Histórico da Página
Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | laphtml/mlahtml025p.p |
Considerações Gerais
Objetivo
O objetivo desta API é fornecer dados sobre pendências do módulo do MLA para o documento de Antecipação, estejam elas pendentes de aprovações, aprovadas ou reprovadas.
Funcionamento
A API fornece basicamente dois tipos de informações: listagem de documentos (neste caso Antecipação) e/ou detalhe um documento (neste caso Antecipação).
A sintaxe para a chamada da API, que deve ser de forma persistente:
run laphtml/mlahtml025p.p persistent set h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Metodo Negócio
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
listagemDocumentos | |||
Requisito | Listagem de pendências do MLA (em várias situações) do documento de Antecipação | ||
Sintaxe | {laphtml/mladados.i}
RUN listagemDocumentos in h-handle (input iCodTipDoc, input tipoDoc, input dtIni, input dtFim, output table ttDados). | ||
Descrição | Através dos parâmetros passados para a procedure, ela retorna os registros para listagem dos documentos (Antecipação) | ||
Parâmetros | Tipo | Descrição | |
iCodTipDoc | INTEGER | Código do tipo de documento (neste caso para Antecipação, informar 25) | |
tipoDoc | CHARACTER | Tipo de documento a ser apresentado. As opções que podem ser utilizadas são:
prin: Documentos pendentes de aprovação saida: Documentos aprovados, rejeitados e reaprovados (histórico de aprovação) alt: Dcoumentos pendentes como usuário alternativo mes: Documentos como usuário mestre ambos: Documentos pendente de aprovação como usuário principal e como alternativo aprov: Documentos aprovados e reaprovados reprov: Documentos reprovados | |
dtIni | DATE | Data de início para consideração dos documentos já aprovados, rejeitados, reaprovados (histórico) | |
dtFim | DATE | Data de término para consideração dos documentos já aprovados, rejeitados, reaprovados (histórico)
As datas somente são utilizadas para o histórico e caso não sejam informadas serão considerados 30 dias. | |
Retorno | A procedure retorna uma temp-table, do tipo ttDados, que está definida na include laphtml/mladados.i. Nesta temp-table contém dados da temp-table tt-it-requisicao-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-it-requisicao-lista:
ttDados.cTable = “tt-it-requisicao-lista” ttDados.iRow = 1 ttDados.cField = “nr-requisicao” ttDados.cValue = “3456”
ttDados.cTable = “tt-it-requisicao-lista” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-it-requisicao-lista” ttDados.iRow = 1 ttDados.cField = “it-codigo” ttDados.cValue = “Antecipação” | ||
ttDados | Entrada/Saída | |||
Temp-table com dados da listagem em formato único. | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
cTable | CHARACTER | Nome da temp-table | Sim | Não se aplica |
iRow | INTEGER | Sequencial de registro | Sim | Não se aplica |
cField | CHARACTER | Nome do campo da temp-table | Sim | Não se aplica |
cValue | CHARACTER | Valor do campo | Sim | Não se aplica |
tt-lista | Entrada/ Saída | ||||
Temp-table com dados da Antecipação para serem apresentados na listagem | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | |
Tta_cod-estab | CHARACTER | X(5) | Estabelecimento | Sim | |
Tta_nom_pessoa | CHARACTER | X(40) | Nome | Sim | |
Tta_cod_refer | CHARACTER | X(10) | Referencia | Sim | |
Tta_dat_transacao | DATE | 99/99/9999 | Data Transação | Sim | |
Tta_val_tit_ap | DECIMAL | ->>>,>>>,>>9.99 | Valor Título | Sim | |
Tta_cod_usuar | CHARACTER | X(12) | Requisitante | Sim | |
|
|
|
|
| |
situacao-doc | INTEGER | >9 | Situação da pendência | Sim | |
situacao-doc-desc | CHARACTER | X(15) | Descrição da situação | Sim | |
nr-trans | INTEGER | >>>,>>>,>>9 | Número da transação (MLA) | Sim | |
alternativo | LOGICAL | YES/NO | Indica que é uma pendência como alternativo | Sim | |
| mestre | LOGICAL | YES/NO | Indica que é uma pendência como mestre | Sim | |
cod-usuar | CHARACTER | X(12) | Aprovador | Sim | |
mla-doc-pend-aprov-valor-doc | DECIMAL | ->>,>>>,>>9.99 | Valor do documento | Sim | |
chave-doc | CHARACTER | X(40) | Chave do documento | Sim | |
chave-doc-formatada | CHARACTER | X(70) | Chave do documento formatada | Sim | |
| mla-ep-codigo | CHARACTER | X(3) | Código da empresa | Sim | |
| mla-cod-estabel | CHARACTER | X(5) | Código do estabelecimento | Sim | |
| mla-desc-ep-codigo | CHARACTER | X(70) | Nome da empresa | Sim | |
| mla-desc-cod-estabel | CHARACTER | X(40) | Nome do estabelecimento | Sim | |
| mla-nome-usuar | CHARACTER | X(40) | Nome do aprovador | Sim | |
| Nota | ||
|---|---|---|
| ||
Se necessário alterar ou incluir informação na listagem, existe um ponto de EPC com evento com o nome de “ListagemDocs” que pode ser utilizado. Ele possui o parâmetro “Handle_ttDados”, que possui o handle da temp-table ttDados. |
listagemDocumentosEmpresaEstab | |||
Requisito | Listagem de pendências do MLA (em várias situações) do documento de Antecipação por empresa e estabelecimento | ||
Sintaxe | {laphtml/mladados.i}
RUN listagemDocumentosEmpresaEstab in h-handle (input cEpCodigo, input cCodEstabel, input iCodTipDoc, input tipoDoc, input dtIni, input dtFim, output table ttDados). | ||
Descrição | Através dos parâmetros passados para a procedure, ela retorna os registros para listagem dos documentos (Antecipação) | ||
Parâmetros | Tipo | Descrição | |
| cEpCodigo | CHARACTER | Código da empresa (Se passar em branco considera todas) | |
| cCodEstabel | CHARACTER | Código do estabelecimento (Se passar em branco considera todos) | |
iCodTipDoc | INTEGER | Código do tipo de documento (neste caso para antecipação, informar 25) | |
tipoDoc | CHARACTER | Tipo de documento a ser apresentado. As opções que podem ser utilizadas são:
prin: Documentos pendentes de aprovação saida: Documentos aprovados, rejeitados e reaprovados (histórico de aprovação) alt: Documentos pendentes como usuário alternativo mes: Documentos como usuário mestre ambos: Documentos pendente de aprovação como usuário principal e como alternativo aprov: Documentos aprovados e reaprovados reprov: Documentos reprovados | |
dtIni | DATE | Data de início para consideração dos documentos já aprovados, rejeitados, reaprovados (histórico) | |
dtFim | DATE | Data de término para consideração dos documentos já aprovados, rejeitados, reaprovados (histórico)
As datas somente são utilizadas para o histórico e caso não sejam informadas serão considerados 30 dias. | |
Retorno | A procedure retorna uma temp-table, do tipo ttDados, que está definida na include laphtml/mladados.i. Nesta temp-table contém dados da temp-table tt-it-requisicao-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-it-requisicao-lista:
ttDados.cTable = “tt-it-requisicao-lista” ttDados.iRow = 1 ttDados.cField = “nr-requisicao” ttDados.cValue = “3456”
ttDados.cTable = “tt-it-requisicao-lista” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-it-requisicao-lista” ttDados.iRow = 1 ttDados.cField = “it-codigo” ttDados.cValue = “Antecipação” | ||
detalheDocumento | ||
Requisito | Detalhe de pendências do MLA do documento de Antecipação | |
Sintaxe | {laphtml/mladados.i}
RUN detalheDocumento in h-handle (input p-nr-transacao, input p-situacao, output table ttDados). | |
Descrição | Através dos parâmetros passados para a procedure, ela retorna as informações para detalhamento da pendência do documento (Antecipação) | |
Parâmetros | Descrição | |
p-nr-transacao | Número da transação da pendência (no MLA) | |
Retorno | p-situacao: Situação da pendência (INTEGER) – Conforme situação no MLA (doc-pend-aprov)
A procedure retorna também uma temp-table, do tipo ttDados, que está definida na include laphtml/mladados.i. Nesta temp-table contém dados das temp-tables tt-requisicao e tt-it-requisicao, que são detalhadas na tabela mais a baixo.
Exemplo de registro que poderiam existir na tt-requisicao:
ttDados.cTable = “tt-requisicao” ttDados.iRow = 1 ttDados.cField = “nr-requisicao” ttDados.cValue = “3456”
ttDados.cTable = “tt-requisicao” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-requisicao” ttDados.iRow = 1 ttDados.cField = “desc-tp-requis” ttDados.cValue = “Antecipação” | |
Tt_detalhe_doc025 | Entrada/ Saída | |||
Temp-table com dados da antecipação para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
Tta_cod_estab | CHARACTER | X(5) | Estabelecimento | Sim |
Tta_cod_refer | CHARACTER | X(10) | Referencia | Sim |
Tta_cod_tip_fluxo_financ | CHARACTER | X(12) | Tipo Fluxo Financ | Sim |
Ttv_des_tip_fluxo_financ | CHARACTER | X(40) | Descrição | Sim |
Tta_cod_plano_cta_ctbl | CHARACTER | X(8) | Plano de Contas | Não |
Ttv_des_plano_cta_ctbl | CHARACTER | X(40) |
| Não |
Tta_cod_cta_ctbl | CHARACTER | X(20) | Conta Contabil | Não |
Ttv_des_cta_ctbl | CHARACTER | X(50) |
| Não |
Tta_cod_unid_negoc | CHARACTER | X(3) | Unid Negocio | Sim |
Ttv_des_unid_negoc | CHARACTER | X(40) |
| Sim |
Tta_cod_plano_ccusto | CHARACTER | X(8) | Plano Centro Custo | Não |
Ttv_des_plano_ccusto | CHARACTER | X(40) |
| Não |
Tta_cod_ccusto | CHARACTER | X(20) | Centro de Custo | Não |
Ttv_des_ccusto | CHARACTER | X(40) |
| Não |
Tta_val_aprop_ctbl | DECIMAL | ->>>,>>>,>>9.99 | Valor Aprop Ctbl | Sim |
Tt_item_detalhe_doc025 | Entrada/ Saída | |||
Temp-table com dados dos itens de Antecipação para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
Tta_cod_estab | CHARACTER | X(5) | Estabelecimento | Sim |
Ttv_des_cod_estab | CHARACTER | X(40) |
| Sim |
Tta_cod_refer | CHARACTER | X(10) | Referencia | Sim |
Tta_dat_transacao | DATE | 99/99/9999 | Data Transacao | Sim |
Tta_cdn_fornecedor | INTEGER | >>>,>>>,>>9 | Fornecedor | Sim |
Tta_nom_pessoa | CHARACTER | X(40) | Nome | Sim |
Tta_cod_pais | CHARACTER | X(3) | País | Sim |
Tta_nom_pais | CHARACTER | X(32) |
| Sim |
Tta_cod_espec_docto | CHARACTER | X(3) | Especie Documento | Sim |
Tta_cod_ser_docto | CHARACTER | X(5) | Série do Documento | Sim |
Tta_cod_tit_ap | CHARACTER | X(10) | Titulo | Sim |
Tta_cod_parcela | CHARACTER | X(02) | Parcela | Sim |
Tta_cod_portador | CHARACTER | X(5) | Portador | Sim |
Tta_dat_emis_docto | DATE | 99/99/9999 | Data Emissão | Sim |
Tta_dat_vencto_tit_ap | DATE | 99/99/9999 | Data Vencimento | Não |
Tta_cod_indic_econ | CHARACTER | X(8) | Moeda | Não |
Tta_val_cotac_indic_econ | DECIMAL | >>>>,>>9.9999999999 | Cotação | Sim |
Tta_val_cotac_indic_inver | DECIMAL | >>>>,>>9.9999999999 |
| Sim |
Tta_val_tit_ap | DECIMAL | ->>>,>>>,>>9.99 | Valor Titulo | Sim |
Tta_cod_forma_pagto | CHARACTER | X(3) | Forma Pagamento | Sim |
Tta_des_forma_pagto | CHARACTER | X(40) | Desc Forma Pagto | Sim |
Ttv_ind_modo_pagto | CHARACTER | X(10) | Modo Pagto | Sim |
Tta_num_cheque | INTEGER | >>>>,>>>,>>9 | Num Cheque | Não |
Tta_num_talon_cheq | INTEGER | >>>,>>>,>>9 | Talonário Cheques | Não |
Tta_ind_favorec_cheq | CHARACTER | X(15) | Portador | Não |
Tta_nom_favorec_cheq | CHARACTER | X(40) | Nome Favorecido | Não |
Tta_cod_histor_padr | CHARACTER | X(8) | Historico padrão | Não |
Tta_des_text_histor | CHARACTER | X(2000) | Historico | Não |
Obs.: Se necessário alterar ou incluir informação no detalhamento, existe um ponto de EPC com evento com o nome de “DetalheDoc” que pode ser utilizado. Ele possui o parâmetro “Handle_ttDados”, que possui o handle da temp-table ttDados.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas