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 value

Analytic attribute

weekday_balances

average_daily_balance_weekday

weekday_balances

average_daily_balance_weekday_by_month

weekday_balances

negative_balances_by_month_weekday

estimated_revenue_txns_list

estimated_revenue_txns_list

estimated_revenue_txns_list

non_estimated_revenue_txns_list

estimated_revenue_by_month_calc_txns

estimated_revenue_by_month_calc_txns

nsf_count

nsf_count

nsf_count

nsf_count_by_month

nsf_transactions_returned_or_not_paid

nsf_transactions_returned_or_not_paid

nsf_transactions_paid_or_negative_balance

nsf_transactions_paid_or_negative_balance

probable_recurring_txns

probable_recurring_txns

txn_summary

deposit_sum

txn_summary

deposit_count

txn_summary

withdrawal_count

txn_summary

withdrawal_sum

txn_summary

txn_count

merchant_cash_advance_lender_txns

merchant_cash_advance_lender_txns

debt_consolidator_txns

debt_consolidator_txns

factor_txns

factor_txns

payroll

payroll

withdrawals

withdrawals

transfer

transfer

nsf_transactions_paid_or_negative_balance_count_by_month

nsf_transactions_paid_or_negative_balance_count_by_month

nsf_transactions_returned_or_not_paid_count_by_month

nsf_transactions_returned_or_not_paid_count_by_month

transfer_num

transfer_num

transfer_sum

transfer_sum

payroll_num

payroll_num

payroll_sum

payroll_sum

txn_four_zeros

txn_four_zeros

venmo_zelle_cashapp_num

venmo_zelle_cashapp_num

venmo_zelle_cashapp_sum

venmo_zelle_cashapp_sum

atm_withdrawals_num

atm_withdrawals_num

atm_withdrawals_sum

atm_withdrawals_sum

merchant_service_deposits_num

merchant_service_deposits_num

merchant_service_deposits_sum

merchant_service_deposits_sum

remote_deposits_num

remote_deposits_num

remote_deposits_sum

remote_deposits_sum

checks_num

checks_num

checks_highest_incidence

checks_highest_incidence

payroll_credits

A list of all positive transactions from payroll providers.

payroll_debits

A list of all negative transactions from payroll providers.

recurring_vs_episodic_outflows_by_month

recurring_vs_episodic_outflows_by_month

recurring_vs_episodic_inflows_by_month

recurring_vs_episodic_inflows_by_month

cash_flow_trend_30d

cash_flow_trend_30d

cash_flow_trend_60d

cash_flow_trend_60d

cash_flow_trend_90d

cash_flow_trend_90d

cash_balance_trend_30d

cash_balance_trend_30d

cash_balance_trend_60d

cash_balance_trend_60d

cash_balance_trend_90d

cash_balance_trend_90d

Period analytics extra fields

The following extra_fields values are available for Period Analytics.

extra_field Value

Analytic attribute

weekday_balances,
period_analytics

negative_balances_weekday

weekday_balances,
period_analytics

average_daily_balance_weekday

estimated_revenue_by_month_calc_txns,
period_analytics

estimated_revenue_calc_txns

nsf_count,
period_analytics

nsf_count

txn_summary,
period_analytics

deposit_sum

txn_summary,
period_analytics

deposit_count

txn_summary,
period_analytics

withdrawal_count

txn_summary,
period_analytics

withdrawal_sum

txn_summary,
period_analytics

txn_count

period_analytics

txn_count

period_analytics

average_amount

period_analytics

average_daily_balance

period_analytics

average_deposit

period_analytics

deposit_max

period_analytics

deposit_min

period_analytics

withdrawals_max

period_analytics

estimated_revenue

period_analytics

negative_balances

nsf_transactions_paid_or_negative_balance_count, period_analytics

nsf_transactions_paid_or_negative_balance_count

nsf_transactions_returned_or_not_paid_count, period_analytics

nsf_transactions_returned_or_not_paid_count


Did this page help you?