---
title: "Returns a list of guest accounts."
method: GET
path: "/finance/v0-nsfw/guest-accounts"
tags: ["SubLedger"]
---

# Returns a list of guest accounts.

`GET /finance/v0-nsfw/guest-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/guest-accounts`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `subledger.read`, `accounting.read`, `admin`

Returns a list of accounts in one property for a reservation.<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_guest_accounts.read'.

## Query parameters

- `propertyId` string, required
- `reservationId` string, required
- `parent` string
- `languageCode` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Success.

- FinanceAccountListModel
  - `accounts` SlimFinanceAccountModel[], required: List of accounts in a property, having one specific parent.
    - `accountNumber` string, required: The account number. Unique identifier within one property.
    - `name` string, 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.
    - `parentNumber` string, nullable: Parent account number. Null for top-level accounts.
    - `hasChildren` boolean, required: Indicates whether this account has children / sub accounts or not.
    - `isArchived` boolean, required: Indicates whether this account is archived ot not.
    - `vat` VatItemModel
      - `type` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required: The VAT type
      - `percent` number, double, required: The currently valid percent to calculate the VAT
    - `subAccounts` SlimFinanceAccountModel[], nullable: Sub accounts for this accounts.
  - `count` integer, required: Total count of items

## Other responses

- `204`: No accounts found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api-not-safe-for-work/revisions/72cbd31f02f4?raw)