Rental API contracts
Rental command preflight, expected versions and locks, conflict and error responses, association endpoints, command results, and the generated rental lifecycle contract tables.
Rental state transitions emit rental.state_changed with the usual id and action envelope plus from and to. Document changes use enquiry, quote, and order. Returns to an active status use status identifiers such as quote_lost → quote_pencilled or order_complete → order_active; configured statuses use their underlying system status for this transition evidence. Status updates and fulfilment promotions retain rental.status_changed and rental.status_promoted. Asset status corrections emit rental.asset_status_changed with assignment_id, from, and to (for example on_hire → allocated).
Guard keys follow rental.transition.<target>, including order, quote, enquiry, and active. The workflow handler rentals.transition.order confirms an order with the same approval, credit and shortage checks; its optional to input accepts only order. Its target-specific identifier preserves the handler's order-specific retry and approval contract. Workflow filters for order confirmation must require trigger.payload.from = quote and trigger.payload.to = order.
Flat rental fields
Rental requests, responses, MCP tools, webhook payloads, plugin fields, imports, exports, reports and merge fields use the database column names throughout.
| Facts | Fields |
|---|---|
| Dates | starts_at, ends_at, ordered_at, is_open_ended |
| Billing | billing_period_starts_at, billing_period_ends_at, uses_billable_days, billable_days |
| Delivery | customer_collects, delivery_address_id, delivery_instructions |
| Collection | customer_returns, collection_address_id, collection_instructions |
| Amounts | subtotal, tax_total, total, agreed_total |
| Amounts by kind | rental_total, sale_total, service_total, sub_hire_total, transit_total, loss_damage_total |
| Base amounts | subtotal_base, tax_total_base |
The four choice fields is_open_ended, uses_billable_days, customer_collects and customer_returns are booleans. When uses_billable_days is true, supply a non-negative billable_days value. Switching it to false clears the day count. Dates are ISO-8601 UTC instants. On update, omitted fields retain their values; nullable address and instruction fields can be cleared with null.
Money responses use decimal major-unit strings with currency_code, matching invoices. Base amounts use base_currency_code. Amounts remain null when their original precision evidence is unavailable. Create accepts an initial subtotal: an integer is minor units; a decimal string or float is major units. Calculated amounts are read-only; use the pricing commands to change pricing.
{
"title": "Festival lighting",
"starts_at": "2026-12-01T09:00:00Z",
"ends_at": "2026-12-04T17:00:00Z",
"uses_billable_days": true,
"billable_days": "3",
"customer_collects": true,
"customer_returns": false
}
The same names apply to filter[starts_at][gte], filter[customer_collects][eq]=true, sort=-subtotal, and fields=id,title,subtotal. Address expansions use include=delivery_address,collection_address. The grouped request keys schedule, billing, fulfilment and totals are rejected even when empty or null; validation identifies the flat replacement fields. Grouped filter and sort names, sparse fieldsets and address includes also return replacement guidance.
Rental state transitions
Use POST /api/v1/rentals/{rental}/transitions with a JSON to target. Read available_actions first: state-transition entries use key = to, with allowed, reason and code. Pass the key directly as to; each key occurs once. Preview the same request with dry_run: true; guards run again during execution.
| Current rental | Target to |
Result |
|---|---|---|
| Enquiry | quote |
Pencilled quote |
| Open, pencilled quote | enquiry |
Enquiry; releases reserved demand |
| Open quote | order |
Active order, subject to shortage and approval checks |
| Open order without dispatch history | quote |
Pencilled quote; releases FX/tax locks |
| Lost, expired or postponed quote | quote_pencilled |
Pencilled quote |
| Cancelled order | order_active |
Active order |
| Completed order | active |
Active order |
Supply expected_version from the last read, and an optional audit reason for backward moves. Order confirmation also accepts shortage_notes and approval_request_id. A stale version returns 409 version_conflict; a target outside the published enum returns a 422 validation error; a supported target that cannot be reached returns 422 invalid_state or the guard's specific refusal code. Dry runs validate the same enum and return state or guard refusals in data without changing state, versions or approvals.
The curated MCP tool is change-rental-state with to and the same transition fields. Its action=change option changes a status within the current state; action=complete and action=cancel retain explicit descendant selections and preview versions. REST cancellation and cloning keep their dedicated endpoints. The UI calls the same domain actions directly.
Overview
Rental reads enforce the parent record policy and account legal-record access. Lists and rental trees omit records the caller may not view; related assets, availability, activity and pricing previews require access to the rental.
This page is the integration reference for rental commands over REST and MCP. For what rentals are, the screens and how to use them, see Rentals. For operator checks and repair commands, see Rental operations.
State-transition preflight and expected versions
The rental page and API use the same current-row preflight engine to report allowed actions and refusal reasons (GET /api/v1/rentals/{rental}/available_actions). A preview can become stale; the later command rechecks current permissions and domain rules before changing the rental. The user-facing action list is in Rentals → State-transition actions.
The shared conversion and confirmation modals capture the rental's aggregate version and bind it to the selected action. Confirmation passes that version to document-state changes, returns to active status, completion, cancellation, archiving, cloning, price-lock changes and invoiced-flag changes. If another command changes the rental, confirmation refuses the original preview without applying the command. Reopen the preview, review the current rental and confirm again. Changing the selected action without opening its preview is also refused. A clone checks the source version under its read lock but does not advance that source version.
Price-lock confirmation captures its Lock/Unlock direction from the same rental row as the version. Its message and command use that captured direction; a refreshed version must not be paired with an older opposite-direction message.
REST and MCP endpoint callers can supply expected_version for archive, clone, price-lock commands and header updates as well as lifecycle commands. An invalid version returns 422; a stale version returns 409 with code: version_conflict. The version is optional; omitting it skips the stale-version check.
Warehouse edits require current access to both the source and target warehouse. Each human edit refreshes current source warehouse access before the policy gate, including a repeated call from the same process after revocation or restoration. The root edit reserves current user warehouse grants before its Rental lock, then rechecks access at the mutation boundary. A grant revoked before that reservation can refuse an edit even if its preview was allowed. Reload the rental and review current access before retrying. Existing caller transactions and nested mutations retain their own lock-order requirements.
Direct flightcase nesting refreshes current source warehouse access before its policy gate and checks the flightcase target warehouse before command validation or fulfilment receipt lookup. The mutation repeats target authority under the flightcase asset row lock. Restoring both grants permits the same actor to submit a fresh valid command; a completed command key replays its original result without another nesting event. REST and MCP execute callers pass raw flightcase intent to the action so current target access is checked before the version or command payload is validated. Authorized malformed and nonexistent target input still returns validation errors. HTTP idempotency authorization fingerprints refresh the current warehouse grant memo before completed response replay; a changed grant returns HTTP 403 with idempotency_replay_authorization_changed and no cached asset response. Scoped route lookup still conceals inaccessible source rentals. Root unkeyed flightcase nesting reserves current human grants through the existing outer fulfilment owner before customer and Rental locks. Source and target revocations serialize in both holder orders without creating a fulfilment receipt. Repeating the current nesting with the current version is an inert no-op. An already active mutation continues joining its caller; complete nested caller admission remains separate.
Direct related item creation, item substitution, optional-item changes and money-unit recording require current target-warehouse access before payload work and recheck it at the locked write boundary. Version comparisons check both source rentals before reading their lines. These checks apply even when the caller has already loaded an otherwise hidden rental. Restore warehouse access before retrying.
The REST move-items endpoint authorizes the source rental before validating the move payload. A hidden source can still be concealed by route lookup; malformed target intent does not grant source access. The destination remains subject to its separate current warehouse and mutation checks.
Quantity changes, line removal and tree edits retry a database concurrency failure within the owning transaction's bounded retry policy. If that root transaction exhausts its attempts, the command returns a validation refusal with HTTP 422 and mutation_retry_exhausted; reload the latest rental before trying again. A command inside a caller-owned outer transaction passes the database failure back to that owner. Successful tree edits return committed totals. The line-item editor shows a save refusal and clears its busy state so the operator can review and retry.
Direct rental mutation commands, including asset substitution in the web assets tab, bound both account and rental prefix locks by the configured credit lock timeout. Contention returns rental_lock_timeout through REST; the assets tab shows “This rental is busy. No change was made; reload and retry.” The failed command leaves the assignment and its effects unchanged and can be submitted again after contention clears.
The approval-submission modal also uses its captured version. A changed rental is refused before the command creates an approval request; notes remain in the open modal for review. Reopening refreshes the preview and resets its notes.
Associated create/extension forms capture the parent version and warehouse timezone when opened. Commands check that parent version under the association-tree locks before creating a child or copying any lines. REST and curated MCP use the optional expected_version field for the same check. The parent remains unchanged, including its version. The Restore button submits its rendered archived version; restore alone explicitly includes archived rows in its primary rental lock lookup; ordinary header, line and item mutations retain active-only admission, including cached locks. Restore rechecks the warehouse-aware delete policy under lock. Restoring an already active rental with a current or omitted precondition is a no-op without a new event or version increment.
Conflicts after owner locks
Rental mutations refresh their loaded model and event-state inputs after taking their owner locks. A customer change while an edit waits for its owner lock returns 409 version_conflict, with the current version and the permitted conflict summary. An event queue based on an older persisted aggregate also returns this conflict before committing. Draft-invoice edits return the existing invoice ownership conflict when a waited account merge or selected invoice/source-line change invalidates their captured participants. Unrelated missing participants keep their existing validation refusal. Asset substitution validates the committed assignment state before allocating an event ID, so its existing 422 invalid_state refusal does not advance the ID allocator cache sequence.
After a conflict, read the current resource, review the intended edit against its current customer, lines and version, and submit a fresh command. These checks preserve the command's current owner and participant facts; historical money and replay operations still require their recorded source evidence and their own domain rules.
Warehouse timezone changes over the API
The API accepts ISO 8601 instants with an explicit offset and returns UTC instants. A PATCH that changes only warehouse_id across timezone boundaries applies the same wall-clock-preserving rebase to omitted rental and item schedule fields; explicitly supplied datetime fields remain the UTC instants in the request. API callers do not receive the form confirmation, so they should make this choice deliberately.
See Rental phases for ordered phases and blocking extents.
Associated rentals endpoints
See Rentals → Associated Rentals for the behaviour and permissions.
| Endpoint | Purpose |
|---|---|
GET /api/v1/rentals/{rental}/tree |
The whole tree from the root, depth-annotated |
POST /api/v1/rentals/{rental}/associations |
Associate this rental beneath a parent |
DELETE /api/v1/rentals/{rental}/associations |
Detach from its parent |
POST /api/v1/rentals/{rental}/associated |
Create a child rental |
POST /api/v1/rentals/{rental}/extend |
Create a child and copy fresh line items into it |
POST /api/v1/rentals/{rental}/lines/move |
Move unfulfilled lines to another rental in the same tree |
GET /api/v1/rentals/{rental}/cascade_preview?action=complete|cancel |
Root readiness plus authorized descendants, versions and refusal reasons before selection |
POST /api/v1/rentals/{rental}/complete |
Complete; selected descendants require matching root expected_version and cascade_expected_versions |
POST /api/v1/rentals/{rental}/cancel |
Cancel; selected descendants require matching root expected_version and cascade_expected_versions |
Rental payloads carry parent_rental_id, and parentRental is available as an include. available_actions gains create_associated and extend_associated. Associating and detaching emit the rental.associated and rental.dissociated events — see Webhooks.
Service date sources
The rental-line API exposes date_source (delivery, collection, or hire_window) together with date_source_starts_at and date_source_ends_at. Compare those source timestamps with the line's starts_at and ends_at to determine whether a service is still synchronised or has been manually overridden.
Command results
Fulfilment DTOs add an optional command_result sidecar. It identifies the existing command_receipt by kind and opaque ID, and carries aggregate_version, fulfilment_phase, code and evidence. A completed human single or Quick receipt captures the version and phase inside its owning transaction; retries restore those original facts, including when the rental has changed later. REST and MCP expose the same DTO sidecar. The assets Livewire component publishes it as lastCommandResult and keeps coded refusals alongside the existing operator message.
Scanner results identify their durable scan_event; allocation workflow results identify their workflow_attempt and retain the captured sidecar in the existing attempt output. These native contracts do not provide human keyed single/Quick adapters: human_receipt_adapter is unavailable with human_receipt_adapter_code set to fulfilment_adapter_unavailable. They retain their existing scan-intent and workflow-effect retry authorities. The owning workflow attempt transaction uses the released three-attempt concurrency retry boundary, including acknowledgement persistence; a caller-owned enclosing transaction must unwind to its owner instead of being retried inside the handler.
Unversioned, unkeyed and pending nested results leave unsupported original version/phase facts null with evidence: unavailable; no current projection is substituted for missing original evidence. An incomplete human receipt returns fulfilment_outcome_unknown and instructs the caller to reconcile the recorded movement. It never re-runs that movement. Existing authorization, intent-conflict, expiry, owner-change, boundary and expected-version refusal codes remain unchanged; no raw command key or credential is exposed.
Rental lifecycle contracts
The tables below describe rental source contracts, also represented in the OpenAPI RentalLifecycleCapabilities example and the rental preflight MCP tool. They describe the lifecycle contract, not the current user's permissions.
Source contract reference
These installed source contracts are not current actor, resource or tenant permissions. Use the rental available-actions preflight before a command; it is checked again at execution. State/status and configured prerequisites remain runtime-only. Events, totals and handoffs are conditional; retries do not imply exactly-once delivery.
State changes use POST /api/v1/rentals/{rental}/transitions with to set to enquiry, quote, order, active, quote_pencilled, order_active. MCP: change-rental-state. State-transition entries use key = to: pass the action key directly as to. Read available_actions and use dry_run before execution.
| State | Default status |
|---|---|
| Enquiry | enquiry_unconfirmed |
| Quote | quote_pencilled |
| Order | order_active |
| Status | State | Value | Derived | Manually selectable |
|---|---|---|---|---|
| EnquiryUnconfirmed | enquiry | enquiry_unconfirmed | no | yes |
| QuotePencilled | quote | quote_pencilled | no | yes |
| QuoteHeld | quote | quote_held | no | yes |
| QuoteLost | quote | quote_lost | no | yes |
| QuoteExpired | quote | quote_expired | no | yes |
| QuotePostponed | quote | quote_postponed | no | yes |
| OrderActive | order | order_active | no | yes |
| OrderDispatched | order | order_dispatched | yes | no |
| OrderOnHire | order | order_on_hire | yes | no |
| OrderReturned | order | order_returned | yes | no |
| OrderChecked | order | order_checked | yes | no |
| OrderComplete | order | order_complete | no | yes |
| OrderCancelled | order | order_cancelled | no | yes |
| Command | Permissions, entry-point versions/retries and potential effects |
|---|---|
rental.accept.version |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["VersionAccepted"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.activate.version |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"conditional_credit_command","key":"idempotencyKey","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["VersionActivated"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.add.rental.cost |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostAdded"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","dashboard","finance","numbering","project_resources","webhooks","workflow"]}} |
rental.add.rental.group |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemAdded"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","numbering","webhooks","workflow"]}} |
rental.add.rental.line |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"idempotencyKey","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","ItemAdded","ItemDiscountSet","RentalIncludedRelatedItemsRepriced"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","catalogue_pricing_publication","finance","numbering","webhooks","workflow"]}} |
rental.add.rental.related.item |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemAdded"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","numbering","webhooks","workflow"]}} |
rental.adjust.loose.quantity |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["LooseQuantityAdjusted"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.allocate.asset |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetAllocated"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","numbering","webhooks","workflow"]}} |
rental.allocate.assets |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetAllocated"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","numbering","webhooks","workflow"]}} |
rental.apply.discount.group |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"commandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","DiscountGroupRepriced","ItemDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.associate.rental |
{"permissions":["rentals.edit","rentals.view"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalEffectiveProjectChanged","RentalParentSet"],"totals_effect":"none","external_handoffs":["audit","dashboard","finance","project_resources","webhooks","workflow"]}} |
rental.cancel.rental |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"conditional_credit_command","key":"idempotencyKey","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalStatusChanged"],"totals_effect":"none","external_handoffs":["audit","availability","boards","dashboard","datatable_chips","finance","guard_pipeline","reports","webhooks","workflow"]}} |
rental.change.line.dates |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostAdded","CostRemoved","CostUpdated","DiscountGroupApplied","ItemDatesChanged","ItemDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","boards","finance","numbering","webhooks","workflow"]}} |
rental.change.line.quantity |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","ItemDiscountSet","ItemQuantityChanged"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","guard_pipeline","webhooks","workflow"]}} |
rental.change.line.rate |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemRateChanged"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","catalogue_pricing_publication","finance","guard_pipeline","webhooks","workflow"]}} |
rental.change.rental.status |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalStatusChanged"],"totals_effect":"none","external_handoffs":["audit","availability","boards","dashboard","datatable_chips","finance","guard_pipeline","reports","webhooks","workflow"]}} |
rental.change.version.label |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["VersionLabelChanged"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.check.asset |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetChecked","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.clear.agreed.price |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"commandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AgreedPriceCleared","ItemAgreedPriceDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.clear.asset.flightcase |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"command.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetFlightcaseCleared"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.clear.section.agreed.price |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["GroupAgreedPriceCleared","ItemAgreedPriceDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.clone.rental |
{"permissions":["rentals.create","rentals.edit","rentals.view"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"source_or_parent_lock_only_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostAdded","DiscountGroupApplied","ItemAdded","ItemDiscountSet","RentalCloned","RentalCreated"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","boards","catalogue_pricing_publication","dashboard","datatable_chips","finance","numbering","project_resources","reports","webhooks","workflow"]}} |
rental.complete.rental |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"conditional_credit_command","key":"idempotencyKey","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalStatusChanged"],"totals_effect":"none","external_handoffs":["audit","availability","boards","dashboard","datatable_chips","finance","guard_pipeline","reports","webhooks","workflow"]}} |
rental.transition.order |
{"permissions":["rentals.edit","shortages.ignore","shortages.resolve"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"conditional_credit_command","key":"creditCommandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}},"confirmedVersionIdFor":{"aggregate_version":{"mode":"unsupported","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalConvertedToOrder","VersionActivated","VersionSuperseded"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","guard_pipeline","identity_reservation","webhooks","workflow"]}} |
rental.transition.quote |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalQuoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","guard_pipeline","webhooks","workflow"]}} |
rental.create.associated.rental |
{"permissions":["rentals.create","rentals.view"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"source_or_parent_lock_only_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalCreated","RentalEffectiveProjectChanged","RentalParentSet"],"totals_effect":"none","external_handoffs":["audit","boards","dashboard","datatable_chips","finance","numbering","project_resources","reports","webhooks","workflow"]}} |
rental.create.rental |
{"permissions":["rentals.create"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"unsupported","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalCreated"],"totals_effect":"none","external_handoffs":["audit","boards","dashboard","datatable_chips","finance","numbering","reports","webhooks","workflow"]}} |
rental.create.rental.with.lines |
{"permissions":["rentals.create","rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"unsupported","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","ItemAdded","ItemDiscountSet","RentalCreated","RentalIncludedRelatedItemsRepriced"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","boards","catalogue_pricing_publication","dashboard","datatable_chips","finance","numbering","reports","webhooks","workflow"]}} |
rental.create.version |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"unsupported","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","ItemAdded","ItemDiscountSet","VersionCreated","VersionSuperseded"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","catalogue_pricing_publication","finance","numbering","webhooks","workflow"]}} |
rental.deallocate.asset |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"idempotencyKey","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}},"execute":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetDeallocated","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.decline.version |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["VersionDeclined"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.delete.rental |
{"permissions":["rentals.delete"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalDeleted"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.delete.version |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemRemoved","VersionDeleted"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.detach.associated.rental |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalEffectiveProjectChanged","RentalParentDetached"],"totals_effect":"none","external_handoffs":["audit","dashboard","finance","project_resources","webhooks","workflow"]}} |
rental.dispatch.asset |
{"permissions":["equipment_tests.override_dispatch","rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetDispatched","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","identity_reservation","webhooks","workflow"]}} |
rental.dispatch.assets |
{"permissions":["equipment_tests.override_dispatch","rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetDispatched","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","identity_reservation","webhooks","workflow"]}} |
rental.dispatch.loose.quantity |
{"permissions":["equipment_tests.override_dispatch","rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["LooseQuantityDispatched","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","identity_reservation","webhooks","workflow"]}} |
rental.extend.rental.into.child |
{"permissions":["rentals.create","rentals.edit","rentals.view"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"source_or_parent_lock_only_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","ItemAdded","ItemDiscountSet","RentalCreated","RentalEffectiveProjectChanged","RentalParentSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","boards","catalogue_pricing_publication","dashboard","datatable_chips","finance","numbering","project_resources","reports","webhooks","workflow"]}} |
rental.lock.rental |
{"permissions":["rentals.unlock_rates"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalLocksApplied"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.mark.asset.on.hire |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"command.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetOnHire","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.merge.rental.lines |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"commandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostAdded","CostRemoved","CostUpdated","DiscountGroupApplied","ItemDatesChanged","ItemDiscountSet","ItemPriceOverridden","ItemQuantityChanged","ItemRemoved"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","boards","finance","numbering","webhooks","workflow"]}} |
rental.move.lines.to.rental |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","ItemAdded","ItemDiscountSet","ItemRemoved","RentalIncludedRelatedItemsRepriced"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","catalogue_pricing_publication","finance","numbering","webhooks","workflow"]}} |
rental.override.line.price |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemPriceOverridden"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.override.rental.line.surcharge |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["SurchargeOverridden"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.prepare.asset |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"command.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetPrepared"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.prepare.assets |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetPrepared"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.rebase.rental.pricing.terms |
{"permissions":["rentals.rebase_pricing_terms","shortages.ignore"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"required","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"required_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"not_admitted"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["PricingRecalculated"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","fulfilment","guard_pipeline","identity_reservation","webhooks","workflow"]}} |
rental.recalculate.rental |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountGroupApplied","DiscountReset","ItemAgreedPriceDiscountSet","ItemDiscountSet","ItemPriceOverridden","PricingRecalculated"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.transition.active |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalReinstated"],"totals_effect":"none","external_handoffs":["audit","availability","finance","guard_pipeline","webhooks","workflow"]}} |
rental.remove.rental.cost |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostRemoved"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","dashboard","finance","project_resources","webhooks","workflow"]}} |
rental.remove.rental.line |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"optional_keyed_command","key":"deleteRequestKey","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemRemoved"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.rename.rental.line |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemRenamed"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.transition.active.from.complete |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalReopened"],"totals_effect":"none","external_handoffs":["audit","availability","finance","guard_pipeline","webhooks","workflow"]}} |
rental.reorder.rental.lines |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemsRestructured"],"totals_effect":"none","external_handoffs":["audit","finance","fulfilment","identity_reservation","webhooks","workflow"]}} |
rental.restore.rental |
{"permissions":["rentals.delete"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalRestored"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.restructure.rental.lines |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"unsupported","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemRemoved","ItemsRestructured"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.return.asset |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetReturned","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.return.assets |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetChecked","AssetReturned","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.return.loose.quantity |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["LooseQuantityReturned","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.revert.asset.preparation |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"command.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetPreparationReverted"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.change.asset.status |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetStatusReverted","RentalStatusPromoted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.transition.enquiry |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalRevertedToEnquiry"],"totals_effect":"none","external_handoffs":["audit","availability","finance","guard_pipeline","webhooks","workflow"]}} |
rental.transition.quote.from.order |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalRevertedToQuotation"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","guard_pipeline","webhooks","workflow"]}} |
rental.send.version |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["VersionSent"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.set.agreed.price |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"commandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AgreedPriceSet","GroupAgreedPriceCleared","ItemAgreedPriceDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.set.asset.flightcase |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetFlightcaseSet"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.set.line.discount |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["DiscountManuallyOverridden","ItemDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.set.section.agreed.price |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["GroupAgreedPriceSet","ItemAgreedPriceDiscountSet"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.substitute.asset |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"optional_keyed_command","key":"data.idempotency_key","receipt_scope":"keyed_command","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["AssetSubstituted"],"totals_effect":"none","external_handoffs":["audit","availability","finance","fulfilment","webhooks","workflow"]}} |
rental.substitute.line |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"commandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemSubstituted"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.toggle.line.optional |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"required_for_interactive_tree_intent","unrecorded_or_repair_omission":"conditional","active_version_precondition":true},"retry":{"mode":"conditional_credit_command","key":"commandId","receipt_scope":"credit_branch_only","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemOptionalToggled"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","finance","webhooks","workflow"]}} |
rental.toggle.rental.surcharge.group |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["SurchargeToggled"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","guard_pipeline","webhooks","workflow"]}} |
rental.unlock.rental |
{"permissions":["rentals.unlock_rates"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["RentalLocksReleased"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","finance","webhooks","workflow"]}} |
rental.update.rental |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostAdded","CostRemoved","CostUpdated","ItemDatesChanged","RentalHeaderDateBatchRepriced","RentalUpdated"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","availability","boards","finance","identity_reservation","numbering","webhooks","workflow"]}} |
rental.update.rental.cost |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["CostUpdated"],"totals_effect":"conditional_projection_or_direct","external_handoffs":["audit","dashboard","finance","project_resources","webhooks","workflow"]}} |
rental.update.rental.line.details |
{"permissions":["rentals.edit"],"entry_points":{"__invoke":{"aggregate_version":{"mode":"optional_nullable","scope":"owning_rental"},"tree_revision":{"mode":"unsupported","unrecorded_or_repair_omission":"unsupported","active_version_precondition":false},"retry":{"mode":"unsupported","key":null,"receipt_scope":"none","unkeyed":"no_general_replay_guarantee"}}},"prerequisites":"runtime_only","effects":{"conditional":true,"events":["ItemDetailsUpdated"],"totals_effect":"none","external_handoffs":["audit","finance","webhooks","workflow"]}} |
Fulfilment batches and rental headers
Rental lines use catalogue_item_id as an optional catalogue reference and line_type as their structural role: group, catalogue_item, component, related_item, service or text. Groups and free-text lines have no catalogue reference. A related item line belongs beneath its principal catalogue line and has its own price and availability demand. Components describe a kit’s bill of materials; related items are supplied alongside the principal. These fields apply when adding a line, substituting its catalogue reference, filtering, and comparing quote versions.
Inline lines in POST /api/v1/rentals cannot use component or related_item: those roles require an existing principal. After creating the rental, use POST /api/v1/rentals/{rental}/lines with principal_item_id for a related item, or with parent_path for a component. A component's parent path must identify a catalogue item line in the same rental and active quote version. Invalid placement returns 422 without creating a line or emitting events.
Create an asset assignment with POST /api/v1/rentals/{rental}/asset_assignments and a body containing rental_line_id and asset_id. The line must belong to the bound rental. Update its fulfilment action with PATCH /api/v1/rentals/{rental}/asset_assignments/{assignment}, or release it with DELETE at the same path. {assignment} identifies the assignment record, while asset_id identifies the physical asset. Rental lines expose the asset_assignments collection when requested with include=asset_assignments on the lines endpoint or include=lines.asset_assignments on the rental endpoint. Keyed deletion retries preserve their original result after the assignment is removed.
For a bulk line, use PATCH /api/v1/rentals/{rental}/lines/{line}/fulfilment. Dispatch requires action: "dispatch" and a positive quantity; return requires action: "return", a positive quantity, and condition: "good" or "damaged". Missing quantities must be recorded as a return exception. Adjust requires action: "adjust" and a nonnegative new_quantity, so zero is accepted. Quantities may be JSON numbers or decimal strings with at most two decimal places. Each action accepts only its own fields, plus optional idempotency_key and expected_version; dispatch and adjust also accept credit_override_id. Unknown or irrelevant fields return 422. Over-dispatch, over-return and adjustments below dispatched quantity are refused without recording any movement.
{"action":"dispatch","quantity":"4.00"}
Use POST /api/v1/rentals/{rental}/fulfilment_batches with a stage of allocate, prepare, dispatch or return and a nonempty lines array. Allocation lines identify the rental line and asset; other stages identify assignments. Scan identifiers can replace the asset or assignment selection; see the examples below. Each stage enforces its own permissions and admission checks. HTTP Idempotency-Key handling and domain command receipts retain their documented scopes; an uncertain outcome requires reconciliation before another movement.
Rental headers use flat fields including owner_id, quote_expires_at, starts_at, ends_at, uses_billable_days, customer_collects, customer_returns, subtotal, tax_total and total. The same names apply to request bodies, resource responses, filters, sorts, webhooks and MCP tools. See Flat rental fields for flat names, partial update rules and the request example, and Rental labels lookup for string state and status identities. Participants are managed at /api/v1/rentals/{rental}/participants and included with include=participants or include=participants.account.
Use customer_notes for customer-facing notes, tax_inclusive when entered prices include tax, and priority for sales priority from 0 to 5. Priority may be null.
Scan identifiers and partial batches
Each allocation line supplies rental_line_id and exactly one of asset_id, barcode, asset_number or scannable_identifier. Prepare, dispatch and return lines supply exactly one of assignment_id, barcode, asset_number or scannable_identifier; scan identifiers resolve to an open assignment on this rental. Normal rental, warehouse, stage and asset eligibility checks remain in force.
POST /api/v1/rentals/42/fulfilment_batches
Content-Type: application/json
{"stage":"allocate","partial":true,"lines":[{"rental_line_id":12,"barcode":"ASSET-1001"},{"rental_line_id":12,"asset_number":"UNKNOWN"}]}
A 207 Multi-Status response can contain one applied line and one unresolved line. The rental resource is abbreviated:
{
"data":{"id":42},
"meta":{"results":[
{"index":0,"status":"ok","rental_line_id":12,"asset_id":1001,"assignment_id":null},
{"index":1,"status":"unknown_identifier","rental_line_id":12,"asset_id":null,"assignment_id":null}
]}
}
Per-line results are in meta.results, never a top-level results. They are included when any line uses a scan identifier or the request supplies partial (even false). The zero-based index identifies the input line; nullable IDs describe resolution, so an allocation result need not contain the newly created assignment ID. Statuses are ok, unknown_identifier, ambiguous_identifier, not_an_asset, line_not_found, wrong_catalogue_item, already_allocated, not_on_rental, duplicate_in_batch and refused; a refusal can include message.
Without partial: true, an unresolved or refused line fails the whole batch with 422 and no movement. Partial mode returns 200 if every line succeeds and 207 if any line is not applied. An unkeyed partial batch can attempt resolved lines separately after a combined domain refusal. A keyed partial batch applies its resolved lines as one keyed command and returns 422 if that command is refused. Reconcile before changing keys or resubmitting uncertain movements.
Approval pre-check
GET /api/v1/rentals/{rental}/available_actions is a read-only pre-check requiring rentals.view and rentals:read. It evaluates the current actor, state and guards, including approvals. An abbreviated response when confirmation needs approval:
{"data":[{"key":"order","to":"order","label":"Confirm order","allowed":false,"reason":"Approval is required.","code":"approval_required"}]}
To preview a specific command, send:
POST /api/v1/rentals/42/transitions
Content-Type: application/json
{"to":"order","dry_run":true}
{"data":{"dry_run":true,"allowed":false,"reason":"Approval is required.","code":"approval_required"}}
The preview requires rentals.edit and rentals:write; it neither opens nor consumes an approval request. Treat code as the stable decision and reason as display text. Execution rechecks the guards. With a published confirmation approval chain, a real first attempt returns 422 approval_required and opens a pending request. Find it through GET /api/v1/approval-requests by its subject.id and transition_key. Assigned approvers approve it, then the original requester using the same token retries the transition with approval_request_id. Approval alone leaves the rental a quote. A changed payload needs a new Idempotency-Key; reusing the original key with the added approval reference returns 409 idempotency_conflict.
External references and changed rentals
Use PUT /api/v1/rentals/by-external-ref/{ref} for integration upserts and filter[external_ref][eq] for lookups. Integration identities describes the contract. A line edit advances the rental's updated_at; filter[updated_at][gte] with include_deleted=true lets a synchroniser collect header, line and retained deletion changes together. Read linked service-line finalisation through resource assignment completion.
Rental line metadata and selectors
Line creation validates line_type before dispatch: an unknown value returns 422 instead of falling back to a catalogue item. Line updates accept custom_fields for rental-line metadata, with optional expected_version and idempotency_key. Metadata changes use the same rental mutation boundary; they do not change tree structure or commercial values. A stale supplied version returns 409. Use the tree endpoint to reorder or nest lines.
For manual unit_price, integers are minor units; floats and decimal strings are major units. A keyed fulfilment adjustment to the quantity already stored returns 422: retry the original command key to replay its receipt.
Validation and refusal codes
Rental line create and update require a recognised string line_type. Arrays, booleans, numbers, null and unknown values return 422 before dispatch. unit_price and discount_percent accept the documented integer, number or numeric-string forms.
Structural changes to accepted pricing return 422 with code: accepted_pricing_locked. A keyed fulfilment adjustment to the current quantity returns 422 with code: no_quantity_change; replaying the original matching key retains normal replay semantics. Refresh the rental and choose a valid change before submitting a new intent.