Invoice

Gets the list of all invoices (the metadata only, not the files).

Gets the list of all invoices (the metadata only, not the files). You must have this scope: 'invoices.read'. For fine-grained clients, you must have this permission: 'core.invoices.read'.

get/finance/v1/invoices

Request

Base URL
https://api.apaleo.com (the document declares no server; this is the origin it was published from)
URL
https://api.apaleo.com/finance/v1/invoices
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: invoices.read, admin

Query parameters

numberstring

The invoice number

status'FullyPaid' | 'Unpaid' | 'WrittenOff'

Filter by invoice status

checkedOutOnAccountsReceivableboolean

If set to true, only return invoices with an open balance (AR) Otherwise, returns all.

outstandingPaymentFilterstring[]

Filter for the outstanding balance for invoices You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean the value should be less than or equal to 7

dateFilterstring[]

Filter by invoice date You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean the value should be less than or equal to 7

propertyIdsstring[]

Filter by property IDs

reservationIdsstring[]

Filter by reservation IDs

bookingIdsstring[]

Filter by booking IDs

folioIdsstring[]

Filter by folio IDs

nameSearchstring

Find invoices for a recipient name or company. Provide at least three characters.

paymentSettledboolean

If set to true, returns only invoices having no outstanding payments or marked as settled. If set to false, returns only invoices with outstanding payment and not marked as settled. If not set, returns all invoices. - DEPRECATED: This field will be removed at 25.06.2022. Use filtering by Status instead

companyIdsstring[]

Filter by company IDs

recipientType'Person' | 'Company'

If nothing is set, invoices addressed both companies and individuals will be returned. If set to Person, invoices that addressed to individuals will be returned. If set to Company, invoice that addressed to companies will be returned.

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: allowedActions, company. All other values will be silently ignored.

Response

Success.

countinteger required

Total count of items

Example response

{
  "invoices": [
    {
      "id": "MUC-20171200000002",
      "number": "20171200000002",
      "type": "Initial",
      "languageCode": "de",
      "folioId": "DHNSHFK-1-1",
      "reservationId": "DHNSHFK-1",
      "bookingId": "DHNSHFK",
      "propertyId": "MUC",
      "subTotal": {
        "amount": 100,
        "currency": "EUR"
      },
      "paymentSettled": true,
      "status": "FullyPaid",
      "created": "2026-10-22T13:50:37.1321675+02:00",
      "guestName": "Alan Turing",
      "guestCompany": "GCHQ",
      "company": {
        "id": "MUC-ACME",
        "code": "ACME",
        "name": "ACME Inc."
      }
    },
    {
      "id": "MUC-20181200000002",
      "number": "20181200000002",
      "type": "Initial",
      "languageCode": "de",
      "folioId": "HGZGDNAK-1-1",
      "reservationId": "HGZGDNAK-1",
      "bookingId": "HGZGDNAK",
      "propertyId": "MUC",
      "subTotal": {
        "amount": 100,
        "currency": "EUR"
      },
      "outstandingPayment": {
        "amount": 95,
        "currency": "EUR"
      },
      "paymentSettled": false,
      "status": "Unpaid",
      "created": "2026-10-22T13:50:37.1321675+02:00",
      "guestName": "Bertrand Russell",
      "allowedActions": [
        "CorrectAddress",
        "CorrectCharges"
      ]
    },
    {
      "id": "MUC-20171200000018",
      "number": "20171200000018",
      "type": "Cancellation",
      "languageCode": "de",
      "folioId": "DHNSHFK-1-2",
      "reservationId": "DHNSHFK-1",
      "bookingId": "DHNSHFK",
      "propertyId": "MUC",
      "relatedInvoiceNumber": "20171200000002",
      "cancellationReasonCode": "ChangeOfInvoiceRecipient",
      "subTotal": {
        "amount": 100,
        "currency": "EUR"
      },
      "paymentSettled": true,
      "status": "FullyPaid",
      "created": "2026-10-23T11:50:37.1321675+02:00",
      "guestName": "Ludwig Wittgenstein"
    },
    {
      "id": "MUC-20171200000022",
      "number": "20171200000022",
      "type": "Correction",
      "languageCode": "de",
      "folioId": "DHNSHFK-1-3",
      "reservationId": "DHNSHFK-1",
      "bookingId": "DHNSHFK",
      "propertyId": "MUC",
      "subTotal": {
        "amount": 100,
        "currency": "EUR"
      },
      "paymentSettled": true,
      "status": "FullyPaid",
      "created": "2026-10-23T11:50:37.1321675+02:00",
      "guestName": "Rudolf Carnap",
      "allowedActions": [
        "CorrectAddress",
        "CorrectCharges"
      ]
    },
    {
      "id": "MUC-20171200000023",
      "number": "20171200000023",
      "type": "Initial",
      "languageCode": "de",
      "folioId": "DHNSHFL-1-5",
      "reservationId": "DHNSHFL-1",
      "bookingId": "DHNSHFL",
      "propertyId": "MUC",
      "writeOffReason": "Some weighty reason",
      "subTotal": {
        "amount": 100,
        "currency": "EUR"
      },
      "paymentSettled": false,
      "status": "WrittenOff",
      "created": "2026-10-23T10:50:37.1321675+02:00",
      "guestName": "Yury Vlasov"
    }
  ],
  "count": 5
}

Changes

No recorded changes to this operation across all 3 revisions of this API.