Create Dimension

post/extensions/roboledger/{graph_id}/operations/create-dimension

Add a member to a management dimension: a department, class, location or project (or an axis of your own) that ledger lines can carry, one member per axis per line. value is the member's stable key within its axis, a slug of the name when omitted; a second member with the same key returns 409. Tag lines with its id through dimension_ids on a journal line, and read the income statement by it with live-financial-statement's dimension.

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

Field	Type	Description
`dimension_type`required	string	The axis: `department`, `class`, `location` or `project`, or any other lowercase name, which starts an axis of its own. `scenario` is reserved for forecasts. Constraints: matches `^[a-z][a-z0-9_]{0,39}$`
`name`required	string	The member's label. Constraints: 1–200 characters
`value`optional	string	The member's stable key within the axis; omitted, a slug of the name. Refused (409) when the axis already has it. Constraints: 1–200 characters

dimension_typerequired

string

The axis: department, class, location or project, or any other lowercase name, which starts an axis of its own. scenario is reserved for forecasts.

Constraints: matches ^[a-z][a-z0-9_]{0,39}$

namerequired

string

The member's label.

Constraints: 1–200 characters

valueoptional

string

The member's stable key within the axis; omitted, a slug of the name. Refused (409) when the axis already has it.

Constraints: 1–200 characters

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/create-dimension" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "dimension_type": "string",
  "name": "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

DimensionResponse

Command-specific result payload

DimensionResponse fields

Field	Type	Description
`id`required	string	The member's id, as lines carry it.
`dimension_type`required	string	The axis: department, class, location, project, or another.
`name`required	string	The member's label.
`value`required	string	The member's stable key within its axis: the source's id for a synced member, a slug of the name for one created here.
`source`optional	string	Where the member came from: `native` or `quickbooks`. Default: `native`
`is_active`required	boolean	False once retired: the member stays on the lines that carry it and can no longer be put on new ones.
`line_count`optional	integer	How many ledger lines carry the member. Default: `0`
`created_at`optional	string (date-time)	When it was created.

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