CLcloudbeds
Folios

Get folio balance summary

Retrieve a summary of each folio for a given source (reservation or group profile). Returns a map keyed by folio ID, where each value contains the folio's balance due. The balance is computed from both posted and pending transactions assigned to each folio.

get/accounting/v1.0/folios/summary

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/accounting/v1.0/folios/summary
  • Auth
    • HTTP bearer
    • or OAuth 2
      Implicit: https://hotels.cloudbeds.com/api/v1.2/oauth
      Scopes: read:payment

Query parameters

sourceIdinteger required

Filter by source ID

sourceKind'CONFIG' | 'RESERVATION' | 'GROUP_PROFILE' required

The type of source a folio belongs to. CONFIG indicates a folio configuration template, RESERVATION is an individual guest booking, and GROUP_PROFILE is a group booking profile.

Headers

X-Property-IDinteger required

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

Response

OK

folioIdstring

Folio ID

balanceDuenumber double

Balance due for this folio

upcomingPaymentsnumber double

Upcoming (pending) payments for this folio

Changes

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