List inbox documents

Returns documents awaiting inbox review with cursor pagination. filter[status] accepts new, viewed or ready; unsupported values return 422 with the allowed values. Converted and merged documents are outside this inbox; use bill.index to find converted purchases. filter[created_from]/filter[created_to] are inclusive UTC creation days (YYYY-MM-DD). Each row includes created_by (the uploader tenant user id), vendor_vat_number (scanned VAT first, then supplier metadata), and vendor_address (extracted address, then the matched supplier when the caller has view_vendors and vendors:read). Requires the document-extractions:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
Allowed:
date

Inclusive upload creation day (UTC), YYYY-MM-DD.

date
integer
1 to 100
Defaults to 25

Number of resources per cursor page (1-100).

string

Opaque cursor returned by the preceding collection response.

string

Comma-separated allowlisted sort fields; prefix descending fields with a minus sign.

string

Comma-separated allowlisted relationships.

string

Comma-separated allowlisted sparse response fields. The id field is always retained.

string

Allowlisted exact or bounded collection filter.

string

Allowlisted exact or bounded collection filter.

string

Allowlisted exact or bounded collection filter.

string

Allowlisted exact or bounded collection filter.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*