Bank Account Analytics

Overview

Model Name: BankAccountAnalytics

Detailed analytics computed on a particular bank account. A Book may contain bank statements from multiple bank accounts, therefore the book analytics may contain multiple objects of this type.

Properties

account_category

Type
String
Required
true

Indicates different categories of bank accounts captured from documents.

Possible Values

  • BUSINESS ACCOUNT
  • PERSONAL ACCOUNT
  • UNKNOWN

account_holder

Type
String
Required
true

The name of the person or entity who owns this bank account.

account_holders

Type
List of strings
Required
false

This field will be a single-element array with the value given in account_holder.

🚧

This field is deprecated and may be removed in the future.

account_number

Type
String
Required
true

The captured number of this bank account.

account_type

Type
String
Required
true

Bank account type indicates the different types of bank accounts captured from documents.

Possible Values

  • SAVINGS
  • CHECKING
  • CHECK CASHING HISTORY
  • CREDITCARD
  • IOLTA
  • UNKNOWN

activity_info

Type
ActivityInfo
Required
true

No description available.

alt_lender_payments_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Debits (i.e. payments) made to alternative lenders grouped by calendar month. Provides context into a customer's access to competitive financing as well as debt service requirements. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

alternative_lender_transactions

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all transactions to/from alternative lenders, including small business lenders, personal lenders, and mortgage players. This list also includes transactions relating to Merchant Cash Advance and Factoring, though these are separately filtered in unique lists for Merchant Cash Advance Transactions and Factoring Transactions.

atm_withdrawals_num

Type
Integer
Required
false
Min. Value
0

Total number of all ATM withdrawals from the bank account

atm_withdrawals_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

The sum of all atm withdrawal amounts

average_alt_lender_payments

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

Average monthly debits (i.e. payments) made to alternative lenders. Provides context into a customer's access to competitive financing as well as debt service requirements.

average_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average absolute value of all transactions grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_daily_balance

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The average daily ending balance (including weekends).

average_daily_balance_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average daily ending balance (including weekends) grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_daily_balance_weekday

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The average daily ending balance of weekdays.

average_daily_balance_weekday_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average daily ending balance of weekdays grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_daily_cash_flow

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

Average daily net cash flow, where Net Cash Flow = Credits - Debits. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.

average_daily_cash_flow_weekday

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

Average daily net cash flow on weekdays, where Net Cash Flow = Credits - Debits. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.

average_deposit_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average value of credit transactions grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_mca_payments

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

Average monthly debits (i.e. payments) made to merchant cash advance lenders. Provides context into a customer's access to competitive financing as well as debt service requirements.

bank_name

Type
String
Required
true
Min. Length
0

Name of the bank which issued the bank statement.

book_pk

Type
Integer (uint64)
Required
true

The unique identifier for the Book that was used to compute these analytics.

branch_withdrawals_num

Type
Integer
Required
false
Min. Value
0

Number of cash withdrawals from a physical location.

branch_withdrawals_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of branch cash withdrawals from a physical location.

cash_balance_trend_30d

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The normalized change in daily cash balance over time. Used to measure the change in cash balances for a business in different environments. ((Mean cash balance t-30 to t-16) - (Mean cash balance t-15 to t-1) ) / standard deviation of cash balance over t-30 to t-1

cash_balance_trend_60d

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The normalized change in daily cash balance over time. Used to measure the change in cash balances for a business in different environments. ((Mean cash balance t-60 to t-31) - (Mean cash balance t-30 to t-1) ) / standard deviation of cash balance over t-60 to t-1

cash_balance_trend_90d

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The normalized change in daily cash balance over time. Used to measure the change in cash balances for a business in different environments. ((Mean cash balance t-90 to t-46) - (Mean cash balance t-45 to t-1) ) / standard deviation of cash balance over t-90 to t-1

cash_expense_days_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Cash expense days grouped by month. Measures the amount of runway a business has given its operating expenses. Cash expense days = (average daily balance)/(average daily expense) Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

cash_flow_trend_30d

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The normalized change in daily cash flow over time. Used to measure the change in profitability for a business in different environments. ((Mean cash flow t-30 to t-16) - (Mean cash flow t-15 to t-1) ) / standard deviation of cash flow over t-30 to t-1

