Get a sales invoice

reference

string

Required

The internal identifier of the sales invoice.

reference

string, max 100

Required

The internal identifier (Reference/Code) of the sales invoice.

subject

string, max 512, nullable

Optional

The subject or description line of the invoice.

ownerReference

string, max 100

Required

The internal identifier (Reference/Code) of the owner whose financial administration this invoice belongs to.

relationReference

string, max 100

Required

The internal identifier (Reference/Code) of the relation this invoice was sent to.

invoiceDate

string (date)

Optional

The date on the invoice, formatted as ISO 8601 (YYYY-MM-DD).

paymentTermName

string, max 256

Required

The payment term applied to this invoice.

dueDate

string (date)

Optional

The date by which the invoice is due for payment, formatted as ISO 8601 (YYYY-MM-DD).

totalAmountExcl

number (double)

Optional

The total invoice amount excluding VAT, in the administration's base currency (major units).

totalAmountVAT

number (double)

Optional

The total VAT amount on the invoice, in the administration's base currency (major units).

totalAmountIncl

number (double)

Optional

The total invoice amount including VAT, in the administration's base currency (major units).

outstandingAmount

number (double), nullable

Optional

The amount still outstanding (unpaid) on this invoice, in the administration's base currency (major units).

outstandingAmountRecalculateDate

string (date-time), nullable

Optional

The date and time outstandingAmount was last recalculated, formatted as ISO 8601.

salesContractReference

string, max 100, nullable

Optional

The internal identifier of the sales contract this invoice is linked to, if applicable.

serviceReference

string, nullable

Optional

The internal identifier of the sales invoice service this invoice originated from, if applicable.

lines

array of objects, nullable

Optional

The invoice's line items. See sub-fields below.

lines.lineIndex

integer

Required (within each line)

The position of this line within the invoice.

lines.ledgerAccountCode

string, max 12, nullable

Optional

The general ledger account code this line is booked to.

lines.realEstateObjectReference

string, max 100, nullable

Optional

The internal identifier of the real estate object this line is allocated to, if applicable.

lines.description

string, max 512, nullable

Optional

The description text for this line.

lines.taxRateCode

string, max 100, nullable

Optional

The VAT/tax rate applied to this line, represented as a descriptive label rather than a short code.

lines.amountExcl

number (double), nullable

Optional

The line amount excluding VAT, in the administration's base currency (major units).

lines.amountVAT

number (double), nullable

Optional

The VAT amount for this line, in the administration's base currency (major units).

lines.amountIncl

number (double), nullable

Optional

The line amount including VAT, in the administration's base currency (major units).