Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprp/prapi002.p

 

Objetivo Principal da API:  Calcular os preços de venda dos produtos e/ou itens conforme as fórmulas e parametrizações existentes no módulo de Administração dos Preços de Venda. Este programa também possibilita que o usuário informe o preço final de vendas para que o cálculo seja feito de forma que se saiba o lucro correspondente à  prática deste valor.                                                    

 

Considerações Gerais:

 

  • Esta API é chamada a partir do programa de cálculo de preço (PR1001) e do programa de Verificação Preço (PR1009, através da BO dibo/bodi335.p).

 

  • Este programa possui procedures específicas de cálculos, e a procedure parametrosEntrada será pré-requisito para a execução do mesma, independente de qual cálculo se deseja efetuar.

 

  • Para calcular o preço é necessário existir um componente do tipo Lucro na fórmula. Para calcular o Lucro, é necessário existir um componente do tipo Preço na fórmula. Para calcular o preço FOB, será necessário existir um componente do tipo Frete na fórmula.

 

  • Por exemplo, se for necessário calcular o valor do preço de venda, é necessário primeiramente executar a procedure parametrosEntrada passando os parâmetros necessários para a mesma e posteriormente executar a procedure calcularValorPrecoVenda que retornará os valores necessários, conforme exemplo:

 

        run parametrosEntrada (input  /* Parâmetro Entrada Especificado abaixo */,

               input  /* Parâmetro Entrada Especificado abaixo */,

                                      input  /* Parâmetro Entrada Especificado abaixo */,

                                      input  /* Parâmetro Entrada Especificado abaixo */,

                                      input  /* Parâmetro Entrada Especificado abaixo */,

                                                 input  /* Parâmetro Entrada Especificado abaixo */,

                                                 input  /* Parâmetro Entrada Especificado abaixo */,

                                                 input  /* Parâmetro Entrada Especificado abaixo */).

                       

        run calcularValorPrecoVenda  (output /* Parâmetro Saída Especificado Abaixo*/,

                                                              output /* Parâmetro Saída Especificado Abaixo*/,

                                                             output /* Parâmetro Saída Especificado Abaixo*/).

 

PROCEDURES EXISTENTES NA PRAPI002

 

A seguir, serão citadas as procedures existentes na PRAPI002 e os parâmetros necessários para a execução das mesmas.

 

As colunas I - O - IO das tabelas que serão mostradas a seguir, indicam se o parâmetro informado é de entrada (I), saída (O) ou ambos (IO).

 

Procedure parametrosEntrada

 

Esta procedure receberá os parâmetros de entrada necessários para os cálculos que serão realizados nesta API.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-rw-form-tb-formula

 

Rowid

 

X

 

 

Esse parâmetro contém o rowid da tabela form-tb-formula. Através dele podemos ter a fórmula, que será desmembrada e submetida ao interpretador de fórmulas, que irá fornecer o resultado.

p-cod-markup

Integer

>>9

X

 

 

Código do markup que será utilizado para geração dos preços de venda da tabela de preços

p-rw-it-markup

Rowid

 

X

 

 

Com esse rowid, será possível localizar para-ped, para-fat, par-preco, tabelas essas usadas para cálculo do preço (relacionado a variavel-preco).

 

p-rw-item

Rowid

 

X

 

 

Com esse rowid, será possível localizar item,  tabela essa usada para cálculo do preco (relacionado a variavel-preco).

p-rw-pr-it-per

Rowid

 

X

 

 

Com esse rowid, será possível localizar a tabela pr-it-per, tabela que está sendo usada para cálculo do preco (relacionado a variavel-preco).

p-lucro-informado

Decimal

 

X

 

 

Usado apenas quando o usuário informa o percentual de lucro e deseja que o programa apure qual o preço que será praticado. Usado apenas quando executada a procedure simularValorPrecoVendaInformandoLucro.

p-preco-informado

Decimal

 

X

 

 

Usado apenas quando o usuário informa o preço de venda que deseja praticar, e quer que o programa calcule o % de lucro que ele obterá. Usado apenas quando executada a procedure simularPercentualLucroInformandoPreco.

p-preco-cif

Decimal

 

X

 

 

Esse parâmetro é passado apenas quando se deseja obter o valor comp lucro (ao executar a procedure calcularValorComponenteLucro). É necessário retornar sempre um percentual. Mas quando o tipo do componente é valor, o preco cif deve ser divido por 100

 

PROCEDURE calcularValorPrecoVenda

 

Esta procedure realizará o cálculo do valor do preço de venda, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api

 

PROCEDURE calcularPercentualLucro

 

Esta procedure realizará o cálculo do percentual do lucro, retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE calcularValorComponenteLucro

 

Esta procedure realizará o cálculo do valor do componente do lucro, retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE calcularPrecoMinCIF

 

Esta procedure realizará o cálculo do preço mínimo CIF, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE calcularPrecoMinFOB

 

Esta procedure realizará o cálculo do preço mínimo FOB, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

PROCEDURE calcularPrecoFOB

 

Esta procedure realizará o cálculo do preço FOB, e retornará os valores conforme tabela abaixo. Para calcular o preço FOB é necessária uma fórmula de Preço. Por isso, nessa procedure é feita uma leitura da fórmula que seja do tipo preço.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados..

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularValorPrecoVendaInformandoLucro

 

Esta procedure tem por objetivo simular o valor do preço de venda informando o lucro, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api

 

 

PROCEDURE simularPercentualLucroInformandoPreco

 

Esta procedure tem por objetivo simular o percentual de lucro informando o preço, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularPrecoMinCIFInformandoLucro

 

Esta procedure tem por objetivo simular o preço mínimo CIF informando o lucro, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado .

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularPrecoMinCIFInformandoPreco

 

Esta procedure tem por objetivo simular o preço mínimo CIF informando o preço, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado .

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularPrecoMinFOBInformandoLucro

 

Esta procedure tem por objetivo simular o preço mínimo FOB informando o lucro, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularPrecoMinFOBInformandoPreco

 

Esta procedure tem por objetivo simular o preço mínimo FOB informando o preço, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularPrecoFOBInformandoLucro

 

Esta procedure tem por objetivo simular o preço FOB informando o lucro, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.

 

PROCEDURE simularPrecoFOBInformandoPreco

 

Esta procedure tem por objetivo simular o preço FOB informando o preço, e retornará os valores conforme tabela abaixo.

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-resultado

 

Decimal

 

 

X

 

Valor final encontrado, baseado na fórmula, conforme tipo de resultado solicitado.

p-formula-num

Char

 

 

X

 

Fórmula substituída pelos respectivos valores numéricos usados.

tt-erros-prapi002

Table

 

 

X

 

Temp table com os erros encontrados na api.