cash_flow_trend_60d

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The normalized change in daily cash flow over time. Used to measure the change in profitability for a business in different environments. ((Mean cash flow t-60 to t-31) - (Mean cash flow t-30 to t-1) ) / standard deviation of cash flow over t-60 to t-1

cash_flow_trend_90d

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The normalized change in daily cash flow over time. Used to measure the change in profitability for a business in different environments. ((Mean cash flow t-90 to t-46) - (Mean cash flow t-45 to t-1) ) / standard deviation of cash flow over t-90 to t-1

casino_lottery_num

Type
Integer
Required
false
Min. Value
0

The number of credit transactions originating from casino or lottery winnings.

casino_lottery_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

The total amount of credit transactions originating from casino or lottery winnings.

checks_highest_incidence

Type
Two-element array of `[string, int]`.
Required
false
Min. Item Count
2
Max. Item Count
2

Most commonly occurring check amount and the number of such occurrences in form [amount, num_occurences]. If no checks were received in this bank statement, will have a value of ["0.00", 0].

checks_num

Type
Integer
Required
false
Min. Value
0

Number of checks

credit_card_payments_num

Type
Integer
Required
false
Min. Value
0

Number of Credit Card Payments

credit_card_payments_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of Credit Card Payments

daily_balances

Type
Map of strings
Key Pattern
/^\d{2}/\d{2}/\d{4}$/
Required
true

A list of the daily ending balances for every day. Each key is a string representing a date, using the regex ^\d{2}/\d{2}/\d{4}$ (i.e MM/DD/YYYY).

daily_cash_flows

Type
Map of strings
Key Pattern
/^\d{2}/\d{2}/\d{4}$/
Required
true

A list of net cash flows for each available date. Net Cash Flow = Credits - Debits. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt.
Each key is a string representing a date, using the regex ^\d{2}/\d{2}/\d{4}$ (i.e MM/DD/YYYY).

daily_cash_flows_weekday

Type
Map of strings
Key Pattern
/^\d{2}/\d{2}/\d{4}$/
Required
false

A list of net cash flows for each available weekday. Net Cash Flow = Credits - Debits. Important to understand if the business is running a surplus or deficit and how much free cash flow may be available for servicing new debt. Each key is a string representing a date, using the regex ^\d{2}/\d{2}/\d{4}$ (i.e MM/DD/YYYY).

debt_consolidator_txns

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all transactions to/from debt consolidation (refinancing) companies.

deposit_count

Type
Integer
Required
true
Min. Value
0

The total number of credit transactions.

deposit_max_by_month

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The credit transactions with the largest amount grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

deposit_min_by_month

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The credit transactions with the smallest amount grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

deposit_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

Sum of all credit transactions

deposits_count_by_month

Type
Map of integers
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The count of all credit transactions grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

deposits_sum_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The sum of all credit transactions grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

equipment_lease_payments_num

Type
Integer
Required
false
Min. Value
0

Number of outflow transactions to equipment leasing companies

equipment_lease_payments_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Total amount of outflow transactions to equipment leasing companies

estimated_daily_expense_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Estimated daily expenses grouped by month. Important for understanding the costs required to operate the business as well as the firm's ability to adapt spending during a period of disruption. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

estimated_daily_revenue_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Estimated daily revenue grouped by month. Important for understanding the magnitude of revenue, trend of revenue, and the resilience of revenue to the present situation.
Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

estimated_expense_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Estimated monthly expenses grouped by calendar month. Important for understanding the costs required to operate the business as well as the firm's ability to adapt spending during a period of disruption. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

estimated_expense_txns_list

Type
List of Transaction objects
Required
true
Min. Item Count
0

List of transactions included in estimated expense calculations.

estimated_revenue_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The estimated revenue of the business grouped by calendar month. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as "Refund", "Reversal", "Cash Back", "Return", and about 20 others.
Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

estimated_revenue_by_month_calc_txns

Type
EstimatedRevenueCalculationTransactionsByMonth
Required
true

No description available.

estimated_revenue_txns_list

Type
List of Transaction objects
Required
true

