Árvore de páginas

Versões comparadas

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/mlahtml007p.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 (por total), 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 - por total) e/ou detalhe um documento (neste caso pedidos de compra - por total).

...

listagemDocumentos

Requisito

Listagem de pendências do MLA (em várias situações) do documento de  pedido de compra (por total)

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 - por total)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

Código do tipo de documento (neste caso para  pedidos de compra - por total, informar 7)

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

 

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

 

ttDados.cTable = “tt-pedido-lista”

ttDados.iRow = 1

ttDados.cField = “num-pedido”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-pedido-lista”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

 

ttDados.cTable = “tt-pedido-lista”

ttDados.iRow = 1

ttDados.cField = “valor”

ttDados.cValue = “9999999”

...

tt-pedido-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

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

mestreLOGICALYES/NOIndica que é uma pendência como mestreSim

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-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 Pedido de compra – por total 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 – total)

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 pedido de compra por total, informar 7)

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

 

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

 

ttDados.cTable = “tt-pedido-lista”

ttDados.iRow = 1

ttDados.cField = “num-pedido”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-pedido-lista”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

 

ttDados.cTable = “tt-pedido-lista”

ttDados.iRow = 1

ttDados.cField = “valor”

ttDados.cValue = “9999999”

 

 

detalheDocumento

Requisito

Detalhe de pendências do MLA do documento de Pedidos de compra (por total)

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 - por total)

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 as ordens de compra do pedido, 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

...

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.