Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicolaphtml/mlahtml016p.p

 

Considerações Gerais

 

Objetivo

 

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

 

A sintaxe para a chamada da API, que deve ser de forma persistente:

 

run laphtml/mlahtml016p.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.

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 evento 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 (eventos de contrato de compra)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

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

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

 

Exemplo de registro que poderiam existir na tt-evento-ped-lista:

 

ttDados.cTable = “tt-evento-ped-lista”

ttDados.iRow = 1

ttDados.cField = “nr-contrato”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-evento-ped-lista”

ttDados.iRow = 1

ttDados.cField = “numero-ordem”

ttDados.cValue = “88888”

 

ttDados.cTable = “tt-evento-ped-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-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

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:

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 Evento 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 (Evento de 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 evento de contrato de compra, informar 16)

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

 

Exemplo de registro que poderiam existir na tt-evento-ped-lista:

 

ttDados.cTable = “tt-evento-ped-lista”

ttDados.iRow = 1

ttDados.cField = “nr-contrato”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-evento-ped-lista”

ttDados.iRow = 1

ttDados.cField = “numero-ordem”

ttDados.cValue = “88888”

 

ttDados.cTable = “tt-evento-ped-lista”

ttDados.iRow = 1

ttDados.cField = “valor”

ttDados.cValue = “9999999”

detalheDocumento

Requisito

Detalhe de pendências do MLA do documento de Evento 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 (Evento 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-evento-ped, que são detalhadas na tabela mais a baixo.

 

Exemplo de registro que poderiam existir na tt-evento-ped:

 

ttDados.cTable = “tt-evento-ped”

ttDados.iRow = 1

ttDados.cField = “nr-contrato”

ttDados.cValue = “99999”

 

ttDados.cTable = “tt-evento-ped”

ttDados.iRow = 1

ttDados.cField = “des-nr-contrato”

ttDados.cValue = “Contrato xxxxx”

 

ttDados.cTable = “tt-evento-ped”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

tt-evento-ped

Entrada/

Saída

Temp-table com dados do evento 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-nr-contrato

CHARACTER

X(32)

Descrição do contrato

Sim

numero-ordem

INTEGER

zzzzz9,99

Ordem de compra

Sim

seq-evento

INTEGER

>>>9

Sequência

Sim

cod-estabel

CHARACTER

X(5)

Estabelecimento

Sim

desc-cod-estabel

CHARACTER

X(40)

Nome estabelecimento

Sim

num-seq-item

INTEGER

>>,>>9

Sequência do item

Sim

it-codigo

CHARACTER

X(16)

Item

Sim

desc-it-codigo

CHARACTER

X(60)

Descrição do item

Sim

cod-comprado

CHARACTER

X(12)

Comprador

Sim

ind-sit-event

INTEGER

9

Situação

Sim

desc-ind-sit-event

CHARACTER

X(10)

Descrição da situação

Sim

dt-evento

DATE

99/99/9999

Data do evento

Sim

dat-realiz

DATE

99/99/9999

Data da realização

Sim

dat-prev-event

DATE

99/99/9999

Data de previsão

Sim

perc-lib-previst

DECIMAL

>>9.99

Percentual de liberação prevista

Não

dat-nova-realiz

DATE

99/99/9999

Data da nova realização

Sim

cod-cond-pag

INTEGER

>>>9

Condição de pagamento

Sim

desc-cod-cond-pag

CHARACTER

X(30)

Descrição condição de pagamento

Sim

cod-tipo-contr

INTEGER

99

Tipo contrato

Sim

desc-cod-tipo-contr

CHARACTER

X(76)

Descrição do tipo de contrato

Sim

dat-prev-entr

DATE

99/99/9999

Data prevista de entrega

Sim

log-liber-autom

LOGICAL

YES/NO

Liberação automática

Não

valor-evento

DECIMAL

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

Valor do evento

Sim

qtd-prevista

DECIMAL

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

Quantidade prevista

Sim

observacao

CHARACTER

X(2000)

Observação

Não

narrativa

CHARACTER

X(15000)

Narrativa

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.