BooksBankAccountDto - SodiumHQ API Schema

Properties

Name	Type	Description
id	string	The platform's identifier for the account.
The platform's identifier for the account.
name	string	The account's name in the books.
The account's name in the books.
accountNumber	string	The account number, where the platform exposes it — often partially masked.
The account number, where the platform exposes it — often partially masked.
currency	string	ISO currency code, where the platform reports one.
ISO currency code, where the platform reports one.
balance	number	The balance the books hold, set only when SodiumHQ.DTOs.ClientBooks.BooksBankAccountDto.BalanceStatus is Reported. Null must never be rendered as zero.
The balance the books hold, set only when SodiumHQ.DTOs.ClientBooks.BooksBankAccountDto.BalanceStatus is Reported. Null must never be rendered as zero.
balanceStatus	enum	NotReported Reported Failed
NotReported Reported Failed
balanceCurrency	string	ISO currency code the balance is stated in, or null when it is the account's own SodiumHQ.DTOs.ClientBooks.BooksBankAccountDto.Currency. Set where the platform reports balances in the organisation's base currency (Xero), so a foreign-currency account's balance is not labelled with the wrong code.
ISO currency code the balance is stated in, or null when it is the account's own SodiumHQ.DTOs.ClientBooks.BooksBankAccountDto.Currency. Set where the platform reports balances in the organisation's base currency (Xero), so a foreign-currency account's balance is not labelled with the wrong code.

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