Documento de API

Objetivo

Retornar o valor do saldo em aberto do ACR e do APB do cliente (emitente), bem como verificar o número máximo de cheques devolvidos e o valor total máximo de cheques devolvidos. A API de Integração, que retorna os valores dos títulos disponíveis no EMS5 retorna especificamente, o Saldo em Saldoem Aberto ACR(Saldo Total – Antecipações), o Saldo em Saldoem Aberto APB(Saldo Total – Antecipações), Total de Aviso de Débito ACR em Atraso ,  o Total de Antecipações em Antecipaçõesem Aberto ACR, o Total de Antecipações em Antecipaçõesem Aberto APB e APBe o Saldo em Saldoem Aberto Vencido ACR.

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API é:

run PrgfinRUN prgfin/acr/acr777zbacr777zd.py (input v_num_vers_integr_api,

                           input                             INPUT v_cod_empresa,

                           input                             INPUT v_cod_empresa_ext,

                           input                             INPUT v_cod_estab,

                           input                             INPUT v_cod_estab_ext,

                           input                             INPUT v_num_dias_maximomax_atraso,

                           input-output table tt-emitente,

                           output table tt_erros-analise-credito,

atr,

                            INPUT v_                              input v_num_dias_max_atr_ad).

Parâmetros API Integração Análise de Crédito:

Os Parâmetros utilizados pelo programa  estão listados abaixo, na ordem que se segue:

• v_num_vers_integr_api: Versão de Integração da API
• v_cod_empresa: Empresa a ser feita a Análise de Crédito (pode ser igual a ?, o que pode indicar que será analisada em todas as Empresas)
• v_cod_empresa_ext: Empresa Externa (verificada através da Matriz de Tradução) a ser feita a Análise de Crédito
• v_cod_estab: Estabelecimento a ser feita a Análise de Crédito (pode ser igual a ?, o que pode indicar que será analisada em todos os Estabelecimentos)
• v_cod_estab_ext: Estabelecimento Externo (verificada através da Matriz de Tradução) a ser feita a Análise de Crédito
• v_num_dias_maximo_atraso: utilizado para cálculo do Total de Títulos em Aberto com Vencimento em Atraso
• tt-emitente: tabela temporária que contém todos os emitentes (clientes) a serem analisados
• tt-erros-analise-credito: retorna os erros que aconteceram ao verificar a Análise de Crédito dos Emitentes (Clientes)
• v_num_dias_max_atr_ad: utilizado para cálculo do Total de Títulos de Aviso de Débito em Aberto com Vencimento em Atraso

Definição dos Parâmetros Recebidos:

...

,

                            INPUT yes, /* v_log_valid_cheq */

                            INPUT no,  /* v_log_retorna_dados */

                            INPUT-OUTPUT TABLE tt_tit_acr_analise_credito,

                            INPUT-OUTPUT TABLE tt_tit_aP_analise_credito,

                            INPUT-OUTPUT TABLE tt-emitente,

                            INPUT-OUTPUT TABLE tt-emitente-safra,

                            INPUT-OUTPUT TABLE tt-erros-analise-credito).

Parâmetros API Integração Análise de Crédito:

Os Parâmetros utilizados pelo programa  estão listados abaixo, na ordem que se segue:

...

• v_num_vers_integr_api

...

• : Versão de Integração da API

• v_cod_

...

• empresa: Empresa a ser feita a Análise de Crédito (pode ser igual a ?, o que pode indicar que será analisada em todas as Empresas)
• v_cod_empresa_

...

def var v_cod_estab           as character format "x(03)"    no-undo.

def var v_cod_estab_ext       as character format "x(08)"    no-undo.

...

• ext: Empresa Externa (verificada através da Matriz de Tradução) a ser feita a Análise de Crédito
• v_cod_estab: Estabelecimento a ser feita a Análise de Crédito (pode ser igual a ?, o que pode indicar que será analisada em todos os Estabelecimentos)
• v_cod_estab_ext: Estabelecimento Externo (verificada através da Matriz de Tradução) a ser feita a Análise de Crédito
• v_num_dias_

...

