Bind folio routing rule

POST

/v1/actions/hospitality.action.bind_folio_routing_rule/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.bind_folio_routing_rule/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "applies_to": "all", "charge_category_filter": [ "rooms" ], "priority": 1, "source_folio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "target_folio_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

• Production API

Create or update a folio routing rule between source and target folios at a property. The folio handler walks active rules at charge post-time.

Effects: create hospitality.folio_routing_rule; modify hospitality.folio_routing_rule; link hospitality.link.folio_routing_rule_source; link hospitality.link.folio_routing_rule_target; link hospitality.link.folio_routing_rule_at_property; link hospitality.link.folio_part_of_group_master.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.bind_folio_routing_rule:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

applies_to

required

Applies to

string

Allowed values: all charge_codes charge_categories percentage capped_amount

charge_category_filter

Buckets the rule takes (applies_to = charge_categories)

Array<string>

Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail

priority

required

Priority

integer

source_folio_id

required

Source folio

string format: uuid

target_folio_id

required

Target folio

string format: uuid

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.folio_routing_rule_source hospitality.link.folio_routing_rule_target hospitality.link.folio_routing_rule_at_property hospitality.link.folio_part_of_group_master

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created modified

object_type

required

Allowed values: hospitality.folio_routing_rule

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.folio_routing_rule_source"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.folio_routing_rule"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.