Exibir origem

CONTEÚDO

Visão Geral
Execução
Funcionamento
Parâmetros

01. VISÃO GERAL

Essa API tem por objetivo realizar a criação ou alteração de registros de ordens de compra (ordem-compra) e suas parcelas (prazo-compra).

02. Execução

A API deve ser chamada de forma padrão (utilizando o comando "RUN") passando os parâmetros esperados.

Ex.: RUN ccp/ccapi012.p (INPUT-OUTPUT tt-ordem-compra,

INPUT-OUTPUT tt-prazo-compra,

OUTPUT TABLE tt-erro,

INPUT NO).

03. Funcionamento

A API irá realizar as consistências de negócio com os dados recebidos nas tabelas temporárias. Ex.: Verificar se a tabela de ordem de compra possui um preço válido (maior do que zero). Após isso, os registros de cotação são gerados de acordo com a configuração do módulo, e caso o programa chamador desejar(último parâmetro recebido pela API) realiza o split de compras. Além disso, quando necessário são realizadas as integrações com outros módulos como investimentos e planejamento.

Caso não informado o número da ordem de compra na tabela temporária (tt-ordem-compra.numero-ordem) a API irá realizar a busca da próxima numeração disponível, conforme parâmetros de compras (CC0104).

04. Parâmetros

A seguir estão listados as definições dos parâmetros recebidos e retornados pela API bem como o que significam.

Pode-se utilizar a include {ccp/ccapi012.i1} para definição das tabelas temporárias tt-ordem-compra e tt-prazo-compra

FIELD l-split AS LOGICAL INITIAL NO // Indica se realiza ou não o split das ordens de compra
FIELD l-gerou AS LOGICAL // Indica se a ordem de compra foi gerada
FIELD r-ordem AS ROWID // Caso a ordem tenha sido criada seu rowid é gravado nesse campo
FIELD ind-tipo-movto AS INTEGER FORMAT "99" INITIAL 1. // Indica o tipo de movimentação (1 = Inclusão, 2 = Alteração)

// Entrada e Saída (INPUT-OUTPUT)

FIELD ind-tipo-movto AS INTEGER FORMAT "99" INITIAL 1. // Indica o tipo de movimentação (1 = Inclusão, 2 = Alteração)

// Entrada e Saída (INPUT-OUTPUT)

FIELD i-sequen AS INTEGER // Sequencia do erro gerado na execução
FIELD cd-erro AS INTEGER // Código do erro gerado na execução
FIELD mensagem AS CHARACTER FORMAT "x(255)". // Mensagem derivada do erro gerado durante a execução

// Saída (OUTPUT TABLE)

Parâmetro de entrada lógico que indica se será realizado ou não o split de compras.

// Entrada (INPUT l-split)

<!-- esconder o menu --> 


<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>