Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Business history

Business summary

This API retrieves the chronological financial summary for a business entity, calculated from deduplicated and organization-enriched transactions across all <glossary:Book> belonging to the requesting organization.

get/v1/businesses/{business_id}/summary

Path parameters

business_idstring uuid required
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

A universally unique identifier (UUID) of the business entity for which you want to retrieve summary.

Query parameters

begin_datestring date
Example:2023-01-01

The start date in YYYY-MM-DD format for the financial summary period.

end_datestring date
Example:2023-10-01

The end date in YYYY-MM-DD format for the financial summary period.

updated_sincestring date
Example:2023-10-01

The date from which to retrieve updated business summaries.

Response

Success

idstring uuid

Unique identifier of the business entity.

namestring

Name of the business entity.

naics4_codestring

A 4-digit North American Industry Classification System (NAICS) code that represents the industry of the business.

naics_descriptionstring

The description of the 4-digit NAICS code, indicating the industry classification of the business category.

naics6_codestring

6-digit NAICS code for the business industry classification.

book_countinteger

Total number of Books associated with the business.

txn_countinteger

Total number of deduplicated transactions for the business.

daily_balancesobject

Daily balances keyed by date in YYYY-MM-DD format.

daily_cash_flowsobject

Daily cash flows keyed by date in YYYY-MM-DD format.

average_daily_balancestring

Average daily balance across the period.

average_daily_cash_flowstring

Average daily cash flow across the period.

average_daily_balance_weekdaystring

Average daily balance on weekdays across the period.

total_daysinteger

Total number of days in the period.

net_cash_flows_by_monthobject

Net cash flows keyed by month in YYYY-MM format.

minimum_balance_by_monthobject

Minimum balances keyed by month in YYYY-MM format.

maximum_balance_by_monthobject

Maximum balances keyed by month in YYYY-MM format.

average_daily_balance_by_monthobject

Average daily balances keyed by month in YYYY-MM format.

average_daily_balance_weekday_by_monthobject

Average daily balances on weekdays keyed by month in YYYY-MM format.

negative_balances_by_monthobject

Dates of negative balances keyed by month in YYYY-MM format.

negative_balances_count_by_monthobject

Count of negative balances grouped by month in YYYY-MM format.

negative_balances_weekday_by_monthobject

Dates of negative balances on weekdays keyed by month in YYYY-MM format.

negative_balances_weekday_count_by_monthobject

Count of negative balances on weekdays keyed by month in YYYY-MM format.

nsf_fee_count_by_monthobject

Count of NSF fees keyed by month in YYYY-MM format.

nsf_raw_fee_count_by_monthobject

Count of raw NSF fees keyed by month in YYYY-MM format.

overdraft_fee_count_by_monthobject

Count of overdraft fees keyed by month in YYYY-MM format.

overdraft_raw_fee_count_by_monthobject

Count of raw (pre-dedup) overdraft fees keyed by month in YYYY-MM format.

returned_item_deposit_count_by_monthobject

Count of returned item deposits keyed by month in YYYY-MM format.

returned_item_withdrawal_count_by_monthobject

Count of returned item withdrawals keyed by month in YYYY-MM format.

average_txn_size_by_monthobject

Average transaction size keyed by month in YYYY-MM format.

average_deposits_by_monthobject

Average deposits keyed by month in YYYY-MM format.

fintech_mca_sourcesobject[]

List of identified Merchant Cash Advance (MCA) providers with deposit/payment breakdowns.

num_fintech_loan_sourcesinteger

Number of identified fintech loan providers.

num_fintech_mca_sourcesinteger

Number of identified MCA providers.

naics6_descriptionstring

The description of the 6-digit NAICS code, indicating the specific industry classification of the business.

mcc_codestring

Merchant Category Code (MCC) that classifies the business by the type of goods or services offered.

mcc_descriptionstring

Description of the Merchant Category Code.

