---
title: "Book summary"
method: GET
path: "/v2/book/{book_uuid}/summary"
tags: ["Cash Flow Analytics"]
---

# Book summary

`GET /v2/book/{book_uuid}/summary`

This API retrieves the Cash Flow Analytics summary of a Book in JSON format. It provides daily balances, bank account PII, and time series for all transaction categories at the <<glossary:Book>> and bank account level. 

It offers quicker analytics generation, more granular and accurate transaction categories (including improved revenue and expense calculations), and a more concise structure.

---

### Async processing 

This API supports asynchronous processing. To get the asynchronous result, add `async=true` in the query parameter to run the request as a background job and receive a `job_id` immediately instead of waiting for the full response inline. When `async=true`, the endpoint returns `202 Accepted` with a `job_id` instead of the analytics payload.

Async mode is required for Books with more than 100,000 transactions. Books exceeding 1,000,000 transactions are rejected with `422` (error code `1100`). Once submitted, poll
[Async job status](https://docs.ocrolus.com/reference/async-job-status) API to retrieve the result when the job is complete.

## Path parameters

- `book_uuid` string, uuid, required

## Query parameters

- `exclude_bank_account_pks` string
- `exclude_months` string
- `async` boolean

## Response `200`

Success

- SuccessBookSummarySchema
  - `book_pk` integer — A unique numerical identifier for a <<glossary:Book>>, commonly referred to as the Book primary key (Book pk).
  - `book_name` string — The name of the Book used for the analytics calculation.
  - `txn_count` integer — The number of transactions considered for analytics calculation.
  - `naics4_code` integer — A 4-digit North American Industry Classification System (NAICS) code that represents the industry of the Book.
  - `naics_description` string — The description of the 4-digit NAICS code, indicating the industry classification of the Book category. > 📘 In Books with multiple businesses or fragmented merchant activity, the widget may show the following statuses as applicable: > - **`Pending - Industry Data`**: Classification is in progress. > - **`Unable to find a unique SMB merchant`**: The system is not able to find a unique merchant mapped to the documents in the Book. > - **`Not Available`**: The system has found a unique merchant, but this merchant does not have industry classification data.
  - `naics6_code` integer — A six-digit NAICS code that provides a more granular industry classification for the merchant. This code refines the broader NAICS category and is commonly used for detailed industry analysis, peer comparisons, and benchmarking.
  - `naics6_description` string — A human-readable description of the six-digit NAICS code that specifies the merchant’s exact industry segment within the broader NAICS classification.
  - `naics_override` boolean — Shows if the 4-digit NAICSA code was overriden by the lender.
  - `mcc_code` integer — A four-digit code assigned by payment networks that classifies a merchant based on the primary type of goods or services they provide. Merchant Category Code (MCC) are commonly derived from card transaction data and are used for transaction categorization, risk assessment, and analytics.
  - `mcc_description_` string — A human-readable description of the MCC that explains the merchant’s primary business activity as defined by the card network.
  - `sic_code` integer — A four-digit Standard Industrial Classification (SIC) code that identifies the merchant’s primary business activity using the legacy SIC system. SIC codes are derived from bank statement data and are used for industry classification, regulatory reporting, and analytics.
  - `sic_description_` string — A human-readable description of the SIC code that explains the merchant’s primary industry classification under the SIC system.
  - `loan_inquiries` object — Summary of loan applications made by the SMB entity, including application history and application velocity over various time windows.
    - `smb_entity_name` string — Merchant name derived from the account holder name in the bank statement.
    - `total_applications` integer — Total number of applications Ocrolus has seen for the merchant, up to the creation time of the current Book.
    - `application_history` object[] — List of prior application timestamps for the merchant, shown in descending order.
      - `created_ts` string, date-time — The timestamp when the loan application was created.
    - `velocity` object — Number of applications the merchant has submitted within trailing time windows (30–365 days).
      - `30_day_count` integer — Number of applications in the last 30 days.
      - `60_day_count` integer — Number of applications in the last 60 days.
      - `90_day_count` integer — Number of applications in the last 90 days.
      - `180_day_count` integer — Number of applications in the last 180 days.
      - `270_day_count` integer — Number of applications in the last 270 days.
      - `365_day_count` integer — Number of applications in the last 365 days.
  - `book_mismatch_severity` string — The severity of mismatches detected in the Book, such as discrepancies between uploaded documents and extracted data. Possible values include Low, Medium, and High. > 📘 **This attribute is in beta. If you encounter any bug, please reach out to support@ocrolus.com.**
  - `daily_balances` unknown[] — A time series showing the daily balances on a daily basis.
    - unknown
  - `daily_cash_flows` unknown[] — A daily time series of cash flows, calculated as the difference between total credits and total debits, arranged in chronological order.
    - unknown
  - `average_daily_cash_flow` number — The average value in `daily_cash_flows`.
  - `net_cash_flows_by_month` unknown[] — The cash flows resulting from the difference between total credits and total debits, categorized by calendar month.
    - unknown
  - `minimum_balance_by_month` unknown[] — The minimum daily balance grouped by calendar month.
    - unknown
  - `maximum_balance_by_month` unknown[] — The maximum daily balance grouped by calendar month.
    - unknown
  - `average_daily_balance` number — The average amount in `daily_balances`.
  - `average_daily_balance_by_month` unknown[] — The average daily balance grouped by calendar month.
    - unknown
  - `average_daily_balance_weekday` number — The average daily balance on weekdays
  - `average_daily_balance_weekday_by_month` unknown[] — The average daily balance on weekdays grouped by calendar month.
    - unknown
  - `total_days` number — Total number of days for which analytics is calculated.
  - `negative_balances_by_month` unknown[] — List of dates with negative ending balances grouped by calendar month.
    - unknown
  - `negative_balances_weekday_by_month` unknown[] — List of dates with negative ending balances on weekdays grouped by calendar month.
    - unknown
  - `nnegative_balances_weekday_count_by_month` unknown[] — List of dates with count of negative ending balances grouped by calendar month.
    - unknown
  - `cash_balance_trend_30d` number — Daily cash balance trend of 30 days. The calculation formula is `((Mean cash balance over first 15 days ) - (Mean cash balance over last 15 days) ) / standard deviation of cash balance over the period`.
  - `cash_balance_trend_60d` number — Daily cash balance trend of 60 days. The calculation formula is `((Mean cash balance over first 30 days ) - (Mean cash balance over last 30 days) ) / standard deviation of cash balance over the period`.
  - `cash_balance_trend_90d` number — Daily cash balance trend of 90 days. The calculation formula is `((Mean cash balance over first 45 days ) - (Mean cash balance over last 45 days) ) / standard deviation of cash balance over the period`.
  - `cash_flow_trend_30d` number — Daily cash flow trend of 30 days. The calculation formula is `((Mean cash flow over first 15 days ) - (Mean cash flow over last 15 days) ) / standard deviation of cash flow over the period`.
  - `cash_flow_trend_60d` number — Daily cash flow trend of 60 days. The calculation formula is `((Mean cash flow over first 30 days ) - (Mean cash flow over last 30 days) ) / standard deviation of cash flow over the period`.
  - `cash_flow_trend_90d` number — Daily cash flow trend of 90 days. The calculation formula is `((Mean cash flow over first 45 days ) - (Mean cash flow over last 45 days) ) / standard deviation of cash flow over the period`.
  - `average_txn_size_by_month` object — The average transaction size grouped by month.
  - `average_deposits_by_month` object — The average number of deposits size grouped by month.
  - `expense_by_month` unknown[] — Expenses grouped by calendar month.
    - unknown
  - `withdrawals_by_month` unknown[] — Withdrawals grouped by calendar month.
    - unknown
  - `revenue_by_month` unknown[] — Revenue grouped by calendar month.
    - unknown
  - `revenue_deduction_by_month` unknown[] — Revenue deductions grouped by calendar month.
    - unknown
  - `deposits_by_month` unknown[] — Deposits grouped by calendar month.
    - unknown
  - `outside_source_deposits_by_month` unknown[] — Outside source deposits grouped by calendar month.
    - unknown
  - `large_deposits_by_month` unknown[] — List of large amount of deposits grouped by calendar month.
    - unknown
  - `debt_consolidator_inflows_by_month` unknown[] — Debt consolidator inflows grouped by calendar month.
    - unknown
  - `debt_consolidator_outflows_by_month` unknown[] — Debt consolidator outflows grouped by calendar month.
    - unknown
  - `factoring_inflows_by_month` unknown[] — Factoring inflows grouped by calendar month.
    - unknown
  - `factoring_outflows_by_month` unknown[] — Factoring outflows grouped by calendar month.
    - unknown
  - `payroll_inflows_by_month` unknown[] — Payroll inflows grouped by calendar month.
    - unknown
  - `payroll_outflows_by_month` unknown[] — Payroll outflows grouped by calendar month.
    - unknown
  - `insurance_inflows_by_month` unknown[] — Insurance inflows grouped by calendar month.
    - unknown
  - `insurance_outflows_by_month` unknown[] — Insurance outflows grouped by calendar month.
    - unknown
  - `venmo_zelle_cashapp_inflows_by_month` unknown[] — Venmo/Zelle/Cash App inflows grouped by calendar month.
    - unknown
  - `venmo_zelle_cashapp_outflows_by_month` unknown[] — Venmo/Zelle/Cash App outflows grouped by calendar month.
    - unknown
  - `atm_inflows_by_month` unknown[] — Automated teller machine (ATM) inflows grouped by calendar month.
    - unknown
  - `atm_outflows_by_month` unknown[] — Automated teller machine (ATM) outflows grouped by calendar month.
    - unknown
  - `tolls_inflows_by_month` unknown[] — Toll inflows grouped by calendar month.
    - unknown
  - `tolls_outflows_by_month` unknown[] — Toll outflows grouped by calendar month.
    - unknown
  - `paypal_inflows_by_month` unknown[] — PayPal inflows grouped by calendar month.
    - unknown
  - `paypal_outflows_by_month` unknown[] — Paypal outflows grouped by calendar month.
    - unknown
  - `equipment_lease_inflows_by_month` unknown[] — Equipment lease inflows grouped by calendar month.
    - unknown
  - `equipment_lease_outflows_by_month` unknown[] — Equipment lease outflows grouped by calendar month.
    - unknown
  - `checks_inflows_by_month` unknown[] — Check inflows grouped by calendar month.
    - unknown
  - `checks_outflows_by_month` unknown[] — Check outflows grouped by calendar month.
    - unknown
  - `txn_four_zeros_inflows_by_month` unknown[] — Transactions with four zeros inflows grouped by calendar month.
    - unknown
  - `txn_four_zeros_outflows_by_month` unknown[] — Transactions with four zeros outflows grouped by calendar month.
    - unknown
  - `txn_five_zeros_inflows_by_month` unknown[] — Transactions with five zeros inflows grouped by calendar month.
    - unknown
  - `txn_five_zeros_outflows_by_month` unknown[] — Transactions with five zeros outflows grouped by calendar month.
    - unknown
  - `probable_recurring_txns_inflows_by_month` unknown[] — Recurring transactions inflows grouped by calendar month.
    - unknown
  - `probable_recurring_txns_outflows_by_month` unknown[] — Recurring transactions outflows grouped by calendar month.
    - unknown
  - `fintech_loan_inflows_by_month` unknown[] — Fintech loan inflows grouped by calendar month.
    - unknown
  - `fintech_loan_outflows_by_month` unknown[] — Fintech loan outflows grouped by calendar month.
    - unknown
  - `bank_loan_inflows_by_month` unknown[] — Bank loan inflows grouped by calendar month.
    - unknown
  - `bank_loan_outflows_by_month` unknown[] — Bank loan outflows grouped by calendar month.
    - unknown
  - `other_loan_inflows_by_month` unknown[] — Other loan inflows grouped by calendar month.
    - unknown
  - `other_loan_outflows_by_month` unknown[] — Other loan outflows grouped by calendar month.
    - unknown
  - `fintech_mca_inflows_by_month` unknown[] — Fintech MCA (merchant cash adavance) inflows grouped by calendar month.
    - unknown
  - `fintech_mca_outflows_by_month` unknown[] — Fintech MCA (merchant cash adavance) outflows grouped by calendar month.
    - unknown
  - `bank_cash_advance_inflows_by_month` unknown[] — Bank cash advance inflows grouped by calendar month.
    - unknown
  - `bank_cash_advance_outflows_by_month` unknown[] — Bank cash advance outflows grouped by calendar month.
    - unknown
  - `debit_card_inflows_by_month` unknown[] — Debit card inflows grouped by calendar month.
    - unknown
  - `debit_card_outflows_by_month` unknown[] — Debit card outflows grouped by calendar month.
    - unknown
  - `credit_card_inflows_by_month` unknown[] — Credit card inflows grouped by calendar month.
    - unknown
  - `credit_card_outflows_by_month` unknown[] — Credit card outflows grouped by calendar month.
    - unknown
  - `merchant_service_inflows_by_month` unknown[] — Merchant service inflows grouped by calendar month.
    - unknown
  - `merchant_service_outflows_by_month` unknown[] — Merchant service outflows grouped by calendar month.
    - unknown
  - `sba_inflows_by_month` unknown[] — SBA inflows grouped by calendar month.
    - unknown
  - `sba_outflows_by_month` unknown[] — SBA outflows grouped by calendar month.
    - unknown
  - `remote_inflows_by_month` unknown[] — Remote inflows grouped by calendar month.
    - unknown
  - `remote_outflows_by_month` unknown[] — Remote outflows grouped by calendar month.
    - unknown
  - `benefits_inflows_by_month` unknown[] — Benefit inflows grouped by calendar month.
    - unknown
  - `benefits_outflows_by_month` unknown[] — Benefit outflows grouped by calendar month.
    - unknown
  - `card_rewards_inflows_by_month` unknown[] — Card reward inflows grouped by calendar month.
    - unknown
  - `card_rewards_outflows_by_month` unknown[] — Card reward outflows grouped by calendar month.
    - unknown
  - `crypto_inflows_by_month` unknown[] — Crypto inflows grouped by calendar month.
    - unknown
  - `crypto_outflows_by_month` unknown[] — Crypto outflows grouped by calendar month.
    - unknown
  - `gambling_inflows_by_month` unknown[] — Gambling inflows grouped by calendar month.
    - unknown
  - `gambling_outflows_by_month` unknown[] — Gambling outflows grouped by calendar month.
    - unknown
  - `investment_inflows_by_month` unknown[] — Investment inflows grouped by calendar month.
    - unknown
  - `investment_outflows_by_month` unknown[] — Investment outflows grouped by calendar month.
    - unknown
  - `reversed_inflows_by_month` unknown[] — Reversed inflows grouped by calendar month.
    - unknown
  - `reversed_outflows_by_month` unknown[] — Reversed outflows grouped by calendar month.
    - unknown
  - `state_tax_inflows_by_month` unknown[] — State tax inflows grouped by calendar month.
    - unknown
  - `state_tax_outflows_by_month` unknown[] — State tax outflows grouped by calendar month.
    - unknown
  - `payroll_tax_inflows_by_month` unknown[] — Payroll tax inflows grouped by calendar month.
    - unknown
  - `payroll_tax_outflows_by_month` unknown[] — Payroll tax outflows grouped by calendar month.
    - unknown
  - `internal_transfer_inflows_by_month` unknown[] — Internal transfer inflows grouped by calendar month.
    - unknown
  - `internal_transfer_outflows_by_month` unknown[] — Internal transfer outflows grouped by calendar month.
    - unknown
  - `merchant_service_transfer_inflows_by_month` unknown[] — Merchant service transfer inflows grouped by calendar month.
    - unknown
  - `merchant_service_transfer_outflows_by_month` unknown[] — Merchant service transfer outflows grouped by calendar month.
    - unknown
  - `wire_transfer_inflows_by_month` unknown[] — Wire transfer inflows grouped by calendar month.
    - unknown
  - `wire_transfer_outflows_by_month` unknown[] — Wire transfer outflows grouped by calendar month.
    - unknown
  - `other_transfer_inflows_by_month` unknown[] — Other transfer inflows grouped by calendar month.
    - unknown
  - `other_transfer_outflows_by_month` unknown[] — Other transfer outflows grouped by calendar month.
    - unknown
  - `truck_stop_inflows_by_month` unknown[] — Truck stop inflows grouped by calendar month.
    - unknown
  - `truck_stop_outflows_by_month` unknown[] — Truck stop outflows grouped by calendar month.
    - unknown
  - `federal_tax_inflows_by_month` unknown[] — Federal tax inflows grouped by calendar month.
    - unknown
  - `federal_tax_outflows_by_month` unknown[] — Federal tax outflows grouped by calendar month.
    - unknown
  - `bank_branch_inflows_by_month` unknown[] — Bank branch inflows grouped by calendar month.
    - unknown
  - `bank_branch_outflows_by_month` unknown[] — Bank branch outflows grouped by calendar month.
    - unknown
  - `credit_builder_inflows_by_month` unknown[] — Credit builder inflows grouped by calendar month.
    - unknown
  - `credit_builder_outflows_by_month` unknown[] — Credit builder outflows grouped by calendar month.
    - unknown
  - `rideshare_by_month` unknown[] — List of transactions pertaining to rideshares grouped by calendar month.
    - unknown
  - `expense_count_by_month` unknown[] — Expense counts grouped by calendar month.
    - unknown
  - `withdrawals_count_by_month` unknown[] — Withdrawal counts grouped by calendar month.
    - unknown
  - `revenue_count_by_month` unknown[] — Revenue counts grouped by calendar month.
    - unknown
  - `deposits_count_by_month` unknown[] — Deposit counts grouped by calendar month.
    - unknown
  - `nsf_fee_count_by_month` unknown[] — Non-sufficient funds (NSF) fees count grouped by calendar month.
    - unknown
  - `nsf_divisor` number — Calculated amount for a single NSF fee.\nThe common divisor is defined as "the least common multiple (in 0.50 increments) of amount values corresponding to transactions with nsf = True".\nThis multiple must fall between 25 and 60 (inclusive) otherwise nsf_divisor = None and no scaling occurs.
  - `nsf_raw_fee_count_by_month` unknown[] — Non-sufficient funds (NSF) fee count (NOT including common divisor logic) grouped by calendar month.
    - unknown
  - `overdraft_fee_count_by_month` unknown[] — Overdraft fees count grouped by calendar month.
    - unknown
  - `overdraft_divisor` number — Calculated amount for a single overdraft fee.\nThe common divisor is defined as "the least common multiple (in 0.50 increments) of amount values corresponding to transactions with overdraft = True".\nThis multiple must fall between 25 and 60 (inclusive) otherwise overdraft = None and no scaling occurs.
  - `overdraft_raw_fee_count_by_month` unknown[] — Overdraft fee count (NOT including common divisor logic) grouped by calendar month.
    - unknown
  - `returned_item_deposit_count_by_month` unknown[] — Returned item deposit count grouped by calendar month.
    - unknown
  - `returned_item_withdrawal_count_by_month` unknown[] — Returned item withdrawal count grouped by calendar month.
    - unknown
  - `fintech_loan_sources` object[] — An array summarizing fintech loan sources found in this Book.
    - `source` string — The name of the lender.
    - `deposit_sum` integer — The total proceeds from the lender.
    - `deposit_count` integer — The number of proceed events from the lender.
    - `deposit` unknown[] — List of deposits for fintech loans.
      - unknown
    - `pmt_sum` integer — The total payments to the lender.
    - `pmt_count` integer — The number of payment events to the lender
    - `pmt_frequency` unknown[] — The average number of days between each payment to the lender
      - unknown
    - `pmts` unknown[] — List of payments from fintech loans.
      - unknown
    - `events` unknown[] — Used to make an informed evaluation of debt status based on payment patterns for fintech loans and fintech MCAs. The available options are PAID IN FULL, STOP PAYMENT, REDUCED PAYMENT, INCREASED PAYMENT, and PAYMENT FREQUENCY CHANGE.
      - unknown
  - `fintech_mca_sources` object[] — An array summarizing fintech mca sources found in this Book.
    - `source` string — The name of the lender.
    - `deposit_sum` integer — The total proceeds from the lender.
    - `deposit_count` integer — The number of proceed events from the lender.
    - `pmt_sum` integer — The total payments to the lender.
    - `pmt_count` integer — The number of payment events to the lender.
    - `pmt_frequency` unknown[] — The average number of days between each payment to the lender.
      - unknown
  - `num_fintech_loan_sources` integer — Number of unique fintech_loan_sources.
  - `num_fintech_mca_sources` integer — Number of unique fintech_mca_sources.
  - `counterparties` object[] — Distribution statistics of revenue and expense counterparties.
    - `category` string — The financial classification of the transactions associated with a counterparty.
    - `distribution` object[] — A breakdown of specific counterparties within a category, including their transaction details.
      - `counterparty` string — Standardized identifier of the transaction counterparty.
      - `rank` number — The position of the counterparty within the category, based on the transaction amount.
      - `proportion` number — The percentage of the total amount within the category attributed to the counterparty.
      - `amount` number — The total monetary value of transactions associated with the counterparty in the specified category.
    - `average_per_counteryparty` number — The average monetary value of transactions per counterparty in the specified category.
    - `num_counterparties` number — The total number of counterparties within the specified category.
  - `cash_flow_at_a_glance` object — Summarized cash flow analytics.
    - `total_revenue` number — Sum total of all revenue found within this Book.
    - `total_expense` number — Sum total of all expenses found within this Book.
    - `total_loan_proceeds` number — Sum total of all loan proceeds found within this Book.
    - `total_loan_payments` number — Sum total of all loan proceeds found within this Book.
    - `debt_coverage_ratio` number — The overall debt coverage ratio of this Book.
    - `total_nsf_fee_count` number — Count of all Non-sufficient funds (NSF) fees within this Book.
  - `missing_bank_accounts` object — Unreconciled internal transfers showing bank accounts that were not submitted by borrowers during underwriting.
    - `account_type` string — The type of the missing bank account such CHECKING or SAVINGS.
    - `account_number` number — The missing bank account number.
    - `total_transfered_to` number — The total amount transferred to the missing bank account.
    - `total_transfered_from` number — The total amount transferred from the missing bank account.
  - `bank_accounts` object[] — An array of bank account level analytics JSONs.
    - `bank_account_pk` number — Unique integer identifier for bank account.
    - `bank_account_name` string — The name of the bank account used to calculate analytics.
    - `bank_name` string — The name of bank issuing the bank statement.
    - `account_type` string — Indicates whether the account is a checking or savings account.
    - `account_holder` string — Name of the bank account holder.
    - `account_number` string — Bank account number used to calculate analytics.
    - `holder_zip` string — Zip code of the bank account holder.
    - `holder_country` string — Country of the bank account holder.
    - `holder_state` string — State of the bank account holder.
    - `holder_city` string — City of the bank account holder.
    - `holder_address_1` string — First line address of the bank account holder.
    - `holder_address_2` string — Second line address of the bank account holder.
    - `account_category` string — Indicates whether the account is a personal or business account.
    - `txn_count` integer — The number of transactions considered for analytics calculation on bank account level.
    - `daily_balances` unknown[] — A time series showing the daily balances on a daily basis.
      - unknown
    - `daily_cash_flows` unknown[] — A daily time series of cash flows, calculated as the difference between total credits and total debits, arranged in chronological order.
      - unknown
    - `average_daily_cash_flow` number — The average value in `daily_cash_flows`.
    - `net_cash_flows_by_month` unknown[] — The cash flows resulting from the difference between total credits and total debits, categorized by calendar month.
      - unknown
    - `minimum_balance_by_month` unknown[] — The minimum daily balance grouped by calendar month.
      - unknown
    - `average_daily_balance` number — The average amount in `daily_balances`.
    - `average_daily_balance_by_month` unknown[] — The average daily balance grouped by calendar month.
      - unknown
    - `average_daily_balance_weekday` number — The average daily balance on weekdays
    - `average_daily_balance_weekday_by_month` unknown[] — The average daily balance on weekdays grouped by calendar month.
      - unknown
    - `total_days` number — Total number of days for which analytics is calculated.
    - `negative_balances_by_month` unknown[] — List of dates with negative ending balances grouped by calendar month.
      - unknown
    - `negative_balances_count_by_month` unknown[] — Count of negative ending balances grouped by calendar month
      - unknown
    - `negative_balances_weekday_by_month` unknown[] — List of weekdays with negative ending balances grouped by calendar month
      - unknown
    - `negative_balances_weekday_count_by_month` unknown[] — Count of weekdays with negative ending balances grouped by calendar month
      - unknown
    - `cash_balance_trend_30d` number — Daily cash balance trend of 30 days. The calculation formula is `((Mean cash balance over first 15 days ) - (Mean cash balance over last 15 days) ) / standard deviation of cash balance over the period`.
    - `cash_balance_trend_60d` number — Daily cash balance trend of 60 days. The calculation formula is `((Mean cash balance over first 30 days ) - (Mean cash balance over last 30 days) ) / standard deviation of cash balance over the period`.
    - `cash_balance_trend_90d` number — Daily cash balance trend of 90 days. The calculation formula is `((Mean cash balance over first 45 days ) - (Mean cash balance over last 45 days) ) / standard deviation of cash balance over the period`.
    - `cash_flow_trend_30d` number — Daily cash flow trend of 30 days. The calculation formula is `((Mean cash flow over first 15 days ) - (Mean cash flow over last 15 days) ) / standard deviation of cash flow over the period`.
    - `cash_flow_trend_60d` number — Daily cash flow trend of 60 days. The calculation formula is `((Mean cash flow over first 30 days ) - (Mean cash flow over last 30 days) ) / standard deviation of cash flow over the period`.
    - `cash_flow_trend_90d` number — Daily cash flow trend of 90 days. The calculation formula is `((Mean cash flow over first 45 days ) - (Mean cash flow over last 45 days) ) / standard deviation of cash flow over the period`.
    - `average_txn_size_by_month` object — The average transaction size grouped by month.
    - `average_deposits_by_month` object — The average number of deposits size grouped by month.
    - `expense_by_month` unknown[] — Expenses grouped by calendar month.
      - unknown
    - `withdrawals_by_month` unknown[] — Withdrawals grouped by calendar month.
      - unknown
    - `revenue_by_month` unknown[] — Revenue grouped by calendar month.
      - unknown
    - `revenue_deduction_by_month` unknown[] — Revenue deductions grouped by calendar month.
      - unknown
    - `deposits_by_month` unknown[] — Deposits grouped by calendar month.
      - unknown
    - `outside_source_deposits_by_month` unknown[] — Outside source deposits grouped by calendar month.
      - unknown
    - `debt_consolidator_inflows_by_month` unknown[] — Debt consolidator inflows grouped by calendar month.
      - unknown
    - `debt_consolidator_outflows_by_month` unknown[] — Debt consolidator outflows grouped by calendar month.
      - unknown
    - `factoring_inflows_by_month` unknown[] — Factoring inflows grouped by calendar month.
      - unknown
    - `factoring_outflows_by_month` unknown[] — Factoring outflows grouped by calendar month.
      - unknown
    - `payroll_inflows_by_month` unknown[] — Payroll inflows grouped by calendar month.
      - unknown
    - `payroll_outflows_by_month` unknown[] — Payroll outflows grouped by calendar month.
      - unknown
    - `insurance_inflows_by_month` unknown[] — Insurance inflows grouped by calendar month.
      - unknown
    - `insurance_outflows_by_month` unknown[] — Insurance outflows grouped by calendar month.
      - unknown
    - `venmo_zelle_cashapp_inflows_by_month` unknown[] — Venmo/Zelle/Cash App inflows grouped by calendar month.
      - unknown
    - `venmo_zelle_cashapp_outflows_by_month` unknown[] — Venmo/Zelle/Cash App outflows grouped by calendar month.
      - unknown
    - `atm_inflows_by_month` unknown[] — Automated teller machine (ATM) inflows grouped by calendar month.
      - unknown
    - `atm_outflows_by_month` unknown[] — Automated teller machine (ATM) outflows grouped by calendar month.
      - unknown
    - `tolls_inflows_by_month` unknown[] — Toll inflows grouped by calendar month.
      - unknown
    - `tolls_outflows_by_month` unknown[] — Toll outflows grouped by calendar month.
      - unknown
    - `paypal_inflows_by_month` unknown[] — PayPal inflows grouped by calendar month.
      - unknown
    - `paypal_outflows_by_month` unknown[] — Paypal outflows grouped by calendar month.
      - unknown
    - `equipment_lease_inflows_by_month` unknown[] — Equipment lease inflows grouped by calendar month.
      - unknown
    - `equipment_lease_outflows_by_month` unknown[] — Equipment lease outflows grouped by calendar month.
      - unknown
    - `checks_inflows_by_month` unknown[] — Check inflows grouped by calendar month.
      - unknown
    - `checks_outflows_by_month` unknown[] — Check outflows grouped by calendar month.
      - unknown
    - `txn_four_zeros_inflows_by_month` unknown[] — Transactions with four zeros inflows grouped by calendar month.
      - unknown
    - `txn_four_zeros_outflows_by_month` unknown[] — Transactions with four zeros outflows grouped by calendar month.
      - unknown
    - `txn_five_zeros_inflows_by_month` unknown[] — Transactions with five zeros inflows grouped by calendar month.
      - unknown
    - `txn_five_zeros_outflows_by_month` unknown[] — Transactions with five zeros outflows grouped by calendar month.
      - unknown
    - `probable_recurring_txns_inflows_by_month` unknown[] — Recurring transactions inflows grouped by calendar month.
      - unknown
    - `probable_recurring_txns_outflows_by_month` unknown[] — Recurring transactions outflows grouped by calendar month.
      - unknown
    - `fintech_loan_inflows_by_month` unknown[] — Fintech loan inflows grouped by calendar month.
      - unknown
    - `fintech_loan_outflows_by_month` unknown[] — Fintech loan outflows grouped by calendar month.
      - unknown
    - `bank_loan_inflows_by_month` unknown[] — Bank loan inflows grouped by calendar month.
      - unknown
    - `bank_loan_outflows_by_month` unknown[] — Bank loan outflows grouped by calendar month.
      - unknown
    - `other_loan_inflows_by_month` unknown[] — Other loan inflows grouped by calendar month.
      - unknown
    - `other_loan_outflows_by_month` unknown[] — Other loan outflows grouped by calendar month.
      - unknown
    - `fintech_mca_inflows_by_month` unknown[] — Fintech MCA (merchant cash adavance) inflows grouped by calendar month.
      - unknown
    - `fintech_mca_outflows_by_month` unknown[] — Fintech MCA (merchant cash adavance) outflows grouped by calendar month.
      - unknown
    - `bank_cash_advance_inflows_by_month` unknown[] — Bank cash advance inflows grouped by calendar month.
      - unknown
    - `bank_cash_advance_outflows_by_month` unknown[] — Bank cash advance outflows grouped by calendar month.
      - unknown
    - `debit_card_inflows_by_month` unknown[] — Debit card inflows grouped by calendar month.
      - unknown
    - `debit_card_outflows_by_month` unknown[] — Debit card outflows grouped by calendar month.
      - unknown
    - `credit_card_inflows_by_month` unknown[] — Credit card inflows grouped by calendar month.
      - unknown
    - `credit_card_outflows_by_month` unknown[] — Credit card outflows grouped by calendar month.
      - unknown
    - `merchant_service_inflows_by_month` unknown[] — Merchant service inflows grouped by calendar month.
      - unknown
    - `merchant_service_outflows_by_month` unknown[] — Merchant service outflows grouped by calendar month.
      - unknown
    - `sba_inflows_by_month` unknown[] — SBA inflows grouped by calendar month.
      - unknown
    - `sba_outflows_by_month` unknown[] — SBA outflows grouped by calendar month.
      - unknown
    - `remote_inflows_by_month` unknown[] — Remote inflows grouped by calendar month.
      - unknown
    - `remote_outflows_by_month` unknown[] — Remote outflows grouped by calendar month.
      - unknown
    - `benefits_inflows_by_month` unknown[] — Benefit inflows grouped by calendar month.
      - unknown
    - `benefits_outflows_by_month` unknown[] — Benefit outflows grouped by calendar month.
      - unknown
    - `card_rewards_inflows_by_month` unknown[] — Card reward inflows grouped by calendar month.
      - unknown
    - `card_rewards_outflows_by_month` unknown[] — Card reward outflows grouped by calendar month.
      - unknown
    - `crypto_inflows_by_month` unknown[] — Crypto inflows grouped by calendar month.
      - unknown
    - `crypto_outflows_by_month` unknown[] — Crypto outflows grouped by calendar month.
      - unknown
    - `gambling_inflows_by_month` unknown[] — Gambling inflows grouped by calendar month.
      - unknown
    - `gambling_outflows_by_month` unknown[] — Gambling outflows grouped by calendar month.
      - unknown
    - `investment_inflows_by_month` unknown[] — Investment inflows grouped by calendar month.
      - unknown
    - `investment_outflows_by_month` unknown[] — Investment outflows grouped by calendar month.
      - unknown
    - `reversed_inflows_by_month` unknown[] — Reversed inflows grouped by calendar month.
      - unknown
    - `reversed_outflows_by_month` unknown[] — Reversed outflows grouped by calendar month.
      - unknown
    - `state_tax_inflows_by_month` unknown[] — State tax inflows grouped by calendar month.
      - unknown
    - `state_tax_outflows_by_month` unknown[] — State tax outflows grouped by calendar month.
      - unknown
    - `payroll_tax_inflows_by_month` unknown[] — Payroll tax inflows grouped by calendar month.
      - unknown
    - `payroll_tax_outflows_by_month` unknown[] — Payroll tax outflows grouped by calendar month.
      - unknown
    - `internal_transfer_inflows_by_month` unknown[] — Internal transfer inflows grouped by calendar month.
      - unknown
    - `internal_transfer_outflows_by_month` unknown[] — Internal transfer outflows grouped by calendar month.
      - unknown
    - `merchant_service_transfer_inflows_by_month` unknown[] — Merchant service transfer inflows grouped by calendar month.
      - unknown
    - `merchant_service_transfer_outflows_by_month` unknown[] — Merchant service transfer outflows grouped by calendar month.
      - unknown
    - `wire_transfer_inflows_by_month` unknown[] — Wire transfer inflows grouped by calendar month.
      - unknown
    - `wire_transfer_outflows_by_month` unknown[] — Wire transfer outflows grouped by calendar month.
      - unknown
    - `other_transfer_inflows_by_month` unknown[] — Other transfer inflows grouped by calendar month.
      - unknown
    - `other_transfer_outflows_by_month` unknown[] — Other transfer outflows grouped by calendar month.
      - unknown
    - `truck_stop_inflows_by_month` unknown[] — Truck stop inflows grouped by calendar month.
      - unknown
    - `truck_stop_outflows_by_month` unknown[] — Truck stop outflows grouped by calendar month.
      - unknown
    - `federal_tax_inflows_by_month` unknown[] — Federal tax inflows grouped by calendar month.
      - unknown
    - `federal_tax_outflows_by_month` unknown[] — Federal tax outflows grouped by calendar month.
      - unknown
    - `bank_branch_inflows_by_month` unknown[] — Bank branch inflows grouped by calendar month.
      - unknown
    - `bank_branch_outflows_by_month` unknown[] — Bank branch outflows grouped by calendar month.
      - unknown
    - `credit_builder_inflows_by_month` unknown[] — Credit builder inflows grouped by calendar month.
      - unknown
    - `credit_builder_outflows_by_month` unknown[] — Credit builder outflows grouped by calendar month.
      - unknown
    - `rideshare_by_month` unknown[] — List of transactions pertaining to rideshares grouped by calendar month.
      - unknown
    - `expense_count_by_month` unknown[] — Expense counts grouped by calendar month.
      - unknown
    - `withdrawals_count_by_month` unknown[] — Withdrawal counts grouped by calendar month.
      - unknown
    - `revenue_count_by_month` unknown[] — Revenue counts grouped by calendar month.
      - unknown
    - `deposits_count_by_month` unknown[] — Deposit counts grouped by calendar month.
      - unknown
    - `nsf_fee_count_by_month` unknown[] — The count of Non-Sufficient Funds (NSF) fees categorized by month of the calendar year.
      - unknown
    - `nsf_divisor` number — A metric used to calculate NSF frequency by dividing the number of NSF occurrences by a specified baseline, such as the total number of transactions or a time period.
    - `nsf_raw_fee_count_by_month` unknown[] — Non-sufficient funds (NSF) fee count (NOT including common divisor logic) grouped by calendar month.
      - unknown
    - `overdraft_fee_count_by_month` unknown[] — Overdraft fees count grouped by calendar month.
      - unknown
    - `overdraft_divisor` number — Calculated amount for a single overdraft fee.\nThe common divisor is defined as "the least common multiple (in 0.50 increments) of amount values corresponding to transactions with overdraft = True".\nThis multiple must fall between 25 and 60 (inclusive) otherwise overdraft = None and no scaling occurs.
    - `overdraft_raw_fee_count_by_month` unknown[] — Overdraft fee count (NOT including common divisor logic) grouped by calendar month.
      - unknown
    - `returned_item_deposit_count_by_month` unknown[] — Returned item deposit count grouped by calendar month.
      - unknown
    - `returned_item_withdrawal_count_by_month` unknown[] — Returned item withdrawal count grouped by calendar month.
      - unknown
    - `nsf_paid_or_negative_balance_fee_count_by_month` unknown[] — Non-sufficient funds (NSF) fees paid or negative balance fee count grouped by calendar month.
      - unknown
    - `nsf_returned_or_not_paid_fee_count_by_month` unknown[] — Non-sufficient funds (NSF) fees returned or not paid fees count grouped by calendar month.
      - unknown
    - `periods` object — A list of statement periods covered by the Book. Each period represents the date range of a single bank statement. **Reconciliation field behavior** When `reconciled` is `true`, `recon_error_absolute_amount` is `null` or `0` and all other recon fields are `null`. When `reconciled` is `false`, `recon_error_absolute_amount` is populated and remaining recon fields are populated where available. Reconciliation values are consistent with the transactions endpoint.
      - `begin_date` string — The start date of the statement period retrieved from the summary section of a bank statement.
      - `end_date` string — The end date of the statement period retrieved from the summary section of a bank statement.
      - `begin_balance` number — The initial balance of the statement period retrieved from the summary section of a bank statement.
      - `end_balance` number — The final balance of the statement period retrieved from the summary section of a bank statement.
      - `txn_count` integer — The count of transactions that were included in the analytics calculation for this particular period.
      - `uploaded_doc_pk` integer — The unique identifier of the document from which this transaction is captured.
      - `average_amount` number — The mean absolute amount of transactions within a given statement period.
      - `average_daily_balance` number — The average daily ending balance including weekends.
      - `average_daily_cash_flow` number — The mean daily net cash flow, calculated as the difference between total credits and total debits. The `Net Cash Flow = Credits - Debits`.
      - `average_deposit` number — The average amount of credit transactions.
      - `deposit_sum` number — The overall amount credit during the specified period.
      - `deposit_count` integer — The total number of deposit occurrences during the specified period.
      - `withdrawal_sum` number — The overall amount withdrawn during the specified period.
      - `withdrawal_count` integer — The total count of withdrawals during the specified period.
      - `revenue` number — Total revenue of the business.
      - `negative_balances_weekday` unknown[] — Days in which the daily ending balance fell below zero.
        - unknown
      - `nsf_fee_sum` integer — The sum of all NSF fee amounts in the statement period.
      - `nsf_fee_count` integer — The number of NSF occurrences in the statement period.
      - `nsf_raw_fee_count` integer — The total NSF fee count (NOT including common divisor logic) in statement period.
      - `overdraft_fee_sum` integer — The sum of all overdraft fee amounts in the statement period.
      - `overdraft_fee_count` integer — The number of overdraft occurrences in the statement period.
      - `overdraft_raw_fee_count` integer — The total overdraft fee count (NOT including common divisor logic) in statement period.
      - `returned_item_deposit_count` integer — The total number of returned item credits.
      - `returned_item_withdrawal_count` integer — The total number of returned item debits.
      - `has_weekend_txn` boolean — Indicates if any transactions occured on a weekend.
      - `nsf_divisor` integer — The calculated amount for a single NSF fee.
      - `overdraft_divisor` integer — The calculated amount for a single overdraft fee.
      - `max_deposit` number, nullable — The highest single deposit amount recorded during the period.
      - `average_withdrawal` number, nullable — The average withdrawal amount across all withdrawals during the period. Returned as a negative value.
      - `max_withdrawal` number, nullable — The largest single withdrawal amount recorded during the period. Returned as a negative value.
      - `revenue_count` integer, nullable — The total number of transactions tagged as revenue during the period.
      - `revenue_deduction` number, nullable — The total amount deducted from gross revenue during the period based on the active revenue formula.
      - `expense` number, nullable — The total amount of transactions tagged as expenses during the period. Returned as a negative value.
      - `expense_count` integer, nullable — The total number of transactions tagged as expenses during the period.
      - `negative_balances` unknown[], nullable — A list of dates within the period on which the account balance was negative. Returns an empty array if no negative balances were recorded.
        - unknown
      - `nsf_days_count` integer, nullable — The number of days within the period on which a non-sufficient funds (NSF) event was recorded.
      - `overdraft_days_count` integer, nullable — The number of days within the period on which an overdraft event was recorded.
      - `nsf_or_overdraft_days_count` integer, nullable — The total number of days within the period on which either an NSF or overdraft event was recorded.
      - `large_deposits` number, nullable — The total amount of deposits considered large during the period, based on Ocrolus thresholds.
      - `reconciled` boolean, nullable — Whether the statement period reconciled successfully. `true` means the opening and closing balances match the transactions, and `false` means a discrepancy was detected.
      - `recon_error_absolute_amount` number, nullable — The dollar amount of the reconciliation discrepancy for the period. Returns null or 0 when the period reconciled or returns the discrepancy amount when it did not.
      - `recon_error_pct_of_average_daily_balance` number, nullable — The reconciliation discrepancy expressed as a percentage of the average daily balance. Helps you identify the relative size of the error. Returns null when the period reconciled or when average daily balance is unavailable.
      - `primary_recon_error_reason` string, nullable — The main reason the period did not reconcile, such as a balance mismatch or missing transactions. Returns null when the period reconciled.
      - `secondary_recon_error_reason` string, nullable — An additional reason contributing to the reconciliation failure, where available. Returns null when the period reconciled or when no secondary reason is identified.
      - `high_amount_average_daily_balance` boolean, nullable — Returns `true` if the average daily balance for this period is unusually high compared to typical activity. May indicate large deposits or infrequent withdrawals.
      - `balance_ending_with_zero` boolean, nullable — Returns `true` if the account balance reached zero at the end of this period. May indicate the account was fully drawn down.
      - `high_txns_count_atm_over_cash` boolean, nullable — Returns `true` if the number of ATM transactions is disproportionately high relative to cash transactions during this period.
      - `has_weekend_transactions` boolean, nullable — Returns `true` if any transactions occurred on weekends during this period. Useful for identifying business type and activity patterns.
      - `no_txn_in_weekdays_within_period` boolean, nullable — Returns `true` if no transactions were recorded on weekdays during this period. May indicate account inactivity or an unusual cash flow pattern.
      - `high_txns_amount_atm_over_cash` boolean, nullable — Returns `true` if the total amount of ATM transactions is disproportionately high relative to cash transactions during this period.
  - `number_of_docs_in_book` integer — The total count of <<glossary:Document>>s uploaded to this <<glossary:Book>>.
  - `number_of_docs_processed` integer — The total count of <<glossary:Document>>s in this <<glossary:Book>> that completed verification.
  - `uploaded_docs` object[] — An array of objects containing information on the <<glossary:Document>>s uploaded to this <<glossary:Book>>.
    - `pk` integer — Unique personal key for the <<glossary:Document>>.
    - `uuid` string — Universal unique identifier for the <<glossary:Document>>.
    - `status` string — Processing status of the <<glossary:Document>>.
    - `pages` integer — The total number of pages present in the <<glossary:Document>>.
    - `mixed_uploaded_doc_pk` integer — Unique personal key for the uploaded Mixed Document associated with this Document. A Mixed Document is a single or multipage PDF that contains more than one doc type.
    - `mixed_uploaded_doc_uuid` string — Universal unique identifier for the uploaded Mixed Document associated with this Document. A Mixed Document is a single or multipage PDF that contains more than one doc type.
    - `rejection_reason` string — An optional attribute that briefly explains why a Document was rejected.
  - `book_uuid` integer — A unique numerical identifier for a <<glossary:Book>>, commonly referred to as the Book UUID.

## Other responses

- `202` — Accepted
- `400` — Txn Limit Exceeded
- `403` — Permission Error
- `404` — Data Not Found Error
- `422` — Book Contains More Than 100k Transactions
- `425` — Analytics Still Processing

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)