Skip to content

Record labour cost

POST
/v1/actions/hospitality.action.record_labour_cost/apply
curl --request POST \
--url https://api.aerandil.com/v1/actions/hospitality.action.record_labour_cost/apply \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "amount": { "amount": "example", "currency": "example" }, "business_date": "2026-04-15", "department": "rooms", "external_ref": "example", "kind": "salaries_wages", "period_end": "2026-04-15", "period_start": "2026-04-15", "shift_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source": "timeclock", "staff_member_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Post one labour-cost amount from the payroll system of record — Aerandil never computes pay. Multi-day pay-period lines post to business_date un-prorated in v1; period_start/period_end preserve the source window. external_ref is the idempotency anchor for imports. Emits labour.cost.recorded for the daily_labour projection.

Effects: create hospitality.labour_ledger_entry; link hospitality.link.labour_entry_at_property; link hospitality.link.labour_entry_for_staff_member; link hospitality.link.labour_entry_for_shift.

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
amount
required
Amount
object
amount
required
string format: decimal
currency
required
string format: iso-4217
business_date
required
Accrual business date
string format: date
department
required
USALI 12 Schedule 15 department
string
Allowed values: rooms food_beverage health_club_spa golf parking minibar it_services retail other_operated minor_operated administrative_general information_telecom_systems sales_marketing property_ops_maintenance utilities
external_ref
Payroll-system line id (idempotency anchor)
string
kind
required
USALI labour-cost kind
string
Allowed values: salaries_wages service_charges_distributed contracted_labour bonuses_incentives payroll_taxes supplemental_pay employee_benefits
period_end
Pay-period end (optional)
string format: date
period_start
Pay-period start (optional)
string format: date
shift_id
Shift the accrual derives from (optional)
string format: uuid
source
Provenance (defaults to `payroll_import`)
string
Allowed values: timeclock payroll_import manual
staff_member_id
Staff member (optional — contracted labour and lump-sum imports may have none)
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
target
required
object
id
required
string format: uuid
object_type
required
Allowed value: hospitality.property

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.labour_entry_at_property hospitality.link.labour_entry_for_staff_member hospitality.link.labour_entry_for_shift
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
object_type
required
Allowed values: hospitality.labour_ledger_entry
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.labour_entry_at_property"
}
],
"modified_objects": [
{
"kind": "created",
"object_type": "hospitality.labour_ledger_entry"
}
]
}

Conflict — concurrent modification or unique constraint violation.

Validation error — parameter validation or business-rule violation.