sic_codestring

Standard Industrial Classification (SIC) code for the business.

sic_descriptionstring

Description of the Standard Industrial Classification code.

active_overrideboolean

Indicates whether an active override has been applied to the business entity.

expense_by_monthobject

Expense amounts grouped by month in YYYY-MM format.

withdrawals_by_monthobject

Withdrawal amounts grouped by month in YYYY-MM format.

revenue_by_monthobject

Revenue amounts grouped by month in YYYY-MM format.

revenue_deduction_by_monthobject

Revenue deduction amounts grouped by month in YYYY-MM format.

deposits_by_monthobject

Deposit amounts grouped by month in YYYY-MM format.

outside_source_deposits_by_monthobject

Deposits from outside sources grouped by month in YYYY-MM format.

large_deposits_by_monthobject

Large deposits grouped by month in YYYY-MM format.

debt_consolidator_inflows_by_monthobject

Debt consolidator inflows grouped by month in YYYY-MM format.

debt_consolidator_outflows_by_monthobject

Debt consolidator outflows grouped by month in YYYY-MM format.

factoring_inflows_by_monthobject

Factoring inflows grouped by month in YYYY-MM format.

factoring_outflows_by_monthobject

Factoring outflows grouped by month in YYYY-MM format.

payroll_inflows_by_monthobject

Payroll inflows grouped by month in YYYY-MM format.

payroll_outflows_by_monthobject

Payroll outflows grouped by month in YYYY-MM format.

insurance_inflows_by_monthobject

Insurance inflows grouped by month in YYYY-MM format.

insurance_outflows_by_monthobject

Insurance outflows grouped by month in YYYY-MM format.

venmo_zelle_cashapp_inflows_by_monthobject

Venmo, Zelle, and Cash App inflows grouped by month in YYYY-MM format.

venmo_zelle_cashapp_outflows_by_monthobject

Venmo, Zelle, and Cash App outflows grouped by month in YYYY-MM format.

atm_inflows_by_monthobject

ATM inflows grouped by month in YYYY-MM format.

atm_outflows_by_monthobject

ATM outflows grouped by month in YYYY-MM format.

tolls_inflows_by_monthobject

Tolls inflows grouped by month in YYYY-MM format.

tolls_outflows_by_monthobject

Tolls outflows grouped by month in YYYY-MM format.

paypal_inflows_by_monthobject

PayPal inflows grouped by month in YYYY-MM format.

paypal_outflows_by_monthobject

PayPal outflows grouped by month in YYYY-MM format.

equipment_lease_inflows_by_monthobject

Equipment lease inflows grouped by month in YYYY-MM format.

equipment_lease_outflows_by_monthobject

Equipment lease outflows grouped by month in YYYY-MM format.

checks_inflows_by_monthobject

Check inflows grouped by month in YYYY-MM format.

checks_outflows_by_monthobject

Check outflows grouped by month in YYYY-MM format.

txn_four_zeros_inflows_by_monthobject

Transactions with four zeros inflows grouped by month in YYYY-MM format.

txn_four_zeros_outflows_by_monthobject

Transactions with four zeros outflows grouped by month in YYYY-MM format.

txn_five_zeros_inflows_by_monthobject

Transactions with five zeros inflows grouped by month in YYYY-MM format.

txn_five_zeros_outflows_by_monthobject

Transactions with five zeros outflows grouped by month in YYYY-MM format.

probable_recurring_txns_inflows_by_monthobject

Probable recurring transaction inflows grouped by month in YYYY-MM format.

probable_recurring_txns_outflows_by_monthobject

Probable recurring transaction outflows grouped by month in YYYY-MM format.

fintech_loan_inflows_by_monthobject

Fintech loan inflows grouped by month in YYYY-MM format.

fintech_loan_outflows_by_monthobject

Fintech loan outflows grouped by month in YYYY-MM format.

bank_loan_inflows_by_monthobject

