InvoiceDto

An invoice: a purchase invoice received from a supplier or subcontractor (the tenant pays it), or a sales invoice
the tenant issued to a customer. The number is unique within the tenant and direction.

Properties

Name	Type	Description
number*	integer	The invoice number, allocated by the tenant in sequence per direction
The invoice number, allocated by the tenant in sequence per direction
contact*	string	The contact's code
The contact's code
contactName	string	The contact's display name
The contact's display name
date*	string	The invoice date
The invoice date
dueDate*	string	When payment is due
When payment is due
yourReference	string	The tenant's own reference
The tenant's own reference
theirReference	string	The contact's reference
The contact's reference
taxStatus*	enum	The CIS deduction rate applied to this invoice's labour. On a purchase invoice it defaults to the subcontractor's rate when the invoice is created. NetOfHigherDeduction NetOfStandardDeduction Gross
The CIS deduction rate applied to this invoice's labour. On a purchase invoice it defaults to the subcontractor's rate when the invoice is created. NetOfHigherDeduction NetOfStandardDeduction Gross
contactTaxStatus*	enum	The subcontractor's current CIS deduction rate, so a caller can see when it differs from the invoice's NetOfHigherDeduction NetOfStandardDeduction Gross
The subcontractor's current CIS deduction rate, so a caller can see when it differs from the invoice's NetOfHigherDeduction NetOfStandardDeduction Gross
isVatApplicable*	boolean	Whether VAT applies: derived from the VAT registration of the two parties, not settable
Whether VAT applies: derived from the VAT registration of the two parties, not settable
isDomesticReverseCharge*	boolean	Whether the VAT domestic reverse charge applies (no VAT charged on the invoice)
Whether the VAT domestic reverse charge applies (no VAT charged on the invoice)
totalLabour*	number	Total of the labour lines, before VAT
Total of the labour lines, before VAT
totalMaterials*	number	Total of the materials lines, before VAT
Total of the materials lines, before VAT
totalVat*	number	Total VAT
Total VAT
total*	number	Grand total: labour, materials and VAT
Grand total: labour, materials and VAT
deduction*	number	The CIS deduction: computed from the labour total and the tax status on a purchase invoice, recorded by the caller on a sales invoice (what the customer deducted)
The CIS deduction: computed from the labour total and the tax status on a purchase invoice, recorded by the caller on a sales invoice (what the customer deducted)
paymentAmount*	number	The amount payable: the total less the deduction
The amount payable: the total less the deduction
totalOfPayments*	number	The total of the payments recorded against the invoice
The total of the payments recorded against the invoice
paid*	boolean	Whether the payments cover the amount payable
Whether the payments cover the amount payable
paidDate	string	The date of the last payment, when paid
The date of the last payment, when paid
monthlyReturnStatus	enum	On a paid purchase invoice, the status of the CIS monthly return for the tax month it was paid in (Open when the return does not exist yet) Open Submitted Accepted Error
On a paid purchase invoice, the status of the CIS monthly return for the tax month it was paid in (Open when the return does not exist yet) Open Submitted Accepted Error
emailStatus	enum	The delivery status of the last email of the invoice, if it was emailed Queued Sent Failed
The delivery status of the last email of the invoice, if it was emailed Queued Sent Failed
externalId	string	The caller's own identifier for the invoice (an external system's id), set on create
The caller's own identifier for the invoice (an external system's id), set on create
lines	array of InvoiceLineDto	The invoice lines. Present on a single invoice; null on a list.
The invoice lines. Present on a single invoice; null on a list.
createdDate*	string	When the invoice was created
When the invoice was created
updatedDate	string	When the invoice was last changed
When the invoice was last changed

JSON Example

{
  "number": 0,
  "contact": "string",
  "contactName": "string",
  "date": "2024-01-01T00:00:00Z",
  "dueDate": "2024-01-01T00:00:00Z",
  "taxStatus": "NetOfHigherDeduction",
  "contactTaxStatus": "NetOfHigherDeduction",
  "isVatApplicable": false,
  "isDomesticReverseCharge": false,
  "totalLabour": 0,
  "totalMaterials": 0,
  "totalVat": 0,
  "total": 0,
  "deduction": 0,
  "paymentAmount": 0,
  "totalOfPayments": 0,
  "paid": false,
  "createdDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas

InvoiceDtoPagedResult