APapaleo
SubLedger

Returns one account.

Returns one account, as specified by its number and the property.<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/v1/accounts/{number}

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

Path parameters

numberstring required

The account number

Query parameters

propertyIdstring required

Specifies the property the account is in.

transactionLimitinteger

Limit how many transactions should be included in the view (between 0 and 50, defaults to 0).

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

Response

Success.

accountNumberstring required

The account number. Unique identifier within one property.

namestring required

The name of the account.

type'Revenues' | 'Payments' | 'Liabilities' | 'Receivables' | 'Vat' | 'House' | 'AccountsReceivable' | 'CityTaxes' | 'TransitoryItems' | 'VatOnLiabilities' | 'LossOfAccountsReceivable' | 'SecondCityTax' | 'GuestLevies' required

The type of account.

hasChildrenboolean required

Indicates whether this account has children / sub accounts or not. The children can be retrieved via GET /accounts and querying by parent.

parentNumberstring nullable

Parent account number. Null for top-level accounts.

isArchivedboolean required

Indicates whether this account is archived ot not.

Example response

{
  "accountNumber": "1000",
  "name": "Other Revenues",
  "type": "Revenues",
  "hasChildren": false,
  "parentNumber": "5000",
  "isArchived": false,
  "transactions": [
    {
      "timestamp": "2026-10-23T11:50:37.1321675+02:00",
      "date": "2026-10-23",
      "debitedAccount": {
        "name": "Cash Payment",
        "number": "1600",
        "type": "Payments"
      },
      "creditedAccount": {
        "name": "Revenues Accommodation",
        "number": "5001",
        "type": "Receivables"
      },
      "command": "PostCharge",
      "amount": {
        "amount": 180,
        "currency": "EUR"
      },
      "entryNumber": "2017122500000001",
      "reference": "SRC-123",
      "referenceType": "Guest",
      "entryGroupNumber": "2017122500000001"
    },
    {
      "timestamp": "2026-10-23T12:50:37.1321675+02:00",
      "date": "2026-10-23",
      "debitedAccount": {
        "name": "Cash Payment",
        "number": "1600",
        "type": "Payments"
      },
      "creditedAccount": {
        "name": "Revenues Accommodation",
        "number": "5001",
        "type": "Receivables"
      },
      "command": "PostCharge",
      "amount": {
        "amount": 210,
        "currency": "EUR"
      },
      "entryNumber": "2017122500000002",
      "reference": "SRC-123",
      "referenceType": "Guest",
      "entryGroupNumber": "2017122500000002"
    }
  ]
}

Changes

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