• maximo_atraso: utilizado para cálculo do Total de Títulos em Aberto com Vencimento em Atraso
• tt-emitente: tabela temporária que contém todos os emitentes (clientes) a serem analisados
• tt-emitente-safra: tabela temporária que contém todos os emitentes da safra
• tt-erros-analise-credito: retorna os erros que aconteceram ao verificar a Análise de Crédito dos Emitentes (Clientes)
• v_num_dias_max_atr_ad: utilizado para cálculo do Total de Títulos de Aviso de Débito em Aberto com Vencimento em Atraso
• v_log_valid_cheq: Esta informação irá determinar se a API irá fazer o tratamento de cheques do Contas a Receber.
• v_log_retorna_dados: Esta informação irá determinar se a API irá retornar os dados dos títulos do APB e ACR que foram levadosem consideração. Os dados serão retornados através das temp-table´s tt_tit_acr_analise_credito e tt_tit_ap_analise_credito.
• tt_tit_acr_analise_credito: Irá retornar todos os títulos do Contas a Receber que fizeram parte da análise do crédito do cliente.
• tt_tit_ap_analise_credito: Irá retornar todos os títulos do Contas a Pagar que fizeram parte da análise de crédito.

Definição dos Parâmetros Recebidos:

def var v_num_vers_integr_api as integer   format ">>>>,>>9" no-undo.

def var v_cod_empresa         as character format "x(03)"    no-undo.

def var v_cod_empresa_ext     as character format "x(03)"    no-undo.

def var v_cod_estab           as character format "x(03)"    no-undo.

def var v_cod_estab_ext       as character format "x(08)"    no-undo.

def var v_num_dias_max_atr    as integer   format ">>>9"     no-undo.

def var v_num_dias_max_atr_ad as integer   format ">>>9"     no-undo.

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

define temp-table tt-emitente no-undo

    field cod-emitente      as integer   format ">>>>>>9"

    field nome-abrev        as character format "x(12)"

    field nr-mesina         as integer   format ">9"

    field cod-gr-cli        as integer   format ">9"

    field nr-peratr         as integer   format ">9"

    /* ****    Atributos utilizados na integração com o EMS 5.0     *****/

    field nr-cheque-devol   as integer   format ">>9"                 /* Número de Cheques Devolvidos */

    field qtd-dias          as integer   format ">>9"

    field vl-max-devol      as decimal   format ">>>,>>>,>>9.99"      /* Valor Máximo do Total de Cheques Devolvidos */

    field identific         as integer   format ">9"

    field moeda-credito     as integer   format ">9"

    field de-saldo-cr       as decimal   format "->>>,>>>,>>>,>>9.99" /* Saldo em Aberto (Saldo Total - Antecipação) ACR */

    field de-saldo-ap       as decimal   format "->>>,>>>,>>>,>>9.99" /* Saldo em Aberto (Saldo Total - Antecipação) APB */

    field de-tot-tit-atr-cr as decimal   format ">>>,>>>,>>>,>>9.99"

    field de-tot-ad-cr      as decimal   format ">>>,>>>,>>>,>>9.99"  /* Total de Aviso de Débito ACR */

    field de-cr-ant-aberto  as decimal   format ">>>,>>>,>>>,>>9.99"  /* Total de Antecipações em Aberto ACR */

    field de-ap-ant-aberto  as decimal   format ">>>,>>>,>>>,>>9.99"  /* Total de Antecipações em Aberto APB */

    field de-tot-tit-atr-ap as decimal   format ">>>,>>>,>>>,>>9.99"  /* Saldo de títulos a pagar em atraso */

    field de-ap-ant-sem-safra as decimal format ">>>,>>>,>>>,>>9.99"  /* Saldo de antecipações que não possuem código de safra */

    index cod-emitente is primary cod-emitente.

def temp-table tt-emitente-safra no-undo

    field cod-emitente                 as integer   format ">>>>>>>>9"          /* Código do emitente */

    field cod-safra                    as character format "9999/9999"          /* Código da safra */

    field de-tit-abe-nao-venc-safra-cr as decimal   format ">>>,>>>,>>>,>>9.99" /* Saldo de títulos a receber não vencidos */

    field de-tit-abe-nao-venc-safra-ap as decimal   format ">>>,>>>,>>>,>>9.99" /* Saldo de títulos a pagar não vencidos */

    field de-ap-ant-safra              as decimal   format ">>>,>>>,>>>,>>9.99" /* Saldo das antecipações */

    index cod-emitente-safra is primary cod-emitente

                                        cod-safra.

