Returns a list of all folios.
Allowed actions are only returned, when the list is filtered by reservation ID.<br>You must have at least one of these scopes: 'folios.read, folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folios.read'.
Request
- Base URLhttps://api.apaleo.com (the document declares no server; this is the origin it was published from)
- URLhttps://api.apaleo.com/finance/v1/folios
- AuthOAuth 2Implicit: https://identity.apaleo.com/connect/authorizeScopes: folios.read, folios.manage, admin
Query parameters
Filter folio list by property IDs
Filter folio list by company IDs
Filter folio list by reservation IDs
Filter folio list by booking IDs
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
If set to true, closed folios are filtered out from the result collection - <b>DEPRECATED: This field will be removed soon. Please use Status=Open instead.</b>
If set to true, only folios <b>with</b> invoices are returned. If set to false, only folios <b>without</b> invoices are returned. If omitted/null, <b>all</b> folios are returned.
The inclusive start time of the date of creation. Mostly useful for external folios<br />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>
The exclusive end time of the date of creation. Mostly useful for external folios<br />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>
The inclusive start time of the date of the last update. Mostly useful for external folios<br />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>
The exclusive end time of the date of the last update. Mostly useful for external folios<br />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>
If set to true, only main folios are returned, otherwise all.
The type of the folio
The status of the folio
Allows filtering external folios by code. Useful when you use external folios with custom codes. Specifying this parameter will ignore the <b>Type</b> parameter and treat as if it would be set to "External" instead.
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.
This will filter reservations based on their balance.<br />You can provide an array of string expressions which all need to apply.<br />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:<br />'eq' for equals<br />'neq' for not equals<br />'lt' for less than<br />'gt' for greater than<br />'lte' for less than or equals<br />'gte' for greater than or equals<br />For instance<br />'eq_5' would mean the value should equal 5<br />'lte_7' would mean the value should be less than or equal to 7
Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
Items per page. Default: 500. Maximum: 500.
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.
List of all embedded resources that should be expanded in the response. Possible values are: allowances, allowedActions, transitoryCharges, charges, company, payments, warnings. All other values will be silently ignored.
Response
Success.
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-23",
"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 3 revisions of this API.