Como enviar registro de escrituração de documentos fiscais via API para o Fiscal.io Monitor
O objetivo deste procedimento é explicar de forma detalhada como usar a API pública da Fiscal.io para envio dos registros de escriturações dos documentos fiscais em softwares externos para o Fiscal.io Monitor.
O que é a API publica do Fiscal.io Monitor?
A API pública é um canal de integração que permite a envio de escriturações de outros sistemas para um ambiente onde esteja instalado o Fiscal.io Monitor seguindo rígidas normas e práticas de autorização de acesso.
Quem deve utilizar esta API?
Empresas ou softwares houses que desejem enviar registros de escrituração para uma instalação do Fiscal.io Monitor.
Ativação da API na assinatura
Acessar a assinatura no site https://app.fiscal.io e cadastrar um endereço de email que servirá de referência para a conexão via API.
Importante: Toda a comunicação será realizada via API e protocolo HTTPS, o e-mail é apenas uma referência para identificação da assinatura e também para definir qual instalação do Fiscal.io Monitor irá receber os registros.
Nota: Este passo pode ser feito pelo time de suporte da Fiscal.io ou pelo próprio cliente.Vinculação da API ao Fiscal.io Monitor ou Fiscal.io Server
Após criar o e mail, vincule o e-mail a máquina onde está instalado o "Fiscal.io Server" que será responsável por receber os documentos, validar e logo após gravar no banco de dados da centralizado dos usuários.
Notas:
Caso ainda não tenha instalado o Fiscal.io Monitor, deixe para executar este passo em momento posterior.
Este passo pode ser feito pelo time de suporte da Fiscal.io ou pelo próprio cliente.
Obtenção de Token de autenticação
O cliente deverá acessar o site https://app.fiscal.io/Api/Edit e obter o token de autenticação da API conforme tela abaixo.
Nota: Este passo deve ser executado exclusivamente pelo cliente utilizando um e-mail que esteja vinculado a licença do Fiscal.io Monitor
Exemplo prático de utilização da API
Após obter o token de autorização, o envio dos registros para a API deverá ser feito conforme instruções abaixo.
O trecho {email-doc-fiscal} deve ser trocado pelo e-mail cadastrado no passo 01.
A requisição é feita utilizando o método POST.
Além disso deve ser passado no header da requisição o token de autenticação obtido no passo 03.
O Token deve ser passado pelo header Authorization, passando o valor basic+ token, conforme exemplo abaixo do Postman.
O corpo da requisição deverá seguir o modelo abaixo. O formato deverá ser JSON.
Chave: Chave do documento fiscal escriturado;
Filial: Em qual CNPJ ou CPF o documento fiscal foi escriturado no software externo;
DataRegistro: Data de registro do documento fiscal. Formato : AAAA-MM-DD;
UsuarioRegistro: Nome ou Identificador do usuário que fez o registro do documento fiscal;
DataLancamento: Data de lançamento que documento fiscal será reconhecido no SPED ou Contabilidade. Formato : AAAA-MM-DD;
NumDocumento: Numero identificador do documento no software externo. (Opcional);
ConfirmarOperacao: Confirmação de operação deverá ser registra na SEFAZ pelo Fiscal.io Monitor. (X -> Sim, Vazio -> Não). (Opcional);
Exemplo de utilização da API em cURL
curl --location -g --request GET 'https://api.fiscal.io/v1/client/queuebook/postdata/email/{email-doc-fiscal}' \
--header 'Authorization: basic 68313c91---------------------------' \
--header 'Content-Type: application/json' \
--data-raw '{
"Chave" : "chave-de-acesso-documento",
"Filial" : "cnpj ou cpf",
"DataRegistro" : "2022-08-15",
"UsuarioRegistro" : "JoseAntonio",
"DataLancamento" : "2022-08-15",
"NumDocumento" : "001231312",
"ConfirmarOperacao" : "X",
}
Como visualizar registros enviados para a API
Acessar a assinatura no site https://app.fiscal.io e clicar sobre a opção "Api: Regs" conforme figura abaixo.
Este opção mostrará os 10 primeiros registros armazenados na API e que ainda estão pendentes de integração com o Fiscal.io Monitor.
Related Articles
Como enviar xmls via API para o Fiscal.io Monitor
O objetivo deste procedimento é explicar de forma detalhada como usar a API pública da Fiscal.io para envio de XMLs de documentos fiscais e eventos para um ambiente onde esteja instalado o Fiscal.io Monitor. O que é a API publica do Fiscal.io ...Fiscal.io Connect: Como integrar o Fiscal.io Monitor com seu sistema de gestão
O Fiscal.io Monitor é completo com automações para ajudar os processos fiscais, contábeis e logísticos da empresas. O objetivo é eliminar processos manuais salvando tempo e esforço dos colaboradores, assim como garantir conformidade fiscal mitigando ...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 ...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 ...Como aumentar 20 vezes a performance do Fiscal.io Monitor ativando SQL Server Monousuário (LocalDB)
O Fiscal.io Monitor utiliza como padrão o software de banco de dados SqlLite, porém este software começa a perder desempenho quando se tem muitas empresas ou muitos arquivos XML gerenciados pelo Fiscal.io Monitor. O Fiscal.o Monitor é um software ...