Bank loan inflows grouped by month in YYYY-MM format.

bank_loan_outflows_by_monthobject

Bank loan outflows grouped by month in YYYY-MM format.

other_loan_inflows_by_monthobject

Other loan inflows grouped by month in YYYY-MM format.

other_loan_outflows_by_monthobject

Other loan outflows grouped by month in YYYY-MM format.

fintech_mca_inflows_by_monthobject

Fintech MCA inflows grouped by month in YYYY-MM format.

fintech_mca_outflows_by_monthobject

Fintech MCA outflows grouped by month in YYYY-MM format.

bank_cash_advance_inflows_by_monthobject

Bank cash advance inflows grouped by month in YYYY-MM format.

bank_cash_advance_outflows_by_monthobject

Bank cash advance outflows grouped by month in YYYY-MM format.

debit_card_inflows_by_monthobject

Debit card inflows grouped by month in YYYY-MM format.

debit_card_outflows_by_monthobject

Debit card outflows grouped by month in YYYY-MM format.

credit_card_inflows_by_monthobject

Credit card inflows grouped by month in YYYY-MM format.

credit_card_outflows_by_monthobject

Credit card outflows grouped by month in YYYY-MM format.

merchant_service_inflows_by_monthobject

Merchant service inflows grouped by month in YYYY-MM format.

merchant_service_outflows_by_monthobject

Merchant service outflows grouped by month in YYYY-MM format.

sba_inflows_by_monthobject

SBA inflows grouped by month in YYYY-MM format.

sba_outflows_by_monthobject

SBA outflows grouped by month in YYYY-MM format.

remote_inflows_by_monthobject

Remote inflows grouped by month in YYYY-MM format.

remote_outflows_by_monthobject

Remote outflows grouped by month in YYYY-MM format.

benefits_inflows_by_monthobject

Benefits inflows grouped by month in YYYY-MM format.

benefits_outflows_by_monthobject

Benefits outflows grouped by month in YYYY-MM format.

card_rewards_inflows_by_monthobject

Card rewards inflows grouped by month in YYYY-MM format.

card_rewards_outflows_by_monthobject

Card rewards outflows grouped by month in YYYY-MM format.

crypto_inflows_by_monthobject

Crypto inflows grouped by month in YYYY-MM format.

crypto_outflows_by_monthobject

Crypto outflows grouped by month in YYYY-MM format.

gambling_inflows_by_monthobject

Gambling inflows grouped by month in YYYY-MM format.

gambling_outflows_by_monthobject

Gambling outflows grouped by month in YYYY-MM format.

investment_inflows_by_monthobject

Investment inflows grouped by month in YYYY-MM format.

investment_outflows_by_monthobject

Investment outflows grouped by month in YYYY-MM format.

reversed_inflows_by_monthobject

Reversed inflows grouped by month in YYYY-MM format.

reversed_outflows_by_monthobject

Reversed outflows grouped by month in YYYY-MM format.

state_tax_inflows_by_monthobject

State tax inflows grouped by month in YYYY-MM format.

state_tax_outflows_by_monthobject

State tax outflows grouped by month in YYYY-MM format.

payroll_tax_inflows_by_monthobject

Payroll tax inflows grouped by month in YYYY-MM format.

payroll_tax_outflows_by_monthobject

Payroll tax outflows grouped by month in YYYY-MM format.

internal_transfer_inflows_by_monthobject

Internal transfer inflows grouped by month in YYYY-MM format.

internal_transfer_outflows_by_monthobject

Internal transfer outflows grouped by month in YYYY-MM format.

merchant_service_transfer_inflows_by_monthobject

Merchant service transfer inflows grouped by month in YYYY-MM format.

merchant_service_transfer_outflows_by_monthobject

Merchant service transfer outflows grouped by month in YYYY-MM format.

wire_transfer_inflows_by_monthobject

