RoboLedger: Ledger & Events

Set Allocation Override

Set the outside owners' share of a member's result for one month in place of the pro-rata share its ownership percentage gives: a preferred return, a waterfall, a special allocation. Give the share as an amount in cents (negative for a share of a loss) or as a percentage of the month's result, with the basis; clear removes it. preview- and propose-consolidation-entries then use it for that month, and their basis says so. Only for a member consolidated in full, and refused in a month the consolidation entity has closed.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

post/extensions/roboledger/{graph_id}/operations/set-allocation-override

Request

  • Base URL: https://api.robosystems.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/set-allocation-override
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

graph_idstring required

Headers

Idempotency-Keystring nullable

Request body

entity_idstring required

The member, consolidated in full.

periodstring required

The month, as YYYY-MM.

amountinteger nullable

The outside owners' share of the month's result, in cents; negative for a share of a loss.

percentagenumber nullable

The outside owners' share as a percentage of the month's result.

basisstring nullable

Why the share differs from the ownership percentage; required to set one.

clearboolean

Remove the month's override, back to the pro-rata share.

Response

Successful Response

operationstring required

Kebab-case operation name

operationIdstring required

op_-prefixed ULID for audit and SSE correlation

status'completed' | 'pending' | 'failed' required

Operation lifecycle state

atstring required

ISO-8601 UTC timestamp

createdBystring nullable

User ID that initiated the operation

idempotentReplayboolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Changes

No recorded changes to this operation across all 1 revision of this API.