CLcloudbeds
Folios

List folios for a source

Retrieve all folios for a given source (reservation, group profile, or configuration). Folios organize transactions into logical groups, such as separating room charges from incidentals. The filter requires both a sourceId and sourceKind to identify the source.

get/accounting/v1.0/folios

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/accounting/v1.0/folios
  • 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

idstring

Folio ID

namestring

Folio name

propertyIdstring

Property ID

configurationIdstring

Folio configuration ID

folioConfigurationIdstring

Deprecated. Use configurationId instead. Folio configuration ID.

parentIdstring

Parent folio ID (null for root folios)

sourceIdstring

Source ID (reservation ID, group profile ID, or config ID)

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

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.

routeChildrenTypesRouteChildrenType[]

Child transaction types that follow their parent to this folio. Reflects the folio's current value — set manually via POST/PUT or inherited from the configuration template via propagation.

Changes

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