StatementDto

A CIS payment and deduction statement: what one subcontractor was paid and had deducted in one tax month
(the 6th to the 5th), or, for an annual statement, in one tax year (6 April to 5 April). A statement exists
once an invoice of the subcontractor is paid in the period.

Properties

Name	Type	Description
contact	string	The subcontractor's contact code
The subcontractor's contact code
contactName	string	The subcontractor's name
The subcontractor's name
contactEmail	string	The subcontractor's email address, the default recipient when the statement is emailed
The subcontractor's email address, the default recipient when the statement is emailed
year*	integer	The calendar year the tax month ends in; for an annual statement, the calendar year the tax year ends in
The calendar year the tax month ends in; for an annual statement, the calendar year the tax year ends in
month	integer	The calendar month (1 to 12) the tax month ends in; null for an annual statement
The calendar month (1 to 12) the tax month ends in; null for an annual statement
isAnnual*	boolean	Whether this is the annual statement for the tax year
Whether this is the annual statement for the tax year
displayName	string	"April '26", or "'25/26 Full Year"
"April '26", or "'25/26 Full Year"
grossAmount*	number	The total paid before deductions
The total paid before deductions
costOfMaterials*	number	The cost of materials, not liable to deduction
The cost of materials, not liable to deduction
amountLiableToDeduction*	number	Gross amount less the cost of materials
Gross amount less the cost of materials
amountDeducted*	number	The CIS deduction
The CIS deduction
amountPayable*	number	Gross amount less the deduction
Gross amount less the deduction
invoiceCount*	integer	The number of invoices in the statement
The number of invoices in the statement
deductionIsAtUnmatchedRate*	boolean	Whether the deduction was at the unmatched (higher) rate
Whether the deduction was at the unmatched (higher) rate
emailStatus	enum	The delivery status of the last email of the statement; null when it has not been emailed Queued Sent Failed
The delivery status of the last email of the statement; null when it has not been emailed Queued Sent Failed
pdfUrl	string	A signed, short-lived (an hour by default) link to the statement's PDF that needs no credentials, for viewers that fetch the file themselves (an in-page PDF viewer, Google's). Append `&disposition=inline` to show it rather than download it. Set on the single statement only, not on the lists.
A signed, short-lived (an hour by default) link to the statement's PDF that needs no credentials, for viewers that fetch the file themselves (an in-page PDF viewer, Google's). Append `&disposition=inline` to show it rather than download it. Set on the single statement only, not on the lists.

JSON Example

{
  "contact": "string",
  "contactName": "string",
  "contactEmail": "string",
  "year": 0,
  "month": 0,
  "isAnnual": false,
  "grossAmount": 0,
  "costOfMaterials": 0,
  "amountLiableToDeduction": 0,
  "amountDeducted": 0,
  "amountPayable": 0,
  "invoiceCount": 0,
  "deductionIsAtUnmatchedRate": false
}

StatementDto

Properties

JSON Example

Used By Operations