def temp-table tt-erros-analise-credito no-undo

    field cod-emitente      as integer   format ">>>>>>9"

    field cod-mensagem      as integer   format ">>>>,>>9"

    field des-msg           as character format "x(50)"  

    field help-msg          as character format "x(50)".

def temp-table tt_tit_acr_analise_credito no-undo

    field tta_cod_empresa                  as character format "x(3)" label "Empresa" column-label "Empresa"

    field tta_cod_estab                    as character format "x(3)" label "Estabelecimento" column-label "Estab"

    field tta_cdn_cliente                  as Integer format ">>>,>>>,>>9" initial 0 label "Cliente" column-label "Cliente"

    field tta_cod_ser_docto                as character format "x(3)" label "Série Documento" column-label "Série"

    field tta_cod_espec_docto              as character format "x(3)" label "Espécie Documento" column-label "Espécie"

    field tta_cod_tit_acr                  as character format "x(10)" label "Título" column-label "Título"

    field tta_cod_parcela                  as character format "x(02)" label "Parcela" column-label "Parc"

    field tta_dat_vencto_tit_acr           as date format "99/99/9999" initial ? label "Vencimento" column-label "Vencimento"

    field tta_dat_emis_docto               as date format "99/99/9999" initial today label "Data  Emissão" column-label "Dt Emissão"

    field tta_ind_tip_espec_docto          as character format "X(17)" initial "Normal" label "Tipo Espécie" column-label "Tipo Espécie"

    field tta_ind_sit_tit_acr              as character format "X(13)" initial "Normal" label "Situação Título" column-label "Situação Título"

    field tta_log_tit_acr_estordo          as logical format "Sim/Não" initial no label "Estornado" column-label "Estornado"

    field tta_cod_indic_econ               as character format "x(8)" label "Moeda" column-label "Moeda"

    field tta_val_origin_tit_acr           as decimal format ">>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Original Título" column-label "Vl Original Título"

    field tta_val_sdo_tit_acr              as decimal format ">>>,>>>,>>9.99" decimals 2 initial 0 label "Saldo Título" column-label "Saldo Título"

    field ttv_rec_tit_acr                  as recid format ">>>>>>9"

    field ttv_cod_indic_movto              as character format "x(1)" label "Indic Movto" column-label "Indic Movto"

    field ttv_val_sdo_tit_analis_cr        as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Vl Análise Crédito" column-label "Vl Análise Crédito"

    index tt_chave                       

          tta_cod_empresa                  ascending

          tta_cod_estab                    ascending

          tta_cod_espec_docto              ascending

          tta_cod_ser_docto                ascending

          tta_cod_tit_acr                  ascending

          tta_cod_parcela                  ascending

    index tt_tipo_espec                  

          tta_ind_tip_espec_docto          ascending.

def temp-table tt_tit_ap_analise_credito no-undo

    field tta_cod_empresa           as character format "x(3)" label "Empresa" column-label "Empresa"

    field tta_cod_estab             as character format "x(3)" label "Estabelecimento" column-label "Estab"

    field tta_cdn_fornecedor        as Integer format ">>>,>>>,>>9" initial 0 label "Fornecedor" column-label "Fornecedor"

    field tta_cod_ser_docto         as character format "x(3)" label "Série Documento" column-label "Série"

    field tta_cod_espec_docto       as character format "x(3)" label "Espécie Documento" column-label "Espécie"

    field tta_cod_tit_ap            as character format "x(10)" label "Título" column-label "Título"

    field tta_cod_parcela           as character format "x(02)" label "Parcela" column-label "Parc"

    field tta_dat_vencto_tit_ap     as date format "99/99/9999" initial today label "Data Vencimento" column-label "Dt Vencto"

    field tta_dat_emis_docto        as date format "99/99/9999" initial today label "Data  Emissão" column-label "Dt Emissão"

    field tta_ind_tip_espec_docto   as character format "X(17)" initial "Normal" label "Tipo Espécie" column-label "Tipo Espécie"

    field tta_ind_sit_tit_ap        as character format "X(13)" label "Situação" column-label "Situação"

    field tta_log_tit_ap_estordo    as logical format "Sim/Não" initial no label "Estornado" column-label "Estornado"

    field tta_cod_indic_econ        as character format "x(8)" label "Moeda" column-label "Moeda"

    field tta_val_origin_tit_ap     as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Original" column-label "Valor Original"

    field tta_val_sdo_tit_ap        as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Saldo" column-label "Valor Saldo"

    field ttv_rec_tit_ap            as recid format ">>>>>>9" initial ?

    field ttv_cod_indic_movto       as character format "x(1)" label "Indic Movto" column-label "Indic Movto"

    field ttv_val_sdo_tit_analis_cr as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Vl Análise Crédito" column-label "Vl Análise Crédito"

    index tt_chave                 

          tta_cod_empresa           ascending

          tta_cod_estab             ascending

          tta_cdn_fornecedor        ascending

          tta_cod_ser_docto         ascending

          tta_cod_espec_docto       ascending

          tta_cod_tit_ap            ascending

          tta_cod_parcela           ascending

    index tt_tipo_espec            

          tta_ind_tip_espec_docto   ascending

