ALaltoviz
BankAccounts

Get a bank account by ID

Changed on
get/v1/bankaccounts/{id}

Request

Path parameters

idinteger required

Bank account ID

Response

OK

accountNumberstring nullable

Accounting account number

balancenumber double

Current balance, derived from the initial balance and every transaction since

bankNamestring nullable

Bank name

bicstring nullable

BIC

connectedboolean

Whether this account is synchronized from a provider, which is exactly whether Altoviz.Api.Models.BankAccount.Provider is set.

A connected account is read-only: PUT and DELETE on it are refused. Disconnect it in the Altoviz application first if you mean to take it over by hand.

currencystring nullable

ISO currency code. Defaults to EUR.

defaultPaymentMethod'Transfer' | 'Order' | 'Check' | 'Cash' | 'Card' | 'Bill' | 'Usec' | 'Other'
ibanstring nullable

IBAN

idinteger

Bank account ID

initialBalancenumber double

Balance the account held before the first transaction Altoviz knows about. The running balance is derived from it, so changing it moves every balance after it.

isMainboolean

Whether this is the company's main account

journalCodestring nullable

Accounting journal code

lastUpdatedAtstring date-time nullable

When the account was last synchronized with its provider

logoUristring nullable

Bank logo URL

metadataobject nullable

Metadata: free-form key/value pairs carried with the bank account, for an integration to keep its own identifiers and flags against it.

Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as null. Omitting the property entirely leaves the whole bag untouched, and "" stores an empty value rather than removing the key.

namestring nullable

Name

pendingTransactionsinteger

Transactions not yet reconciled with a document

pendingTransactionsTotalnumber double

Total value of the transactions not yet reconciled

synchronizingboolean

Whether a synchronization is running

Changes