API Docs / Schemas / UpdateInvoiceLineRequest

UpdateInvoiceLineRequest

A line of an invoice being replaced: with the code of an existing line it updates that line, without one it adds
a line. Lines of the invoice not in the request are deleted.

Properties

Name Type Description
type*enum

Labour (subject to the CIS deduction) or Materials

Labour Materials

Labour (subject to the CIS deduction) or Materials

Labour Materials

descriptionstring

What the line is for

What the line is for

quantity*number

Quantity (hours, units). Values under 1 are treated as 1.

Quantity (hours, units). Values under 1 are treated as 1.

amount*number

Unit amount before VAT

Unit amount before VAT

vatRate*enum

The VAT rate. Ignored (OutOfScope) when VAT does not apply to the invoice.

Zero Reduced Standard OutOfScope Exempt

The VAT rate. Ignored (OutOfScope) when VAT does not apply to the invoice.

Zero Reduced Standard OutOfScope Exempt

externalIdstring

The caller's own identifier for the line

The caller's own identifier for the line

codestring

The code of the line to update, or null for a new line

The code of the line to update, or null for a new line

JSON Example

{
  "type": "Labour",
  "description": "string",
  "quantity": 0,
  "amount": 0,
  "vatRate": "Zero"
}

Contained in Schemas