v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

invoices

Retrieve catalog-matched invoice lines as receiver/quantity export

Returns a paginated list of exported invoices with their catalog-matched line items. Only invoices in exported state, from vendors with item validation enabled, are returned. Fringe catalog entries and unmatched lines are excluded. If an invoice has zero qualifying lines after filtering it is omitted entirely.

get/invoices/receiver-export

Query parameters

ottimate_company_idinteger required

Ottimate company ID to scope the response

ottimate_location_idinteger required

Ottimate location (restaurant) ID to scope the response

exported_afterstring date-time

ISO 8601 datetime; returns invoices exported after this timestamp

exported_after_utcstring date-time

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

exported_beforestring date-time

ISO 8601 datetime; returns invoices exported before this timestamp

exported_before_utcstring date-time

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

vendor_idstring

Filter by vendor ID

pageinteger

Page number

limitinteger

Max results per page (default 50, max 200)

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Paginated list of receiver export invoices

countinteger

Total number of invoices matching the query

nextstring uri nullable

URL for the next page of results, or null if on the last page

previousstring uri nullable

URL for the previous page of results, or null if on the first page

pageinteger

Current page number

per_pageinteger

Number of results per page