Set Allocation Override

post/extensions/roboledger/{graph_id}/operations/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.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id Constraints: matches `^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?\|sec(?:_[a-zA-Z0-9]{1,20})?\|library)$`

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`entity_id`required	string	The member, consolidated in full.
`period`required	string	The month, as YYYY-MM. Constraints: matches `^\d{4}-(0[1-9]\|1[0-2])$`
`amount`optional	integer	The outside owners' share of the month's result, in cents; negative for a share of a loss.
`percentage`optional	number	The outside owners' share as a percentage of the month's result. Constraints: 0–100
`basis`optional	string	Why the share differs from the ownership percentage; required to set one.
`clear`optional	boolean	Remove the month's override, back to the pro-rata share. Default: `false`

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/set-allocation-override" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_id": "string",
  "period": "string"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

AllocationOverrideResponse

Command-specific result payload

AllocationOverrideResponse fields

Field	Type	Description
`entity_id`required	string	The member.
`period`required	string	The month, as YYYY-MM.
`amount`optional	integer	The share, in cents, when set so.
`percentage`optional	number	The share as a percentage, when set so.
`basis`optional	string	Why it differs from pro rata.
`set_by`optional	string	Who set it.
`cleared`optional	boolean	True when the override was removed. Default: `false`

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation

idempotentReplayoptional

boolean

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

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error