Record compensation result

POST

/v1/actions/hospitality.action.record_compensation_result/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_compensation_result/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "compensation_note": "example", "compensation_status": "compensated", "compensation_step_run_id": "example", "external_reference": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.workflow_step_run" } }'

• Production API

Records the outcome of a declared compensating action / function / manual step against the original successful terminal step. When compensation_step_run_id is set the handler creates the workflow_step_run_compensates_step_run self-link from the compensating row to the original. Recomputes the parent run’s compensation state and emits workflow_step.compensated / workflow_step.compensation_failed. Failed compensation is terminal evidence, never an excuse to delete the original step.

Effects: modify hospitality.workflow_step_run; modify hospitality.workflow_run; link hospitality.link.workflow_step_run_compensates_step_run.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.record_compensation_result: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

compensation_note

Bounded text note

string

compensation_status

required

compensated | compensation_failed | manual_required

string

Allowed values: compensated compensation_failed manual_required

compensation_step_run_id

Creates `workflow_step_run_compensates_step_run` when set

string

external_reference

PSP/PMS/manual-task reference

string

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.workflow_step_run

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.workflow_step_run_compensates_step_run

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: modified

object_type

required

Allowed values: hospitality.workflow_step_run hospitality.workflow_run

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.workflow_step_run_compensates_step_run"
    }
  ],
  "modified_objects": [
    {
      "kind": "modified",
      "object_type": "hospitality.workflow_step_run"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.