API Docs / Schemas / BooksBankAccountDto

BooksBankAccountDto

A bank account held in a client's own books.

Properties

Name Type Description
idstring

The platform's identifier for the account.

The platform's identifier for the account.

namestring

The account's name in the books.

The account's name in the books.

accountNumberstring

The account number, where the platform exposes it — often partially masked.

The account number, where the platform exposes it — often partially masked.

currencystring

ISO currency code, where the platform reports one.

ISO currency code, where the platform reports one.

balancenumber

The balance the books hold. Null means the platform does not return balances on its accounts
endpoint — Xero, for one, does not — and must not be rendered as zero.

The balance the books hold. Null means the platform does not return balances on its accounts
endpoint — Xero, for one, does not — and must not be rendered as zero.

JSON Example

{
  "id": "string",
  "name": "string",
  "accountNumber": "string",
  "currency": "string",
  "balance": 0
}