reporting_adjustment.post

What it does

Post a balanced, evidenced framework adjustment for the business’s selected reporting package. An adjustment dated before a functional-currency change is recorded in the current ledger at the frozen change rate.

Before you send it

Requires an interactive OAuth connection; headless credentials are refused. Effective membership, application grant and token permissions still apply. Describe reporting_adjustment.post through GET /v1/catalog/commands/{name} before acting.

The envelope may reference a registered source document of kind source_document; this is separate from any evidence required by the input.

Inputs

Put these fields inside the envelope’s input object. The outer envelope names the command, a stable idempotency_key and effective_at; request and recovery rules explain those separately. Use exact minor-unit integer strings for monetary fields. Take existing IDs from prior reads or command results; choose a new identity only where the command asks for one.

Required means required within its containing object; an optional parent can be omitted.

After acceptance

When the command emits events, its documented effects and receipt are recorded in the command transaction. The response returns commandId, replayed, the command-specific result below and emitted events with their IDs and CIDs. A command is not automatically a cash movement or revenue recognition: use the behavior above to determine what this command records.

Inspect result and the affected records or reports before continuing. Save returned identifiers for later calls. Fetch GET /v1/commands/{id} with commandId to recover the accepted receipt; retry the same intent with the same idempotency key if the response was lost. Some commands can succeed with events: [] and return a transient result and commandId without persisting a receipt. A lookup of that ID can return null; retain the returned result and verify the affected record. Retrying can re-evaluate the current state rather than replay a stored result. A domain no_change is a separate success outcome with no persisted receipt.

Result fields

Required means required within its containing object; an optional parent can be omitted.

All commands · Operation and errors · Reusable schemas

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

Exact request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "const": "reporting_adjustment.post"
    },
    "input": {
      "type": "object",
      "required": [
        "packageId",
        "requirement",
        "description",
        "currency",
        "lines"
      ],
      "properties": {
        "packageId": {
          "type": "string"
        },
        "requirement": {
          "type": "string"
        },
        "description": {
          "type": "string",
          "maxLength": 1024
        },
        "currency": {
          "type": "string"
        },
        "lines": {
          "type": "array",
          "minItems": 2,
          "maxItems": 100,
          "items": {
            "type": "object",
            "required": [
              "accountCode",
              "direction",
              "amount"
            ],
            "properties": {
              "accountCode": {
                "type": "integer"
              },
              "direction": {
                "enum": [
                  "debit",
                  "credit"
                ]
              },
              "amount": {
                "type": "string",
                "pattern": "^(0|[1-9][0-9]*)$"
              },
              "subKey": {
                "type": "object",
                "properties": {
                  "kind": {
                    "enum": [
                      0,
                      1,
                      2,
                      3,
                      4,
                      5,
                      6
                    ]
                  },
                  "symbol": {
                    "type": "string"
                  },
                  "partyId": {
                    "type": "string"
                  },
                  "sku": {
                    "type": "string"
                  },
                  "financialAccountId": {
                    "type": "string"
                  },
                  "taxCodeId": {
                    "type": "string"
                  },
                  "expenseFunction": {
                    "enum": [
                      "cost_of_revenue",
                      "research_and_development",
                      "sales_and_marketing",
                      "general_and_administrative",
                      "other"
                    ]
                  }
                }
              },
              "asset": {
                "type": "string"
              },
              "assetAmount": {
                "type": "string"
              },
              "externalId": {
                "type": "string",
                "maxLength": 200
              }
            }
          }
        }
      },
      "additionalProperties": false
    },
    "idempotency_key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "effective_at": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    },
    "source_document_id": {
      "description": "A registered document of kind source_document that caused this command.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name",
    "input",
    "idempotency_key",
    "effective_at"
  ],
  "additionalProperties": false
}

Accepted command receipt

{
  "type": "object",
  "required": [
    "commandId",
    "replayed",
    "result",
    "events"
  ],
  "properties": {
    "commandId": {
      "type": "string"
    },
    "replayed": {
      "type": "boolean"
    },
    "imported": {
      "const": true,
      "description": "The command's events are history from before the business joined Economico, recorded as an import: free of monthly events."
    },
    "result": {
      "type": "object",
      "required": [
        "eventId"
      ],
      "properties": {
        "eventId": {
          "type": "integer"
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}

Example request

{
  "name": "reporting_adjustment.post",
  "input": {
    "packageId": "us-gaap-private-c-corp-software-services-2026.1",
    "requirement": "asc-350-40-internal-use-software-conclusion",
    "description": "Capitalize qualifying internal-use software costs",
    "currency": "USD",
    "lines": [
      {
        "accountCode": 1280,
        "direction": "debit",
        "amount": "10000"
      },
      {
        "accountCode": 5110,
        "subKey": {
          "kind": 6,
          "expenseFunction": "research_and_development"
        },
        "direction": "credit",
        "amount": "10000"
      }
    ]
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "reporting_adjustment.post-example-0"
}