Browse the API reference

Change Reporting Style

post/extensions/roboledger/{graph_id}/operations/change-reporting-style

Part of Extensions: RoboLedger.

Switch the reporting entity's Reporting Style — how its statements are laid out (equity-form, close-target concept, per-statement Networks). Validates that the target Style has a complete composition in the tenant schema, then flips entities.reporting_style_id. Omit entity_id to target the graph's primary entity. Filed Reports are unaffected (their FactSet rows pin their structures at create-time); new reports use the new Style. Idempotent on the same id.

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

NameTypeDescription
graph_idrequiredstringGraph Id

Header parameters

NameTypeDescription
Idempotency-KeyoptionalstringIdempotency-Key

Request body

Required, application/json.

FieldTypeDescription
reporting_style_idrequiredstring

Structure id of the target Reporting Style. Must exist in the tenant schema with a complete Network composition.

entity_idoptionalstring

Target entity. Omit to target the graph's primary (earliest-created) entity — the single-entity default.

Example request

curl
curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/change-reporting-style" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "reporting_style_id": "10d05f23-8ea8-5348-b8c9-f1e65bbda4a3"
}'

Responses

200 Successful Response

FieldTypeDescription
operationrequiredstring

Kebab-case operation name

operationIdrequiredstring

op_-prefixed ULID for audit and SSE correlation

statusrequiredstring

Operation lifecycle state

One of: completed, pending, failed

resultoptionalChangeReportingStyleResponse

Command-specific result payload

ChangeReportingStyleResponse fields
FieldTypeDescription
entity_idrequiredstring

Entity whose Style was targeted.

previous_reporting_style_idoptionalstring

Style id before the change (null for legacy/unset).

reporting_style_idrequiredstring

Active Style id after the call.

reporting_style_codeoptionalstring

4-segment Style code (e.g. BSC-CORP-IS02-CF1), when stamped.

changedrequiredboolean

False when the target equals the current Style (no-op).

atrequiredstring

ISO-8601 UTC timestamp

createdByoptionalstring

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

idempotentReplayoptionalboolean

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

Default: false

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