Wire transfer inflows grouped by month in YYYY-MM format.

wire_transfer_outflows_by_monthobject

Wire transfer outflows grouped by month in YYYY-MM format.

other_transfer_inflows_by_monthobject

Other transfer inflows grouped by month in YYYY-MM format.

other_transfer_outflows_by_monthobject

Other transfer outflows grouped by month in YYYY-MM format.

truck_stop_inflows_by_monthobject

Monthly truck stop inflows.

truck_stop_outflows_by_monthobject

Monthly truck stop outflows.

federal_tax_inflows_by_monthobject

Monthly federal tax inflows.

federal_tax_outflows_by_monthobject

Monthly federal tax outflows.

bank_branch_inflows_by_monthobject

Monthly bank branch inflows.

bank_branch_outflows_by_monthobject

Monthly bank branch outflows.

credit_builder_inflows_by_monthobject

Monthly credit builder inflows.

credit_builder_outflows_by_monthobject

Monthly credit builder outflows.

custom_tag_by_monthobject

Monthly values for this custom tag category.

expense_count_by_monthobject

Monthly expense transaction counts.

withdrawals_count_by_monthobject

Monthly withdrawal transaction counts.

revenue_count_by_monthobject

Monthly revenue transaction counts.

deposits_count_by_monthobject

