# 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 e parceiros para automatizar os cadastros necessários à geração de regras tributárias da reforma tributária, que deverão ser monitoradas pela Systax. Assim, as API´s mencionadas nesse documento destinam-se a: 1. Cadastrar, consultar e deletar produtos; 2. Associar ou desassociar produtos a grupos de produtos (incluir um produto na lista de regras que serão geradas para determinado cenário) e consultar os grupos já existentes; 3. Cadastrar, consultar e deletar cenários (operações); 4. Associar ou desassociar grupos de produtos em cenários da Reforma Tributária Esses cadastros, realizados via integração ou não, são necessários para o uso da nossa solução de Parametrização Fiscal. ***Atenção:** Todas as API's que estiverem com a marcação "RT" devem ser utilizadas somente para clientes que optarem exclusivamente pela geração de regras da Reforma Tributária. Portanto, para clientes que já utilizam nossas API's com a tributação atual, será feito um De-Para dos cenários para o formato RT. * # Acesso **Comunicação:** REST/JSON **Swagger Cadastros para geração de regras** [https://app.systax.com.br/geracao-regras-rt/swagger](https://app.systax.com.br/geracao-regras-rt/swagger "https://app.systax.com.br/geracao-regras-rt/swagger") **Listagem dos Endpoints que contemplam o manual de Cadastros para geração das regras**

