API Reference

/accounting/v1.0/source-balances/{sourceKind}/{sourceId}

get
https://api.cloudbeds.com/accounting/v1.0/source-balances//

Retrieve the financial balance summary for a specific source. The source can be a reservation, house account, group profile, or accounts receivable ledger, identified by the sourceKind and sourceId path parameters. The response includes a detailed breakdown of charges (subtotal, additional items, taxes, fees), payments, refunds, upcoming payments, and the overall balance due. Use the optional Accept-Language header to receive localized tax and fee names.

Path Params
string
enum
required

The type of source entity. Determines how the sourceId is interpreted.

Allowed:
int64
required

Unique identifier of the source entity. The meaning depends on the sourceKind parameter: a reservation ID, house account ID, group profile ID, or accounts receivable ledger ID.

Headers
int64
required

Unique identifier of the property. Required for all requests to scope data to a specific property.

string
enum
Defaults to en-US

Language preference for localized tax/fee names. Supports: en-US (English US), es-ES (Spanish Spain), es-MX (Spanish Mexico), fr-FR (French), de-DE (German), it-IT (Italian), pt-PT (Portuguese Portugal), pt-BR (Portuguese Brazil). Defaults to en-US if not provided or unsupported language is specified.

Responses

Updated 27 days ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 27 days ago