Link Entity to Taxonomy

post/extensions/roboledger/{graph_id}/operations/link-entity-taxonomy

Link the graph's entity to a taxonomy. Idempotent — returns existing linkage if it already exists. CoA blocks auto-link at create time; use this only to switch the primary CoA or link a reporting extension / custom ontology explicitly.

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

Header parameters

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

Request body

Required, application/json.

Field	Type	Description
`taxonomy_id`required	string	The taxonomy to link to.
`basis`optional	string	Linkage role: `chart_of_accounts` (the entity's CoA), `reporting` (reporting standard like us-gaap), `mapping` (CoA→reporting rollup), `schedule` (schedule structure). One of: `reporting`, `chart_of_accounts`, `mapping`, `schedule` Default: `chart_of_accounts`
`is_primary`optional	boolean	Mark this as the primary linkage for the basis. False allows secondary attachments (e.g. parallel reporting standards). Default: `true`
`adoption_context`optional	string	Why the entity is reporting under this taxonomy (e.g. 'voluntary', 'regulatory', 'lender_requirement'). Default: `voluntary`

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/link-entity-taxonomy" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "basis": "chart_of_accounts",
  "taxonomy_id": "tax_acme_coa"
}'

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

EntityTaxonomyResponse

Command-specific result payload

EntityTaxonomyResponse fields

Field	Type	Description
`entity_id`required	string	The entity that was linked.
`taxonomy_id`required	string	The taxonomy that was linked.
`basis`required	string	Linkage role (see request).
`is_primary`required	boolean	Whether this is the primary linkage.
`adoption_context`optional	string	Adoption context recorded at link time.

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation (null for legacy callers)

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