Tax Engine RT - Services
- Índice
- 1 - Versões
- 2 - Introdução
- 3 - Acessos
- 4 - Estrutura de dados da Requisição do Motor de Cálculo
- 5 - Estrutura de dados da Response do Motor de Cálculo
- 6 – Tabela De/Para Cenários
- 7 - Json de requisição
Índice
1 - Versões
2 - Introdução
3 - Acessos
4 - Estrutura de dados da requisição do Motor de cálculo
5 - Estrutura de dados da response do Motor de cálculo
6 - Tabela De/Para Cenários
7 - Json de requisição
1 - Versões
|
Versão |
Publicação |
Alterações |
Autor |
|
01 |
02/07/2026 |
Inclusão |
Henrique Moreira |
2 - Introdução
Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações internas ao serviço do Motor de Cálculo da Systax.
Com o objetivo de facilitar esse processo de integração, a Systax disponibiliza um módulo de integração desenvolvido na forma de webservice e webapi/JSON, o que assegura interoperabilidade com sistemas construídos em diferentes linguagens e plataformas.
Além disso, este documento descreve as diferentes modalidades de cálculo oferecidas pelo Motor de Cálculo, permitindo que os usuários analisem as diversas particularidades dos cálculos e os apliquem conforme as necessidades de suas operações.
3 - Acessos
Swagger:
https://wscockpit.systax.com.br/TaxEngineReforma/swagger/index.html
URL API Rest / Json:
wscockpit.systax.com.br/TaxEngineReforma/api/CalcularServicoCombinado
Autenticação:
1) Basic Auth;
2) JWT Bearer token
Nota: Para consultar como fazer a geração de Token, acesse o manual no link abaixo:
4 - Estrutura de dados da Requisição do Motor de Cálculo
| Campo | Descrição | Cabeçalho / Item | Obrigatório | Valores Aceitos |
| SessionID | Código de qualquer formato gerado pelo cliente e utilizado para obter controle das transações. Recomendamos que seja um código único por requisição. | Cabeçalho | Não | Texto e numérico |
| SisOrig | Código numérico que identifica o sistema de origem de request. Controle do cliente e utilizado quando há vários sistemas requisitando o motor de cálculo. Se for utilizar somente 1 solução pra chamar o motor, por exemplo, pode mandar 1 no parâmetro. | Não | Texto e numérico | |
| DtCalc | Data de cálculo a ser considerada na vigência da regra. | Sim | Formato 'YYYY-MM-DD' | |
| UfOrig | Campo utilizado para informar o Estado de saída da operação. | Sim | Texto | |
| UfDest | Campo utilizado para informar o Estado de destino da operação. | Sim | Texto | |
| CNAERem | CNAE do remetente. | Não | Numérico | |
| CNAEDest | CNAE do destinatário. | Não | Numérico | |
| MunGerador | Código do municipio gerador da operação. | Não | Numérico | |
| MunTomador | Código do municipio tomador da operação. | Não | Numérico | |
| MunExcucao | Código do municipio execução da operação. | Não | Numérico | |
| ChaveBanco | Código do Cockpit do cliente considerado no cálculo. | Não | Numérico | |
| PerfilRem | Campo utilizado para informar o remetente de saída da operação. | Sim | Numérico | |
| PerfilDest | Campo utilizado para informar o destinatário de saída da operação. | Sim | Numérico | |
| Id | Identificação única de cada item da requisição. | Item | Não | Numérico |
| VServico | Valor do serviço da operação. | Não | Numérico | |
| VDescIncodicional | Valor do desconto incondicional. | Não | Numérico | |
| VDescCondicional | Valor do desconto condicional. | Não | Numérico | |
| VDeducoes | Valor de deduções da operação. | Não | Numérico | |
| CodServico | Código do serviço. | Não | Numérico | |
| CodServicoExecucao | Código do serviço execução. | Não | Numérico | |
| CodServicoInterno | Código do serviço interno. | Não | Numérico | |
| nbs | Código NBS. | Sim | Numérico |
5 - Estrutura de dados da Response do Motor de Cálculo
| Campo | Descrição | Fórmula de cálculo do campo | Obrigatório |
| CST | Código de Situação Tributária do IBS e da CBS |
Informação da Regra | Sim |
| cClassTrib | Código de Classificação Tributária do IBS e da CBS |
Informação da Regra | Sim |
| cCredPres | Código e classificação do crédito presumido: IBS e CBS. |
Informação da Regra | Não |
| CSTReg | Código de Situação Tributária do IBS e da CBS de tributação regular |
Informação da Regra | Sim |
| cClassTribReg | Código da Classificação Tributária do IBS e da CBS de tributação regular |
Informação da Regra | Sim |
| pDifUF | Percentual de diferimento para o IBS estadual | Informação da Regra | Sim |
| pDifMun | Percentual de diferimento para o IBS municipal | Informação da Regra | Sim |
| pDifCBS | Percentual de diferimento para a CBS | Informação da Regra | Sim |
| pRedutor | Percentual de redução de aliquota em compra governamental. | Informação da Regra | Sim |
| vBC | Valor da base de cálculo (BC) do IBS/CBS antes das reduções para cálculo do tributo bruto. |
Se data do cálculo enviado na requisição for igual ou menor que 31/12/2026: vBC = vServ - descIncond – vCalcReeRepRes – vISSQN – vPIS - vCOFINS Se data do cálculo enviado na requisição for maior que 31/12/2026: vBC = vServ - descIncond – vCalcReeRepRes – vISSQN |
Sim |
| pIBSUF | Alíquota da UF para IBS da localidade de incidência parametrizada no sistema. |
Informação da Regra | Sim |
| pRedAliqUF | Percentual de redução de alíquota estadual | Informação da Regra | Sim |
| pAliqEfetUF | Percentual de alíquota efetiva | pAliqEfetUF = pIBSUF x (1 - (pRedAliqUF/100)) x (1 - pRedutor) Se pRedAliqUF não for informado na DPS, então pAliqEfetUF é a própria pIBSUF. |
Sim |
| pIBSMun | Alíquota da UF para IBS da localidade de incidência parametrizada no sistema. |
Informação da Regra | Sim |
| pRedAliqMun | Percentual de redução de alíquota municipal | Informação da Regra | Sim |
| pAliqEfetMun | Percentual de alíquota efetiva | pAliqEfetMun = pIBSMun x (1 - (pRedAliqMun/100)) x (1 - pRedutor) Se pRedAliqMun não for informado na DPS, então pAliqEfetMun é a própria pIBSMun. |
Sim |
| pCBS | Alíquota da UF para IBS da localidade de incidência parametrizada no sistema. |
Informação da Regra | Sim |
| pRedAliqCBS | Percentual da redução de alíquota. | Informação da Regra | Sim |
| pAliqEfetCBS | Percentual de alíquota efetiva | pAliqEfetCBS = pCBS x (1 - (pRedAliqCBS/100)) x (1 - pRedutor) Se pRedAliqCBS não for informado na DPS, então pAliqEfetCBS é a própria pCBS. |
Sim |
| vTotNF | Valor Total da NF considerando os impostos por fora: IBS e CBS. O IBS e a CBS são por fora, por isso seus valores devem ser adicionados ao valor total da NF. |
Se data do cálculo enviado na requisição for igual ou menor que 31/12/2026: vTotNF = vLiq Se data do cálculo enviado na requisição for maior que 31/12/2026: vTotNF = vLiq + vCBS + vIBSTot |
Sim |
| pAliqEfeRegIBSUF | Alíquota efetiva de tributação regular do IBS estadual |
Informação da Regra | Sim |
| vTribRegIBSUF | Valor da tributação regular do IBS estadual. | vTribRegIBSUF = vBC x pAliqEfeRegIBSUF | Sim |
| pAliqEfeRegIBSMun | Alíquota efetiva de tributação regular do IBS municipal |
Informação da Regra | Sim |
| vTribRegIBSMun | Valor da tributação regular do IBS municipal. |
vTribRegIBSMun = vBC x pAliqEfeRegIBSMun | Sim |
| pAliqEfeRegCBS | Alíquota efetiva de tributação regular da CBS |
Informação da Regra | Sim |
| vTribRegCBS | Valor da tributação regular da CBS. | vTribRegCBS = vBC x pAliqEfeRegCBS | Sim |
| pIBSUF | Alíquota do IBS de competência do Estado | Informação da Regra | Sim |
| pIBSMun | Alíquota do IBS de competência do Município |
Informação da Regra | Sim |
| pCBS | Alíquota da CBS | Informação da Regra | Sim |
| vIBSTot | Valor total do IBS. | vIBSTot = vIBSUF + vIBSMun | Sim |
| pCredPresIBS | Alíquota do crédito presumido para o IBS | Informação da Regra | Sim |
| vCredPresIBS | Valor do Crédito Presumido para o IBS | vCredPresIBS = vBC x pCredPresIBS | Sim |
| vDifUF | Total do Diferimento do IBS estadual | vDifUF = vIBSUF x pDifUF | Sim |
| vIBSUF | Total valor do IBS estadual. | vIBSUF = vBC x (pIBSUF ou pAliqEfetUF) | Sim |
| vDifMun | Total do Diferimento do IBS municipal. | vDifMun = vIBSMun x pDifMun | Sim |
| vIBSMun | Total valor do IBS municipal | vIBSMun = vBC x (pIBSMun ou pAliqEfetMun) | Sim |
| pCredPresCBS | Alíquota do crédito presumido para a CBS | Informação da Regra | Sim |
| vCredPresCBS | Valor do Crédito Presumido da CBS | vCredPresCBS = vBC x pCredPresCBS | Sim |
| vDifCBS | Total do Diferimento CBS. | vDifCBS = vCBS x pDifCBS | Sim |
| vCBS | Total da CBS da União. | vCBS = vBC x (pCBS ou pAliqEfetCBS) | Sim |
6 – Tabela De/Para Cenários
Para busca de regras referente a reforma tributária, o motor considera apenas os cenários cujo parâmetros constem na tabela de De/Para de cenários presente no cockipt.
Caso os parâmetros da operação, enviados na requisição do motor de cálculo não conste nessa tabela, o motor não encontrará a regra equivalente para a reforma tributária.
Abaixo segue link do manual para consulta e gerenciamento dessa tela no cockpit: