# API - Diagnóstico Fiscal

# Introdução

# Introdução

<span style="font-size: 14px;">Essa API tem por objetivo validar documentos fiscais e gerar um resultado em JSON.</span>

# Acesso

# Acesso

**Comunicação:** REST/JSON  
  
**Listagem dos Endpoints que contemplam o manual da API de Diagnóstico Fiscal**

<table border="2" id="bkmrk-descri%C3%A7%C3%A3o-vers%C3%A3o-m%C3%A9t"><thead><tr><th scope="col">Descrição

</th><th scope="col">Versão

</th><th scope="col">Método

</th><th scope="col">URL Endpoint

</th><th scope="col">URL Token

</th></tr></thead><tbody><tr><td><span style="font-size: 14px;">Importar os arquivos</span></td><td>v1

</td><td>Post

</td><td><span style="font-size: 14px;">https://api-gateway.systax.com.br/parceiros/  
api/diagnostico/upload  
\[?id\_empresa\]</span></td><td>[<span style="color: #000000;">https://app.systax  
.com.br/auth/  
access-token</span>](https://app.systax.com.br/auth/access-token)

</td></tr><tr><td>Listagem

</td><td>v1

</td><td>Get

</td><td><span style="font-size: 14px;">https://api-gateway.systax.com.br/parceiros/  
api/diagnostico/listar/{id\_empresa}/  
{offset}/{limit}</span></td><td>[<span style="color: #000000;">https://app.systax  
.com.br/auth  
/access-token</span>](https://app.systax.com.br/auth/access-token)

</td></tr><tr><td><span style="font-size: 14px;">Exibir o resultado da  
análise dos arquivos  
importados. </span></td><td>v1

</td><td>Post

</td><td><span style="font-size: 14px;"> https://api-gateway.systax.com.br/parceiros/  
api/diagnostico/relatorio/resultado  
\[?id\_empresa\]</span></td><td>[<span style="color: #000000;">https://app.systax  
.com.br/auth  
/access-token</span>](https://app.systax.com.br/auth/access-token)

</td></tr></tbody></table>

# Autenticação

# Autenticação

A autenticação nas API´s mencionadas nesse documento, é feita via bearer token.

# Descrição dos campos - API Upload

# Descrição dos campos de chamada - API Upload

<span style="font-size: 14px;"> O campo "id\_empresa" é passado como parâmetro na URL:</span>

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 500px;"><tbody><tr><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Campo**</span></td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**PAI**</span></td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Descrição**</span></td><td style="background-color: #dddddd; text-align: center;">**<span style="font-size: 14px;">Tipo</span>**</td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Obrigatório**</span></td></tr><tr><td style="text-align: center;"><span style="font-size: 14px;">id\_empresa</span></td><td style="text-align: center;"><span style="font-size: 14px;">/</span></td><td style="text-align: center;"><span style="font-size: 14px;">Código da empresa</span></td><td style="text-align: center;"><span style="font-size: 14px;">Inteiro</span></td><td style="text-align: center;"><span style="font-size: 14px;">Não</span></td></tr></tbody></table>

<span style="font-size: 14px;">No body da URL é feito a importação dos arquivos com o seguinte formato:</span>

- <span style="font-size: 14px;">**Arquivos NF-e**: é necessário que os arquivos sejam colocados dentro de uma pasta de nome "NFe" para serem compactados em extensão \*.zip.</span>
- <span style="font-size: 14px;">**Arquivos Sped**: é necessário que os arquivos sejam colocados dentro de uma pasta de nome "SPED" para serem compactados em extensão \*.zip. </span>

# Descrição dos campos de retorno - API Upload

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 864px;"><tbody><tr><td style="background-color: rgb(221, 221, 221); text-align: center; width: 170.217px;"><span style="font-size: 14px;">**Campo**</span></td><td style="background-color: rgb(221, 221, 221); text-align: center; width: 170.217px;"><span style="font-size: 14px;">**PAI**</span></td><td style="background-color: rgb(221, 221, 221); text-align: center; width: 170.217px;"><span style="font-size: 14px;">**Descrição**</span></td><td style="background-color: rgb(221, 221, 221); text-align: center; width: 170.217px;">**<span style="font-size: 14px;">Tipo</span>**</td></tr><tr><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">sucesso</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">Código do retorno</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">Boolean</span></td></tr><tr><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">mensagem</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">Mensagem do retorno</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">nome\_arquivo</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">dados</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">Identificador do arquivo importado (\*.zip)</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">status</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">dados</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">Status do processamento do arquivo (Uploading, Finalizado e Falha)</span></td><td style="text-align: center; width: 170.217px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 170.217px;">mensagem\_erro</td><td style="text-align: center; width: 170.217px;">dados</td><td style="text-align: center; width: 170.217px;">Caso tenha ocorrido algum, será informado aqui</td><td style="text-align: center; width: 170.217px;">String</td></tr><tr><td style="text-align: center; width: 170.217px;">config\_blob</td><td style="text-align: center; width: 170.217px;">dados</td><td style="text-align: center; width: 170.217px;">Indica a empresa que realizou o Upload dos arquivos</td><td style="text-align: center; width: 170.217px;">String</td></tr></tbody></table>

<span style="font-size: 14px;">**Tabela de referência para os campos "sucesso" e "mensagem":**</span>

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-de-retorno-su" style="width: 1158px;"><tbody><tr><td style="width: 206.967px;">**Código de retorno**</td><td style="width: 206.967px;">**Sucesso**</td><td style="width: 206.967px;">**Mensagem**</td><td style="width: 206.967px;">**Descrição**</td></tr><tr><td style="width: 206.967px;">201</td><td style="width: 206.967px;">true</td><td style="width: 206.967px;">null</td><td style="width: 206.967px;">Upload realizado com sucesso</td></tr><tr><td style="width: 206.967px;">401</td><td style="width: 206.967px;">false</td><td style="width: 206.967px;">Unauthorized</td><td style="width: 206.967px;">Token informado inválido, em branco ou expirado</td></tr><tr><td style="width: 206.967px;">400</td><td style="width: 206.967px;">false</td><td style="width: 206.967px;">Arquivo não encontrado</td><td style="width: 206.967px;">Arquivo para Upload não informado</td></tr></tbody></table>

# Exemplos de chamada - API Upload

<span style="font-size: 14px;">**Parâmetros da requisição:**</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/CArfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/CArfee.jpg)</span>

<span style="font-size: 14px;">**Corpo da requisição:** </span>

<span style="font-size: 14px;">**[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/Hiufee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/Hiufee.jpg)**</span>

# Exemplos de retorno - API Upload

{

 "sucesso": true,

 "mensagem": null,

 "dados": {

 "nome\_arquivo": "a5c9f73f-37a4-42b0-b933-58b2f2744f23.zip",

 "status": "Finalizado",

 "mensagem\_erro": null,

 "config\_blob": "empresateste"

 }

}

# Descrição dos campos de chamada - API de listagem

<span style="font-size: 14px;">Os campos "id\_empresa", "offset" e "limit" são passados como parâmetros na URL:</span>

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 500px;"><tbody><tr><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Campo**</span></td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**PAI**</span></td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Descrição**</span></td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Tipo**</span></td><td style="background-color: #dddddd; text-align: center;"><span style="font-size: 14px;">**Obrigatório**</span></td></tr><tr><td style="text-align: center;"><span style="font-size: 14px;">id\_empresa</span></td><td style="text-align: center;"><span style="font-size: 14px;">/</span></td><td style="text-align: center;"><span style="font-size: 14px;">Código da empresa</span></td><td style="text-align: center;"><span style="font-size: 14px;">Inteiro</span></td><td style="text-align: center;"><span style="font-size: 14px;">Sim</span></td></tr><tr><td style="text-align: center;"><span style="font-size: 14px;">offset</span></td><td style="text-align: center;"><span style="font-size: 14px;">/</span></td><td style="text-align: center;"><span style="font-size: 14px;">Deslocamento</span></td><td style="text-align: center;"><span style="font-size: 14px;">Inteiro</span></td><td style="text-align: center;"><span style="font-size: 14px;">Sim</span></td></tr><tr><td style="text-align: center;"><span style="font-size: 14px;">limit</span></td><td style="text-align: center;"><span style="font-size: 14px;">/</span></td><td style="text-align: center;"><span style="font-size: 14px;">Quantidade de registros por página</span></td><td style="text-align: center;"><span style="font-size: 14px;">Inteiro</span></td><td style="text-align: center;"><span style="font-size: 14px;">Sim</span></td></tr></tbody></table>

<span style="font-size: 14px;">"offset" e "limit" são usados na paginação do resultado da API e funcionam em conjunto da seguinte forma:</span>

<span style="font-size: 14px;">Exemplo de uma lista ordenada: </span>

<span style="font-size: 14px;">reg A</span>

<span style="font-size: 14px;">reg B</span>

<span style="font-size: 14px;">reg C</span>

<span style="font-size: 14px;">reg D</span>

<span style="font-size: 14px;">reg E</span>

<span style="font-size: 14px;">Se offset = 0 e limit=3 serão exibidos os registros: "reg A", "reg B" e "reg C";</span>

<span style="font-size: 14px;">Se offset = 1 e limit=3 serão exibidos os registros: "reg B", "reg C" e "reg D";</span>

<span style="font-size: 14px;">Se offset = 2 e limit=3 serão exibidos os registros: "reg C", "reg D" e "reg E";</span>

# Descrição dos campos de retorno - API de listagem

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o%C2%A0" style="height: 1px; width: 1054px;"><tbody><tr><td style="background-color: rgb(204, 204, 204); text-align: center; width: 193.967px;"><span style="font-size: 14px;">**Campo**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 193.967px;"><span style="font-size: 14px;">**PAI**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 193.967px;"><span style="font-size: 14px;">**Descrição** </span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 193.967px;"><span style="font-size: 14px;">**Tipo**</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">data</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">/</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">id\_config</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">data</span></td><td style="width: 193.967px;"><span style="font-size: 14px;">ID de consulta. Usado na consulta do resultado.</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">Int32</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">identificador</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">data</span></td><td style="width: 193.967px;"><span style="font-size: 14px;">Identificador do arquivo importado (\*.zip) </span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">status\_processamento</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">data</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">ArquivoRecebido: Quando o arquivo é recebido  
com sucesso pelo diagnóstico.</span>

<span style="font-size: 14px;">AguardandoProcessamento: Quando o arquivo recebido  
é enviado para iniciar processamento.  
  
LeituraArquivos: Informações dos XMLs sendo lidas para  
iniciar o processamento.  
  
SemArquivos: Quando o arquivo referente ao registro de processamento recebido não é encontrado ou foi eliminado  
após tentativas de processamento sem sucesso.   
  
Processando: Processando o diagnóstico (definição de perfil e agrupamento) </span>

<span style="font-size: 14px;">GerandoRelatorio: Cria a pasta com o relatório e o log dos itens processados, que é enviado por email/liberado para download.  
  
Finalizado: Processo finalizado e relatório gerado com sucesso.  
  
Erro: Quando ocorre algum erro interno no processamento por conta de diferenças no arquivo enviado ou problema com arquitetura.</span>

</td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">resultados</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">data</span></td><td style="width: 193.967px;"><span style="font-size: 14px;">Log de processamento dos arquivos (\*.zip)</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">success</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">/</span></td><td style="width: 193.967px;"><span style="font-size: 14px;">Status do retorno</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">Boolean</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">message</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">/</span></td><td style="width: 193.967px;"><span style="font-size: 14px;">Mensagem do retorno</span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">record\_count</span>

</td><td style="width: 193.967px;"><span style="font-size: 14px;">/</span></td><td style="width: 193.967px;"><span style="font-size: 14px;">Quantidade de registros retornados </span></td><td style="text-align: center; width: 193.967px;"><span style="font-size: 14px;">Int32</span></td></tr></tbody></table>

<span style="font-size: 14px;">**Tabela de referência para os campos "sucesso" e "mensagem":**</span>

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-de-retorno-su" style="width: 1156px;"><tbody><tr><td style="width: 206.717px;">**Código de retorno**</td><td style="width: 206.717px;">**Sucesso**</td><td style="width: 206.717px;">**Mensagem**</td><td style="width: 206.717px;">**Descrição**</td></tr><tr><td style="width: 206.717px;">200</td><td style="width: 206.717px;">true</td><td style="width: 206.717px;">null</td><td style="width: 206.717px;">Listagem realizada com sucesso</td></tr><tr><td style="width: 206.717px;">401</td><td style="width: 206.717px;">false</td><td style="width: 206.717px;">Unauthorized</td><td style="width: 206.717px;">Token informado inválido, em branco ou expirado</td></tr></tbody></table>

# Exemplos de chamada - API de listagem

**<span style="font-size: 14px;">Parâmetros da requisição:</span>**

**[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/BG7fee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/BG7fee.jpg)**

# Exemplos de retorno - API de listagem

<span style="font-size: 14px;"> {  
 "id\_config": 202550,  
 "identificador": "1ffffa76-f812-4f43-a31d-6a14239acd3b.zip",  
 "status\_processamento": "Finalizado",  
 "resultados": "https://enginefiscal.blob.core.windows.net/produtos/relatorios/202550-1ffffa76-f812-4f43-a31d-6a14239acd3b.zip-05-25-2021-134242.zip?sv=2019-02-02&amp;sr=b&amp;sig=vILQL7D5F78uTJnQ0sppE4LGX68OzmEoWlYzxfGGlgU%3D&amp;st=2021-05-25T13%3A37%3A44Z&amp;se=2024-02-19T13%3A42%3A44Z&amp;sp=r"  
 }</span>

# Descrição dos campos de chamada - API de resultado

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 1002px;"><tbody><tr><td style="background-color: rgb(204, 204, 204); text-align: center; width: 149.967px;"><span style="font-size: 14px;">**Campo**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 149.967px;"><span style="font-size: 14px;">**PAI**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 149.967px;"><span style="font-size: 14px;">**Descrição**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 149.967px;">**<span style="font-size: 14px;">Tipo</span>**</td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 149.967px;"><span style="font-size: 14px;">**Obrigatório**</span></td></tr><tr><td style="width: 149.967px;"><span style="font-size: 14px;">id\_empresa</span>

</td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Código da empresa</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Inteiro</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Não</span></td></tr><tr><td style="width: 149.967px;"><span style="font-size: 14px;">id\_config</span>

</td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">ID da consulta (gerado no retorno da API de listagem)</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Inteiro</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Não</span></td></tr><tr><td style="width: 149.967px;"><span style="font-size: 14px;">continuation\_token</span>

</td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Ponteiro utilizado para paginação. Enviar vazio na primeira consulta.</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">String</span></td><td style="text-align: center; width: 149.967px;"><span style="font-size: 14px;">Não</span></td></tr></tbody></table>

# Descrição dos campos de retorno - API de resultado

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 1098px;"><tbody><tr><td style="background-color: rgb(204, 204, 204); text-align: center; width: 199.467px;"><span style="font-size: 14px;">**Campo**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 199.467px;"><span style="font-size: 14px;">**PAI**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 199.467px;"><span style="font-size: 14px;">**Descrição**</span></td><td style="background-color: rgb(204, 204, 204); text-align: center; width: 199.467px;"><span style="font-size: 14px;">**Tipo**</span></td></tr><tr><td style="width: 199.467px;"><span style="font-size: 14px;">continuationToken</span>

</td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Ponteiro utilizado para paginação</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="width: 199.467px;"><span style="font-size: 14px;">data</span>

</td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Resultado em formato JSON</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">/</span></td></tr><tr><td style="width: 199.467px;"><span style="font-size: 14px;">success</span>

</td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Status do retorno</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Boolean</span></td></tr><tr><td style="width: 199.467px;"><span style="font-size: 14px;">message</span>

</td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Mensagem do retorno</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">String</span></td></tr><tr><td style="width: 199.467px;"><span style="font-size: 14px;">record\_count</span>

</td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">/</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Quantidade de registros retornados</span></td><td style="text-align: center; width: 199.467px;"><span style="font-size: 14px;">Int32</span></td></tr></tbody></table>

<span style="font-size: 14px;">**Tabela de referência para os campos "success" e "message":**</span>

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-de-retorno-su"><tbody><tr><td>**Código de retorno**</td><td>**Sucesso**</td><td>**Mensagem**</td><td>**Descrição**</td></tr><tr><td>200</td><td>true</td><td>null</td><td>Resultado gerado com sucesso</td></tr><tr><td>401</td><td>false</td><td>Unauthorized</td><td>Token informado inválido, em branco ou expirado</td></tr></tbody></table>

<span style="font-size: 14px;">**Detalhamento do resultado:**</span>

<span style="font-size: 14px;">Dos campos "id" até "extipi" constam os dados do cliente e a definição de perfil nas primeiras colunas:</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/daJfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/daJfee.jpg)</span>

<span style="font-size: 14px;">Dos campos "nat\_op" até "finalidade" constam os dados do cenário gerado á partir da definição dos perfis:</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/BWGfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/BWGfee.jpg)</span>

