Get a purchase invoice

Prev Next
Get
/api/v1/invoices/purchaseinvoices

Get an existing purchase invoice.

Description

This endpoint retrieves existing purchase invoices from the financial accounting administration by utilizing the reference. 

Use Case

The user wants to retrieve an individual purchase invoice by specifying its reference. To obtain the reference of a particular purchase invoice, the user can first use the POST Get Purchase Invoices Filtered and Paged endpoint.

Request fields

The request contains the following fields:

FieldDescription
referenceThe unique identifier for this reminder within Bloxs. This is unique (per client specific environment) for all reminders. 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.

FieldDescription
referenceThe unique identifier for this reminder within Bloxs. This is unique (per client specific environment) for all reminders. This identifier is generated by the Bloxs system.
subjectPurchase invoice subject.
ownerReferenceThis is the reference of the owner of the object.
relationReference

This is the reference of the relation associated with the reminder. It can refer to any relation type within the system and is not necessarily a tenant. For example, it may also refer to an owner who has an outstanding debt with another owner.

invoiceDateThis is the date on which the next action is required according to Bloxs. For example, if an invoice is due in eight days, this date will reflect the invoice’s due date. Please note: the API does not specify what the next action is, only when it is expected.
paymentTermnameDescription of the payment term, for example: "Payment must be made by [date]."
dueDate
Due date of the purchase invoice.
totalAmountExcl
Total amount excluding VAT.
totalAmountVATTotal VAT amount.
totalAmountInclTotal amount including VAT.
OutstandingAmountThis represents the total outstanding amount, based solely on invoiced charges. It does not include administrative or collection fees. Such additional costs may be invoiced separately and can then be included in the total debt. The amount is expressed with two decimals.
OutstandingAmountRecalculateDateThe date on which the outstanding debt was last updated. This value is generated by Bloxs.
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
reference
stringRequired

The internal identifier of the model (i.e. Reference, Code, Name, depends on model).

Responses
200

OK

object
reference
string
Min length0
Max length100
subject
string | null
Min length0
Max length512
ownerReference
string
Min length0
Max length100
relationReference
string
Min length0
Max length100
invoiceDate
string (date)
paymentTermName
string
Min length0
Max length256
dueDate
string (date)
totalAmountExcl
number (double)
totalAmountVAT
number (double)
totalAmountIncl
number (double)
outstandingAmount
number (double) | null
outstandingAmountRecalculateDate
string (date-time) | null
404

The requested purchase invoice was not found.