# APIs de Aprovação, Rejeição e Consulta de Regras Pendentes

# Introdução

Essas API's tem o objetivo de aprovar ou rejeitar regras que estejam pendentes e também de consultar regras pendentes.

# Acesso

# Swagger e Endpoint

**Comunicação:** REST/JSON  
  
**Para acessar a coleção de chamadas** [clique aqui.](https://www.dropbox.com/scl/fi/ty8iqpx9bhmbzw812zytw/API-Regras-Pendentes-e-Aprova-o-e-Rejei-o-de-Regras.v2.postman_collection.json?rlkey=8956mprafewwgnueuiwgdg0xh&dl=0)

**Swagger:** [https://wscockpit.systax.com.br/api/swagger/index.html](https://wscockpit.systax.com.br/api/swagger/index.html)

<table border="2" id="bkmrk-descri%C3%A7%C3%A3o-grupo-swag"><thead><tr><th scope="col">Descrição

</th><th scope="col">Grupo Swagger

</th><th scope="col">Método

</th><th scope="col">URL Endpoint

</th><th scope="col">URL Token

</th></tr></thead><tbody><tr><td>Aprovar ou rejeitar  
regras de mercadorias  
pendentes, aprovadas ou rejeitadas no Cockpit

</td><td>Regras

</td><td>POST

</td><td> https://wscockpit.systax.com.br/  
api/api/regras/validar</td><td>[https://app.systax  
.com.br/auth/  
access-token](https://app.systax.com.br/auth/access-token)

</td></tr><tr><td>Consultar regras pendentes no Cockpit</td><td>Regras</td><td>POST</td><td>https://wscockpit.systax.com.br/api/  
api/regras/pendentes</td><td>[https://app.systax  
.com.br/auth/  
access-token](https://app.systax.com.br/auth/access-token)</td></tr></tbody></table>

# Autenticação

A autenticação é feita via JWT bearer token ou Basic Auth.

Para mais informações sobre como gerar o token, acesse a documentação API - Gerar token.

# API de Aprovação ou Rejeição de Regras

# Estrutura dos dados da chamada

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-obri"><tbody><tr><td>**Campo**</td><td>**Descrição**</td><td>**Obrigatório**</td></tr><tr><td>id</td><td>Não tem validação de informação indicada, deve ser retornado como indicação do item no response</td><td>Não</td></tr><tr><td>acao</td><td>Indica qual ação será executada pela API.  
  
**A:** Aprovar regras pendentes, de acordo com os parâmetros informados.  
  
**R:** Rejeitar regras pendentes, de acordo com os parâmetros informados.  
 </td><td>Sim</td></tr><tr><td>cenario</td><td>Aprova ou rejeita regras relacionadas ao cenário indicado</td><td>Não</td></tr><tr><td>natureza</td><td>Aprova ou rejeita regras relacionadas a informação, se recebida</td><td>Não</td></tr><tr><td>ufOrigem</td><td>Aprova ou rejeita regras relacionadas a informação, se recebida</td><td>Não</td></tr><tr><td>ufDestino</td><td>Aprova ou rejeita regras relecionadas a informação, se recebida</td><td>Não</td></tr><tr><td>perfilOrigem</td><td>Aprova ou rejeita regras relacionadas a informação, se recebida</td><td>Não</td></tr><tr><td>perfilDestino</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>munOrigem</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>munDestino</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>finalidade</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>codProduto</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>origemProduto</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>ncm</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>extipi</td><td>Aprova ou rejeita regras, relacionadas a informação, se recebidas</td><td>Não</td></tr><tr><td>ean</td><td>Aprova ou rejeita regras, relacionadas a informação se recebidas</td><td>Não</td></tr><tr><td>periodo</td><td>É indicado no formato dd/mm/aaaa a dd/mm/aaaa e a API aprova ou rejeita regras pendentes dentro desse </td><td> </td></tr></tbody></table>

**Importante:** Caso não seja informado o campo ação, a API irá retornar uma mensagem de erro "o campo acao deve ser indicado".  
**Importante 2:** Se não informado nenhum parâmetro, todas as regras pendentes serão aprovadas ou rejeitadas, de acordo com a ação indicada.  
  
**Códigos de retorno**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-retorno-0-par"><tbody><tr><td>**Código**</td><td>**Retorno**</td></tr><tr><td>0</td><td>Parâmetros incorretos</td></tr><tr><td>1</td><td>Deve ser indicada "acao"</td></tr><tr><td>2</td><td>Retornado com sucesso</td></tr><tr><td>3</td><td>Não existem regras pendentes</td></tr></tbody></table>

# Estrutura dos dados de retorno

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-id-r"><tbody><tr><td>**Campo**</td><td>**Descrição**</td></tr><tr><td>id</td><td>Retorna de acordo com o valor indicado na chamada</td></tr><tr><td>protocolo</td><td>Protocolo gerado no retorno da chamada</td></tr><tr><td>data</td><td>Informa a data em que a ação foi executada</td></tr><tr><td>cod</td><td>Informa o código de retorno, que indica se ação foi executada com sucesso ou não</td></tr><tr><td>message</td><td>Mensagem de retorno, de acordo com o código acima</td></tr></tbody></table>

# Exemplo de chamada

{  
 "itens": \[  
 {  
 "id": 0,  
 "acao": "A",  
 "cenario": "2104488",  
 "natureza": "108",  
 "ufOrigem": "GO",  
 "ufDestino": "SP",  
 "perfilOrigem": "2",  
 "perfilDestino": "578",  
 "munOrigem": "",  
 "munDestino": "",  
 "finalidade": "175",  
 "codProduto": "630797",  
 "origemProduto": "0",  
 "ncm": "01012100",  
 "extipi": "",  
 "ean": "10203040",  
 "periodo": ""  
 }  
 \]  
}

[![API Aprovação e Rejeição de Regras - Exemplo de chamada (Imagem 1).png](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-aprovacao-e-rejeicao-de-regras-exemplo-de-chamada-imagem-1.png)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-aprovacao-e-rejeicao-de-regras-exemplo-de-chamada-imagem-1.png)

# Exemplo de retorno

{  
 "itens": \[  
 {  
 "id": 0,  
 "protocolo": 35,  
 "data": "18/09/2023 16:06:14",  
 "cod": 2,  
 "message": "Retornado com sucesso"  
 }  
 \]  
}

[![API Aprovação e Rejeição de Regras - Exemplo de retorno (Imagem 1).png](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-aprovacao-e-rejeicao-de-regras-exemplo-de-retorno-imagem-1.png)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-aprovacao-e-rejeicao-de-regras-exemplo-de-retorno-imagem-1.png)

# API Consulta de Regras Pendentes

# Estrutura dos dados da chamada

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-obri"><tbody><tr><td>**Campo**</td><td>**Descrição**</td><td>**Obrigatório**</td></tr><tr><td>Id</td><td>Não tem validação de informação indicada, deve ser retornado como indicação do item no response</td><td>Não</td></tr><tr><td>cenario</td><td>Se indicado busca regras pendentes relacionadas ao cenários indicado</td><td>Não</td></tr><tr><td>natureza</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>ufOrigem</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>ufDestino</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>perfilOrigem</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>perfilDestino</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>munOrigem</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>munDestino</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>finalidade</td><td>Se indicado busca regras pendentes com essa infromação</td><td>Não</td></tr><tr><td>codProduto</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>origemProduto</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>ncm</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>extipi</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>ean</td><td>Se indicado busca regras pendentes com essa informação</td><td>Não</td></tr><tr><td>data</td><td>É indicado no formato dd/mm/aaaa a dd/mm/aaaa e a API busca as regras pendentes dentro desse período</td><td>Não</td></tr></tbody></table>

  
<u>**Importante:**</u> 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**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-retorno-0-par"><tbody><tr><td>**Código**</td><td>**Retorno**</td></tr><tr><td>0</td><td>Parâmetros incorretos</td></tr><tr><td>1</td><td>Retornado com sucesso</td></tr><tr><td>2</td><td>Não existem regras pendentes</td></tr></tbody></table>

# 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 chamada

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

[![API Consulta de Regras Pendentes - Exemplo de chamada (Imagem 1).png](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-consulta-de-regras-pendentes-exemplo-de-chamada-imagem-1.png)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-consulta-de-regras-pendentes-exemplo-de-chamada-imagem-1.png)

# 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. "  
 }  
}