v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Cash Flow Analytics

Bank statement income calculator

This API retrieves the bank statement income calculator output in JSON format. You can also access this through the Dashboard. To learn more, see Bank Statement Income Calculator.

get/v2/book/{book_uuid}/income/bank-statement-v2

Path parameters

book_uuidstring uuid required

The unique identifier of the <glossary:Book> that contains the bank statements you'd like to have analyzed.

Response

Success

book_uuidstring uuid

Unique identifier for the book.

calculated_atstring date-time

Timestamp indicating when the income calculation was performed.

Example response

{
  "book_uuid": "ef199503-ef03-4fc1-a05f-2ad14416821d",
  "calculated_at": "2026-06-30T06:22:04.791742-04:00",
  "bank_statement_income": [
    {
      "account": {
        "pk": 435388,
        "account_number": "381007628285",
        "holder_name": "ZOHEB SAIT"
      },
      "deposits": [
        {
          "pk": 2255891820,
          "date": "2017-03-24",
          "description": "INTEREST EARNED",
          "amount": 0.01,
          "page_doc_pk": 18034747,
          "period_pk": 1034191,
          "period_uuid": "12d358a4-dac9-4f11-ade4-09d03ed23e79",
          "exclude": true
        }
      ],
      "calculations": {
        "statement_summary": [
          {
            "begin_date": "2017-03-01",
            "end_date": "2017-03-24",
            "beginning_balance": 1354.81,
            "ending_balance": 1379.82,
            "statement_status": true
          }
        ],
        "large_deposit_summary": {
          "average_deposit": 12.51,
          "percentage_amount": 50,
          "deposit_threshold": 18.76,
          "threshold_base": "AVERAGE_DEPOSIT",
          "large_deposit_count": 3,
          "large_deposit_amount": 75,
          "large_deposit_txn_pks": [
            2255891823,
            2255891822,
            2255891821
          ]
        },
        "total_deposit_summary": {
          "deposits": 75.03,
          "excluded_deposits": 75.03
        },
        "total_included_months": 4
      },
      "recurring_transactions": [
        {
          "pk": 2255891823,
          "date": "2017-03-01",
          "description": "ONLINE SCHEDULED TRANSFER FROM CHK 4172 CONFIRMATION",
          "amount": 25
        }
      ]
    }
  ]
}