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",
    "ativorepete_numero_terceiro": "S",
    "obrigavalida_centrobloqueio_custoinscricao_pedidoendereco": "S",
    "valida_safra_tabela_precoobriga_hectare": "S",
    "necessitapermite_autorizacaodesmembrar": "S",
    "utilizacodigo_procuradorexterno": "SEXT123",
    "repetedata_numero_terceiroalteracao": "S2024-08-29T13:37:28.287Z",
    "validapedido_bloqueioconfiguracao_inscricao_endereco": "S",decimais": {
      "obriga_hectareid": "S"1,
  "permite_desmembrar    "id_pedido_configuracao": "S"1001,
      "codigovalor_externounitario": "EXT123"10,
  "data_alteracao": "2024-08-29T13:37:28.287Z",     "pedidototal_configuracao_decimaisunitario": 100,
 {     "idvalor_total_indexador": 11000,
      "idvalor_pedidounitario_configuracaoindexador": 100110,
      "valor_desconto_unitario": 105,
      "total_unitariopedido": 100500,
      "valor_total_indexador": 1000codigo_externo": "EXT123"
    },
    "valorpedido_unitarioconfiguracao_indexadorfinanceiro": {
 10,     "valor_desconto_unitarioid": 51,
      "totaldias_pedidovalidade": 50030,
      "codigoutiliza_forma_externoparcelamento": "EXT123S",
  },    "pedido_configuracao_financeiro": {data_validade": "2024-08-29",
      "iddata_prazo_pagamento": 1,"2024-08-29",
      "dias_validadeinicializa_forma_pagamento_pessoa": 30"S",
      "utilizaaltera_formadata_parcelamentovalidade": "S",
      "dataobriga_forma_validadeparcelamento": "2024-08-29S",
      "obriga_data_prazopagamento_igual_pagamentovencimento": "2024-08-29S",
      "inicializaobriga_forma_pagamento_pessoa": "S",
      "alteraid_mensagem_datanota_validadepadrao": "S"1001,
      "obrigaid_formapedido_parcelamentoconfiguracao": "S"1001,
      "obriga_data_pagamento_igual_vencimentocodigo_externo": "S"EXT123"
    },
    "obrigapedido_formaconfiguracao_pagamentoproduto": {
      "Sid": 1,
      "id_mensagempedido_nota_padraoconfiguracao": 1001,
      "id_pedidodesconto_configuracaopontualidade": 10012001,
      "codigoid_saldo_externonegativo": 3001,
"EXT123"   },   "pedidopermite_configuracao_produto": {item_duplicado": "S",
      "idpermite_alterar_valor": 1"S",
      "idutiliza_pedido_configuracaopontualidade": 1001"S",
      "idcontrola_descontorateio_pontualidaderentabilidade": 2001"S",
      "idutiliza_saldodata_negativoentrega": 3001"S",
      "permiteatualiza_item_duplicadocota": "S",
      "permiteignora_alterar_valorcotacao": "S",
      "utiliza_pontualidadeobriga_centro_custo_item": "S",
      "controlaobriga_rateiocultura_rentabilidadediagnostico": "S",
      "utilizaobriga_dataequipamento_entregaaplicado": "S",
      "atualizautiliza_producao_cotasemente": "S",
      "ignoraobriga_tratamento_cotacaosemente": "S",
      "obrigacontrola_centroautorizacao_custo_itemsaldo": "S",
      "obrigaconsidera_culturatsi_diagnosticocomissao": "S",
      "obrigatolerancia_equipamentomargem_aplicadominima": "S"10,
      "utilizaobriga_producao_sementeembalagem": "S",
      "obrigacontrola_item_tratamentopor_sementelimite": "S",
      "controla_autorizacao_saldopromocao": "S",
      "consideracontrola_tsishelf_comissaolife": "S",
      "toleranciaprioriza_margemshelf_minimalife": 10, "S",
      "obrigashelf_life_embalagemminimo": "S"30,
      "controlashelf_itemlife_por_limitemaximo": "S"60,
    "controla_promocao  "permite_editar_shelf_life": "S",
      "controlacodigo_shelf_lifeexterno": "SEXT123",
      "priorizadesconto_pontualidade_shelf_life": "S",
tipo_pessoa": [
   "shelf_life_minimo": 30,  {
  "shelf_life_maximo": 60,     "permite_editar_shelf_lifeid": "S"1,
    "codigo_externo    "id_desconto_pontualidade": "EXT123"2001,
     "desconto_pontualidade_tipo_pessoa": [   "codigo_externo": "EXT123"
     { }
    ],
"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

...

}
]

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

  • ativoutiliza_procurador: Indica se a configuração está ativautiliza procurador. Valores disponíveis: (S) - SIM, (N) - NAO

  • obrigarepete_centronumero_custo_pedidoterceiro: Indica se obriga centro de custo no pedidorepete número de terceiro. Valores disponíveis: (S) - SIM, (N) - NAO

  • valida_safrabloqueio_tabelainscricao_precoendereco: Indica se valida safra na tabela de preçobloqueio de inscrição e endereço. Valores disponíveis: (S) - SIM, (N) - NAO

  • necessitaobriga_autorizacaohectare: Indica se necessita autorizaçãoobriga hectare. Valores disponíveis: (S) - SIM, (N) - NAO

  • utilizapermite_procuradordesmembrar: Indica se utiliza procuradorpermite desmembrar. 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) - NAOcodigo_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

  • data_alteracao: Data da última alteração do registro

  • pedido_configuracao_decimaisfinanceiro: Configuração dos decimais financeira 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

    • utilizafinanceira 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 utiliza obriga forma de parcelamento. Valores disponíveis: (S) - Sim, (N) - Não

    • obriga_data_pagamento_validade: Data de validade do pedido

    • data_prazo_pagamento: Data de prazo de pagamento do pedido

    • inicializaigual_vencimento: Indica se obriga data de pagamento igual ao vencimento. Valores disponíveis: (S) - Sim, (N) - Não

    • obriga_forma_pagamento_pessoa: Indica se inicializa obriga forma de pagamento da pessoa. Valores disponíveis: (S) - Sim, (N) - Nãoaltera_data_validade: Indica se altera data de validade

  • 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: (SA) - SimAceita, (N) - Nãoobriga_forma_parcelamento: Indica se obriga forma de parcelamento. Valores disponíveis: (S) - SimSomente avisa, (NB) - NãoBloqueia

    • obrigapermite_data_pagamento_igual_vencimentoalterar_valor: Indica se obriga data de pagamento igual ao vencimentopermite alterar valor. Valores disponíveis: (S) - Sim, (N) - Não

    • obrigautiliza_forma_pagamentopontualidade: Indica se obriga forma de pagamentoutiliza pontualidade. Valores disponíveis: (S) - Sim, (N) - Não

    pedido
    • controla_

    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 valorrateio_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 utiliza_pontualidade

    • obriga_centro_custo_item: Indica se utiliza pontualidadeobriga centro de custo no item. Valores disponíveis: (S) - Sim, (N) - Não

    • controlaobriga_rateiocultura_rentabilidadediagnostico: Indica se controla rateio obriga cultura de rentabilidadediagnóstico. Valores disponíveis: (S) - Sim, (N) - Não utiliza_data_entrega: Indica se utiliza data de entrega(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 , (O) - Obriga atualiza_cota

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

    • ignoraobriga_tratamento_cotacaosemente: Indica se ignora cotaçãoobriga tratamento de semente. Valores disponíveis: (S) - Sim, (N) - Não

    • obrigacontrola_centroautorizacao_custo_itemsaldo: Indica se obriga centro de custo no itemcontrola autorização de saldo. Valores disponíveis: (S) - Sim, (N) - Não

    • obrigaconsidera_culturatsi_diagnosticocomissao: Indica se obriga cultura de diagnósticoconsidera TSI na comissão. Valores disponíveis: (NS) - Nenhum itemSim, (DN) - Defensivos, (V) - Não Defensivos, (A) - Defensivos e não defensivos obriga_equipamento_aplicadoNão

    • tolerancia_margem_minima: Tolerância de margem mínima

    • obriga_embalagem: Indica se obriga equipamento de aplicaçãoembalagem. Valores disponíveis: (ST) - SimTodos, (N) - Nenhum, (S) - Não utiliza_producao_semente: Indica se utiliza produção de sementeLote de Semente

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

    • obrigacontrola_tratamento_sementepromocao: Indica se obriga tratamento de sementecontrola promoção. Valores disponíveis: (S) - Sim, (N) - Não

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

    • consideraprioriza_tsishelf_comissaolife: Indica se considera TSI na comissãoprioriza shelf life. Valores disponíveis: (SC) - SimConfiguração do Pedido, (NP) - Não

    • tolerancia_margem_minima: Tolerâ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

    • controla_promocao: Indica se controla promoção. Valores disponíveis: (S) - Sim, (N) - Não

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

    • prioriza_shelf_life: Indica se prioriza shelf life. Valores disponíveis: (C) - Configuração do Pedido, (P) - 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_pontualidade_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 de pontualidade

      • codigo_externo: Código externo do desconto de pontualidade

2. Endpoints

...

    • 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_pontualidade_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 de pontualidade

      • codigo_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:

...