Manual Cadastro Geral (CFM)
Manual contendo as últimas atualizações efetuadas em 15/12/2021.

Introdução
Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações internas ao Systax. Com o objetivo de facilitar esse processo de integração, a Systax possui um módulo de integração construído na forma de um webservice o que garante a interoperabilidade com sistemas desenvolvidos em linguagens e plataformas diversas.

Webservice
Padrão de comunicação : O meio físico de comunicação será a internet com o modelo de comunicação padrão de webservices definido pelo WS-I Basic Profile, utilizando SOAP na troca de mensagens entre as aplicações, com XML no padrão Style/Enconding: Document/Literal, wrapped. 

 WSDL :  https://www.systax.com.br/systaxcadastroretorno_geral_04/services/Cadastro?wsdl

Associação de Produto e Grupo
Associa um produto á um ou mais grupos de produtos no Portal de Classificação Fiscal.

Observações da funcionalidade
O nome do grupo pode ser criado da forma que melhor represente o agrupamento de produtos do cliente, mas recomendamos que seja criado conforme o padrão abaixo: 

 

 UFORIGEM-UFDESTINO-NATUREZADEOPERACAO-PERFILORIGEM-PERFILDESTINACAO-FINALIDADE 

 

 Exemplo: SP-SP-120-1-140-569. Essa notação permite que os grupos sejam facilmente associados aos seus respectivos cenários. 

 A opção "Finalidade" não é obrigatória e será utilizada somente para cenários de entrada. 

 É importante frisar que a não associação de produtos a grupos determina que sejam criadas regras tributárias para todos os cenários sem grupos disponíveis, o que nem sempre é necessário.

Descrição dos campos de chamada e retorno
  

 Chamada 

 

 

 

 

 Pai 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 associarProdutoGrupos 

 

 

 usuário 

 

 

 String 

 

 

 Usuário do Portal CFM 

 

 

 Sim 

 

 

 

 

 associarProdutoGrupos 

 

 

 senha 

 

 

 String 

 

 

 Senha 

 

 

 Sim 

 

 

 

 

 associarProdutoGrupos 

 

 

 xmlGrupoProdutos 

 

 

 String 

 

 

 XML 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Pai 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 produto 

 

 

 cProd 

 

 

 Código de produto 

 

 

 

 

 produto 

 

 

 codigo 

 

 

 Código da mensagem de retorno 

 

 

 

 

 grupo 

 

 

 ID 

 

 

 ID do grupo 

 

 

 

 

 grupo 

 

 

 codigo 

 

 

 Código da mensagem de retorno 

 

 

 

 

 grupo 

 

 

 mensagem 

 

 

 Mensagem de retorno 

 

 

 

 

 grupo 

 

 

 nomeGrupo 

 

 

 Nome do grupo de produto

