BankAccount

A bank account the organization receives money into or pays from, in one currency.

type BankAccount {
  accountName: String!
  accountNumber: String!
  accountType: String!
  bankName: String!
  branchCode: String
  createdAt: DateTime!
  currencyCode: String!
  currentBalance: Float!
  iban: String
  id: ID!
  isActive: Boolean!
  isDefault: Boolean!
  notes: String
  organizationId: String!
  swiftCode: String
  updatedAt: DateTime!
}

Fields

BankAccount.accountName ● String! non-null scalar

The name the account is known by in the organization.

BankAccount.accountNumber ● String! non-null scalar

The account number, masked. Use revealBankAccountSecrets for the full number.

BankAccount.accountType ● String! non-null scalar

The kind of account, for example CURRENT or SAVINGS.

BankAccount.bankName ● String! non-null scalar

The name of the bank that holds the account.

BankAccount.branchCode ● String scalar

The bank branch or sort code.

BankAccount.createdAt ● DateTime! non-null scalar

When the record was created.

BankAccount.currencyCode ● String! non-null scalar

ISO 4217 currency code.

BankAccount.currentBalance ● Float! non-null scalar

The running balance in the account's currency. Processed payments move it, and adjustBankAccountBalance corrects it.

BankAccount.iban ● String scalar

The IBAN, masked. Use revealBankAccountSecrets for the full value.

BankAccount.id ● ID! non-null scalar

The unique ID of this record.

BankAccount.isActive ● Boolean! non-null scalar

Whether the record is active.

BankAccount.isDefault ● Boolean! non-null scalar

Whether this is the default.

BankAccount.notes ● String scalar

Free-text notes about the account.

BankAccount.organizationId ● String! non-null scalar

The ID of the organization the record belongs to.

BankAccount.swiftCode ● String scalar

The SWIFT or BIC code of the bank.

BankAccount.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Returned By

adjustBankAccountBalance mutation ● bankAccount query ● bankAccounts query ● createBankAccount mutation ● setDefaultBankAccount mutation ● updateBankAccount mutation