Documento de API

Ocorrência:

Documentação de API

run laphtml/mlahtml008p.p persistent set h-handle.

listagemDocumentos

Requisito

Listagem de pendências do MLA (em várias situações) do documento de  pedido de compra emergencial (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 emergencial - por total)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

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

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”

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

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

listagemDocumentosEmpresaEstab

Requisito

Listagem de pendências do MLA (em várias situações) do documento de Pedido de compra emergencial – 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 emergencial – total)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

Código do tipo de documento (neste caso para pedido de compra emergencial por total, informar 8)

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 emergencial (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 emergencial - 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-pedido

Entrada/

Saída

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

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

num-pedido

INTEGER

>>>>>,>>9

Número pedido

Sim

cod-estabel

CHARACTER

X(5)

Estabelecimento

Sim

desc-cod-estabel

CHARACTER

X(40)

Nome estabelecimento

Sim

cod-emitente

INTEGER

>>>>>>>>9

Código do fornecedor

Sim

desc-cod-emitente

CHARACTER

X(12)

Nome abreviado do fornecedor

Sim

razao-social

CHARACTER

X(80)

Razão social do fornecedor

Sim

natureza

INTEGER

>9

Natureza

Sim

desc-natureza

CHARACTER

X(15)

Descrição da natureza

Sim

data-pedido

DATE

99/99/9999

Data pedido

Sim

frete

INTEGER

>9

Frete

Sim

desc-frete

CHARACTER

X(8)

Descrição do frete

Sim

responsavel

CHARACTER

X(12)

Responsável

Sim

desc-responsavel

CHARACTER

X(40)

Nome usuário

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-trans

INTEGER

>>,>>9

Transportador

Sim

via-trans

INTEGER

9

Via transporte

Sim

desc-via-trans

CHARACTER

X(16)

Descrição via de transporte

Sim

comentarios

CHARACTER

X(2000)

Comentários

Sim

total-pedido

DECIMAL

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

Total do pedido

Sim

tt-ordem-compra

Entrada/

Saída

Temp-table com dados das 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

num-pedido

INTEGER

>>>>>,>>9

Número pedido

Sim

it-codigo

CHARACTER

X(16)

Item

Sim

desc-it-codigo

CHARACTER

X(60)

Descrição do item

Sim

cod-estabel

CHARACTER

X(5)

Estabelecimento

Sim

desc-cod-estabel

CHARACTER

X(40)

Nome estabelecimento

Sim

data-emissao

DATE

99/99/9999

Data emissão

Sim

situacao

INTEGER

>9

Situação

Sim

desc-situacao

CHARACTER

X(15)

Descrição da Situação

Sim

natureza

INTEGER

>9

Natureza

Sim

desc-natureza

CHARACTER

X(15)

Descrição da Natureza

Sim

origem

INTEGER

>9

Origem

Sim

desc-origem

CHARACTER

X(15)

Descrição da Origem

Sim

tp-despesa

INTEGER

>>9

Tipo de despesa

Não

desc-tp-despesa

CHARACTER

X(30)

Descrição do tipo de despesa

Não

centro-custo

CHARACTER

X(20)

Centro de Centro

Não

ct-codigo

CHARACTER

X(20)

Conta

Sim

desc-ct-codigo

CHARACTER

X(40)

Descrição da conta

Sim

sc-codigo

CHARACTER

X(20)

Sub-conta

Sim

desc-sc-codigo

CHARACTER

X(40)

Descrição sub-conta

Sim

data-entrega

DATE

99/99/9999

Data entrega

Sim

quant-saldo

DECIMAL

>>>,>>>,>>9.9999

Quantidade saldo

Sim

qt-solic

DECIMAL

>>>,>>>,>>9.9999

Quantidade solicitada

Sim

pre-unti-for

DECIMAL

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

Preço unitário fornecedor

Sim

preco-unit

DECIMAL

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

Preço unitário

Sim

un

CHARACTER

X(2)

Unidade Medida

Sim

aliquota-ipi

DECIMAL

>>9.99

Alíquota API

Sim

aliquota-icm

DECIMAL

>>9.99

Alíquota ICM

Sim

prazo-entreg

INTEGER

>,>>9

Prazo Entrega

Sim

data-cotacao

DATE

99/99/9999

Data cotação

Sim

requisitante

CHARACTER

X(12)

Requisitante

Sim

desc-requisitante

CHARACTER

X(40)

Nome requisitante

Sim

valor-taxa

DECIMAL

>>9.9999

Taxa Financeira

Sim

nr-dias-taxa

INTEGER

>>9

Dias Taxa Financeira

Sim

perc-descto

DECIMAL

>9.99999

Percentual desconto

Sim

valor-descto

DECIMAL

>>>,>>>,>>9.9999

Valor do desconto

Não

narrativa

CHARACTER

X(2000)

Narrativa da ordem

Sim

nr-contrato

INTEGER

>>>>>>>>9

Número contrato

Não

num-seq-item

INTEGER

>>,>>9

Sequência Item contrato

Não

int-tipo-control

INTEGER

>9

Tipo de controle do contrato

Não

desc-int-tipo-control

CHARACTER

X(12)

Descrição do tipo de controle do contrato

Não

sit-ordem-contrat

INTEGER

>9

Situação da ordem no contrato

Não

desc-sit-ordem-contrat

CHARACTER

X(12)

Descrição da situação da ordem no contrato

Não

nr-alt-preco

INTEGER

>9

Número de alterações de preço

Sim

cod-comprado

CHARACTER

X(12)

Comprador

Sim

desc-cod-comprado

CHARACTER

X(40)

Nome do comprador

Sim

data-movto

DATE

99/99/9999

Data Movimento

Não

numero-nota

CHARACTER

X(16)

Número da nota

Não

ordem-servic

INTEGER

>>>,>>>,>>9

Ordem Serviço

Sim

op-codigo

INTEGER

>>>>9

Operação

Sim

dep-almoxar

CHARACTER

X(3)

Depósito

Sim

desc-dep-almoxar

CHARACTER

X(40)

Descrição do Depósito

Sim

num-ord-inv

INTEGER

>>>,>>>,>>9

Ordem investimento

Não

expectativa

LOGICAL

YES/NO

Expectativa de compra

Não

tt-cond-especif

Entrada/

Saída

Temp-table com dados de condições específicas de pagamento do pedido para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

sequencia

INTEGER

>9

Sequência

Sim

data-pagto

DATE

99/99/9999

Data pagamento

Sim

perc-pagto

DECIMAL

->>.999

Percentual de pagamento

Sim

comentarios

CHARACTER

X(500)

Comentários

Sim

tt-prazo-compra

Entrada/

Saída

Temp-table com dados de entregas das 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

parcela

INTEGER

>>>>9

Parcela

Sim

un

CHARACTER

X(2)

Unidade Medida

Sim

data-entrega

DATE

99/99/9999

Data Entrega

Sim

quantidade

DECIMAL

>>>>,>>9.9999

Quantidade

Sim

quant-saldo

DECIMAL

->>>>,>>9.9999

Quantidade Saldo

Sim

quant-receb

DECIMAL

>>>>,>>9.9999

Quantidade Recebida

Sim

quant-rejeit

DECIMAL

>>>>,>>9.9999

Quantidade Rejeitada

Sim

tt-alt-ped

Entrada/

Saída

Temp-table com dados de alteração do pedido para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

num-pedido

INTEGER

>>>>>,>>9

Número pedido

Sim

numero-ordem

INTEGER

zzzzz9,99

Número da ordem

Sim

quantidade

CHARACTER

X(15)

Quantidade

Não

data-entrega

CHARACTER

X(10)

Data Entrega

Não

cod-cond-pag

CHARACTER

X(4)

Condição de pagamento

Não

preco

CHARACTER

X(20)

Preço

Não

data

DATE

99/99/9999

Data da alteração

Não

hora

CHARACTER

X(8)

Hora da alteração

Não

usuario

CHARACTER

X(12)

Usuário

Não

parcela

INTEGER

>>>>9

Parcela

Não

observacao

CHARACTER

X(76)

Observação

Não

qtd-sal-forn

CHARACTER

X(15)

Nova Quantidade

Não

pre-unit-forn

CHARACTER

X(20)

Novo Preço

Não

data-entrega2

CHARACTER

X(10)

Nova data Entrega

Não

cod-cond-pag2

CHARACTER

X(4)

Nova condição de pagamento

Não

comentarios

CHARACTER

X(2000)

Comentários

Não

tt-cotacao-item

Entrada/

Saída

Temp-table com dados das cotações para as ordens do pedido, 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

cod-emitente

INTEGER

>>>>>>>>9

Código fornecedor

Sim

desc-cod-emitente

CHARACTER

X(12)

Nome abreviado do fornecedor

Sim

data-cotacao

DATE

99/99/9999

Data cotação

Sim

prazo-entreg

INTEGER

>,>>9

Prazo Entrega

Sim

un

CHARACTER

X(2)

Unidade medida

Sim

mo-codigo

INTEGER

>9

Moeda

Sim

preco-fornec

DECIMAL

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

Preço fornecedor

Sim

pre-unit-for

DECIMAL

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

Preço Unitário Fornecedor

Sim

aliquota-ipi

DECIMAL

>>9.99

Alíquota API

Sim

codigo-ipi

LOGICAL

YES/NO

IPI Incluso

Sim

aliquota-icm

DECIMAL

>>9.99

Alíquota ICMS

Sim

contato

CHARACTER

X(40)

Contato

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

cod-comprado

CHARACTER

X(12)

Comprador

Sim

desc-cod-comprado

CHARACTER

X(40)

Nome do comprador

Sim

cod-transp

INTEGER

>>,>>9

Transportador

Sim

desc-cod-transp

CHARACTER

X(12)

Nome abreviado do transportador

Sim

cot-aprovada

LOGICAL

YES/NO

Indica se a cotação está aprovada

Sim

valor-descto

DECIMAL

>>>,>>>,>>9.9999

Valor do desconto

Não

valor-frete

DECIMAL

>>>,>>>,>>9.9999

Valor frete

Sim

frete

LOGICAL

YES/NO

Frete incluso

Sim

taxa-financ

LOGICAL

YES/NO

Encargos financeiros

Sim

valor-taxa

DECIMAL

>>9.9999

Taxa Financeira

Sim

nr-dias-taxa

INTEGER

>>9

Dias Taxa Financeira

Sim

perc-descto

DECIMAL

>9.99999

Percentual desconto

Sim

motivo-aprov

CHARACTER

X(2000)

Narrativa da cotação aprovada

Sim

valor-ipi

DECIMAL

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

Valor IPI

Sim

valor-liquido

DECIMAL

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

Valor líquido

Sim

valor-total-cotacao

DECIMAL

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

Valor Total

Sim

tt-ultima-compra

Entrada/

Saída

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

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

numero-ordem-orig

INTEGER

zzzzz9,99

Número da ordem original

Sim

numero-ordem

INTEGER

zzzzz9,99

Número da ordem

Sim

cod-emitente

INTEGER

>>>>>>>>9

Código fornecedor

Sim

desc-cod-emitente

CHARACTER

X(12)

Nome abreviado do fornecedor

Sim

num-pedido

INTEGER

>>>>>,>>9

Número pedido

Sim

data-pedido

DATE

99/99/9999

Data pedido

Sim

natureza

INTEGER

>9

Natureza

Sim

desc-natureza

CHARACTER

X(15)

Descrição da natureza

Sim

un

CHARACTER

X(2)

Unidade medida

Sim

mo-codigo

INTEGER

>9

Moeda

Sim

desc-mo-codigo

CHARACTER

X(12)

Descrição da Moeda

Sim

preco-unit-conv

DECIMAL

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

Preço Unitário

Sim

quantidade

DECIMAL

>>>,>>>,>>9.9999

Quantidade

Sim

aliquota-ipi

DECIMAL

>>9.99

Alíquota IPI

Sim

aliquota-icm

DECIMAL

>>9.99

Alíquota ICMS

Sim

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