---
title: "Get autorouting rules"
method: GET
path: "/accounting/v1.0/folios/rules"
tags: ["Folio Configuration"]
---

# Get autorouting rules

`GET /accounting/v1.0/folios/rules`

## Request

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

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.

## Query parameters

- `sourceId` integer, required
- `sourceKind` 'GROUP_PROFILE': Deprecated. Defaults to GROUP_PROFILE if not provided.
- `subSourceId` integer
- `includeSubSourceRules` boolean

## Headers

- `X-Property-ID` integer, required

## Response `200`

OK

- RoutingRuleResponse[]
  - `propertyId` string: Property ID
  - `sourceId` string: Group Profile ID
  - `sourceKind` 'GROUP_PROFILE': Deprecated. Defaults to GROUP_PROFILE if not provided.
  - `subSourceId` string: Allotment Block ID. Null for group-level rules.
  - `rules` RoutingRuleEntryResponse[]: Rule entries. For group-level rules this contains exactly one entry (no folioId). For block-level rules each entry targets a different folio.
    - `id` string: Rule entry ID
    - `enabled` boolean: Whether this rule entry is enabled
    - `folioId` string: Target folio ID for this entry
    - `routeChildrenTypes` RouteChildrenType[]: Child transaction types that follow their parent to the same folio
    - `transactionTypes` RoutingRuleTransactionTypeResponse[]: Transaction types this entry routes
      - `externalRelationKind` 'ROOM' | 'PAYMENT' | 'ITEM' | 'ITEM_POS' | 'ADDON' | 'RESERVATION' | 'ACCOUNTS_RECEIVABLE' | 'ROOM_REVENUE' | 'TAX' | 'FEE' | 'ADJUSTMENT' | 'PAYMENT_FEE' | 'BOOKABLE_RESOURCE' | 'CHANNEL_COMMISSION' | 'CITY_LEDGER' | 'GRATUITY' | 'CHECK_ITEM' | 'CHECK_SERVICE_CHARGE' | 'CHECK_DISCOUNT' | 'CHANNEL_COMMISSION_MANUAL': Kind of the external relation
      - `originId` string: Origin ID for the transaction type (e.g., fee ID, tax ID)

## Other responses

- `400`: Bad Request
- `404`: Not found

---

[API](https://skmtc.dev/cloudbeds/apis/accounting-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/accounting-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/accounting-api/revisions/0b58c698deef?raw)