Invoice

Busca invoices, documentos internacionais ingeridos através de OCR

Este endpoint possibilita a busca por invoices internacionais que foram processadas e ingeridas na Qive através de OCR. A resposta retorna um objeto JSON contendo uma lista de invoices. Cada invoice é composta pelos seguintes dados:

  • ID: Identificador único da invoice na API Qive.
  • Parsed Document: Uma representação estruturada dos dados invoice.

O endpoint retorna um máximo de 50 invoices por página. A busca pode ser filtrada utilizando a data em que o documento foi processado pela Qive.

get/v1/invoice/search

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/invoice/search
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Query parameters

initial_datestring date-time required

Data inicial para o filtro de busca. Esta data se refere à data em que o documento foi ingerido pela Qive. Utilize o formato: 2025-01-23T00:00:00Z.

final_datestring date-time required

Data final para o filtro de busca. Esta data se refere à data em que o documento foi ingerido pela Qive. Utilize o formato: 2025-01-23T23:59:59Z.

pageinteger required

Página que deve ser buscada pela API. Cada página retorna um total de até 50 documentos.

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

Response

Successful fetch

Changes

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