Struct plaid::model::AssetReportTransaction
source · pub struct AssetReportTransaction {Show 21 fields
pub account_id: String,
pub account_owner: Option<String>,
pub amount: f64,
pub category: Option<Vec<String>>,
pub category_id: Option<String>,
pub check_number: Option<String>,
pub credit_category: Option<CreditCategory>,
pub date: NaiveDate,
pub date_transacted: Option<String>,
pub income_source_id: Option<String>,
pub iso_currency_code: Option<String>,
pub location: Option<Location>,
pub merchant_name: Option<String>,
pub name: Option<String>,
pub original_description: Option<String>,
pub payment_meta: Option<PaymentMeta>,
pub pending: bool,
pub pending_transaction_id: Option<String>,
pub transaction_id: String,
pub transaction_type: Option<String>,
pub unofficial_currency_code: Option<String>,
}
Expand description
A transaction on the asset report
Fields§
§account_id: String
The ID of the account in which this transaction occurred.
account_owner: Option<String>
The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
amount: f64
The settled value of the transaction, denominated in the transaction’s currency, as stated in iso_currency_code
or unofficial_currency_code
. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
category: Option<Vec<String>>
A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see /categories/get
.
This field will only appear in an Asset Report with Insights.
category_id: Option<String>
The ID of the category to which this transaction belongs. For a full list of categories, see /categories/get
.
This field will only appear in an Asset Report with Insights.
check_number: Option<String>
The check number of the transaction. This field is only populated for check transactions.
credit_category: Option<CreditCategory>
Information describing the intent of the transaction. Most relevant for credit use cases, but not limited to such use cases.
See the taxonomy csv file
for a full list of credit categories.
date: NaiveDate
For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD
).
date_transacted: Option<String>
The date on which the transaction took place, in IS0 8601 format.
income_source_id: Option<String>
A unique identifier for an income source.
iso_currency_code: Option<String>
The ISO-4217 currency code of the transaction. Always null
if unofficial_currency_code
is non-null.
location: Option<Location>
A representation of where a transaction took place
merchant_name: Option<String>
The merchant name, as enriched by Plaid from the name
field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be null
.
name: Option<String>
The merchant name or transaction description.
This field will only appear in an Asset Report with Insights.
original_description: Option<String>
The string returned by the financial institution to describe the transaction.
payment_meta: Option<PaymentMeta>
Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be null
.
If the transactions
object was returned by a Transactions endpoint such as /transactions/sync
or /transactions/get
, the payment_meta
key will always appear, but no data elements are guaranteed. If the transactions
object was returned by an Assets endpoint such as /asset_report/get/
or /asset_report/pdf/get
, this field will only appear in an Asset Report with Insights.
pending: bool
When true
, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
pending_transaction_id: Option<String>
The ID of a posted transaction’s associated pending transaction, where applicable.
transaction_id: String
The unique ID of the transaction. Like all Plaid identifiers, the transaction_id
is case sensitive.
transaction_type: Option<String>
digital:
transactions that took place online.
place:
transactions that were made at a physical location.
special:
transactions that relate to banks, e.g. fees or deposits.
unresolved:
transactions that do not fit into the other three types.
unofficial_currency_code: Option<String>
The unofficial currency code associated with the transaction. Always null
if iso_currency_code
is non-null
. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the currency code schema for a full listing of supported unofficial_currency_code
s.
Trait Implementations§
source§impl Clone for AssetReportTransaction
impl Clone for AssetReportTransaction
source§fn clone(&self) -> AssetReportTransaction
fn clone(&self) -> AssetReportTransaction
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more