Exemplo de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br">    <soap:Header/>    <soap:Body>       <sys:associarProdutoGrupo>          <sys:usuario>superdemo</sys:usuario>          <sys:senha>systax741</sys:senha>          <sys:xmlGrupoProdutos><![CDATA[ 

 

 

  <systaxCadastro> 

 

 

 

  <produto> 

 

 

 

 

  <cProd>94394394</cProd> 

 

 

 

 

  <orig>0</orig> 

 

 

 

 

  <grupos>                           

  <grupo>MG-MG-121-3,134-140</grupo>                           

  <grupo>MG-AC-121-3,134-140</grupo>                          </grupos> 

 

 

 

  </produto>

 

 

 

 

 

 

 

 

 

 

 

 

  </systaxCadastro>]]></sys:xmlGrupoProdutos>       </sys:associarProdutoGrupo>    </soap:Body> </soap:Envelope> 

 Observação : A tag <grupo> pode ser adicionada de acordo com a quantidadade necessária pelo cliente. 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">    <soapenv:Body>       <ns:associarProdutoGrupoResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:nil="true"/>             <ax21:produto xsi:type="ax21:Produto">                <ax21:ID xsi:nil="true"/>                <ax21:cProd>P0123</ax21:cProd>                <ax21:codigo>128</ax21:codigo>                <ax21:grupos xsi:type="ax21:Grupos">                   <ax21:grupo xsi:type="ax21:Grupo">                      <ax21:ID>82393179</ax21:ID>                      <ax21:codigo>128</ax21:codigo>                      <ax21:mensagem>Grupo associado com sucesso. Cenário já existente.</ax21:mensagem>                      <ax21:nomeGrupo>grupoABC</ax21:nomeGrupo>                   </ax21:grupo>                   <ax21:grupo xsi:type="ax21:Grupo">                      <ax21:ID>82393180</ax21:ID>                      <ax21:codigo>128</ax21:codigo>                      <ax21:mensagem>Grupo associado com sucesso. Cenário já existente.</ax21:mensagem>                      <ax21:nomeGrupo>grupoDEF</ax21:nomeGrupo>                   </ax21:grupo>                   <ax21:grupo xsi:type="ax21:Grupo">                      <ax21:ID>82393181</ax21:ID>                      <ax21:codigo>128</ax21:codigo>                      <ax21:mensagem>Grupo associado com sucesso. Cenário já existente.</ax21:mensagem>                      <ax21:nomeGrupo>grupoGHI</ax21:nomeGrupo>                   </ax21:grupo>                </ax21:grupos>                <ax21:mensagem>Grupo associado com sucesso. Cenário já existente.</ax21:mensagem>                <ax21:orig>0</ax21:orig>             </ax21:produto>          </ns:return>       </ns:associarProdutoGrupoResponse>    </soapenv:Body> </soapenv:Envelope> 

 

 Obs.: 

 Quando a chamada possuí mais de um grupo associado ao produto, é criado um código de retorno para cada grupo envolvido na requisição (em verde), e também, um código de retorno isolado (em amarelo). Veja abaixo: 

 

 Quando há apenas um único grupo envolvido na requisição, os códigos de retorno são iguais conforme na imagem: 

 

 Para fins de integração, recomenda-se obter sempre os códigos de retorno envolvidos nos grupos (em verde). O código de retorno (em amarelo) é usado apenas por integrações desenvolvidas anteriormente.

 

  

Ativar Produtos
Ativa um ou mais produtos no Portal de Classificação Fiscal.

Descrição dos campos de chamada e retorno
  

 Chamada 

 

 

 

 

 Pai 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 ativarProdutos 

 

 

 usuário 

 

 

 String 

 

 

 Usuário do Portal CFM 

 

 

 Sim 

 

 

 

 

 ativarProdutos 

 

 

 senha 

 

 

 String 

 

 

 Senha 

 

 

 Sim 

 

 

 

 

 ativarProdutos 

 

 

 xmlProdutos 

 

 

 String 

 

 

 XML 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Pai 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 produto 

 

 

 ID 

 

 

 ID do produto 

 

 

 

 

 produto 

 

 

 cProd 

 

 

 Código de produto 

 

 

 

 

 produto 

 

 

 codigo 

 

 

 Código da mensagem de retorno 

 

 

 

 

 produto 

 

 

 mensagem 

 

 

 Descrição da mensagem de retorno 

 

 

 

 

 produto 

 

 

 origem 

 

 

 Origem de produto

