Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

1. Exemplo do json:

...

1. Exemplo do json:

Code Block
[
  {
    "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",
  "codigo_externo": "EXT123",   "data_alteracao": "2024-08-29T13:37:28.287Zpermite_alterar_valor": "S",
      "pedidoutiliza_configuracao_decimaispontualidade": "S",
{      "idcontrola_rateio_rentabilidade": 1"S",
      "idutiliza_pedidodata_configuracaoentrega": 1001"S",
      "valoratualiza_unitariocota": 10, "S",
      "totalignora_unitariocotacao": 100"S",
      "valorobriga_centro_totalcusto_indexadoritem": 1000"S",
      "valorobriga_unitariocultura_indexadordiagnostico": 10"S",
      "valorobriga_descontoequipamento_unitarioaplicado": 5"S",
      "totalutiliza_producao_pedidosemente": 500"S",
      "codigoobriga_tratamento_externosemente": "EXT123S",
  },    "pedidocontrola_configuracaoautorizacao_financeirosaldo": {     "idS":,
 1,     "diasconsidera_tsi_validadecomissao": 30"S",
      "utilizatolerancia_formamargem_parcelamentominima": "S"10,
      "dataobriga_validadeembalagem": "2024-08-29S",
      "datacontrola_item_prazopor_pagamentolimite": "2024-08-29S",
      "inicializa_forma_pagamento_pessoacontrola_promocao": "S",
      "alteracontrola_datashelf_validadelife": "S",
      "obrigaprioriza_formashelf_parcelamentolife": "S",
      "obriga_data_pagamento_igual_vencimentoshelf_life_minimo": "S"30,
      "obrigashelf_formalife_pagamentomaximo": "S"60,
      "idpermite_mensagemeditar_notashelf_padraolife": 1001"S",
      "idcodigo_pedido_configuracaoexterno": 1001"EXT123",
      "codigo_externodesconto_pontualidade_tipo_pessoa": "EXT123"[
  },   "pedido_configuracao_produto": {
        "id": 1,
    "id_pedido_configuracao": 1001,
    "id_desconto_pontualidade": 2001,
        "idcodigo_saldo_negativoexterno": 3001,
"EXT123"
      }
    ],
    }
   "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

...

}
]

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

    • codigo: 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: (A) - Aceita, (S) - Somente avisa, (B) - Bloqueia

    • 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, (O) - Obriga

    • 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

    • obriga_cultura_diagnostico: Indica se obriga cultura de diagnóstico. Valores disponíveis: (N) - Nenhum item, (D) - Defensivos, (V) - Não Defensivos, (A) - Defensivos e não defensivos

    • obriga_equipamento_aplicado: Indica se obriga equipamento de aplicação. Valores disponíveis: (S) - Sim, (N) - Não

    • utiliza_producao_semente: Indica se utiliza produção de semente. Valores disponíveis: (S) - Sim, (N) - Não

    • obriga_tratamento_semente: Indica se obriga tratamento de semente. Valores disponíveis: (S) - Sim, (N) - Não

    • controla_autorizacao_saldo: Indica se controla autorização de saldo. Valores disponíveis: (S) - Sim, (N) - Não

    • considera_tsi_comissao: Indica se considera TSI na comissão. Valores disponíveis: (S) - Sim, (N) - Não

    • datatolerancia_margem_validademinima: 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 pessoaTolerância de margem mínima

    • obriga_embalagem: Indica se obriga embalagem. Valores disponíveis: (T) - Todos, (N) - Nenhum, (S) - Lote de Semente

    • controla_item_por_limite: Indica se controla item por limite. Valores disponíveis: (S) - Sim, (N) - Não

    • alteracontrola_data_validadepromocao: Indica se altera data de validadecontrola promoção. Valores disponíveis: (S) - Sim, (N) - Não

    • obrigacontrola_formashelf_parcelamentolife: Indica se obriga forma de parcelamentocontrola shelf life. Valores disponíveis: (S) - Sim, (N) - Não

    • obrigaprioriza_data_pagamento_igual_vencimentoshelf_life: Indica se obriga data de pagamento igual ao vencimentoprioriza shelf life. Valores disponíveis: (SC) - SimConfiguração do Pedido, (N) - Nãoobriga_forma_pagamento: Indica se obriga forma de pagamentoP) - Configuração da pessoa

    • shelf_life_minimo: Shelf life mínimo

    • shelf_life_maximo: Shelf life máximo

    • permite_editar_shelf_life: Indica se permite editar shelf life. Valores disponíveis: (S) - Sim, (N) - Não

    • codigo_externo: Código externo da configuração do produto do pedido

    • desconto_

    configuracao_produto Configuração dos produtos do pedido
    • id: ID único da configuração do produto do pedidopontualidade_tipo_pessoa: Lista dos descontos de pontualidade relacionados ao tipo de pessoa

      • codigo: Código do registro

      • tipo_pessoa: Tipo de pessoa. Valores disponíveis: A - Associados, T - Terceiros

      • id_desconto_pontualidade: ID do desconto

      por
      • de pontualidade

      id
      • codigo_

      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

...

      • externo: Código externo do desconto de pontualidade

...

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.3 - Cadastrar ou editar configurações de pedido

Endpoint:/pedido-configuracao

Tipo: post

Notas:

  • Informe no corpo da requisição o json conforme exemplo na sessão 1.

  • Para cadastrar uma configuração de pedido não informe o campo “codigo”;

  • Para editar uma configuração de pedido já existente informe o campo “codigo” com o código da configuração de pedido que deseja editar;

  • Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna a configuração de pedido cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar uma configuração de pedido

Não é possível deletar uma configuração de pedido, apenas inativar, pois a configuração pode ter vinculo com pedidos/notas. Nesse caso, a configuração de pedido continua no banco de dados porém com o status inativo.

Endpoint:/pedido-configuracao

Tipo: get delete

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

...

  • de pedido no banco de dados do CRM.

  • codigoExterno:Tipo: String.Código da configuração de pedido no banco de dados do sistema integrado, caso existir.

Resposta: Status 200 - Retorna a lista das configurações de pedido no formato documentado na sessão Exemplo do json Mensagem: Registro inativado com sucesso.

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 endpointretorna as configurações de pedido baseado nos filtros e na ordenação informados;

  • Exemplo do corpo da requisição:

...