Skip to main content

Manual de cadastro de Produtos e Cenários RT (CFM)

Manual contendo as últimas atualizações efetuadas em 17/12/2025

Introdução

Este documento tem por objetivo orientar o time técnico de desenvolvimento dos nossos clientes ...

Acesso

Comunicação: REST/JSON Swagger Cadastros para geração de regrashttps://app.systax.com.br/gerac...

Autenticação

A autenticação das API's de cadastro de produtos e cenários é feita via bearer token. Para mais d...

Consulta de produtos

Retornar informações dos produtos existentes no cadastro de um cliente. Os campos de filtros são ...

Descrição dos campos de retorno

Campo PAI Descrição id produtos ID do produto (Systax) ...

Exemplo de chamada e retorno

Chamada Retorno {  "produtos": [    {      "id": "2002272",      "cod_interno": "10026",   ...

Cadastro de produtos

Cadastrar um ou mais produtos por requisição. Método: POST URL: https://app.systax.com.br/v2/...

Descritivo dos campos da chamada

Chamada Campo PAI Descrição  cod_interno products ID do pro...

Descritivo dos campos do retorno

Retorno Campo PAI Descrição status / Status do retorno ...

Exemplos de chamada e retorno

Chamada {  "products": [    {      "cod_interno": "Produto 04",      "origem_produto": 0,      "...

Consulta de cenários RT

Consultar os cenários da Reforma Tributária existentes no cadastro de um cliente. Os campos de fi...

Descrição dos campos de retorno

Campo Pai Descrição id cenarios ID identificador do cenári...

Exemplo de retorno

{     "success": true,     "message": "ok",     "record_count": 1019,     "pages": 11,  ...

Cadastro de cenários RT

Cadastrar um ou mais cenários (operações do cliente) da Reforma Tributária em uma mesma requisiçã...

Descrição dos campos da chamada

CAMPO PAI DESCRIÇÃO idTributo cenarios Preenchimento padrão ...

Descrição dos campos de retorno

Descrição dos campos de retorno Campo PAI Descrição success / ...

Exemplo de chamada e retorno

Chamada {    "cenarios": [        {            "idTributo": 100,            "apelido": "Teste ...

Consulta grupos de produtos

Consultar os grupos de produtos do cliente. Os campos de filtros são enviados como parâmetros da ...

Descrição dos campos de retorno

  Retorno Campo PAI Descrição success / Status do retorno ...

Exemplos de chamada e retorno

  Chamada Retorno {  "success": true,  "message": "Ok",  "record_count": 1,  "data": [    ...

Associação de produtos e grupos

Possibilita a associação de produtos em um ou mais grupos de produtos. Esta API também criará o g...

Conceito

Este recurso é utilizado para limitar a produção de regras para um determinado cenário de forma q...

Descrição dos campos da chamada

Descrição dos campos de entrada Campo PAI Descrição cod_interno ...

Descrição dos campos de retorno

Campo PAI Descrição success / Status do retorno m...

Exemplos de chamada e retorno

  Chamada {  "products_groups": [    {      "cod_interno": "Produto 02",      "origem_produto":...

Desassociação de produtos e grupos

Contrário ao processo de associação, a desassociação de produtos em grupos de produtos retira o v...

Descrição dos campos da chamada

Campo PAI Descrição action - Contém a palavra "desassociar...

Descrição dos campos de retorno

Campo PAI Descrição success / Status do retorno m...

Exemplos de chamada e retorno

Chamada {    "action": "desassociar",    "products_groups": [        {            "cod_interno":...

Associação/ Desassociação de grupos nos cenários RT

Conforme descrito no capítulo “Associação de produtos/grupos” deste manual, um grupo de produto...

Descrição dos campos da chamada e retorno

  Chamada Campo Descrição acao Opções “associar” e “desassociar” ...

Exemplos de chamada e retorno

Chamada {  "items": [    {      "acao": "associar",      "id_cenario_rt": 206829,      "nome...

Exclusão de produtos

Excluir produtos existentes no cadastro de um cliente. Método: DEL URL: https://app.systax.co...

Tabela de Códigos

  Código de retorno Sucess Message Descrição 200 true ...

Exemplos de chamada e retorno

  Chamada Retorno {    "success": true,    "message": "deleted"}

Exclusão de cenários RT

Excluir um único cenário RT por requisição. Método: DEL URL: https://app.systax.com.br/rt/cen...

Descrição dos campos de retorno

Descrição dos campos de retorno Campo PAI Descrição success / ...

Exemplos de chamada e retorno

Chamada Retorno {     "success": true,     "message": "Deletado" }
Back to top