---
title: "Get bank accounts"
method: GET
path: "/bankaccounts"
tags: ["Bank Accounts"]
---

# Get bank accounts

`GET /bankaccounts`

Returns a list of bank accounts.

## Query parameters

- `type` string
- `matterId` string

## Response `200`

When request is successful. Returns a collection of 'BankAccount' objects.

- BankAccountCollection
  - `id` string, nullable
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `value` BankAccount[], nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
    - `self` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `id` string, nullable — Unique identifier of the bank account.
    - `type` string — The type of the bank account (Operating, Trust, Credit, ControlledMoney).
    - `status` 0 | 1
    - `matter` Link
      - `id` string, nullable
      - `href` string, nullable
      - `relation` string, nullable
      - `method` string, nullable
    - `accountType` integer — The type of the bank account (Operating = 0, Trust = 1, Credit = 2, ControlledMoney = 3). This field is deprecated and scheduled for removal - use the Type field instead.
    - `accountName` string, nullable — Account Name.
    - `accountNumber` string, nullable — Account Number.
    - `bankName` string, nullable — Bank Name.
    - `branchNumber` string, nullable — Branch Number.
    - `branchName` string, nullable — Branch Name.
    - `balance` number, double — Total balance of the bank account.
    - `contactBalances` BankAccountContactBalance[], nullable — List of contact balances. If balances are stored by matter, not by contact, then there can be a contact balance with no contact id. In this case, MatterBalances are used instead. Only supported in US.
      - `matter` Link
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
      - `contact` Link
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
      - `balance` number, double — The balance belonging for the specified matter contact.
      - `protectedBalance` number, double — The protected balance for the specified matter and contact.
      - `availableBalance` number, double — The available balance for the specified matter and contact. This value is calculated as the total balance minus the protected balance.
      - `lastUpdated` string, date-time, nullable — Date and time that the balance was last updated.
    - `matterBalances` BankAccountMatterBalance[], nullable — List of matter balances. A matter balance will be equal to the sum of all contact balances with the same MatterId.
      - `matter` Link
        - `id` string, nullable
        - `href` string, nullable
        - `relation` string, nullable
        - `method` string, nullable
      - `balance` number, double — The balance belonging for the specified matter.
      - `protectedBalance` number, double — The protected balance for the specified matter.
      - `availableBalance` number, double — The available balance for the specified matter. This value is calculated as the total balance minus the protected balance.
      - `unpresentedChequesBalance` number, double — Balance of the unpresented cheques for this matter. A cheque is considered unpresented if the related transaction has not been reconciled. If this balance is not zero, some actions on the matter are restricted (e.g. closing or cancelling the matter).
      - `lastUpdated` string, date-time, nullable — Date and time that the balance was last updated.

## Other responses

- `400` — When an unsupported request is made.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/versions/197984da9b42/schema)