receipts

Facets of the receipts matching the same filters as the list: total, per-month counts and sums (on dateBasis), top merchants, top tags, status and link split.

get/households/{householdId}/receipts/facets

Request

  • Base URL: https://api.vokse.ai
  • URL: https://api.vokse.ai/households/{householdId}/receipts/facets
  • Auth: HTTP bearer

Query parameters

inboxOnlyunknown

true = not yet linked to a transaction

linkedunknown

true = linked to a transaction, false = still in the tray

transactionIdunknown
statusunknown

Comma-separated: pending, processing, extracted, failed

kindunknown

receipt | invoice | product | other

qunknown

Free text over what was read (merchant, items, tags, summary); terms are ANDed

dateBasisunknown

Which day the date filters and sorts use: receipt (default; the day printed on it, the upload day until it is read) or upload

dateFromunknown

Inclusive (YYYY-MM-DD) on the chosen dateBasis

dateTounknown

Inclusive (YYYY-MM-DD) on the chosen dateBasis

amountMinstring

Inclusive lower bound on the read total, integer cents

amountMaxstring

Inclusive upper bound on the read total, integer cents

merchantunknown

Comma-separated merchant keys (from the facets); any of them

tagunknown

Comma-separated tags; all of them

Changes

No recorded changes to this operation across all 1 revision of this API.