Accounts
Chart of accounts.
GET /accountsList accountsPOST /accountsCreate an accountGET /accounts/{account_id}Get an accountPATCH /accounts/{account_id}Update an accountGET /posting-mappingsList posting mappingsPOST /posting-mappingsCreate or change a posting mapping
List accounts
GET /accounts
Sends Vortex-Entity.
Requires ledger:read.
Parameters
| Name | In | Type | About |
|---|---|---|---|
limit | query | integer | |
starting_after | query | string | |
type | query | AccountType | |
include_inactive | query | boolean |
Answers
Create an account
POST /accounts
Sends Vortex-Entity and Idempotency-Key.
Requires accounts:write.
Body
Answers
Get an account
GET /accounts/{account_id}
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
account_id required | path | string |
Answers
Update an account
PATCH /accounts/{account_id}
Sends Vortex-Entity.
Renames, re-maps or deactivates an account. The account type cannot change once the account has postings, and accounts are never deleted. Requires accounts:write.
Parameters
| Name | In | Type | About |
|---|---|---|---|
account_id required | path | string |
Body
Answers
List posting mappings
GET /posting-mappings
Sends Vortex-Entity.
The entity's posting rules: which account each role, category, tax jurisdiction, card processor, payroll tax or deduction posts to. Requires ledger:read.
Parameters
| Name | In | Type | About |
|---|---|---|---|
kind | query | PostingMappingKind |
Answers
Create or change a posting mapping
POST /posting-mappings
Sends Vortex-Entity and Idempotency-Key.
Upserts by kind and key. The account must be active and of a type that suits the mapping (422 wrong_account_type); a role must be one SYNC's posting rules use (422 unknown_role). Future events post differently; posted entries don't change, and events held for review wait to be re-posted. The change is written to the audit log. Requires accounts:write, which platform keys can't hold.
Body
Answers
- 200 PostingMapping. The mapping.
- 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
- 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

