Documento de API

Objetivo: Realizar o cálculo do custo de material, mão de obra e GGF de um ou mais itens, utilizando-se da estrutura desses itens e realizando o cálculo de forma recursiva, processando os valores da cada componente dos itens e acumulando-os de forma a compor o custo final dos itens desejados.

Funcionamento: Realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias ao processamento de um ou mais cálculos. A sintaxe para a chamada é:

run csp/csapi001.p  (input  table tt-custos-param,

 input  table tt-custos-item,

 output table tt-custos-calculo,

 output table tt-custos-mob-dir,

 output table tt-custos-ggf,

 output table tt-custos-op,

 output table tt-erro).

Parâmetros: Os parâmetros utilizados pela API são:

- tt-custos-param: Temp-table que deve conter apenas um registro e representa os parâmetros gerais utilizados pela API para cálculo dos custos de todos os itens. A temp-table tt-custos-param contém os seguintes campos:

cod-versao-integracao – Contém a versão de integração da API (atualmente 001).

l-acomp – Indica se a API irá apresentar uma tela mostrando o andamento do processo sendo executado (ut-acomp).

h-acomp – Caso o parâmetro l-acomp for YES, h-acomp deverá conter o handle do programa ut-acomp, executado de forma persistente:

run utp/ut-acomp.p persistente set tt-custos-param.h-acomp.

Caso o handle não seja informado, a própria API realizará a chamada para o ut-acomp, setando o handle (se l-acomp = YES).

tp-preco – Corresponde ao tipo de preço/custo utilizado para o cálculo, conforme a tabela abaixo:

1 – Médio Batch (utiliza moeda/estabelecimento);

2 – Médio On-Line (utiliza moeda/estabelecimento);

3 – Custo Padrão (utiliza moeda/estabelecimento);

4 – Preço Base;

5 – Preço Reposição;

6 – Preço Última Entrada;

7 – Preço Fiscal.

moeda – Indica a moeda que será utilizada para a realização dos cálculos (quando o preço/custo permitir essa opção). As moedas utilizadAs são as constantes dos parâmetros de estoque:

0 – Moeda Corrente;

1 – Moeda Alternativa 1;

2 – Moeda Alternativa 2.

corrige – Determina se o programa realizará a correção dos valores caso a moeda informada seja diferente da moeda padrão do item.

cod-estabel – Informa o código do estabelecimento que será utilizado para os cálculos (quando o preço/custo permitir essa opção).

tempo-prepar – Informa se o programa irá considerar o tempo de preparação das operações no cálculo, conforme a tabela abaixo:

0 – Sem Custo Preparação

1 – Preparação Ordem

2 – Preparação X Número Lotes

3 – Preparação Unitário X Quantidade

4 – Preparação X Quantidade

custo-oper – Contém a forma de cálculo dos custos das operações, conforme abaixo:

1 – Total

2 – Previsto

3 – Padrão

rkw-up – Informa a metodologia de cálculo utilizada para as operações:

1 – RKW

2 – UP

nr-niveis – Determina o número máximo de níveis de estrutura que o programa irá processar.

cod-obsoleto – Indica o grau de obsolescência dos itens que irão participar dos cálculos:

1 – Apenas itens Ativos

2 – Opção Anterior + Obsoletos para Ordens Automáticas

3 – Opção Anterior + Obsoleto Todas as Ordens

4 – Opção Anterior + Totalmente Obsoleto (Todos os Itens)

atual-custo-data – Informa se o programa irá atualizar a tabela “custo-data”, que contém os valores calculados de custos dos itens para consultas específicas.

tipo-custo – Campo chave da tabela “custo-data”, utilizado para conter um número indicativo do tipo de cálculo de custos armazenado (definido pelo usuário), caso a opção atual-custo-data esteja setada.

atual-com-erro – Caso a opção atual-custo-data receba o valor YES, essa opção indica se a tabela será atualizada mesmo que tenha ocorrido algum erro no cálculo do custo do item.

dt-custo – Outro campo chave da tabela “custo-data”, e deve conter a data do cálculo do custo do item.

cons-estab-fil - Informa se o sistema irá considerar o estabelecimento dos itens filhos para composição dos tempos da operações

detalha-ggf – Informa se o Gastos gerais de fabricação – GGF será listado de forma detalhada com seus respectivos itens o em forma resumida com somente os tempos.

l-visao-un – informa se deseja ter a visão por Unidade de Negócio ou não. O padrão é Não, pois o campo é lógico. O campo será utilizado somente a partir da release 2.06B, se a funcionalidade de unidade de negócio estiver ativada.

