Documento de API

Objetivo: Realizar a atualização do custo padrão de um ou mais itens, calculando e gerando posteriormente o movimento de variação relativo à essa atualização.

Tal movimento de variação será creditado ou debitado (dependendo se a alteração do preço padrão foi para maior ou menor) na “Conta de Variação de Saldo”, parametrizada no programa CE0110 – Manutenção de Contas para Contabilização.

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 uma ou mais atualizações. A sintaxe para a chamada é:

run csp/csapi002.p  (input        table tt-item-estab,                    

                     input-output table tt-erro,

                     input        l-deleta-erros).

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

-          tt-item-estab: Temp-table com as informações relativas ao registro da tabela “item-estab” que será atualizado. A API não realiza a criação de registros, sendo necessário que o registro na tabela já esteja criado. Essa temp-table possui os seguintes campos

cod-versao-integracao – Deve conter a versão de integração corrente da API (atualmente 001).

cod-estabel – Código do Estabelecimento.

it-codigo – Código do Item.

val-unit-mat-p – Novo valor unitário de materiais para o item.

val-unit-mob-p – Novo valor unitário de mão-de-obra direta.

val-unit-ggf-p – Novo valor unitário de GGF para o item.

Obs.: Os campos de valor são definidos como extent 3, pois recebem valores relativos às três moedas disponíveis nos parâmetros de estoque:

1 – Moeda Corrente

2 – Moeda Alternativa 1

3 – Moeda Alternativa 2

Caso uma ou ambas moedas alternativas não sejam utilizadas, pode-se passar o valor zero.

-          tt-erro: Temp-table que devolve os erros eventualmente encontrados durante o processamento da API. Possui os seguintes campos:

cd-erro –  Código do erro ocorrido.

mensagem – Mensagem de erro.

-          l-deleta-erros – Informa à API que o conteúdo anterior, eventualmente existente na temp-table de erros será eliminado logo após o início do processamento da API. Normalmente utiliza-se YES, sendo parametrizado como NO apenas se a chamada para a API fizer parte de uma transação maior, que eventualmente já tenha gerado registros na temp-table de erros e que devam permanecer após a chamada da API.

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 movimento de atualização são especificados na temp-table tt-erro.