CLcloudbeds
SourceBalance

Get source balance

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.

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

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/accounting/v1.0/source-balances/{sourceKind}/{sourceId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Implicit: https://hotels.cloudbeds.com/api/v1.2/oauth
      Scopes: read:payment

Path parameters

sourceKind'RESERVATION' | 'HOUSE_ACCOUNT' | 'GROUP_PROFILE' | 'ACCOUNTS_RECEIVABLE_LEDGER' required

The type of financial source that owns transactions and balances. RESERVATION is an individual guest booking, HOUSE_ACCOUNT is a property-level account for miscellaneous charges, GROUP_PROFILE is a group booking that can aggregate charges from multiple reservations, and ACCOUNTS_RECEIVABLE_LEDGER tracks balances transferred for later collection.

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

sourceIdinteger 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

X-Property-IDinteger required

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

Accept-Language'en-US' | 'es-ES' | 'es-MX' | 'fr-FR' | 'de-DE' | 'it-IT' | 'pt-PT' | 'pt-BR'

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.

Response

OK

currencystring

Currency code (e.g., USD)

currencyScaleinteger

Number of decimal places for the currency

grandTotalnumber double

Grand total amount in smallest currency unit

subtotalnumber double

Subtotal amount in smallest currency unit

additionalItemsnumber double

Additional items amount in smallest currency unit

arTransfernumber double

Accounts receivable transfer amount in smallest currency unit

amountPaidnumber double

Amount paid in smallest currency unit

refundIssuednumber double

Refund issued amount in smallest currency unit

upcomingPaymentsnumber double

Upcoming payments amount in smallest currency unit

upcomingRefundnumber double

Upcoming refund amount in smallest currency unit

cancellationFeenumber double

Cancellation fee amount in smallest currency unit

noShowFeenumber double

No show fee amount in smallest currency unit

balanceDuenumber double

Balance due amount in smallest currency unit

channelCommissionnumber double

Channel commission amount in smallest currency unit

gratuitynumber double

Gratuity (TIP) total in smallest currency unit (ITC 8995 family).

updatedAtstring date-time

Timestamp when the balance was last updated (UTC)

Changes

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