Get an existing sales invoice service.
Description
This endpoint retrieves a specific sales invoice service by utilizing the reference of this invoice. Sales invoice services are simplified sales invoices and therefore contain less properties than the normal sales invoices.
If the user does not know the correct reference, the filter can be used to retrieve all available references.
Use Case
The user wants to retrieve an individual sales invoice service by specifying its reference. To obtain the reference of a particular sales invoice service, the user can first use the POST Get sales invoices services filtered and paged endpoint.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| reference | The unique identifier for this sales invoice service within Bloxs. This is unique (per client specific environment) for all sales invoice services. This identifier is generated by the Bloxs system. |
Response fields
The 200 response contains the fields in the table below. For the GET operation it gives a up-to-date insight in the data that is currently registered in Bloxs.
| Field | Description |
|---|---|
| reference | The unique identifier for this sales invoice service within Bloxs. This is unique (per client specific environment) for all sales invoice services. This identifier is generated by the Bloxs system. |
| externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. |
| salesContractReference | The unique identifier for the related sales contract within Bloxs. This identifier is generated by the Bloxs system. |
| ownerReference | The unique identifier for the related owner within Bloxs. This identifier is generated by the Bloxs system. |
| relationReference | The unique identifier for the related relation (not being the owner) within Bloxs. This identifier is generated by the Bloxs system. |
| supplyDate | The actual supply date of the service. This date can differ from the invoice date. |
| paymentMethod | The method by which the invoice is expected to be paid. The following options are availabe: 1 = Direct debit 2 = Bank transfer |
| workflowState | Indicates the status of sales invoice service. Each number represents a status, which is described below: 1 = Draft 2 = OnHold 3 = Cancelled 4 = ApprovalWorkflow 7 = Final 9 = Disapproved 10 = OwnerApprovalWorkflow 11 = DisapprovedByOwner |
| totalAmountExcl | Total amount excluding VAT. |
| totalAmountVAT | Total VAT amount. |
| totalAmountIncl | Total amount including VAT. |
| lineIndex | The order in which the line items are portrayed. |
| description | The default description of the invoice service line. It can provide extra details in addition to the name of the invoice service line. |
| numberOfItems | The number of items associated with this specific invoice service item. If for example the service is 'office rental per 1 hour', this value should contain '1' |
| amountExclPerItem | The amount excluding VAT per item. Bloxs uses this field together with numberOfItems to calculate the amountExcl, amountVAT & amountIncl. |
| amountExcl | the amount excluding VAT of this specific service item. |
| amountVAT | the amount excluding VAT of this specific service item. |
| amountIncl | the amount excluding VAT of this specific service item. |
| serviceItemName | Includes the name of the sales service line item. An example would be 'Office space rental 1 hour'. |
| ledgerAccountCode | The ledger account code of this specific service item. |
| realEstateObjectReference | The unique identifier for the real estate object related to the service item within Bloxs. This identifier is generated by the Bloxs system. |
Please enter a valid token
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
OK
The requested sales invoice service was not found.