Overview

Model Name: PeriodAnalytics

Analytics for a contiguous time period described on a bank statement. Non-contiguous periods are represented with multiple objects of this type.

Properties

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

`average_amount`

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

The average absolute value of transaction amounts in a statement period.

`average_daily_balance`

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

The average daily ending balance (including weekends).

`average_daily_balance_weekday`

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

The average daily ending balance of weekdays.

`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`

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

The average value of credit transactions

`bank_account_pk`

Type: Integer (uint64)
Required: true

No description available.

`begin_balance`

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

The beginning balance of the statement period captured from the summary section of a bank statement.

`begin_date`

Type: String
Pattern: /^\\d{2}\/\\d{2}\/\\d{4}$/
Required: true

The beginning date of the statement period captured from the summary section of a bank statement.

`deposit_count`

Type: Integer
Required: true
Min. Value: 0

The total number of credit transactions.

`deposit_max`

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

The credit txn(s) with the largest amount

`deposit_min`

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

The credit txn(s) with the smallest amount

`deposit_sum`

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

Sum of all credit transactions

`end_balance`

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

The ending balance of the statement period captured from the summary section of a bank statement.

`end_date`

Type: String
Pattern: /^\\d{2}\/\\d{2}\/\\d{4}$/
Required: true

The ending date of the statement period captured from the summary section of a bank statement.

`estimated_revenue`

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

The estimated revenue of the business. 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.

`estimated_revenue_calc_txns`

Type: EstimatedRevenueCalculationTransactions
Required: true

No description available.

`negative_balances`

Type: List of strings
Required: true
Min. Item Count: 0

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

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

`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_transactions_paid_or_negative_balance_count`

Type: Integer
Required: true
Min. Value: 0

The count of transactions associated with overdraft transactions.

`nsf_transactions_returned_or_not_paid_count`

Type: Integer
Required: false
Min. Value: 0

The count of transactions associated with returned and/or unpaid items due to NSF fees.

`payroll`

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

The sum of payroll transaction amounts within this period.

`period_month_days`

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

Number of days in the period grouped by month

`period_month_txns`

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

Number of transactions in the period grouped by month

`pk`

Type: Integer (uint64)
Required: true

A unique identifying integer.

`primary_recon_error_reason`

Type: String
Required: true

Manual verifier flag for suspicious activity after inspection

`secondary_recon_error_reason`

Type: String
Required: true

Manual verifier flag for suspicious activity after inspection

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

`txn_count`

Type: Integer
Required: true
Min. Value: 0

The total number of transactions in a bank account.

`uploaded_doc_pk`

Type: Integer (uint64)
Required: true

Unique identifying integer

`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_max`

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

The debit transaction(s) with the most negative amount