Get Bank Entry

GET /banking/bank-entries/{id}

Group: Banking › Bank Entries · Operation ID: getBankEntry

Returns the bank entry with the given identifier. Use the bank entry's id, not its bankEntryNumber.

A bank entry records money moving in or out of a bank account. Its lines record the general-ledger postings, as decimals in the entry currency.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the bank entry to return.

Response

200 Success

Under data (getBankEntryOutput):

Field Type Required Description
id string yes The unique identifier for the bank entry.
bankEntryNumber string no The bank entry number. Absent until one has been assigned.
name string no The display name of the bank entry.
description string no A free-form description of the entry.
transactionDate string (date) yes The date of the transaction this entry records. Format YYYY-MM-DD.
serviceDate string (date) no The date the goods or services were delivered. Format YYYY-MM-DD. Defaults to the transaction date where the entity's country requires a service date.
currency string no The currency the entry is denominated in. Format ISO 4217, for example 'USD'. It governs every line amount.
status string yes The reconciliation status of the entry. Possible values: 'matched', 'unmatched', 'voided', 'integrated'.
journalEntryNumber string no The number of the journal entry this entry posted to, when it has been posted.
origin string no A label for the source system the entry was created from.
externalUrl string no A link to the source document in an external system.
bankAccountId string no The bank general-ledger account this entry is recorded against. See id on GET accounting/accounts/:id.
bankAccountName string no The name of the bank general-ledger account.
entityId string no The legal entity this entry is posted under. See id on GET base/entities.
lastModifiedDate string (date-time) yes The date and time the bank entry last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object no The posting lines of the entry, one per general-ledger posting. An empty array when the entry has none.
lines[].id string yes The unique identifier for the line.
lines[].lineNumber string no The line number.
lines[].description string no A free-form description of the line.
lines[].lineType string no The kind of line. Possible values: 'oneTime', 'prepaid'.
lines[].amount string (decimal) no The gross line amount, including VAT, in the entry currency.
lines[].currency string no The currency of the line. Format ISO 4217. It always matches the entry currency.
lines[].netAmount string (decimal) no The line amount excluding VAT, in the entry currency.
lines[].vatAmount string (decimal) no The VAT amount on the line, in the entry currency.
lines[].vatPercentage string (decimal) no The VAT rate applied, as a percentage. For example, 19 means 19%.
lines[].origin string no A label for the source system, copied onto the line from the entry.
lines[].accountId string no The general-ledger account this line posts to. See id on GET accounting/accounts/:id.
lines[].departmentId string no The department this line is charged to. See id on GET departments/:id.

Errors

Code Status
NOT_FOUND 400

Statuses