Alteração de cenários em lote
Objetivo: Alterar um ou mais cenários na mesma requisição.
Descrição dos campos de entrada:
Campo | PAI | Descrição |
id | cenarios | ID do cenário |
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 (utilizado somente na entrada) |
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 | 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 |
Tabela de referência para os campos "cod_nat_op", "finalidade", "destinacao" e "alternativo_ex_origem":
Para obter a tabela completa dos campos acima, acesse a última versão de documentação no link: https://documentacao.systax.com.br/PublicView2/Index/c14f5c52f0b52073cdf05eb75/26445
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 encontrados (existentes) |
position | itens_ok | Posição do cenário na chamada |
id | itens_ok | ID do cenário alterado |
total_error | / | Quantidade de cenários não alterados |
position | itens_error | Posição do cenário na chamada |
id | itens_error | ID do cenário com erro |
message | itens_error | Mensagem do retorno |
extra | itens_error | Mensagem de 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": 2032806,
"apelido": "Teste alteração 1"
},
{
"id": 2032401,
"apelido": "Teste alteração 2"
}
]
}
Exemplos de retorno:
{
"success": true,
"message": "ok",
"total_itens": 2,
"total_ok": 2,
"itens_ok": [
{
"position": 0,
"id": "2032806"
},
{
"position": 1,
"id": "2032401"
}
],
"total_error": 0,
"itens_error": []
}