Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicolaphtml/mlahtml010p.p

 

Considerações Gerais

 

Objetivo

 

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

 

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

 

run laphtml/mlahtml010p.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 Processo 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 (Processo de compra – por total)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

Código do tipo de documento (neste caso para processo de compra – por total , informar 10)

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

 

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

 

ttDados.cTable = “tt-processo-lista”

ttDados.iRow = 1

ttDados.cField = “nr-processo”

ttDados.cValue = “9999”

 

ttDados.cTable = “tt-processo-lista”

ttDados.iRow = 1

ttDados.cField = “descricao”

ttDados.cValue = “Processo XXX”

 

ttDados.cTable = “tt-processo-lista”

ttDados.iRow = 1

ttDados.cField = “cod-comprado”

ttDados.cValue = “xxxxxxxx

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-processo-lista

Entrada/

Saída

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

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

nr-processo

INTEGER

999,999

Processo

Sim

descricao

CHARACTER

X(40)

Descrição do processo

Sim

cod-comprado

CHARACTER

X(12)

Comprador

Sim

dt-inicio

DATE

99/99/9999

Data de início

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 Processo 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 (Processo 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 processo de compra por total, informar 10)

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

 

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

 

ttDados.cTable = “tt-processo-lista”

ttDados.iRow = 1

ttDados.cField = “nr-processo”

ttDados.cValue = “9999”

 

ttDados.cTable = “tt-processo-lista”

ttDados.iRow = 1

ttDados.cField = “descricao”

ttDados.cValue = “Processo XXX”

 

ttDados.cTable = “tt-processo-lista”

ttDados.iRow = 1

ttDados.cField = “cod-comprado”

ttDados.cValue = “xxxxxxxx

detalheDocumento

Requisito

Detalhe de pendências do MLA do documento de Processo 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 (Processo 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-processo, tt-ordem-proc e tt-mapa-comparativo, que são detalhadas na tabela mais a baixo.

 

Exemplo de registro que poderiam existir na tt-processo:

 

ttDados.cTable = “tt-processo”

ttDados.iRow = 1

ttDados.cField = “nr-processo”

ttDados.cValue = “999”

 

ttDados.cTable = “tt-processo”

ttDados.iRow = 1

ttDados.cField = “descricao”

ttDados.cValue = “Processo xxxx”

 

ttDados.cTable = “tt-processo”

ttDados.iRow = 1

ttDados.cField = “cod-comprado”

ttDados.cValue = “xxxxx”

tt-processo

Entrada/

Saída

Temp-table com dados do processo de compra para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

nr-processo

INTEGER

999,999

Processo

Sim

descricao

CHARACTER

X(40)

Descrição do processo

Sim

cod-comprado

CHARACTER

X(12)

Comprador

Sim

dt-inicio

DATE

99/99/9999

Data de início

Sim

valor

DECIMAL

->>,>>>,>>9.99

Valor

Sim

cod-estabel

CHARACTER

X(5)

Estabelecimento

Sim

desc-cod-estabel

CHARACTER

X(40)

Nome estabelecimento

Sim

valor-aprovado

DECIMAL

>>>>>,>>>,>>9.99999

Valor aprovado

Sim

valor-a-aprovar

DECIMAL

>>>>>,>>>,>>9.99999

Valor a aprovar

Sim

valor-total

DECIMAL

>>>>>,>>>,>>9.99999

Valor total

Sim

tt-ordem-proc

Entrada/

Saída

Temp-table com dados das ordens de compra do processo para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

numero-ordem

INTEGER

zzzzz9,99

Ordem de compra

Sim

it-codigo

CHARACTER

X(16)

Item

Sim

desc-it-codigo

CHARACTER

X(60)

Descrição do item

Sim

un

CHARACTER

X(2)

Unidade Medida

Sim

qt-solic

DECIMAL

>>>,>>>,>>9.9999

Quantidade solicitada

Sim

aprovada

LOGICAL

YES/NO

Indica se a ordem está aprovada

Sim

tt-mapa-comparativo

Entrada/

Saída

Temp-table com dados das cotações para as ordens do pacote e dados da última compra para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

numero-ordem

INTEGER

zzzzz9,99

Ordem de compra

Sim

data-cotacao

DATE

99/99/9999

Data cotação

Sim

cod-emitente

INTEGER

>>>>>>>>9

Código fornecedor

Sim

nome-abrev

CHARACTER

X(12)

Nome abreviado do fornecedor

Sim

nome-emit

CHARACTER

X(80)

Nome fornecedor

Sim

cidade-estado

CHARACTER

X(40)

Cidade/estado

Sim

nome-contato

CHARACTER

X(40)

Nome contato

Sim

fone-contato

CHARACTER

X(15)

Telefone contato

Sim

ramal-contato

CHARACTER

X(5)

Ramal contato

Sim

qt-solic

DECIMAL

>>>,>>>,>>9.9999

Quantidade solicitada

Sim

pre-unit-for

DECIMAL

>>>>>,>>>,>>9.99999

Preço Unitário Fornecedor

Sim

preco-total

DECIMAL

>>>>>,>>>,>>9.99999

Preço total sem IPI

Sim

aliquota-ipi

DECIMAL

>>9.99

Alíquota API

Sim

valor-ipi

DECIMAL

>>>>>,>>>,>>9.99999

Valor IPI

Sim

preco-total-ipi

DECIMAL

>>>>>,>>>,>>9.99999

Preço total com IPI

Sim

perc-descto

DECIMAL

>9.99999

Percentual desconto

Sim

valor-descto

DECIMAL

>>>,>>>,>>9.9999

Valor do desconto

Não

nr-dias-taxa

INTEGER

>>9

Dias Taxa Financeira

Sim

valor-taxa

DECIMAL

>>9.9999

Taxa Financeira

Sim

preco-total-calc

DECIMAL

>>>>>,>>>,>>9.99999

Preço total

Sim

preco-medio

DECIMAL

>>>>>,>>>,>>9.99999

Preço médio

Sim

prazo-entreg

INTEGER

>,>>9

Prazo Entrega

Sim

cod-cond-pag

INTEGER

>>>9

Condição de pagamento

Sim

desc-cod-cond-pag

CHARACTER

X(30)

Descrição da condição de pagamento

Sim

narrativa

CHARACTER

X(2000)

Narrativa da cotação

Sim

c-aprovada

CHARACTER

X(2000)

Narrativa da cotação aprovada

Sim

un

CHARACTER

X(2)

Unidade medida

Sim

desc-un

CHARACTER

X(15)

Descrição Unidade medida

Sim

aprovada

LOGICAL

YES/NO

Indica se a cotação está aprovada

Sim

ult-compra

LOGICAL

YES/NO

Indica que são informações da última compra

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.