Cadastro de cenários
Objetivo: Cadastrar um ou mais cenários (operações do cliente) em uma mesma requisição.
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/PublicView2/Index/0c5a84a842cddc2474b2e6d25/32159. 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 acionar o nosso time e solicitar o ajuste.
Descrição dos campos de entrada:
| Campo | PAI | Descrição |
| id | cenarios | Não enviar esta tag. Este código será gerado e preenchido automaticamente pelo sistema Systax. |
| id_cliente | cenarios | ID do cliente |
| grupo_cache | cenarios | Preencher sempre com "A" |
| apelido | cenarios | Descrição do cenário |
| ent_sai | cenarios | Tipo entrada/saída |
| cod_nat_op | cenarios | Código de natureza de operação |
| finalidade | cenarios | Código de finalidade |
| destinacao | cenarios | Perfil do destinatário |
| alternativo_ex_origem | cenarios | Perfil do remetente |
| uf_origem | cenarios | UF do remetente |
| uf_destino | cenarios | UF do destinatário |
| id_mun_origem | cenarios | ID do município do remetente |
| id_mun_destino | cenarios | ID do município do destinatário |
| cnpj_ex_origem | cenarios | CNPJ do remetente |
| cnae_destinatario | cenarios | CNAE do destinatário |
| origem_produto_alternativo | cenarios | Preencher somente se houver orientação específica do time Systax |
| cenario_ind_prod | cenarios | Uso interno Systax. Não preencher. |
| st_cest | cenarios | Uso interno Systax.Não preencher. |
| frequencia | cenarios |
Preenchimento padrão: "1" - Para cenários de Saída "2" - Para cenários de Entrada |
| dias_futuros | cenarios | Prenchimento padrão: "30". Refere-se à vigência da regra entregue. |
| dt_criacao | cenarios | Não enviar esta tag. A data será preenchida automaticamente pelo sistema Systax. |
Tabela de referência para o campo "ent_sai":
| ent_sai | Descrição |
| 0 | Entrada |
| 1 | Saída |
Tabela de referência para os campos "cod_nat_op", "finalidade", "destinacao" e "alternativo_ex_origem":
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/PublicView2/Index/c14f5c52f0b52073cdf05eb75/26445. 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:
| 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 |
| position | itens_error | Posição do cenário na chamada |
| 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 |
| false | token_expired | |
| 500 | false | internal_error |
Exemplos de chamada:
{
"cenarios": [
{
"id_cliente": 71408,
"grupo_cache": "A",
"apelido": "Cenario teste 1",
"ent_sai": 0,
"cod_nat_op": 121,
"finalidade": 0,
"destinacao": "3",
"alternativo_ex_origem": "3",
"uf_origem": "SP",
"uf_destino": "SP",
"id_mun_origem": 0,
"id_mun_destino": 0,
"cnpj_ex_origem": "",
"cnae_destinatario": "",
"origem_produto_alternativo": 0,
"cenario_ind_prod": "",
"st_cest": 0,
"frequencia": 0,
"dias_futuros": 0,
"dt_criacao": ""
},
{
"id_cliente": 71408,
"grupo_cache": "A",
"apelido": "Cenario teste 2",
"ent_sai": 0,
"cod_nat_op": 121,
"finalidade": 0,
"destinacao": "3",
"alternativo_ex_origem": "3",
"uf_origem": "SP",
"uf_destino": "AC",
"id_mun_origem": 0,
"id_mun_destino": 0,
"cnpj_ex_origem": "",
"cnae_destinatario": "",
"origem_produto_alternativo": 0,
"cenario_ind_prod": "",
"st_cest": 0,
"frequencia": 0,
"dias_futuros": 0,
"dt_criacao": ""
}
]
}
Exemplos de retorno:
{
"success": true,
"message": "ok",
"total_itens": 2,
"total_ok": 2,
"itens_ok": [
{
"position": 0,
"id": "2033763"
},
{
"position": 1,
"id": "2033764"
}
],
"total_error": 0,
"itens_error": []
}