Bank Entries

GET /banking/bank-entries

Group: Banking › Bank Entries · Operation ID: bankEntries

Returns a list of bank entries. Each row is the entry header without its posting lines. To read the lines use GET banking/bank-entries/:id, and to match on the bank account use POST banking/bank-entries/search.

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
bankEntryNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
transactionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
serviceDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
journalEntryNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
origin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, bankEntryNumber, transactionDate, serviceDate, currency, status, journalEntryNumber, origin, lastModifiedDate
Selectable: id, bankEntryNumber, name, description, transactionDate, serviceDate, currency, status, journalEntryNumber, origin, bankAccountName, lastModifiedDate

Response

200 Success

Under data, an array of bankEntriesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the bank entry.
`bankEntryNumber`	string or null	no	The bank entry number. Absent until one has been assigned.
`name`	string or null	no	The display name of the bank entry.
`description`	string or null	no	A free-form description of the entry.
`transactionDate`	string (date) or null	no	The date of the transaction this entry records. Format YYYY-MM-DD.
`serviceDate`	string (date) or null	no	The date the goods or services were delivered. Format YYYY-MM-DD.
`currency`	string or null	no	The currency the entry is denominated in. Format ISO 4217, for example 'USD'. It governs every line amount.
`status`	string or null	no	The reconciliation status of the entry. Possible values: 'matched', 'unmatched', 'voided', 'integrated'.
`journalEntryNumber`	string or null	no	The number of the journal entry this entry posted to, when it has been posted.
`origin`	string or null	no	A label for the source system the entry was created from.
`bankAccountName`	string or null	no	The name of the bank general-ledger account.
`lastModifiedDate`	string (date-time) or null	no	The date and time the bank entry last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error