Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Susan Marjorie Alves

Gravado em

comparado com

Nova versão 103

changes.mady.by.user Eder Valmir Holz

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

...

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicolaphtml/mlahtml013p.p

 

Considerações Gerais

 

Objetivo

 

O objetivo desta API é fornecer dados sobre pendências do módulo do MLA para o documento 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 contratos de compras) e/ou detalhe um documento (neste caso contratos de compra).

...

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  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 (contratos de compra)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

Código do tipo de documento (neste caso para contratos de compra, informar 13)

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-contrato-lista, que é detalhada na tabela mais abaixo.

 

Exemplo de registro que poderiam existir na tt-contrato-lista:

 

ttDados.cTable = “tt-contrato-lista”

ttDados.iRow = 1

ttDados.cField = “nr-contrato”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-contrato-lista”

ttDados.iRow = 1

ttDados.cField = “des-contrat”

ttDados.cValue = “Contrato xxxxxx”

 

ttDados.cTable = “tt-contrato-lista”

ttDados.iRow = 1

ttDados.cField = “valor”

ttDados.cValue = “9999999”

...

tt-contrato-lista

Entrada/

Saída

Temp-table com dados do contrato de compra para serem apresentados na listagem

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

dt-contrato

DATE

99/99/9999

Data do contrato

Sim

valor

DECIMAL

->>,>>>,>>9.99

Valor

Sim

cod-estabel

CHARACTER

X(5)

Estabelecimento

Sim

cod-cond-pag

INTEGER

>>>9

Condição Pagamento

Sim

desc-cod-cond-pag

CHARACTER

X(30)

Descrição Condição pagamento

Sim

dt-ini-validade

DATE

99/99/9999

Data Início Validade

Sim

dt-ter-validade

DATE

99/99/9999

Data Término

Sim

limite-valor

DECIMAL

->>>,>>>,>>>,>>9.9999

Limite Valor

Sim

limite-quantidade

DECIMAL

->>>,>>>,>>>,>>9.9999

Limite Quantidade

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

mestreLOGICALYES/NOIndica que é uma pendência como mestreSim

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-codigoCHARACTERX(3)Código da empresaSim
mla-cod-estabelCHARACTERX(5)Código do estabelecimentoSim
mla-desc-ep-codigoCHARACTERX(70)Nome da empresaSim
mla-desc-cod-estabelCHARACTERX(40)Nome do estabelecimentoSim
      

 

...

mla-nome-usuarCHARACTERX(40)Nome do aprovadorSim
Nota
titleNota:

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 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 (Contrato de compra)

Parâmetros

Tipo

Descrição

cEpCodigoCHARACTERCódigo da empresa (Se passar em branco considera todas)
cCodEstabelCHARACTERCódigo do estabelecimento (Se passar em branco considera todos)

iCodTipDoc

INTEGER

Código do tipo de documento (neste caso para contrato de compra, informar 13)

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-contrato-lista, que é detalhada na tabela mais abaixo.

 

Exemplo de registro que poderiam existir na tt-contrato-lista:

 

ttDados.cTable = “tt-contrato-lista”

ttDados.iRow = 1

ttDados.cField = “nr-contrato”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-contrato-lista”

ttDados.iRow = 1

ttDados.cField = “des-contrat”

ttDados.cValue = “Contrato xxxxxx”

 

ttDados.cTable = “tt-contrato-lista”

ttDados.iRow = 1

ttDados.cField = “valor”

ttDados.cValue = “9999999”

detalheDocumento

Requisito

Detalhe de pendências do MLA do documento 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 (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-contrato, tt-item-contrat, tt-anexo e tt-clausula, que são detalhadas na tabela mais a baixo.

 

Exemplo de registro que poderiam existir na tt-contrato:

 

ttDados.cTable = “tt-contrato”

ttDados.iRow = 1

ttDados.cField = “nr-contrato”

ttDados.cValue = “99999”

 

ttDados.cTable = “tt-contrato”

ttDados.iRow = 1

ttDados.cField = “des-contrat”

ttDados.cValue = “Contrato xxxxx”

 

ttDados.cTable = “tt-contrato”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

...

tt-clausula

Entrada/

Saída

Temp-table com dados das cláusulas do contrato para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

nr-contrato

INTEGER

>>>>>>>>9

Contrato

Sim

num-seq-clausula

INTEGER

99

Número da sequência

Sim

des-clausula

CHARACTER

X(32)

Descrição

Não

narrat-clausula

CHARACTER

X(15000)

Narrativa

Não

Nota

...

title

...

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.