API Consulta do De-Para de Cenários
Consultar os registros da tabela “De-Para – Cenários RT”, que contém a correlação entre os cenários da tributação atual e seus respectivos cenários na Reforma Tributária.
Método: GET
API Rest/ Json: https://wscockpit.systax.com.br/api/api/RegrasReforma/DeParaCenarios/{paginacao}/{ponteiro}/{paramProxPag}
Obs.: dada a utilização do método GET, os parâmetros da chamada são informados na própria URL e não há body.
Descrição dos parâmetros da chamada
|
Parâmetro |
Detalhamento do preenchimento |
Obrigatório |
|
Paginação |
Quantidade de registros/regras a serem entregues por página. Limite máximo 1.000. |
Sim |
|
Ponteiro |
Ponteiro do controle de atualização. |
Sim |
|
-Para carga inicial (recebimento de todos os registros), informar 0. |
||
|
-Para atualizações, informar o ponteiro retornado na primeira chamada da carga anterior. |
||
|
*paramProxPag |
É o dado recebido no response que identificará quais registros devem retornar na próxima página. Na primeira chamada do processo, informar 0. Sempre que retornado o campo "paramProxPag", deverá ser feita mais uma chamada para obter a próxima página. A partir da 2ª chamada, informar no parâmetro "paramProxPagina" o valor retornado no campo "paramProxPagina" do response da página anterior. O conteúdo retornado neste campo é sempre equivalente ao ID do último cenário atual retornado na página, que também será o primeiro a retornar na próxima página. |
Sim |
Os dados apresentados nesta Tag estão parametrizados em base64.
Descrição dos campos de retorno
|
Campo |
Pai |
Descrição |
|
Ponteiro |
- |
Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo. Essa informação é retornada na primeira página do processo de carga e deverá ser armazenada para servir de parâmetro para utilização na próxima carga, que identificará quais regras já foram recebidas no processo anterior e, portanto, não deverão ser entregues novamente. |
|
codStatus |
status |
Código de retorno |
|
msgStatus |
status |
Mensagem de retorno |
|
paramProxPag |
- |
Retorna o resultado da concatenação de "IdCenario | codigoProduto | origemProduto" do último produto e cenário retornado nesta página. O objetivo é usar este valor como parâmetro na request da próxima página para definir quais regras devem retornar nesta, assim a primeira regra a ser entregue deverá ser a regra do produto e cenário identificados nesta concatenação e as próximas regras deverão ser as que são subsequentes à primeira. |
|
retorno tributário |
- |
O detalhamento do retorno a partir deste campo consta no item "Informações da RT retornadas no Cockpit" deste manual. |
Mensagens de retorno
|
cod_status |
msg_status |
|
200 |
Sucesso |
|
401 |
Token ou Login/ Senha inválidos |
|
500 |
Falha na aplicação |
|
901 |
Usuario sem cliente |
|
902 |
Cliente sem connection string |
Exemplo de chamada
Exemplo de retorno
{
{ "ponteiro": "20260415172447",
"paramProxPag": "150462",
"status": {
"codStatus": 200,
"msgStatus": "Sucesso"
},
"cenario": [
{
"atual": {
"idCenario": "150461",
"entSai": "3",
"apelido": "Revenda-SP-SP-Atacado-Varejista",
"ufOrigem": "SP",
"ufDestino": "SP",
"naturezaOperacao": "121",
"origem": "2",
"destinacao": "140"
},
"rt": {
"idCenario": "82",
"entSai": "3",
"apelido": "Venda-SP-SP-Atacado-Varejo",
"ufOrigem": "SP",
"ufDestino": "SP",
"naturezaOperacao": "121",
"origem": "1553",
"destinacao": "3042"
},
"dtCriacao": "2025-07-04T13:39:22.073",
"usuario": "Superdemo"
},
{
"atual": {
"idCenario": "150462",
"entSai": "1",
"apelido": "Compra-SP-SP-Industria-Atacado",
"ufOrigem": "SP",
"ufDestino": "SP",
"naturezaOperacao": "120",
"finalidade": "569",
"origem": "1",
"destinacao": "138"
},
"rt": {
"idCenario": "82",
"entSai": "3",
"apelido": "Venda-SP-SP-Atacado-Varejo",
"ufOrigem": "SP",
"ufDestino": "SP",
"naturezaOperacao": "121",
"origem": "1553",
"destinacao": "3042"
},
"dtCriacao": "2026-04-14T09:23:58.463",
"usuario": "Superdemo"
}
]
}
}