<span style="font-size: 14px;">Dos campos "xProd" até "vOutro" também são relativos aos documentos do cliente, dados e valores dos produtos:</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/eNSfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/eNSfee.jpg)</span>

<span style="font-size: 14px;">A partir do campos "nfE\_CFOP" as informações são intercaladas sendo sempre “Cliente” – “Systax”. Todas as colunas com nome que se inicia com "nFe" são do cliente, e todas as colunas com nome que se inicia com "tax", são informações da regra Systax:</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/1Dhfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/1Dhfee.jpg)</span>

<span style="font-size: 14px;">No início de cada bloco de tributo, existe um campo que indica quais campos tiveram divergências (diferenças\_ICMS, diferenças\_PIS, diferenças\_COFINS e diferenças\_IPI). No exemplo abaixo os campos "CST" e "cEnq" possuem diferenças no bloco do IPI, e por isso, foram informados no campo "Diferenças\_IPI":</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/JYbfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/JYbfee.jpg)</span>

<span style="font-size: 14px;">No final de cada bloco de tributo, existe um campo que informa o valor da diferença encontrada. Essa diferença é gerada comparando o valor do tributo do documento do cliente e o valor do tributo gerado pela Systax. No exemplo abaixo, caso houvesse diferenças no bloco do IPI, seria exibida no campo "valor\_diferença\_IPI": </span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/iMJfee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/iMJfee.jpg)</span>

