NFe

Busca os XMLs de todos os eventos de NFe da conta

Este endpoint é responsável por realizar a busca dos XMLs de todos os eventos NFe da conta autenticada, retornados em base64.

  • 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.
  • Campo 'type' represenha o tipo de evento, de acordo com a documentação da SEFAZ.
get/v1/events/nfe

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/events/nfe
  • Auth: none declared

Query parameters

access_keystring[]

Uma lista de chaves de acessos de NFe. Exemplo: /v1/events/nfe?access_key[]=44charKey

typestring[]

Um Array com os tipos de eventos a serem filtrados. Cada tipo de evento é uma string de 6 dígitos string, exemplo: /v1/events/nfe?type[]=110111&type[]=110110' Existem diversos tipos de evento, sendo o principal utilizado tipo 110111, para Cancelamento de uma NFe

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.

Response

Successful fetch

countinteger
signaturestring

Example response

{
  "data": [
    {
      "access_key": "11223344556677889900112233445566778899001122",
      "type": "210210",
      "xml": "SXNzbyBuw6NvIMOpIHVtIGV2ZW50byBkZSBORmUh"
    }
  ]
}

Changes

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