Transaction 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) |
memo | string | No | |
total_amount | number | No | negative for CREDIT, positive for DEBIT |
tax_amount | number | No | negative for CREDIT, positive for DEBIT |
account_id | string | No | (reference to AccountingAccount) |
reference | string | No | |
sub_total_amount | number | No | |
split_account_id | string | No | |
payment_method | string | No | |
payment_terms | string | No | |
customer_message | string | No | |
type | string | No | eg. CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, BANK_DEPOSIT, BANK_TRANSFER, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation |
lineitems | AccountingTransactionLineItem[] | No | |
lineitems[].id | string | No | |
lineitems[].unit_quantity | number | No | |
lineitems[].unit_amount | number | No | |
lineitems[].total_amount | number | No | will be a positive value for a debit and negative for a credit |
lineitems[].account_id | string | No | (reference to AccountingAccount) |
lineitems[].object_type | string | No | |
lineitems[].name | string | No | |
lineitems[].description | string | No | |
lineitems[].category_ids | string[] | No | (reference to AccountingCategory) |
lineitems[].taxrate_id | string | No | ref -> AccountingTaxrate applied to the line |
currency | string | No | |
contacts | AccountingTransactionContact[] | No | |
contacts[].id | string | Yes | |
contacts[].is_customer | boolean | No | |
contacts[].is_supplier | boolean | No | |
organization_id | string | No | |
category_ids | string[] | No | (reference to AccountingCategory) |
project_id | string | No | (reference to TaskProject) |
transaction_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
exchange_rate | number | No | Exchange rate to the base/home currency at the transaction date |
status | enum | No | Posting state of the transaction Values: PENDING, POSTED, VOID, OTHER |
Are we missing anything? Let us know