Documento de API

Objetivo:

Realizar o cálculo da variação do valor final do produto configurado conforme o seu preço de venda e de produção.

Considerações Gerais:

-     Devem ser passadas 4 (cinco) temp-tables como parâmetro, sendo uma de entrada, duas de saída e uma de entrada e saída, e mais um parâmetro lógico (yes/no) que define se os erros já existentes na temp-table de erros serão eliminados no início da execução.

-          Exemplo de execução da API:

      run vcp/vcapi001.p (input        table ttParam,

       output       table ttResumoPedido,

output       table ttDetalheOrdem,

input-output table tt-erro,

       input              yes).

-       A API funciona da seguinte forma: Recebe como parâmetro a temp-table de parâmetros, faz as criticas das mesmas, caso não tenha ocorrido nenhum problema retorna os valores da variação do valor final do pedido da configuração e os valores de detalhe da ordem de produção criado para o produto configurado.

-       Se o programa chamador necessita executar a api para vários Itens configurados deve-se lembrar de limpar a temp-table de parâmetros e criá-la novamente para o novo item.

Parâmetros de Entrada

Temp-table ttParam: nesta temp-table deverá ser armazenado os parâmetros para o cálculo da variação da configuração.

- it-codigo: Código do item pai do produto configurado.

- cod-estabel: Estabelecimento em que o item é produzido.

- tipo-custo: Tipo de custeio do item (1-Médio, 2-On-line).

- ped-aber: Considera os pedidos em aberto.

- ped-atend-par: Considera os pedidos atendidos parcialmente.

- ped-atend-tot: Considera os pedidos atendidos totalmente.

- carrega-detalhe: Carrega a temp-table de detalhe das ordens de produção.

- variacao-ini: Percentual inicial da variação a ser considerada.

- variacao-fim: Percentual inicial da variação a ser considerada.

- da-entrega-ini: Data de entrega inicial a ser considerada.

- da-entrega-fim: Data de entrega final a ser considerada.

- nome-abrev-ini: Nome abreviado inicial a ser considerado.

- nome-abrev-fim: Nome abreviado final a ser considerado.

- cod-versao-integracao: Versão de integração da API.

Parâmetros de Saída

Temp-table ttResumoPedido: nesta temp-table serão armazenado o pedidos do item informado nos parâmetros.

- nome-abrev: Nome abreviado do pedido.

- nr-pedcli: Número do pedido.

- nr-sequencia: Seqüência do item no pedido.

- it-codigo: Item do pedido.

- desc-item: Descrição do item do pedido.

- variacao: Variação do preço do item.

- Quantidade: Quantidade do item no pedido.

- preco-real: Preço unitário de produção do item.

- preco-venda: Preço unitário de venda do item.

Temp-table ttDetalheOrdem: Esta temp-table retornará os valores de detalhe da ordem de produção.

- nr-ord-produ: Número da ordem de produção.

- nr-ord-pai: Número da ordem de produção pai.

- it-codigo: Item da ordem de produção.

- nome-abrev: Nome abreviado do pedido.

- nr-pedcli: Número do pedido.

- nr-sequencia: Seqüência do item no pedido.

- nr-config: Número da configuração do item.

- nivel: Nível da ordem de produção.

- quant-atend: Quantidade atendida da ordem de produção.

- custo-unit: Custo unitário de produção do item.

- custo-total: Custo total de produção da ordem.

- custo-mat: Custo total de material.

- custo-mob: Custo total de mão-de-obra.

- custo-mob-c: Custo total de mão-de-obra componente.

- custo-ggf[6]: Custo total de ggf dividido por tipo de ocorrência.

Temp-table tt-erro: Para cada balanceamento serão executadas validações para consistir os registros, os erros encontrados serão gravados na temp-table tt-erro.

Obs: O campo cd-erro possui o número do erro do cadastro de mensagem; O campo mensagem possui a descrição da mensagem do cadastro de mensagem; O campo i-sequen possui o número sequencial do erro.