Extra fields

The extra_fields parameter to the Analytics (JSON) endpoint allows you to request additional optional analytics provided by Ocrolus. The values should be provided as a comma-separated list of the field names.

Bank account analytics extra fields

The following extra_fields values are available for Bank account analytics.

extra_field valueAnalytic attribute
weekday_balancesaverage_daily_balance_weekday
weekday_balancesaverage_daily_balance_weekday_by_month
weekday_balancesnegative_balances_by_month_weekday
estimated_revenue_txns_listestimated_revenue_txns_list
estimated_revenue_txns_listnon_estimated_revenue_txns_list
estimated_revenue_by_month_calc_txnsestimated_revenue_by_month_calc_txns
nsf_countnsf_count
nsf_countnsf_count_by_month
nsf_transactions_returned_or_not_paidnsf_transactions_returned_or_not_paid
nsf_transactions_paid_or_negative_balancensf_transactions_paid_or_negative_balance
probable_recurring_txnsprobable_recurring_txns
txn_summarydeposit_sum
txn_summarydeposit_count
txn_summarywithdrawal_count
txn_summarywithdrawal_sum
txn_summarytxn_count
merchant_cash_advance_lender_txnsmerchant_cash_advance_lender_txns
debt_consolidator_txnsdebt_consolidator_txns
factor_txnsfactor_txns
payrollpayroll
withdrawalswithdrawals
transfertransfer
nsf_transactions_paid_or_negative_balance_count_by_monthnsf_transactions_paid_or_negative_balance_count_by_month
nsf_transactions_returned_or_not_paid_count_by_monthnsf_transactions_returned_or_not_paid_count_by_month
transfer_numtransfer_num
transfer_sumtransfer_sum
payroll_numpayroll_num
payroll_sumpayroll_sum
txn_four_zerostxn_four_zeros
venmo_zelle_cashapp_numvenmo_zelle_cashapp_num
venmo_zelle_cashapp_sumvenmo_zelle_cashapp_sum
atm_withdrawals_numatm_withdrawals_num
atm_withdrawals_sumatm_withdrawals_sum
merchant_service_deposits_nummerchant_service_deposits_num
merchant_service_deposits_summerchant_service_deposits_sum
remote_deposits_numremote_deposits_num
remote_deposits_sumremote_deposits_sum
checks_numchecks_num
checks_highest_incidencechecks_highest_incidence
payroll_creditsA list of all positive transactions from payroll providers.
payroll_debitsA list of all negative transactions from payroll providers.
recurring_vs_episodic_outflows_by_monthrecurring_vs_episodic_outflows_by_month
recurring_vs_episodic_inflows_by_monthrecurring_vs_episodic_inflows_by_month
cash_flow_trend_30dcash_flow_trend_30d
cash_flow_trend_60dcash_flow_trend_60d
cash_flow_trend_90dcash_flow_trend_90d
cash_balance_trend_30dcash_balance_trend_30d
cash_balance_trend_60dcash_balance_trend_60d
cash_balance_trend_90dcash_balance_trend_90d

Period analytics extra fields

The following extra_fields values are available for Period Analytics.

extra_field ValueAnalytic attribute
weekday_balances, period_analyticsnegative_balances_weekday
weekday_balances, period_analyticsaverage_daily_balance_weekday
estimated_revenue_by_month_calc_txns, period_analyticsestimated_revenue_calc_txns
nsf_count, period_analyticsnsf_count
txn_summary, period_analyticsdeposit_sum
txn_summary, period_analyticsdeposit_count
txn_summary, period_analyticswithdrawal_count
txn_summary, period_analyticswithdrawal_sum
txn_summary, period_analyticstxn_count
period_analyticstxn_count
period_analyticsaverage_amount
period_analyticsaverage_daily_balance
period_analyticsaverage_deposit
period_analyticsdeposit_max
period_analyticsdeposit_min
period_analyticswithdrawals_max
period_analyticsestimated_revenue
period_analyticsnegative_balances
nsf_transactions_paid_or_negative_balance_count, period_analyticsnsf_transactions_paid_or_negative_balance_count
nsf_transactions_returned_or_not_paid_count, period_analyticsnsf_transactions_returned_or_not_paid_count