Invoice

Retrieve invoice by id

Disponível somente em ambiente de produção.

Este endpoint é equivalente ao /v1/invoice/search, mas com a finalidade de retornar um documento específico de invoice a partir de seu identificador único.

A resposta será um objeto JSON contendo o documento solicitado, com os seguintes campos:

  • id: identificador único do documento na API da Qive.
  • parsed_document: objeto estruturado com os dados extraídos do documento de invoice.

Esse recurso é útil para consultas diretas a um documento previamente conhecido, sem a necessidade de navegação paginada ou filtros adicionais.

get/v1/invoice/{id}

Request

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

Path parameters

idstring required

id é o ID do documento de invoice a ser buscado na API.

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

Successfull Fetch

Changes

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