...
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | laphtml/mlahtml025p.p |
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 variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
...
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” | ||
...
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” | |
...
