Journal data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
reference | string | No | |
tax_amount | number | No | |
currency | string | No | |
lineitems | AccountingJournalLineitem[] | No | new field name |
lineitems[].id | string | No | |
lineitems[].tax_amount | number | No | |
lineitems[].total_amount | number | No | will be a positive value for a debit and negative for a credit |
lineitems[].debit_amount | number | No | will replace total_amount (absolute value) |
lineitems[].credit_amount | number | No | |
lineitems[].description | string | No | |
lineitems[].account_id | string | No | (reference to AccountingAccount) |
lineitems[].contact_id | string | No | (reference to AccountingContact) |
lineitems[].payment_id | string | No | link to PaymentPayment (reference to PaymentPayment) |
lineitems[].invoice_id | string | No | (reference to AccountingInvoice) |
lineitems[].category_ids | string[] | No | (reference to AccountingCategory) |
lineitems[].group_id | string | No | points to a HRIS Group (reference to HrisGroup) |
lineitems[].project_id | string | No | (reference to TaskProject) |
lineitems[].organization_id | string | No | points to a AccountingOrganization |
lineitems[].taxrate_id | string | No | ref -> AccountingTaxrate applied to the line |
taxrate_id | string | No | |
description | string | No | |
posted_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
source | string | No | |
organization_id | string | No | |
category_ids | string[] | No | (reference to AccountingCategory) |
project_id | string | No | (reference to TaskProject) |
attachments | AccountingAttachment[] | No | |
attachments[].id | string | No | |
attachments[].download_url | string | No | |
attachments[].name | string | No | |
attachments[].mime_type | string | No | |
total_amount | number | No | Total of the debit lines; equals the total of the credit lines |
exchange_rate | number | No | Exchange rate to the base/home currency at the posting date |
status | enum | No | Posting state of the journal entry Values: DRAFT, POSTED, VOID, OTHER |
is_inclusive_of_tax | boolean | No | True when the line amounts already include tax |
Are we missing anything? Let us know