Monitor Status
Check Filing Status
Endpoint: GET /api/filings/v1/filings/{id}/
curl -X GET https://api.abacus.com/api/filings/v1/filings/f1i2l3i4-n5g6-7890-abcd-ef1234567890/ \
-H "Authorization: Bearer YOUR_TOKEN"
Response:
{
"id": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"name": "DE VAT Return - January 2025",
"state": "internal_review_pending",
"state_display": "Internal Review Pending",
"transaction_state": "all_data_provided",
"transaction_state_display": "All Data Provided",
"period_start_date": "2025-01-01",
"period_end_date": "2025-01-31",
"period_display": "January 2025",
"base_due_date": "2025-02-10",
"effective_due_date": "2025-02-10",
"is_nil_return": false,
"input_vat": "1250.00",
"output_vat": "3700.00",
"net_vat": "2450.00",
"payment_reference": "DE-VAT-2025-001-12345",
"amount_refundable": "0.00",
"correction": false,
"correction_of": null,
"blocked_by_warnings_or_errors": false,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-02-08T14:30:00Z",
"finance_tax_payment_reference": null
}
Filing State Values
| State | Description |
|---|---|
draft | Filing is in draft state |
internal_review_pending | Awaiting internal review |
awaiting_client_review | Awaiting client approval |
approved | Approved and ready for submission |
filed | Filed with tax authority |
accepted | Accepted by tax authority |
rejected | Rejected by tax authority |
Get Draft Return Boxes
Endpoint: GET /api/filings/v1/filing-draft-return-box/?filing={filing_id}
curl -X GET "https://api.abacus.com/api/filings/v1/filing-draft-return-box/?filing=f1i2l3i4-n5g6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer YOUR_TOKEN"
Response:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "box1-uuid-here",
"filing": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"draft_return_box": "drb-uuid-here",
"draft_return_box_detail": {
"id": "drb-uuid-here",
"position": "020",
"name": "Tax-free transactions with input tax deduction",
"group": "Sales",
"page": "1"
},
"position": 20,
"name": "Tax-free transactions with input tax deduction",
"group": "Sales",
"page": "1",
"net": "12894.50",
"vat": "0.00",
"gross": "12894.50",
"other": null,
"metadata": {},
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
},
{
"id": "box2-uuid-here",
"filing": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"draft_return_box": "drb2-uuid-here",
"draft_return_box_detail": {
"id": "drb2-uuid-here",
"position": "083",
"name": "Tax to be paid",
"group": "Tax Due",
"page": "2"
},
"position": 83,
"name": "Tax to be paid",
"group": "Tax Due",
"page": "2",
"net": "0.00",
"vat": "2450.00",
"gross": "2450.00",
"other": null,
"metadata": {},
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}
]
}
Approve Filing
Endpoint: POST /api/filings/v1/{filing_id}/approve/
curl -X POST https://api.abacus.com/api/filings/v1/f1i2l3i4-n5g6-7890-abcd-ef1234567890/approve/ \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"
Response:
HTTP 200 OK
Note: The approve endpoint returns a 200 status code on successful approval. The filing state will be updated to the next appropriate state in the workflow.
Get Filing Files
Endpoint: GET /api/filings/v1/filing-files/?filing={filing_id}
curl -X GET "https://api.abacus.com/api/filings/v1/filing-files/?filing=f1i2l3i4-n5g6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer YOUR_TOKEN"
Response:
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": "file1-uuid-here",
"file": "file-vault-uuid-here",
"file_detail": {
"id": "file-vault-uuid-here",
"name": "DE_VAT_Return_Jan2025_Draft.pdf",
"size": 245760,
"content_type": "application/pdf",
"created_at": "2025-01-15T10:30:00Z"
},
"file_url": "https://s3.amazonaws.com/bucket/path/to/file.pdf?signed-url-params",
"filing": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"category": "draft_return",
"category_display": "Draft Return",
"filing_detail": {
"id": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"name": "DE VAT Return - January 2025",
"state": "internal_review_pending",
"state_display": "Internal Review Pending"
},
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
},
{
"id": "file2-uuid-here",
"file": "file-vault-uuid2-here",
"file_detail": {
"id": "file-vault-uuid2-here",
"name": "workings_jan2025.xlsx",
"size": 89432,
"content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"created_at": "2025-01-15T11:00:00Z"
},
"file_url": "https://s3.amazonaws.com/bucket/path/to/workings.xlsx?signed-url-params",
"filing": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"category": "workings",
"category_display": "Workings",
"filing_detail": {
"id": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"name": "DE VAT Return - January 2025",
"state": "internal_review_pending",
"state_display": "Internal Review Pending"
},
"created_at": "2025-01-15T11:00:00Z",
"updated_at": "2025-01-15T11:00:00Z"
}
]
}
Filing File Categories
| Category | Description |
|---|---|
draft_return | Draft return document |
pdf_draft_return | PDF version of draft return |
workings | Supporting workings/calculations |
manual_draft_return | Manually uploaded draft return |
rejected_draft_return | Previously rejected draft return |
rejected_pdf_draft_return | Previously rejected PDF draft return |
rejected_manual_draft_return | Previously rejected manual draft return |
Get Individual Filing File
Endpoint: GET /api/filings/v1/filing-files/{file_id}/
curl -X GET https://api.abacus.com/api/filings/v1/filing-files/file1-uuid-here/ \
-H "Authorization: Bearer YOUR_TOKEN"
Response:
{
"id": "file1-uuid-here",
"file": "file-vault-uuid-here",
"file_detail": {
"id": "file-vault-uuid-here",
"name": "DE_VAT_Return_Jan2025_Draft.pdf",
"size": 245760,
"content_type": "application/pdf",
"created_at": "2025-01-15T10:30:00Z"
},
"file_url": "https://s3.amazonaws.com/bucket/path/to/file.pdf?signed-url-params",
"filing": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"category": "draft_return",
"category_display": "Draft Return",
"filing_detail": {
"id": "f1i2l3i4-n5g6-7890-abcd-ef1234567890",
"name": "DE VAT Return - January 2025",
"state": "internal_review_pending",
"state_display": "Internal Review Pending"
},
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}