1. Exemplo do json:
{
"codigo": 1,
"id_safra": 1001,
"id_natureza_operacao": 1001,
"descricao": "Configuração de Pedido",
"serie": "A1",
"status": "A",
"tipo_frete": "A",
"data_previsao": "2023-12-31",
"entrada_saida": "E",
"utiliza_canal_venda": "S",
"ativo": "S",
"obriga_centro_custo_pedido": "S",
"valida_safra_tabela_preco": "S",
"necessita_autorizacao": "S",
"utiliza_procurador": "S",
"repete_numero_terceiro": "S",
"valida_bloqueio_inscricao_endereco": "S",
"obriga_hectare": "S",
"permite_desmembrar": "S",
"codigo_externo": "EXT123",
"data_alteracao": "2024-08-29T13:37:28.287Z",
"pedido_configuracao_decimais": {
"id": 1,
"id_pedido_configuracao": 1001,
"valor_unitario": 10,
"total_unitario": 100,
"valor_total_indexador": 1000,
"valor_unitario_indexador": 10,
"valor_desconto_unitario": 5,
"total_pedido": 500,
"codigo_externo": "EXT123"
},
"pedido_configuracao_financeiro": {
"id": 1,
"dias_validade": 30,
"utiliza_forma_parcelamento": "S",
"data_validade": "2024-08-29",
"data_prazo_pagamento": "2024-08-29",
"inicializa_forma_pagamento_pessoa": "S",
"altera_data_validade": "S",
"obriga_forma_parcelamento": "S",
"obriga_data_pagamento_igual_vencimento": "S",
"obriga_forma_pagamento": "S",
"id_mensagem_nota_padrao": 1001,
"id_pedido_configuracao": 1001,
"codigo_externo": "EXT123"
},
"pedido_configuracao_produto": {
"id": 1,
"id_pedido_configuracao": 1001,
"id_desconto_pontualidade": 2001,
"id_saldo_negativo": 3001,
"permite_item_duplicado": "S",
"permite_alterar_valor": "S",
"utiliza_pontualidade": "S",
"controla_rateio_rentabilidade": "S",
"utiliza_data_entrega": "S",
"atualiza_cota": "S",
"ignora_cotacao": "S",
"obriga_centro_custo_item": "S",
"obriga_cultura_diagnostico": "S",
"obriga_equipamento_aplicado": "S",
"utiliza_producao_semente": "S",
"obriga_tratamento_semente": "S",
"controla_autorizacao_saldo": "S",
"considera_tsi_comissao": "S",
"tolerancia_margem_minima": 10,
"obriga_embalagem": "S",
"controla_item_por_limite": "S",
"controla_promocao": "S",
"controla_shelf_life": "S",
"prioriza_shelf_life": "S",
"shelf_life_minimo": 30,
"shelf_life_maximo": 60,
"permite_editar_shelf_life": "S",
"codigo_externo": "EXT123",
"desconto_pontualidade_tipo_pessoa": [
{
"id": 1,
"id_desconto_pontualidade": 2001,
"codigo_externo": "EXT123"
}
],
}
}
Campos:
codigo: Código único da configuração do pedido
id_safra: ID da safra
id_natureza_operacao: ID da natureza da operação
descricao: Descrição da configuração do pedido
serie: Série do pedido
status: Status do pedido. Valores disponíveis: (A) - Aprovado, (N) - Normal
tipo_frete: Tipo de frete do pedido. Valores disponíveis: (P) - PAGO, (A) - A PAGAR, (B) - EM BRANCO
data_previsao: Data de previsão do pedido
entrada_saida: Entrada ou saída do pedido. Valores disponíveis: E - ENTRADA, S - SAIDA
utiliza_canal_venda: Indica se utiliza canal de venda. Valores disponíveis: (S) - SIM, (N) - NAO
ativo: Indica se a configuração está ativa. Valores disponíveis: (S) - SIM, (N) - NAO
obriga_centro_custo_pedido: Indica se obriga centro de custo no pedido. Valores disponíveis: (S) - SIM, (N) - NAO
valida_safra_tabela_preco: Indica se valida safra na tabela de preço. Valores disponíveis: (S) - SIM, (N) - NAO
necessita_autorizacao: Indica se necessita autorização. Valores disponíveis: (S) - SIM, (N) - NAO
utiliza_procurador: Indica se utiliza procurador. Valores disponíveis: (S) - SIM, (N) - NAO
repete_numero_terceiro: Indica se repete número de terceiro. Valores disponíveis: (S) - SIM, (N) - NAO
valida_bloqueio_inscricao_endereco: Indica se valida bloqueio de inscrição e endereço. Valores disponíveis: (S) - SIM, (N) - NAO
obriga_hectare: Indica se obriga hectare. Valores disponíveis: (S) - SIM, (N) - NAO
permite_desmembrar: Indica se permite desmembrar. Valores disponíveis: (S) - SIM, (N) - NAO
codigo_externo: Código externo da configuração do pedido
data_alteracao: Data da última alteração do registro
pedido_configuracao_decimais: Configuração dos decimais do pedido
id: ID único da configuração dos decimais do pedido
valor_unitario: Valor unitário
total_unitario: Total unitário
valor_total_indexador: Valor total indexador
valor_unitario_indexador: Valor unitário indexador
valor_desconto_unitario: Valor de desconto unitário
total_pedido: Total do pedido
codigo_externo: Código externo da configuração dos decimais do pedido
pedido_configuracao_financeiro: Configuração financeira do pedido
id: ID único da configuração financeira do pedido
dias_validade: Dias de validade do pedido
utiliza_forma_parcelamento: Indica se utiliza forma de parcelamento. Valores disponíveis: (S) - Sim, (N) - Não
data_validade: Data de validade do pedido
data_prazo_pagamento: Data de prazo de pagamento do pedido
inicializa_forma_pagamento_pessoa: Indica se inicializa forma de pagamento da pessoa. Valores disponíveis: (S) - Sim, (N) - Não
altera_data_validade: Indica se altera data de validade. Valores disponíveis: (S) - Sim, (N) - Não
obriga_forma_parcelamento: Indica se obriga forma de parcelamento. Valores disponíveis: (S) - Sim, (N) - Não
obriga_data_pagamento_igual_vencimento: Indica se obriga data de pagamento igual ao vencimento. Valores disponíveis: (S) - Sim, (N) - Não
obriga_forma_pagamento: Indica se obriga forma de pagamento. Valores disponíveis: (S) - Sim, (N) - Não
pedido_configuracao_produto Configuração dos produtos do pedido
id: ID único da configuração do produto do pedido
id_desconto_pontualidade: ID do desconto por pontualidade
id_saldo_negativo: ID do saldo negativo
permite_item_duplicado: Indica se permite item duplicado. Valores disponíveis: (S) - Sim, (N) Não
permite_alterar_valor: Indica se permite alterar valor. Valores disponíveis: (S) - Sim, (N) Não
utiliza_pontualidade: Indica se utiliza pontualidade. Valores disponíveis: (S) - Sim, (N) Não
controla_rateio_rentabilidade: Indica se controla rateio de rentabilidade. Valores disponíveis: (S) - Sim, (N) Não
utiliza_data_entrega: Indica se utiliza data de entrega. Valores disponíveis: (S) - Sim, (N) Não
atualiza_cota: Indica se atualiza cota. Valores disponíveis: (S) - Sim, (N) Não
ignora_cotacao: Indica se ignora cotação. Valores disponíveis: (S) - Sim, (N) Não
obriga_centro_custo_item: Indica se obriga centro de custo no item. Valores disponíveis: (S) - Sim, (N) Não
desconto_pontualidade_tipo_pessoa: Lista de Configurações dos descontos do pedido
id: ID único da configuração do desconto do pedido
id_desconto_pontualidade: ID do desconto por pontualidade
codigo_externo: Código externo da configuração do desconto do pedido
2. Endpoints
2.1 - Buscar configurações de pedido pelo código
Endpoint: /pedido-configuracao
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da configuração de pedido no banco de dados do CRM.
Resposta: Status 200 - Retorna a configuração de pedido no formato documentado na sessão Exemplo do json
2.2 - Buscar todas as configurações de pedido
Endpoint: /pedido-configuracao/todos
Tipo: get
Resposta: Status 200 - Retorna a lista das configurações de pedido no formato documentado na sessão Exemplo do json
2.5 - Retornar os metadados das configurações de pedido
Endpoint: /pedido-configuracao/metadados
Tipo: get
Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável
Resposta: Status 200 - Retorna um json com as informações dos campos da configuração de pedido
2.6 - Pesquisar
Endpoint: /pedido-configuracao/pesquisa
Tipo: post
pedidos:
Esse endpoint retorna as configurações de pedido baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
{
"pagina": 1,
"quantidadeRegistros": 10,
"filtros": [
{
"campo": "descricao",
"comparacao": "COMECA_COM",
"valor": "C"
}
],
"ordenacao": [
{
"campo": "descricao",
"ordenacao": "ASC"
}
]
}
Nesse exemplo, estamos filtrando todas os Configurações de pedido cuja descrição começa com a letra C;