Deactivate or reactivate a chart account
set_chart_account_activeDeactivates (active=false) or reactivates (active=true) a chart account. Deactivating hides it from new categorisation but never deletes it — existing transactions keep their account and still appear in the P&L. REFUSED for system accounts (required by the pipeline) and for any account that counterparty rules point at (repoint or remove those rules first — the error says how many). Audit-trailed. actor_id is optional — it defaults to the organisation entity, and if provided must belong to this org.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | Yes | true to reactivate (un-hide), false to deactivate (hide from new selection). | |
| org_id | No | Optional. Defaults to the organisation the authenticated API key is bound to, so you normally omit it and never need to ask the user for their organisation UUID. If provided, it must match the key’s org or the request is rejected. | 0e91146d-511c-469f-bdee-5c867b26ae0d |
| reason | Yes | Why the change. Stored verbatim in the audit trail. | |
| actor_id | No | Optional. Defaults to the organisation entity (correct for an org-scoped key). If provided, it must be an entity belonging to this organisation — arbitrary UUIDs are rejected, so the audit trail cannot be attributed to someone else. | |
| account_id | Yes | The account id from list_chart_accounts. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | Yes |