Create a folio

post

https://api.cloudbeds.com/accounting/v1.0/folios

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

propagateDownstream

boolean

Defaults to false

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

Body Params

name

string

required

Folio name

sourceId

string

required

Source ID (reservation ID or group profile ID)

sourceKind

string

enum

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.

Allowed:

routeChildrenTypes

array of objects

Child transaction types that follow their parent to this folio

routeChildrenTypes

Allowed:

transactionTypes

array of objects

required

Transaction types to assign to this folio

transactionTypes*

Headers

X-Property-ID

int64

required

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

Responses

201Created

400Bad Request

403Access denied