Period analytics

{

Attribute

Data type

Description

Required extra_field

pk

PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints. We represent primary keys as unsigned 64-bit integers.

bank_account_pk

Bank Account PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints. We represent primary keys as unsigned 64-bit integers.

uploaded_doc_pk

Document PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints. We represent primary keys as unsigned 64-bit integers.

begin_date

Date

end_date

Date

begin_balance

Money

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

end_balance

Money

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

calculated_end_balance

Money

The balance Ocrolus calculates by taking the begin balance and summing all transactions captured in a period. Note: field will be blank unless it varies from the end balance.

primary_recon_error_reason
secondary_recon_error_reason

Suspicious Activity Flags

txn_count

Integer

The total number of transactions in a statement period.

period_analytics

average_amount

Money

The average monetary value of transactions in a statement period.

period_analytics

average_daily_balance

Money

The average daily ending balance (including weekends).

period_analytics

average_daily_balance_weekday

Money

The average daily ending balance of weekdays (excluding weekends)

weekday_balances,period_analytics

average_deposit

Money

The average monetary value of deposits in a statement period.

period_analytics

deposit_max

List of Transactions

The credit transaction with the largest monetary value.

period_analytics

deposit_min

List of Transactions

The credit transaction with the smallest monetary value.

period_analytics

deposit_sum

Money

The total monetary value of credits in a statement period.

txn_summary,period_analytics

deposit_count

Integer

The total number of credit transactions in a statement period.

txn_summary,period_analytics

withdrawal_sum

Money

The total monetary value of debits in a statement period.

txn_summary,period_analytics

withdrawal_count

Integer

The total number of debit transactions in a statement period.

txn_summary,period_analytics

withdrawals_max

List of Transactions

The debit transaction with the largest monetary value.

period_analytics

estimated_revenue

Money

The estimated revenue of the business in a statement period. 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.

period_analytics

estimated_revenue_calc_txns

Revenue Calculation Transactions

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

estimated_revenue_by_month_calc_txns,period_analytics

negative_balances

List of Dates

The list of dates with balances below zero (including weekends).

period_analytics

negative_balances_weekday

List of Dates

The list of dates with balances below zero (excluding weekends).

weekday_balances,period_analytics

nsf_count

Integer

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

nsf_count,period_analytics

nsf_transactions_paid_or_negative_balance_count

Integer

count of NSF transactions that have paid or negative balances

nsf_transactions_paid_or_negative_balance_count, period_analytics

nsf_transactions_returned_or_not_paid_count

Integer

count of NSF transactions that have returned or unpaid balances

nsf_transactions_returned_or_not_paid_count, period_analytics

period_month_days

Month Map

The number of weekdays in a statement period.

period_month_txns

Month Map

The number of transactions in a statement period.

payroll

List of Transactions

A list of all transactions from payroll providers.

payroll,period_analytics

}


Did this page help you?