Get a paged list of existing sales invoice services, optionally filtered to the given parameters.
Description
This endpoint retrieves a paged list of existing sales invoice services, filtered to the given parameters. Sales invoice services are simplified sales invoices and therefore contain less properties than the normal sales invoices.
Use Case
The user wants to call the GET sales invoice services operation, however does not know which reference to use for the specific invoice service. By using the filter operation and leaving 'reference' empty the user can retrieve the list of available sales invoice services.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | The data field based on which sorting is applied. For example, if the results are sorted based on payment method, columnName will contain the value 'payment method'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| reference | The unique identifier for this specific sales invoice, created by Bloxs. |
| 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.from | The actual supply date of the service. This date can differ from the invoice date. This defines the lower border of the range. |
| supplyDate.to | The actual supply date of the service. This date can differ from the invoice date. This defines the upper border of the range. |
| paymentMethod | The method by which the invoice is expected to be paid. The following options are availabe: 1 = Direct debit 2 = Bank transfer |
| totalAmountExcl.from | Total amount excluding VAT. This defines the lower border of the range. |
| totalAmountExcl.to | Total amount excluding VAT. This defines the upper border of the range. |
| totalAmountVAT.from | Total VAT amount. This defines the lower border of the range. |
| totalAmountVAT.to | Total VAT amount. This defines the upper border of the range. |
| totalAmountIncl.from | Total amount including VAT. This defines the lower border of the range. |
| totalAmountIncl.to | Total amount including VAT. This defines the upper border of the range. |
Response fields
In addition to the request, the 200 response contains the fields in the table below.
| Field | Description |
|---|---|
| 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. |
| 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 |
Please enter a valid token
OK