Returns the fund transfers that match the given filters.

POST /banking/fund-transfers/search

Group: Banking › Fund Transfers · Operation ID: searchFundTransfer

Every filter is optional and they are combined with AND. Omit them all to return every fund transfer.

fromAccountId and toAccountId are separate filters, so you can find what left an account, what arrived in it, or both.

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.

Request body

Required, application/json: searchFundTransferInput.

Field Type Required Description
filters object no The filters to apply. A fund transfer must match every filter you send. Omit to return all fund transfers.
filters.id string no Limits results to the fund transfer with this identifier.
filters.fundTransferNumber string no Limits results to the fund transfer with this number. The match is exact.
filters.journalEntryNumber string no Limits results to fund transfers posted to the journal entry with this number. The match is exact.
filters.externalPaymentId string no Limits results to fund transfers with this external payment identifier. It is not unique, so several transfers can match. The match is exact.
filters.fromAccountId string no Limits results to transfers that left this general-ledger account. See id on GET accounting/accounts/:id.
filters.toAccountId string no Limits results to transfers that arrived in this general-ledger account. See id on GET accounting/accounts/:id.
filters.entityId string no Limits results to transfers posted under this legal entity. See id on GET base/entities.
filters.entityName string no Limits results to transfers posted under the legal entity with this name. The match is exact and case-sensitive.
filters.isVoided boolean no Limits results to voided transfers when true, and to live transfers when false. Omit to return both.
filters.isIntercompany boolean no Limits results to intercompany transfers when true, and to same-entity transfers when false. Omit to return both.
filters.origin string no Limits results to transfers with this origin. The match is exact.
page object no The pagination controls. Omit for the first page.
page.cursor string no The cursor from the previous response's pagination.nextCursor. Omit for the first request.
page.size number no The number of fund transfers per page. Defaults to 50. A value above 200 is treated as 200, not rejected.

Example:

{
  "filters": {
    "isVoided": false
  },
  "page": {
    "size": 50
  }
}

Response

200 Success

Under data (searchFundTransferOutput):

Field Type Required Description
items array of object yes The fund transfers on this page, most recently created first. An empty array when nothing matches.
items[].id string yes The unique identifier for the fund transfer.
items[].fundTransferNumber string no The fund transfer number, for example 'FT-71122'. Absent while none has been assigned.
items[].name string no The display name of the fund transfer.
items[].description string no A free-form description of the transfer.
items[].transferDate string (date) yes The date the money moved. Format YYYY-MM-DD.
items[].transferAmount string (decimal) no The amount moved, in the transfer currency.
items[].currency string no The transfer currency. Format ISO 4217, for example 'USD'. transferAmount is in this currency.
items[].exchangeRate string (decimal) no The exchange rate applied when the two accounts are held in different currencies.
items[].isVoided boolean no Whether the transfer has been voided. A voided transfer is kept for audit rather than deleted.
items[].isIntercompany boolean no Whether the transfer moves money between two legal entities rather than between two accounts of one entity. When true, toEntityId names the receiving entity.
items[].journalEntryNumber string no The number of the journal entry this transfer posted to, on GET accounting/journal-entries. Absent until the transfer has posted.
items[].origin string no The system or process the transfer came from.
items[].externalUrl string no An absolute http or https link to the source document in an external system.
items[].externalPaymentId string no The identifier of this payment in the external system that initiated the transfer. It is not unique.
items[].fromAccountId string no The general-ledger account the money left. See id on GET accounting/accounts/:id.
items[].fromAccountName string no The name of the account the money left.
items[].toAccountId string no The general-ledger account the money arrived in. See id on GET accounting/accounts/:id.
items[].toAccountName string no The name of the account the money arrived in.
items[].entityId string no The legal entity the transfer is posted under. On an intercompany transfer this is the sending entity. See id on GET base/entities.
items[].entityName string no The name of the legal entity the transfer is posted under.
items[].toEntityId string no The receiving legal entity on an intercompany transfer. Absent on a same-entity transfer. See id on GET base/entities.
items[].toEntityName string no The name of the receiving legal entity on an intercompany transfer.
items[].lastModifiedDate string (date-time) yes The date and time the fund transfer last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lines array of object no The two sides of the transfer, one line per side. Read accountType to tell them apart rather than relying on order.
items[].lines[].id string yes The unique identifier for the line.
items[].lines[].lineNumber string no The line number.
items[].lines[].accountType string yes Which side of the transfer this line is. Possible values: 'from', 'to'.
items[].lines[].description string no A free-form description of the line.
items[].lines[].amount string (decimal) no The line amount, in the line currency.
items[].lines[].currency string no The currency of the line. Format ISO 4217, for example 'USD'. It differs from the transfer currency only on a cross-currency transfer.
items[].lines[].bankFee string (decimal) no The bank fee charged on this side of the transfer, in the line currency.
pagination object yes The pagination details for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as page.cursor. Absent on the last page.
pagination.hasMore boolean yes Whether more matches remain beyond this page.

Statuses