Histórico da Página
Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | laphtml/mlahtml021p.p |
Considerações Gerais
Objetivo
O objetivo desta API é fornecer dados sobre pendências do módulo do MLA para o documento Aprovação de Crédito, estejam elas pendentes de aprovações, aprovadas ou reprovadas.
Funcionamento
A API fornece basicamente dois tipos de informações: listagem de documentos (neste caso Aprovação de Crédito) e/ou detalhe um documento (neste caso Aprovação de Crédito).
A sintaxe para a chamada da API, que deve ser de forma persistente:
run laphtml/mlahtml021p.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 Aprovação de Crédito | ||
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 (Aprovação de Crédito) | ||
Parâmetros | Tipo | Descrição | |
iCodTipDoc | INTEGER | Código do tipo de documento (neste caso para solicitação de compra por item, informar 1) | |
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-ped-venda-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-ped-venda-lista:
ttDados.cTable = “tt-ped-venda-lista” ttDados.iRow = 1 ttDados.cField = “nr-pedido” ttDados.cValue = “3456”
ttDados.cTable = “tt-ped-venda-lista” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-ped-venda-lista” ttDados.iRow = 1 ttDados.cField = “nome” ttDados.cValue = “Avaliação de Crédito” |
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-evento-ped-lista | Entrada/ Saída | |||
Temp-table com dados do evento do contrato de compra para serem apresentados na listagem | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
numero-ordem | INTEGER | zzzzz9,99 | Ordem de compra | Sim |
nr-contrato | INTEGER | >>>>>>>>9 | Contrato | Sim |
seq-event | INTEGER | >>>9 | Sequência | Sim |
dt-evento | DATE | 99/99/9999 | Data do evento | 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 |
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 Aprovação de Crédito 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 (Aprovação de Crédito) | ||
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 Aprovação de crédito, informar 21) | |
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-ped-venda-lista, que é detalhada na tabela mais abaixo.
Exemplo de registro que poderiam existir na tt-ped-venda-lista:
ttDados.cTable = “tt-ped-venda-lista” ttDados.iRow = 1 ttDados.cField = “nr-pedido” ttDados.cValue = “3456”
ttDados.cTable = “tt-ped-venda-lista” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-ped-venda-lista” ttDados.iRow = 1 ttDados.cField = “nome” ttDados.cValue = “Avaliação de Crédito” |
detalheDocumento | ||
Requisito | Detalhe de pendências do MLA do documento de Aprovação de Crédito | |
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 (Aprovação de Crédito) | |
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-valores2, tt-ped-venda, tt-emitente, tt-ped-item que são detalhadas na tabela mais a baixo.
Exemplo de registro que poderiam existir na tt-ped-venda:
ttDados.cTable = “tt-ped-venda” ttDados.iRow = 1 ttDados.cField = “nr-pedido” ttDados.cValue = “3456”
ttDados.cTable = “tt-ped-venda” ttDados.iRow = 1 ttDados.cField = “cod-estabel” ttDados.cValue = “EST1”
ttDados.cTable = “tt-ped-venda” ttDados.iRow = 1 ttDados.cField = “nome” ttDados.cValue = “Avaliação de Crédito” |
tt-valores2 | Entrada/ Saída | |||
Temp-table com dados da Situação Geral da Aprovação de Crédito para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
tt-de-lim-credito | DECIMAL | X(5) | Limite de Crédito | Sim |
tt-d-moeda | CHARACTER | X(10) | Moeda | Sim |
tt-i-totpdre | INTEGER | (9999) | Total de Pedidos Recusados | Sim |
tt-i-totpdap | INTEGER | (9999) | Total de Pedidos Aprovados | Sim |
tt-de-totvlap-vw | DECIMAL | zz,zzz,zzz,zz9.99 |
| Sim |
tt-de-totvlaa-vw | DECIMAL | zz,zzz,zzz,zz9.99 |
| Sim |
tt-i-totpdaa | INTEGER | (9999) | Total de Pedidos a Aprovar | Sim |
tt-de-totvlre-vw | DECIMAL | zz,zzz,zzz,zz9.99 | Total de Pedidos Recusados | Sim |
tt-de-vl-nota-vw | DECIMAL | -zz,zzz,zzz,zz9.99 | NF’s não atual do CR | Sim |
tt-i-totpdcr | INTEGER | (9999) | NF’s não atual do CR | Sim |
tt-de-saldo-cr-vw | DECIMAL | -zz,zzz,zzz,zz9.99 | Saldo Devedor CR/VI MP | Sim |
tt-p5-vl-cr-abe | DECIMAL | -zz,zzz,zzz,zz9.99 | Saldo Devedor CR/VI MP | Sim |
tt-de-saldo-ap-vw | DECIMAL | -zz,zzz,zzz,zz9.99 | Saldo Credor AP/VI MP | Sim |
tt-de-saldo-vw | DECIMAL | -zz,zzz,zzz,zz9.99 | Saldo Atual | Sim |
tt-emitente | Entrada/ Saída | |||
Temp-table com dados do emitente para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
cod-emitente | INTEGER | >>>>>>>>9 | Emitente | Sim |
nome-abrev | CHARACTER | X(40) | Nome | Sim |
nome-repres | CHARACTER | X(40) | Nome Representante | Sim |
endereco | CHARACTER | X(40) | Endereço | Sim |
bairro | CHARACTER | X(30) | Bairro | Sim |
cidade | CHARACTER | X(25) | Cidade | Sim |
estado | CHARACTER | X(04) | Estado | Sim |
cep | CHARACTER | X(12) | CEP | Sim |
endereco-cob | CHARACTER | X(40) | Endereço de Cobrança | Sim |
bairro-cob | CHARACTER | X(30) | Bairro de Cobrança | Sim |
cidade-cob | CHARACTER | X(25) | Cidade de Cobrança | Sim |
estado-cob | CHARACTER | X(04) | Estado de Cobrança | Sim |
cep-cob | CHARACTER | X(12) | CEP | Sim |
cgc-cob | CHARACTER | X(19) | CGC | Sim |
Ins-est-cob | CHARACTER | X(19) | Inscrição Estadual de Cobrança | Sim |
telefone | CHARACTER | X(15) | Telefone | Sim |
lim-credito | DECIMAL | >>>,>>>,>>9.99 | Limite de Crédito | Sim |
dt-lim-cred | DATE | 99/99/9999 | Data Limite de Crédito | 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. |
tt-ped-venda | Entrada/ Saída | |||
Temp-table com dados Gerais da Aprovação de Crédito para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
cod-estabel | CHARACTER | X(5) | Estabelecimento | Sim |
nome | CHARACTER | X(40) | Nome | Sim |
nr-pedido | INTEGER | >>>,>>>,>>9 | Número do Pedido | Sim |
dt-emissao | DATE | 99/99/9999 | Data de Emissão | Sim |
cod-canal-venda | INTEGER | >>9 | Canal de Venda | Sim |
desc-canal | CHARACTER | X(30) | Descrição Canal de Venda | Sim |
mo-codigo | INTEGER | >9 | Moeda | Sim |
desc-moeda | CHARACTER | X(12) | Descrição da Moeda | Sim |
cod-cond-pag | INTEGER | >>>9 | Condição de Pagamento | Sim |
desc-pagto | CHARACTER | X(30) | Descrição da Condição de Pagamento | Sim |
nr-tabpre | CHARACTER | X(08) | Tabela de Preço | Sim |
nr-tab-finan | INTEGER | >>9 | Tabela de Financiamento | Sim |
nr-ind-finan | INTEGER | >9 | Índice de Financiamento | Sim |
perc-desco1 | DECIMAL | ->9.999 | Desconto Cliente | Sim |
perc-desco2 | DECIMAL | ->9.999 | Desconto Totais | Sim |
vl-tot-ped | DECIMAL | >,>>>,>>>,>>9.99 | Valor Total do Pedido | Sim |
vl-liq-ped | DECIMAL | >,>>>,>>>,>>9.99 | Valor Líquido do Pedido | Sim |
vl-liq-abe | DECIMAL | >,>>>,>>>,>>9.99 | Valor Total Aberto | Sim |
nr-pedrep | CHARACTER | X(12) | Pedido Representante | Sim |
dt-emissao | DATE | 99/99/9999 | Data de Emissão | Sim |
dt-entrega | DATE | 99/99/9999 | Data de Entrega | Sim |
quem-aprovou | CHARACTER | X(12) | Arprovador Crédito | Sim |
cod-sit-aval | INTEGER | 99 | Situação Avaliação Crédito | Sim |
desc-sit-aval | CHARACTER | X(32) | Situação da Avaliação | Sim |
dt-apr-cred | DATE | 99/99/9999 | Data Aprovação de Crédito | Sim |
desc-bloq-cr | CHARACTER | X(76) | Motivo Bloqueio Crédito | Sim |
desc-forc-cr | CHARACTER | X(76) | Motivo Liberação Forçada | Sim |
tt-ped-item | Entrada/ Saída | |||
Temp-table com dados dos itens do pedido da Aprovação de Crédito para serem apresentados no detalhamento do documento | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
nr-sequencia | INTEGER | >>,>>9 | Sequencia do Item | Sim |
It-codigo | CHARACTER | X(16) | Código do Item | Sim |
descrição-1 | CHARACTER | X(18) | Descrição do Item | Sim |
cod-refer | CHARACTER | X(08) | Referencia do Item | Sim |
qt-pedida | DECIMAL | >>>>,>>9.9999 | Quantidade Pedida | Sim |
vl-liq-abe | DECIMAL | >>>>,>>>,>>9.99 | Valor Total Aberto | Sim |
un | CHARACTER | xx | Unidade de Medida | Sim |