EXAPI016 - API responsável pela integração das despesas de Exportação com o Contas a Pagar (Fluxo de Caixa)
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | exp/exapi016.p |
Considerações Gerais
Objetivo
Realizar a geração do movimento de fluxo para as despesas de exportação.
Funcionamento
A execução da API só ocorre na forma persistente.O programa chamador irá executar a procedure correspondente ao tratamento dos movimentos de fluxo para as despesas de exportação.
A sintaxe para executar a API/BO em modo persistente é realizada conforme abaixo:
run exp/exapi016.p persistent set h-handle. |
Obs.: A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
tt-param-fluxo | Entrada/Saída | ||||
Temp-table contendo os dados de parâmetros do fluxo | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-versao-integracao | INTEGER | 999 | Valida a versao da api sendo executada | Sim | - |
tipo-fluxo | INTEGER | 9 | Valida o tipo de atualizacao a ser efetuado | Sim | - |
| dt-inicio-fluxo | DATE | 99/99/9999 | Data inicial para geracao de movimento | Sim | - |
dt-ini | DATE | 99/99/9999 | Data inicial para a pesquisa | Sim | - |
dt-fim | DATE | 99/99/9999 | Data final para a pesquisa | Sim | - |
cod-estab-ini | CHARACTER | x(05) | Estabelecimento inicial da faixa | Sim | - |
cod-estab-fim | CHARACTER | x(05) | Estabelecimento final da faixa | Sim | - |
cod_unid_negoc_ini | CHARACTER | x(03) | Unidade de negocio inicial a compor o fluxo | Sim | - |
cod_unid_negoc_fim | CHARACTER | x(03) | Unidade de negocio final a compor o fluxo | Sim | - |
considera-pd | LOGICAL | Sim/Não | Considera pedidos de venda no fluxo | Sim | - |
pr-lib-tit | LOGICAL | Sim/Não | Identifica se serao somados os pedidos suspensos na carteira de pedidos para o fluxo de caixa. | Sim | - |
ped-suspenso | LOGICAL | Sim/Não | Identifica se vao ser somados os pedidos suspensos na carteira de pedidos para o fluxo de caixa. | Sim | - |
tipo-ordem-cc | INTEGER | 9 | 1-Confirmada, 2-Nao Confirm, 3-Ambas | Sim | - |
tipo-preco | INTEGER | 9 | 1-Reposicao, 2-Base,3-Ultima Entr,4-Medio, 5-Preco ON-line, 6-Preco Padrao | Sim | - |
considera-pv | LOGICAL | Sim/Não | Considera previsão de vendas no fluxo. | Sim | - |
cd-plano-pv | INTEGER | >>9 | Plano de vendas informado na tela do EMS 5 dos parâmetros do fluxo no EMS 2 | Sim | - |
tt-movto-fluxo | Entrada/Saída | ||||
Temp-table contendo os dados dos movimentos do fluxo | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-estabel | CHARACTER | x(5) | Estabelecimento | Sim | - |
data-movto | DATE | 99/99/9999 | Data Movimento | Sim | - |
| tp-codigo | INTEGER | >>9 | Tipo | Sim | - |
| cod-gr-forn | INTEGER | >9 | Grupo de Fornecedor | Sim | - |
| cod-emitente | INTEGER | 999999999 | Emitente | Sim | - |
| tipo-fluxo | INTEGER | 9 | Tipo Fluxo Financeiro | Sim | - |
| tipo-movto | INTEGER | 9 | Tipo Movimento | Sim | - |
| origem | INTEGER | 9 | Origem | Sim | - |
| mo-codigo | INTEGER | >9 | Moeda | Sim | - |
| cod_unid_negoc | CHARACTER | x(03) | Unidade de Negócio | Sim | - |
| numero-ordem | CHARACTER | x(16) | Numero da Ordem | Sim | - |
| parcela | CHARACTER | x(02) | Parcela | Sim | - |
| sit-ordem | INTEGER | >9 | Situação da Ordem | Sim | - |
| vl-fluxo | INTEGER | ->>>,>>>,>>>,>>9.99 | Valor do Movimento de Fluxo Caixa | Sim | - |
| data-fluxo | DATE | 99/99/9999 | Data Fluxo | Sim | - |
| it-codigo | CHARACTER | x(16) | Item | Sim | - |
| nr-sequencia | INTEGER | >>,>>9 | Sequencia | Sim | - |
| portador | INTEGER | >>>>9 | Portador | Sim | - |
| modalidade | INTEGER | 9 | Modalidade | Sim | - |
| cod-grupo | INTEGER | 9 | Grupo | Sim | - |
| nome-abrev | CHARACTER | x(12) | Nome Abreviado | Sim | - |
| nr-pedcli | CHARACTER | x(12) | Numero do Pedido | Sim | - |
| nome-emit | CHARACTER | x(40) | Nome Emitente | Sim | - |
| referencia | CHARACTER | x(08) | Referencia | Sim | - |
| Índice: ch-fluxo | data-fluxo tp-codigo tit-codigo | ||||
| Índice: ch-orig | origem | ||||
tt-erro | Entrada/Saída | ||||
Temp-table contendo os erros da execução | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cd-erro | INTEGER | 999999999 | Código do Erro | Sim | - |
modulo | CHARACTER | x(3) | Módulo | Sim | - |
| mensagem | CHARACTER | x(255) | Mensagem | Sim | - |
Métodos de Negócio
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-gera-fluxo-desp | ||||
Requisito | API deve estar rodando persistente na varável h-handle. | |||
Sintaxe | run pi-gera-fluxo-desp in h-handle (INPUT <r-ped-item> INPUT <tt-param-fluxo> INPUT-OUTPUT <tt-movto-fluxo> INPUT-OUTPUT <tt-erro>) | |||
Descrição
| Realiza a leitura das despesas dos pedidos de venda e geração do fluxo com base nelas | |||
Parâmetros | Tipo | Input/Output | Descrição | |
r-ped-item | ROWID | INPUT | Rowid da tabela ped-item | |
tt-param-fluxo | TEMP-TABLE | INPUT | Tabela temporária tt-param-fluxo | |
tt-movto-fluxo | TEMP-TABLE | INPUT-OUTPUT | Tabela temporária tt-movto-fluxo | |
tt-erro | TEMP-TABLE | INPUT-OUTPUT | Tabela temporária tt-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 problemas são especificados na temp-table tt-erro. | |||
pi-gera-fluxo-desp-nota | ||||
Requisito | API deve estar rodando persistente na varável h-handle. | |||
Sintaxe | run pi-gera-fluxo-desp in h-handle (INPUT <tt-param-fluxo> INPUT-OUTPUT <tt-movto-fluxo> INPUT-OUTPUT <tt-erro>) | |||
Descrição
| Realiza a leitura das despesas das notas fiscais e geração do fluxo com base nelas | |||
Parâmetros | Tipo | Input/Output | Descrição | |
tt-param-fluxo | TEMP-TABLE | INPUT | Tabela temporária tt-param-fluxo | |
tt-movto-fluxo | TEMP-TABLE | INPUT-OUTPUT | Tabela temporária tt-movto-fluxo | |
tt-erro | TEMP-TABLE | INPUT-OUTPUT | Tabela temporária tt-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 problemas são especificados na temp-table tt-erro. | |||
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas