OCR

Get OCR tasks

get/ocr_tasks

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/ocr_tasks
  • Auth: HTTP bearer

Query parameters

order'asc' | 'desc'

Sort order (ascending by default). Typically used together with the sort parameter.

limitinteger

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstring

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sort'id' | 'created_at'

The field to sort the results by. Typically used together with the order parameter.

created_at__gtstring date-time

Return only ocr tasks created after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm].

created_at__ltstring date-time

Return only ocr tasks created in Monite before the specified date and time.

created_at__gtestring date-time

Return only ocr tasks created on or after the specified date and time.

created_at__ltestring date-time

Return only ocr tasks created before or on the specified date and time.

status'processing' | 'success' | 'error'

Return only ocr tasks that have the specified status.

document_type'invoice' | 'credit_note' | 'receipt'

Return only OCR tasks related to documents of a specific type.

id__instring uuid

Return only ocr tasks with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results.

To specify multiple IDs, repeat this parameter for each value: id__in=<id1>&id__in=<id2>

Headers

x-monite-versionstring required
x-monite-entity-idstring

The ID of the entity that owns the requested resource.

Response

Successful Response

next_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you've reached the last page).

prev_pagination_tokenstring

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you've reached the first page).

Changes

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