reporting_profile.select

What it does

Pin the business to one exact reporting-profile package and scope using an immutable approval document.

Before you send it

Requires an interactive OAuth connection; headless credentials are refused. Effective membership, application grant and token permissions still apply. Describe reporting_profile.select 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.

Field	Type	Required	Meaning and accepted values
`packageId`	string	Yes	Example: `"us-gaap-private-c-corp-software-services-2026.1"`.
`jurisdiction`	string	Yes	Example: `"US"`.
`legalEntityScope`	string	Yes	Example: `"private-c-corporation-software-services"`.
`framework`	string	Yes	Example: `"US GAAP"`.
`frameworkEdition`	string	Yes	Example: `"2026"`.
`policyElections`	array	Yes	Items: string. Maximum items: `32`.
`overrides`	array	No	Items: object. Maximum items: `100`.
`overrides[].ruleId`	string	Yes
`overrides[].destination`	object	Yes
`overrides[].destination.code`	string	Yes
`overrides[].destination.label`	string	Yes
`overrides[].destination.reportLineIds`	array	Yes	Items: string. Minimum items: `1`. Maximum items: `32`.

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.

Field	Type	Required	Meaning and accepted values
`packageId`	string	Yes
`jurisdiction`	string	Yes
`legalEntityScope`	string	Yes
`framework`	string	Yes
`frameworkEdition`	string	Yes
`policyElections`	array	Yes	Items: string.
`overrideSetCid`	string	No
`overrides`	array	Yes	Items: object.
`overrides[].ruleId`	string	Yes
`overrides[].destination`	object	Yes
`overrides[].destination.code`	string	Yes
`overrides[].destination.label`	string	Yes
`overrides[].destination.reportLineIds`	array	Yes	Items: string. Minimum items: `1`. Maximum items: `32`.
`evidenceDocumentId`	string	Yes
`evidenceDocumentCid`	string	Yes

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_profile.select"
    },
    "input": {
      "type": "object",
      "required": [
        "packageId",
        "jurisdiction",
        "legalEntityScope",
        "framework",
        "frameworkEdition",
        "policyElections"
      ],
      "properties": {
        "packageId": {
          "type": "string"
        },
        "jurisdiction": {
          "type": "string"
        },
        "legalEntityScope": {
          "type": "string"
        },
        "framework": {
          "type": "string"
        },
        "frameworkEdition": {
          "type": "string"
        },
        "policyElections": {
          "type": "array",
          "maxItems": 32,
          "items": {
            "type": "string"
          }
        },
        "overrides": {
          "type": "array",
          "maxItems": 100,
          "items": {
            "type": "object",
            "required": [
              "ruleId",
              "destination"
            ],
            "properties": {
              "ruleId": {
                "type": "string"
              },
              "destination": {
                "type": "object",
                "required": [
                  "code",
                  "label",
                  "reportLineIds"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "reportLineIds": {
                    "type": "array",
                    "minItems": 1,
                    "maxItems": 32,
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "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": [
        "packageId",
        "jurisdiction",
        "legalEntityScope",
        "framework",
        "frameworkEdition",
        "policyElections",
        "overrides",
        "evidenceDocumentId",
        "evidenceDocumentCid"
      ],
      "properties": {
        "packageId": {
          "type": "string"
        },
        "jurisdiction": {
          "type": "string"
        },
        "legalEntityScope": {
          "type": "string"
        },
        "framework": {
          "type": "string"
        },
        "frameworkEdition": {
          "type": "string"
        },
        "policyElections": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "overrideSetCid": {
          "type": "string"
        },
        "overrides": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "ruleId",
              "destination"
            ],
            "properties": {
              "ruleId": {
                "type": "string"
              },
              "destination": {
                "type": "object",
                "required": [
                  "code",
                  "label",
                  "reportLineIds"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "reportLineIds": {
                    "type": "array",
                    "minItems": 1,
                    "maxItems": 32,
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "evidenceDocumentId": {
          "type": "string"
        },
        "evidenceDocumentCid": {
          "type": "string"
        }
      }
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "cid": {
            "type": "string"
          }
        }
      }
    }
  }
}

Example request

{
  "name": "reporting_profile.select",
  "input": {
    "packageId": "us-gaap-private-c-corp-software-services-2026.1",
    "jurisdiction": "US",
    "legalEntityScope": "private-c-corporation-software-services",
    "framework": "US GAAP",
    "frameworkEdition": "2026",
    "policyElections": [
      "private-company-alternatives-not-elected"
    ]
  },
  "effective_at": "2026-09-01T00:00:00Z",
  "idempotency_key": "reporting_profile.select-example-0"
}