Struct plaid::model::BaseReportTransaction

pub struct BaseReportTransaction {
    pub account_owner: Option<String>,
    pub amount: f64,
    pub check_number: Option<String>,
    pub credit_category: Option<CreditCategory>,
    pub date: NaiveDate,
    pub date_transacted: Option<String>,
    pub iso_currency_code: Option<String>,
    pub location: Option<Location>,
    pub merchant_name: Option<String>,
    pub original_description: Option<String>,
    pub pending: bool,
    pub unofficial_currency_code: Option<String>,
}

A transaction on the Base Report

Fields

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.

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.

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.

original_description: Option<String>

The string returned by the financial institution to describe the transaction.

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.

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_codes.

Trait Implementations

impl Clone for BaseReportTransaction

fn clone(&self) -> BaseReportTransaction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BaseReportTransaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BaseReportTransaction

fn default() -> BaseReportTransaction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BaseReportTransaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BaseReportTransaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for BaseReportTransaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.