Descrição dos campos - API Upload
- Descrição dos campos de chamada - API Upload
- Descrição dos campos de retorno - API Upload
- Exemplos de chamada - API Upload
- Exemplos de retorno - API Upload
- Descrição dos campos de chamada - API de listagem
- Descrição dos campos de retorno - API de listagem
- Exemplos de chamada - API de listagem
- Exemplos de retorno - API de listagem
- Descrição dos campos de chamada - API de resultado
- Descrição dos campos de retorno - API de resultado
- Exemplos de chamada - API de resultado
- Exemplos de retorno - API de resultado
Descrição dos campos de chamada - API Upload
O campo "id_empresa" é passado como parâmetro na URL:
| Campo | PAI | Descrição | Tipo | Obrigatório |
| id_empresa | / | Código da empresa | Inteiro | Não |
No body da URL é feito a importação dos arquivos com o seguinte formato:
- Arquivos NF-e: é necessário que os arquivos sejam colocados dentro de uma pasta de nome "NFe" para serem compactados em extensão *.zip.
- Arquivos Sped: é necessário que os arquivos sejam colocados dentro de uma pasta de nome "SPED" para serem compactados em extensão *.zip.
Descrição dos campos de retorno - API Upload
| Campo | PAI | Descrição | Tipo |
| sucesso | / | Código do retorno | Boolean |
| mensagem | / | Mensagem do retorno | String |
| nome_arquivo | dados | Identificador do arquivo importado (*.zip) | String |
| status | dados | Status do processamento do arquivo (Uploading, Finalizado e Falha) | String |
| mensagem_erro | dados | Caso tenha ocorrido algum, será informado aqui | String |
| config_blob | dados | Indica a empresa que realizou o Upload dos arquivos | String |
Tabela de referência para os campos "sucesso" e "mensagem":
| Código de retorno | Sucesso | Mensagem | Descrição |
| 201 | true | null | Upload realizado com sucesso |
| 401 | false | Unauthorized | Token informado inválido, em branco ou expirado |
| 400 | false | Arquivo não encontrado | Arquivo para Upload não informado |
Exemplos de chamada - API Upload
Parâmetros da requisição:
Corpo da requisição:
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
Os campos "id_empresa", "offset" e "limit" são passados como parâmetros na URL:
| Campo | PAI | Descrição | Tipo | Obrigatório |
| id_empresa | / | Código da empresa | Inteiro | Sim |
| offset | / | Deslocamento | Inteiro | Sim |
| limit | / | Quantidade de registros por página | Inteiro | Sim |
"offset" e "limit" são usados na paginação do resultado da API e funcionam em conjunto da seguinte forma:
Exemplo de uma lista ordenada:
reg A
reg B
reg C
reg D
reg E
Se offset = 0 e limit=3 serão exibidos os registros: "reg A", "reg B" e "reg C";
Se offset = 1 e limit=3 serão exibidos os registros: "reg B", "reg C" e "reg D";
Se offset = 2 e limit=3 serão exibidos os registros: "reg C", "reg D" e "reg E";
Descrição dos campos de retorno - API de listagem
| Campo | PAI | Descrição | Tipo |
| data | / | / | / |
|
id_config |
data | ID de consulta. Usado na consulta do resultado. | Int32 |
|
identificador |
data | Identificador do arquivo importado (*.zip) | String |
|
status_processamento |
data |
ArquivoRecebido: Quando o arquivo é recebido AguardandoProcessamento: Quando o arquivo recebido GerandoRelatorio: Cria a pasta com o relatório e o log dos itens processados, que é enviado por email/liberado para download. |
String |
|
resultados |
data | Log de processamento dos arquivos (*.zip) | String |
|
success |
/ | Status do retorno | Boolean |
|
message |
/ | Mensagem do retorno | String |
|
record_count |
/ | Quantidade de registros retornados | Int32 |
Tabela de referência para os campos "sucesso" e "mensagem":
| Código de retorno | Sucesso | Mensagem | Descrição |
| 200 | true | null | Listagem realizada com sucesso |
| 401 | false | Unauthorized | Token informado inválido, em branco ou expirado |
Exemplos de chamada - API de listagem
Parâmetros da requisição:
Exemplos de retorno - API de listagem
{
"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&sr=b&sig=vILQL7D5F78uTJnQ0sppE4LGX68OzmEoWlYzxfGGlgU%3D&st=2021-05-25T13%3A37%3A44Z&se=2024-02-19T13%3A42%3A44Z&sp=r"
}
Descrição dos campos de chamada - API de resultado
| Campo | PAI | Descrição | Tipo | Obrigatório |
|
id_empresa |
/ | Código da empresa | Inteiro | Não |
|
id_config |
/ | ID da consulta (gerado no retorno da API de listagem) | Inteiro | Não |
|
continuation_token |
/ | Ponteiro utilizado para paginação. Enviar vazio na primeira consulta. | String | Não |
Descrição dos campos de retorno - API de resultado
| Campo | PAI | Descrição | Tipo |
|
continuationToken |
/ | Ponteiro utilizado para paginação | String |
|
data |
/ | Resultado em formato JSON | / |
|
success |
/ | Status do retorno | Boolean |
|
message |
/ | Mensagem do retorno | String |
|
record_count |
/ | Quantidade de registros retornados | Int32 |
Tabela de referência para os campos "success" e "message":
| Código de retorno | Sucesso | Mensagem | Descrição |
| 200 | true | null | Resultado gerado com sucesso |
| 401 | false | Unauthorized | Token informado inválido, em branco ou expirado |
Detalhamento do resultado:
Dos campos "id" até "extipi" constam os dados do cliente e a definição de perfil nas primeiras colunas:
Dos campos "nat_op" até "finalidade" constam os dados do cenário gerado á partir da definição dos perfis:
Dos campos "xProd" até "vOutro" também são relativos aos documentos do cliente, dados e valores dos produtos:
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:
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":
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":
Exemplos de chamada - API de resultado
Corpo da requisição:
Exemplos de retorno - API de resultado
{
"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
}