APapaleo
SubLedger

Returns the chart of accounts of the subledger.

Returns the schema of subledger, split into global and guest ledger.<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_schema.read'.

get/finance/v0-nsfw/accounts/schema

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/accounts/schema
  • 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

depthinteger

How many hierarchy levels to include (between 1 and 4, default is 1).

includeArchivedboolean

If set to true, also includes archived accounts. If not set, or set to false, it only returns non-archived accounts

accountingSchema'Simple' | 'Extended'

Allows to override the default accounting schema. Only specify this, when you know what you are doing.

languageCodestring

The language for the the report. If not specified, language code from "Accept-Language" will be used.

Response

Success.

Example response

{
  "globalAccounts": [
    {
      "accountNumber": "9000",
      "name": "House",
      "type": "House",
      "hasChildren": false,
      "isArchived": true
    },
    {
      "accountNumber": "1000",
      "name": "Payments",
      "type": "Payments",
      "hasChildren": true,
      "isArchived": false
    },
    {
      "accountNumber": "5000",
      "name": "Revenues",
      "type": "Revenues",
      "hasChildren": true,
      "isArchived": false
    }
  ],
  "guestAccounts": [
    {
      "accountNumber": "3000",
      "name": "Guest Liabilities",
      "type": "Liabilities",
      "hasChildren": true,
      "isArchived": false
    },
    {
      "accountNumber": "1200",
      "name": "Guest Receivables",
      "type": "Receivables",
      "hasChildren": true,
      "isArchived": false
    }
  ],
  "externalAccounts": [
    {
      "accountNumber": "1200",
      "name": "External Receivables",
      "type": "Receivables",
      "hasChildren": true,
      "isArchived": false
    }
  ],
  "bookingAccounts": [
    {
      "accountNumber": "1200",
      "name": "Liabilities",
      "type": "Liabilities",
      "hasChildren": true,
      "isArchived": false
    }
  ]
}

Changes

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