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 

 

 

 

 

 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

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" 

         } 

     ] 

 }