API Consulta Produtos com Regra Geral
Retorna a lista de produtos aos quais se aplica a tributação geral em cada cenário.
Método: GET
API Rest/ Json: https://wscockpit.systax.com.br/api/api/RegrasReforma/{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" no response, 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 a concatenação dos dados do último registro retornado na página (IdCenario + codigoProduto + origemProduto), que também será o primeiro a retornar na próxima página.
*Os dados apresentados nesta Tag estão parametrizados em base64. |
Sim |
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 registros 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 registro 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. |
|
cenario |
- |
Os campos retornados neste bloco são os mesmos campos de cenário e produto existentes em nossas APIs de cadastros. Para consultar mais detalhes, clique aqui. |
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": "20260415181409",
"paramProxPag": "MjIzNTkxMDcwMTAxNTA=",
"status": {
"codStatus": 200,
"msgStatus": "Sucesso"
},
"regra": [
{
"idCenario": "150459",
"codigoProduto": "29730",
"origemProduto": 0,
"vigenciaDe": "2025-01-07T17:47:39.367",
"dtCriacao": "2025-01-07T17:47:39.36",
"idCarga": 0
},
{
"idCenario": "22359",
"codigoProduto": "10701015",
"origemProduto": 0,
"descricao": "CFI 0 48X1000X2000",
"ncm": 72193400,
"ean": "7891285399018",
"vigenciaDe": "2025-08-14T00:00:00",
"dtCriacao": "2025-08-15T15:58:26.8",
"idCarga": 11223
}
]
}