# Accounting API — Bank Accounts
> Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Bank-Accounts
This document contains every operation on the `Bank Accounts` resource.
---
# List Bank Accounts
> **Accounting API** · `GET /accounting/bank-accounts`
> Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Bank-Accounts/operation/bankAccountsAll
List Bank Accounts
## Parameters
| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. |
| `cursor` | query | `string` | No | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. |
| `limit` | query | `integer` | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |
| `filter` | query | `object` | No | Apply filters |
| `sort` | query | `object` | No | Apply sorting |
| `pass_through` | query | `object` | No | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads |
| `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. |
### Responses
#### 200 — Bank Accounts
- `status_code` `integer` **required** — HTTP Response Status Code — example: `200`
- `status` `string` **required** — HTTP Response Status — example: `OK`
- `service` `string` — Apideck ID of service provider — example: `quickbooks`
- `resource` `string` — Unified API resource name — example: `bank-accounts`
- `operation` `string` — Operation performed — example: `all`
- `data` `array of object` **required**
- `id` `string` **required** — A unique identifier for an object. — example: `12345`
- `downstream_id` `string` — The third-party API ID of original entity — example: `12345`
- `display_id` `string` — Display ID for the bank account — example: `BA-001`
- `name` `string` — The name of the bank account — example: `Main Operating Account`
- `account_number` `string` — The bank account number — example: `123465`
- `account_type` `string` — The type of bank account — enum: `checking`, `savings`, `credit_card`, `money_market`, `line_of_credit`, `other`, `cash` — example: `checking`
- `ledger_account` `object`
- `id` `string` — The unique identifier for the account. — example: `123456`
- `name` `string` — The name of the account. — example: `Bank account`
- `nominal_code` `string` — The nominal code of the account. — example: `N091`
- `code` `string` — The code assigned to the account. — example: `453`
- `parent_id` `string` — The parent ID of the account. — example: `123456`
- `display_id` `string` — The display ID of the account. — example: `123456`
- `bank_name` `string` — The name of the bank or financial institution — example: `Chase Bank`
- `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
- `balance` `number` — The current balance of the bank account — example: `25000`
- `available_balance` `number` — The available balance (considering pending transactions and overdraft) — example: `24500`
- `overdraft_limit` `number` — The overdraft limit for the account — example: `5000`
- `routing_number` `string` — Bank routing number (US) — example: `021000021`
- `iban` `string` — International Bank Account Number — example: `GB33BUKB20201555555555`
- `bic` `string` — Bank Identifier Code / SWIFT Code — example: `CHASUS33`
- `bsb_number` `string` — Bank State Branch number (Australia/New Zealand) — example: `062-001`
- `branch_identifier` `string` — Bank branch identifier — example: `001`
- `bank_code` `string` — Bank code assigned by central bank — example: `BNH`
- `country` `string` — Country code according to ISO 3166-1 alpha-2. — example: `US`
- `status` `string` — The status of the bank account — enum: `active`, `inactive`, `closed` — example: `OK`
- `description` `string` — Description or notes about the bank account — example: `Primary operating account for daily transactions`
- `custom_fields` `array of object`
- `id` `string` — Unique identifier for the custom field. — example: `2389328923893298`
- `name` `string` — Name of the custom field. — example: `employee_level`
- `description` `string` — More information about the custom field — example: `Employee Level`
- `value` `string | number | boolean | object | array of string | number | boolean | object`
- One of:
- Option 1: string
- Option 2: number
- Option 3: boolean
- Option 4: object
- Option 5: array of string | number | boolean | object
- `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here.
- `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `created_by` `string` — The user who created the object. — example: `12345`
- `updated_by` `string` — The user who last updated the object. — example: `12345`
- `meta` `object` — Response metadata
- `items_on_page` `integer` — Number of items returned in the data property of the response — example: `50`
- `cursors` `object` — Cursors to navigate to previous or next pages through the API
- `previous` `string` — Cursor to navigate to the previous page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjE=`
- `current` `string` — Cursor to navigate to the current page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjI=`
- `next` `string` — Cursor to navigate to the next page of results through the API — example: `em9oby1jcm06OnBhZ2U6OjM=`
- `links` `object` — Links to navigate to previous or next pages through the API
- `previous` `string` — Link to navigate to the previous page through the API — example: `https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D`
- `current` `string` — Link to navigate to the current page through the API — example: `https://unify.apideck.com/crm/companies`
- `next` `string` — Link to navigate to the previous page through the API — example: `https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM`
#### 400 — Bad Request
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 401 — Unauthorized
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 402 — Payment Required
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 404 — The specified resource was not found
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 422 — Unprocessable
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### default — Unexpected error
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
---
# Create Bank Account
> **Accounting API** · `POST /accounting/bank-accounts`
> Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Bank-Accounts/operation/bankAccountsAdd
Create Bank Account
## Parameters
| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
### Request Body
_Required._
- `id` `string` **required** — A unique identifier for an object. — example: `12345`
- `downstream_id` `string` — The third-party API ID of original entity — example: `12345`
- `display_id` `string` — Display ID for the bank account — example: `BA-001`
- `name` `string` — The name of the bank account — example: `Main Operating Account`
- `account_number` `string` — The bank account number — example: `123465`
- `account_type` `string` — The type of bank account — enum: `checking`, `savings`, `credit_card`, `money_market`, `line_of_credit`, `other`, `cash` — example: `checking`
- `ledger_account` `object`
- `id` `string` — The unique identifier for the account. — example: `123456`
- `name` `string` — The name of the account. — example: `Bank account`
- `nominal_code` `string` — The nominal code of the account. — example: `N091`
- `code` `string` — The code assigned to the account. — example: `453`
- `parent_id` `string` — The parent ID of the account. — example: `123456`
- `display_id` `string` — The display ID of the account. — example: `123456`
- `bank_name` `string` — The name of the bank or financial institution — example: `Chase Bank`
- `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
- `balance` `number` — The current balance of the bank account — example: `25000`
- `available_balance` `number` — The available balance (considering pending transactions and overdraft) — example: `24500`
- `overdraft_limit` `number` — The overdraft limit for the account — example: `5000`
- `routing_number` `string` — Bank routing number (US) — example: `021000021`
- `iban` `string` — International Bank Account Number — example: `GB33BUKB20201555555555`
- `bic` `string` — Bank Identifier Code / SWIFT Code — example: `CHASUS33`
- `bsb_number` `string` — Bank State Branch number (Australia/New Zealand) — example: `062-001`
- `branch_identifier` `string` — Bank branch identifier — example: `001`
- `bank_code` `string` — Bank code assigned by central bank — example: `BNH`
- `country` `string` — Country code according to ISO 3166-1 alpha-2. — example: `US`
- `status` `string` — The status of the bank account — enum: `active`, `inactive`, `closed` — example: `active`
- `description` `string` — Description or notes about the bank account — example: `Primary operating account for daily transactions`
- `custom_fields` `array of object`
- `id` `string` — Unique identifier for the custom field. — example: `2389328923893298`
- `name` `string` — Name of the custom field. — example: `employee_level`
- `description` `string` — More information about the custom field — example: `Employee Level`
- `value` `string | number | boolean | object | array of string | number | boolean | object`
- One of:
- Option 1: string
- Option 2: number
- Option 3: boolean
- Option 4: object
- Option 5: array of string | number | boolean | object
- `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here.
- `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `created_by` `string` — The user who created the object. — example: `12345`
- `updated_by` `string` — The user who last updated the object. — example: `12345`
### Responses
#### 201 — Bank Account created
- `status_code` `integer` **required** — HTTP Response Status Code — example: `201`
- `status` `string` **required** — HTTP Response Status — example: `Created`
- `service` `string` — Apideck ID of service provider — example: `quickbooks`
- `resource` `string` — Unified API resource name — example: `bank-accounts`
- `operation` `string` — Operation performed — example: `add`
- `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted.
- `id` `string` **required** — The unique identifier of the resource — example: `12345`
#### 400 — Bad Request
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 401 — Unauthorized
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 402 — Payment Required
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 404 — The specified resource was not found
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 422 — Unprocessable
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### default — Unexpected error
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
---
# Get Bank Account
> **Accounting API** · `GET /accounting/bank-accounts/{id}`
> Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Bank-Accounts/operation/bankAccountsOne
Get Bank Account
## Parameters
| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | `string` | Yes | ID of the record you are acting upon. |
| `filter` | query | `object` | No | Apply filters |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `x-apideck-company-id` | header | `string` | No | The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings. |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
| `fields` | query | `string` | No | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.
Example: `fields=name,email,addresses.city`
In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. |
### Responses
#### 200 — Bank Account
- `status_code` `integer` **required** — HTTP Response Status Code — example: `200`
- `status` `string` **required** — HTTP Response Status — example: `OK`
- `service` `string` — Apideck ID of service provider — example: `quickbooks`
- `resource` `string` — Unified API resource name — example: `bank-accounts`
- `operation` `string` — Operation performed — example: `one`
- `data` `object` **required**
- `id` `string` **required** — A unique identifier for an object. — example: `12345`
- `downstream_id` `string` — The third-party API ID of original entity — example: `12345`
- `display_id` `string` — Display ID for the bank account — example: `BA-001`
- `name` `string` — The name of the bank account — example: `Main Operating Account`
- `account_number` `string` — The bank account number — example: `123465`
- `account_type` `string` — The type of bank account — enum: `checking`, `savings`, `credit_card`, `money_market`, `line_of_credit`, `other`, `cash` — example: `checking`
- `ledger_account` `object`
- `id` `string` — The unique identifier for the account. — example: `123456`
- `name` `string` — The name of the account. — example: `Bank account`
- `nominal_code` `string` — The nominal code of the account. — example: `N091`
- `code` `string` — The code assigned to the account. — example: `453`
- `parent_id` `string` — The parent ID of the account. — example: `123456`
- `display_id` `string` — The display ID of the account. — example: `123456`
- `bank_name` `string` — The name of the bank or financial institution — example: `Chase Bank`
- `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
- `balance` `number` — The current balance of the bank account — example: `25000`
- `available_balance` `number` — The available balance (considering pending transactions and overdraft) — example: `24500`
- `overdraft_limit` `number` — The overdraft limit for the account — example: `5000`
- `routing_number` `string` — Bank routing number (US) — example: `021000021`
- `iban` `string` — International Bank Account Number — example: `GB33BUKB20201555555555`
- `bic` `string` — Bank Identifier Code / SWIFT Code — example: `CHASUS33`
- `bsb_number` `string` — Bank State Branch number (Australia/New Zealand) — example: `062-001`
- `branch_identifier` `string` — Bank branch identifier — example: `001`
- `bank_code` `string` — Bank code assigned by central bank — example: `BNH`
- `country` `string` — Country code according to ISO 3166-1 alpha-2. — example: `US`
- `status` `string` — The status of the bank account — enum: `active`, `inactive`, `closed` — example: `OK`
- `description` `string` — Description or notes about the bank account — example: `Primary operating account for daily transactions`
- `custom_fields` `array of object`
- `id` `string` — Unique identifier for the custom field. — example: `2389328923893298`
- `name` `string` — Name of the custom field. — example: `employee_level`
- `description` `string` — More information about the custom field — example: `Employee Level`
- `value` `string | number | boolean | object | array of string | number | boolean | object`
- One of:
- Option 1: string
- Option 2: number
- Option 3: boolean
- Option 4: object
- Option 5: array of string | number | boolean | object
- `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here.
- `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `created_by` `string` — The user who created the object. — example: `12345`
- `updated_by` `string` — The user who last updated the object. — example: `12345`
#### 400 — Bad Request
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 401 — Unauthorized
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 402 — Payment Required
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 404 — The specified resource was not found
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 422 — Unprocessable
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### default — Unexpected error
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
---
# Delete Bank Account
> **Accounting API** · `DELETE /accounting/bank-accounts/{id}`
> Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Bank-Accounts/operation/bankAccountsDelete
Delete Bank Account
## Parameters
| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | `string` | Yes | ID of the record you are acting upon. |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
### Responses
#### 200 — Bank Account deleted
- `status_code` `integer` **required** — HTTP Response Status Code — example: `200`
- `status` `string` **required** — HTTP Response Status — example: `OK`
- `service` `string` — Apideck ID of service provider — example: `quickbooks`
- `resource` `string` — Unified API resource name — example: `bank-accounts`
- `operation` `string` — Operation performed — example: `delete`
- `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted.
- `id` `string` **required** — The unique identifier of the resource — example: `12345`
#### 400 — Bad Request
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 401 — Unauthorized
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 402 — Payment Required
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 404 — The specified resource was not found
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 422 — Unprocessable
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### default — Unexpected error
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
---
# Update Bank Account
> **Accounting API** · `PATCH /accounting/bank-accounts/{id}`
> Canonical URL: https://developers.apideck.com/apis/accounting/reference#tag/Bank-Accounts/operation/bankAccountsUpdate
Update Bank Account
## Parameters
| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | `string` | Yes | ID of the record you are acting upon. |
| `x-apideck-consumer-id` | header | `string` | Yes | ID of the consumer which you want to get or push data from |
| `x-apideck-app-id` | header | `string` | Yes | The ID of your Unify application |
| `x-apideck-service-id` | header | `string` | No | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
| `raw` | query | `boolean` | No | Include raw response. Mostly used for debugging purposes |
### Request Body
_Required._
- `id` `string` **required** — A unique identifier for an object. — example: `12345`
- `downstream_id` `string` — The third-party API ID of original entity — example: `12345`
- `display_id` `string` — Display ID for the bank account — example: `BA-001`
- `name` `string` — The name of the bank account — example: `Main Operating Account`
- `account_number` `string` — The bank account number — example: `123465`
- `account_type` `string` — The type of bank account — enum: `checking`, `savings`, `credit_card`, `money_market`, `line_of_credit`, `other`, `cash` — example: `checking`
- `ledger_account` `object`
- `id` `string` — The unique identifier for the account. — example: `123456`
- `name` `string` — The name of the account. — example: `Bank account`
- `nominal_code` `string` — The nominal code of the account. — example: `N091`
- `code` `string` — The code assigned to the account. — example: `453`
- `parent_id` `string` — The parent ID of the account. — example: `123456`
- `display_id` `string` — The display ID of the account. — example: `123456`
- `bank_name` `string` — The name of the bank or financial institution — example: `Chase Bank`
- `currency` `string` — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). — enum: `UNKNOWN_CURRENCY`, `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BOV`, `BRL`, `BSD`, `BTN`, `BWP`, `BYR`, `BZD`, `CAD`, `CDF`, `CHE`, `CHF`, `CHW`, `CLF`, `CLP`, `CNY`, `COP`, `COU`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `IRR`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LTL`, `LVL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRO`, `MUR`, `MVR`, `MWK`, `MXN`, `MXV`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRC`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `USN`, `USS`, `UYI`, `UYU`, `UZS`, `VEF`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XBA`, `XBB`, `XBC`, `XBD`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `XTS`, `XXX`, `YER`, `ZAR`, `ZMK`, `ZMW`, `BTC`, `ETH` — example: `USD`
- `balance` `number` — The current balance of the bank account — example: `25000`
- `available_balance` `number` — The available balance (considering pending transactions and overdraft) — example: `24500`
- `overdraft_limit` `number` — The overdraft limit for the account — example: `5000`
- `routing_number` `string` — Bank routing number (US) — example: `021000021`
- `iban` `string` — International Bank Account Number — example: `GB33BUKB20201555555555`
- `bic` `string` — Bank Identifier Code / SWIFT Code — example: `CHASUS33`
- `bsb_number` `string` — Bank State Branch number (Australia/New Zealand) — example: `062-001`
- `branch_identifier` `string` — Bank branch identifier — example: `001`
- `bank_code` `string` — Bank code assigned by central bank — example: `BNH`
- `country` `string` — Country code according to ISO 3166-1 alpha-2. — example: `US`
- `status` `string` — The status of the bank account — enum: `active`, `inactive`, `closed` — example: `active`
- `description` `string` — Description or notes about the bank account — example: `Primary operating account for daily transactions`
- `custom_fields` `array of object`
- `id` `string` — Unique identifier for the custom field. — example: `2389328923893298`
- `name` `string` — Name of the custom field. — example: `employee_level`
- `description` `string` — More information about the custom field — example: `Employee Level`
- `value` `string | number | boolean | object | array of string | number | boolean | object`
- One of:
- Option 1: string
- Option 2: number
- Option 3: boolean
- Option 4: object
- Option 5: array of string | number | boolean | object
- `custom_mappings` `object` — When custom mappings are configured on the resource, the result is included here.
- `created_at` `string` — The date and time when the object was created. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `updated_at` `string` — The date and time when the object was last updated. — format: `date-time` — example: `2020-09-30T07:43:32.000Z`
- `created_by` `string` — The user who created the object. — example: `12345`
- `updated_by` `string` — The user who last updated the object. — example: `12345`
### Responses
#### 200 — Bank Account updated
- `status_code` `integer` **required** — HTTP Response Status Code — example: `200`
- `status` `string` **required** — HTTP Response Status — example: `OK`
- `service` `string` — Apideck ID of service provider — example: `quickbooks`
- `resource` `string` — Unified API resource name — example: `bank-accounts`
- `operation` `string` — Operation performed — example: `update`
- `data` `object` **required** — A object containing a unique identifier for the resource that was created, updated, or deleted.
- `id` `string` **required** — The unique identifier of the resource — example: `12345`
#### 400 — Bad Request
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 401 — Unauthorized
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 402 — Payment Required
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 404 — The specified resource was not found
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### 422 — Unprocessable
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
#### default — Unexpected error
> Standard error response — see [Error Responses](https://developers.apideck.com/errors)
---