Skip to main content

Filings API Reference

Create Filing​

Endpoint: POST /api/filing/v1/filings/

{
  "registration_filing_type": "string (uuid, required)",
  "reporting_period_start": "string (date, required)",
  "reporting_period_end": "string (date, required)"
}

Get Filing​

Endpoint: GET /api/filing/v1/filings/{id}/

{
  "id": "string (uuid)",
  "status": "draft|pending_approval|approved|submitted|accepted|rejected",
  "due_date": "string (date)",
  "submitted_date": "string (datetime)",
  "filing_reference": "string",
  "total_vat_due": "string (decimal)",
  "total_net": "string (decimal)",
  "currency": "string"
}

Get Filing Files​

Endpoint: GET /api/filing/v1/filings/{id}/files/

{
  "results": [
    {
      "id": "string (uuid)",
      "file_type": "vat_return|submission_receipt|acknowledgment",
      "filename": "string",
      "download_url": "string (url)",
      "created_at": "string (datetime)"
    }
  ]
}

Get Draft Return Boxes​

Endpoint: GET /api/filing/v1/filings/{id}/draft-return-boxes/

{
  "boxes": [
    {
      "box_number": "string",
      "description": "string",
      "value": "string (decimal)",
      "currency": "string"
    }
  ],
  "total_vat_due": "string (decimal)",
  "reporting_period": "string"
}

Approve Filing​

Endpoint: POST /api/filing/v1/filings/{id}/approve/

{
  "approved_by": "string (optional)",
  "approval_notes": "string (optional)"
}