Draft Financial Report

Independently reviewed reporting entities, exact FX translation and balanced eliminations.

POST/api/v1/general_ledger/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/general_ledger/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: DRAFT_FINANCIAL_REPORT" \
  -H "Content-Type: application/json" \
  -d '{
    "configuration": {
      "asOf": "2026-01-15",
      "eliminations": [
        {
          "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "credit": "string",
          "debit": "string",
          "evidence": "string"
        }
      ],
      "entities": [
        {
          "functionalCurrency": "USD",
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "name": "string"
        }
      ],
      "evidence": "string",
      "mappings": [
        {
          "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "entityId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "statementCode": "string"
        }
      ],
      "name": "string",
      "rates": [
        {
          "effectiveOn": "2026-01-15",
          "evidence": "string",
          "fromCurrency": "USD",
          "rate": "string",
          "toCurrency": "USD"
        }
      ],
      "reportingCurrency": "USD"
    },
    "report_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: FinanceThe caller must hold this role or a higher one.
Multi-factor sign-in: Required. The access token must come from a session that completed multi-factor sign-in.
Action: DRAFT_FINANCIAL_REPORT

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be DRAFT_FINANCIAL_REPORT for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

configurationobjectRequired
No description yet.
8 child fields
- asOfdateRequired
  No description yet.
- eliminationsarray of objectRequired
  No description yet.
  4 child fields
  accountIduuidRequired
  No description yet.
  creditstringRequired
  No description yet.
  debitstringRequired
  No description yet.
  evidencestringRequired
  No description yet.
- entitiesarray of objectRequired
  No description yet.
  3 child fields
  functionalCurrencystringRequired
  No description yet.
  iduuidRequired
  No description yet.
  namestringRequired
  No description yet.
- evidencestringRequired
  No description yet.
- mappingsarray of objectRequired
  No description yet.
  3 child fields
  accountIduuidRequired
  No description yet.
  entityIduuidRequired
  No description yet.
  statementCodestringRequired
  No description yet.
- namestringRequired
  No description yet.
- ratesarray of objectRequired
  No description yet.
  5 child fields
  effectiveOndateRequired
  No description yet.
  evidencestringRequired
  No description yet.
  fromCurrencystringRequired
  No description yet.
  ratestringRequired
  No description yet.
  toCurrencystringRequired
  No description yet.
- reportingCurrencystringRequired
  No description yet.
report_iduuidRequired
No description yet.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send DRAFT_FINANCIAL_REPORT.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below finance, the session has not completed multi-factor sign-in, or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.