v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Business history

Business transactions

This API retrieves the paginated, deduplicated enriched transactions across all of the requesting org's <glossary:Book>s for a given business. Transactions are structurally compatible with the existing book-level enriched transactions API.

👍 Tips start_date and end_date filter transactions based on when they occurred at the bank, while updated_since filters based on when transactions were ingested into the system. Use updated_since to retrieve newly added data, even if the transaction dates are earlier.

get/v1/businesses/{business_id}/transactions

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 transction details.

Query parameters

offsetinteger

Number of transactions to skip for pagination.

limitinteger

Maximum number of records to return per page, starting from the specified offset.

start_datestring date

Example:2023-01-01

Start date in YYYY-MM-DD format from which you want to filter transactions. The system includes only transactions with a txn_date on or after the specified date.

end_datestring date

Example:2023-12-31

End date in YYYY-MM-DD format from which you want to filter transactions. The system includes only transactions with a txn_date on or before the specified date.

updated_sincestring date-time

Example:2023-01-01T00:00:00Z

Timestamp (ISO 8601) for filtering transactions ingested into the system after this time. The system uses txn_created_ts to determine the ingestion time. Use this for incremental retrieval to fetch only newly ingested transactions since your last request.

Response

Success

idstring uuid

Unique identifier of the business entity for which transaction details are retrieved.

totalinteger

The total number of deduplicated transactions for this business retrieved based on the specified query parameteres.

filtered_totalinteger

The total number of transactions retrieved based on the provided start_date, end_date, and updated_since filters.

offsetinteger

The starting index for paginated transactions result.

limitinteger

The maximum number of transactions returned per page starting from the specified offset value.

Example response

{
  "id": "caaa57ba-8909-4a05-9dcc-e7cc057e3c48",
  "total": 50,
  "filtered_total": 50,
  "offset": 1,
  "limit": 50,
  "transactions": [
    {
      "description": "CHECKCARD 0109 LIBERTY PAPER SUPPLIES",
      "bank_account_pk": 123246,
      "uploaded_doc_name": "december_bank_statement",
      "amount": -50,
      "counterparty": "ACME Corp",
      "comment": "Payment for office supplies",
      "book_uuid": "book-uuid-456",
      "deposits": true,
      "withdrawals": true,
      "revenue": true,
      "nsf": true,
      "expense": true,
      "overdraft": true,
      "atm": true,
      "checks": true,
      "credit_card": true,
      "crypto": true,
      "debit_card": true,
      "debt_consolidator": true,
      "equipment_lease": true,
      "factoring": true,
      "federal_tax": true,
      "fintech_loan": true,
      "fintech_mca_source": true,
      "fintech": true,
      "gambling": true,
      "insurance": true,
      "internal_transfer": true,
      "investment": true,
      "large_deposits": true,
      "merchant_service_transfer": true,
      "merchant_service": true,
      "nsf_paid_or_negative_balance": true,
      "nsf_returned_or_not_paid": true,
      "other_loan": true,
      "other_transfer": true,
      "outside_source_deposits": true,
      "paypal": true,
      "payroll_tax": true,
      "payroll": true,
      "probable_recurring_txns": true,
      "remote": true,
      "returned_item": true,
      "revenue_deduction_other": true,
      "revenue_deduction": true,
      "reversed": true,
      "sba": true,
      "state_tax": true,
      "tolls": true,
      "truck_stop": true,
      "txn_five_zeros": true,
      "txn_four_zeros": true,
      "venmo_zelle_cashapp": true,
      "wire_transfer": true
    }
  ]
}