Get a sales invoice service

reference

string

Required

The internal identifier of the sales invoice service.

reference

string, max 100

Required

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

externalIdentifier

string, nullable

Optional

The external API identifier of the sales invoice service, if any.

salesContractReference

string, max 100, nullable

Optional

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

ownerReference

string, max 100

Required

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

relationReference

string, max 100

Required

The internal identifier (Reference/Code) of the relation (customer) this service is delivered to and invoiced to.

supplyDate

string (date)

Optional

The date the service was supplied, formatted as ISO 8601 (YYYY-MM-DD).

paymentMethod

integer (enum)

Required

The payment method for the resulting sales invoice. Allowed values: 1 = DirectDebit, 2 = BankTransfer. Only these two methods are supported for sales invoice services.

workflowState

integer (enum)

Optional

The current approval workflow state of this sales invoice service. Allowed values: 1 = Draft, 2 = OnHold, 3 = Cancelled, 4 = ApprovalWorkflow, 7 = Final, 9 = Disapproved, 10 = OwnerApprovalWorkflow, 11 = DisapprovedByOwner.

totalAmountExcl

number (double)

Optional

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

totalAmountVAT

number (double)

Optional

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

totalAmountIncl

number (double)

Optional

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

lines

array of objects, nullable

Optional

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

lines.lineIndex

integer

Required (within each line)

The position of this line within the service.

lines.description

string, nullable

Optional

The description text for this line.

lines.numberOfItems

integer

Optional

The number of items/units for this line.

lines.amountExclPerItem

number (double), nullable

Optional

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

lines.amountExcl

number (double), nullable

Optional

The total line amount excluding VAT (numberOfItems × amountExclPerItem), 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 total line amount including VAT, in the administration's base currency (major units).

lines.serviceItemName

string, nullable

Optional

The name of the service item this line is based on. Must match an entry from the configurable service items catalog (see Get All Sales Invoice Service Items); each line has exactly one service item.

lines.realEstateObjectReference

string, nullable

Optional

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