Contents x
    Get a sales invoice
    • 23 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    Get a sales invoice

    • Updated on 23 May 2025
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /api/v1/invoices/salesinvoice

    [PREVIEW] Get an existing sales invoice.

    Description

    This endpoint retrieves sales invoices related to a specific real estate object.

    Use Case

    The user wants to retrieve an individual sales invoice by specifying its reference. To obtain the reference of a particular invoice, the user can first use the POST filter endpoint. Currently, this GET API returns the same information as the filter API. However, this will change in the future: additional fields will be added to the GET operation, enabling it to provide more detailed information than the filter API. 

    Request fields

    The request contains the following fields:

    FieldDescription
    referenceThe unique identifier for this sales invoice within Bloxs. This is unique (per client specific environment) for all sales invoices. 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 sales invoice within Bloxs. This is unique (per client specific environment) for all sales invoices. This identifier is generated by the Bloxs system.
    subjectInvoice 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.

    invoiceDateInvoice date.
    paymentTermNameDescription of the payment term, for example: "Payment must be made by [date]."
    dueDateDue date of the invoice.
    totalAmountExcl

    Total amount excluding VAT.

    totalAmountVATTotal VAT amount.
    totalAmountInclTotal amount including VAT.
    outstandingAmountTotal outstanding amount for the current month only. This reflects the amount due specifically within the current month and does not include any outstanding balances from previous months.
    outstandingAmountRecalcaulateDateThe 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-time)
    paymentTermName
    string
    Min length0
    Max length256
    dueDate
    string (date-time)
    totalAmountExcl
    number (double)
    totalAmountVAT
    number (double)
    totalAmountIncl
    number (double)
    outstandingAmount
    number (double) | null
    outstandingAmountRecalculateDate
    string (date-time) | null
    404

    The requested sales invoice was not found.

    What's Next