The ungrouped list of credit transactions that comprise the estimated revenue of the applicant.

factor_txns

Type
List of Transaction objects
Required
true

A list of all transactions to/from invoice factoring companies.

holder_address_1

Type
String
Required
true

The primary address of the person or entity who owns this bank account.

holder_address_2

Type
String (or null)
Required
true

Extra address information about the owner of this bank account, usually about a particular suite or office. Will be null if not provided.

holder_city

Type
String
Required
true

The town or city of the account holder's address.

holder_country

Type
String
Required
true

The captured country of residence of the account holder. We only support American bank statements at this time.

holder_state

Type
String
Required
true

The captured state or territory of the account holder.

holder_zip

Type
String
Required
true

The captured postal code of the account holder.

id

Type
Integer
Required
false

No description available.

🚧

This field is deprecated and may be removed in the future.

insurance_credits

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all positive transactions from insurance providers.

insurance_debits

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all negative transactions from insurance providers.

insurance_payments_num

Type
Integer
Required
false
Min. Value
0

Number of insurance payments

insurance_payments_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of insurance payments

insurance_terms

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of negative transactions associated with insurance companies.

interbank_transactions

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all transactions to/from any bank or financial institution.

lottery_withdrawals_num

Type
Integer
Required
false
Min. Value
0

Number of outflow transactions spent on lottery

lottery_withdrawals_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Total amount of outflow transactions spent on lottery

mca_payments_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Debits (i.e. payments) made to merchant cash advance lenders, broken out by month. Provides context into a customer's access to competitive financing as well as debt service requirements. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

merchant_cash_advance_lender_txns

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all transactions to/from merchant cash advance companies.

merchant_service_deposits_num

Type
Integer
Required
false
Min. Value
0

Total number of merchant service deposits (positive transactions matching with merchant service terms) in the bank account

merchant_service_deposits_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

The sum of merchant service deposit transactions amounts (positive transactions matching with merchant service terms) in the bank account

minimum_balance_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The lowest end-of-day balance in a calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

name

Type
String
Required
true
Min. Length
0

Name of the book or bank account

negative_balances_by_month

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The list of all days in which the daily ending balance fell below zero grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY). Months with no days ending with a negative balance are represented with empty arrays.

negative_balances_by_month_weekday

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The list of all weekdays in which the daily ending balance fell below zero grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY). Months with no days ending with a negative balance are represented with empty arrays.

negative_balances_weekday

Type
List of strings
Required
true
Min. Item Count
0

The list of all weekdays in which the daily ending balance fell below zero

negative_cash_flows

Type
List of strings
Required
true
Min. Item Count
0

List of dates where net cash flows (defined as credits - debits) are negative.

negative_cash_flows_weekday

Type
List of strings
Required
true
Min. Item Count
0

List of weekdays where net cash flows (defined as credits - debits) are negative.

net_cash_flows_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true
Min. Item Count
0

The net cash flow grouped by month, where Net Cash Flow = Credits - Debits.
Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

non_estimated_revenue_txns_list

Type
List of Transaction objects
Required
true
Min. Item Count
0

The list of credit transactions that are excluded from the β€œEstimated Revenue by Month” calculation.

nsf_count

Type
Integer
Required
true
Min. Value
0

The number of unique NSF & Overdraft fees for each bank account. This is especially useful with institutions that lump NSF fees into one transaction.

nsf_count_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The number of unique NSF fees grouped by month. This is especially useful with institutions that lump NSF fees into one transaction. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

nsf_transactions

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of transactions associated with non-sufficient funds and overdraft transactions.

nsf_transactions_paid_or_negative_balance

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of transactions associated with overdraft transactions.

nsf_transactions_paid_or_negative_balance_count_by_month

Type
Map of integers
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The count of transactions associated with overdraft transactions grouped by month Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

nsf_transactions_returned_or_not_paid

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of transactions associated with returned and/or unpaid items due to NSF fees.

nsf_transactions_returned_or_not_paid_count_by_month

Type
Map of integers
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The count of transactions associated with returned and/or unpaid items due to NSF fees grouped by month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

outside_source_deposits

