Folios

Route transactions to a group profile

Route reservation transactions to a group profile folio. Routing binds reservation transactions to a group profile and assigns them to the specified folio. You can specify individual transaction IDs or transaction types (by origin ID and external relation kind) to route all matching transactions at once. At least one of transactions or transactionTypes must be provided.

post/accounting/v1.0/folios/transactions/route

Request

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

Headers

X-Property-IDinteger required

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

Request body

reservationIdinteger required

Reservation ID (source of the transactions to route)

groupProfileIdinteger required

Group profile ID (target of the routing)

targetFolioIdinteger required

Target folio ID where transactions will be assigned

sourceFolioIdinteger

Optional. Scopes the operation to the transactions the folio list endpoint returns for this folio (deposit-account transactions are excluded; pending transactions count in their routed-to folio; applies to both transactions and transactionTypes selection). The folio must belong to the request's source (for route: to the reservation). When omitted, transactions are matched across all folios of the source.

transactionsinteger[]

List of transaction IDs to route. Required if transactionTypes is not provided.

Response

OK

Changes

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