Descrição	Versão	Grupo Swagger	Método	URL Endpoint
Consulta lista de produtos	v2	Produtos v2	GET	[https://app.systax.com.br/v2/cfm/products](https://app.systax.com.br/v2/cfm/products)
Cadastro de produtos	v2	Produtos v2	POST	[https://app.systax.com.br/v2/cfm/products/multi](https://app.systax.com.br/v2/cfm/products/multi)
Consulta de cenários RT	-	Cenarios	GET	[https://app.systax.com.br/cadastro-geral/rt/cenarios](https://app.systax.com.br/cadastro-geral/rt/cenarios)
Cadastro de cenários RT	-	Cenarios	POST	[https://app.systax.com.br/rt/cenarios](https://app.systax.com.br/rt/cenarios)
Consulta de grupos de produtos	-	Consulta de grupos de produtos	GET	[https://app.systax.com.br/cadastro-geral/groups](https://app.systax.com.br/cadastro-geral/groups)
Associação de produtos/grupos	-	Associação de produtos ao grupo	POST	[https://app.systax.com.br/cadastro-geral/assoc/products-groups](https://app.systax.com.br/cadastro-geral/assoc/products-groups)
Dessociação de produtos/grupos	-	Desassociação de produtos ao grupo	POST	[https://app.systax.com.br/cadastro-geral/desassociar/products-groups](https://app.systax.com.br/cadastro-geral/desassociar/products-groups)
Excluir produto	-	Produtos v2	DEL	https://app.systax.com.br/v2/cfm/products/
Exclusão cenários RT	v2	Cenários	DEL	[https://app.systax.com.br/rt/cenarios/](https://app.systax.com.br/rt/cenarios/){}
Associação/ Desassociação de grupos nos cenários RT	-	Cenários Grupos Assoc.	POST	[https://app.systax.com.br/rt/cenarios-rt/grupos/operations-assoc](https://app.systax.com.br/rt/cenarios-rt/grupos/operations-assoc "https://app.systax.com.br/rt/cenarios-rt/grupos/operations-assoc")

# Autenticação A autenticação das API's de cadastro de produtos e cenários é feita via bearer token. Para mais detalhes de como obtê-la, acesse a última versão de documentação pelo link: [https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token](https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token) # Consulta de produtos Retornar informações dos produtos existentes no cadastro de um cliente. Os campos de filtros são enviados como parâmetros na URL endpoint (não há body). Consultar o Swagger para obter os filtros possíveis. **Método:** GET - **URL (Cadastro unitário):** [https://app.systax.com.br/v2/cfm/products](https://app.systax.com.br/v2/cfm/products) # Descrição dos campos de retorno

Campo	PAI	Descrição
id	produtos	ID do produto (Systax)
cod\_interno	produtos	ID do produto (Cliente)
origem\_produto	produtos	Origem do produto
ean	produtos	EAN do produto
descricao	produtos	Descrição do produto
descricao\_sugerida	produtos	Descrição sugerida do produto pela Systax
complemento	produtos	Complemento do produto
ncm\_original	produtos	NCM original do produto
ex\_tipi\_original	produtos	Ex TIPI original do produto
ncm\_sugerida	produtos	NCM do produto sugerida pela Systax
ex\_tipi\_sugerida	produtos	Ex TIPI do produto sugerida pela Systax
ncm\_definitiva	produtos	NCM definitiva
ex\_tipi\_definitiva	produtos	Ex TIPI definitiva do produto
status\_atual	produtos	Status do produto
duvida\_tecnica	produtos	Dúvida Técnica
resposta\_tecnica	produtos	Resposta Técnica
fundamentacao	produtos	Fundamento técnico
dt\_classificacao	produtos	Data de classificação do produto
data\_criacao	produtos	Data de criação do produto
username\_criacao	produtos	Usuário responsável pela criação do produto
total\_registros	paginacao	Total de registros retornados
num\_paginas	paginacao	Total de páginas
por\_pagina	paginacao	Quantidade de itens por página
pagina\_atual	paginacao	Página atual
itens\_da\_pagina	paginacao	Quantidade de itens por página
success	/	Status do retorno
message	/	Mensgem do retorno

**Tabela de referência para o campo "origem\_produto":** Para obter a tabela completa do campo mencionado acima, acesse o link: [https://documentacao.systax.com.br/books/tabelas-auxiliares/page/origem-do-material](https://documentacao.systax.com.br/books/tabelas-auxiliares/page/origem-do-material) **Tabela de referência para os campos "success" e "message":**

Código de retorno	success	message
200	true	OK
200	false	not\_found
400	false false	token\_invalid token\_expired
500	false	internal\_error

# Exemplo de chamada e retorno **Chamada** [![Consulta - Exemplo Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/7C2consulta-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/7C2consulta-exemplo-chamada.PNG) **Retorno** { "produtos": \[ { "id": "2002272", "cod\_interno": "10026", "origem\_produto": "0", "ean": "7891024194102", "descricao": "DESINF PINHO SOL 500ML ORIGINAL", "descricao\_sugerida": "", "complemento": "", "ncm\_original": "96032900", "ex\_tipi\_original": "", "ncm\_sugerida": "", "ex\_tipi\_sugerida": "", "ncm\_definitiva": "96032900", "ex\_tipi\_definitiva": "", "status\_atual": "classificado", "duvida\_tecnica": "", "resposta\_tecnica": "", "fundamentacao": "", "dt\_classificacao": "", "data\_criacao": "02\\/06\\/2017 10:58:56", "username\_criacao": "superdemo" } \], "success": true, "message": "ok" } # Cadastro de produtos Cadastrar um ou mais produtos por requisição. **Método:** POST - **URL:** https://app.systax.com.br/v2/cfm/products/multi Obs.1: esta versão permite informar o código CEST do produto para que a Systax o considere no tratamento e geração do retorno tributário. Obs.2: esta API acata automaticamente a CEST informada. Porém, se o cadastrante entende que o produto não tem CEST e quer que a Systax retorne a regra tributária considerando isso, será necessário alinhar previamente com o Time Systax para que façamos a configuração necessária para este cliente e incluamos no seu fluxo de atendimento o tratamento manual para estes itens. Após as devidas tratativas, para estes casos, as chamadas devem conter "true" no campo "use\_cest" e o campo "cest" deverá ser enviado vazio. Obs. 3: Ao cadastrar um cenário, os campos "perfil\_origem" e "perfil\_destinacao" devem ser preenchidos com os códigos exclusivos da Reforma Tributária, uma vez que esta API está parametrizada para validar estes campos. Na ocorrência de inserção de código da tributação atual, a API retornará uma mensagem de erro. # Descritivo dos campos da chamada **Chamada**

Campo	PAI	Descrição
cod\_interno	products	ID do produto (código interno do Cliente)
origem\_produto	products	Origem do produto
descricao	products	Descrição do produto
complemento	products	Complemento do produto
ean	products	EAN do produto
ncm\_original	products	NCM do produto
ex\_tipi\_original	products	Ex TIPI do produto
use\_cest	products	Indica se a Systax deve respeitar o código CEST indicado na chamada como parâmetro de tratamento e retorno tributário. Assim, temos 3 possibilidades: 1\) Se preenchido com "true" e informado EAN na chamada, a Systax comparará o CEST da chamada com o que será entregue pela Systax, a partir do tratamento por EAN + origem do material. Sendo a CEST compatível, o sistema seguirá com o fluxo padrão, ou seja, cadastro do item novo e geração de regras para ele dentro dos cenários devidos. Caso seja incompatível, o retorno evidenciará a incompatibilidade, apresentando a CEST que a Systax entende correta e o produto não será cadastrado. 2\) Se preenchido com "true" e informada apenas NCM (sem EAN) na chamada, a Systax validará se essa CEST é possível para a NCM da chamada. Sendo a CEST compatível, o sistema seguirá com o fluxo padrão, ou seja, cadastro do item novo e geração de regras para ele dentro dos cenários devidos. Caso seja incompatível, o retorno evidenciará a incompatibilidade e o produto não será cadastrado. 3\) Se preenchido com "false" ou se não informada a tag, o produto será inserido sem essa informação e o tratamento seguirá como padrão, por EAN ou NCM.
cest	products	CEST do produto (somente é necessário se "use\_cest" = "true")

**Tabela de referência para o campo "origem\_produto":** Para obter a tabela completa do campo acima, acesse o link: [https://documentacao.systax.com.br/books/tabelas-auxiliares/page/remetenteperfil-origem](https://documentacao.systax.com.br/books/tabelas-auxiliares/page/remetenteperfil-origem) # Descritivo dos campos do retorno **Retorno**

Campo	PAI	Descrição
status	/	Status do retorno
itens	/	Quantidade de itens na chamada
itens\_ok	/	Quantidade de itens inseridos
position	insert\_ids	Posição do item na chamada
cod\_interno	insert\_ids	ID do produto (Cliente)
origem\_produto	insert\_ids	Origem do produto
id	insert\_ids	ID do produto (Systax)

**Tabela de referência para os campos "success" e "message":**

Código de retorno	success	message
200	true	ok
400	false false	An error while decoding token Provided token is expired.
401	false	Token not provided

**Tabela de referência para os retornos via CEST:**

Success	Message	Descrição
true	RETORNO COM SUCESSO	A CEST é válida para a NCM informada e foi possível o tratamento do item com sucesso.
false	CEST INCOMPATIVEL	Pode estar acompanhado das "message\_cest" abaixo, para esclarecimento do motivo de incompatibilidade.

		"message\_cest": "o produto não possui CEST"
		"message\_cest": "lista CEST válida(s): XXXXX"
		"message\_cest": "NCM encontrada: XXXXX"
false	CEST NÃO LOCALIZADA	Não encontrou nenhuma CEST
false	NAO FOI POSSIVEL CADASTRAR	Para casos de chamada com use\_cest=true e CEST=vazio e não existe produto compatível pre-existente na Systax.

		Este caso, provavelmente precisará de atuação de um consultor Systax e estará acompanhado de uma das "message\_cest" abaixo:
		"message\_cest": EAN possui CEST
		"message\_cest": NCM possui CEST
		"message\_cest": não existe produto na base Systax sem CEST para vincular
		"msg": "item sem configuracao"

		Esta mensagem será exibida quando o produto Systax de referência precisa de tratamento manual de um consultor Systax.

# Exemplos de chamada e retorno **Chamada** { "products": \[ { "cod\_interno": "Produto 04", "origem\_produto": 0, "descricao": "Produto 04", "complemento": "", "ean": "", "ncm\_original": "", "ex\_tipi\_original": "", "use\_cest": "true", "cest": "2001200" }, { "cod\_interno": "Produto 05", "origem\_produto": 0, "descricao": "Produto 05", "complemento": "", "ean": "", "ncm\_original": "", "ex\_tipi\_original": "" }, { "cod\_interno": "Produto 06", "origem\_produto": 0, "descricao": "Produto 06", "complemento": "", "ean": "", "ncm\_original": "", "ex\_tipi\_original": "", "use\_cest": "true", "cest": "" } \] } **Retorno** { "status": "Ok", "itens": 3, "itens\_ok": 3, "insert\_ids": \[ { "position": 0, "cod\_interno": "Produto 04", "origem\_produto": 0, "id": "11793766" }, { "position": 1, "cod\_interno": "Produto 05", "origem\_produto": 0, "id": "11793767" }, { "position": 2, "cod\_interno": "Produto 06", "origem\_produto": 0, "id": "11793768" "message\_cest": "validacao\_ok" } \], "itens\_error": 0, "errors": \[\], "success": true, "message": "ok" } # Consulta de cenários RT Consultar os cenários da Reforma Tributária existentes no cadastro de um cliente. Os campos de filtros são enviados como parâmetros da URL endpoint da requisição (não há body). Consultar o Swagger para obter os filtros possíveis. **Método:** GET - **URL:** https://app.systax.com.br/cadastro-geral/cenarios # Descrição dos campos de retorno

Campo	Pai	Descrição
id	cenarios	ID identificador do cenário
idCliente	cenarios	ID identificador do cliente
ativo	cenarios	Indica se o cenário está ativo ou não. Preenchimento com "Sim" ou "Não"
idTributo	cenarios	Preenchimento padrão sendo "100" - IBS Master
apelido	cenarios	Descrição do cenário
diasFuturos	cenarios	Prenchimento padrão: "30". Refere-se à vigência da regra entregue.
entSai	cenarios	Tipo entrada/saída sendo "1"para Entradas e "3" para Saídas
naturezaOperacao	cenarios	Código de natureza de operação
finalidade	cenarios	Código de finalidade
ufOrigem	cenarios	UF do remetente
municipioOrigem	cenarios	ID município do remetente
ufDestino	cenarios	UF do destinatário
municipioDestino	cenarios	ID município do destinatário
ufEntrega	cenarios	Sigla da UF de entrega da
ufEntrega	cenarios	mercadoria
municipioEntrega	cenarios	ID município do entrega
municipioExecucao	cenarios	ID município do execução
perfilOrigem	cenarios	Perfil do remetente
cnaeOrigem	cenarios	CNAE do remetente - Preencher somente se houver orientação específica do time Systax.
perfilDestino	cenarios	Perfil do destinatário
cnaeDestino	cenarios	CNAE do destinatário
prestador	cenarios	Perfil do prestador de um serviço
tomador	cenarios	Perfil do tomador de um serviço
executor	cenarios	Perfil do executor de um serviço
origemProdAlternativo	cenarios	Uso interno Systax
dataCriacao	cenarios	Data de criação do cenário

**Tabela de referência para o campo "ent\_sai"**

ent\_sai	Descrição
0	Entrada
1	Saída

**Tabelas de referência para os campos "perfilOrigem", "perfilDestino", "finalidade" e "cod\_nat\_op"** Para obter informações sobre as tabelas dos campos acima, acesse o link: [https://documentacao.systax.com.br/books/tabelas-auxiliares](https://documentacao.systax.com.br/books/tabelas-auxiliares) # Exemplo de retorno

{

"success": true,

"message": "ok",

"record_count": 1019,

"pages": 11,

"data": [

{

"id": 81,

"idCliente": 71408,

"ativo": true,

"idTributo": 100,

"apelido": "Venda-SP-SP-Ind-Atacado",

"frequencia": 30,

"diasFuturos": 30,

"entSai": 3,

"naturezaOperacao": 120,

"finalidade": 0,

"ufOrigem": "SP",

"municipioOrigem": null,

"ufDestino": "SP",

"municipioDestino": null,

"ufEntrega": null,

"municipioEntrega": null,

"municipioExecucao": null,

"perfilOrigem": "1551",

"cnaeOrigem": null,

"perfilDestino": "3041",

"cnaeDestino": null,

"prestador": null,

"tomador": null,

"executor": null,

"origemProdAlternativo": null,

"dataCriacao": "2024-11-12 07:49:00"

}

]

}

# Cadastro de cenários RT Cadastrar um ou mais cenários (operações do cliente) da Reforma Tributária em uma mesma requisição. **Método:** POST - **URL:** https://app.systax.com.br/rt/cenarios[](https://app.systax.com.br/v2/cfm/products) A criação de cenário com parâmetros errados, gerará retorno tributário errado para todos os itens do cenário incorreto. Caso tenha necessidade de alterar algum cenário cadastrado com erro, será preciso deletá-lo e cadastrar um novo correto ou acionar o nosso time e solicitar o ajuste. **ATENÇÃO:** Antes de iniciar o cadastro de cenários, leia atentamente o nosso "Roteiro de cenários", disponível no link: [https://documentacao.systax.com.br/books/manual-para-criacao-de-cenarios](https://documentacao.systax.com.br/books/roteiro-para-criacao-de-cenarios). # Descrição dos campos da chamada

CAMPO	PAI	DESCRIÇÃO
idTributo	cenarios	Preenchimento padrão sendo "100" - IBS Master
apelido	cenarios	Descrição do cenário
dias\_futuros	cenarios	Prenchimento padrão: "30". Refere-se à vigência da regra entregue.
ent\_sai	cenarios	Tipo entrada/saída sendo "1"para Entradas e "3" para Saídas
cod\_nat\_op	cenarios	Código de natureza de operação
finalidade	cenarios	Código de finalidade
uf\_origem	cenarios	UF do remetente
id\_mun\_origem	cenarios	Código IBGE do município do remetente - Preencher somente para municípios com tributação diferenciada (ex.: municípios localizados na ZFM e ALC).
uf\_destino	cenarios	UF do destinatário
id\_mun\_destino	cenarios	Código IBGE do município do destinatário - Preencher somente para municípios com tributação diferenciada (ex.: municípios localizados na ZFM e ALC).
ufEntrega	cenarios	Sigla da UF de entrega da
ufEntrega	cenarios	mercadoria
municipioEntrega	cenarios	Código de Município de entrega da operação. Deve ser utilizada a Tabela de código de Município mantida pelo IBGE disponível em: Tabela Códigos dos Municípios - IBGE
municipioExecucao	cenarios	Código de Município de execução da operação. Deve ser utilizada a Tabela de código de Município mantida pelo IBGE disponível em: Tabela Códigos dos Municípios - IBGE
perfilOrigem	cenarios	Perfil do remetente
cnae\_origem	cenarios	CNPJ do remetente - Preencher somente se houver orientação específica do time Systax.
perfilDestino	cenarios	Perfil do destinatário
cnae\_destinatario	cenarios	CNAE do destinatário - Preencher somente para casos de tributação por CNAE (ex.: operações com destino a MT ou CE).
prestador	cenarios	Perfil do prestador de um serviço
tomador	cenarios	Perfil do tomador de um serviço
executor	cenarios	Perfil do executor de um serviço
origem\_produto\_ alternativo	cenarios	Preencher somente se houver orientação específica do time Systax.

***IMPORTANTE:** para os campos em que não for necessário o preenchimento, não enviar a tag ou enviar sem preenchimento.* **Tabela de referência para o campo "ent\_sai":**

ent\_sai	Descrição
1	Entrada
3	Saída

**Tabela de referência para os campos "cod\_nat\_op", "finalidade", "perfilOrigem" e "perfilDestinacao":** Para obter a tabela com os principais códigos dos campos acima, acesse a última versão de documentação no link: [https://documentacao.systax.com.br/books/tabelas-auxiliares](https://documentacao.systax.com.br/books/tabelas-auxiliares). Caso tenha alguma situação específica e não localize nas tabelas um código compatível com a necessidade, acione nosso time para que possamos lhe dar orientações assertivas # Descrição dos campos de retorno **Descrição dos campos de retorno**

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
total\_itens	/	Quantidade de cenários na chamada
total\_ok	/	Quantidade de cenários cadastrados
position	itens\_ok	Posição do cenário na chamada
id	itens\_ok	ID do cenário cadastrado
total\_error	/	Quantidade de cenários não cadastrados
message	itens\_error	Mensagem do retorno

**Tabela de referência para os campos "success" e "message"**

Código de retorno	success	message
200	true	OK
400	false	token\_invalid
400	false	token\_expired
400	false	cenário já cadastrado com esses parâmetros
422	false	"Criado apenas "\[quantidade de cenários criados\]" cenários, pois a solicitação excede a quantidade de regras enviado para Trial".
500	false	internal\_error

# Exemplo de chamada e retorno **Chamada** { "cenarios": \[ { "idTributo": 100, "apelido": "Teste - MG-AM-ImpInd-AtcVar", "diasFuturos": 30, "entSai": 3, "naturezaOperacao": 121, "finalidade": "", "ufOrigem": "MG", "municipioOrigem": "4101606", "ufDestino": "AM", "municipioDestino": "4101606", "ufEntrega": "", "municipioEntrega": "4101606", "municipioExecucao": "4101606", "perfilOrigem": "1573", "cnaeOrigem": "", "perfilDestino": "3044", "cnaeDestino": "", "prestador": "", "tomador": "", "executor": "", "origemProdAlternativo": "5" } \] } **Retorno** { "success": true, "message": "ok", "total\_itens": 1, "total\_ok": 1, "itens\_ok": \[ { "position": 0, "id": 56599 } \], "total\_error": 0, "itens\_error": \[\] } # Consulta grupos de produtos Consultar os grupos de produtos do cliente. Os campos de filtros são enviados como parâmetros da requisição (não há body). Consultar o Swagger para obter os filtros possíveis. **Método:** GET - **URL:** https://app.systax.com.br/cadastro-geral/groups # Descrição dos campos de retorno **Retorno**

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
record\_count	/	Número de registros retornados
id	data	ID do grupo
descricao	data	Descrição do grupo

**Tabela de referência para os campo "success" e "message"**

Código de retorno	success	message
200	true	OK
400	false	token\_invalid
400	false	token\_expired
500	false	internal error

# Exemplos de chamada e retorno **Chamada** [![Exemplo Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/exemplo-chamada.PNG) **Retorno** { "success": true, "message": "Ok", "record\_count": 1, "data": \[ { "id": "135146", "descricao": "SP-SP-235-137-2" } \] } # 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 grupo de produtos indicado na chamada de associação, caso ele ainda não exista. Criamos um video para exemplificar os conceitos descritos neste tópico. Sugerimos que, após a leitura, [**assista este vídeo**](https://www.dropbox.com/scl/fi/ee8zpy9tq5v5qivln6y4q/AssocProdAoGrupo-Rafael.mp4?rlkey=td2iofju2qi40u9ifh6hl86fa&dl=0) para melhor compreensão. **Método:** POST - **URL:** https://app.systax.com.br/cadastro-geral/assoc/products-groups # Conceito Este recurso é utilizado para limitar a produção de regras para um determinado cenário de forma que a Systax gere para o cliente apenas as regras que, de fato, ele utilizará, evitando o esforço e o custo do recebimento de dados desnecessários. Em regra, nem todos os produtos do cliente são movimentados em todas as operações (geralmente isso ocorre nas compras), assim esse recurso permite a relação “N-N” entre produtos e cenários. Vejamos o exemplo abaixo de um cliente com 1.000 produtos cadastrados:

Cenários	Grupo de produtos	nº regras a receber da Systax
Compra SP-SP	Comprados de SP	997
Compra RJ-SP	Comprados de RJ	3
Compra AM-SP	Comprados de AM	2
Venda SP-SP	-	1000

Internamente, o sistema terá a lista de produtos que compõem cada grupo (ex.: Comprados do AM: produtos “E” e “F”) e, sempre que um cenário estiver com um grupo associado (ex.: o Grupo de Produtos “Comprados do AM” estará associado ao cenário “Compra AM-SP”), somente serão geradas regras para os produtos movimentados nesta operação (ex.: para o cenário “Compra AM-SP” serão geradas regras apenas para os produtos “E” e “F”). **Descrição dos campos de entrada**

Campo	PAI	Descrição
cod\_interno	products\_groups	ID do produto (Cliente)
origem\_produto	products\_groups	Origem do produto
descricao	grupos	Descrição do grupo de produtos

Link para consulta da tabela de referência para o campo "origem\_produto": [https://documentacao.systax.com.br/books/tabelas-auxiliares](https://documentacao.systax.com.br/books/tabelas-auxiliares) # Descrição dos campos da chamada **Descrição dos campos de entrada**

Campo	PAI	Descrição
cod\_interno	products\_groups	ID do produto (Cliente)
origem\_produto	products\_groups	Origem do produto
descricao	grupos	Descrição do grupo de produtos

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
itens	/	Quantidade de itens na chamada
itens\_ok	/	Quantidade de itens encontrados (existentes)
position	assocs\_ok	Posição do item na chamada
cod\_interno	assocs\_ok	ID do produto (Cliente)
origem\_produto	assocs\_ok	Origem do produto
descricao	grupos	Descrição do grupo
msg	grupos	Mensagem de retorno referente a associação
itens\_error	/	Quantidade de itens

**Tabela de referência para o campo "success" e "message"**

Código de retorno	sucess	message
200	true	OK
400	false false	token\_invalid token\_expired
500	false	internal\_error

**Tabela de referência para o campo "msg"**

msg	Descrição
assoc\_ok	Associação realizada com sucesso
assoc\_already\_exists	Associação já existente

# Exemplos de chamada e retorno **Chamada** { "products\_groups": \[ { "cod\_interno": "Produto 02", "origem\_produto": 0, "grupos": \[ { "descricao": "GRUPO 1" }, { "descricao": "GRUPO 3" } \] }, { "cod\_interno": "Produto 03", "origem\_produto": 0, "grupos": \[ { "descricao": "GRUPO 1" }, { "descricao": "GRUPO 3" } \] } \] } **Retorno** { "success": true, "message": "ok", "itens": 2, "itens\_ok": 2, "assocs\_ok": \[ { "position": 0, "cod\_interno": "Produto 02", "origem\_produto": 0, "grupos": \[ { "descricao": "GRUPO 1", "msg": "assoc\_ok" }, { "descricao": "GRUPO 3", "msg": "assoc\_ok" } \] }, { "position": 1, "cod\_interno": "Produto 03", "origem\_produto": 0, "grupos": \[ { "descricao": "GRUPO 1", "msg": "assoc\_ok" }, { "descricao": "GRUPO 3", "msg": "assoc\_ok" } \] } \], "itens\_error": 0, "assocs\_error": \[\] } # 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ínculo feito anterior com um grupo de produtos, extinguindo o grupo caso não tenha mais nenhum outro produto associado. **Método:** POST - **URL:** https://app.systax.com.br/cadastro-geral/desassociar/products-groups # Descrição dos campos da chamada

Campo	PAI	Descrição
action	-	Contém a palavra "desassociar"
cod\_interno	products\_groups	ID do produto (Cliente)
origem\_produto	products\_groups	Origem do produto
descricao	grupos	Descrição do grupo de produtos

# Descrição dos campos de retorno

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
itens	/	Quantidade de itens na chamada
itens\_ok	/	Quantidade de itens encontrados (existentes)
desassoc\_ok	/	Confirmação da desassociação
position	assocs\_ok	Posição do item na chamada
cod\_interno	assocs\_ok	ID do produto (Cliente)
origem\_produto	assocs\_ok	Origem do produto
descricao	grupos	Descrição do grupo
msg	grupos	Mensagem de retorno referente a desassociação
itens\_error	/	Quantidade de itens
desassocs\_error	/	Mensagem de possíveis erros na desassociação

**Tabela de referência para o campo "success" e "message"**

Código de retorno	sucess	message
200	true	OK
400	false false	token\_invalid token\_expired
500	false	internal\_error

**Tabela de referência para o campo "msg"**

msg	Descrição
desassoc\_ok	Desassociação realizada com sucesso
desassoc\_not\_found	Desassociação não efetuada

# Exemplos de chamada e retorno **Chamada** { "action": "desassociar", "products\_groups": \[ { "cod\_interno": "10026", "origem\_produto": 0, "grupos": \[ { "descricao": "Grupo Teste V1" } \] }, { "cod\_interno": "22970", "origem\_produto": 0, "grupos": \[ { "descricao": "Grupo Teste V1" } \] } \] } **Retorno** { "success": true, "message": "ok", "itens": 1, "itens\_ok": 1, "desassocs\_ok": \[ { "position": 0, "cod\_interno": "10026", "origem\_produto": 0, "grupos": \[ { "id": 1187737, "descricao": "Grupo Teste V1", "msg": "desassoc\_ok" } \] } \], "itens\_error": 0, "desassocs\_error": \[\] } # 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 produtos serve para otimizar o volume de regras que serão geradas pela Systax, de forma que em cada cenário sejam geradas regras apenas para os produtos movimentados neste cenário, fazendo com que nosso cliente receba somente as regras que ele realmente utilizará. Dito isso, esta API possibilita associar ou desassociar um grupo de produtos de um cenário existente da Reforma Tributária. Para os casos em que ocorrerem erros como cenário ou grupo não existente, grupo já associado anteriormente etc., a API irá informar a ocorrência conforme mensagem específica. **Método:** POST - **URL:** https://app.systax.com.br/cadastro-geral/cenarios/grupos/operations-assoc # Descrição dos campos da chamada e retorno **Chamada**

Campo	Descrição
acao	Opções “associar” e “desassociar”
id\_cenario	ID do cenário do cliente
nome\_grupo	Nome do grupo de produtos

**Retorno**

Campo	Descrição
success	Status de retorno
message	Mensagem de retorno
itens	Quantidade de itens da chamada
status	Indicador numérico do tipo de status retornado
message	Mensagem relacionado ao status retornado
acao	Opção selecionada de associar ou desassociar
id\_cenario	ID do cenário do cliente
nome\_grupo	Nome do grupo de produtos

**Tabela de referência para o campo “success” e “message”**

Código de retorno	sucess	message
200	true	OK
400	false false false	token\_invalid token\_expired Username ou Password inválido
500	false	internal\_error

**Tabela de referência para o campo “msg”**

Campo	nº ordem	Descrição
Status	0	Sucesso
	1	Cenário não localizado
	2	Grupo de Produtos não localizado
	3	Grupo de Produtos já associado a este cenário
	4	Grupo de Produtos não consta como associado a este cenário

# Exemplos de chamada e retorno **Chamada** { "items": \[ { "acao": "associar", "id\_cenario\_rt": 206829, "nome\_grupo": "000005" }, { "acao": "desassociar", "id\_cenario\_rt": 208547, "nome\_grupo": "Pentest" } \] } **Retorno** { "success": true, "message": "Ok", "items": \[ { "status": 0, "message": "Sucesso", "acao": "associar", "id\_cenario\_rt": 206829, "nome\_grupo": "000005" }, { "status": 0, "message": "Sucesso", "acao": "desassociar", "id\_cenario\_rt": 208547, "nome\_grupo": "Pentest" } \] } # Exclusão de produtos Excluir produtos existentes no cadastro de um cliente. **Método:** DEL - **URL:** https://app.systax.com.br/v2/cfm/products/ Obs.: para envio da chamada substituir "{id}" pelo id do produto (código gerado pela Systax e retornado nos endpoints de cadastro ou de consulta de produtos) que deverá ser deletado. # Tabela de Códigos

Código de retorno	Sucess	Message	Descrição
200	true	deleted	Exclusão realizada com sucesso
400	false	id\_not\_found	ID informado não foi encontrado
400	false	token\_invalid	Token informado não é válido
400	false	token\_expired	Token informado expirou
400	false	missing\_token	Token não foi informado
500	false	internal\_error	Erro interno da API

# Exemplos de chamada e retorno **Chamada** [![Exclusão produtos - Exemplo Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/exclusao-produtos-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/exclusao-produtos-exemplo-chamada.PNG) **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/cenarios/{}[](https://app.systax.com.br/v2/cfm/products) O ID do cenário é enviado como parâmetro da requisição. O parâmetro para exclusão (ID Cenário) é enviado na URL endpoint (não há body). Obs.: ID Cenário é um código gerado pela Systax e retornado nos endpoints de cadastro ou de consulta de cenários. # Descrição dos campos de retorno **Descrição dos campos de retorno**

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno

**Tabela de referência para os campos "success" e "message"**

Código de retorno	success	message
200	true	Sucesso
400	false false	token\_invalid token\_expired
500	false	internal\_error

# Exemplos de chamada e retorno **Chamada** [![Exclusão - Exemplo Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/exclusao-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/exclusao-exemplo-chamada.PNG) **Retorno** { "success": true, "message": "Deletado" }