Transaction object

Attribute Name
​
Type
​
Description
id
​
number
​
Unique identifier for transaction
date
​
string
​
Date of transaction in ISO 8601 format
payee
​
string
​
Name of payee
If recurring_id is not null, this field will show the payee of associated recurring expense instead of the original transaction payee
amount
​
string
​
Amount of the transaction in numeric format to 4 decimal places
currency
​
string
​
Three-letter lowercase currency code of the transaction
notes
​
string
​
User-entered transaction notes
If recurring_id is not null, this field will be description of associated recurring expense
category_id
​
number
​
Unique identifier of associated category (see Categories)
asset_id
​
number
​
Unique identifier of associated manually-managed account (see Assets)
Note: plaid_account_id and asset_id cannot both exist for a transaction
plaid_account_id
​
number
​
Unique identifier of associated Plaid account (see Plaid Accounts)
Note: plaid_account_id and asset_id cannot both exist for a transaction
status
​
string
​
One of the following:
cleared: User has reviewed the transaction
uncleared: User has not yet reviewed the transaction
recurring: Transaction is linked to a recurring expense
recurring_suggested: Transaction is listed as a suggested transaction for an existing recurring expense. User intervention is required to change this to recurring.
parent_id
​
number
​
Exists if this is a split transaction. Denotes the transaction ID of the original transaction. Note that the parent transaction is not returned in this call.
is_group
​
boolean
​
True if this transaction represents a group of transactions. If so, amount and currency represent the totalled amount of transactions bearing this transaction’s id as their group_id. Amount is calculated based on the user’s primary currency.
group_id
​
number
​
Exists if this transaction is part of a group. Denotes the parent’s transaction ID
tags
​
Tag[]
​
Array of Tag objects​
external_id
​
string
​
User-defined external ID for any manually-entered or imported transaction. External ID cannot be accessed or changed for Plaid-imported transactions. External ID must be unique by asset_id. Max 75 characters.
​

FAQ

Next - Transactions

Get all transactions

Last updated 10 months ago

Attribute Name	Type	Description
id	number	Unique identifier for transaction
date	string	Date of transaction in ISO 8601 format
payee	string	Name of payee If recurring_id is not null, this field will show the payee of associated recurring expense instead of the original transaction payee
amount	string	Amount of the transaction in numeric format to 4 decimal places
currency	string	Three-letter lowercase currency code of the transaction
notes	string	User-entered transaction notes If recurring_id is not null, this field will be description of associated recurring expense
category_id	number	Unique identifier of associated category (see Categories)
asset_id	number	Unique identifier of associated manually-managed account (see Assets) Note: plaid_account_id and asset_id cannot both exist for a transaction
plaid_account_id	number	Unique identifier of associated Plaid account (see Plaid Accounts) Note: plaid_account_id and asset_id cannot both exist for a transaction
status	string	One of the following: `cleared`: User has reviewed the transaction `uncleared`: User has not yet reviewed the transaction `recurring`: Transaction is linked to a recurring expense `recurring_suggested`: Transaction is listed as a suggested transaction for an existing recurring expense. User intervention is required to change this to recurring.
parent_id	number	Exists if this is a split transaction. Denotes the transaction ID of the original transaction. Note that the parent transaction is not returned in this call.
is_group	boolean	True if this transaction represents a group of transactions. If so, amount and currency represent the totalled amount of transactions bearing this transaction’s id as their group_id. Amount is calculated based on the user’s primary currency.
group_id	number	Exists if this transaction is part of a group. Denotes the parent’s transaction ID
tags	Tag[]	Array of Tag objects
external_id	string	User-defined external ID for any manually-entered or imported transaction. External ID cannot be accessed or changed for Plaid-imported transactions. External ID must be unique by asset_id. Max 75 characters.