Exemplos de chamada e retorno
  

 Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br"> <soap:Header/> <soap:Body> <sys:ativarProdutos> <!--Optional:--> <sys:usuario>superdemo</sys:usuario> <!--Optional:--> <sys:senha>systax741</sys:senha> <!--Optional:--> 

 <sys:xmlProdutos><![CDATA[<systaxCadastro> <produto> <cProd>48888887</cProd> <NCM>21069090</NCM> <EX_TIPI></EX_TIPI> <cEAN></cEAN> <descricao>Outras Preparações</descricao> <orig>0</orig> <complemento>TESTE</complemento> </produto> </systaxCadastro>]]></sys:xmlProdutos> </sys:ativarProdutos> </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:ativarProdutosResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:nil="true"/>             <ax21:produto xsi:type="ax21:Produto">                <ax21:ID>766456854</ax21:ID>                <ax21:cProd>48888887</ax21:cProd>                <ax21:codigo>115</ax21:codigo>                <ax21:grupos xsi:nil="true"/>                <ax21:mensagem>Ativado com sucesso.</ax21:mensagem>                <ax21:orig>0</ax21:orig>             </ax21:produto>          </ns:return>       </ns:ativarProdutosResponse>    </soapenv:Body> </soapenv:Envelope>

Consulta de grupos
Retorna os grupos de produtos do cliente no Portal de Classificação Fiscal.

Descrição dos campos de chamada e retorno
  

 Chamada 

 

 

 

 

 Pai 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 consultaGrupos 

 

 

 usuário 

 

 

 String 

 

 

 Usuário do Portal CFM 

 

 

 Sim 

 

 

 

 

 consultaGrupos 

 

 

 senha 

 

 

 String 

 

 

 Senha 

 

 

 Sim 

 

 

 

 

 consultaGrupos 

 

 

 idCli 

 

 

 Int 

 

 

 Código de cliente 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Pai 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 grupo 

 

 

 ID 

 

 

 ID do grupo 

 

 

 

 

 grupo 

 

 

 nomeGrupo 

 

 

 Nome do grupo de produto

Exemplos de chamada e retorno
  

 Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br">    <soap:Header/>    <soap:Body>       <sys:consultaGrupos>          <!--Optional:-->          <sys:usuario>superdemo</sys:usuario>          <!--Optional:-->          <sys:senha>systax741</sys:senha>          <!--Optional:-->          <sys:idCli>71408</sys:idCli>       </sys:consultaGrupos>    </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:consultaGruposResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:type="ax21:Grupo">                <ax21:ID>2195</ax21:ID>                <ax21:codigo xsi:nil="true"/>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>Teste de grupo</ax21:nomeGrupo>             </ax21:grupo> 

 <ax21:produto xsi:nil="true"/>          </ns:return>       </ns:consultaGruposResponse>    </soapenv:Body> </soapenv:Envelope>

Consulta de grupo de cenários por produto
Retorna os cenários e grupos associados á eles em função do produto informado pelo cliente. 

Descrição dos campos de chamada e retorno
Chamada 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 usuário 

 

 

 String 

 

 

 Usuário do Potal CFM 

 

 

 Sim 

 

 

 

 

 senha 

 

 

 String 

 

 

 Senha 

 

 

 Sim 

 

 

 

 

 idCli 

 

 

 Int 

 

 

 Código de cliente 

 

 

 Sim 

 

 

 

 

 codProd 

 

 

 String 

 

 

 Código de produto 

 

 

 Sim 

 

 

 

 

 origProd 

 

 

 Int 

 

 

 Origem de produto 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 idGrupo 

 

 

 ID do grupo 

 

 

 

 

 NomeGrupo 

 

 

 Nome do grupo

