Struct TransactionStream

pub struct TransactionStream {

    pub account_id: String,
    pub average_amount: TransactionStreamAmount,
    pub category: Vec<String>,
    pub category_id: String,
    pub description: String,
    pub first_date: NaiveDate,
    pub frequency: RecurringTransactionFrequency,
    pub is_active: bool,
    pub is_user_modified: bool,
    pub last_amount: TransactionStreamAmount,
    pub last_date: NaiveDate,
    pub last_user_modified_datetime: Option<DateTime<Utc>>,
    pub merchant_name: Option<String>,
    pub personal_finance_category: Option<PersonalFinanceCategory>,
    pub predicted_next_date: Option<NaiveDate>,
    pub status: TransactionStreamStatus,
    pub stream_id: String,
    pub transaction_ids: Vec<String>,
}

A grouping of related transactions

Fields

account_id: String

The ID of the account to which the stream belongs

average_amount: TransactionStreamAmount

Object with data pertaining to an amount on the transaction stream.

category: Vec<String>

A hierarchical array of the categories to which this transaction belongs. See Categories.

All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

category_id: String

The ID of the category to which this transaction belongs. See Categories.

All implementations are encouraged to use the new personal_finance_category instead of category. personal_finance_category provides more meaningful categorization and greater accuracy.

description: String

A description of the transaction stream.

first_date: NaiveDate

The posted date of the earliest transaction in the stream.

frequency: RecurringTransactionFrequency

Describes the frequency of the transaction stream.

WEEKLY: Assigned to a transaction stream that occurs approximately every week.

BIWEEKLY: Assigned to a transaction stream that occurs approximately every 2 weeks.

SEMI_MONTHLY: Assigned to a transaction stream that occurs approximately twice per month. This frequency is typically seen for inflow transaction streams.

MONTHLY: Assigned to a transaction stream that occurs approximately every month.

ANNUALLY: Assigned to a transaction stream that occurs approximately every year.

UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

is_active: bool

Indicates whether the transaction stream is still live.

is_user_modified: bool

This will be set to true if the stream has been modified by request to a /transactions/recurring/streams endpoint. It will be false for all other streams.

last_amount: TransactionStreamAmount

Object with data pertaining to an amount on the transaction stream.

last_date: NaiveDate

The posted date of the latest transaction in the stream.

last_user_modified_datetime: Option<DateTime<Utc>>

The date and time of the most recent user modification. This will only be set if is_user_modified is true.

merchant_name: Option<String>

The merchant associated with the transaction stream.

personal_finance_category: Option<PersonalFinanceCategory>

Information describing the intent of the transaction. Most relevant for personal finance use cases, but not limited to such use cases.

See the taxonomy CSV file for a full list of personal finance categories. If you are migrating to personal finance categories from the legacy categories, also refer to the migration guide.

predicted_next_date: Option<NaiveDate>

The predicted date of the next payment. This will only be set if the next payment date can be predicted.

status: TransactionStreamStatus

The current status of the transaction stream.

MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence (For Annual recurring stream, we will mark it MATURE after 2 instances).

EARLY_DETECTION: When a recurring transaction first appears in the transaction history and before it fulfills the requirement of a mature stream, the status will be EARLY_DETECTION.

TOMBSTONED: A stream that was previously in the EARLY_DETECTION status will move to the TOMBSTONED status when no further transactions were found at the next expected date.

UNKNOWN: A stream is assigned an UNKNOWN status when none of the other statuses are applicable.

stream_id: String

A unique id for the stream

transaction_ids: Vec<String>

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

Trait Implementations

impl Clone for TransactionStream

fn clone(&self) -> TransactionStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionStream

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionStream

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransactionStream

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

Formats the value using the given formatter.

impl Serialize for TransactionStream

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

where __S: Serializer,

Serialize this value into the given Serde serializer.