These accounts are meant to mirror the firm’s accounts at their financial institution. Users can add a bank account to Clio to use with [Clio Payments](https://help.clio.com/hc/articles/9285631748507-Payments-and-Bank-Accounts), and for use as an audit and [reconciliation](https://help.clio.com/hc/en-us/articles/9290138047899) tool. [Support Link](https://help.clio.com/hc/articles/9285631748507-Payments-and-Bank-Accounts)
openapi: 3.0.0
info:
title: Clio API Documentation Activities Bank Accounts API
contact:
name: Clio API Support
email: api@clio.com
description: "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n **This is the default version**\n\n * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n"
version: v4
x-logo:
url: https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png
servers:
- url: https://app.clio.com/api/v4
description: US region Production Server
- url: https://eu.app.clio.com/api/v4
description: Europe region Production Server
- url: https://ca.app.clio.com/api/v4
description: Canada region Production Server
- url: https://au.app.clio.com/api/v4
description: Australia region Production Server
tags:
- name: Bank Accounts
description: 'These accounts are meant to mirror the firm’s accounts at their financial institution. Users can add a bank account to Clio to use with [Clio Payments](https://help.clio.com/hc/articles/9285631748507-Payments-and-Bank-Accounts), and for use as an audit and [reconciliation](https://help.clio.com/hc/en-us/articles/9290138047899) tool.
[Support Link](https://help.clio.com/hc/articles/9285631748507-Payments-and-Bank-Accounts)
'
paths:
/bank_accounts.json:
get:
tags:
- Bank Accounts
summary: Return the data for all BankAccounts
operationId: BankAccount#index
description: Outlines the parameters, optional and required, used when requesting the data for all BankAccounts
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: created_since
in: query
description: Filter BankAccount records to those having the `created_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: ids[]
in: query
description: Filter BankAccount records to those having the specified unique identifiers.
required: false
schema:
type: integer
format: int64
- name: limit
in: query
description: 'A limit on the number of BankAccount records to be returned. Limit can range between 1 and 200. Default: `200`.'
required: false
schema:
type: integer
format: int32
- name: order
in: query
description: 'Orders the BankAccount records by the given field. Default: `id(asc)`.'
required: false
schema:
type: string
enum:
- id(asc)
- id(desc)
- name(asc)
- name(desc)
- institution(asc)
- institution(desc)
- account_number(asc)
- account_number(desc)
- transit_number(asc)
- transit_number(desc)
- currency(asc)
- currency(desc)
- updated_at(asc)
- updated_at(desc)
- type(asc)
- type(desc)
- name: page_token
in: query
description: A token specifying which page to return.
required: false
schema:
type: string
- name: show_empty_accounts
in: query
description: Filter BankAccount records to those having a zero or non zero balance.
required: false
schema:
type: boolean
- name: status
in: query
description: Filter BankAccount records to those having a specific status.
required: false
schema:
type: string
enum:
- opened
- closed
- name: type
in: query
description: Filter BankAccount records to those having a specific type.
required: false
schema:
type: string
enum:
- OperatingAccount
- TrustAccount
- name: updated_since
in: query
description: Filter BankAccount records to those having the `updated_at` field after a specific time. (Expects an ISO-8601 timestamp).
required: false
schema:
type: string
format: date-time
- name: user_id
in: query
description: The unique identifier for a single User. Use the keyword `null` to match those without a BankAccount. The list will be filtered to include only the BankAccount records with the matching property.
required: false
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/BankAccount_List'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
post:
tags:
- Bank Accounts
summary: Create a new BankAccount
operationId: BankAccount#create
description: Outlines the parameters and data fields used when creating a new BankAccount
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
responses:
'201':
description: Created
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/BankAccount_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Bank Accounts
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
account_number:
type: string
description: 'Account number for the BankAccount.
When Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.
'
balance:
type: number
format: double
description: BankAccount balance.
client:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the client associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.
'
controlled_account:
type: boolean
description: 'Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).
When Compliant Trust Accounting is enabled, controlled bank accounts must be of type "Trust" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.
'
currency:
type: string
description: Currency the BankAccount is in.
default_account:
type: boolean
description: Whether or not the BankAccount should be the default account.
domicile_branch:
type: string
description: Branch where the BankAccount was opened.
general_ledger_number:
type: string
description: General ledger number used for the Law Society of Alberta.
holder:
type: string
description: BankAccount holder.
institution:
type: string
description: 'Financial institution (bank name).
When Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.
'
matter:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the matter associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.
'
name:
type: string
description: BankAccount name.
swift:
type: string
description: Identification code for the financial institution.
transit_number:
type: string
description: 'Transit number for the BankAccount branch.
When Compliant Trust Accounting is enabled, this field is required for operating accounts.
'
type:
type: string
enum:
- Operating
- Trust
description: Type of BankAccount.
required:
- currency
- type
application/x-www-form-urlencoded:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
account_number:
type: string
description: 'Account number for the BankAccount.
When Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.
'
balance:
type: number
format: double
description: BankAccount balance.
client:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the client associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.
'
controlled_account:
type: boolean
description: 'Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).
When Compliant Trust Accounting is enabled, controlled bank accounts must be of type "Trust" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.
'
currency:
type: string
description: Currency the BankAccount is in.
default_account:
type: boolean
description: Whether or not the BankAccount should be the default account.
domicile_branch:
type: string
description: Branch where the BankAccount was opened.
general_ledger_number:
type: string
description: General ledger number used for the Law Society of Alberta.
holder:
type: string
description: BankAccount holder.
institution:
type: string
description: 'Financial institution (bank name).
When Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.
'
matter:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the matter associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.
'
name:
type: string
description: BankAccount name.
swift:
type: string
description: Identification code for the financial institution.
transit_number:
type: string
description: 'Transit number for the BankAccount branch.
When Compliant Trust Accounting is enabled, this field is required for operating accounts.
'
type:
type: string
enum:
- Operating
- Trust
description: Type of BankAccount.
required:
- currency
- type
multipart/form-data:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
account_number:
type: string
description: 'Account number for the BankAccount.
When Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.
'
balance:
type: number
format: double
description: BankAccount balance.
client:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the client associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.
'
controlled_account:
type: boolean
description: 'Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).
When Compliant Trust Accounting is enabled, controlled bank accounts must be of type "Trust" and require bank name, client, and matter details. Client and matter cannot be updated after the account is created.
'
currency:
type: string
description: Currency the BankAccount is in.
default_account:
type: boolean
description: Whether or not the BankAccount should be the default account.
domicile_branch:
type: string
description: Branch where the BankAccount was opened.
general_ledger_number:
type: string
description: General ledger number used for the Law Society of Alberta.
holder:
type: string
description: BankAccount holder.
institution:
type: string
description: 'Financial institution (bank name).
When Compliant Trust Accounting is enabled and the BankAccount is controlled, this field is required.
'
matter:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the matter associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and the matter must belong to the same client specified in `client[id]`. This association cannot be updated after the account is created.
'
name:
type: string
description: BankAccount name.
swift:
type: string
description: Identification code for the financial institution.
transit_number:
type: string
description: 'Transit number for the BankAccount branch.
When Compliant Trust Accounting is enabled, this field is required for operating accounts.
'
type:
type: string
enum:
- Operating
- Trust
description: Type of BankAccount.
required:
- currency
- type
required: false
/bank_accounts/{id}.json:
get:
tags:
- Bank Accounts
summary: Return the data for a single BankAccount
operationId: BankAccount#show
description: Outlines the parameters, optional and required, used when requesting the data for a single BankAccount
parameters:
- name: IF-MODIFIED-SINCE
in: header
description: The server will send the requested resource with a 200 status, but only if it has been modified after the given date. (Expects an RFC 2822 timestamp).
required: false
schema:
type: string
format: date
- name: IF-NONE-MATCH
in: header
description: The server will send the requested resource with a 200 status, but only if the existing resource's [ETag](#section/ETags) doesn't match any of the values listed.
required: false
schema:
type: string
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: id
in: path
description: The unique identifier for the BankAccount.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/BankAccount_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'304':
description: Not Modified
patch:
tags:
- Bank Accounts
summary: Update a single BankAccount
operationId: BankAccount#update
description: Outlines the parameters and data fields used when updating a single BankAccount
parameters:
- name: IF-MATCH
in: header
description: The server will update the requested resource and send back a 200 status, but only if value in the header matches the existing resource's [ETag](#section/ETags).
required: false
schema:
type: string
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
- name: id
in: path
description: The unique identifier for the BankAccount.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/BankAccount_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Unprocessable Entity
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'412':
description: Precondition Failed
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
requestBody:
description: Request Body for Bank Accounts
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
account_number:
type: string
description: 'Account number for the BankAccount.
When Compliant Trust Accounting is enabled, this field is required for operating accounts and controlled trust accounts.
'
client:
type: object
properties:
id:
type: integer
format: int64
description: 'The unique identifier for the client associated with a controlled BankAccount.
When Compliant Trust Accounting is enabled and creating a controlled bank account, this field is required and cannot be updated after the account is created.
'
controlled_account:
type: boolean
description: 'Whether this BankAccount is a controlled bank account (Controlled Money Account / Interest Bearing Deposit).
When Compliant Trust Accounting is enabled, controlled bank accounts must be of type "Trust" and require bank name, client, and matter details. Client and matter cannot be updated
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clio/refs/heads/main/openapi/clio-bank-accounts-api-openapi.yml