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) | ||
| tokenSentAt | string | UTC time the link was emailed |
UTC time the link was emailed | ||
| confirmedAt | string | UTC time the contractor confirmed |
UTC time the contractor confirmed | ||
| confirmedByEmail | string | Email address of the recipient who confirmed (from their magic link) |
Email address of the recipient who confirmed (from their magic link) | ||
| queriedAt | string | UTC time the contractor queried the return |
UTC time the contractor queried the return | ||
| queryMessage | string | What the contractor said isn't right |
What the contractor said isn't right | ||
| isNilReturn | boolean | Whether the return has no payments |
Whether the return has no payments | ||
| subcontractorCount | integer | The number of subcontractors on the return as confirmed |
The number of subcontractors on the return as confirmed | ||
| totalGross | number | Gross payments on the return as confirmed |
Gross payments on the return as confirmed | ||
| totalMaterials | number | Materials on the return as confirmed |
Materials on the return as confirmed | ||
| totalDeductions | number | Deductions on the return as confirmed |
Deductions on the return as confirmed | ||
| returnSnapshotJson | string | The return's breakdown as the contractor saw it when they confirmed, as JSON |
The return's breakdown as the contractor saw it when they confirmed, as JSON | ||
JSON Example
{
"taxMonthEnd": "2024-01-01",
"organisationCode": "string",
"tokenSentAt": "2024-01-01T00:00:00Z",
"confirmedAt": "2024-01-01T00:00:00Z",
"confirmedByEmail": "string"
}