Monthly deposit transaction counts.

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Acme Corp",
  "naics4_code": "5411",
  "naics_description": "Legal Services",
  "naics6_code": "541110",
  "books": [
    {
      "uuid": "book-uuid-1",
      "name": "Q1 2025 Application",
      "created_ts": "2025-01-10T08:00:00Z",
      "uploaded_docs": [
        {
          "uuid": "doc-uuid-1",
          "name": "jan_statement.pdf",
          "status": "VERIFIED"
        }
      ]
    }
  ],
  "book_count": 3,
  "txn_count": 5234,
  "bank_accounts": [
    {
      "bank_account_pks": [
        42,
        87,
        153
      ],
      "txn_count": 3200,
      "bank_name": "Chase",
      "account_type": "CHECKING",
      "account_number": "****1234",
      "account_holder_name": "ACME CORP",
      "account_category": "BUSINESS",
      "holder_address_1": "123 MAIN STREET",
      "holder_address_2": "APT 4B",
      "holder_city": "NEW YORK",
      "holder_state": "NY",
      "holder_zip": "10001",
      "daily_balances": {
        "2025-01-01": 15000.5
      },
      "periods": [
        {
          "begin_date": "2016-01-01",
          "end_date": "2016-01-29",
          "begin_balance": 1614,
          "end_balance": -783
        }
      ],
      "expense_by_month": {
        "2025-01": -14404.21,
        "2025-02": -38898.7
      },
      "withdrawals_by_month": {
        "2025-01": -14404.21,
        "2025-02": -38898.7
      },
      "revenue_by_month": {
        "2025-01": 11116.01,
        "2025-02": 23734.38
      },
      "revenue_deduction_by_month": {
        "2025-01": 478.67,
        "2025-02": 22631.99
      },
      "deposits_by_month": {
        "2025-01": 11594.68,
        "2025-02": 46366.37
      },
      "outside_source_deposits_by_month": {
        "2025-01": 5000
      },
      "large_deposits_by_month": {
        "2025-01": 25000
      }
    }
  ],
  "daily_balances": {
    "2025-01-01": 15000.5,
    "2025-01-02": 14850.25
  },
  "daily_cash_flows": {
    "2025-01-01": -150.25,
    "2025-01-02": 500
  },
  "total_days": 365,
  "net_cash_flows_by_month": {
    "2025-01": 3200,
    "2025-02": -1500
  },
  "minimum_balance_by_month": {
    "2025-01": 8000,
    "2025-02": 6500
  },
  "maximum_balance_by_month": {
    "2025-01": 22000,
    "2025-02": 19000
  },
  "average_daily_balance_by_month": {
    "2025-01": 14000,
    "2025-02": 12000
  },
  "average_daily_balance_weekday_by_month": {
    "2025-01": 14200,
    "2025-02": 12300
  },
  "negative_balances_by_month": {
    "2025-03": [
      "2025-03-15",
      "2025-03-16"
    ]
  },
  "negative_balances_count_by_month": {
    "2025-03": 2
  },
  "negative_balances_weekday_by_month": {
    "2025-03": [
      "2025-03-15"
    ]
  },
  "negative_balances_weekday_count_by_month": {
    "2025-03": 1
  },
  "nsf_fee_count_by_month": {
    "2025-03": 1
  },
  "nsf_raw_fee_count_by_month": {
    "2025-03": 1
  },
  "overdraft_fee_count_by_month": {
    "2025-01": 0
  },
  "overdraft_raw_fee_count_by_month": {
    "2025-01": 0
  },
  "returned_item_deposit_count_by_month": {
    "2025-01": 0
  },
  "returned_item_withdrawal_count_by_month": {
    "2025-01": 0
  },
  "average_txn_size_by_month": {
    "2025-01": 450
  },
  "average_deposits_by_month": {
    "2025-01": 2500
  },
  "fintech_loan_sources": [
    {
      "source": "Kabbage",
      "deposit_count": 2,
      "deposits": {
        "2025-01": 25000,
        "2025-04": 25000
      },
      "pmt_count": 12,
      "pmt_frequency_days": 30,
      "pmts": {
        "2025-02": 2000
      }
    }
  ],
  "num_fintech_loan_sources": 1,
  "counterparties": [
    {
      "category": "revenue",
      "distribution": [
        {
          "counterparty": "BigCorp Inc",
          "rank": 1
        }
      ],
      "num_counterparties": 10
    }
  ],
  "cash_flow_at_a_glance": {
    "average_deposit_count": 45,
    "total_nsf_fee_count": 3
  },
  "naics6_description": "Dry Pea and Bean Farming",
  "mcc_code": "1520",
  "mcc_description": "General Contractors-Residential and Commercial",
  "sic_code": "2095",
  "sic_description": "ROASTED COFFEE",
  "expense_by_month": {
    "2016-01": 0
  },
  "withdrawals_by_month": {
    "2025-01": -14404.21,
    "2025-02": -38898.7
  },
  "revenue_by_month": {
    "2025-01": 11116.01,
    "2025-02": 23734.38
  },
  "revenue_deduction_by_month": {
    "2025-01": 478.67,
    "2025-02": 22631.99
  },
  "deposits_by_month": {
    "2025-01": 11594.68,
    "2025-02": 46366.37
  },
  "outside_source_deposits_by_month": {
    "2025-01": 5000
  },
  "large_deposits_by_month": {
    "2025-01": 25000
  },
  "truck_stop_inflows_by_month": {
    "2016-01": "0.0"
  },
  "truck_stop_outflows_by_month": {
    "2016-01": "0.0"
  },
  "federal_tax_inflows_by_month": {
    "2016-01": "0.0"
  },
  "federal_tax_outflows_by_month": {
    "2016-01": "0.0"
  },
  "bank_branch_inflows_by_month": {
    "2019-06": "0.13"
  },
  "bank_branch_outflows_by_month": {
    "2016-01": "0.0"
  },
  "credit_builder_inflows_by_month": {
    "2016-01": "0.0"
  },
  "credit_builder_outflows_by_month": {
    "2019-06": "-29.04"
  },
  "custom_tag_by_month": {
    "2016-01": "0.0"
  },
  "expense_count_by_month": {
    "2019-07": "61"
  },
  "withdrawals_count_by_month": {
    "2019-07": "61"
  },
  "revenue_count_by_month": {
    "2019-07": "20"
  },
  "deposits_count_by_month": {
    "2019-07": "22"
  }
}