---
title: "Retrieves the collection of BankTransaction resources."
method: GET
path: "/bank_transactions"
tags: ["BankTransaction"]
---

# Retrieves the collection of BankTransaction resources.

`GET /bank_transactions`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/bank_transactions`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/bank_transactions/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of BankTransaction resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

BankTransaction collection

- BankTransaction[]
  - `id` string
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string: Unique identifier for each bank transaction
  - `contactId` string, nullable: ID of the associated contact
  - `contactName` string, nullable: Full name of contact
  - `date` string, nullable: Transaction date
  - `status` string, nullable: Status of bank transaction e.g. "RECEIVE" e.g. "RECEIVE-OVERPAYMENT"
  - `lineAmountTypes` string, nullable: The type of line amount e.g. "Exclusive" e.g. "Inclusive" e.g. "NoTax"
  - `lineItemDescription` string, nullable: A description of the line item
  - `lineItemUnitAmount` integer, nullable: Unit amount of line item
  - `lineItemTaxType` string, nullable: Type of tax applied to the line item e.g. "INPUT" e.g. "OUTPUT e.g. "GSTONIMPORTS"
  - `lineItemTaxAmount` integer, nullable: The amount taxed for the line item
  - `lineAmount` integer, nullable: The total of the line including discount
  - `lineItemAccountCode` string, nullable: Account code of line item
  - `lineItemQuantity` integer, nullable: Quantity of line item
  - `lineItemId` string, nullable: ID for the line item
  - `subtotal` integer, nullable: Total of bank transaction excluding taxes
  - `totalTax` integer, nullable: Total tax of bank transaction
  - `total` integer, nullable: Total of bank transaction
  - `modified` string, nullable: Date and time the bank transaction was last updated
  - `currencyCode` string, nullable: The currency the bank transaction has been raised in
  - `accountId` string, nullable: ID of the bank account
  - `bankAccountCode` string, nullable: Bank account code
  - `bankAccountName` string, nullable: Name of the bank account
  - `type` string, nullable: Transaction Type
  - `reference` string, nullable: Reference for the transaction
  - `isReconciled` boolean, nullable: Whether the transaction is reconciled
  - `fromAccountId` string, nullable: Account ID from which money will be transferred
  - `toAccountId` string, nullable: Account ID to which money will be transferred
  - `paymentMode` string, nullable: Mode of payment for the transaction
  - `customerId` string, nullable: ID of customer
  - `vendorId` string, nullable: ID of vendor
  - `created` string, date-time, nullable
  - `txnId` string, nullable: Transaction ID
  - `category` string, nullable
  - `merchant` string, nullable
  - `description` string, nullable

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)