Exemplos de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br">    <soap:Header/>    <soap:Body>       <sys:consultaGruposCenariosByProduto>          <!--Optional:-->          <sys:usuario>superdemo</sys:usuario>          <!--Optional:-->          <sys:senha>systax741</sys:senha>          <!--Optional:-->          <sys:idCli>71408</sys:idCli>          <!--Optional:-->          <sys:codProd>94394394</sys:codProd>          <!--Optional:-->          <sys:origProd>0</sys:origProd>       </sys:consultaGruposCenariosByProduto>    </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:consultaGruposCenariosByProdutoResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroGrupoCenarioResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupoCenario xsi:type="ax21:GrupoCenario">                <ax21:cenarios xsi:type="ax21:Cenario">                   <ax21:codigo xsi:nil="true"/>                   <ax21:descricao>MG-MG-121-3,134-140</ax21:descricao>                   <ax21:idCenario>2122038</ax21:idCenario>                   <ax21:mensagem xsi:nil="true"/>                </ax21:cenarios>                <ax21:codigo xsi:nil="true"/>                <ax21:idGrupo>439551</ax21:idGrupo>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>MG-MG-121-3,134-140</ax21:nomeGrupo>             </ax21:grupoCenario>             <ax21:grupoCenario xsi:type="ax21:GrupoCenario">                <ax21:cenarios xsi:type="ax21:Cenario">                   <ax21:codigo xsi:nil="true"/>                   <ax21:descricao>MG-AM-121-3,134-140</ax21:descricao>                   <ax21:idCenario>2122699</ax21:idCenario>                   <ax21:mensagem xsi:nil="true"/>                </ax21:cenarios>                <ax21:codigo xsi:nil="true"/>                <ax21:idGrupo>440205</ax21:idGrupo>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>MG-AM-121-3,134-140</ax21:nomeGrupo>             </ax21:grupoCenario>             <ax21:grupoCenario xsi:type="ax21:GrupoCenario">                <ax21:cenarios xsi:type="ax21:Cenario">                   <ax21:codigo xsi:nil="true"/>                   <ax21:descricao>MG-AC-121-3,134-140</ax21:descricao>                   <ax21:idCenario>2122700</ax21:idCenario>                   <ax21:mensagem xsi:nil="true"/>                </ax21:cenarios>                <ax21:codigo xsi:nil="true"/>                <ax21:idGrupo>440206</ax21:idGrupo>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>MG-AC-121-3,134-140</ax21:nomeGrupo>             </ax21:grupoCenario>             <ax21:grupoCenario xsi:type="ax21:GrupoCenario">                <ax21:cenarios xsi:type="ax21:Cenario">                   <ax21:codigo xsi:nil="true"/>                   <ax21:descricao>MG-RS-121-3,134-140</ax21:descricao>                   <ax21:idCenario>2126076</ax21:idCenario>                   <ax21:mensagem xsi:nil="true"/>                </ax21:cenarios>                <ax21:codigo xsi:nil="true"/>                <ax21:idGrupo>443786</ax21:idGrupo>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>MG-RS-121-3,134-140</ax21:nomeGrupo>             </ax21:grupoCenario>             <ax21:grupoCenario xsi:type="ax21:GrupoCenario">                <ax21:cenarios xsi:type="ax21:Cenario">                   <ax21:codigo>133</ax21:codigo>                   <ax21:descricao xsi:nil="true"/>                   <ax21:idCenario xsi:nil="true"/>                   <ax21:mensagem>Este grupo não tem cenários</ax21:mensagem>                </ax21:cenarios>                <ax21:codigo xsi:nil="true"/>                <ax21:idGrupo>443787</ax21:idGrupo>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>MG-MG-121-3,134,140</ax21:nomeGrupo>             </ax21:grupoCenario>             <ax21:grupoCenario xsi:type="ax21:GrupoCenario">                <ax21:cenarios xsi:type="ax21:Cenario">                   <ax21:codigo xsi:nil="true"/>                   <ax21:descricao>RS-PE-121-3,134-140</ax21:descricao>                   <ax21:idCenario>2126078</ax21:idCenario>                   <ax21:mensagem xsi:nil="true"/>                </ax21:cenarios>                <ax21:codigo xsi:nil="true"/>                <ax21:idGrupo>443788</ax21:idGrupo>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>RS-PE-121-3,134-140</ax21:nomeGrupo>             </ax21:grupoCenario>          </ns:return>       </ns:consultaGruposCenariosByProdutoResponse>    </soapenv:Body> </soapenv:Envelope>

