Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicolaphtml/mlahtml024p.p

 

Considerações Gerais

 

Objetivo

 

O objetivo desta API é fornecer dados sobre pendências do módulo do MLA para o documento Titulo Normal(Duplicatas), estejam elas pendentes de aprovações, aprovadas ou reprovadas.

 

Funcionamento

 

A API fornece basicamente dois tipos de informações: listagem de documentos (neste caso titulo normal) e/ou detalhe um documento (neste caso titulo normal).

 

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

 

run laphtml/mlahtml024p.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 Titulo Normal

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 (Titulo Normal – Duplicatas)

Parâmetros

Tipo

Descrição

iCodTipDoc

INTEGER

Código do tipo de documento (neste caso para titulo normal, informar 24)

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

 

Exemplo de registro que poderiam existir na tt-it-requisicao-lista:

 

ttDados.cTable = “tt-it-requisicao-lista”

ttDados.iRow = 1

ttDados.cField = “nr-requisicao”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-it-requisicao-lista”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

 

ttDados.cTable = “tt-it-requisicao-lista”

ttDados.iRow = 1

ttDados.cField = “it-codigo”

ttDados.cValue = “Documento Normal”

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_lista_doc24

Entrada/

Saída

Temp-table com dados do titulo normal para serem apresentados na listagem

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

tta_cod_estab

CHARACTER

X(5)

Estabelecimento

Sim

tta_nom_pessoa

CHARACTER

X(40)

Nome

Sim

tta_cod_refer

CHARACTER

X(10)

Referencia

Sim

tta_num_seq_refer

INTEGER

>>>9

Sequencia

Sim

tta_dat_transacao

DATE

99/99/9999

Data Transacao

Sim

Tta_val_tit_ap

DECIMAL

->>>,>>>,>>9.99

Valor Título

Sim

Tta_cod_usuar

CHARACTER

X(12)

Usuário

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 Títulos normais 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 (Títulos normais)

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 títulos normais, informar 24)

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

 

Exemplo de registro que poderiam existir na tt-it-requisicao-lista:

 

ttDados.cTable = “tt-it-requisicao-lista”

ttDados.iRow = 1

ttDados.cField = “nr-requisicao”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-it-requisicao-lista”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

 

ttDados.cTable = “tt-it-requisicao-lista”

ttDados.iRow = 1

ttDados.cField = “it-codigo”

ttDados.cValue = “Documento Normal”

detalheDocumento

Requisito

Detalhe de pendências do MLA do documento de Titulo Normal – por item

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 (Titulo Normal)

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-requisicao e tt-it-requisicao, que são detalhadas na tabela mais a baixo.

 

Exemplo de registro que poderiam existir na tt-requisicao:

 

ttDados.cTable = “tt-requisicao”

ttDados.iRow = 1

ttDados.cField = “nr-requisicao”

ttDados.cValue = “3456”

 

ttDados.cTable = “tt-requisicao”

ttDados.iRow = 1

ttDados.cField = “cod-estabel”

ttDados.cValue = “EST1”

 

ttDados.cTable = “tt-requisicao”

ttDados.iRow = 1

ttDados.cField = “desc-tp-requis”

ttDados.cValue = “Titulo Normal”

Tt_detalhe_doc024

Entrada/

Saída

Temp-table com dados do titulo normal para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Tta_cod_tip_fluxo_financ

CHARACTER

X(12)

Tipo Fluxo Financ

Sim

Ttv_des_tip_fluxo_financ

CHARACTER

X(40)

Descrição

Sim

Tta_cod_plano_cta_ctbl

CHARACTER

X(8)

Plano Contas

Sim

Ttv_des_plano_cta_ctbl

CHARACTER

X(40)

 

Sim

Tta_cod_cta_ctbl

CHARACTER

X(20)

Conta Contabil

Sim

Ttv_des_cta_ctbl

CHARACTER

X(50)

 

Sim

Tta_cod_unid_negoc

CHARACTER

X(3)

Unid Negócio

Sim

Ttv_des_unid_negoc

CHARACTER

X(40)

 

Sim

Tta_cod_plano_ccusto

CHARACTER

X(8)

Plano Centro Custo

Não

Ttv_des_plano_ccusto

CHARACTER

X(40)

 

Não

Tta_cod_ccusto

CHARACTER

X(11)

Centro de Custo

Não

Ttv_des_ccusto

CHARACTER

X(40)

Des CCusto

Não

Tta_val_aprop_ctbl

DECIMAL

->>>,>>>,>>9.99

Valor Aprop Ctbl

Sim

Tt_item_detalhe_doc024

Entrada/

Saída

Temp-table com dados dos itens do titulo normal para serem apresentados no detalhamento do documento

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Tta_cod_estab

CHARACTER

X(5)

Estabelecimento

Sim

Ttv_des_cod_estab

CHARACTER

X(40)

 

Sim

Tta_cod_refer

CHARACTER

X(10)

Referencia

Sim

Tta_num_seq_refer

INTEGER

>>>9

Sequencia

Sim

Tta_dat_transacao

DATE

99/99/9999

Data Transacao

Sim

Tta_cdn_fornecedor

INTEGER

>>>,>>>,>>9

Fornecedor

Sim

Tta_nom_pessoa

CHARACTER

X(40)

Nome

Sim

Tta_cod_pais

CHARACTER

X(3)

País

Sim

Tta_nom_pais

CHARACTER

X(32)

Nome País

Sim

Tta_cod_forma_pagto

CHARACTER

X(3)

Forma Pagamento

Sim

Tta_des_forma_pagto

CHARACTER

X(40)

Descr Forma Pagto

Sim

Tta_cod_espec_docto

CHARACTER

X(3)

Espécie Documento

Sim

Tta_cod_ser_docto

CHARACTER

X(3)

Série Documento

Sim

Tta_cod_tit_ap

CHARACTER

X(10)

Título

Sim

Tta_cod_parcela

CHARACTER

X(02)

Parcela

Sim

Tta_cod_indic_econ

CHARACTER

X(8)

Moeda

Sim

Tta_val_tit_ap

DECIMAL

->>>,>>>,>>9.99

Valor Título

Sim

Tta_cod_portador

CHARACTER

X(5)

Portador

Sim

Tta_dat_emis_docto

DATE

99/99/9999

Data Emissão

Sim

Tta_dat_vencto_tit_ap

DATE

99/99/9999

Data Vencimento

Sim

Tta_dat_prev_pagto

DATE

99/99/9999

Data Prevista Pgto

Sim

Tta_dat_desconto

DATE

99/99/9999

Data Desconto

Não

Tta_val_perc_desc

DECIMAL

>9.9999

Percentual Desconto

Não

Tta_val_desconto

DECIMAL

->>>,>>>,>>9.99

Valor Desconto

Não

Tta_num_dias_atraso

INTEGER

>9

Dias Atraso

Não

Tta_val_perc_juros_dia_atraso

DECIMAL

>9.9999999

Perc Jur Dia Atraso

Não

Tta_val_perc_multa_atraso

DECIMAL

>9.99

Perc Multa Atraso

Não

Tta_val_juros_dia_atraso

DECIMAL

->>>,>>>,>>9.99

Valor Juros

Não

Tta_des_text_histor

CHARACTER

X(2000)

Historico

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.