API Engine Fiscal Manual da API Engine Fiscal - versão 1 - 15/02/2021 Introdução Este documento é destinado a parceiros que precisam enviar os documentos de seus clientes para validação. Além do envio padrão, através de um aplicativo que roda no ambiente do parceiro, que envia lotes de arquivos e baixa os retornos, o Engine Fiscal também pode ser acionado por meio de uma API. Acesso e autenticação Método, URL e autenticação da API. API REST/JSON Swagger https://enginefiscal.systax.com.br/api/index.html?urls.primaryName=Engine%20Fiscal%20Parceiros As API’s destinadas aos parceiros podem ser listadas separadamente, como visto na figura abaixo. Autenticação A autenticação é feita por meio de um token, enviado no header da requisição. O token poderá ser solicitado à equipe Systax responsável pelo atendimento. Deverá ser informado o campo Authorization, com o valor Basic , conforme demonstrado abaixo: Envio Informações sobre envio de arquivos NFe e EFD via API. Padrão de envio e recebimento de arquivos NFe Os arquivos de NFe deverão ser enviados em um arquivo compactado, com o nome que o parceiro desejar. Mas os arquivos deverão ser organizados em pastas nomeadas com o mês e o ano, segundo o padrão AAAAMM. No retorno, cada pasta será retornada como um arquivo de relatório separado, com o mesmo nome da pasta enviada AAAAMM. Se os arquivos não estiverem organizados conforme acima, serão devolvidos em uma pasta chamada “Outros”. EFD Os arquivos EFD contribuições e EFD fiscal deverão ser enviados em um arquivo compactado. Nesse arquivo poderão constar mais de um arquivo EFD e com o mesmo nome com que foram enviados, serão devolvidos no relatório. Envio de NFe POST https://enginefiscal.systax.com.br/api/LoteParceiro/parceiro/lote/nfe/{identificador} Dados da chamada: Identificador – Informado na URL, para controle do parceiro que está enviando os arquivos. File – Arquivo compactado contendo os arquivos para validação. Dados do retorno: errorMessage – Mensagem de erro, caso ocorra. success – true ou false Abaixo um exemplo de envio e retorno de arquivo contendo NFe’s: Envio de arquivos EFD É utilizado para o envio de arquivos EDF Fiscal, EFD Contribuições e SINTEGRA POST https://enginefiscal.systax.com.br/api/LoteParceiro/parceiro/lote/sped/ Dados da chamada: Identificador – Informado na URL, para controle do parceiro que está enviando os arquivos. File – Arquivo compactado contendo os arquivos para validação. Dados do retorno: errorMessage – Mensagem de erro, caso ocorra. success – true ou false Abaixo um exemplo de envio e retorno de arquivo contendo arquivos EFD: Relatórios Informações de manipulação dos relatórios gerados via API. Lista de relatórios produzidos GET https://enginefiscal.systax.com.br/api/LoteParceiro/parceiro/relatorio Dados da chamada: Nenhum Dados do retorno: arquivos – Lista contendo um par nome/valor, onde o valor é o nome representando o  grupo de informações enviado conforme definido no parágrafo “padrão de envio e recebimento de arquivos”. nome – Nome do arquivo enviado identificador – Identificador informado no envio. Abaixo um exemplo da lista de retornos: Os 10 relatórios mais antigos serão devolvidos, caso existam mais relatórios disponíveis, eles serão exibidos conforme os 10 primeiros forem sendo excluídos. A exclusão é uma ação do parceiro, que poderá excluir após a leitura de cada arquivo. A leitura interna dos arquivos ocorre uma vez ao dia, por tanto, os relatórios estarão disponíveis a partir do dia seguinte ao envio. Download do relatórios GET https://enginefiscal.systax.com.br/api/LoteParceiro/parceiro/relatorio/{name} Dados da chamada: name – Nome do arquivo retornado na lista de relatórios produzidos. Dados do retorno: O retorno será o arquivo CSV. Exclusão de relatórios DELETE https://enginefiscal.systax.com.br/api/LoteParceiro/parceiro/relatório/{name} Dados da chamada: name – Nome do relatório retornado na lista de relatórios produzidos. Dados do retorno: errorMessage – Mensagem de erro, caso ocorra. success – true ou false