Type
List of Transaction objects
Required
true
Min. Item Count
0

The list of credit transactions that are not transfers

paypal_num

Type
Integer
Required
false
Min. Value
0

Number of Paypal Transactions

🚧

This field is deprecated and may be removed in the future.

paypal_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of Paypal Transactions

🚧

This field is deprecated and may be removed in the future.

payroll

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of all transactions from payroll providers.

payroll_num

Type
Integer
Required
false
Min. Value
0

For business account only, the total number of payroll transactions (negative transactions matching with payroll term list) in the bank account

payroll_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

For business account only, the sum of payroll transactions' amounts (negative transactions matching with payroll term list) in the bank account

period_balance_mismatches

Type
List of PeriodBalanceMismatch objects
Required
true
Min. Item Count
0

An indication of gaps between statement periods captured in the bank account.

periods

Type
List of PeriodAnalytics objects
Required
true
Min. Item Count
0

Contains list of period level JSONs

pk

Type
Integer (uint64)
Required
true

A unique identifying integer.

ppp_loan_txns

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of credit transactions associated with the SBA Payroll Protection Program

probable_recurring_txns

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of transactions with the same dollar value that are greater than $10 and occur two or more times within 45 days.

recurring_vs_episodic_inflows_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The ratio of total recurring credit transactions to total non-recurring credit transactions. Demonstrates stability of revenues. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

recurring_vs_episodic_outflows_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The ratio of total recurring debit transactions to total non-recurring debit transactions. Measures fixed expenses. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

remote_deposits_num

Type
Integer
Required
false
Min. Value
0

Total number of remote deposits in the bank account

🚧

This field is deprecated and may be removed in the future.

remote_deposits_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Sum of remote deposit amounts in the bank account

🚧

This field is deprecated and may be removed in the future.

returned_items

Type
List of Transaction objects
Required
false
Min. Item Count
0

No description available.

🚧

This field is deprecated and may be removed in the future.

round_number_txns

Type
List of Transaction objects
Required
true
Min. Item Count
0

A list of transactions that end in at least five zeroes, e.g., $1,000.00.

state_tax_payments_num

Type
Integer
Required
false
Min. Value
0

Number of tax payments that are not US tax payments

🚧

This field is deprecated and may be removed in the future.

state_tax_payments_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of tax payments that are not US tax payments

🚧

This field is deprecated and may be removed in the future.

suspicious_activities

Type
SuspiciousActivities
Required
true

No description available.

🚧

This field is deprecated and may be removed in the future.

tolls_num

Type
Integer
Required
false
Min. Value
0

Number of toll payments

tolls_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of toll payments

total_days

Type
Integer
Required
true
Min. Value
0

The total number of days in all statement periods captured in the bank account.

transfer

Type
Transfers
Required
true

No description available.

transfer_num

Type
Integer
Required
false
Min. Value
0

Total number of transfer transactions (positive and negative transactions matching with transfer term list) in the bank account

transfer_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Sum of transfer transactions' amounts (positive and negative transactions matching with transfer term list) in the bank account

txn_count

Type
Integer
Required
true
Min. Value
0

The total number of transactions in a bank account.

txn_four_zeros

Type
Integer
Required
false
Min. Value
0

Number of transactions ending in 4 zeros (00.00)

usa_tax_payments_num

Type
Integer
Required
false
Min. Value
0

Number of US tax payments

🚧

This field is deprecated and may be removed in the future.

usa_tax_payments_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Amount of US tax payments

venmo_zelle_cashapp_num

Type
Integer
Required
false
Min. Value
0

Total number of transactions that include terms such as Venmo, Zelle or Cash App

venmo_zelle_cashapp_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
false

Sum of amounts for Venmo, Zelle and Cash App transactions

withdrawal_count

Type
Integer
Required
true
Min. Value
0

The total number of debit transactions.

withdrawal_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The total monetary value of debits

withdrawals

Type
List of Transaction objects
Required
true
Min. Item Count
0

The list of all debits transactions from a bank account.

withdrawals_max_by_month

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The debit transaction(s) with the most negative amount grouped by month.
Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

withdrawals_sum_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The sum of all debit transactions grouped by calendar month.