BankAccounts

Bank accounts store payment destination details for subsidiaries, displayed on invoices and financial documents. They contain IBAN, SWIFT/BIC, bank name, and account number fields.

Manage which bank accounts are associated with each subsidiary to control what payment information appears on client-facing documents.

Attributes

archived_at string
Response

Timestamp when the bank account was archived, or null if active.
bank_address string
Response Request

The physical address of the bank associated with this account.
bank_name string
Response Request Parameter `filter`

The name of the bank associated with this account.
currency string
Response Request

The ISO 4217 currency code for this bank account (e.g. USD, EUR).
id integer
Parameter `filter` Parameter `sort`

Unique identifier for the bank account.
name string
Response Request Parameter `filter` Parameter `sort`

The display name of the bank account.
number string
Response Request

The bank account number (IBAN or local account number).
organization organization
Response

The organization this bank account belongs to.
status integer
Parameter `filter` Enum

The current status of the bank account (e.g. active or archived).

Enum Values (2 values)

  • 1
  • 2
subsidiary subsidiary
Response

The subsidiary this bank account belongs to.
subsidiary_id integer
Request Parameter `filter`

The ID of the subsidiary this bank account belongs to.
swift_code string
Response Request

The SWIFT/BIC code identifying the bank in international transactions.

Operations

GET /api/v2/bank_accounts
Get bank accounts
POST /api/v2/bank_accounts
Create a bank account
GET /api/v2/bank_accounts/{id}
Gets a bank account
PATCH /api/v2/bank_accounts/{id}
Update a bank account
PATCH /api/v2/bank_accounts/{id}/archive
Archives a bank account
PATCH /api/v2/bank_accounts/{id}/restore
Restores an archived bank account