Properties
| Name | Type | Description |
|---|---|---|
| year | integer | The calendar year the tax month ends in |
The calendar year the tax month ends in | ||
| month | integer | The calendar month the tax month ends in (on the 5th) |
The calendar month the tax month ends in (on the 5th) | ||
| status | enum | Open Submitted Accepted Error Submitting |
Open Submitted Accepted Error Submitting | ||
| dueDate | string | When it is due at HMRC (the 19th) |
When it is due at HMRC (the 19th) | ||
| isOverdue | boolean | Not accepted and past its due date |
Not accepted and past its due date | ||
| errors | array of string | HMRC's or the submission's errors, when in error |
HMRC's or the submission's errors, when in error | ||
| submissionBlockedReason | string | Why it cannot be submitted now (filing credits, billing), or null |
Why it cannot be submitted now (filing credits, billing), or null | ||
| creditsRequired | integer | The filing credits submitting it will use, when it is paid for with them |
The filing credits submitting it will use, when it is paid for with them | ||
| invoiceCount | integer | The invoices paid in the month |
The invoices paid in the month | ||
| contactCount | integer | The subcontractors paid in the month |
The subcontractors paid in the month | ||
| deductions | number | The CIS deducted in the month |
The CIS deducted in the month | ||
JSON Example
{
"year": 0,
"month": 0,
"status": "Open",
"dueDate": "2024-01-01",
"isOverdue": false
}