Properties
| Name | Type | Description |
|---|---|---|
| taxMonthEnd | string | The 5th the tax month ends on |
The 5th the tax month ends on | ||
| organisationCode | string | The client's CIS Manager organisation (its tenant code) |
The client's CIS Manager organisation (its tenant code) | ||
| submittedAt | string | UTC time the return was submitted (or found already submitted) |
UTC time the return was submitted (or found already submitted) | ||
| submittedBy | string | Who submitted: the user's email address, or "System" for an automatic run |
Who submitted: the user's email address, or "System" for an automatic run | ||
| isNilReturn | boolean | Whether the return had no payments (no declarations sent) |
Whether the return had no payments (no declarations sent) | ||
| employmentStatusDeclared | boolean | Whether the employment status declaration was sent |
Whether the employment status declaration was sent | ||
| verificationDeclared | boolean | Whether the verification declaration was sent |
Whether the verification declaration was sent | ||
| totalDeductions | number | Deductions on the return when submitted |
Deductions on the return when submitted | ||
| acceptedAt | string | UTC time HMRC's acceptance was seen |
UTC time HMRC's acceptance was seen | ||
| correlationId | string | HMRC's correlation id for the submission |
HMRC's correlation id for the submission | ||
| irMarkMessage | string | HMRC's IRmark message once the return is accepted |
HMRC's IRmark message once the return is accepted | ||
| errorMessage | string | HMRC's error, as CIS Manager translated it, when the return was rejected |
HMRC's error, as CIS Manager translated it, when the return was rejected | ||
| lastPolledAt | string | UTC time the poll last read the return's status |
UTC time the poll last read the return's status | ||
| filedOutsideStep | boolean | Whether the return was already submitted or accepted in CIS Manager when the step ran |
Whether the return was already submitted or accepted in CIS Manager when the step ran | ||
JSON Example
{
"taxMonthEnd": "2024-01-01",
"organisationCode": "string",
"submittedAt": "2024-01-01T00:00:00Z",
"submittedBy": "string",
"isNilReturn": false
}