def var v_num_dias_max_atr_ad as integer   format ">>>9"     no-undo.

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

define temp-table tt-emitente no-undo

    field cod-emitente      as integer   format ">>>>>>9"

    field nome-abrev        as character format "x(12)"

    field nr-mesina         as integer   format ">9"

    field cod-gr-cli        as integer   format ">9"

    field nr-peratr         as integer   format ">9"

    /* ****    Atributos utilizados na integra‡Æo com o EMS 5.0     *****/

    field nr-cheque-devol   as integer   format ">>9"                 /* Número de Cheques Devolvidos */

    field qtd-dias          as integer   format ">>9"

    field vl-max-devol      as decimal   format ">>>,>>>,>>9.99"      /* Valor Máximo do Total de Cheques Devolvidos */

    field moeda-credito     as integer   format ">9"

    field de-saldo-cr       as decimal   format "->>>,>>>,>>>,>>9.99" /* Saldo em Aberto (Saldo Total - Antecipa‡Æo) ACR */

    field de-saldo-ap       as decimal   format "->>>,>>>,>>>,>>9.99" /* Saldo em Aberto (Saldo Total - Antecipa‡Æo) APB */

    field de-tot-tit-atr-cr as decimal   format ">>>,>>>,>>>,>>9.99"

    field de-tot-ad-cr      as decimal   format ">>>,>>>,>>>,>>9.99"  /* Total de Aviso de D‚bito ACR */

    field de-cr-ant-aberto  as decimal   format ">>>,>>>,>>>,>>9.99"  /* Total de Antecipaçäes em Aberto ACR */

    field de-ap-ant-aberto  as decimal   format ">>>,>>>,>>>,>>9.99"  /* Total de Antecipaçäes em Aberto APB */

    index cod-emitente is primary cod-emitente.

def temp-table tt-erros-analise-credito no-undo

    field cod-emitente      as integer   format ">>>>>>9"

    field cod-mensagem      as integer   format ">>>>,>>9"

    field des-msg           as character format "x(50)"  

    field help-msg          as character format "x(50)".

Possíveis erros que podem retornar da API de Análise de Crédito

Observações

• Caso não seja informado a Empresa, Empresa Externa, Estabelecimento e Estabelecimento Externo, será feita a Análise de Crédito em todas as Empresas/Estabelecimentos existentes no EMS5.
• Caso seja informado o Estabelecimento, serão desconsiderados os valores informados para Empresa, Empresa Externa e Estabelecimento Externo, ou seja, a Análise de Crédito será verificada apenas para o Estabelecimento informado, na sua respectiva Empresa.
• Caso seja informado o Estabelecimento Externo (e não seja informado o Estabelecimento), serão desconsiderados os valores informados para Empresa e Empresa Externa. Através da Matriz de Tradução informada na integração de Análise Crédito 2.00 (integração criada através dos Parâmetros de Integração do EMS), será feita a Análise de Crédito apenas para o Estabelecimento correspondente, na sua respectiva Empresa.
• Caso seja informado a Empresa (e não seja informado o Estabelecimento e Estabelecimento Externo) será desconsiderado o valor informado para Empresa Externa, ou seja, será feita a Análise de Crédito com base em todos os Estabelecimentos  da Empresa informada.
• Caso seja informado a Empresa Externa (e não seja informado a Empresa, o Estabelecimento e o Estabelecimento Externo), através da Matriz de Tradução informada na integração de Análise Crédito 2.00 (criada através dos Parâmetros de Integração do EMS), será feita a Análise de Crédito com base em todos os Estabelecimentos da Empresa correspondente.
• O cliente teve ter cadastrado o parâmetro de integração 'Análise de Crédito'.

...