Tempo aproximado para leitura: 00:16:03 min
Dúvida
O objetivo desta API é obter as informações utilizadas pelo portal do MLA (Novo Framework HTML)
Ambiente
Cross Segmentos - TOTVS Backoffice (Linha Datasul) - Aprovação Processo Logístico (MLA) - Versão 12
Solução
A API fornece basicamente informações da empresa selecionada, da ordenação usada na listagem dos documentos, do histórico de aprovações, dos documentos do usuário e dos totalizadores dos documentos.
A sintaxe para a chamada da API, que deve ser de forma persistente:
run lap/mla0009.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:
|
getDadosEmpresa |
|
|
Requisito |
Nenhum. |
|
Sintaxe |
RUN getDadosEmpresa IN h-handle(OUTPUT TABLE tt-empresas-usuar, OUTPUT p-cod-empresa, OUTPUT p-razao-social). |
|
Descrição |
Retorna informações da empresa logada e lista de empresas do usuário. Obs: Para acessar este método via REST usar a procedure REST_GET_getDadosEmpresa. |
|
Retorno |
tt-empresas-usuar: temp-table com as empresas do usuário. p-cod-empresa (CHARACTER): Código da empresa selecionada. p-razao-social (CHARACTER): Razão social da empresa selecionada. |
|
tt-empresas-usuar |
Entrada/Saída |
|||
|
Temp-table com dados das empresas do usuário |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
c-cod-empresa |
CHARACTER |
Código da empresa |
Sim |
Não se aplica |
|
c-razao-social |
CHARACTER |
Razão social da empresa |
Sim |
Não se aplica |
|
getSortDefault |
|
|
Requisito |
Nenhum. |
|
Sintaxe |
RUN getSortDefault IN h-handle(OUTPUT i-sort). |
|
Descrição |
Retorna a ordenação padrão usada na listagem dos documentos para o usuário em questão Obs: Para acessar este método via REST usar a procedure REST_GET_getSortDefault. |
|
Retorno |
i-ordering: tipo de ordenação 1- Mais recentes 2- Mais antigas 3- Maior valor 4- Menor valor 5- Maior empresa 6- Menor empresa |
|
getTotalizadoresPorDocumento |
||
|
Requisito |
Nenhum. |
|
|
Sintaxe |
RUN getTotalizadoresPorDocumento in h-handle (input i-tipo, input dtIni, input dtFim, output table ttDocuments). |
|
|
Descrição |
Retorna para cada documento que o usuário tem permissão de acesso, o número de pendências como principal e o número de pendências alternativo. Obs: Para acessar este método via REST usar a procedure REST_GET_getTotalizadoresPorDocumento |
|
|
Parâmetros |
Descrição |
|
|
i-tipo |
Tipo da pendência. 1- Principais e alternativas (com mestre junto) 2- Saída |
|
|
dtIni |
Data de início para consideração dos históricos. |
|
|
dtFim |
Data de término para consideração dos históricos. |
|
|
Retorno |
ttDocuments: Temp-table com os documentos e seus totais.
Exemplo de registro que poderiam existir na ttDocuments:
ttDocuments.cod-tip-doc = 2 ttDocuments.desc-tip-doc = "Solicitação de Compra - Total" ttDocuments.nr-doc-pend-aprov-prin = 2 ttDocuments.nr-doc-pend-aprov-alter = 0 ttDocuments.nr-doc-pend-aprov-mes = 0 ttDocuments.nr-doc-pend-aprov-total = 2 ttDocuments.nr-doc-pend-aprov-saida = 0
ttDocuments.cod-tip-doc = 5 ttDocuments.desc-tip-doc = "Cotação de Materiais" ttDocuments.nr-doc-pend-aprov-prin = 19 ttDocuments.nr-doc-pend-aprov-alter = 0 ttDocuments.nr-doc-pend-aprov-mes = 0 ttDocuments.nr-doc-pend-aprov-total = 19 ttDocuments.nr-doc-pend-aprov-saida = 0 |
|
|
getTotalizadoresPorDocumentoEmpresaEstab |
||
|
Requisito |
Nenhum. |
|
|
Sintaxe |
RUN getTotalizadoresPorDocumentoEmpresaEstab in h-handle (input epCodigo, input codEstabel, input i-tipo, input dtIni, input dtFim, output table ttDocuments). |
|
|
Descrição |
Retorna para cada documento que o usuário tem permissão de acesso, o número de pendências como principal e o número de pendências alternativo, considerando a empresa e estabelecimento. Obs: Para acessar este método via REST usar a procedure REST_GET_getTotalizadoresPorDocumentoEmpresaEstab |
|
|
Parâmetros |
Descrição |
|
| epCodigo | Código da empresa (Se passar em branco, considera todas) | |
| codEstabel | Código do estabelecimento (Se passar em branco, considera todos) | |
|
i-tipo |
Tipo da pendência. 1- Principais e alternativas (com mestre junto) 2- Saída |
|
|
dtIni |
Data de início para consideração dos históricos. |
|
|
dtFim |
Data de término para consideração dos históricos. |
|
|
Retorno |
ttDocuments: Temp-table com os documentos e seus totais.
Exemplo de registro que poderiam existir na ttDocuments:
ttDocuments.cod-tip-doc = 2 ttDocuments.desc-tip-doc = "Solicitação de Compra - Total" ttDocuments.nr-doc-pend-aprov-prin = 2 ttDocuments.nr-doc-pend-aprov-alter = 0 ttDocuments.nr-doc-pend-aprov-mes = 0 ttDocuments.nr-doc-pend-aprov-total = 2 ttDocuments.nr-doc-pend-aprov-saida = 0
ttDocuments.cod-tip-doc = 5 ttDocuments.desc-tip-doc = "Cotação de Materiais" ttDocuments.nr-doc-pend-aprov-prin = 19 ttDocuments.nr-doc-pend-aprov-alter = 0 ttDocuments.nr-doc-pend-aprov-mes = 0 ttDocuments.nr-doc-pend-aprov-total = 19 ttDocuments.nr-doc-pend-aprov-saida = 0 |
|
|
ttDocuments |
Entrada/Saída |
|||
|
Temp-table com os totalizadores dos documentos. |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
cod-tip-doc |
INTEGER |
Código da empresa |
Sim |
Não se aplica |
|
desc-tip-doc |
CHARACTER |
Razão social da empresa |
Sim |
Não se aplica |
|
nr-doc-pend-aprov-prin |
INTEGER |
Total de pendências principais |
Sim |
Não se aplica |
|
nr-doc-pend-aprov-alter |
INTEGER |
Total de pendências alternativas |
Sim |
Não se aplica |
| nr-doc-pend-aprov-mes | INTEGER | Total de pendências como mestre | Sim | Não se aplica |
|
nr-doc-pend-aprov-total |
INTEGER |
Total de pendências |
Sim |
Não se aplica |
|
nr-doc-pend-aprov-saida |
INTEGER |
Total de pendências do histórico. |
Sim |
Não se aplica |
|
getHistoricoAprovacoes |
||
|
Requisito |
Nenhum. |
|
|
Sintaxe |
RUN getHistoricoAprovacoes in h-handle (input p-nr-transacao, output table tt-historico-aprov). |
|
|
Descrição |
Retorna o histórico de aprovações do documento. Obs: Para acessar este método via REST usar a procedure REST_GET_getHistoricoAprovacoes. |
|
|
Parâmetros |
Descrição |
|
|
p-nr-transacao |
Número de transação da pendência do MLA |
|
|
Retorno |
tt-historico-aprov: Temp-table com histórico de aprovações do documento. |
|
|
tt-historico-aprov |
Entrada/Saída |
|||
|
Temp-table com o histórico de aprovações do documento. |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
nivel |
INTEGER |
Nível de Aprovação |
Sim |
Não se aplica |
|
desc-nivel |
CHARACTER |
Descrição do nível de aprovação. |
Sim |
Não se aplica |
|
cod-aprovador |
CHARACTER |
Código do usuário aprovador |
Sim |
Não se aplica |
|
nome-aprovador |
CHARACTER |
Nome do usuário aprovador |
Sim |
Não se aplica |
|
data-aprovacao |
DATE |
Data de aprovação/rejeição |
Sim |
Não se aplica |
|
hora-aprovacao |
CHARACTER |
Hora da aprovação/rejeição |
Sim |
Não se aplica |
|
narrativa |
CHARACTER |
Narrativa de aprovação/rejeição. |
Sim |
Não se aplica |
|
getDocumentosDoUsuario |
|
|
Requisito |
Nenhum. |
|
Sintaxe |
RUN getDocumentosDoUsuario in h-handle (output table ttDocs). |
|
Descrição |
Retorna os documentos que o usuário tem permissão. Obs: Para acessar este método via REST usar a procedure REST_GET_getDocumentosDoUsuario. |
|
Retorno |
ttDocs: Temp-table com a lista de documentos do usuário. |
|
ttDocs |
Entrada/Saída |
|||
|
Temp-table com a lista de documentos do usuário |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
cod-tip-doc |
INTEGER |
Código do Documento |
Sim |
Não se aplica |
|
desc-tip-doc |
CHARACTER |
Nome do documento |
Sim |
Não se aplica |
|
getDetalhePendencia |
|
|
Requisito |
Nenhum. |
|
Sintaxe |
RUN getDetalhePendencia IN h-handle(INPUT p-nr-transacao, OUTPUT TABLE tt-detalhe-pendencia, OUTPUT TABLE tt-chave). |
|
Descrição |
Retorna informações detalhadas de uma pendência. Obs: Para acessar este método via REST usar a procedure REST_GET_getDetalhePendencia. |
|
Retorno |
tt-detalhe-pendencia: temp-table com as informações detalhadas da pendência. tt-chave: temp-table com a chave formatada da pendência. |
|
tt-detalhe-pendencia |
Entrada/Saída |
|||
|
Temp-table com as informações detalhadas da pendência. |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
ep-codigo |
INTEGER |
Código do Documento |
Sim |
Não se aplica |
|
desc-ep |
CHARACTER |
Descrição Empresa |
Sim |
Não se aplica |
| nr-trans | Integer | Número da transação | Sim | Não se aplica |
| cod-estabel | CHARACTER | Código estabelecimento | Sim | Não se aplica |
| desc-estabel | CHARACTER | Descrição Estabelecimento | Sim | Não se aplica |
| dt-geracao | DATE | Data de geração | Sim | Não se aplica |
| hr-geracao | CHARACTER | Hora de geração | Sim | Não se aplica |
| cod-tip-doc | INTEGER | Código documento | Sim | Não se aplica |
| desc-doc | CHARACTER | Descrição documento | Sim | Não se aplica |
| dt-aprova | DATE | Data de aprovação | Não | Não se aplica |
| hr-aprova | CHARACTER | Hora de aprovação | Não | Não se aplica |
| motivo-doc | CHARACTER | Motivo | Não | Não se aplica |
| dt-rejeita | DATE | Data de rejeição | Não | Não se aplica |
| hr-rejeita | CHARACTER | Hora de rejeição | Não | Não se aplica |
| motivo-hist | CHARACTER | Histórico | Não | Não se aplica |
| dt-reaprova | DATE | Data de reaprovação | Não | Não se aplica |
| hr-reaprova | CHARACTER | Hora de reaprovação | Não | Não se aplica |
| cod-usuar-trans | CHARACTER | Código usuário alternativo | Sim | Não se aplica |
| nome-usuar-trans | CHARACTER | Nome usuário alternativo | Sim | Não se aplica |
| valor-doc | DECIMAL | Valor documento | Sim | Não se aplica |
| ind-tip-aprov | INTEGER | Tipo de aprovação | Sim | Não se aplica |
| desc-tip-aprov | CHARACTER | Descrição tipo de aprovação | Sim | Não se aplica |
| cod-usuar-doc | CHARACTER | Usuário documento | Sim | Não se aplica |
| nome-usuar-doc | CHARACTER | Nome usuário documento | Sim | Não se aplica |
| cod-lotacao-trans | CHARACTER | Código Lotação | Sim | Não se aplica |
| desc-lotacao-trans | CHARACTER | Descrição Lotação Transação | Sim | Não se aplica |
| cod-usuar | CHARACTER | Aprovador | Sim | Não se aplica |
| nome-usuar | CHARACTER | Nome aprovador | Sim | Não se aplica |
| cod-lotacao-doc | CHARACTER | Lotação Documento | Sim | Não se aplica |
| desc-lotacao-doc | CHARACTER | Descrição Lotação Documento | Sim | Não se aplica |
| cod-usuar-altern | CHARACTER | Alternativo | Não | Não se aplica |
| nome-usuar-altern | CHARACTER | Nome usuário alternativo | Não | Não se aplica |
| mo-codigo | INTEGER | Código Moeda | Sim | Não se aplica |
| desc-moeda | CHARACTER | Descrição Moeda | Sim | Não se aplica |
| cod-rejeicao | INTEGER | Código Rejeição | Não | Não se aplica |
| desc-rejeicao | CHARACTER | Descrição Rejeição | Não | Não se aplica |
| aprov-auto | LOGICAL | Aprovação automática | Sim | Não se aplica |
| desc-situacao | CHARACTER | Descrição situação | SIm | Não se aplica |
| ind-situacao | INTEGER | Situação | Sim | Não se aplica |
| chave-doc | CHARACTER | Chave documento | Sim | Não se aplica |
| narrativa-apr | CHARACTER | Narrativa aprovação | Não | Não se aplica |
| narrativa-rej | CHARACTER | Narrativa rejeição | Não | Não se aplica |
|
tt-chave |
Entrada/Saída |
|||
|
Temp-table com a chave formatada do documento |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
cod-tip-doc |
INTEGER |
Código do Documento |
Sim |
Não se aplica |
|
posicao-ini |
INTEGER |
Posição inicial |
Sim |
Não se aplica |
| posicao-fim | INTEGER | Posição final | Sim | Não se aplica |
| desc-campo | CHARACTER | Descrição campo chave | Sim | Não se aplica |
| char-1 | CHARACTER | Campo character livre 1 | Não | Não se aplica |
| char-2 | CHARACTER | Campo character livre 2 | Não | Não se aplica |
| char-3 | CHARACTER | Campo character livre 3 | Não | Não se aplica |
| char-4 | CHARACTER | Campo character livre 4 | Não | Não se aplica |
| char-5 | CHARACTER | Campo character livre 5 | Não | Não se aplica |
| dec-1 | DECIMAL | Campo decimal livre 1 | Não | Não se aplica |
| dec-2 | DECIMAL | Campo decimal livre 2 | Não | Não se aplica |
| dec-3 | DECIMAL | Campo decimal livre 3 | Não | Não se aplica |
| dec-4 | DECIMAL | Campo decimal livre 4 | Não | Não se aplica |
| dec-5 | DECIMAL | Campo decimal livre 5 | Não | Não se aplica |
| int-1 | INTEGER | Campo integer livre 1 | Não | Não se aplica |
| int-2 | INTEGER | Campo integer livre 2 | Não | Não se aplica |
| int-3 | INTEGER | Campo integer livre 3 | Não | Não se aplica |
| int-4 | INTEGER | Campo integer livre 4 | Não | Não se aplica |
| int-5 | INTEGER | Campo integer livre 5 | Não | Não se aplica |
| log-1 | LOGICAL | Campo logical livre 1 | Não | Não se aplica |
| log-2 | LOGICAL | Campo logical livre 2 | Não | Não se aplica |
| log-3 | LOGICAL | Campo logical livre 3 | Não | Não se aplica |
| log-4 | LOGICAL | Campo logical livre 4 | Não | Não se aplica |
| log-5 | LOGICAL | Campo logical livre 5 | Não | Não se aplica |
| data-1 | DATE | Campo data livre 1 | Não | Não se aplica |
| data-2 | DATE | Campo data livre 2 | Não | Não se aplica |
| data-3 | DATE | Campo data livre 3 | Não | Não se aplica |
| data-4 | DATE | Campo data livre 4 | Não | Não se aplica |
| data-5 | DATE | Campo data livre 5 | Não | Não se aplica |
| ep-codigo | CHARACTER | Código da empresa | Sim | Não se aplica |
| valor | CHARACTER | Valor da chave | Sim | Não se aplica |
|
getUsuarInformation |
|
|
Requisito |
Nenhum. |
|
Sintaxe |
RUN getUsuarInformation IN h-handle(OUTPUT TABLE tt-info-usuar). |
|
Descrição |
Retorna informações padrões do usuário logado. Obs: Para acessar este método via REST usar a procedure REST_GET_getUsuarInformation. |
|
Retorno |
tt-info-usuar: temp-table com as informações do usuário |
|
tt-info-usuar |
Entrada/Saída |
|||
|
Temp-table com o histórico de aprovações do documento. |
Saída |
|||
|
Atributo |
Tipo |
Descrição |
Obrigatório |
Evolução |
|
cod-usuar |
CHARACTER |
Código do usuário |
Sim |
Não se aplica |
| usuar-mestre | LOGICAL | Indica se o usuário é mestre | Sim | Não se aplica |
| idi-ordenacao-portal | INTEGER | Ordenação padrão | Sim | Não se aplica |
| log-pendcia-todas-empres | LOGICAL | Indica que o usuário visualiza todas as pendências | Sim | Não se aplica |
| log-visualiza-detalhe-listagem | LOGICAL | Indica se deverá ser exibido o detalhe da pendência na listagem de pendências | Sim | Não se aplica |
| log-visualiza-contador-pendencia | LOGICAL | Indica se deverá ser exibido o contador de pendências | Sim | Não se aplica |
| idi-visualizacao-padrao | INTEGER | Visualização padrão | Sim | Não se aplica |
| ep-codigo | CHARACTER | Código da empresa logada | Sim | Não se aplica |
| ep-codigo desc | CHARACTER | Razão social da empresa logada | Sim | Não se aplica |
| log-aprovac-unica-pendcia | LOGICAL | Indica que o botão de aprovação individual não considera os registros selecionados | Sim | Não se aplica |
0 Comentários