Returns the credit card entries that match the given filters.

POST /banking/credit-card-entries/search

Group: Banking › Credit Card Entries · Operation ID: searchCreditCardEntry

Every filter is optional and they are combined with AND. Omit them all to return every credit card entry. Each match includes the entry header and its posting lines.

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: searchCreditCardEntryInput.

Field Type Required Description
filters object no The filters to apply. A credit card entry must match every filter you send. Omit to return all credit card entries.
filters.id string no Limits results to the credit card entry with this identifier.
filters.creditCardEntryNumber string no Limits results to the credit card entry with this number. The match is exact.
filters.journalEntryNumber string no Limits results to entries that posted to the journal entry with this number. The match is exact.
filters.status string no Limits results to entries in this status. Accepted values: 'Matched', 'Unmatched', 'Posted', 'Voided', 'Integrated'. Any other value matches nothing.
filters.currency string no Limits results to entries denominated in this currency. Format ISO 4217, for example 'USD'.
filters.creditCardAccountId string no Limits results to entries recorded against this credit card general-ledger account. See id on GET accounting/accounts/:id.
filters.entityId string no Limits results to entries posted under this legal entity. See id on GET base/entities.
filters.origin string no Limits results to entries created by this source system. 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 credit card entries per page. Defaults to 50. A value above 200 is treated as 200, not rejected.

Example:

{
  "filters": {
    "status": "Unmatched"
  },
  "page": {
    "size": 50
  }
}

Response

200 Success

Under data (searchCreditCardEntryOutput):

Field Type Required Description
items array of object yes The credit card entries on this page, most recently created first. An empty array when nothing matches.
items[].id string yes The unique identifier for the credit card entry.
items[].creditCardEntryNumber string no The credit card entry number. Absent until one has been assigned.
items[].name string no The display name of the credit card entry.
items[].description string no A free-form description of the entry.
items[].transactionDate string (date) yes The date of the transaction this entry records. Format YYYY-MM-DD.
items[].serviceDate string (date) no The date the goods or services were delivered. Format YYYY-MM-DD.
items[].currency string no The currency the entry is denominated in. Format ISO 4217, for example 'USD'. It governs every line amount.
items[].status string yes The reconciliation status of the entry. Possible values: 'Matched', 'Unmatched', 'Posted', 'Voided', 'Integrated'.
items[].journalEntryNumber string no The number of the journal entry this entry posted to, when it has been posted.
items[].origin string no A label for the source system the entry was created from.
items[].externalUrl string no A link to the source document in an external system.
items[].creditCardAccountId string no The credit card general-ledger account this entry is recorded against. See id on GET accounting/accounts/:id.
items[].creditCardAccountName string no The name of the credit card general-ledger account.
items[].entityId string no The legal entity this entry is posted under. See id on GET base/entities.
items[].lastModifiedDate string (date-time) yes The date and time the credit card entry last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
items[].lines array of object no The posting lines of the entry, one per general-ledger posting. An empty array when the entry has none.
items[].lines[].id string yes The unique identifier for the line.
items[].lines[].lineNumber string no The line number.
items[].lines[].description string no A free-form description of the line.
items[].lines[].lineType string no The kind of line. Possible values: 'oneTime', 'prepaid'.
items[].lines[].amount string (decimal) no The gross line amount, including VAT, in the entry currency.
items[].lines[].currency string no The currency of the line. Format ISO 4217. It always matches the entry currency.
items[].lines[].netAmount string (decimal) no The line amount excluding VAT, in the entry currency.
items[].lines[].vatAmount string (decimal) no The VAT amount on the line, in the entry currency.
items[].lines[].vatPercentage string (decimal) no The VAT rate applied, as a percentage. For example, 19 means 19%.
items[].lines[].origin string no A label for the source system, copied onto the line from the entry.
items[].lines[].accountId string no The general-ledger account this line posts to. See id on GET accounting/accounts/:id.
items[].lines[].departmentId string no The department this line is charged to. See id on GET departments/:id.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor to pass as page.cursor for the next page. Absent on the last page.
pagination.hasMore boolean yes Whether more matches remain beyond this page.

Statuses