Bank Feeds

List bank-feed accounts and one transaction bucket

Returns one feed card per account with a live Bank Feeds card (connection is bank or files; bank rows and CSV upload rows share the table), hiddenFeeds for hidden cards, complete bucket counts, and a transaction page for the selected account. feed.balanceOnly is true when the bank finished loading history and reports a balance but has sent no transactions; upload a CSV for that account's rows. Account, transaction bucket, inclusive dates, and search are applied before pagination. Results are ordered newest first with transaction ID as a stable tie-breaker. Each row reports origin (bank or csv) and duplicatePartner when it has a live possible-duplicate partner.

get/bank-feeds

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/bank-feeds
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Query parameters

bankAccountIdstring uuid
transactionView'ready' | 'pending' | 'checks' | 'posted' | 'excluded' | 'all'

Transaction bucket filtered before pagination.

startDatestring date

Inclusive bank transaction date, YYYY-MM-DD. Omit for no lower date bound.

endDatestring date

Inclusive bank transaction date, YYYY-MM-DD. Omit for no upper date bound.

searchstring

Case-insensitive text search across description, reference, payee, counterparty, and category name within the selected filters.

direction'in' | 'out'

Money in (deposits) or money out (withdrawals); omit for both.

sortBy'date' | 'amount'

Row order field; date (default) or amount.

sortOrder'asc' | 'desc'

desc (default, newest or largest first) or asc.

selectIdsboolean

When true, return { ids, total, truncated } for every row in the Ready or Posted bucket that matches the filters (up to 500, in sortBy/sortOrder order) instead of a page. Other buckets return no ids. Transfer and card-payment suspects and reconciled Posted rows are left out. categorize-batch accepts at most 200 ids per request, so send the ids in chunks of 200.

similarTostring uuid

With selectIds, return the bucket's rows from the same merchant and money direction (in or out) as this transaction, ignoring text, date, and direction filters.

pageinteger
limitinteger
includeExcludedboolean
sourceTypestring
possibleDuplicateboolean

When true, return only rows with a live possible-duplicate partner.

Response

Feed cards, selected bucket rows, summary, diagnostics, and pagination with page, limit, total matching rows, and totalPages. An out-of-range page returns the last available page. Each feed card's repeatsRegister is null, or names another importing feed card that holds the same date and amount for most of this card's last 120 days of feed activity (bankAccountId, accountName, accountNumber, matchedCount, rowCount); importing both counts those charges twice.

Changes

No recorded changes to this operation across all 5 revisions of this API.