v1
latestOpenAPI 3.0.12026-07-245277551.2 MBDeposits
Get deposit balance
Retrieve the deposit balance for a specific source or the entire property. To get the balance for a specific reservation or other source, provide both sourceId and sourceKind. To get the aggregate deposit balance for the whole property, omit both parameters. The response includes the posted balance and pending balance in the smallest currency unit.
get/accounting/v1.0/deposits/balance
Query parameters
sourceIdinteger
Identifier of the source to get the deposit balance for (e.g., a reservation ID). Omit along with sourceKind to get the property-wide deposit balance.
sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER'
Kind of the source entity
Type of the source entity. Required when sourceId is provided.
Headers
X-Property-IDinteger required
Property id
Response
OK