Consulta de grupos por configuração
Retorna o grupo associado ao cenário pesquisado.

Descrição dos campos de chamada e retorno
Chamada 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição  

 

 

 Obrigatório 

 

 

 

 

 usuario 

 

 

 String 

 

 

 Usuário do Portal CFM 

 

 

 Sim 

 

 

 

 

 senha 

 

 

 String 

 

 

 Senha 

 

 

 Sim 

 

 

 

 

 idCli 

 

 

 int 

 

 

 Código de cliente 

 

 

 Sim 

 

 

 

 

 idCenario 

 

 

 int 

 

 

 Código de cenário 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 ID 

 

 

 ID do grupo 

 

 

 

 

 NomeGrupo 

 

 

 Nome do grupo associado ao cenário

Exemplos de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br">    <soap:Header/>    <soap:Body>       <sys:consultaGruposConfig>          <!--Optional:-->          <sys:usuario>superdemo</sys:usuario>          <!--Optional:-->          <sys:senha>systax741</sys:senha>          <!--Optional:-->          <sys:idCli>71408</sys:idCli>          <!--Optional:-->          <sys:idCenario>2126076</sys:idCenario>       </sys:consultaGruposConfig>    </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:consultaGruposConfigResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:type="ax21:Grupo">                <ax21:ID>443786</ax21:ID>                <ax21:codigo xsi:nil="true"/>                <ax21:mensagem xsi:nil="true"/>                <ax21:nomeGrupo>MG-RS-121-3,134-140</ax21:nomeGrupo>             </ax21:grupo>             <ax21:produto xsi:nil="true"/>          </ns:return>       </ns:consultaGruposConfigResponse>    </soapenv:Body> </soapenv:Envelope>

Consulta de grupos por produto
Retorna as informações de um grupo de produtos específico do cliente.

Descrição dos campos de chamada e retorno
Chamada 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição  

 

 

 Obrigatório 

 

 

 

 

 usuario 

 

 

 String 

 

 

 Usuário do Portal CFM 

 

 

 Sim 

 

 

 

 

 senha 

 

 

 String 

 

 

 Senha 

 

 

 Sim 

 

 

 

 

 idCli 

 

 

 int 

 

 

 Código de cliente 

 

 

 Sim 

 

 

 

 

 idGrupo 

 

 

 int 

 

 

 Grupo de produto 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 ID 

 

 

 ID do produto 

 

 

 

 

 cProd 

 

 

 Código de produto 

 

 

 

 

 orig 

 

 

 Origem de produto

Exemplos de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br">    <soap:Header/>    <soap:Body>       <sys:consultaGruposProdutos>          <!--Optional:-->          <sys:usuario>superdemo</sys:usuario>          <!--Optional:-->          <sys:senha>systax741</sys:senha>          <!--Optional:-->          <sys:idCli>71408</sys:idCli>          <!--Optional:-->          <sys:idGrupo>1254577</sys:idGrupo>       </sys:consultaGruposProdutos>    </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:consultaGruposProdutosResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:nil="true"/>             <ax21:produto xsi:type="ax21:Produto">                <ax21:ID xsi:nil="true"/>                <ax21:cProd xsi:nil="true"/>                <ax21:codigo>121</ax21:codigo>                <ax21:grupos xsi:nil="true"/>                <ax21:mensagem>Não há produtos para o grupo informado.</ax21:mensagem>                <ax21:orig xsi:nil="true"/>             </ax21:produto>          </ns:return>       </ns:consultaGruposProdutosResponse>    </soapenv:Body> </soapenv:Envelope>

Desassociação de produto em um grupo
Desassocia um produto de um ou mais grupos no Portal de Classificação Fiscal.

