Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | laphtml/mlahtml019p.p |
Considerações Gerais
Objetivo
O objetivo desta API é fornecer dados sobre pendências do módulo do MLA para o documento pedido de compra emergencial (por item), estejam elas pendentes de aprovações, aprovadas ou reprovadas.
Funcionamento
A API fornece basicamente dois tipos de informações: listagem de documentos (neste caso pedidos de compra emergencial - por item) e/ou detalhe um documento (neste caso pedidos de compra emergencial - por item).
...
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 pedido de compra emergencial (por item) | ||
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 (pedidos de compra emergencial - por item) | ||
Parâmetros | Tipo | Descrição | |
iCodTipDoc | INTEGER | Código do tipo de documento (neste caso para pedidos de compra emergencial - por item, informar 19) | |
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-pedido-item-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-pedido-item-lista:
ttDados.cTable = “tt-pedido-item-lista” ttDados.iRow = 1 ttDados.cField = “num-pedido” ttDados.cValue = “3456”
ttDados.cTable = “tt-pedido-item-lista” ttDados.iRow = 1 ttDados.cField = “numero-ordem” ttDados.cValue = “99999”
ttDados.cTable = “tt-pedido-item-lista” ttDados.iRow = 1 ttDados.cField = “it-codigo” ttDados.cValue = “Item XXXX” |
...
tt-pedido-item-lista | Entrada/ Saída | ||||
Temp-table com dados pedidos de compra para serem apresentados na listagem | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | |
cod-estabel | CHARACTER | X(5) | Estabelecimento | Sim | |
num-pedido | INTEGER | >>>>>,>>9 | Número pedido | Sim | |
numero-ordem | INTEGER | zzzzz9,99 | Ordem de compra | Sim | |
it-codigo | CHARACTER | X(16) | Código do item | Sim | |
nr-contrato | INTEGER | >>>>>>>>9 | Número contrato | Não | |
nome-abrev | CHARACTER | X(12) | Nome abreviado do fornecedor | Sim | |
nome-emit | CHARACTER | X(80) | Nome fornecedor | Sim | |
data-pedido | DATE | 99/99/9999 | Data pedido | Sim | |
desc-natureza | CHARACTER | X(30) | Natureza | Sim | |
desc-cond-pagto | CHARACTER | X(30) | Descrição da condição de pagamento | Sim | |
responsavel | CHARACTER | X(12) | Responsável | Sim | |
cod-estab-gestor | CHARACTER | X(5) | Código do estabelecimento gestor | Sim | |
valor | DECIMAL | ->>,>>>,>>9.99 | Valor | 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 | |
Obs.: 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.
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 Pedido de compra emergencial – por item 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 (Pedido de compra emergencial – Item) | ||
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 pedido de compra emergencial por item, informar 19) | |
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-pedido-item-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-pedido-item-lista:
ttDados.cTable = “tt-pedido-item-lista” ttDados.iRow = 1 ttDados.cField = “num-pedido” ttDados.cValue = “3456”
ttDados.cTable = “tt-pedido-item-lista” ttDados.iRow = 1 ttDados.cField = “numero-ordem” ttDados.cValue = “99999”
ttDados.cTable = “tt-pedido-item-lista” ttDados.iRow = 1 ttDados.cField = “it-codigo” ttDados.cValue = “Item XXXX” |
detalheDocumento | ||
Requisito | Detalhe de pendências do MLA do documento de Pedidos de compra emergencial (por item) | |
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 (Pedidos de compra emergencial - por item) | |
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-pedido, tt-cond-especif, tt-ordem-compra, tt-prazo-compra, tt-cotacao-item, tt-alt-ped, tt-ultima-comrpa e tt-it-requisicao, que são detalhadas na tabela mais a baixo.
Exemplo de registro que poderiam existir na tt-pedido:
ttDados.cTable = “tt-pedido” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-pedido” ttDados.iRow = 1 ttDados.cField = “num-pedido” ttDados.cValue = “99999”
ttDados.cTable = “tt-pedido” ttDados.iRow = 1 ttDados.cField = “desc-natureza” ttDados.cValue = “Compra” |
...
tt-it-requisicao | Entrada/ Saída | |||
Temp-table com dados dos itens de solicitação referente a ordem de compra, para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
numero-ordem | INTEGER | zzzzz9,99 | Número da ordem | Sim |
nr-requisicao | INTEGER | >>>,>>>,>>9 | Requisição | Sim |
sequencia | INTEGER | >>9 | Sequência | Sim |
it-codigo | CHARACTER | X(16) | Item | Sim |
desc-it-codigo | CHARACTER | X(60) | Descrição do item | Sim |
cod-depos | CHARACTER | X(3) | Depósito | Sim |
cod-estabel | CHARACTER | X(5) | Estabelecimento | Sim |
cod-localiz | CHARACTER | X(20) | Localização | Sim |
cod-refer | CHARACTER | X(8) | Referência | Sim |
dt-atend | DATE | 99/99/9999 | Data atendimento | Sim |
dt-entrega | DATE | 99/99/9999 | Data entrega | Sim |
qt-requisitada | DECIMAL | >>>,>>>,>>9.9999 | Quantidade requisitada | Sim |
ct-codigo | CHARACTER | X(20) | Conta | Não |
desc-ct-codigo | CHARACTER | X(40) | Descrição da conta | Não |
sc-codigo | CHARACTER | X(20) | Sub-conta | Não |
desc-sc-codigo | CHARACTER | X(40) | Descrição sub-conta | Não |
situacao | INTEGER | >9 | Situação | Sim |
desc-situacao | CHARACTER | X(10) | Descrição da situação | Sim |
narrativa | CHARACTER | X(2000) | Narrativa | Não |
...
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. |