API - Leitura de regras
Objetivo: Retornar as regras aprovadas do Cockpit.
Método: POST
API Rest / Json: https://api-gateway.systax.com.br/cockpit/v2/api/regras
Descrição dos campos de chamada:
| Campo | PAI | Descrição | Obrigatório |
| id_cenario | / | Informar 0 ou 1 para iniciar o processo de leitura. A partir da segunda chamada do processo, informar o último "id_cenario" retornado na resposta da chamada anterior. | Não |
| codigo_produto | / | Informar 0 ou 1 para iniciar o processo de leitura. A partir da segunda chamada do processo, informar o "cod_prod" do último produto retornado na resposta da chamada anterior. | Não |
| origem_produto | / | Informar 0 ou 1 para iniciar o processo de leitura. A partir da segunda chamada do processo, informar a "origem_produto" do último produto retornado na resposta da chamada anterior. | Não |
| paginacao | / | Quantidade de registros/regras a serem entregues por página. Limite máximo 100. | Não |
| ponteiro_atualizacao | / |
Ponteiro do controle de atualização. -Para carga inicial (recebimento de todas as regras), informar 0 ou 1. -Para atualizações, informar o ponteiro retornado na primeira chamada do dia anterior (ou o ponteiro retornado na primeira chamada do processo anterior, caso seja realizado mais de um processo de leitura por dia). Vide orientações detalhadas no item Ponteiro de atualização e Paginação. |
Não |
Exemplo de chamada:
{
"id_cenario": "0",
"codigo_produto": "0",
"origem_produto": "0",
"paginacao": 100,
"ponteiro_atualizacao": "0"
}
Descrição dos campos de retorno:
| Campo | PAI | Descrição |
| ponteiro_atualizacao | / | Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo |
| origem | / | Valor fixo "Systax". |
| sistema | / |
Valor fixo "Cockpit". |
| cod_status | status | Código de retorno |
| msg_status | status | Mensagem de retorno |
| cenario | O detalhamento do retorno a partir deste campo está disponível no item Informações retornadas pelo systax_erp. |
Tabela de referência para os campos "cod_status" e "msg_status":
| cod_status | msg_status |
| 0 | Sucesso |
| 1 | LoginSenhaInvalido |
| 8 | UsuarioSemCliente |
| 9 | ClienteSemConnectionString |
| 10 | FalhaNaAplicacao |
Exemplo de retorno:
{
"cenario": [
{
"ent_sai": "1",
"id_cenario": "292613",
"apelido": "Compra-SP-SP-Industria-Varejo--569",
"dias_futuros": "30",
"grupo_produtos": "Industria - Varejo - SP - SP, Compra Origem 2 - SP_SP, compra origem 0 -SP-SP, SP-SP-120-1-140-569",
"uf_origem": "SP",
"uf_destino": "SP",
"origem": "1",
"destinacao": "140",
"cod_natureza_operacao": "120",
"finalidade": "569",
"retorno": [
{
"cod_prod": "892478",
"descricao": "VENTILADOR DE TETO BRAVO",
"ean": "7898140448379",
"ncm": "84145990",
"origem_produto": "0",
"grupo_produto_associado": "SP-SP-120-1-140-569",
"cfop": "5401",
"cfop_entrada": "1403",
"cest": "2108800",
"icms": {
"cst": "10",
"bc_composicao": 2,
"bc_composicao_sn_especial": 0,
"bc_composicao_fcp": 0,
"aliquota": "18.0000",
"vigencia_de": "2001-01-01T00:00:00",
"dispositivo_legal": "art. 37, I, e § 1º do RICMS/SP. art. 52, I do RICMS/SP",
"inf_adicionais": "Arts. 313-Z 19 do RICMS/SP c/c Portaria SER n º 59/2023. art. 37, I, e § 1º do RICMS/SP. art. 52, I do RICMS/SP.",
"icms_st": {
"bc_composicao": 62,
"bc_composicao_fcp": 0,
"aliquota_st": "18.0000",
"mva": "49.00",
"vigencia_de": "2023-10-01T00:00:00",
"dispositivo_legal": "Arts. 313-Z 19 do RICMS/SP c/c Portaria SER n º 59/2023. art. 52, I do RICMS/SP"
},
"estatistica": "Z01|"
},
"credito_icms": {
"indicador_credito": 0,
"cst_entrada": "60",
"vigencia_de": "2001-01-01T00:00:00",
"dispositivo_legal": "Arts. 59, 61 e 272 do RICMS-SP.",
"observacoes": "Observar as condições previstas no parágrafo único do art. 272 do RICMS-SP"
},
"ipi": {
"cst": "51",
"cenq": "999",
"bc_composicao": 0,
"generico": "ipi_cenq=999",
"vigencia_de": "2022-08-01T00:00:00",
"dispositivo_legal": "Art. 190 do RIPI/2010 c/c Decreto nº 11.158/2022",
"estatistica": "B05|B07"
},
"credito_ipi": {
"indicador_credito": 0,
"cst_entrada": "01",
"vigencia_de": "2010-06-25T00:00:00",
"dispositivo_legal": "Art. 226 do RIPI/2010"
},
"pis": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "1.6500",
"vigencia_de": "2002-12-01T00:00:00",
"dispositivo_legal": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
},
"credito_pis": {
"indicador_credito": 1,
"cst_entrada": "50",
"percentual_credito": "100.0000",
"vigencia_de": "2002-12-01T00:00:00",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.637/2002"
},
"cofins": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "7.6000",
"vigencia_de": "2004-02-01T00:00:00",
"dispositivo_legal": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003"
},
"credito_cofins": {
"indicador_credito": 1,
"cst_entrada": "50",
"percentual_credito": "100.0000",
"vigencia_de": "2004-02-01T00:00:00",
"dispositivo_legal": "Art. 3°, inciso I, da Lei 10.833/2003"
}
}
]
}
],
"ponteiro_atualizacao": "20241112172839",
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}