Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/acr/acr575za

Objetivo

Extrair os registros de liquidação e antecipação dos Pagamentos Eletrônicos para enviar no SPED 1601

Vamos considerar todos os Movimentos de Liquidações com Portador diferente de Caixa e as Implantações de Antecipação que tem Portador informado e que este Portador seja diferente de Caixa.

Funcionamento

1. No programa chamador da API  devem ser declaradas as temp-tables tt_dwf_pagto_eletr_particip, tt_dwf_pagto_eletr_movto e tt_log_erros_extracao. Informar nos parâmetros de entrada os campos código do estabelecimento do EMS2, a data inicial e a data final para extrair os dados. Informar nos parâmetros de saída a tabela temporárias tt_dwf_pagto_eletr_particip, tt_dwf_pagto_eletr_movto e tt_log_erros_extracao.

2. Executar o programa API conforme exemplo de código a seguir:

def var v_hdl_programa as handle no-undo.

run prgfin/acr/acr575za.py persistent set v_hdl_programa.

run pi_extrair_pagto_eletronico in v_hdl_programa (input v_cod_estab_ems2, input v_dat_inicial, input param v_dat_final, output table tt_dwf_pagto_eletr_particip, output table tt_dwf_pagto_eletr_movto, output table tt_log_erros_extracao).

delete procedure v_hdl_programa.

3. Após a execução do programa, pode ser verificada se retornou algum erro durante o processo de importação através da temp-table tt_log_erros_extracao.

Parâmetros de entrada

v_cod_estab_ems2: Determina para qual Estabelecimento EMS2 será extraído os dados.

v_dat_inicial: Determina a data inicial que irá extrair os dados.

v_dat_final: Determina a data final que irá extrair os dados.

Tabelas Temporárias

Tabela Temporária

Descrição

Entrada/Saída

tt_dwf_pagto_eletr_particip

Conterá as informações do participante do pagamento eletrônico que será gerada, podendo ser da Instituição Financeira ou do Marketplace

Entrada/Saída

AtributoDescriçãoFormatoDescriçãoMandatórioObservação
ttv_cod_particip_instit_financcharacterx(30)Cod. ParticipanteSim
tta_nom_pessoacharacterx(40)NomeNão
tta_cod_paischaracterx(3)PaísNão
tta_nom_enderecocharacterx(40)EndereçoNão


def temp-table tt_dwf_pagto_eletr_particip no-undo
    field ttv_cod_particip_instit_financ   as character format "x(30)" label "Cód. Participante"
    field tta_nom_pessoa                       as character format "x(40)" label "Nome" column-label "Nome"
    field tta_cod_pais                             as character format "x(3)" label "País" column-label "Pa¡s"
    field tta_nom_endereco                   as character format "x(40)" label "Endereço" column-label "Endereço"
    index tt_dwf_pagto_partic                is primary unique
          ttv_cod_particip_instit_financ   ascending
    .





Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros

Conterá as informações de erros na integração dos movimentos

Saída

Atributo

Tipo

Formato

Descrição

ttv_num_seq

character

x(3)

Seq

ttv_num_cod_erro

Integer

>>>,>>9

Número Erro

ttv_des_erro

integer

>>>>,>>9

Incosistência

ttv_des_ajuda

character

x(50)

Ajuda

def temp-table tt_log_erros no-undo
    field ttv_num_seq                      as integer format ">>>,>>9" label "Seqˆncia" column-label "Seq"
    field ttv_num_cod_erro                 as integer format ">>>>,>>9" label "N£mero" column-label "N£mero"
    field ttv_des_erro                     as character format "x(50)" label "Inconsistˆncia" column-label "Inconsistˆncia"
    field ttv_des_ajuda                    as character format "x(50)" label "Ajuda" column-label "Ajuda"
    index tt_id                           
          ttv_num_seq                      ascending
          ttv_num_cod_erro                 ascending
    .