Descrição dos campos de chamada e retorno
Chamada 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 usuário 

 

 

 String 

 

 

 Usuário do portal CFM 

 

 

 Sim 

 

 

 

 

 senha 

 

 

 String 

 

 

 senha 

 

 

 Sim 

 

 

 

 

 xmlGrupoProdutos 

 

 

 String 

 

 

 XML 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 ID 

 

 

 ID do produto 

 

 

 

 

 cProd 

 

 

 Código de produto 

 

 

 

 

 codigo 

 

 

 Código da mensagem de retorno 

 

 

 

 

 mensagem 

 

 

 Descrição da mensagem de retorno 

 

 

 

 

 origem 

 

 

 Origem de produto

Exemplos de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br">    <soap:Header/>    <soap:Body>       <sys:desassociarProdutoGrupo>          <sys:usuario>superdemo</sys:usuario>          <sys:senha>systax741</sys:senha>          <sys:xmlGrupoProdutos><![CDATA[ 

 

 

  <systaxCadastro> 

 

 

 

  <produto> 

 

 

 

 

  <cProd>94394394</cProd> 

 

 

 

 

  <orig>0</orig> 

 

 

 

 

  <grupos>                          <grupo>MG-AC-121-3,134-140</grupo>                          </grupos> 

 

 

 

  </produto>

 

 

 

 

 

 

 

 

 

 

 

 

  </systaxCadastro>]]></sys:xmlGrupoProdutos>       </sys:desassociarProdutoGrupo>    </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:desassociarProdutoGrupoResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:nil="true"/>             <ax21:produto xsi:type="ax21:Produto">                <ax21:ID>440206</ax21:ID>                <ax21:cProd>94394394</ax21:cProd>                <ax21:codigo>117</ax21:codigo>                <ax21:grupos xsi:nil="true"/>                <ax21:mensagem>Desassociado com sucesso.</ax21:mensagem>                <ax21:orig>0</ax21:orig>             </ax21:produto>          </ns:return>       </ns:desassociarProdutoGrupoResponse>    </soapenv:Body> </soapenv:Envelope>

Desativar produtos
Desativa um ou mais produtos no Portal de Classificação Fiscal. 

Descrição dos campos de chamada e retorno
Chamada 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 usuário 

 

 

 String 

 

 

 Usuário do Portal CFM 

 

 

 Sim 

 

 

 

 

 senha 

 

 

 String 

 

 

 senha 

 

 

 Sim 

 

 

 

 

 xmlProdutos 

 

 

 String 

 

 

 XML 

 

 

 Si 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 ID 

 

 

 ID do produto 

 

 

 

 

 cProd 

 

 

 Código de Produto 

 

 

 

 

 codigo 

 

 

 Código da mensagem de retorno 

 

 

 

 

 mensagem 

 

 

 Descrição da mensagem de retorno 

 

 

 

 

 orig 

 

 

 Origem de produto

Exemplos de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br"> <soap:Header/> <soap:Body> <sys:desativarProdutos> <!--Optional:--> <sys:usuario>superdemo</sys:usuario> <!--Optional:--> <sys:senha>systax741</sys:senha> <!--Optional:--> 

 <sys:xmlProdutos><![CDATA[<systaxCadastro> <produto> <cProd>48888887</cProd> <NCM>21069090</NCM> <EX_TIPI></EX_TIPI> <cEAN></cEAN> <descricao>Outras Preparações</descricao> <orig>0</orig> <complemento>TESTE</complemento> </produto> </systaxCadastro>]]></sys:xmlProdutos> </sys:desativarProdutos> </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:desativarProdutosResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:nil="true"/>             <ax21:produto xsi:type="ax21:Produto">                <ax21:ID>12306438</ax21:ID>                <ax21:cProd>48888887</ax21:cProd>                <ax21:codigo>110</ax21:codigo>                <ax21:grupos xsi:nil="true"/>                <ax21:mensagem>Desativado com sucesso.</ax21:mensagem>                <ax21:orig>0</ax21:orig>             </ax21:produto>          </ns:return>       </ns:desativarProdutosResponse>    </soapenv:Body> </soapenv:Envelope>

