CLcloudbeds
Folios

Create a folio

Create a new folio for a source (reservation, group profile, or configuration). You must provide a name, the source details, and the transaction types assigned to it.

post/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: write:payment

Query parameters

propagateDownstreamboolean

When true and source kind is CONFIG, create matching child folios for active reservations and groups using this configuration.

Headers

X-Property-IDinteger required

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

Request body

namestring required

Folio name

sourceIdstring required

Source ID (reservation ID or group profile 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.

routeChildrenTypesRouteChildrenType[]

Child transaction types that follow their parent to this folio

Response

Created

idstring required

Created folio ID

Changes

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