Skip to main content
​
external_id
string | null
required
Maximum string length: 255
Example:

"1234567890"

​
amount
number
required
Example:

520.56

​
datetime
string<date-time>
required
​
description
string
required

The description of the Transaction

Maximum string length: 512
Example:

"Payment from Acme Corp"

​
posted
boolean
required
​
type
enum<string>
required

The type of the Transaction

Available options:
business,
personal
Examples:

"business"

"personal"

​
reviewed
boolean
required
​
id
string<txn_string>
required

The ID of the Transaction

Example:

"txn_WQMDNUHpBThYSNh4AprDBo"

​
external_account_id
string<eac_string>
required

The ID of the External Account associated with the Transaction

Example:

"eac_WQMDNUHpBThYSNh4AprDBo"

​
metadata_
Metadata · object | null
​
category
TransactionCategory · object[] | null

The categories associated with the Transaction, derived from the journal entry with both basis. Each entry carries the ledger name and the amount allocated to it; a single-category journal entry is still returned as a one-element list. Null when no journal entry with both basis exists.

Example:
​
status
enum<string> | null

The status of the Transaction. Null when it has no status.

Available options:
bookkeeper_pending,
business_pending,
confirmed
Example:

"confirmed"

​
line_items
TransactionLineItem · object[] | null

The categorized line items of the Transaction. Each item carries the ledger it is categorized to and the amount allocated to it. Pass the ids of the line items to the split endpoint to re-split the Transaction. Null when the Transaction has no categorization.

​
invoice_payments
InvoicePaymentPublic · object[] | null

The invoice payments associated with the Transaction

Example:

null

​
refund_payments
RefundPaymentPublic · object[] | null

The refund payments associated with the Transaction

Example:

null

​
bill_payments
BillPaymentPublic · object[] | null

The bill payments associated with the Transaction

Example:

null

​
tags
Tags · object | null

Tag field name to the list of values attached to the transaction. Each value carries its allocated amount and, when pinned, its ledger; a single-value field is still returned as a one-element list.

Example: