v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

invoices

Get invoice settlements

Get all settlements for the invoice. Use the query parameters to filter and navigate through the results.

Scope: invoices:read

get/companies/{companyId}/invoices/{invoiceId}/settlements

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

Optional query to filter the data set with supported fields listed below and available operations.

Field	Type
date	date
sumBaseCurrency	decimal

Response

List of settlements

totalItemsinteger

totalPagesinteger

currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "c529df79-eb7f-5ef0-a8dc-c2b71f953554",
      "invoiceId": "a419cf69-db6f-4de9-992c-b1a60942a443",
      "type": "bankFee",
      "invoiceSettlementDetails": {
        "date": "2024-10-15",
        "sumBaseCurrency": 15.5
      },
      "journalEntryRef": {
        "id": "55c899c5-82b2-4a09-899e-9dc03342b5dc"
      }
    }
  ]
}