Folio Configuration

Get autorouting rules

Retrieve the autorouting rules configured for a group profile. Autorouting rules define which transaction types are automatically routed from reservations to a group profile folio.

get/accounting/v1.0/folios/rules

Request

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

Query parameters

sourceIdinteger required

Group Profile ID

sourceKind'GROUP_PROFILE'

Deprecated. Defaults to GROUP_PROFILE if not provided.

subSourceIdinteger

Allotment Block ID. When provided, filters rules to only that block. When omitted, returns only group-level rules unless includeSubSourceRules is true.

includeSubSourceRulesboolean

When true and subSourceId is omitted, also includes block-level (sub-source) rules in the response. Ignored when subSourceId is provided.

Headers

X-Property-IDinteger required

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

Response

OK

propertyIdstring

Property ID

sourceIdstring

Group Profile ID

sourceKind'GROUP_PROFILE'

Deprecated. Defaults to GROUP_PROFILE if not provided.

subSourceIdstring

Allotment Block ID. Null for group-level rules.

Changes

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