Incluir produtos
Faz a inclusão de um ou mais produtos no Portal de Classificação Fiscal.

Descrição dos campos de chamada e retorno
Chamada 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Descrição 

 

 

 Obrigatório 

 

 

 

 

 usuario 

 

 

 String 

 

 

 Usuário do portal CFM 

 

 

 Sim 

 

 

 

 

 senha 

 

 

 String 

 

 

 senha de usuário 

 

 

 Sim 

 

 

 

 

 xmlProdutos 

 

 

 String 

 

 

 XML 

 

 

 Sim 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 ID 

 

 

 ID do produto 

 

 

 

 

 cProd 

 

 

 Código de produto 

 

 

 

 

 codigo 

 

 

 Código da mensagem de retorno 

 

 

 

 

 mensagem 

 

 

 Descrição da mensagem de retorno 

 

 

 

 

 origem 

 

 

 Origem de produto

Exemplos de chamada e retorno
Chamada 

 <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:sys="http://systax.com.br"> <soap:Header/> <soap:Body> <sys:incluirProdutos> <!--Optional:--> <sys:usuario>superdemo</sys:usuario> <!--Optional:--> <sys:senha>systax741</sys:senha> <!--Optional:--> 

 <sys:xmlProdutos><![CDATA[<systaxCadastro> <produto> <cProd>4888888</cProd> <NCM>33041000</NCM> <EX_TIPI></EX_TIPI> <cEAN></cEAN> <descricao>Batom Natural Benecos</descricao> <orig>0</orig> <complemento>TESTE</complemento> </produto> </systaxCadastro>]]></sys:xmlProdutos> </sys:incluirProdutos> </soap:Body> </soap:Envelope> 

 

 Retorno 

 <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">    <soapenv:Body>       <ns:incluirProdutosResponse xmlns:ns="http://systax.com.br">          <ns:return xsi:type="ax21:SystaxCadastroResp" xmlns:ax21="http://retorno.systax.com.br/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">             <ax21:grupo xsi:nil="true"/>             <ax21:produto xsi:type="ax21:Produto">                <ax21:ID>766456760</ax21:ID>                <ax21:cProd>48888887</ax21:cProd>                <ax21:codigo>100</ax21:codigo>                <ax21:grupos xsi:nil="true"/>                <ax21:mensagem>Incluido com sucesso.</ax21:mensagem>                <ax21:orig>0</ax21:orig>             </ax21:produto>          </ns:return>       </ns:incluirProdutosResponse>    </soapenv:Body> </soapenv:Envelope>

Dicionário de dados
A tabela baixo contem detalhes das informações presentes no XML de cadastro de produtos (método incluirProdutos). 

 

 

 

 

 Campo 

 

 

 Tipo 

 

 

 Tamanho 

 

 

 Aceita nulo 

 

 

 Observação 

 

 

 

 

 cProd 

 

 

 String 

 

 

 120 

 

 

 Não 

 

 

   

 

 

 

 

 NCM 

 

 

 String 

 

 

 8 

 

 

 Sim 

 

 

   

 

 

 

 

 EXTIPI 

 

 

 String 

 

 

 3 

 

 

 Sim 

 

 

   

 

 

 

 

 cEAN 

 

 

 String 

 

 

 14 

 

 

 Sim 

 

 

   

 

 

 

 

 descricao 

 

 

 String 

 

 

 250 

 

 

 Sim 

 

 

   

 

 

 

 

 medLista 

 

 

 String 

 

 

 1 

 

 

 Sim 

 

 

 Utilizado somente para medicamentos. 

 

 

 

 

 medTipo 

 

 

 String 

 

 

 1 

 

 

 Sim 

 

 

 Utilizado somente para medicamentos. 

 

 

 

 

 orig 

 

 

 String 

 

 

 - 

 

 

 Não 

 

 

 Utilizado somente para medicamentos. 

 

 

 

 

 complemento 

 

 

 String 

 

 

 2500 

 

 

 Sim 

 

 

  

