Analytics (JSON) (Deprecated)

get deprecatedhttps://api.ocrolus.com/v1/book/summary

Retrieves analytics for a Book in JSON format, for use within your own application workflows.

🚧
We have a better version!
This product was deprecated in December 2023 and has been superseded by our new Analytics 2.0 offering, which we recommend for all new work.

📘
Multiple endpoints, one object
This endpoint and the asynchronous version return analytics objects in the same format. The XLSX endpoint logically returns most of the same information, but does not use the same schema since JSON schemas don't apply to XLSX files. You can find a detailed reference of the returned analytics object here.

Responses

Response body

object

status

integer

required

Defaults to 200

Numerical code indicating the status of this request. Will be 200 for a successful response.

code

integer

Numerical code indicating the nature of an error. Will not be present if the response is successful.

message

string

required

Defaults to OK

A textual description that indicates details about this response's status. Will be "OK" for a successful request.

response

object | null

required

Detailed analytics computed on the requested Book.
All monetary amounts are given in USD.

alt_lender_payments_by_month

required

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

average_by_month

required

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

string

required

The average daily ending balance (including weekends).

average_daily_balance_by_month

required

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

string

required

The average daily ending balance of weekdays.

average_daily_balance_weekday_by_month

required

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_deposit_by_month

required

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

bank_accounts

array of objects

required

length ≥ 0

List of Bank Account Level JSONs

Bank Account Level Analytics*

object

account_category

string

required

Indicates different categories of bank accounts captured from documents.

BUSINESS ACCOUNT PERSONAL ACCOUNT UNKNOWN

account_holder

string

required

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

account_holders

array of strings

deprecated

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

Bank Account Holders

account_number

string

required

The captured number of this bank account.

account_type

string

required

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

SAVINGS CHECKING CHECK CASHING HISTORY CREDITCARD IOLTA UNKNOWN

activity_info

object

required

A series of date ranges indicating periods of activity and inactivity in a bank account.

alt_lender_payments_by_month

required

alternative_lender_transactions

array of objects

required

length ≥ 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.

List of Alternative Lender Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

The coordinates of the bounding box (i.e. rectangle) on the page from which this transaction was captured.
Unit of measurement is in pixels, and the origin ([0, 0]) is in the top-left corner.
The bounding box is encoded as [x, y, x+w, y+h], where:

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

atm_withdrawals_num

integer

≥ 0

Total number of all ATM withdrawals from the bank account

atm_withdrawals_sum

string

The sum of all atm withdrawal amounts

average_alt_lender_payments

string

required

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

required

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

string

required

The average daily ending balance (including weekends).

average_daily_balance_by_month

required

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

string

required

The average daily ending balance of weekdays.

average_daily_balance_weekday_by_month

required

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

string

required

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

string

required

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

required

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

string

required

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

string

required

length ≥ 0

Name of the bank which issued the bank statement.

book_pk

uint64

required

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

branch_withdrawals_num

integer

≥ 0

Number of cash withdrawals from a physical location.

branch_withdrawals_sum

string

Amount of branch cash withdrawals from a physical location.

cash_balance_trend_30d

string

required

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

string

required

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

string

required

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

required

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

string

required

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

string

required

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

string

required

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

integer

≥ 0

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

casino_lottery_sum

string

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

checks_highest_incidence

array

length between 2 and 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].

Amount of check with highest incidence

checks_num

integer

≥ 0

Number of checks

credit_card_payments_num

integer

≥ 0

Number of Credit Card Payments

credit_card_payments_sum

string

Amount of Credit Card Payments

daily_balances

required

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

required

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

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

array of objects

required

length ≥ 0

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

Debt Consolidator Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

deposit_count

integer

required

≥ 0

The total number of credit transactions.

deposit_max_by_month

required

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

required

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

string

required

Sum of all credit transactions

deposits_count_by_month

required

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

required

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

integer

≥ 0

Number of outflow transactions to equipment leasing companies

equipment_lease_payments_sum

string

Total amount of outflow transactions to equipment leasing companies

estimated_daily_expense_by_month

required

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

required

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

required

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

array of objects

required

length ≥ 0

List of transactions included in estimated expense calculations.

Estimated Expense Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

estimated_revenue_by_month

object

required

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

Has additional fields

estimated_revenue_by_month_calc_txns

object

required

The list of credit transactions used to calculate estimated revenues grouped by category and calendar month.
estimated_revenue = all credits - revenue_deducted - transfer + revenue_included - alternative_lender + factoring 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.

estimated_revenue_txns_list

array of objects

required

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

Estimated Revenue Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

factor_txns

array of objects

required

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

Factoring Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

holder_address_1

string

required

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

holder_address_2

string | null

required

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

string

required

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

holder_country

string

required

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

holder_state

string

required

The captured state or territory of the account holder.

holder_zip

string

required

The captured postal code of the account holder.

