API Regras Pendentes

• Introdução
• Acesso
• Swagger e Endpoint
• Autenticação
• Chamada
• Estrutura dos dados da chamada
• Exemplo de chamada
• Retorno
• Estrutura dos dados de retorno
• Exemplo de retorno

Introdução

Acesso

Swagger e Endpoint

Comunicação: REST/JSON

Para acessar a coleção de chamadas Clique Aqui.

Swagger Regras Pendentes
https://wscockpit.systax.com.br/api/swagger/index.html#/

Listagem do Endpoint que contempla o manual de Regras Pendentes

Descrição	Versão	Grupo Swagger	Método	URL Endpoint	URL Token
Retorna as regras de mercadorias pendentes do Cockpit	v1	Regras	Post	https://wscockpit.systax.com.br/ api/api/regras/pendentes	https://app.systax .com.br/auth/ access-token

Autenticação

Chamada

Estrutura dos dados da chamada

Campo	Descrição	Obrigatório
Id	Não tem validação de informação indicada, deve ser retornado como indicação do item no response	Não
cenario	Se indicado busca regras pendentes relacionadas ao cenários indicado	Não
natureza	Se indicado busca regras pendentes com essa informação	Não
ufOrigem	Se indicado busca regras pendentes com essa informação	Não
ufDestino	Se indicado busca regras pendentes com essa informação	Não
perfilOrigem	Se indicado busca regras pendentes com essa informação	Não
perfilDestino	Se indicado busca regras pendentes com essa informação	Não
munOrigem	Se indicado busca regras pendentes com essa informação	Não
munDestino	Se indicado busca regras pendentes com essa informação	Não
finalidade	Se indicado busca regras pendentes com essa infromação	Não
codProduto	Se indicado busca regras pendentes com essa informação	Não
origemProduto	Se indicado busca regras pendentes com essa informação	Não
ncm	Se indicado busca regras pendentes com essa informação	Não
extipi	Se indicado busca regras pendentes com essa informação	Não
ean	Se indicado busca regras pendentes com essa informação	Não
data	É indicado no formato dd/mm/aaaa a dd/mm/aaaa e a API busca as regras pendentes dentro desse período	Não

Importante: as regras pendentes serão informadas pela API, de acordo com os parâmetros preenchidos na chamada. Caso nenhum parâmetro seja informado, todas as regras pendentes de aprovação retornarão na API.

Códigos de retorno

Código	Retorno
0	Parâmetros incorretos
1	Retornado com sucesso
2	Não existem regras pendentes

Exemplo de chamada

{
  "id": 0,
  "cenario": "2336815",
  "natureza": "121",
  "ufOrigem": "",
  "ufDestino": "",
  "perfilOrigem": "3",
  "perfilDestino": "6",
  "munOrigem": "",
  "munDestino": "",
  "finalidade": "",
  "codProduto": "",
  "origemProduto": "",
  "ncm": "",
  "extipi": "",
  "ean": "",
  "data": ""
}

Retorno

Estrutura dos dados de retorno

O retorno da API será com todos os dados do Cockpit, seguindo todos os detalhes da regra que está pendente de aprovação.

Exemplo de retorno

{
    "cenario": [
        {
            "ent_sai": "3",
            "id_cenario": "2336815",
            "apelido": "Revenda-MG-SP-Varejo-CFNC",
            "dias_futuros": "30",
            "uf_origem": "MG",
            "uf_destino": "SP",
            "origem": "3",
            "destinacao": "6",
            "cod_natureza_operacao": "121",
            "retorno": [
                {
                    "cod_prod": "NCM00000000-0",
                    "descricao": "Frete",
                    "ean": "8880001040289",
                    "ncm": "00000000",
                    "origem_produto": "0",
                    "cfop": "6357",
                    "icms": {
                        "cst": "00",
                        "bc_composicao": 2,
                        "bc_composicao_sn_especial": 0,
                        "bc_composicao_fcp": 0,
                        "aliquota": "12.0000",
                        "generico": "tributos_aproximados_Estadual=18.00|tributos_aproximados_Federal=7.85|pendente_revisao=1|indice_precisao=0",
                        "vigencia_de": "2023-07-01T00:00:00",
                        "dispositivo_legal": "Art. 12, I do RICMS/MG. Art. 11, II e item 3.1 do Anexo I, Parte II do RICMS/MG",
                        "icms_uf_dest": {
                            "cst": "00",
                            "bc_composicao": 2,
                            "bc_composicao_fcp": 0,
                            "aliq_interna_dest": "12.0000",
                            "perc_partilha_dest": "100.0000",
                            "vigencia_de": "2019-01-01T00:00:00",
                            "dispositivo_legal": "art. 37, I, e § 1º do RICMS/SP, art. 54, I do RICMS/SP"
                        },
                        "estatistica": "A05|A06|A07"
                    },
                    "pis": {
                        "cst": "01",
                        "bc_composicao": 2,
                        "aliquota": "0.65",
                        "vigencia_de": "2002-12-01T00:00:00",
                        "dispositivo_legal": "Art. 8º, I, da Lei nº 9.715/1998."
                    },
                    "cofins": {
                        "cst": "01",
                        "bc_composicao": 2,
                        "aliquota": "3.00",
                        "vigencia_de": "2004-02-01T00:00:00",
                        "dispositivo_legal": "Art. 8º da Lei nº 9.718/1998."
                    }
                }
            ]
        }
    ],
    "status": {
        "cod_status": 0,
        "msg_status": "Retorno com sucesso. "
    }
}