Histórico da Página
Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | laphtml/mlahtml014p.p |
Considerações Gerais
Objetivo
O objetivo desta API é fornecer dados sobre pendências do módulo do MLA para o documento de medição de contrato de compra, estejam elas pendentes de aprovações, aprovadas ou reprovadas.
Funcionamento
A API fornece basicamente dois tipos de informações: listagem de documentos (neste caso medições de contrato de compra) e/ou detalhe um documento (neste caso medição de contrato de compra).
A sintaxe para a chamada da API, que deve ser de forma persistente:
run laphtml/mlahtml014p.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.
Método 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 medição de contrato de compra | ||
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 (medições de contrato de compra) | ||
Parâmetros | Tipo | Descrição | |
iCodTipDoc | INTEGER | Código do tipo de documento (neste caso para medição de contrato de compra, informar 14) | |
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-medicao-contrat-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-medicao-contrat-lista:
ttDados.cTable = “tt-medicao-contrat-lista” ttDados.iRow = 1 ttDados.cField = “nr-contrato” ttDados.cValue = “3456”
ttDados.cTable = “tt-medicao-contrat-lista” ttDados.iRow = 1 ttDados.cField = “numero-ordem” ttDados.cValue = “88888”
ttDados.cTable = “tt-medicao-contrat-lista” ttDados.iRow = 1 ttDados.cField = “valor” ttDados.cValue = “9999999” | ||
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-medicao-contrat-lista | Entrada/ Saída | |||
Temp-table com dados da medição do contrato de compra para serem apresentados na listagem | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
nr-contrato | INTEGER | >>>>>>>>9 | Contrato | Sim |
num-seq-item | INTEGER | >>>,>>9 | Sequência do Item | Sim |
numero-ordem | INTEGER | zzzzz9,99 | Ordem de compra | Sim |
num-seq-event | INTEGER | >,>>9 | Sequência do evento | Sim |
num-seq-medicao | INTEGER | >,>>9 | Sequência da medição | Sim |
it-codigo | CHARACTER | X(16) | Código do item | Sim |
valor | DECIMAL | ->>,>>>,>>9.99 | Valor | Sim |
des-contrat | CHARACTER | X(32) | Descrição do contrato | Sim |
cod-estabel | CHARACTER | X(5) | Estabelecimento | 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 Medição de Contrato de compra 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 (Medição contrato de compra) | ||
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 medição de contrato de compra, informar 14) | |
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-medicao-contrat-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-medicao-contrat-lista:
ttDados.cTable = “tt-medicao-contrat-lista” ttDados.iRow = 1 ttDados.cField = “nr-contrato” ttDados.cValue = “3456”
ttDados.cTable = “tt-medicao-contrat-lista” ttDados.iRow = 1 ttDados.cField = “numero-ordem” ttDados.cValue = “88888”
ttDados.cTable = “tt-medicao-contrat-lista” ttDados.iRow = 1 ttDados.cField = “valor” ttDados.cValue = “9999999” | ||
detalheDocumento | ||
Requisito | Detalhe de pendências do MLA do documento de Medição de Contrato de Compra | |
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 (Medição de Contrato de compra) | |
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-medicao-contrat, que são detalhadas na tabela mais a baixo.
Exemplo de registro que poderiam existir na tt-medicao-contrat:
ttDados.cTable = “tt-medicao-contrat” ttDados.iRow = 1 ttDados.cField = “nr-contrato” ttDados.cValue = “99999”
ttDados.cTable = “tt-medicao-contrat” ttDados.iRow = 1 ttDados.cField = “des-nr-contrato” ttDados.cValue = “Contrato xxxxx”
ttDados.cTable = “tt-medicao-contrat” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1” | |
tt-medicao-contrat | Entrada/ Saída | |||
Temp-table com dados da medição do contrato de compra para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
nr-contrato | INTEGER | >>>>>>>>9 | Contrato | Sim |
des-contrat | CHARACTER | X(32) | Descrição do contrato | Sim |
num-seq-item | INTEGER | >>,>>9 | Sequência do item | Sim |
numero-ordem | INTEGER | zzzzz9,99 | Ordem de compra | Sim |
num-seq-event | INTEGER | >,>>9 | Sequência do evento | Sim |
num-seq-medicao | INTEGER | >,>>9 | Sequência da medição | Sim |
cod-estabel | CHARACTER | X(5) | Estabelecimento | Sim |
desc-cod-estabel | CHARACTER | X(40) | Nome estabelecimento | Sim |
it-codigo | CHARACTER | X(16) | Item | Sim |
desc-it-codigo | CHARACTER | X(60) | Descrição do item | Sim |
dat-prev-medicao | DATE | 99/99/9999 | Data de previsão | Sim |
qtd-prevista | DECIMAL | ->>>>>,>>>,>>9.9999 | Quantidade prevista | Não |
un | CHARACTER | X(2) | Unidade de medida | Sim |
responsavel | CHARACTER | X(12) | Responsável | Não |
perc-medicao | DECIMAL | >>9.99 | Percentual de medição | Não |
ind-sit-medicao | INTEGER | 9 | Situação | Sim |
desc-ind-sit-medicao | CHARACTER | X(10) | Descrição da situação | Sim |
observacao | CHARACTER | X(2000) | Observação | Não |
| narrativa-item | CHARACTER | x(2000) | Narrativa do Item | Não |
| narrativa-it-cn | CHARACTER | x(2000) | Narrativa Item Contrato | Não |
valor-medicao | DECIMAL | >>>>>,>>>,>>9.99 | Valor da medição | Sim |
| valor-doc | DECIMAL | ->,>>>,>>>,>>>,>>9.99 | Total do Documento | Sim |
| Nota | ||
|---|---|---|
| ||
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