NFCe

Busca XMLs de NFCes emitidas pelos CNPJs de sua conta

Este endpoint é responsável por buscar XMLs de NFCes emitidas, utilizando alguns filtros.

  • Nossa API utiliza o 'cursor' como parâmetro para paginação. Para cada documento é atribuído um cursor que não muda com o tempo, sendo possível fazer o reprocessamento dos documentos resetando o cursor para 0.
  • O campo 'limit' define a quantidade de documentos retornados na resposta, sendo máximo 50. O padrão, caso não seja enviado, é sempre 50.
  • Campos created_at[from] e created_at[to] definem um range de buscar por datas em que a nota entrou na API - estes campos não se referem à data de emissão da nota e sim a sua criação na Qive.
  • Campo cnpj[] - utilizado para filtrar pelos CNPJs que são 'owner' do documento.
  • Campo access_key[] - permite filtrar por um conjunto de chaves de acesso. Example: GET /nfce/emitted?access_key[]=44charkey&limit=50
get/v1/nfce/emitted

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/nfce/emitted
  • Auth: none declared

Query parameters

limitinteger

Quantidade de XMLs retornados na resposta. Máximo 50 documentos. Caso não seja enviado, serão retornados 50 documentos.

cursorinteger

O cursor define a posição a partir da qual serão buscados os documentos. Este valor será retorno no campo data.page.next após uma requisição bem sucedida, com o valor do próximo cursor a ser buscado.

access_keystring[]

Filtrar uma lista de chaves de acesso. Exemplo de uso deste filtro: v1/nfce/emitted?access_key[]=44charKey

cnpjstring[]

Filtrar por uma lista de CNPJs ou CPFs. Examplo de uso deste filtro: v1/nfce/emitted?cnpj[]=34174654000153&cnpj[]=34174654000215

created_at[from]string

Filtrar por datas de criação da nota na API. Este campo é obrigatório quando o campo created_at[to] for utilizado. Examplo de uso = /v1/nfce/emitted?created_at[from]=2019-09-12 15:30:25&created_at[to]=2019-09-15 15:30:25. Pode ser utilizado datetime ou apenas date.

created_at[to]string

Filtrar por datas de criação da nota na API. Este campo é obrigatório quando o campo created_at[from] for utilizado. Examplo de uso = /v1/nfce/emitted?created_at[from]=2019-09-12 15:30:25&created_at[to]=2019-09-15 15:30:25. Pode ser utilizado datetime ou apenas date.

Response

Successful fetch

countinteger
signaturestring

Changes

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