--- title: "Book summary" method: GET path: "/v2/book/{book_uuid}/summary" tags: ["Cash Flow Analytics"] --- # Book summary `GET /v2/book/{book_uuid}/summary` ## Request - Base URL: `https://api.ocrolus.com` - URL: `https://api.ocrolus.com/v2/book/{book_uuid}/summary` - Auth: OAuth 2 - Client credentials - Token URL: `https://auth.ocrolus.com/oauth/token` 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 <> 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 <>, 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` string: 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 NAICS code was overridden by the lender. - `mcc_code` string: 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. > ❗️ > This field is deprecated. Always returns `999999` - `mcc_description` string: A human-readable description of the MCC that explains the merchant's primary business activity as defined by the card network. > ❗️ > This field is deprecated. - `sic_code` string: 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. > ❗️ > This field is deprecated. Always returns `999999` - `sic_description` string: A human-readable description of the SIC code that explains the merchant's primary business activity as defined by the legacy SIC system. > ❗️ > This field is deprecated. - `business_verification_data` object: Verification data for the business, including legal identifiers, alternate names, website, and associated people with their contact information. - `legal_name` string: The official registered legal name of the business entity. - `address` object: Account holder address associated with the business entity. - `address_line_1` string: Primary street address line of the account holder. - `address_line_2` string: Secondary street address line of the account holder, such as suite or apartment number. - `city` string: City of the account holder address. - `state` string: State or region of the holder address. - `zip` string: Postal or ZIP code of the account holder address. - `formation_type` string: The legal formation type of the business entity such as Limited Liability Company, Corporation, Sole Proprietorship. - `website` string, nullable: Website URL associated with the business. null when no website is available. - `people` object[]: List of key people associated with the business, including their names and titles. - `name` string: The name of the person. - `title` string: The title or position of the person in the business. - `loan_inquiries` object: Summary of loan applications made by the SMB entity, including application history and application velocity over various time windows. - `merchant_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: 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` 'LOW' | 'MEDIUM' | 'HIGH' | 'NO MISMATCHES FOUND': The severity of mismatches detected in the Book, such as discrepancies between uploaded documents and extracted data. > 📘 **This attribute is in beta. If you encounter any bug, please reach out to support@ocrolus.com.** - `daily_balances` object: Daily ending balances keyed by date. Each key is a date in YYYY-MM-DD format and the value is the ending balance for that date. - `daily_cash_flows` object: Daily cash flows keyed by date. Each key is a date in YYYY-MM-DD format and the value is the net cash flow for that date, calculated as the difference between total credits and total debits. - `average_daily_cash_flow` number: The average value in `daily_cash_flows`. - `net_cash_flows_by_month` object: The cash flows resulting from the difference between total credits and total debits, categorized by calendar month. Each key is a month in YYYY-MM format. - `minimum_balance_by_month` object: The minimum daily balance grouped by calendar month. Each key is a month in YYYY-MM format. - `maximum_balance_by_month` object: The maximum daily balance grouped by calendar month. Each key is a month in YYYY-MM format. - `average_daily_balance` number: The average amount in `daily_balances`. - `average_daily_balance_by_month` object: The average daily balance grouped by calendar month. Each key is a month in YYYY-MM format. - `average_daily_balance_weekday` number: The average daily balance on weekdays. - `average_daily_balance_weekday_by_month` object: The average daily balance on weekdays grouped by calendar month. Each key is a month in YYYY-MM format. - `total_days` integer: Total number of days for which analytics is calculated. - `negative_balances_by_month` object: Dates with negative ending balances grouped by calendar month. Each key is a month in YYYY-MM format and the value is an array of date strings in YYYY-MM-DD format. - `negative_balances_count_by_month` object: Count of negative ending balances grouped by calendar month. Each key is a month in YYYY-MM format. - `negative_balances_weekday_by_month` object: Dates with negative ending balances on weekdays grouped by calendar month. Each key is a month in YYYY-MM format and the value is an array of date strings in YYYY-MM-DD format. - `negative_balances_weekday_count_by_month` object: Count of weekdays with negative ending balances grouped by calendar month. Each key is a month in YYYY-MM format. - `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. Each key is the first day of the month in YYYY-MM-DD format. - `average_deposits_by_month` object: The average deposit size grouped by calendar month. Each key is a month in YYYY-MM format. - `expense_by_month` object: Expenses grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `withdrawals_by_month` object: Withdrawals grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `revenue_by_month` object: Revenue grouped by calendar month. Each key is a month in YYYY-MM format. - `revenue_deduction_by_month` object: Revenue deductions grouped by calendar month. Each key is a month in YYYY-MM format. - `deposits_by_month` object: Deposits grouped by calendar month. Each key is a month in YYYY-MM format. - `outside_source_deposits_by_month` object: Outside source deposits grouped by calendar month. Each key is a month in YYYY-MM format. - `large_deposits_by_month` object: Total amount of large deposits grouped by calendar month. Each key is a month in YYYY-MM format. - `debt_consolidator_inflows_by_month` object: Debt consolidator inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `debt_consolidator_outflows_by_month` object: Debt consolidator outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `factoring_inflows_by_month` object: Factoring inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `factoring_outflows_by_month` object: Factoring outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_inflows_by_month` object: Payroll inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_outflows_by_month` object: Payroll outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `insurance_inflows_by_month` object: Insurance inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `insurance_outflows_by_month` object: Insurance outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `venmo_zelle_cashapp_inflows_by_month` object: Venmo/Zelle/Cash App inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `venmo_zelle_cashapp_outflows_by_month` object: Venmo/Zelle/Cash App outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `atm_inflows_by_month` object: Automated teller machine (ATM) inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `atm_outflows_by_month` object: Automated teller machine (ATM) outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `tolls_inflows_by_month` object: Toll inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `tolls_outflows_by_month` object: Toll outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `paypal_inflows_by_month` object: PayPal inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `paypal_outflows_by_month` object: PayPal outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `equipment_lease_inflows_by_month` object: Equipment lease inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `equipment_lease_outflows_by_month` object: Equipment lease outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `checks_inflows_by_month` object: Check inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `checks_outflows_by_month` object: Check outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_four_zeros_inflows_by_month` object: Transactions with four zeros inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_four_zeros_outflows_by_month` object: Transactions with four zeros outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_five_zeros_inflows_by_month` object: Transactions with five zeros inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_five_zeros_outflows_by_month` object: Transactions with five zeros outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `probable_recurring_txns_inflows_by_month` object: Recurring transactions inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `probable_recurring_txns_outflows_by_month` object: Recurring transactions outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_loan_inflows_by_month` object: Fintech loan inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_loan_outflows_by_month` object: Fintech loan outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_loan_inflows_by_month` object: Bank loan inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_loan_outflows_by_month` object: Bank loan outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_loan_inflows_by_month` object: Other loan inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_loan_outflows_by_month` object: Other loan outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_mca_inflows_by_month` object: Fintech MCA (Merchant Cash Advance) inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_mca_outflows_by_month` object: Fintech MCA (Merchant Cash Advance) outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_cash_advance_inflows_by_month` object: Bank cash advance inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_cash_advance_outflows_by_month` object: Bank cash advance outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `debit_card_inflows_by_month` object: Debit card inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `debit_card_outflows_by_month` object: Debit card outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `credit_card_inflows_by_month` object: Credit card inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `credit_card_outflows_by_month` object: Credit card outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_inflows_by_month` object: Merchant service inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_outflows_by_month` object: Merchant service outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `sba_inflows_by_month` object: SBA inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `sba_outflows_by_month` object: SBA outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `remote_inflows_by_month` object: Remote inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `remote_outflows_by_month` object: Remote outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `benefits_inflows_by_month` object: Benefit inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `benefits_outflows_by_month` object: Benefit outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `card_rewards_inflows_by_month` object: Card reward inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `card_rewards_outflows_by_month` object: Card reward outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `crypto_inflows_by_month` object: Crypto inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `crypto_outflows_by_month` object: Crypto outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `gambling_inflows_by_month` object: Gambling inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `gambling_outflows_by_month` object: Gambling outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `investment_inflows_by_month` object: Investment inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `investment_outflows_by_month` object: Investment outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `reversed_inflows_by_month` object: Reversed inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `reversed_outflows_by_month` object: Reversed outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `state_tax_inflows_by_month` object: State tax inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `state_tax_outflows_by_month` object: State tax outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_tax_inflows_by_month` object: Payroll tax inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_tax_outflows_by_month` object: Payroll tax outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `internal_transfer_inflows_by_month` object: Internal transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `internal_transfer_outflows_by_month` object: Internal transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_transfer_inflows_by_month` object: Merchant service transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_transfer_outflows_by_month` object: Merchant service transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `wire_transfer_inflows_by_month` object: Wire transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `wire_transfer_outflows_by_month` object: Wire transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_transfer_inflows_by_month` object: Other transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_transfer_outflows_by_month` object: Other transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `truck_stop_inflows_by_month` object: Truck stop inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `truck_stop_outflows_by_month` object: Truck stop outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `federal_tax_inflows_by_month` object: Federal tax inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `federal_tax_outflows_by_month` object: Federal tax outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_branch_inflows_by_month` object: Bank branch inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_branch_outflows_by_month` object: Bank branch outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `credit_builder_inflows_by_month` object: Credit builder inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `credit_builder_outflows_by_month` object: Credit builder outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `expense_count_by_month` object: Expense counts grouped by calendar month. Each key is a month in YYYY-MM format. - `withdrawals_count_by_month` object: Withdrawal counts grouped by calendar month. Each key is a month in YYYY-MM format. - `revenue_count_by_month` object: Revenue counts grouped by calendar month. Each key is a month in YYYY-MM format. - `deposits_count_by_month` object: Deposit counts grouped by calendar month. Each key is a month in YYYY-MM format. - `nsf_fee_count_by_month` object: Non-sufficient funds (NSF) fees count grouped by calendar month. Each key is a month in YYYY-MM format. - `nsf_divisor` number, nullable: Calculated amount for a single NSF fee. The common divisor is defined as the least common multiple (in 0.50 increments) of amount values corresponding to transactions with nsf = True. This multiple must fall between 25 and 60 (inclusive) otherwise nsf_divisor = null and no scaling occurs. - `nsf_raw_fee_count_by_month` object: Non-sufficient funds (NSF) fee count (NOT including common divisor logic) grouped by calendar month. Each key is a month in YYYY-MM format. - `overdraft_fee_count_by_month` object: Overdraft fees count grouped by calendar month. Each key is a month in YYYY-MM format. - `overdraft_divisor` number, nullable: Calculated amount for a single overdraft fee. The common divisor is defined as the least common multiple (in 0.50 increments) of amount values corresponding to transactions with overdraft = True. This multiple must fall between 25 and 60 (inclusive) otherwise overdraft_divisor = null and no scaling occurs. - `overdraft_raw_fee_count_by_month` object: Overdraft fee count (NOT including common divisor logic) grouped by calendar month. Each key is a month in YYYY-MM format. - `returned_item_deposit_count_by_month` object: Returned item deposit count grouped by calendar month. Each key is a month in YYYY-MM format. - `returned_item_withdrawal_count_by_month` object: Returned item withdrawal count grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_loan_sources` object[]: An array summarizing fintech loan sources found in this Book. - `source` string: The name of the lender. - `deposit_sum` number: Total sum of all deposits from this fintech source. - `deposit_count` integer: The number of proceed events from the lender. - `deposits` object: Deposit amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the deposit amount for that date. - `pmt_sum` number: Total sum of all payments to this fintech source. Negative value. - `pmt_count` integer: The number of payment events to the lender. - `pmt_frequency_days` integer: Average number of calendar days between payments. Returns 0 when there are fewer than two payments. - `pmts` object: Payment amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the total payment amount for that date. Values are negative. Multiple payments on the same day are summed into one entry, so this object may have fewer keys than pmt_count. - `events` object[]: List of payment events associated with this fintech source. Can be empty even when payments exist. - `event_type` 'PAID IN FULL' | 'STOP PAYMENT' | 'REDUCED PAYMENT' | 'INCREASED PAYMENT' | 'PAYMENT FREQUENCY CHANGE': Type of payment event. Possible values: PAID IN FULL, STOP PAYMENT, REDUCED PAYMENT, INCREASED PAYMENT, PAYMENT FREQUENCY CHANGE. - `date` string: Date of the event in YYYY-MM-DD format. - `fintech_mca_sources` object[]: List of MCA (Merchant Cash Advance) fintech sources detected in this Book. - `source` string: Name of the MCA provider. - `deposit_sum` number: Total sum of all deposits from this MCA source. - `deposit_count` integer: Total number of deposits from this MCA source. - `deposits` object: Deposit amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the deposit amount for that date. - `pmt_sum` number: Total sum of all payments to this MCA source. Negative value. - `pmt_count` integer: Total number of payments to this MCA source. - `pmt_frequency_days` integer: Average number of calendar days between payments. Returns 0 when there are fewer than two payments. - `pmts` object: Payment amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the total payment amount for that date. Values are negative. Multiple payments on the same day are summed into one entry, so this object may have fewer keys than pmt_count. - `events` object[]: List of payment events associated with this MCA source. Can be empty even when payments exist. - `event_type` 'PAID IN FULL' | 'STOP PAYMENT' | 'REDUCED PAYMENT' | 'INCREASED PAYMENT' | 'PAYMENT FREQUENCY CHANGE': Type of payment event. Possible values: PAID IN FULL, STOP PAYMENT, REDUCED PAYMENT, INCREASED PAYMENT, PAYMENT FREQUENCY CHANGE. - `date` string: Date of the event in YYYY-MM-DD format. - `num_fintech_loan_sources` integer: Number of unique fintech loan sources detected in this Book. - `num_fintech_mca_sources` integer: Number of unique fintech MCA sources detected in this Book. - `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` integer: 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_counterparty` number: The average monetary value of transactions per counterparty in the specified category. - `num_counterparties` integer: 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 payments found within this Book. - `debt_coverage_ratio` number, nullable: The overall debt coverage ratio of this Book. - `total_nsf_fee_count` integer: Count of all Non-sufficient funds (NSF) fees within this Book. - `total_nsf_or_overdraft_days_count` integer: Number of distinct calendar days across the Book with at least one NSF fee or overdraft fee. Each day counts once, no matter how many fees post that day. Use this field for a Book-wide total instead of summing the `period-level nsf_or_overdraft_days_count`, which can count a statement-boundary date in two periods. - `average_deposit_count` integer: Average number of deposits per month across all bank accounts in this Book. - `average_monthly_revenue` number: Average monthly revenue across the statement period. - `average_monthly_expense` number: Average monthly expense across the statement period. - `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 as CHECKING or SAVINGS. - `account_number` string: 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 objects. - `bank_account_pk` integer: Unique integer identifier for the bank account. - `bank_account_name` string: The name of the bank account used to calculate analytics. - `bank_name` string: The name of the 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 at bank account level. - `daily_balances` object: Daily ending balances keyed by date. Each key is a date in YYYY-MM-DD format and the value is the ending balance for that date. - `daily_cash_flows` object: Daily cash flows keyed by date. Each key is a date in YYYY-MM-DD format and the value is the net cash flow for that date, calculated as the difference between total credits and total debits. - `average_daily_cash_flow` number: The average value in `daily_cash_flows`. - `net_cash_flows_by_month` object: The cash flows resulting from the difference between total credits and total debits, categorized by calendar month. Each key is a month in YYYY-MM format. - `minimum_balance_by_month` object: The minimum daily balance grouped by calendar month. Each key is a month in YYYY-MM format. - `maximum_balance_by_month` object: The maximum daily balance grouped by calendar month. Each key is a month in YYYY-MM format. - `average_daily_balance` number: The average amount in `daily_balances`. - `average_daily_balance_by_month` object: The average daily balance grouped by calendar month. Each key is a month in YYYY-MM format. - `average_daily_balance_weekday` number: The average daily balance on weekdays. - `average_daily_balance_weekday_by_month` object: The average daily balance on weekdays grouped by calendar month. Each key is a month in YYYY-MM format. - `total_days` integer: Total number of days for which analytics is calculated. - `negative_balances_by_month` object: Dates with negative ending balances grouped by calendar month. Each key is a month in YYYY-MM format and the value is an array of date strings in YYYY-MM-DD format. - `negative_balances_count_by_month` object: Count of negative ending balances grouped by calendar month. Each key is a month in YYYY-MM format. - `negative_balances_weekday_by_month` object: Dates with negative ending balances on weekdays grouped by calendar month. Each key is a month in YYYY-MM format and the value is an array of date strings in YYYY-MM-DD format. - `negative_balances_weekday_count_by_month` object: Count of weekdays with negative ending balances grouped by calendar month. Each key is a month in YYYY-MM format. - `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. Each key is the first day of the month in YYYY-MM-DD format. - `average_deposits_by_month` object: The average deposit size grouped by calendar month. Each key is a month in YYYY-MM format. - `large_deposits_by_month` object: Total amount of large deposits grouped by calendar month. Each key is a month in YYYY-MM format. - `expense_by_month` object: Expenses grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `withdrawals_by_month` object: Withdrawals grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `revenue_by_month` object: Revenue grouped by calendar month. Each key is a month in YYYY-MM format. - `revenue_deduction_by_month` object: Revenue deductions grouped by calendar month. Each key is a month in YYYY-MM format. - `deposits_by_month` object: Deposits grouped by calendar month. Each key is a month in YYYY-MM format. - `outside_source_deposits_by_month` object: Outside source deposits grouped by calendar month. Each key is a month in YYYY-MM format. - `debt_consolidator_inflows_by_month` object: Debt consolidator inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `debt_consolidator_outflows_by_month` object: Debt consolidator outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `factoring_inflows_by_month` object: Factoring inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `factoring_outflows_by_month` object: Factoring outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_inflows_by_month` object: Payroll inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_outflows_by_month` object: Payroll outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `insurance_inflows_by_month` object: Insurance inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `insurance_outflows_by_month` object: Insurance outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `venmo_zelle_cashapp_inflows_by_month` object: Venmo/Zelle/Cash App inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `venmo_zelle_cashapp_outflows_by_month` object: Venmo/Zelle/Cash App outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `atm_inflows_by_month` object: Automated teller machine (ATM) inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `atm_outflows_by_month` object: Automated teller machine (ATM) outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `tolls_inflows_by_month` object: Toll inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `tolls_outflows_by_month` object: Toll outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `paypal_inflows_by_month` object: PayPal inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `paypal_outflows_by_month` object: PayPal outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `equipment_lease_inflows_by_month` object: Equipment lease inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `equipment_lease_outflows_by_month` object: Equipment lease outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `checks_inflows_by_month` object: Check inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `checks_outflows_by_month` object: Check outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_four_zeros_inflows_by_month` object: Transactions with four zeros inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_four_zeros_outflows_by_month` object: Transactions with four zeros outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_five_zeros_inflows_by_month` object: Transactions with five zeros inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `txn_five_zeros_outflows_by_month` object: Transactions with five zeros outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `probable_recurring_txns_inflows_by_month` object: Recurring transactions inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `probable_recurring_txns_outflows_by_month` object: Recurring transactions outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_loan_inflows_by_month` object: Fintech loan inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_loan_outflows_by_month` object: Fintech loan outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_loan_inflows_by_month` object: Bank loan inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_loan_outflows_by_month` object: Bank loan outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_loan_inflows_by_month` object: Other loan inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_loan_outflows_by_month` object: Other loan outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_mca_inflows_by_month` object: Fintech MCA (Merchant Cash Advance) inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_mca_outflows_by_month` object: Fintech MCA (Merchant Cash Advance) outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_cash_advance_inflows_by_month` object: Bank cash advance inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_cash_advance_outflows_by_month` object: Bank cash advance outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `debit_card_inflows_by_month` object: Debit card inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `debit_card_outflows_by_month` object: Debit card outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `credit_card_inflows_by_month` object: Credit card inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `credit_card_outflows_by_month` object: Credit card outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_inflows_by_month` object: Merchant service inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_outflows_by_month` object: Merchant service outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `sba_inflows_by_month` object: SBA inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `sba_outflows_by_month` object: SBA outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `remote_inflows_by_month` object: Remote inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `remote_outflows_by_month` object: Remote outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `benefits_inflows_by_month` object: Benefit inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `benefits_outflows_by_month` object: Benefit outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `card_rewards_inflows_by_month` object: Card reward inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `card_rewards_outflows_by_month` object: Card reward outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `crypto_inflows_by_month` object: Crypto inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `crypto_outflows_by_month` object: Crypto outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `gambling_inflows_by_month` object: Gambling inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `gambling_outflows_by_month` object: Gambling outflows grouped by calendar month. Each key is a month in YYYY-MM format. Values are negative. - `investment_inflows_by_month` object: Investment inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `investment_outflows_by_month` object: Investment outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `reversed_inflows_by_month` object: Reversed inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `reversed_outflows_by_month` object: Reversed outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `state_tax_inflows_by_month` object: State tax inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `state_tax_outflows_by_month` object: State tax outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_tax_inflows_by_month` object: Payroll tax inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `payroll_tax_outflows_by_month` object: Payroll tax outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `internal_transfer_inflows_by_month` object: Internal transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `internal_transfer_outflows_by_month` object: Internal transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_transfer_inflows_by_month` object: Merchant service transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `merchant_service_transfer_outflows_by_month` object: Merchant service transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `wire_transfer_inflows_by_month` object: Wire transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `wire_transfer_outflows_by_month` object: Wire transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_transfer_inflows_by_month` object: Other transfer inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `other_transfer_outflows_by_month` object: Other transfer outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `truck_stop_inflows_by_month` object: Truck stop inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `truck_stop_outflows_by_month` object: Truck stop outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `federal_tax_inflows_by_month` object: Federal tax inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `federal_tax_outflows_by_month` object: Federal tax outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_branch_inflows_by_month` object: Bank branch inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `bank_branch_outflows_by_month` object: Bank branch outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `credit_builder_inflows_by_month` object: Credit builder inflows grouped by calendar month. Each key is a month in YYYY-MM format. - `credit_builder_outflows_by_month` object: Credit builder outflows grouped by calendar month. Each key is a month in YYYY-MM format. - `rideshare_by_month` object: Rideshare transactions grouped by calendar month. Each key is a month in YYYY-MM format. - `expense_count_by_month` object: Expense counts grouped by calendar month. Each key is a month in YYYY-MM format. - `withdrawals_count_by_month` object: Withdrawal counts grouped by calendar month. Each key is a month in YYYY-MM format. - `revenue_count_by_month` object: Revenue counts grouped by calendar month. Each key is a month in YYYY-MM format. - `deposits_count_by_month` object: Deposit counts grouped by calendar month. Each key is a month in YYYY-MM format. - `nsf_fee_count_by_month` object: Non-sufficient funds (NSF) fees count grouped by calendar month. Each key is a month in YYYY-MM format. - `nsf_divisor` number, nullable: Calculated amount for a single NSF fee. The common divisor is defined as the least common multiple (in 0.50 increments) of amount values corresponding to transactions with nsf = True. This multiple must fall between 25 and 60 (inclusive) otherwise nsf_divisor = null and no scaling occurs. - `nsf_raw_fee_count_by_month` object: Non-sufficient funds (NSF) fee count (NOT including common divisor logic) grouped by calendar month. Each key is a month in YYYY-MM format. - `overdraft_fee_count_by_month` object: Overdraft fees count grouped by calendar month. Each key is a month in YYYY-MM format. - `overdraft_divisor` number, nullable: Calculated amount for a single overdraft fee. The common divisor is defined as the least common multiple (in 0.50 increments) of amount values corresponding to transactions with overdraft = True. This multiple must fall between 25 and 60 (inclusive) otherwise overdraft_divisor = null and no scaling occurs. - `overdraft_raw_fee_count_by_month` object: Overdraft fee count (NOT including common divisor logic) grouped by calendar month. Each key is a month in YYYY-MM format. - `returned_item_deposit_count_by_month` object: Returned item deposit count grouped by calendar month. Each key is a month in YYYY-MM format. - `returned_item_withdrawal_count_by_month` object: Returned item withdrawal count grouped by calendar month. Each key is a month in YYYY-MM format. - `nsf_paid_or_negative_balance_fee_count_by_month` object: Non-sufficient funds (NSF) fees paid or negative balance fee count grouped by calendar month. Each key is a month in YYYY-MM format. - `nsf_returned_or_not_paid_fee_count_by_month` object: Non-sufficient funds (NSF) fees returned or not paid fees count grouped by calendar month. Each key is a month in YYYY-MM format. - `fintech_loan_sources` object[]: An array summarizing fintech loan sources found in this bank account. - `source` string: The name of the lender. - `deposit_sum` number: Total sum of all deposits from this fintech source. - `deposit_count` integer: The number of proceed events from the lender. - `deposits` object: Deposit amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the deposit amount for that date. - `pmt_sum` number: Total sum of all payments to this fintech source. Negative value. - `pmt_count` integer: The number of payment events to the lender. - `pmt_frequency_days` integer: Average number of calendar days between payments. Returns 0 when there are fewer than two payments. - `pmts` object: Payment amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the total payment amount for that date. Values are negative. Multiple payments on the same day are summed into one entry, so this object may have fewer keys than pmt_count. - `events` object[]: List of payment events associated with this fintech source. Can be empty even when payments exist. - `event_type` 'PAID IN FULL' | 'STOP PAYMENT' | 'REDUCED PAYMENT' | 'INCREASED PAYMENT' | 'PAYMENT FREQUENCY CHANGE': Type of payment event. Possible values: PAID IN FULL, STOP PAYMENT, REDUCED PAYMENT, INCREASED PAYMENT, PAYMENT FREQUENCY CHANGE. - `date` string: Date of the event in YYYY-MM-DD format. - `fintech_mca_sources` object[]: List of MCA (Merchant Cash Advance) fintech sources detected in this bank account. - `source` string: Name of the MCA provider. - `deposit_sum` number: Total sum of all deposits from this MCA source. - `deposit_count` integer: Total number of deposits from this MCA source. - `deposits` object: Deposit amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the deposit amount for that date. - `pmt_sum` number: Total sum of all payments to this MCA source. Negative value. - `pmt_count` integer: Total number of payments to this MCA source. - `pmt_frequency_days` integer: Average number of calendar days between payments. Returns 0 when there are fewer than two payments. - `pmts` object: Payment amounts keyed by date. Each key is a date in YYYY-MM-DD format and the value is the total payment amount for that date. Values are negative. Multiple payments on the same day are summed into one entry, so this object may have fewer keys than pmt_count. - `events` object[]: List of payment events associated with this MCA source. Can be empty even when payments exist. - `event_type` 'PAID IN FULL' | 'STOP PAYMENT' | 'REDUCED PAYMENT' | 'INCREASED PAYMENT' | 'PAYMENT FREQUENCY CHANGE': Type of payment event. Possible values: PAID IN FULL, STOP PAYMENT, REDUCED PAYMENT, INCREASED PAYMENT, PAYMENT FREQUENCY CHANGE. - `date` string: Date of the event in YYYY-MM-DD format. - `num_fintech_loan_sources` integer: Number of unique fintech loan sources detected in this bank account. - `num_fintech_mca_sources` integer: Number of unique fintech MCA sources detected in this bank account. - `active_dates` object[]: Date ranges during which this bank account had active transactions. - `start` string: Start date of the active period in YYYY-MM-DD format. - `end` string: End date of the active period in YYYY-MM-DD format. - `missing_dates` object[]: Date ranges within the bank account's active period that have no transaction data. - `start` string: Start date of the missing period in YYYY-MM-DD format. - `end` string: End date of the missing period in YYYY-MM-DD format. - `cash_flow_at_a_glance` object: Summarized cash flow analytics for this bank account. - `total_revenue` number: Sum total of all revenue found within this bank account. - `total_expense` number: Sum total of all expenses found within this bank account. - `total_loan_proceeds` number: Sum total of all loan proceeds found within this bank account. - `total_loan_payments` number: Sum total of all loan payments found within this bank account. - `debt_coverage_ratio` number, nullable: The overall debt coverage ratio for this bank account. - `total_nsf_fee_count` integer: Count of all Non-sufficient funds (NSF) fees within this bank account. - `periods` object[]: A list of statement periods covered by this bank account. 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 included in the analytics calculation for this period. - `uploaded_doc_pk` integer: The unique identifier of the document from which this period was captured. - `missing_period_data` boolean: Indicates whether any transaction data is missing for this period. - `average_amount` number: The mean absolute amount of transactions within this statement period. - `average_daily_balance` number: The average daily ending balance including weekends. - `average_daily_balance_weekday` number: The average daily ending balance on weekdays only. - `average_daily_cash_flow` number: The mean daily net cash flow, calculated as the difference between total credits and total debits. - `average_deposit` number: The average amount of credit transactions. - `deposit_sum` number: The overall amount credited during this period. - `deposit_count` integer: The total number of deposit occurrences during this period. - `max_deposit` number, nullable: The highest single deposit amount recorded during this period. - `average_withdrawal` number, nullable: The average withdrawal amount across all withdrawals during this period. Returned as a negative value. - `withdrawal_sum` number: The overall amount withdrawn during this period. - `withdrawal_count` integer: The total count of withdrawals during this period. - `max_withdrawal` number, nullable: The largest single withdrawal amount recorded during this period. Returned as a negative value. - `revenue` number: Total revenue of the business during this period. - `revenue_count` integer, nullable: The total number of transactions tagged as revenue during this period. - `revenue_deduction` number, nullable: The total amount deducted from gross revenue during this period based on the active revenue formula. - `expense` number, nullable: The total amount of transactions tagged as expenses during this period. Returned as a negative value. - `expense_count` integer, nullable: The total number of transactions tagged as expenses during this period. - `negative_balances` string[], nullable: A list of dates within this period on which the account balance was negative. Returns an empty array if no negative balances were recorded. - `negative_balances_weekday` string[]: Days in this period on which the daily ending balance fell below zero on a weekday. - `nsf_days_count` integer, nullable: The number of days within this period on which a non-sufficient funds (NSF) event was recorded. - `nsf_fee_sum` number: The sum of all NSF fee amounts in this statement period. - `nsf_fee_count` integer: The number of NSF occurrences in this statement period. - `nsf_raw_fee_count` integer: The total NSF fee count (NOT including common divisor logic) in this statement period. - `overdraft_days_count` integer, nullable: The number of days within this period on which an overdraft event was recorded. - `overdraft_fee_sum` number: The sum of all overdraft fee amounts in this statement period. - `overdraft_fee_count` integer: The number of overdraft occurrences in this statement period. - `overdraft_raw_fee_count` integer: The total overdraft fee count (NOT including common divisor logic) in this statement period. - `nsf_or_overdraft_days_count` integer, nullable: The total number of days within this period on which either an NSF or overdraft event was recorded. - `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 occurred on a weekend. - `large_deposits` number, nullable: The total amount of deposits considered large during this period, based on Ocrolus thresholds. - `nsf_divisor` number, nullable: The calculated amount for a single NSF fee. - `overdraft_divisor` number, nullable: The calculated amount for a single overdraft fee. - `reconciled` boolean, nullable: Whether the statement period reconciled successfully. `true` means the opening and closing balances match the transactions; `false` means a discrepancy was detected. - `recon_error_absolute_amount` number, nullable: The dollar amount of the reconciliation discrepancy for this period. Returns null or 0 when the period reconciled, or 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. 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. - `balance_ending_with_zero` boolean, nullable: Returns `true` if the account balance reached zero at the end of this period. - `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. - `no_txn_in_weekdays_within_period` boolean, nullable: Returns `true` if no transactions were recorded on weekdays during this period. - `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 <>s uploaded to this <>. - `number_of_docs_processed` integer: The total count of <>s in this <> that completed verification. - `uploaded_docs` object[]: An array of objects containing information on the <>s uploaded to this <>. - `pk` integer: Unique primary key for the <>. - `uuid` string: Universally unique identifier for the <>. - `status` string: Processing status of the <>. - `pages` integer: The total number of pages present in the <>. - `mixed_uploaded_doc_pk` integer, nullable: Unique primary key for the uploaded Mixed Document associated with this <>. A Mixed Document is a single or multipage PDF that contains more than one doc type. - `mixed_uploaded_doc_uuid` string, nullable: Universally unique identifier for the uploaded Mixed Document associated with this <>. A Mixed Document is a single or multipage PDF that contains more than one doc type. - `rejection_reason` string, nullable: An optional attribute that briefly explains why a <> was rejected. Present only when status is REJECTED. - `book_uuid` string: Universally unique identifier (UUID) for the <>. ## Other responses - `202`: Accepted - `400`: Client Errors - `403`: Permission Error - `404`: Data Not Found Error - `422`: Book Contains More Than 100k Transactions - `425`: Analytics Still Processing --- [API](https://skmtc.dev/ocrolus/apis/analyze.md) - [All operations](https://skmtc.dev/ocrolus/apis/analyze/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/analyze/revisions/4ef40f224ab5?raw)