APapaleo
CustomSubAccounts

Returns a list of all sub-accounts.

Returns a list of all sub-accounts.<br>You must have at least one of these scopes: 'subledger.read, setup.read, setup.manage'.

get/settings/v1/sub-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/settings/v1/sub-accounts
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: subledger.read, setup.read, setup.manage, admin

Query parameters

propertyIdstring required

ID of the property

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

{
  "subAccounts": [
    {
      "id": "MUC-TEA",
      "propertyId": "MUC",
      "code": "Tea",
      "name": "Finest green tea",
      "type": "FoodAndBeverages"
    }
  ],
  "count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.