Skip to content
aerandil.com
GitHub

Validate Record utility cost (dry-run)

POST
/v1/actions/hospitality.action.record_utility_cost/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_utility_cost/validate \
  --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", "consumption_quantity": "example", "consumption_unit": "kwh", "external_ref": "example", "kind": "electricity", "period_end": "2026-04-15", "period_start": "2026-04-15", "source": "invoice_import" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

Dry-run of apply_hospitality_action_record_utility_cost’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
consumption_quantity
Metered consumption quantity (requires consumption_unit)
string format: decimal
consumption_unit
Consumption unit (requires consumption_quantity)
string
Allowed values: kwh mwh therm mmbtu gallon cubic_meter litre kilogram pound ton tonne cubic_yard other
external_ref
Invoice-line id (idempotency anchor)
string
kind
required
USALI Schedule 9 account
string
Allowed values: electricity natural_gas fuel_oil propane steam chilled_water renewable_electricity water sewer waste_landfill waste_recycling waste_organics waste_hazardous contract_services other
period_end
Billing-period end (optional)
string format: date
period_start
Billing-period start (optional)
string format: date
source
Provenance (defaults to `invoice_import`)
string
Allowed values: invoice_import manual
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

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}