APapaleo
SubLedger

Returns a list of guest accounts.

Returns a list of accounts in one property for a reservation.<br>You must have at least one of these scopes: 'subledger.read, accounting.read'.<br>For fine-grained clients, you must have this permission: 'core.subledger_guest_accounts.read'.

get/finance/v1/guest-accounts

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/guest-accounts
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: subledger.read, accounting.read, admin

Query parameters

propertyIdstring required

Filter account list by property id

reservationIdstring required

Filter account list by reservation id

parentstring

Filter account list by the parent account's number.

languageCodestring

The language for the the report

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.

Response

Success.

countinteger required

Total count of items

Example response

{
  "accounts": [
    {
      "accountNumber": "1100",
      "name": "Credit Card Payment",
      "type": "Payments",
      "hasChildren": true,
      "isArchived": false
    },
    {
      "accountNumber": "1100",
      "name": "Bank Transfer",
      "type": "Payments",
      "hasChildren": false,
      "isArchived": true
    }
  ],
  "count": 0
}

Changes

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