APapaleo
CustomSubAccounts

Create a sub-account.

Create a sub-account.<br>You must have at least one of these scopes: 'subledger.manage, setup.manage'.

post/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.manage, setup.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

propertyIdstring required

ID of the property

codestring required

Code of the sub-account. Has to be unique per property, and must not be one of the reserved codes:

  • Unspecified
  • System
  • Normal
  • Reduced
  • VeryReduced
  • Special
  • Null
  • Without
namestring required

Name of the sub-account

type'Other' | 'Accommodation' | 'FoodAndBeverages' required

Service type of the sub-account

Example request

{
  "propertyId": "MUC",
  "code": "TEA",
  "name": "Finest green tea",
  "type": "FoodAndBeverages"
}

Response

Creation of the new sub-account was successful.

idstring required

The ID of the sub-account

Example response

{
  "id": "MUC-Tea"
}

Changes

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