Tabelas
As tabelas a seguir listam o conteúdo dos campos de origem do material, lista de medicamentos e tipo de medicamento.

Lista de códigos de campos "ORIG"
Código 

 

 

 Descrição 

 

 

 

 

 0 

 

 

 Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 

 

 

 

 

 1 

 

 

 Estrangeira - Importação direta, exceto a indicada no código 6 

 

 

 

 

 2 

 

 

 Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7 

 

 

 

 

 3 

 

 

 Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70% 

 

 

 

 

 4 

 

 

 Nacional, cuja produção tenha sido feita em conformidade com os PPB de que tratam as legislações citadas nos Ajustes 

 

 

 

 

 5 

 

 

 Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40% 

 

 

 

 

 6 

 

 

 Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural 

 

 

 

 

 7 

 

 

 Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 

 

 

 

 

 8 

 

 

 Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%

Lista de códigos de campos "medlista" do grupo Medicamento
  

 

 

 

 

 Código 

 

 

 Descrição 

 

 

 

 

 0 

 

 

 Positiva 

 

 

 

 

 1 

 

 

 Negativa 

 

 

 

 

 2 

 

 

 Neutra

Lista de códigos de campos "medtipo"do grupo Medicamento
Código 

 

 

 Descrição 

 

 

 

 

 R 

 

 

 Referência 

 

 

 

 

 G 

 

 

 Genérico 

 

 

 

 

 S 

 

 

 Similar 

 

 

 

 

 O 

 

 

 Outros

Lista de códigos de retorno
Código 

 

 

 Mensagem 

 

 

 

 

 100 

 

 

 Incluído com sucesso. 

 

 

 

 

 104 

 

 

 Usuário ou senha inválidos. 

 

 

 

 

 105 

 

 

 Não autorizado. 

 

 

 

 

 106 

 

 

 Código Produto sem preenchimento ou Origem Prod. inválido ou sem preenchimento. 

 

 

 

 

 110 

 

 

 Desativado com sucesso. 

 

 

 

 

 111 

 

 

 Falha de schema. 

 

 

 

 

 113 

 

 

 Atualizado com sucesso. 

 

 

 

 

 114 

 

 

 Limite de produtos de cliente Systax Light atingido. Limite do cliente: XX. 

 

 

 

 

 115 

 

 

 Ativado com sucesso. 

 

 

 

 

 116 

 

 

 Grupo associado com sucesso. Cenário criado. 

 

 

 

 

 117 

 

 

 Desassociado com sucesso. 

 

 

 

 

 118 

 

 

 As finalidades dos clientes não batem com as dos clientes. 

 

 

 

 

 119 

 

 

 Não há grupos para o cenário informado. 

 

 

 

 

 120 

 

 

 Não encontrado. 

 

 

 

 

 121 

 

 

 Não há produtos para o grupo informado. 

 

 

 

 

 122 

 

 

 Impossível reativar. 

 

 

 

 

 123 

 

 

 Não há grupos para o cliente informado. 

 

 

 

 

 124 

 

 

 Grupo associado com sucesso. Cenário não criado. Nome do grupo fora do padrão. 

 

 

 

 

 125 

 

 

 Produto já associado ao grupo. Sem alterações. 

 

 

 

 

 127 

 

 

 Resultados diversos. Veja o detalhe de cada produto. 

 

 

 

 

 128 

 

 

 Grupo associado com sucesso. Cenário já existente. 

 

 

 

 

 131 

 

 

 O produto informado não existe. 

 

 

 

 

 132 

 

 

 Não há grupos para o produto informado. 

 

 

 

 

 133 

 

 

 Este grupo não tem cenários. 

 

 

 

 

 999 

 

 

 Erro fatal.