Book-Level Analytics

Overview

Model Name: BookAnalytics

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

Properties

alt_lender_payments_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Debits (i.e. payments) made to alternative lenders grouped by calendar month. Provides context into a customer's access to competitive financing as well as debt service requirements. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average absolute value of all transactions grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_daily_balance

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The average daily ending balance (including weekends).

average_daily_balance_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average daily ending balance (including weekends) grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_daily_balance_weekday

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

The average daily ending balance of weekdays.

average_daily_balance_weekday_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average daily ending balance of weekdays grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

average_deposit_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The average value of credit transactions grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

bank_accounts

Type
List of BankAccountAnalytics objects
Required
true
Min. Item Count
0

List of Bank Account Level JSONs

cash_expense_days_by_month

Type
Map of numbers
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Cash expense days grouped by month. Measures the amount of runway a business has given its operating expenses. Cash expense days = (average daily balance)/(average daily expense) Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

daily_balances

Type
Map of strings
Key Pattern
/^\d{2}/\d{2}/\d{4}$/
Required
true

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

daily_balances_by_month

Type
Map of objects
Required
true

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

daily_balances_weekday

Type
Map of strings
Key Pattern
/^\d{2}/\d{2}/\d{4}$/
Required
true

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

daily_balances_weekday_by_month

Type
Map of objects
Key Pattern
/^\d{2}/\d{4}$/
Required
true

A list of the daily ending balances for every weekday grouped by month.
Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).
Each value is an object with keys that are string representations of a date, using the regex ^\d{2}/\d{2}/\d{4}$ (i.e MM/DD/YYYY).

deposit_count

Type
Integer
Required
true
Min. Value
0

The total number of credit transactions.

deposit_sum

Type
String
Pattern
/^[+-]?\\d+(\\.\\d{1,2})?$/
Required
true

Sum of all credit transactions

estimated_daily_expense_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Estimated daily expenses grouped by month. Important for understanding the costs required to operate the business as well as the firm's ability to adapt spending during a period of disruption. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

estimated_expense_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Estimated monthly expenses grouped by calendar month. Important for understanding the costs required to operate the business as well as the firm's ability to adapt spending during a period of disruption. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

estimated_revenue_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The estimated revenue of the business grouped by calendar month. This is calculated by summing together all credit transactions, then removing all transfer credits (except for wire transfers), all alternative lender credits (except for factoring credits), and all transactions that contain words that signify that they are not revenue deposits. This includes words such as "Refund", "Reversal", "Cash Back", "Return", and about 20 others.
Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

mca_payments_by_month

Type
Map of strings
Key Pattern
/^\d{2}/\d{4}$/
Required
true

Debits (i.e. payments) made to merchant cash advance lenders, broken out by month. Provides context into a customer's access to competitive financing as well as debt service requirements. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY).

name

Type
String
Required
true
Min. Length
0

Name of the book or bank account

negative_balances_by_month

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The list of all days in which the daily ending balance fell below zero grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY). Months with no days ending with a negative balance are represented with empty arrays.

negative_balances_by_month_weekday

Type
Map of arrays
Key Pattern
/^\d{2}/\d{4}$/
Required
true

The list of all weekdays in which the daily ending balance fell below zero grouped by calendar month. Each key is a string representing a month and a year, using the regex ^\d{2}/\d{4}$ (i.e MM/YYYY). Months with no days ending with a negative balance are represented with empty arrays.

pk

Type
Integer (uint64)
Required
true

A unique identifying integer.