# Exemplos de chamada - API de resultado

<span style="font-size: 14px;">**Corpo da requisição:**</span>

<span style="font-size: 14px;">[![fee.jpg](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/cV1fee.jpg)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/cV1fee.jpg)</span>

# Exemplos de retorno - API de resultado

<span style="font-size: 14px;">{  
 "continuationToken": null,  
 "data": \[  
 {  
 "id": "1f4232dd-330c-4c49-bebf-bc5b1f649602",  
 "id\_nfe": 1,  
 "id\_item": 1,  
 "id\_lote": 78536,  
 "lote\_nome": "Outros",  
 "id\_config": 203002,  
 "session\_Engine": null,  
 "chave": "35210557489403000163550060001234031571430860 ",  
 "id\_linha": null,  
 "cnpj\_emit": "57489403000163",  
 "cnpj\_dest": "00636695956 ",  
 "emit\_dest": null,  
 "nFe\_dhEmi": "2021-05-17T00:00:00",  
 "entSai": "1",  
 "ufOrig": "SP",  
 "ufDest": "PR",  
 "mod": "55",  
 "indFinal": "1",  
 "crt\_emit": "3",  
 "mun\_emit": "3547809",  
 "mun\_dest": "4115200",  
 "valor\_item": 34.8700,  
 "sn": "N",  
 "ean": "SEM GTIN",  
 "orig": "2",  
 "ncm": "40169990",  
 "extipi": "",  
 "nat\_op": "121",  
 "perfRem": "3",  
 "perfDest": "6",  
 "finalidade": null,  
 "xProd": "ANTI VIBRADOR HEAD SMARTSORB",  
 "qTrib": 3.0000,  
 "cProd": "060280",  
 "uCom": "UND",  
 "qCom": "3.0000",  
 "vUnCom": "34.8700000000",  
 "uTrib": "UND",  
 "vFrete": null,  
 "vSeg": null,  
 "vDesc": null,  
 "vOutro": null,  
 "nfE\_CFOP": "6108",  
 "taX\_CFOP": "6108",  
 "nFe\_CEST": null,  
 "tax\_CEST": null,  
 "nFe\_cBenef": null,  
 "tax\_cBenef": null,  
 "diferencas\_ICMS": "",  
 "nFe\_ICMS\_CST": "00",  
 "tax\_ICMS\_CST": "00",  
 "nFe\_ICMS\_modBC": "3",  
 "tax\_ICMS\_modBC": "3",  
 "nFe\_ICMS\_modBCST": null,  
 "tax\_ICMS\_modBCST": null,  
 "nFe\_ICMS\_motDesICMS": null,  
 "tax\_ICMS\_motDesICMS": null,  
 "nFe\_ICMS\_pDif": 0.0,  
 "tax\_ICMS\_pDif": 0.0,  
 "nFe\_ICMS\_pICMS": 4.0000,  
 "tax\_ICMS\_pICMS": 4.0000,  
 "nFe\_ICMS\_pICMSST": 0.0,  
 "tax\_ICMS\_pICMSST": 0.0,  
 "nFe\_ICMS\_pMVAST": 0.0,  
 "tax\_ICMS\_pMVAST": 0.0,  
 "nFe\_ICMS\_pRedBC": 0.0,  
 "tax\_ICMS\_pRedBC": 0.0,  
 "nFe\_ICMS\_pRedBCST": 0.0,  
 "tax\_ICMS\_pRedBCST": 0.0,  
 "nFe\_ICMS\_vBC": 104.61,  
 "tax\_ICMS\_vBC": 104.61,  
 "nFe\_ICMS\_vBCST": 0.0,  
 "tax\_ICMS\_vBCST": 0.0,  
 "nFe\_ICMS\_vICMS": 4.18,  
 "tax\_ICMS\_vICMS": 4.18,  
 "nFe\_ICMS\_pFCP": 0.0,  
 "tax\_ICMS\_pFCP": 0.0,  
 "nFe\_ICMS\_vBCFCP": 0.0,  
 "tax\_ICMS\_vBCFCP": 0.0,  
 "nFe\_ICMS\_vFCP": 0.0,  
 "tax\_ICMS\_vFCP": 0.0,  
 "valor\_diferenca\_ICMS": 0.00,  
 "nFe\_ICMS\_vICMSDeson": 0.0,  
 "tax\_ICMS\_vICMSDeson": 0.0,  
 "nFe\_ICMS\_vICMSDif": 0.0,  
 "tax\_ICMS\_vICMSDif": 0.0,  
 "nFe\_ICMS\_vICMSOp": 0.0,  
 "tax\_ICMS\_vICMSOp": 0.0,  
 "nFe\_ICMS\_vICMSST": 0.0,  
 "tax\_ICMS\_vICMSST": 0.0,  
 "nFe\_ICMS\_pFCPST": 0.0,  
 "tax\_ICMS\_pFCPST": 0.0,  
 "nFe\_ICMS\_vBCFCPST": 0.0,  
 "tax\_ICMS\_vBCFCPST": 0.0,  
 "nFe\_ICMS\_vFCPST": 0.0,  
 "tax\_ICMS\_vFCPST": 0.0,  
 "valor\_diferenca\_ICMS\_ST": 0.0,  
 "diferencas\_PIS": "",  
 "nfe\_PIS\_CST": "01",  
 "tax\_PIS\_CST": "01",  
 "nfe\_PIS\_vBC": 104.61,  
 "tax\_PIS\_vBC": 104.61,  
 "nfe\_PIS\_pPIS": 1.6500,  
 "tax\_PIS\_pPIS": 1.6500,  
 "nfe\_PIS\_qBCProd": 0.000,  
 "tax\_PIS\_qBCProd": 0.000,  
 "nfe\_PIS\_vAliqProd": 0.0,  
 "tax\_PIS\_vAliqProd": 0.0,  
 "nfe\_PIS\_vPIS": 1.73,  
 "tax\_PIS\_vPIS": 1.73,  
 "valor\_diferenca\_PIS": 0.00,  
 "diferencas\_COFINS": "",  
 "nFe\_COFINS\_CST": "01",  
 "tax\_COFINS\_CST": "01",  
 "nFe\_COFINS\_vBC": 104.61,  
 "tax\_COFINS\_vBC": 104.61,  
 "nFe\_COFINS\_pCOFINS": 7.6000,  
 "tax\_COFINS\_pCOFINS": 7.6000,  
 "nFe\_COFINS\_qBCProd": 0.000,  
 "tax\_COFINS\_qBCProd": 0.000,  
 "nFe\_COFINS\_vAliqProd": 0.0,  
 "tax\_COFINS\_vAliqProd": 0.0,  
 "nFe\_COFINS\_vCOFINS": 7.95,  
 "tax\_COFINS\_vCOFINS": 7.95,  
 "valor\_diferenca\_COFINS": 0.00,  
 "diferencas\_IPI": "CST, cEnq",  
 "nFe\_IPI\_CST": "99",  
 "tax\_IPI\_CST": "53",  
 "nFe\_IPI\_cEnq": "340",  
 "tax\_IPI\_cEnq": "999",  
 "nFe\_IPI\_vBC": 0.0,  
 "tax\_IPI\_vBC": 0.0,  
 "nFe\_IPI\_pIPI": 0.0000,  
 "tax\_IPI\_pIPI": 0.000,  
 "nFe\_IPI\_qUnid": 0.000,  
 "tax\_IPI\_qUnid": 0.000,  
 "nFe\_IPI\_vUnid": 0.0,  
 "tax\_IPI\_vUnid": 0.0,  
 "nFe\_IPI\_vIPI": 0.0,  
 "tax\_IPI\_vIPI": 0.0,  
 "valor\_diferenca\_IPI": 0.0,  
 "tax\_NCM": "40169990",  
 "dispositivo\_Legal\_ICMS": "art. 37, I, e § 1º do RICMS/SP. Resolução do Senado Federal nº 13/2012 e Art. 52, § 2º, 1, \\"a\\" e \\"b\\", do RICMS/SP",  
 "dispositivo\_Legal\_IPI": "Art. 35 do RIPI/2010",  
 "dispositivo\_Legal\_PIS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002",  
 "dispositivo\_Legal\_COFINS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",  
 "dispositivo\_Legal\_Antecipacao": null,  
 "dispositivo\_Legal\_Credito": null,  
 "dispositivo\_Legal\_Credito\_ICMS": null,  
 "dispositivo\_Legal\_Credito\_IPI": null,  
 "dispositivo\_Legal\_Credito\_PIS": null,  
 "dispositivo\_Legal\_Credito\_COFINS": null,  
 "dispositivo\_Legal\_UFDest": "Art. 8º, I e §1º do RICMS/PR , Art. 17, V, do RICMS/PR",  
 "vProdOriginal": 104.6100,  
 "origem\_regra": "NCM",  
 "numero\_nfe": "123403",  
 "serie\_nfe": "006",  
 "diferencas\_ICMSUFDest": "",  
 "tax\_vBCUFDest": 104.61,  
 "tax\_vBCFCPUFDest": 0.0,  
 "tax\_pFCPUFDest": 0.0,  
 "tax\_pICMSUFDest": 18.0000,  
 "tax\_pICMSInter": 4.00,  
 "tax\_pICMSInterPart": 100.0000,  
 "tax\_vFCPUFDest": 0.0,  
 "tax\_vICMSUFDest": 14.65,  
 "tax\_vICMSUFRemet": 0.00,  
 "tax\_pRedBC\_UFDest": 0.0,  
 "nFe\_vBCUFDest": 104.61,  
 "nFe\_vBCFCPUFDest": 0.0,  
 "nFe\_pFCPUFDest": 0.0,  
 "nFe\_pICMSUFDest": 18.0000,  
 "nFe\_pICMSInter": 4.00,  
 "nFe\_pICMSInterPart": 100.0000,  
 "nFe\_vFCPUFDest": 0.0,  
 "nFe\_vICMSUFDest": 14.65,  
 "nFe\_vICMSUFRemet": 0.0,  
 "valor\_diferenca\_vFCPUFDest": 0.0,  
 "valor\_diferenca\_vICMSUFDest": 0.00,  
 "valor\_diferenca\_vICMSUFRemet": 0.00,  
 "statusFinal": "GeradoRelatorio",  
 "divergente": true  
 }  
 \],  
 "success": true,  
 "message": null,  
 "record\_count": null  
}</span>