APapaleo
SubLedger

Returns a list of child accounts for a specified parent account.

<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_accounts.read'.

get/finance/v0-nsfw/accounts/child-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/v0-nsfw/accounts/child-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

parentstring required

Filter account list by the parent account's number.

languageCodestring

The language for the the report

accountingSchema'Simple' | 'Extended'

Allows to override the default accounting schema

includeArchivedboolean

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

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 4 revisions of this API.