Accounting journal entries
Balanced debits and credits that post one business event to the ledger.
- API name:
accountingjournalentries - Domain: Accounting
- Modules: Sales analytics, Finance analytics, Finances
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| Entry number | uid | Text | Number of this journal entry. | |
| Posting date | date | Date | Yes | The date selects the fiscal period. |
| User | userId | User | ||
| Fiscal period | accountingfiscalyearperiodId | Reference | Yes | The system sets this from the posting date. You do not select it. |
| Journal type | kind | Constant | Yes | Fixed option from the allowed set for this field. |
| Total debits | debit | Currency | Yes | Sum of line debits in accounting currency. Must equal total credits on a balanced entry. |
| Total credits | credit | Currency | Yes | Sum of line credits in accounting currency. Must equal total debits on a balanced entry. |
| Cancel reason | cancelReason | Text Area | Required explanation when canceling this record. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Comments | comments | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Posted by | processedBy | User | ||
| Posted at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
User userId | Users | reference |
Fiscal period accountingfiscalyearperiodId | Fiscal periods | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event accountingjournalentries.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new journal entry. | App · API · MCP · CLI |
| Edit | update | Save changes to this journal entry. | App · API · MCP · CLI |
| Post | process | Post this journal entry to the general ledger. You cannot edit it after posting. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this journal entry. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this journal entry. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this journal entry again. | App · API · MCP · CLI |
| Archive | archive | Retire this journal entry from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this journal entry to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this journal entry and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.