integer

deprecated

insurance_credits

array of objects

required

length ≥ 0

A list of all positive transactions from insurance providers.

Insurance Credits*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

insurance_debits

array of objects

required

length ≥ 0

A list of all negative transactions from insurance providers.

Insurance Debits*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

insurance_payments_num

integer

≥ 0

Number of insurance payments

insurance_payments_sum

string

Amount of insurance payments

insurance_terms

array of objects

required

length ≥ 0

A list of negative transactions associated with insurance companies.

Insurance Terms*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

interbank_transactions

array of objects

required

length ≥ 0

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

List of Interbank Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

lottery_withdrawals_num

integer

≥ 0

Number of outflow transactions spent on lottery

lottery_withdrawals_sum

string

Total amount of outflow transactions spent on lottery

mca_payments_by_month

required

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

array of objects

required

length ≥ 0

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

Merchant Cash Advance Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

merchant_service_deposits_num

integer

≥ 0

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

merchant_service_deposits_sum

string

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

minimum_balance_by_month

required

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

string

required

length ≥ 0

Name of the Book or bank account

negative_balances_by_month

required

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

required

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

array of strings

required

length ≥ 0

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

List of Weekdays with Negative Balances*

negative_cash_flows

array of strings

required

length ≥ 0

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

List of Negative Cash Flow Days*

negative_cash_flows_weekday

array of strings

required

length ≥ 0

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

List of Negative Cash Flow Weekdays*

net_cash_flows_by_month

required

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

array of objects

required

length ≥ 0

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

Deposits Not Included in Estimated Revenue*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

nsf_count

integer

required

≥ 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

required

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

array of objects

required

length ≥ 0

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

List of NSF Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

nsf_transactions_paid_or_negative_balance

array of objects

required

length ≥ 0

A list of transactions associated with overdraft transactions.

NSF Transactions Paid Or Negative Balance*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

nsf_transactions_paid_or_negative_balance_count_by_month

required

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

array of objects

required

length ≥ 0

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

NSF Transactions Returned Or Not Paid*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

nsf_transactions_returned_or_not_paid_count_by_month

required

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

array of objects

required

length ≥ 0

The list of credit transactions that are not transfers

List of Deposits from Outside Sources*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

paypal_num

integer

≥ 0

deprecated

Number of Paypal Transactions

paypal_sum

string

deprecated

Amount of Paypal Transactions

payroll

array of objects

required

length ≥ 0

A list of all transactions from payroll providers.

Payroll*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

payroll_num

integer

≥ 0

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

payroll_sum

string

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

period_balance_mismatches

array of objects

required

length ≥ 0

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

Period Balance Mismatches*

object

begin_date

string

The starting date of the unaccounted-for statement period.

begin_balance

string

The starting balance of the unaccounted-for statement period.

end_date

string

The ending date of the unaccounted-for statement period.

end_balance

string

The ending balance of the unaccounted-for statement period.

periods

array of objects

required

length ≥ 0

Contains list of period level JSONs

Period Level Analytics*

object

alternative_lender_transactions

array of objects

required

length ≥ 0

List of Alternative Lender Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

average_amount

string

required

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

average_daily_balance

string

required

The average daily ending balance (including weekends).

average_daily_balance_weekday

string

required

The average daily ending balance of weekdays.

average_daily_cash_flow

string

required

average_daily_cash_flow_weekday

string

required

average_deposit

string

required

The average value of credit transactions

bank_account_pk

uint64

required

begin_balance

string

required

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

begin_date

string

required

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

deposit_count

integer

required

≥ 0

The total number of credit transactions.

deposit_max

array of objects

required

length ≥ 0

The credit txn(s) with the largest amount

Maximum Deposit*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

deposit_min

array of objects

required

length ≥ 0

The credit txn(s) with the smallest amount

Minimum Deposit*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

deposit_sum

string

required

Sum of all credit transactions

end_balance

string

required

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

end_date

string

required

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

estimated_revenue

string

required

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

object

required

The list of credit transactions that comprise the estimated revenue calculations for the business.

negative_balances

array of strings

required

length ≥ 0

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

List of Negative Balances*

negative_balances_weekday

array of strings

required

length ≥ 0

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

List of Weekdays with Negative Balances*

negative_cash_flows

array of strings

required

length ≥ 0

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

List of Negative Cash Flow Days*

negative_cash_flows_weekday

array of strings

required

length ≥ 0

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

List of Negative Cash Flow Weekdays*

nsf_count

integer

required

≥ 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

integer

required

≥ 0

The count of transactions associated with overdraft transactions.

nsf_transactions_returned_or_not_paid_count

integer

≥ 0

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

payroll

string

required

The sum of payroll transaction amounts within this period.

period_month_days

required

Number of days in the period grouped by month

period_month_txns

required

Number of transactions in the period grouped by month

uint64

required

A unique identifying integer.

