Folio

Returns a list of all folios.

Allowed actions are only returned, when the list is filtered by reservation ID. You must have at least one of these scopes: 'folios.read, folios.manage'. For fine-grained clients, you must have this permission: 'core.folios.read'.

get/finance/v0-nsfw/folios

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/v0-nsfw/folios
Auth
OAuth 2
Implicit: https://identity.apaleo.com/connect/authorize
Scopes: folios.read, folios.manage, admin

Query parameters

propertyIdsstring[]

Filter folio list by property IDs

companyIdsstring[]

Filter folio list by company IDs

reservationIdsstring[]

Filter folio list by reservation IDs

bookingIdsstring[]

Filter folio list by booking IDs

isEmptyboolean

If set to true, only return empty folios (no unmoved [transitory] charges, no unmoved payments, no allowances). If set to false, only return non-empty folios

excludeClosedboolean

If set to true, closed folios are filtered out from the result collection - DEPRECATED: This field will be removed soon. Please use Status=Open instead.

hasInvoicesboolean

If set to true, only folios with invoices are returned. If set to false, only folios without invoices are returned. If omitted/null, all folios are returned.

dateFilter'Stay' | 'Creation' | 'Modification'

Filter by date and time attributes of folio. Use in combination with the 'To' and 'From' attributes. All filters will check if the date specified by the filter type is between from (included) and to (excluded). The exception being filtering for 'stay', which will return all reservations that are overlapping with the interval specified by from and to.

fromstring date-time

The start of the time interval. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time

The end of the time interval, must be larger than 'from'. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

createdFromstring date-time

The inclusive start time of the date of creation. Mostly useful for external folios - DEPRECATED: This field will be removed on August 17th 2026. Please use DateFilter instead. A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

createdTostring date-time

The exclusive end time of the date of creation. Mostly useful for external folios - DEPRECATED: This field will be removed on August 17th 2026. Please use DateFilter instead. A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

updatedFromstring date-time

The inclusive start time of the date of the last update. Mostly useful for external folios - DEPRECATED: This field will be removed on August 17th 2026. Please use DateFilter instead. A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

updatedTostring date-time

The exclusive end time of the date of the last update. Mostly useful for external folios - DEPRECATED: This field will be removed on August 17th 2026. Please use DateFilter instead. A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

onlyMainboolean

If set to true, only main folios are returned, otherwise all.

type'House' | 'Guest' | 'External' | 'Booking'

The type of the folio

status'Open' | 'Closed'

The status of the folio

reservationStatusstring[]

Filter result by reservation status. If filtering by reservation status, only guest folios linked to reservations with the specified status(es) will be returned.

externalFolioCodestring

Allows filtering external folios by code. Useful when you use external folios with custom codes. Specifying this parameter will ignore the Type parameter and treat as if it would be set to "External" instead.

textSearchstring

This will filter all folios where the provided text is contained in: debitor first name or last name or company name, folio id. The search is case insensitive.

balanceFilterstring[]

This will filter reservations based on their balance. 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

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.

sortstring[]

List of all fields that can be used to sort the results. Possible values are: created:asc, created:desc, balance:asc, balance:desc. All other values will be silently ignored.

expandstring[]

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

Response

Success.

countinteger required

Total count of items

Example response

{
  "folios": [
    {
      "id": "XKCD-17",
      "created": "0001-01-01T00:00:00Z",
      "updated": "0001-01-01T00:00:00Z",
      "type": "Guest",
      "debitor": {
        "title": "Mr",
        "name": "Fisher",
        "personalTaxId": "123456789"
      },
      "isMainFolio": true,
      "isEmpty": false,
      "reservation": {
        "id": "XKCD-17",
        "bookingId": "XKCD-17"
      },
      "balance": {
        "amount": 223.59,
        "currency": "EUR"
      },
      "checkedOutOnAccountsReceivable": false,
      "allowedActions": [
        "AddCharge",
        "AddPayment",
        "Close"
      ],
      "relatedInvoices": [
        {
          "id": "00010675"
        }
      ],
      "status": "Open"
    },
    {
      "id": "BRC-231",
      "created": "0001-01-01T00:00:00Z",
      "updated": "0001-01-01T00:00:00Z",
      "type": "House",
      "debitor": {
        "title": "Mr",
        "name": "Lee",
        "personalTaxId": "123456789"
      },
      "isMainFolio": true,
      "isEmpty": false,
      "reservation": {
        "id": "BRC-231",
        "bookingId": "BRC-231"
      },
      "balance": {
        "amount": 364.83,
        "currency": "EUR"
      },
      "checkedOutOnAccountsReceivable": false,
      "allowedActions": [
        "AddCharge",
        "AddPayment",
        "Close"
      ],
      "relatedInvoices": [
        {
          "id": "00010672"
        }
      ],
      "status": "Open"
    },
    {
      "id": "XKCD-5-1",
      "created": "0001-01-01T00:00:00Z",
      "updated": "0001-01-01T00:00:00Z",
      "type": "Guest",
      "debitor": {
        "title": "Ms",
        "name": "Ms Jackson"
      },
      "closingDate": "2026-09-16",
      "isMainFolio": false,
      "isEmpty": false,
      "reservation": {
        "id": "XKCD-5",
        "bookingId": "XKCD"
      },
      "balance": {
        "amount": 0,
        "currency": "EUR"
      },
      "checkedOutOnAccountsReceivable": true,
      "allowedActions": [
        "AddCharge",
        "AddPayment",
        "Close"
      ],
      "relatedInvoices": [
        {
          "id": "00010687"
        }
      ],
      "status": "Open"
    }
  ],
  "count": 3
}

Changes

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