RoboLedger: Fiscal Close

Set Close Target

Set the user-controlled goal period for closing (close_target). Format: YYYY-MM. Distinct from closed_through (what's actually locked) — setting a target doesn't close anything; call close-period for that. The catch-up sequence between closed_through and this target appears on the response's fiscal_calendar.catch_up_sequence.

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/set-close-target

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/set-close-target
  • 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 whose books this acts on, by id. Omit for the group parent — the single-entity default.

periodstring required

Target period in YYYY-MM format. Must be > current closed_through.

notestring nullable

Free-form note attached to the audit event

Example request

{
  "period": "2026-03"
}

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.