RoboLedger: Taxonomy & Mapping

Link Entity to Taxonomy

Link an entity to a taxonomy. Idempotent — returns the existing linkage if it already exists. CoA blocks auto-link at create time; use this to switch an entity's primary chart of accounts. Only the chart_of_accounts basis changes behavior: a reporting, mapping or schedule link records the association and nothing reads it. Statements render from the entity's reporting style (change-reporting-style), and custom statement rows come from a reporting extension of that style.

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/link-entity-taxonomy

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/link-entity-taxonomy
  • 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 nullable

The entity to link, by id. Omit for the group parent.

taxonomy_idstring required

The taxonomy to link to.

basis'reporting' | 'chart_of_accounts' | 'mapping' | 'schedule'

Linkage role: chart_of_accounts (the entity's CoA), reporting (a reporting standard), mapping (CoA→reporting rollup), schedule (schedule structure). Only chart_of_accounts is read; the others are recorded and do not change how statements render.

is_primaryboolean

Mark this as the primary linkage for the basis. False allows secondary attachments (e.g. parallel reporting standards).

adoption_contextstring nullable

Why the entity is reporting under this taxonomy (e.g. 'voluntary', 'regulatory', 'lender_requirement').

Example request

{
  "basis": "chart_of_accounts",
  "taxonomy_id": "tax_acme_coa"
}

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.