Documentação da API

Introdução

A API Eficiência Fiscal pode ser utilizada por nossos clientes para realizar o download de arquivos ZIP contendo os XMLs de suas notas fiscais.

A API é acessada através da URL https://api-externa.eficienciafiscal.com.br.

Autenticação

A autenticação é feita através de um token que deve ser enviado no cabeçalho Authorization da requisição. Por exemplo, se o seu token de autorização é eyjgk512yax..., você deve enviar o cabeçalho da seguinte maneira:

              
Authorization: Bearer eyjgk512yax...

Endereços disponíveis

GET /chaves

Através desse endereço, você pode obter a lista das chaves das suas notas fiscais disponíveis no Eficiência Fiscal. Dessa forma, você pode comparar com as chaves das notas que já baixou e evitar o download repetido de XMLs.

O endereço pode ser consultado da seguinte maneira:

            
GET https://api-externa.eficienciafiscal.com.br/chaves?cnpjs[]=102030000112&cnpjs[]=102030000101&data_inicial=2021-01-01&data_final=2021-01-31&emissao=saida

Exemplo de retorno:

            
[
    "112...409",
    "112...751",
    "112...321",
    "112...932"
]

GET /canceladas

Através desse endereço, você pode obter a lista das chaves das suas notas fiscais canceladas.

O endereço pode ser consultado da seguinte maneira (observe que não é necessário o parâmetro tipo_emissao):

            
GET https://api-externa.eficienciafiscal.com.br/chaves?cnpjs[]=102030000112&cnpjs[]=102030000101&data_inicial=2021-01-01&data_final=2021-01-31

Exemplo de retorno:

            
[
    "112...409",
    "112...751",
    "112...321",
    "112...932"
]

GET /nfes

Através desse endereço, você pode realizar o download de um arquivo ZIP com as suas notas fiscais para o período informado.

O endereço pode ser consultado da seguinte maneira:

            
      GET https://api-externa.eficienciafiscal.com.br/nfes?cnpjs[]=102030000112&cnpjs[]=102030000101&data_inicial=2021-01-01&data_final=2021-01-31&emissao=entrada

O retorno é um arquivo ZIP contendo os XMLs encontrados.

POST /nfes

Esse endereço é semelhante ao GET /nfes, mas aqui você pode buscar as notas pelas chaves obtidas, por exemplo, no endereço GET /chaves

O endereço pode ser consultado da seguinte maneira:

            
POST https://api-externa.eficienciafiscal.com.br/nfes
Content-Type: application/json

{
  chaves: ["112...512", "112...612", "112..821"]
}

O retorno é um arquivo ZIP contendo os XMLs encontrados.

Introdução
Autenticação
Endereços disponíveis