Journal entries
The general ledger. Read entries, post manual entries, reverse entries.
GET /journal-entriesList journal entriesPOST /journal-entriesPost a manual journal entryGET /journal-entries/{journal_entry_id}Get a journal entryPOST /journal-entries/{journal_entry_id}/reverseReverse a journal entry
List journal entries
GET /journal-entries
Sends Vortex-Entity.
Requires ledger:read.
Parameters
| Name | In | Type | About |
|---|---|---|---|
limit | query | integer | |
starting_after | query | string | |
start_date | query | string (date) | |
end_date | query | string (date) | |
account_id | query | string | |
source_type | query | SourceType | |
is_adjusting | query | boolean |
Answers
Post a manual journal entry
POST /journal-entries
Sends Vortex-Entity and Idempotency-Key.
Posts a balanced entry directly. Rejected with 422 unbalanced_entry if debits and credits differ, or 422 period_closed if the date falls in a closed period. Requires journal:write, which is granted to accountant roles, not to platforms.
Body
Answers
- 201 JournalEntry. The posted entry.
- 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
Get a journal entry
GET /journal-entries/{journal_entry_id}
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
journal_entry_id required | path | string |
Answers
- 200 JournalEntry. The entry.
- 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
Reverse a journal entry
POST /journal-entries/{journal_entry_id}/reverse
Sends Vortex-Entity and Idempotency-Key.
Posts a new entry that exactly offsets the original, dated reversal_date (default today). The original stays as it was. Requires journal:write. Reversing a payment makes what it applied owed again and marks its event reversed. Any other reversed event is marked reversed too. Entries also recorded outside the ledger return 409 and are corrected where they're kept: an invoice or bill (use_document_void), a bank line (entry_on_bank_line), stock (entry_moved_stock), a refund (use_correcting_entry) or a sale with refunds (sale_has_refunds).
Parameters
| Name | In | Type | About |
|---|---|---|---|
journal_entry_id required | path | string |
Body
| Field | Type | About |
|---|---|---|
reversal_date | string (date) | |
reason required | string | Up to 500 characters. |
Answers
- 201 JournalEntry. The reversing entry.
- 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

