Comparativo de compras
- Introdução
- Acessos
- Chamada
- Retorno
- Dicionário de dados
- Fórmulas para Cálculo dos Tributos
- Tabelas Auxiliares
Introdução
Comparativo de compras é uma ferramenta que tem como objetivo indicar o melhor custo de aquisição nas operações de compras das empresas. Viabiliza um melhor planejamento de compras, pois em uma única consulta, há a possibilidade de pesquisa de diversos fornecedores e produtos tendo como retorno a indicação do melhor custo de aquisição.
Sobre o Comparativo de Compras
O Comparativo de compras é uma ferramenta em forma de webapi/JSON que facilita a integração com outros sistemas.
A chamada na ferramenta possui 4 grupos de informações:
- Cabeçalho: informações pertinentes ao cliente que está fazendo a consulta, como usuário, senha e data da consulta;
- Dados do produto: nesse item são indicados os dados do produto que será consultado, como código do produto, CEAN, NCM e origem do produto;
- Perfil do destino: indicado nesse item os dados do comprador, como: perfil, uf e finalidade da compra. Nesse caso também é possivel fazer a chamada com mais de um perfil de destino, consultando assim qual o melhor custo de aquisição de acordo com o destino indicado;
- Perfil de origem: são as indicações dos fornecedores, onde é informado o perfil de origem, a natureza de operação e a uf de localização, podendo nesse caso ser indicado mais de um fornecedor por consulta;
Em uma única chamada é possível indicar diversos produtos, assim como mais de um destinatário e mais de um fornecedor, sendo:
- Perfil de origem (fornecedores): no mínimo 2 e no máximo 5 indicações;
- Perfil destino (compradores ou apenas destinatário): no mínimo 1 e no máximo 2;
Para isso basta repetir na chamada, dentro das listas, os grupos de informações do “DadosProdutos”, "perfil destino" e “perfil origem”.
Acessos
O acesso á API é feito através da url:
Swagger: https://wscockpit.systax.com.br/TaxEngineRest/swagger/ui/index#!/Comparador/Comparador_Post
API Rest / JSON: https://wscockpit.systax.com.br/TaxEngineRest/api/Comparador
A autenticação da API é feita por meios de credenciais de usuário e senha fornecidos pela Systax.
Chamada
Aqui veremos todos pontos da chamada, como definições, estruturas e exemplos para serem utilizados como base.
Definições da Chamada
Na chamada deve sempre ser indicado um produto, os dados do destinatário/comprador e aos menos 2 fornecedores diferentes (remetente) para que a solução tenha parâmetros para apontar qual fornecedor tem o melhor custo para aquisição.
Diferenciais: 1. Cálculo “onDemand” e 2. Consulta por valor de compra ou valor de custo
1. Cálculo onDemand:
O produto pode ser um existente na base do cliente ou ainda um produto novo ou desconhecido, onde nessa condição, a ferramenta fará uma consulta online com os produtos existentes na base de produtos da Systax.
Assim como o produto, os dados dos fornecedores podem ser de cenários já previamente cadastrados na base de cenários do cliente ou uma nova operação, e nessa condição, a ferramenta simulará um calculo online com cenários da base da Systax.
A modalidade de cálculo online tanto no caso de produto como de cenário, é conhecido como “onDemand”, e essa informação será indicada no genérico do retorno ‘tiporegra=ondemand".
2. Consulta por valor de compra ou valor de custo:
A ferramenta tem possibilidade de consultar cada fornecedor de forma diferente, onde pode-se indicar para um fornecedor o preço de custo, ou seja sem os tributos, e a ferramenta embute os tributos para calcular o “custo de aquisição” ou informa-se o valor da compra, com os tributos e demais despesas, e a ferramenta apenas indica o valor do custo (sem tributos), nesse caso, mantem o calculo do “custo de aquisição” pelo valor indicado no “vProdUni”, que corresponde ao valor de compra.
Em ambos os casos o Comparativo de Compras indica a melhor opção de compra, fazendo as devidas distinções entre as opções indicadas na chamada.
A chamada e o retorno de cada uma dessas opções são feitas em tags específicas.
Na chamada na tag "precoOuCusto” indica-se a modalidade de cálculo que se deseja para o fornecedor, onde:
Se indicado nessa tag “C” a ferramenta vai considerar que o valor indicado na tag “vProdUni” é o custo sem os tributos, e portanto vai embutir os tributos e formar um novo “vProdUni”, calculando o custo de aquisição partindo desse valor, e indicará esse valor na tag do retorno “precoTributos”.
Se indicado na tag “P” a ferramenta entende que o valor da tag “vProdUni” é o valor de compra com tributos, e calculará o “custo de aquisição” a partir desse valor e apenas indicará no retorno na tag “precoNet” o custo líquido, ou seja, valor sem os tributos.
Se na chamada a tag não for indicado nenhum valor a ferramenta calculará o “custo de aquisição” partindo do valor informado no “vProdUni”.
Veja o anexo 1 com exemplos de uma chamada com as indicações dessas tags.
Estrutura dos dados da chamada
|
TAG |
PAI |
DESCRIÇÃO |
OBRIGATÓRIO |
|
chamada |
/ |
Ocorrência mínima: 1 | Ocorrência máxima: 1 |
Sim |
|
cabecalho |
chamada |
Ocorrência mínima: 1 | Ocorrência máxima: 1 |
Sim |
|
usuario |
cabecalho |
Usuário cadastrado no Cockpit |
Sim |
|
senha |
cabecalho |
Senha do usuário do Cockpit |
Sim |
|
sessionID |
cabecalho |
Código do sistema de origem + código hash |
Sim |
|
sisOrig |
cabecalho |
Código que identifica o sistema de origem |
Sim |
|
dtCalc |
cabecalho |
Data de cálculo a ser considerada na vigência da regra. |
Sim |
|
tpNF |
cabecalho |
Tipo da operação: |
Sim |
|
generico |
cabecalho |
Campo genérico para funções especiais para a chamada inteira, não deve ser informado se não for especialmente necessário. |
Não |
|
chavebanco |
cabecalho |
Código do Cockpit considerado no cálculo Permite utilizar um único Motor de Cálculo e vários bancos de dados. As chaves precisam ser previamente cadastradas e informadas no momento do cálculo. Caso não seja informada, o motor irá procurar por um banco de dados padrão, que poderá ser configurado opcionalmente. |
Não |
|
Itens |
chamada |
Ocorrência mínima: 1 | Ocorrência máxima: 1 |
Sim |
|
DadosProduto |
DadosProduto |
Ocorrência mínima: 1 | Ocorrência máxima: 999 |
Sim |
|
cProd |
DadosProduto |
Código do produto previamente configurado. |
Não |
|
Orig |
DadosProduto |
Inteiro de 0 a 8 conforme tabela "Origem do produto" (abaixo). |
Sim |
|
cEAN |
DadosProduto |
Código de barras do produto |
Não |
|
NCM |
DadosProduto |
Classificação fiscal do produto |
Não |
|
EXTIPI |
DadosProduto |
Código EX da TIPI |
Não |
|
PerfilDestino |
PerfilDestino |
Ocorrência mínima: 1 | Ocorrência máxima: 1 |
Sim |
|
finalidade |
PerfilDestino |
Código da finalidade do cenário. |
Não |
|
perfilDest |
PerfilDestino |
Obedecerá a tabela e códigos combinada a partir de parâmetros da contratação do serviço. |
Sim |
|
ufDest |
PerfilDestino |
Campo utilizado para informar o Estado de destino da mercadoria, ele é destinado para requisições do tributo A (ICMS e ICMS/ST). |
Sim |
|
CNAEDest |
PerfilDestino |
Código CNAE correspondente ao destinatário. |
Não |
|
munDest |
PerfilDestino |
Código do município de entrada da mercadoria, de acordo com a tabela IBGE (vide item 1 do anexo) |
Não |
|
ItensComparacao |
perfilOrigem |
Ocorrência mínima: 1 | Ocorrência máxima: 999 |
Sim |
|
Id |
perfilOrigem |
Identificação única de cada item. |
Sim |
|
natOp |
perfilOrigem |
Conforme tabela |
Sim |
|
ufOrig |
perfilOrigem |
Campo utilizado para informar o Estado de saída da mercadoria, ele é destinado para requisições do tributo A (ICMS e ICMS/ST). |
Sim |
|
perfilRem |
perfilOrigem |
Obedecerá a tabela e códigos combinada a partir de parâmetros da contratação do serviço. |
Sim |
|
CNAERem |
perfilOrigem |
Código CNAE correspondente ao remetente. |
Não |
|
munOrig |
perfilOrigem |
Código do município de saída da mercadoria, de acordo com a tabela IBGE (vide item 1 do anexo) |
Não |
|
precoOuCusto |
perfilOrigem |
Calcula o custo do produto, sem os tributos, ou calcula o valor de compra: P - Calcula o valor de custo – desembute os tributos C – Forma novo valor do vProdUni - embute os tributos |
Não |
|
qTrib |
perfilOrigem |
Quantidade |
Sim |
|
vProdUni |
perfilOrigem |
Valor unitário do produto. |
Sim |
|
vFrete |
perfilOrigem |
Valor do frete |
Não |
|
pFrete |
perfilOrigem |
Percentual de frete. Pode ser indicado quando for feita a chamada com a solicitação de retorno do NetPrice, assim será considerado na formação do valor do valor de custo o percentual relativo ao frete do produto. |
Não |
|
vSeg |
perfilOrigem |
Valor do seguro |
Não |
|
vOutro |
perfilOrigem |
Outras despesas acessórias |
Não |
|
vDesc |
perfilOrigem |
Valor do desconto incondicional |
Não |
|
outrasDesp |
perfilOrigem |
Outras despesas, para operações de entrada quando aplicável. Ocorrência mínima: 1 | Ocorrência máxima: 1 |
Não |
|
vII |
outrasDesp |
Valor Imposto de Importação |
Não |
|
bcII |
outrasDesp |
Base de cálculo do Imposto de Importação |
Não |
|
vIOF |
outrasDesp |
Valor Imposto sobre Operações Financeiras |
Não |
|
vEncCamb |
outrasDesp |
Valor dos encargos cambiais |
Não |
|
vDespAdu |
outrasDesp |
Valor despesas aduaneiras |
Não |
|
pCredSN |
perfilOrigem |
Alíquota do Simples Nacional aplicável no cálculo do crédito pelo contribuinte destinatário. |
Não |
|
generico |
perfilOrigem |
Campo genérico para funções especiais no âmbito do item, não deve ser informado se não for especialmente necessário. |
Não |
Origem do produto
| 0 | Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 |
| 1 | Estrangeira - Importação direta, exceto a indicada no código 6 |
| 2 | Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7 |
| 3 | Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70% |
| 4 | Nacional, cuja produção tenha sido feita em conformidade com os PPB de que tratam as legislações citadas nos Ajustes |
| 5 | Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40% |
| 6 | Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural |
| 7 | Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural |
| 8 | Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70% |
Exemplo de chamada
{
"cabecalho": {
"usuario": "superdemo@systax.com.br",
"senha": "super123",
"sessionID": "1",
"sisOrig": "1",
"dtCalc": "2021-03-24",
"tpNF": "",
"generico": "",
"chaveBanco": "superdemo1"
},
"Itens": [
{
"DadosProduto": {
"cProd": "",
"Orig": "",
"CEAN": "",
"NCM": "21033021",
"EXTIPI": ""
},
"PerfilDestino": [
{
"finalidade": "569",
"perfilDest": "138",
"ufDest": "SC",
"CNAEDest": "",
"munDest": ""
},
{
"finalidade": "569",
"perfilDest": "138",
"ufDest": "SP",
"CNAEDest": "",
"munDest": ""
}
],
"PerfilOrigem": [
{
"Id": "1",
"natOp": "121",
"UfOrig": "AC",
"PerfilRem": "2",
"CNAERem": "",
"MunOrig": "",
"qTrib": "1",
"vProdUni": "10.00",
"precoNet": "S",
"vFrete": "",
"pFrete": "",
"vSeg": "",
"vOutro": "",
"vDesc": "",
"outrasDesp": {
"vII": "",
"bcII": "",
"vIOF": "",
"vEncCamb": "",
"vDespAdu": ""
},
"pCredSN": "",
"generico": ""
},
{
"Id": "2",
"natOp": "120",
"UfOrig": "TO",
"PerfilRem": "1",
"CNAERem": "",
"MunOrig": "",
"qTrib": "1",
"vProdUni": "10.00",
"precoNet": "",
"TribIncluse": "",
"vFrete": "",
"pFrete": "",
"vSeg": "",
"vOutro": "",
"vDesc": "",
"outrasDesp": {
"vII": "",
"bcII": "",
"vIOF": "",
"vEncCamb": "",
"vDespAdu": ""
},
"pCredSN": "",
"generico": ""
}
]
}
]
}
Retorno
Aqui veremos todos pontos do retorno, como definições, estruturas e exemplos para serem utilizados como base.
Definições do retorno
O retorno é apresentado ordenado pelo melhor custo de aquisição entre os fornecedores e destinatários consultados, e para cada operação é informada toda tributação envolvida. Este retorno é apresentado no bloco "comparativo" ordenado do menor para o maior custo de aquisição"
Como mencionado no tópico anterior, a chamada pode ser feita solicitando uma consulta pelo valor de compra ou pelo custo, e o retorno dessas indicações são destacadas no bloco "comparativo" do retorno.
{
"comparativo" [
{
"ufOrigem": "",
"ufDestino": "",
"perfilRem": "",
"perfilDest": "",
"custoAquisicao": "",
"precoNet": "",
"precoTributos": "",
}
Dependendo da consulta feita é indicado o “precoNet” que informa o valor líquido da operação, ou seja, sem os tributos. Ou retorna o “precoTributos” que informa o valor da operação, embutindo os tributos no caso da indicação na chamada por um valor de custo.
Portanto:
- Se na chamada for solicitado "precoOuCusto": "P" no retorno o resultado será apresentado "precoTributos";
- Se na chamada for solicitado "precoOuCusto": "C" no retorno o resultado será apresentado no "precoNet".
- Se na chamada o campo "precoOuCusto" for vazio, no retorno nenhum dos campos supra citados serão preenchidos.
Estrutura dos dados do retorno
|
TAG |
PAI |
DESCRIÇÃO |
|
retorno |
/ |
Grupo raiz |
|
comparativo |
Retorno |
Grupo de itens |
|
itens |
Itens |
Diversas ocorrências por retorno conforme a quantidade de itens enviados. |
| id | Itens | Identifica o item indicado na chamada. |
|
ufOrigem |
Itens |
Corresponde a UF do fornecedor. |
| ufDestino | Itens | Correspode a UF do destinatário |
|
perfilRem |
Itens |
Perfil do fornecedor. |
| perfilDest | Itens | Perfil do destinatário/comprador. |
|
custoAquisicao |
Itens |
Valor do custo de aquisição. |
|
precoNet |
Itens |
Valor unitário sem os tributos. |
|
precoTributos |
Itens |
Novo valor unitário a ser empregado para o cálculo. |
|
item |
Itens |
Retorno de todos os detalhes do cálculo dos tributos, assim como status da consulta. Conteúdo disponível conforme indicação do link abaixo. |
Como o retorno da tributação do Comparativo de Compras possuí a mesma estrutura do retorno do motor de cálculo, acesse o link abaixo para obter o detalhamento dos campos:
http://documentacao.systax.com.br/Element78/VisualizationDetail/25693
Exemplo de retorno
{"comparativo": [{
"itens": [
{
"id": "1",
"ufOrigem": "ac",
"ufDestino": "sc",
"perfilRem": "2",
"perfilDest": "138",
"custoAquisicao": "7.87",
"precoNet": "",
"precoTributos": null
},
{
"id": "2",
"ufOrigem": "to",
"ufDestino": "sc",
"perfilRem": "1",
"perfilDest": "138",
"custoAquisicao": "7.87",
"precoNet": "",
"precoTributos": null
},
{
"id": "1",
"ufOrigem": "ac",
"ufDestino": "sp",
"perfilRem": "2",
"perfilDest": "138",
"custoAquisicao": "10.94",
"precoNet": "",
"precoTributos": null
},
{
"id": "2",
"ufOrigem": "to",
"ufDestino": "sp",
"perfilRem": "1",
"perfilDest": "138",
"custoAquisicao": "10.94",
"precoNet": "",
"precoTributos": null
}
],
"calculoDetalhadoItens": [
{
"id": "1",
"cProd": "",
"CEST": "1703800",
"CFOP": "6102",
"NCM": "21033021",
"pCredSN_resp": "0",
"custo_aquisicao": "7.87",
"generico": "busca=NCMD|codProd=NCM_21033021-0|orig=|CFOP_ENTRADA=2102|UFO=ac|UFD=sc|natOp=121|perfilorig=2|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",
"status": {
"cod": "0",
"msg": "Retornado com sucesso."
},
"NFe": {
"imposto": {
"ICMS": {"ICMS00": {
"orig": "",
"CST": "00",
"modBC": "3",
"vBC": "10.00",
"pICMS": "12.0000",
"vICMS": "1.20"
}},
"IPI": {
"cEnq": "999",
"IPINT": {"CST": "51"}
},
"PIS": {"PISAliq": {
"CST": "01",
"vBC": "10.00",
"pPIS": "1.6500",
"vPIS": "0.17"
}},
"COFINS": {"COFINSAliq": {
"CST": "01",
"vBC": "10.00",
"pCOFINS": "7.6000",
"vCOFINS": "0.76"
}}
},
"infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "
},
"conteudoAuxiliar": {
"ICMSCred": {
"cst_entrada": "00",
"indicador_credito": "1",
"percentual_credito": "100.00",
"valor_base_calculo": "10.00",
"valor_credito": "1.20",
"dispositivo_legal": "Art.28 e 29, do RICMS/SC",
"pICMS": "12.0000"
},
"IPICred": {
"cst_entrada": "01",
"indicador_credito": "0",
"valor_base_calculo": "0.00",
"percentual_credito": "0.00",
"valor_credito": "0.00",
"dispositivo_legal": "Art. 226 do RIPI/2010"
},
"PISCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.17",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.637/2002",
"pPIS": "1.6500"
},
"COFINSCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.76",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.833/2003",
"pCOFINS": "7.6000"
},
"DispositivoLegal": {
"DispositivoLegalICMS": "Art. 5º, I do RICMS/AC. Art. 17, II do RICMS/AC ",
"DispositivoLegalICMSST": null,
"DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",
"DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",
"DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
}
}
},
{
"id": "2",
"cProd": "",
"CEST": "1703800",
"CFOP": "6102",
"NCM": "21033021",
"pCredSN_resp": "0",
"custo_aquisicao": "7.87",
"generico": "busca=NCMD|codProd=NCM_21033021-0|orig=|CFOP_ENTRADA=2102|UFO=to|UFD=sc|natOp=120|perfilorig=1|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",
"status": {
"cod": "0",
"msg": "Retornado com sucesso."
},
"NFe": {
"imposto": {
"ICMS": {"ICMS00": {
"orig": "",
"CST": "00",
"modBC": "3",
"vBC": "10.00",
"pICMS": "12.0000",
"vICMS": "1.20"
}},
"IPI": {
"cEnq": "999",
"IPINT": {"CST": "51"}
},
"PIS": {"PISAliq": {
"CST": "01",
"vBC": "10.00",
"pPIS": "1.6500",
"vPIS": "0.17"
}},
"COFINS": {"COFINSAliq": {
"CST": "01",
"vBC": "10.00",
"pCOFINS": "7.6000",
"vCOFINS": "0.76"
}}
},
"infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "
},
"conteudoAuxiliar": {
"ICMSCred": {
"cst_entrada": "00",
"indicador_credito": "1",
"percentual_credito": "100.00",
"valor_base_calculo": "10.00",
"valor_credito": "1.20",
"dispositivo_legal": "Art.28 e 29, do RICMS/SC",
"pICMS": "12.0000"
},
"IPICred": {
"cst_entrada": "01",
"indicador_credito": "0",
"valor_base_calculo": "0.00",
"percentual_credito": "0.00",
"valor_credito": "0.00",
"dispositivo_legal": "Art. 226 do RIPI/2010"
},
"PISCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.17",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.637/2002",
"pPIS": "1.6500"
},
"COFINSCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.76",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.833/2003",
"pCOFINS": "7.6000"
},
"DispositivoLegal": {
"DispositivoLegalICMS": "Art. 22, I da Lei nº 1.287/2001. Art. 27, § 2º,II da Lei nº 1.287/2001",
"DispositivoLegalICMSST": null,
"DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",
"DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",
"DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
}
}
},
{
"id": "1",
"cProd": "",
"CEST": "1703800",
"CFOP": "6102",
"NCM": "21033021",
"pCredSN_resp": "0",
"custo_aquisicao": "10.94",
"generico": "busca=NCMD|codProd=NCM_21033021-0|orig=|CFOP_ENTRADA=2403|UFO=ac|UFD=sp|natOp=121|perfilorig=2|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",
"status": {
"cod": "0",
"msg": "Retornado com sucesso."
},
"NFe": {
"imposto": {
"ICMS": {"ICMS00": {
"orig": "",
"CST": "00",
"modBC": "3",
"vBC": "10.00",
"pICMS": "12.0000",
"vICMS": "1.20"
}},
"IPI": {
"cEnq": "999",
"IPINT": {"CST": "51"}
},
"PIS": {"PISAliq": {
"CST": "01",
"vBC": "10.00",
"pPIS": "1.6500",
"vPIS": "0.17"
}},
"COFINS": {"COFINSAliq": {
"CST": "01",
"vBC": "10.00",
"pCOFINS": "7.6000",
"vCOFINS": "0.76"
}}
},
"infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "
},
"conteudoAuxiliar": {
"ICMSCred": {
"cst_entrada": "60",
"indicador_credito": "0",
"percentual_credito": "0.00",
"valor_base_calculo": "0.00",
"valor_credito": "0.00"
},
"ICMS_Antecipacao": {
"tipo_antecipacao": "2",
"encerra_trib": "1",
"responsavel": "D",
"p_red_bc_interna_dest": "0.00",
"aliq_interna_dest": "18.0000",
"bc_icms_antecipacao": "17.0720",
"vigencia_de": "2020-03-01",
"valor_icms_antecipacao": "1.87",
"mva": "70.72",
"mva_ajustado": "0.00",
"mva_lista_positiva_ajustado": "0.00",
"mva_lista_negativa_ajustado": "0.00",
"mva_lista_neutra_ajustado": "0.00"
},
"ICMS_ANTECIPACAOCred": {
"indicador_credito": "0",
"valor_base_calculo": "0.00",
"percentual_credito": "0.00",
"valor_credito": "0.00",
"dispositivo_legal": "Art. 277 cc §5º do artigo 426-A do RICMS/SP",
"observacoes": "Observar as condições do §3º do artigo 277 do RICMS/SP: \"O valor do imposto recolhido antecipadamente por meio de guia de recolhimentos especiais, nos termos do art. 426-A, deverá ser escriturada no LRAICMS\"."
},
"IPICred": {
"cst_entrada": "01",
"indicador_credito": "0",
"valor_base_calculo": "0.00",
"percentual_credito": "0.00",
"valor_credito": "0.00",
"dispositivo_legal": "Art. 226 do RIPI/2010"
},
"PISCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.17",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.637/2002",
"pPIS": "1.6500"
},
"COFINSCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.76",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.833/2003",
"pCOFINS": "7.6000"
},
"DispositivoLegal": {
"DispositivoLegalICMS": "Art. 5º, I do RICMS/AC. Art. 17, II do RICMS/AC ",
"DispositivoLegalICMSST": null,
"DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",
"DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",
"DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
}
}
},
{
"id": "2",
"cProd": "",
"CEST": "1703800",
"CFOP": "6102",
"NCM": "21033021",
"pCredSN_resp": "0",
"custo_aquisicao": "10.94",
"generico": "busca=NCMD|codProd=NCM_21033021-0|orig=|CFOP_ENTRADA=2403|UFO=to|UFD=sp|natOp=120|perfilorig=1|perfildest=138|tiporegra=ondemand|regranaocriada|versao=5.95|",
"status": {
"cod": "0",
"msg": "Retornado com sucesso."
},
"NFe": {
"imposto": {
"ICMS": {"ICMS00": {
"orig": "",
"CST": "00",
"modBC": "3",
"vBC": "10.00",
"pICMS": "12.0000",
"vICMS": "1.20"
}},
"IPI": {
"cEnq": "999",
"IPINT": {"CST": "51"}
},
"PIS": {"PISAliq": {
"CST": "01",
"vBC": "10.00",
"pPIS": "1.6500",
"vPIS": "0.17"
}},
"COFINS": {"COFINSAliq": {
"CST": "01",
"vBC": "10.00",
"pCOFINS": "7.6000",
"vCOFINS": "0.76"
}}
},
"infAdProd": "pFCP: 0%. vFCP: R$ 0.00. "
},
"conteudoAuxiliar": {
"ICMSCred": {
"cst_entrada": "60",
"indicador_credito": "0",
"percentual_credito": "0.00",
"valor_base_calculo": "0.00",
"valor_credito": "0.00"
},
"ICMS_Antecipacao": {
"tipo_antecipacao": "2",
"encerra_trib": "1",
"responsavel": "D",
"p_red_bc_interna_dest": "0.00",
"aliq_interna_dest": "18.0000",
"bc_icms_antecipacao": "17.0720",
"vigencia_de": "2020-03-01",
"valor_icms_antecipacao": "1.87",
"mva": "70.72",
"mva_ajustado": "0.00",
"mva_lista_positiva_ajustado": "0.00",
"mva_lista_negativa_ajustado": "0.00",
"mva_lista_neutra_ajustado": "0.00"
},
"ICMS_ANTECIPACAOCred": {
"indicador_credito": "0",
"valor_base_calculo": "0.00",
"percentual_credito": "0.00",
"valor_credito": "0.00",
"dispositivo_legal": "Art. 277 cc §5º do artigo 426-A do RICMS/SP",
"observacoes": "Observar as condições do §3º do artigo 277 do RICMS/SP: \"O valor do imposto recolhido antecipadamente por meio de guia de recolhimentos especiais, nos termos do art. 426-A, deverá ser escriturada no LRAICMS\"."
},
"IPICred": {
"cst_entrada": "01",
"indicador_credito": "0",
"valor_base_calculo": "0.00",
"percentual_credito": "0.00",
"valor_credito": "0.00",
"dispositivo_legal": "Art. 226 do RIPI/2010"
},
"PISCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.17",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.637/2002",
"pPIS": "1.6500"
},
"COFINSCred": {
"cst_entrada": "50",
"indicador_credito": "1",
"valor_base_calculo": "10.00",
"percentual_credito": "100.00",
"valor_credito": "0.76",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.833/2003",
"pCOFINS": "7.6000"
},
"DispositivoLegal": {
"DispositivoLegalICMS": "Art. 22, I da Lei nº 1.287/2001. Art. 27, § 2º,II da Lei nº 1.287/2001",
"DispositivoLegalICMSST": null,
"DispositivoLegalIPI": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016",
"DispositivoLegalPIS": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003",
"DispositivoLegalCOFINS": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
}
}
}
]
}]}
Códigos do retorno
No retorno, para cada consulta feita, ou seja dentro de cada "item", existe o "status" que indica qual o resultado da chamada, se foi retornada com sucesso, se não foi localizada regra, entre outros.
Essas informações estão dispostas nas tags "cod" e "msg", que correspondem aos valores abaixo:
|
“cod” |
“msg” |
|
0 |
Retornado com sucesso. |
|
2 |
Código do produto não localizado na tabela. |
|
3 |
Código do produto não informado. |
|
7 |
Parâmetros insuficiente para essa requisição. |
|
8 |
Regra não encontrada para o item. |
|
9 |
Regra parcialmente aprovada. |
| 10 | Regra sem CFOP de Entrada, Ausencia de Tributos Obrigatórios - PIS, Ausencia de Tributos Obrigatórios - COFINS, Regra com ST e Antecipação, Regra com CST diferente de 60 |
| 11 | Falha de conexão com API do Regra online |
| 998 | Usuário ou senha invalidos |
|
999 |
Erro fatal. |
Dicionário de dados
Considerando que as tags da “chamada” e do “retorno” utilizam a mesma estrutura do 'motor de cálculo', indicamos nesse capítulo o acesso aos respectivos dicionários.
Chamada
https://documentacao.systax.com.br/PublicView2/Index/eb760fdab1ce135efabebecc1/25201/25954/25973
Chamada:
|
CAMPOS RELATIVOS A CHAMADA |
|||
|
CAMPO |
TIPO |
TAMANHO |
OBSERVAÇÃO |
|
precoOuCusto |
String |
1 |
P ou C |
|
pFrete |
Decimal |
13,4 |
13 dígitos de corpo e 4 dígitos de precisão |
Retorno
https://documentacao.systax.com.br/PublicView2/Index/eb760fdab1ce135efabebecc1/25201/25954/25974
|
CAMPOS RELATIVOS AO RETORNO |
|||
|
CAMPO |
TIPO |
TAMANHO |
OBSERVAÇÃO |
|
precoNet |
Decimal |
13,4 |
13 dígitos de corpo e 4 dígitos de precisão |
|
precoTributos |
Decimal |
13,4 |
13 dígitos de corpo e 4 dígitos de precisão |
Fórmulas para Cálculo dos Tributos
Para cálculo dos tributos são necessários elementos que formam a base de cálculo, calculam as diversidades de antecipações que existem, e as inúmeras formas de apropriação de créditos. A Systax possui algumas tabelas com as fórmulas para cada situação necessárias para composição dos cálculos.
Os nomes das tabelas representam as tags indicadas em cada retorno.
O conteúdo das tabelas com as fórmulas está disposto no capítulo "Tabelas Auxiliares"
- bc_composição e bc_composição FCP
- Tipo_antecipação
- Indicador de crédito
- bc_composição_FCP_antecipação
Tabelas Auxiliares
As tabelas auxiliares são imprescindíveis para entender o retorno tributário disponibilizado pela Systax, pois são elas que indicam os perfis do remetente, destinatário, a natureza da operação, a finalidade da compra, entre outros.
A documentação dedicada das tabelas auxiliares pode ser acessada no link a seguir: https://documentacao.systax.com.br/books/tabelas-auxiliares