Fiscal.io API Eventos de DFe
O objetivo deste procedimento é descrever o passo a passo para utilização da API responsável pela captura dos eventos registrados contra documentos fiscais.
Compra de crédito
Acessar a página de compra e adquirir créditos conforme volume de documentos que deseja consultar.
Nota: Caso tenha realizado uma negociação específica com o time comercial vá direto para o passo 2.
Acesso e Token de API
Passo 1 - Acessar aplicativo
Acessar o aplicativo app.fiscal.io e registrar um usuário e senha.
Utilize o mesmo e-mail do passo descrito em [Compra de crédito].
Passo 2 - Utilizar Token
Na parte superior da tela clique em API para utilizar o token de segurança.
Passo 3 - Conectar o sistema
Conecte o seu sistema na API e inicie a utilização da API conforme especificação abaixo.
A utilização da API deve ser feita de forma assíncrona. Para isto são disponibilizamos dois processos de consulta:
- Solicitação dos eventos;
- Consulta dos resultados.
1. Solicitação dos eventos
Neste processo de consulta informe o token no Header e passe a chave de acesso no corpo através do parâmetro "DFeKey" conforme exemplo abaixo.
Solicitação
- --header 'Basic: {Token}' \--header 'Content-Type: application/json' \--data-raw '{"DFeKey" : "{Chave de Acesso}"} '
Resposta em caso de sucesso
- {"taskId": "37","messsage": "Em processamento. Aguarde 10 segundos e consulte novamente."}
Resposta em caso de erros ou falta de créditos
- {"ERROR": ["Chave de acesso inválida"]}
2. Solicitação de resposta
Neste processo de consulta informe o token no Header e passe a "TaskId" conforme resposta da solicitação do processo de consulta 1 (solicitação dos eventos).
Solicitação
- curl --location --request GET 'https://api.fiscal.io/v1/dfekey/status/{TaskId}' \--header 'Basic: {Token}'
Resposta em caso de sucesso
- [{"chave": "31200792660604011974550500000540921748158329","tpEvento": "110100","nSeqEvento": "1","dtEmi": "2020.07.02","hrEmi": "\r\r:22:14","xEvento": "Autorização de Uso","dtAut": "2020.07.02","hrAut": "\r\r:22:14","protc": "131203732916059","cStat": "100","xMotivo": "Evento registrado e vinculado ao NFe","cnpj": null,"cOrgao": null,"xJust": null,"xObs": null},{"chave": "31200792660604011974550500000540921748158329","tpEvento": "210210","nSeqEvento": "1","dtEmi": "2020.07.02","hrEmi": "\r\r:22:36","xEvento": "Ciência da Operação pelo Destinatário (Órgão Autor: AN)","dtAut": "2020.07.02","hrAut": "\r\r:22:36","protc": "891202146420280","cStat": "135","xMotivo": "Evento registrado e vinculado a NF-e","cnpj": "92660604015457","cOrgao": "91","xJust": "","xObs": ""}]
Resposta em caso de erros ou falta de créditos
- {"9999": ["NOT_FOUND - Item 40 não encontrado.\n"]}
Na resposta com sucesso a API retorna a lista de eventos registrados contra o documento fiscal.
Informações fornecidas
As seguintes informações são disponibilizadas para cada evento:
Campo | Descrição | Mandatório/Opcional |
chave | Chave de acesso do documento fiscal | Mandatório |
tpEvento | Código do evento | Mandatório |
nSeqEvento | Sequencial do evento | Mandatório |
dtEmi | Data de emissão | Mandatório |
hrEmi | Hora de emissão | Mandatório |
xEvento | Descrição do evento | Mandatório |
dtAut | Data de autorização | Mandatório |
hrAut | Hora de autorização | Mandatório |
protc | Número do protocolo de autorização | Mandatório |
cStat | Código do status de autorização | Mandatório |
xMotivo | Motivo do evento | Opcional |
cnpj | CNPJ do parceiro que registrou o evento | Opcional |
cOrgao | Código IBGE do estado onde o evento foi registrado | Opcional |
xJust | Justificativa do evento | Opcional |
xObs | Observações registrados no evento | Opcional. |
As informações opcionais somente serão retornadas nos eventos que exigem tal informação durante seu registro na SEFAZ.
Consulta de créditos e extrato de consumo
Através da página principal do app.fiscal.io é possível consultar o saldo contratado e também os créditos utilizados.
Ao clicar sobre o campo [Utilizado] da tela acima, o sistema detalha como os créditos foram utilizados.
Related Articles
Eventos de documentos fiscais
O Fiscal.io Monitor é um sistema que monitora de hora em hora todos os documentos que foram emitidos contra as empresas que nele estão cadastradas e também os documentos emitidos por estas empresas. Isso inclui os documentos que chamamos de eventos. ...Como consultar o status dos documentos na SEFAZ através de seus eventos
É de suma importância para as empresas possuir relatórios alimentados com informações atualizadas sobre os seus documentos fiscais. No meio eletrônico, uma das informações mais importantes sobre os documentos fiscais são seus status perante a SEFAZ. ...Robô para transmissão de documentos Fiscal.io Cliente
O componente Fiscal.io Cliente é um programa desenvolvido pela Fiscal.io para ser instalado em uma máquina de empresa terceira, monitorar uma pasta ou tabelas de outro sistema e transmitir os XMLs de documentos de entrada ou de saída de forma ...Averbação de Exportação
O Fiscal.io Monitor proporciona redução de custos operacionais ao permitir a automação dos processos de confirmação fiscal de mercadorias exportadas. Essa automação é possível por meio da captura da Averbação de Exportação. A averbação de exportação ...Como monitorar os cancelamentos sobre documentos de entrada
O Fiscal.io Monitor está preparado para ajudar o setor logístico, fiscal e contábil reduzir o risco de contabilização de documentos cancelados através de uma automação simples. Como você fica sabendo quando um fornecedor cancela uma nota emitida ...