API Docs / Schemas / UpdateInvoiceRequest

UpdateInvoiceRequest

A full replacement of an invoice's editable fields and lines. The contact, external id and payments are not
changed here.

Properties

Name Type Description
date*string

The invoice date

The invoice date

dueDatestring

When payment is due. Defaults to the invoice date.

When payment is due. Defaults to the invoice date.

yourReferencestring

The tenant's own reference

The tenant's own reference

theirReferencestring

The contact's reference

The contact's reference

isDomesticReverseCharge*boolean

Whether the VAT domestic reverse charge applies. Cleared when either party is not VAT registered.

Whether the VAT domestic reverse charge applies. Cleared when either party is not VAT registered.

deductionnumber

Sales invoices only: the CIS deduction the customer made. Ignored on a purchase invoice, where the deduction
follows from the labour total and the tax status.

Sales invoices only: the CIS deduction the customer made. Ignored on a purchase invoice, where the deduction
follows from the labour total and the tax status.

taxStatus*enum

The CIS deduction rate applied to the invoice's labour

NetOfHigherDeduction NetOfStandardDeduction Gross

The CIS deduction rate applied to the invoice's labour

NetOfHigherDeduction NetOfStandardDeduction Gross

lines*array of UpdateInvoiceLineRequest

The lines, keyed by code: an existing code updates that line, no code adds one, and a line left out is deleted

The lines, keyed by code: an existing code updates that line, no code adds one, and a line left out is deleted

JSON Example

{
  "date": "2024-01-01T00:00:00Z",
  "dueDate": "2024-01-01T00:00:00Z",
  "yourReference": "string",
  "theirReference": "string",
  "isDomesticReverseCharge": false,
  "taxStatus": "NetOfHigherDeduction",
  "lines": [
    {
      "type": "...",
      "description": "...",
      "quantity": "...",
      "amount": "...",
      "vatRate": "..."
    }
  ]
}

Used By Operations