Linha Datasul

Árvore de páginas

Documento de API

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 sintaxe para a chamada da API, que deve ser de forma persistente:

 

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

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

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

Entrada/

Saída

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

CHARACTER

X(32)

Descrição do contrato

Sim

cod-estabel

CHARACTER

X(5)

Estabelecimento

Sim

desc-cod-estabel

CHARACTER

X(40)

Nome estabelecimento

Sim

cod-tipo-contrat

INTEGER

99

Tipo do Contrato

Sim

desc-cod-tipo-contrat

CHARACTER

X(76)

Descrição do tipo do contrato

Sim

dt-contrato

DATE

99/99/9999

Data Contrato

Sim

cod-emitente

INTEGER

>>>>>>>>9

Código do fornecedor

Sim

desc-cod-emitente

CHARACTER

X(12)

Nome abreviado do fornecedor

Sim

dt-ini-validade

DATE

99/99/9999

Data de inicio da validade

Sim

cod-comprado

CHARACTER

X(12)

Comprador

Sim

dt-ter-validade

DATE

99/99/9999

Data de término da validade

Sim

contato

CHARACTER

X(40)

Contato

Sim

cod-trans

INTEGER

>>,>>9

Transportador

Sim

desc-cod-transp

CHARACTER

X(12)

Nome abreviado do Transportador

Sim

frete

INTEGER

>9

Frete

Sim

desc-frete

CHARACTER

X(8)

Descrição do frete

Sim

via-trans

INTEGER

9

Via transporte

Sim

desc-via-trans

CHARACTER

X(16)

Descrição via de transporte

Sim

total-contrato

DECIMAL

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

Total do contrato

Sim

ind-sit-contrat

INTEGER

>9

Situação

Sim

desc-ind-sit-contrat

CHARACTER

X(12)

Descrição da situação

Sim

ind-control-rec

INTEGER

9

Controle Recebimento

Não

desc-ind-control-rec

CHARACTER

X(15)

Descrição do Controle de recebimento

Não

mo-codigo

INTEGER

>9

Moeda

Sim

desc-mo-codigo

CHARACTER

X(12)

Descrição da Moeda

Sim

variacao-qtd

DECIMAL

>>9.99

Variação Quantidade

Não

variacao-preco

DECIMAL

>>9.99

Variação Preço

Não

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

CHARACTER

X(12)

Código do projeto

Sim

natureza

INTEGER

>9

Natureza

Sim

desc-natureza

CHARACTER

X(15)

Descrição da Natureza

Sim

dat-revisao

DATE

99/99/9999

Data Revisão

Sim

cod-cond-fatur

INTEGER

>>>9

Condição de faturamento

Não

desc-cod-cond-fatur

CHARACTER

X(30)

Descrição condição de faturamento

Não

gestor-tecnico

CHARACTER

X(12)

Gestor Técnico

Sim

cod-mensagem

INTEGER

>>9

Mensagem

Sim

desc-mensagem

CHARACTER

X(20)

Descrição da Mensagem

Sim

impr-contrat

LOGICAL

YES/NO

Impressão do contrato

Sim

narrat-contrat

CHARACTER

X(15000)

Narrativa contrato

Não

moeda-padrao

INTEGER

>9

MoedaPadrão

Sim

desc-moeda-padrao

CHARACTER

X(12)

Descrição da Moeda padrão

Sim

tt-item-contrat

Entrada/

Saída

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

preco-fornec

DECIMAL

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

Preço fornecedor

Não

qtd-total

DECIMAL

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

Quantidade total

Não

tt-anexo

Entrada/

Saída

Temp-table com dados dos anexos 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-anexo

INTEGER

99

Sequência do anexo

Sim

des-anexo

CHARACTER

X(32)

Descrição

Não

narrat-anexo

CHARACTER

X(15000)

Narrativa

Não

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:

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.