c-origem – informa se a emissão do relatório partiu da engenharia ou partiu do módulo de desenvolvimento de produtos, caso seja do módulo de engenharia, deverá ser informado “EN”, caso contrário, deve ser informado “DP”

- tt-custos-item: Contém as informações relativas aos itens que serão calculados.

i-sequen – Código de sequência que serve para o relacionamento entre as tabelas de saída.

it-codigo – Código do Item.

cod-refer –  Código de referência do item.

quantidade – Quantidade utilizada para o cálculo.

dt-corte-estrut – Data de corte da estrutura do item a ser calculado.

dt-corte-op – Data de corte das operações do item.

fm-codigo – Código da família do item a ser calculado (opcional).

ge-codigo – Código do grupo de estoque do item a ser calculados (opcional).

cod-unid-negoc – Código da unidade de negócio do item, guardado a partir do padrão. 

c-origem – Informa se a emissão do relatório partiu da Engenharia ou partiu do módulo de Desenvolvimento de Produtos, caso seja do módulo de engenharia, o programa deve ser informado “EN”, caso contrário, deve ser informado “DP”.

- tt-custos-calculo: Retorna o cálculo dos custos de cada item constante da tt-custos-item e também dos componentes desses itens. As informações retornadas por essa temp-table são:

i-sequen – Código de sequência, idêntico ao informado na tabela tt-custos-item.

seq-impressão – Sequência de impressão das informações.

it-codigo – Código do item calculado.

cod-refer – Código de referência do item calculado.

nivel – Número do nível na estrutura onde o item está localizado.

vl-unit-mat – Valor unitário de material. Caso o preço/custo parametrizado para cálculo não permita subdivisão em material, mão de obra e GGF, sempre será utilizado o campo de material, ficando os demais com o valor 0 (zero).

vl-unit-mob – Valor unitário de mão de obra direta.

vl-unit-mob-c – Valor unitário de mão de obra dos componentes do item calculado.

vl-unit-ggf – Valor unitário de GGF, dividido nos seis tipos disponíveis de GGF.

vl-unit-ggf-c – Valor unitário de GGF  dos componentes do item calculado.

vl-unit-prep – Valor unitário de preparação.

vl-unit-ext – Valor unitário das operações externas.

vl-unit-ref – Valor unitário de refugo.

qt-up – Quantidade de UP´s relativas ao valor das operações.

qt-up-prep – Quantidade de UP´s relativas ao valor de preparação das operações.

quantidade –

dt-cotacao – Data de obtenção do preço/custo.

fm-codigo – Família do item calculado.

ge-codigo – Grupo de máquina do item calculado.

ult-nivel – Informa se o item pertence ao último nível na estrutura.

c-origem - Retornará se o registro é do módulo de engenharia (“EN”) ou do módulo de desenvolvimento de produtos (“DP”).

- tt-custos-mob-dir: Contém os valores totais de mão de obra direta agrupados por código de mob-dir.

i-sequen – Código de sequência, idêntico ao informado na tabela tt-custos-item.

cd-mob-dir – Código de mão de obra direta (tabela de salários).

valor – Valor do custo de mão de obra direta.

tempo – Tempo em horas das operações reportadas.

- tt-custos-ggf: Contém os valores totais de GGF agrupados por código de centro de custo.

i-sequen – Código de sequência, idêntico ao informado na tabela tt-custos-item.

cc-codigo – Código do centro de custo onde o GGF foi apontado.

valor – Valor do custo de GGF.

tempo – Tempo em horas das operações reportadas.

- tt-custos-op: Contém o resultado dos cálculos relativos às operações dos itens informados na tt-custos-item.

i-sequen – Código de sequência, idêntico ao informado na tabela tt-custos-item.

seq-impressao – Sequência de impressão.

cod-roteiro – Código do roteiro ao qual a operação pertence.

op-codigo – Código da operação.

vl-unit-mob – Valor unitário de mão de obra direta.

vl-unit-ggf –  Valor unitário de GGF (nos seis tipos disponíveis).

vl-unit-prep –  Valor unitário de preparação.

vl-unit-ext – Valor unitário informado da operação externa.

qt-up – Quantidade de up´s.

qt-up-prep – Quantidade de up´s de preparação.

cc-codigo – Código do centro de custos da operação

cd-mob-dir – Código de mão de obra direta da operação.

c-origem – Retornará se o registro é do módulo de Engenharia (“EN”) ou do módulo de Desenvolvimento de Produtos (“DP”).

- tt-erro: Apresenta os erros eventualmente ocorridos durante o cálculo.

i-sequen – Código de sequência, idêntico ao informado na tabela tt-custos-item.

cd-erro –  Código do erro ocorrido.

mensagem – Mensagem de erro.

Retorno: A API irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do cálculo são especificados na temp-table tt-erro.