List receipts in this household; filter by link state, extraction status, kind, day, amount, merchant, tags or free text; sort by date, amount or merchant.
Request
- Base URL: https://api.vokse.ai
- URL: https://api.vokse.ai/households/{householdId}/receipts
- Auth: HTTP bearer
Query parameters
nextCursor of the previous page; only valid for the same sort and dateBasis
date_desc (default) | date_asc | amount_desc | amount_asc | merchant_asc; dates follow dateBasis, ties break on id, receipts without a total or merchant come last
true = not yet linked to a transaction
true = linked to a transaction, false = still in the tray
Comma-separated: pending, processing, extracted, failed
receipt | invoice | product | other
Free text over what was read (merchant, items, tags, summary); terms are ANDed
Which day the date filters and sorts use: receipt (default; the day printed on it, the upload day until it is read) or upload
Inclusive (YYYY-MM-DD) on the chosen dateBasis
Inclusive (YYYY-MM-DD) on the chosen dateBasis
Inclusive lower bound on the read total, integer cents
Inclusive upper bound on the read total, integer cents
Comma-separated merchant keys (from the facets); any of them
Comma-separated tags; all of them
Changes
No recorded changes to this operation across all 1 revision of this API.