Documento de API

Objetivo: Realizar o estorno dos reportes da produção, gerando a movimentação “contrária” de estoque, de materiais, de GGF e Mão-de-obra direta em relação aos movimentos originalmente gerados pelo reporte. Toda a movimentação é feita com base nos movimentos gerados originalmente, não permitindo a realização de estornos parciais. Essa característica auxilia na eliminação de erros, tornando o processo muito mais rápido e seguro.

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 estornos. A sintaxe para a chamada é:

{cpp/cpapi009.i}  //Definição das temporárias para uso no CPAPI011. São iguais a CPAPI009
{cdp/cd0666.i}    //Definição da tabela temporária tt-erro

run cpp/cpapi011.p  (input        table tt-rep-prod,
                     input-output table tt-erro,
                     input        table tt-relatorio,
                     input        YES /*l-deleta-erros*/).

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

1. tt-rep-prod

   (Definição conforme CPAPI009) – Temp-table contendo as informações principais dos reportes que serão estornados. Apesar da temp-table possuir vários campos, pois sua definição é a mesma utilizada por outra API (CPAPI009 – Reporte por Item), os únicos campos que precisam ser preenchidos para que o estorno seja processado são:
   • Cod-versao-integracao: Contém a versão de integração da API (atualmente 001)
   • Nr-reporte: Contém o número do reporte que será estornado
   • Data: Contém da data de geração dos movimentos do estorno

2. tt-erro  

   (Definição da tabela conforme CPAPI009)  – Temp-table que retorna os erros e “avisos” retornados pela API durante o processamento dos reportes.

3. tt-relatorio  

   (Definição da tabela conforme CPAPI009) – Apesar de não ser mais utilizada, esta temp table deve ser utilizada para manter compatibilidade entre os programas

4. 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 estorno são especificados na temp-table tt-erro.

UPC Interna: A API possui duas chamadas UPC do tipo Ponto Estratégico, executadas respectivamente antes e depois do processamento do estorno.

Os nomes dos pontos de chamada UPC são respectivamente “Before-Return” e “After-Return” e o valor passado para a UPC corresponde ao rowid da tabela rep-prod relativo ao estorno sendo processado no momento.