primary_recon_error_reason

string

required

Defaults to None

Manual verifier flag for suspicious activity after inspection

secondary_recon_error_reason

string

required

deprecated

Manual verifier flag for suspicious activity after inspection

txn_count

integer

required

≥ 0

The total number of transactions in a bank account.

uploaded_doc_pk

uint64

required

Unique identifying integer

withdrawal_count

integer

required

≥ 0

The total number of debit transactions.

withdrawal_sum

string

required

The total monetary value of debits

withdrawals_max

array of objects

required

length ≥ 0

The debit transaction(s) with the most negative amount

Max Withdrawal*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

uint64

required

A unique identifying integer.

ppp_loan_txns

array of objects

required

length ≥ 0

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

PPP Loan Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

probable_recurring_txns

array of objects

required

length ≥ 0

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

Probable Recurring Transactions*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

recurring_vs_episodic_inflows_by_month

required

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

required

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

integer

≥ 0

deprecated

Total number of remote deposits in the bank account

remote_deposits_sum

string

deprecated

Sum of remote deposit amounts in the bank account

returned_items

array of objects

length ≥ 0

deprecated

Returned Items

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

round_number_txns

array of objects

required

length ≥ 0

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

List of Transactions Ending in 5 Zeros or More*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

state_tax_payments_num

integer

≥ 0

deprecated

Number of tax payments that are not US tax payments

state_tax_payments_sum

string

deprecated

Amount of tax payments that are not US tax payments

suspicious_activities

object

required

deprecated

Suspicious activity flags.
Deprecated because this represents legacy detection. We suggest using our dedicated Suspicious Activity Flags, which reveals suspicious activity signals with much greater accuracy and fidelity than offered by this attribute.

tolls_num

integer

≥ 0

Number of toll payments

tolls_sum

string

Amount of toll payments

total_days

integer

required

≥ 0

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

transfer

object

required

The list of all transfers to or from a bank account.

transfer_num

integer

≥ 0

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

transfer_sum

string

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

txn_count

integer

required

≥ 0

The total number of transactions in a bank account.

txn_four_zeros

integer

≥ 0

Number of transactions ending in 4 zeros (00.00)

usa_tax_payments_num

integer

≥ 0

deprecated

Number of US tax payments

usa_tax_payments_sum

string

Amount of US tax payments

venmo_zelle_cashapp_num

integer

≥ 0

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

venmo_zelle_cashapp_sum

string

Sum of amounts for Venmo, Zelle and Cash App transactions

withdrawal_count

integer

required

≥ 0

The total number of debit transactions.

withdrawal_sum

string

required

The total monetary value of debits

withdrawals

array of objects

required

length ≥ 0

The list of all debits transactions from a bank account.

Withdrawals*

object

page_idx

integer

required

≥ 0

The page number of the original document from which this transaction was captured.

bank_account_pk

uint64

required

The primary key of the bank account from which this transaction was captured.

amount

string

required

The amount of the credit or debit that this transaction represents. Will be in USD, and can be positive or negative.

bbox

array of numbers

required

length between 4 and 4

x is the horizontal position of the box, relative to the left of the page.
y is the vertical position of the bounding box, relative to the top of the page.
w is the width of the bounding box.
h is the height of the bounding box.

bbox*

txn_date

string

required

The date on which this transaction occurred. Given in MM/DD/YYYY format.

page_doc_pk

uint64

required

The unique identifier of the page from which this transaction was captured.

uint64

required

The unique identifier of this particular transaction.

uploaded_doc_pk

uint64

required

The unique identifier of the document from which this transaction was captured.

description

string

required

Details about the transaction that were captured from the original bank statement.

withdrawals_max_by_month

required

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

required

The sum of all debit transactions grouped by calendar month.

cash_expense_days_by_month

required

daily_balances

required

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_balances_by_month

required

A list of the daily ending balances for every day grouped by month.

daily_balances_weekday

required

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

daily_balances_weekday_by_month

required

A list of the daily ending balances for every weekday 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).
Each value is an object with keys that are string representations of a date, using the regex ^\d{2}/\d{2}/\d{4}$ (i.e MM/DD/YYYY).

deposit_count

integer

required

≥ 0

The total number of credit transactions.

deposit_sum

string

required

Sum of all credit transactions

estimated_daily_expense_by_month

required

estimated_expense_by_month

required

estimated_revenue_by_month

object

required

Has additional fields

mca_payments_by_month

required

name

string

required

length ≥ 0

Name of the Book or bank account

negative_balances_by_month

required

negative_balances_by_month_weekday

required

uint64

required

A unique identifying integer.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.ocrolus.com/v1/book/summary \
3
     --header 'accept: application/json'

Choose an example:

application/json

Analytics (JSON) (Deprecated)

🚧
We have a better version!

📘
Multiple endpoints, one object

200Success

400Client Errors