Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/apb/apb902ze


Objetivo

Efetuar a Inclusão/Pagamento dos títulos do “Contas a Pagar” via Lote ou Borderô.


Parâmetros

Parâmetro

Descrição

p_num_vers_integr_api

Será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API, neste caso é 1.

tt_integrapi_apb_pagto

 

Tabela temporária que conterá os dados do lote/borderô de pagamento a ser importado, incluindo os dados para atualização ou não do lote/borderô

tt_log_erros_atualiz

Tabela temporária que retorna os erros encontrados durante a atualização do lote/borderô e dos itens do lote/borderô;

tt_integrapi_bord_lote_pagto_1

Tabela temporária que conterá os dados dos itens (títulos) do lote/borderô a serem importados;

tt_integrapi_apb_abat_prev

Tabela temporária que conterá os dados dos abatimentos das previsões dos itens (títulos) do lote/borderô a serem importados;

tt_integrapi_apb_abat_antecip:

Tabela temporária que conterá os dados dos abatimentos das antecipações dos itens (títulos) do lote/borderô a serem importados;

tt_integrapi_apb_impto_impl_pendpend4

Tabela temporária que conterá os dados dos impostos utilizados no pagamento dos itens (títulos) do lote/borderô a serem importados;

[ p_cod_matriz_trad_org_ext ]

Deverá ser informada a Matriz de Tradução Organizacional. Caso não queira passá-la como parâmetro mandar brancos utilizando aspas ( ““ ).

Veja exemplo abaixo.

tt_integrapi_cambio_ems5

Contém os dados do Contrato de Câmbio.

tt_api_1099

Tabela temporária que conterá o Valor 1099, o Número da Taxa de Identificação e o Tipo de Transação 1099. Estes campos só podem ser utilizados pelos clientes da Datasul dos EUA.

tt_integrapi_apb_pagto_aux_1

Tabela temporária que conterá o log do lote/borderô de             pagamento a ser importado, que identifica se a baixa deve ser feita no estabelecimento do título ou do lote de pagamento.

tt_integrapi_apb_bord_lote_pg_att_params_generic_api

Tabela temporária que conterá o log de atualiza data de Vencimento dos impostos vinculados ao título.

tt_api_params_genericConterá campos novos das temp-tables passadas como parâmetro.

Observações:

  • AMatriz de Tradução Organizacional é Opcional. Caso for informada, será utilizada esta matriz ao invés da informada nos Parâmetros de Integração. A matriz tradução organizacional possui as matrizes de estabelecimento, Portador, Carteira Bancária e da Moeda que serão necessárias para o cadastro de itens do lote/borderô de pagamento.
  • Para liquidações com geração automática de impostos, se os documentos possuírem impostos de Pis, Cofins ou Csll, e essa baixa for realizada com abatimento de uma ou mais antecipações que já tenham sofrido a retenção desses impostos, o sistema fará automaticamente o acerto do rendimento tributável para desconsiderar do valor os impostos já retidos. Se os impostos forem calculados pela rotina específica, isto é, quando não há geração automática, o recálculo não será feito.

Funcionamento

A sintaxe para executar a API/BO em modo persistente é:

run prgfin/apb/apb902ze.py persistent set v_hdl_aux .

  • Para os dados bancários informados nos itens (banco, agência e conta corrente), os mesmos somente serão gravados nos itens do borderô, quando a forma de pagamento utilizada estiver parametrizada para "Não agrupar títulos do fornecedor".  Caso na forma de pagamento esteja parametrizado para "Agrupar títulos do fornecedor", mesmo que enviadas informações bancárias via pré-api, as mesmas não serão gravadas nos itens do borderô e será utilizada a conta bancária informada no cadastro de fornecedor financeiro para a realização do pagamento. 

Funcionamento

A sintaxe para executar a API/BO em modo persistente é:

run prgfin/apb/apb902ze.py persistent set v_hdl_aux .

run pi_main_code_run pi_main_code_api_integr_apb_pagto_4_evo_4 in 6 IN v_hdl_aux (Input 1,

                                             Input table tt_integr_apb_pagto,

                                             output table tt_log_erros_atualiz,

6,

                                                   Input table tt_api_apb_pagto,

                                                   Input table tt_api                                             Input table tt_integr_bord_lote_pagto_1,

                                             Input                                                    Input table tt_integrapi_apb_abat_prev,

                                             Input                                                    Input table tt_integrapi_apb_abat_antecip,

                                             Input                                                    Input table tt_integrapi_apb_impto_impl_pend,pend4,

                                                   Input                                              Input p_cod_matriz_trad_org_ext,

                                             Input                                                    Input table tt_integrapi_cambio_ems5,

                                             Input table tt_1099,

                                                   Input table tt_api_1099,

                                                   Input table tt_api                                             Input table tt_integr_apb_pagto_aux_1,

                                             Input                                                    Input table tt_integrapi_apb_bord_lote_pg_a,

                                             input                                                   input-output table tt_api_params_generic_api).

...

,

...

                                                   output table tt_log_erros_atualiz).


A variável denominada v_hdl_aux irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Retorno

A API

Retorno

A API retornará na tabela temporária tt_log_erros_atualiz todos os erros encontrados durante a atualização do lote/borderô e dos itens do lote/borderô.

...

Observações: Quando a API for executada por um programa externo, logo após a chamada da API, deverá ser criado um tratamento para impressão dos erros. E para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.

 

Tabelas Temporárias


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_apb_pagto

Conterá as informações do lote/borderô de pagamento.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_empresa

character


Código da Empresa é desconsiderado, assumindo a empresa do estabelecimento.



tta_cod_estab_refer

character


Código do Estabelecimento. Deverá receber valor somente para a criação do lote.



tta_cod_refer

character


Referência. Deverá receber valor somente para a criação do lote.



tta_cod_estab_bord

character


Código do Estabelecimento. Deverá receber valor somente para a criação do borderô.



tta_dat_transacao

date


Data Transação



tta_cod_indic_econ

character


Código do Indicador Econômico (Moeda).



tta_val_tot_lote_pagto_efetd

decimal


Total Lote Pagamento Efetuado



tta_val_tot_lote_pagto_infor

decimal


Total Lote já Informado.



tta_cdn_fornecedor

Integer


Código do Fornecedor. Opcional para a criação do lote.



tta_cdn_cliente

Integer


Código do Cliente.  Não utilizado



tta_cod_usuar_pagto

character


Deverá ser informado um usuário que está cadastrado no contas a pagar, e que tenha a liberações necessárias para efetuar pagamento, liberação e preparação.



tta_log_enctro_cta

logical


Lógico Encontro de Contas (APB x ACR). Não utilizado.



tta_val_tot_liquidac_tit_acr

decimal


Valor Total Liquidação Títulos ACR. Não utilizado.



tta_num_bord_ap

integer


Número Borderô. Deverá receber valor somente para a criação do borderô.



tta_cod_msg_inic

character


Código da Mensagem Inicial. Deverá receber valor somente para a criação do borderô.



tta_cod_msg_fim

character


Código da Mensagem Final. Deverá receber valor somente para a criação do borderô.



tta_log_bord_ap_escrit

logical


Borderô Escritural. Deverá receber valor somente para a criação do borderô. “S” / “N”.



tta_log_bord_ap_escrit_envdo

logical


Lógico Borderô “Enviado”. Deverá receber valor somente para a criação do borderô.  Sempre “N”.



tta_ind_tip_bord_ap

character


Indicador do Tipo de Borderô. Deverá receber valor somente para a criação do borderô. Sempre como “Normal”.



tta_cod_finalid_econ

character


Código da Finalidade Econômica.



tta_cod_cart_bcia

character


Carteira Bancária. Não utilizado.



tta_cod_livre_1

character


Atributo Livre 1 para uso interno. Não utilizado.



tta_cod_livre_2

character


Atributo Livre 2 para uso interno. Não utilizado



tta_dat_livre_1

date


Atributo Livre 1 para uso interno. Não utilizado



tta_dat_livre_2

date


Atributo Livre 2 para uso interno. Não utilizado.



tta_log_livre_1

logical


Atributo Livre 1 para uso interno. Não utilizado.



tta_log_livre_2

logical


Atributo Livre 2 para uso interno. Não utilizado.



tta_num_livre_1

integer


Atributo Livre 1 para uso interno. Não utilizado.



tta_num_livre_2

integer


Atributo Livre 2 para uso interno. Não utilizado.



tta_val_livre_1

decimal


Atributo Livre 1 para uso interno. Não utilizado.



tta_val_livre_2

decimal


Atributo Livre 2 para uso interno. Não utilizado.



ttv_log_atualiz_refer

logical


Deverá ser informado como (yes) quando se deseja atualizar o lote ou (no) quando não deseja atualizar o lote.  Em caso da não atualização do lote o mesmo ficará pendente no sistema e somente poderá ser atualizado via on-line.

Obs: Para o borderô este atributo não tem efeito, o borderô somente poderá ser atualizado via on-line, isto se faz necessário porque o borderô deverá ser impresso antes da sua atualização, sendo assim o mesmo ficará pendente no sistema.



ttv_log_gera_lote_parcial

logical


Deverá ser informado como (yes) quando se deseja atualizar o lote parcialmente ou (no) para o caso contrário. Ex.: Se um dos itens do lote/borderô de pagamento apresentar um erro, e este atributo estiver como (no), todo o lote será eliminado, mas se o mesmo estiver como (yes), somente os itens em questão será eliminado, e o restante do lote será atualizado.



ttv_ind_tip_atualiz

character


Deverá ser informado neste atributo o tipo de pagamento, sendo que o mesmo deverá receber o valor de “lote” quando a importação for para lote, e “borderô” quando a importação for via borderô, somente será considerado essas duas situações.



tta_cod_portador

character


Código do Portador. Deverá receber valor somente para a criação do borderô.



ttv_reccod_table_parent

recid

character

X(80)

Como sugestão, receber o STRING(ROWIDDeverá receber o recid(tt_integrapi_apb_pagto)tanto para lote como para borderô o processo é o mesmo.



tta_cod_estab_ext

character


Informa-se neste atributo o código do estabelecimento externo do título.

 Este campo será obrigatório se o campo tta_cod_estab_refer ou tta_cod_estab_bord não estiver preenchido.



tta_cod_portad_ext

character


Código do Portador Externo. Este campo deverá ser obrigatoriamente preenchido caso o campo tta_cod_portador não estiver preenchido.



tta_cod_modalid_ext

character


Código da Modalidade Externa. Não utilizado.



tta_cod_finalid_econ_ext

character


Código do Finalidade Econômica Externa. Este campo deverá ser obrigatoriamente preenchido caso o campo tta_cod_finalid_econ não estiver preenchido.



ttv_log_vinc_impto_auto

logical


Vincula Impostos PIS/COFINS/CSLL automaticamente.



...

Definição:

def temp-table tt_integrapi_apb_pagto no-undo

        field tta_cod_empresa                  as empresa                  as character

        field tta_cod_estab_refer              as refer              as character   

    field tta_cod_refer                    as refer                    as character

        field tta_cod_estab_bord               as bord               as character

        field tta_dat_transacao                as transacao                as date initial today

        field tta_cod_indic_econ               econ               as character

        field tta_val_tot_lote_pagto_efetd     efetd     as decimal initial 0   

    field tta_val_tot_lote_pagto_infor     infor     as decimal initial 0

        field tta_cdn_fornecedor               fornecedor               as Integer initial 0   

    field tta_cdn_cliente                  as cliente                  as Integer initial 0

        field tta_cod_usuar_pagto              as pagto              as character

        field tta_log_enctro_cta               cta               as logical initial no

        field tta_val_tot_liquidac_tit_acr     acr     as decimal initial 0

        field tta_num_bord_ap                  as ap                  as integer initial 0

        field tta_cod_msg_inic                 inic                 as character   

    field tta_cod_msg_fim                  as fim                  as character

        field tta_log_bord_ap_escrit           escrit           as logical initial no

        field tta_log_bord_ap_escrit_envdo     envdo     as logical initial no

        field tta_ind_tip_bord_ap              as ap              as character

        field tta_cod_finalid_econ             econ             as character   

    field tta_cod_cart_bcia                as bcia                as character

        field tta_cod_livre_1                  as 1                  as character   

    field tta_cod_livre_2                  as 2                  as character

        field tta_dat_livre_1                  as 1                  as date initial ?   

    field tta_dat_livre_2                  as 2                  as date initial ?

        field tta_log_livre_1                  as 1                  as logical initial no   

    field tta_log_livre_2                  as 2                  as logical initial no

        field tta_num_livre_1                  as 1                  as integer initial 0   

    field tta_num_livre_2                  as 2                  as integer initial 0

        field tta_val_livre_1                  as 1                  as decimal initial 0   

    field tta_val_livre_2                  as 2                  as decimal initial 0

        field ttv_log_atualiz_refer            as refer            as logical initial no

        field ttv_log_gera_lote_parcial        as parcial        as logical initial no

        field ttv_ind_tip_atualiz              as atualiz              as character

        field tta_cod_portador                 portador                 as character

        field ttv_reccod_table_parent             as recidparent             as character

        field tta_cod_estab_ext                as ext                as character

        field tta_cod_portad_ext               ext               as character   

    field tta_cod_modalid_ext              as ext              as character

        field tta_cod_finalid_econ_ext         ext         as character

        field ttv_log_vinc_impto_auto          as auto          as logical initial no

        index tt_rec_index                     index                     is primary unique

                    ttv_reccod_table_parent             parent             ascending
        .    


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_bord_lote_pagto_1

Conterá as informações dos itens(títulos) do lote/borderô de pagamento.

Entrada

...

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_empresa

character

x(3)

Código da Empresa.



ttv_cod_estab_bord_refer

character

x(8)

Código do Estabelecimento.Deverá receber os seguintes valores: quando o pagamento for via borderô (tt_integrapi_apb_pagto.tta_cod_estab_bord), e Quando o pagamento for via lote (tt_integrapi_apb_pagto.tta_cod_estab_refer).



tta_cod_refer

character

x(10)

Código de Referência. Deverá receber valor somente para a criação de itens (títulos) do lote.



tta_cod_portador

character

x(5)

Código do Portador.



tta_cod_refer_antecip_pef

character

x(10)

Código de Referencia Pagamento Extra Fornecedor Pendente. Receberá valor somente se for Pagamento Extra Fornecedor.



tta_cod_estab

character

x(3) / x(5)*

Código do Estabelecimento.



tta_cod_espec_docto

character

x(3)

Código da Espécie do Documento. Não receberá valor se for PEF ou Antecipação.



tta_cod_ser_docto

character

x(3)/x(5)**

Código da Série Documento. Não receberá valor se for PEF ou Antecipação.



tta_cdn_fornecedor

Integer

>>>,>>>,>>9

Código do Fornecedor. Não receberá valor se for PEF ou Antecipação.



tta_cod_tit_ap

character

x(10)/x(16)**

Código do Título. Não receberá valor se for PEF ou Antecipação.



tta_cod_parcela

character

x(02)

Parcela.



tta_dat_cotac_indic_econ

date

99/99/9999

Data Cotação.



tta_val_cotac_indic_econ

decimal

>>>>,>>9.9999999999

Valor da Cotação no Índice econômico.



tta_val_pagto

decimal

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

Valor Pagamento.



tta_val_multa_tit_ap

decimal

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

Valor Multa.



tta_val_juros

decimal

>>>>,>>>,>>9.99

Valor Juros.



tta_val_cm_tit_ap

decimal

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

Valor Correção Monetária.



tta_val_desc_tit_ap

decimal

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

Valor Desconto.



tta_val_abat_tit_ap

decimal

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

Valor Abatimento.



tta_des_text_histor

character

x(2000)

Texto Histórico (padrão ou informado).



tta_cod_banco

character

x(8)

Código do Banco. Não utilizado.



tta_cod_forma_pagto

character

x(3)

Código da Forma Pagamento. Deverá receber valor somente para a criação de itens (títulos) do borderô.



tta_cod_forma_pagto_altern

character

x(3)

Código da Forma Pagamento Alternativa.



tta_val_pagto_inic

decimal

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

Valor Pagamento Inicial. Não utilizado.



tta_val_desc_tit_ap_inic

decimal

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

Valor Desconto Inicial. Não utilizado.



tta_val_pagto_orig_inic

decimal

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

Valo Pagamento no Índice Econ. de Origem Inicial. Não utilizado.



tta_val_desc_tit_ap_orig_inic

decimal

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

Valor Original de Desconto no Índice Econ. do Título Inicial. Não utilizado.



tta_cod_docto_bco_pagto

character

x(20)

Código do Título no Banco de Pagamento.



tta_ind_sit_item_bord_ap

character

X(9)

Situação do Item do Borderô no contas a pagar. Não utilizado.



tta_log_critic_atualiz_ok

logical

Sim/Não

Lógico Crítica Atualização OK.   Informar sempre “N”.



tta_cod_estab_cheq

character

x(3) / x(5)*

Código do Estabelecimento Cheque. Não utilizado.



tta_num_seq_item_cheq

integer

>>>9

Seqüência Item Cheque. Não utilizado.



tta_cod_finalid_econ

character

x(10)

Código da Finalidade Econômica.



tta_num_talon_cheq

integer

>>>,>>>,>>9

Número Talonário Cheques. Deverá receber valor somente para a criação de itens (títulos) do lote.



tta_num_cheque

integer

>>>>,>>>,>>9

Número Cheque. Deverá receber valor somente para a criação de itens (títulos) do lote.



tta_ind_favorec_cheq

character

X(15)

Deverá receber os seguintes valores “Portador”, “Fornecedor” e “Outros”, esta informação se faz necessária quando o pagamento for efetuado via portador /banco.  Caso o atributo seja “Outros”, o atributo tta_nom_favored_cheq deverá ser informado. Deverá receber valor somente para a criação de itens (títulos) do lote caso for pagamento em cheque.



tta_nom_favorec_cheq

character

x(40)

Nome Favorecido Cheque.



tta_cod_indic_econ

character

x(8)

Indicador Econômico (Moeda). Deverá receber valor somente para a criação de itens (títulos) do lote.



tta_val_variac_cambial

decimal

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

Valor Variação Cambial. Deverá receber valor somente para a criação de itens (títulos) do lote.



tta_ind_sit_item_lote_bxa_ap

character

X(9)

Situação do Item do Lote de Baixa. Não utilizado.



tta_cod_cart_bcia

character

x(3)

Carteira Bancária. Não utilizado.



tta_cod_livre_1

character

x(100)

Atributo Livre 1 para uso interno. Não utilizado.



tta_cod_livre_2

character

x(100)

Atributo Livre 2 para uso interno. Não utilizado.



tta_dat_livre_1

date

99/99/9999

Este campo será utilizado para informar a Data de Pagamento do título, portando caso não seja gravado nenhuma informação o programa assume a data conforme regra de negócio.



tta_dat_livre_2

date

99/99/9999

Atributo Livre 2 para uso interno. Não utilizado.



tta_num_livre_1

integer

>>>>>9

Atributo Livre 1 para uso interno. Não utilizado



tta_num_livre_2

integer

>>>>>9

Atributo Livre 2 para uso interno. Não utilizado.



tta_val_livre_1

decimal

>>>,>>>,>>9.9999

Atributo Livre 1 para uso interno. Não utilizado



tta_val_livre_2

decimal

>>>,>>>,>>9.9999

Atributo Livre 2 para uso interno. Não utilizado.



tta_log_livre_1

logical

Sim/Não

Atributo Livre 1 para uso interno. Não utilizado



tta_log_livre_2

logical

Sim/Não

Atributo Livre 2 para uso interno. Não utilizado.



ttv_ind_forma_pagto

character

X(18)

Somente deverá receber valor para pagamento via borderô, onde somente dois valores serão validos, “informada” isto quer dizer que a forma de pagamento virá na temp-table, caso seja “não informada” isto quer dizer que a forma de pagamento utilizada é a mesma cadastrada para o título.

Isto não se aplica para o lote de pagamento.



ttv_reccod_table_child

recid

>>>>>>9

character

x(80)

Como sugestão, receber o string(ROWIDDeverá receber o recid(tt_integr_apbapi_bord_lote_pagto_1)).



ttv_reccod_table_parent

recid

character

x(80)>>>>>>9

Deverá receber o atributo (tt_integrapi_apb_pagto.ttv_reccod_table_parent) para que haja relacionamento entre as temp-tables.



tta_cod_portad_ext

character

x(8)

Código  do Portador Externo. Esta campo deverá ser obrigatoriamente preenchido caso o campo tta_cod_portador não estiver preenchido.



tta_cod_modalid_ext

character

x(8)

Código  da Modalidade Externa. Não utilizado



tta_cod_finalid_econ_ext

character

x(8)

Código do Finalidade Econômica Externa. Esta campo deverá ser obrigatoriamente preenchido caso o campo tta_cod_finalid_econ não estiver preenchido.



tta_cod_agenc_bcia

charácter

X(10)

Código da Agencia Bancária.



tta_cod_digito_agenc_bcia

charácter

X(2)

Digito da Agencia Bancária.



tta_cod_cta_corren_bco

charácter

X(20)

Código da conta corrente.



tta_cod_digito_cta_corren

Carácter

X(20)

Digito da Conta corrente.



...

Definição:

def temp-table tt_integrapi_bord_lote_pagto_1 no-undo

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

        field ttv_cod_estab_bord_refer         refer         as character format "x(8)"

        field tta_cod_refer                    as refer                    as character format "x(10)" label "Referência" column-label "Referência"

        field tta_cod_portador                 portador                 as character format "x(5)" label "Portador" column-label "Portador"

        field tta_cod_refer_antecip_pef        as pef        as character format "x(10)" label "Ref Antec PEF Pend" column-label "Ref Antec PEF Pend"

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

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

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

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

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

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

        field tta_dat_cotac_indic_econ         econ         as date format "99/99/9999" initial ? label "Data Cotação" column-label "Data Cotação"

        field tta_val_cotac_indic_econ         econ         as decimal format ">>>>,>>9.9999999999" decimals 10 initial 0 label "Cotação" column-label "Cotação"

        field tta_val_pagto                    as pagto                    as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Pagamento" column-label "Valor Pagto"

        field tta_val_multa_tit_ap             ap             as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Multa" column-label "Valor Multa"

        field tta_val_juros                    as juros                    as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Juros" column-label "Valor Juros"

        field tta_val_cm_tit_ap                as ap                as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Val Correção Monet" column-label "Val Corr Monet"

        field tta_val_desc_tit_ap              as ap              as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Desconto" column-label "Vl Desconto"

        field tta_val_abat_tit_ap              as ap              as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Abatimento" column-label "Vl Abatimento"

        field tta_des_text_histor              as histor              as character format "x(2000)" label "Histórico" column-label "Histórico"

        field tta_cod_banco                    as banco                    as character format "x(8)" label "Banco" column-label "Banco"

        field tta_cod_forma_pagto              as pagto              as character format "x(3)" label "Forma Pagamento" column-label "F Pagto"

        field tta_cod_forma_pagto_altern       altern       as character format "x(3)" label "Forma Pagamento" column-label "F Pagto Alt"

        field tta_val_pagto_inic               inic               as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Pagto Inic" column-label "Vl Pagto Inic"

        field tta_val_desc_tit_ap_inic         inic         as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Desc Inic" column-label "Vl Desc Inic"

        field tta_val_pagto_orig_inic          as inic          as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Pagto Orig Inic" column-label "Vl Pagto Orig Inic"

        field tta_val_desc_tit_ap_orig_inic    as inic    as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Orig Descto" column-label "Vl orig Descto"

        field tta_cod_docto_bco_pagto          as pagto          as character format "x(20)" label "Tit Bco Pagto" column-label "Tit Bco Pagto"

        field tta_ind_sit_item_bord_ap         ap         as character format "X(9)" label "Situação" column-label "Situação"

        field tta_log_critic_atualiz_ok        as ok        as logical format "Sim/Não" initial no label "Crítica OK" column-label "Crítica OK"

        field tta_cod_estab_cheq               cheq               as character format "x(5)" label "Estabelec Cheque" column-label "Estabelec Cheque"

        field tta_num_seq_item_cheq            as cheq            as integer format ">>>9" initial 0 label "Sequência Item Cheq" column-label "Seq"

        field tta_cod_finalid_econ             econ             as character format "x(10)" label "Finalidade" column-label "Finalidade"

        field tta_num_talon_cheq               cheq               as integer format ">>>,>>>,>>9" initial 0 label "Talonário Cheques" column-label "Talonário Cheques"

        field tta_num_cheque                   cheque                   as integer format ">>>>,>>>,>>9" initial ? label "Num Núm Cheque" column-label "Num Cheque"

        field tta_ind_favorec_cheq             cheq             as character format "X(15)" initial "Portador" label "FavorecidoFavorec" column-label "FavorecidoFavorec"
        field tta_nom_favorec_cheq             cheq             as character format "x(40)" label "Nome Favorecido" column-label "Nome Favorecido"

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

        field tta_val_variac_cambial           cambial           as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Varic Cambial" column-label "Variac Cambial"

        field tta_ind_sit_item_lote_bxa_ap     ap     as character format "X(9)" initial "Gerado" label "Situação" column-label "Situação"

        field tta_cod_cart_bcia                as bcia                as character format "x(3)" label "Carteira" column-label "Carteira"

        field tta_cod_livre_1                  as 1                  as character format "x(100)" label "Livre 1" column-label "Livre 1"

        field tta_cod_livre_2                  as 2                  as character format "x(100)" label "Livre 2" column-label "Livre 2"

        field tta_dat_livre_1                  as 1                  as date format "99/99/9999" initial ? label "Livre 1" column-label "Livre 1"

        field tta_dat_livre_2                  as 2                  as date format "99/99/9999" initial ? label "Livre 2" column-label "Livre 2"

        field tta_num_livre_1                  as 1                  as integer format ">>>>>9" initial 0 label "Livre 1" column-label "Livre 1"

        field tta_num_livre_2                  as 2                  as integer format ">>>>>9" initial 0 label "Livre 2" column-label "Livre 2"

        field tta_val_livre_1                  as 1                  as decimal format ">>>,>>>,>>9.9999" decimals 4 initial 0 label "Livre 1" column-label "Livre 1"

        field tta_val_livre_2                  as 2                  as decimal format ">>>,>>>,>>9.9999" decimals 4 initial 0 label "Livre 2" column-label "Livre 2"

        field tta_log_livre_1                  as 1                  as logical format "Sim/Não" initial no label "Livre 1" column-label "Livre 1"

        field tta_log_livre_2                  as 2                  as logical format "Sim/Não" initial no label "Livre 2" column-label "Livre 2"

        field ttv_ind_forma_pagto              as pagto              as character format "X(18)" initial "Assume do Título"

        field ttv_reccod_table_child              as recid format ">>>>>>9"    child              as character format "x(80)"

    field ttv_reccod_table_parent             as recid format ">>>>>>9"parent             as character format "x(80)"

        field tta_cod_portad_ext               ext               as character format "x(8)" label "Portador Externo" column-label "Portador Externo"

        field tta_cod_modalid_ext              as character format ext              as character format "x(8)" label "Modalidade Externa" column-label "Modalidade Externa"

        field tta_cod_finalid_econ_ext         ext         as character format "x(8)" label "Finalid Econ Externa" column-label "Finalidade Externa"

        field tta_cod_agenc_bcia               bcia               as character format "x(10)" label "Agência Bancária" column-label "Agência Bancária"

        field tta_cod_digito_agenc_bcia        as bcia        as character format "x(2)" label "Dígito Ag Bcia" column-label "Dig Ag"

        field tta_cod_cta_corren_bco           bco           as character format "x(20)" label "Conta Corrente Banco" column-label "Conta Corrente Banco"

        field tta_cod_digito_cta_corren        as corren        as character format "x(2)" label "Dígito Cta Corrente" column-label "Dígito Cta Corrente"

        index tt_rec_index                     index                     is primary unique

                    ttv_reccod_table_parent             parent             ascending         

          ttv_reccod_table_child              ascending    child              ascending
    .


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_apb_abat_antecip

Conterá as informações das antecipações utilizadas nos itens(títulos) do lote/borderô de pagamento.

Entrada

...

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab

character

x(3) / x(5)*

Estabelecimento.



tta_cod_espec_docto

character

x(3)

Espécie Documento.



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento.



tta_cdn_fornecedor

Integer

>>>,>>>,>>9

Fornecedor.



tta_cod_tit_ap

character

x(10)/x(16)**

Título.



tta_cod_parcela

character

x(02)

Parcela.



tta_val_abat_tit_ap

decimal

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

Valor Abatimento.



ttv_reccod_integr_apb_item_lote

recid

>>>>>>9

character

x(80)

Relaciona as informações de Abatimento das antecipações utilizadas nos itens(títulos) do lote/borderô de pagamento ao item (título) do lote de pagamento.

Deverá receber o valor do atributo (tt_integr_apbapi_bord_lote_pagto_1.ttv_reccod_table_  child), para que haja relacionamento entre a temp-table de itens lote/borderô e esta temp-table.



...

Definição:

def temp-table tt_integrapi_apb_abat_antecip no-undo

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

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

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

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

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

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

        field tta_val_abat_tit_ap              as ap              as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Abatimento" column-label "Vl Abatimento"

    field   field ttv_reccod_integr_apb_item_lote     lote     as recid character format ">>>>>>9x(80)"
        .


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_apb_abat_prev

Conterá as informações das previsões utilizados nos itens do lote de pagamento.

Entrada

...

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab

character

x(3) / x(5)*

Estabelecimento.



tta_cod_espec_docto

character

x(3)

Espécie Documento.



tta_cod_ser_docto

character

x(3)/x(5)**

Série Documento.



tta_cdn_fornecedor

Integer

>>>,>>>,>>9

Fornecedor.



tta_cod_tit_ap

character

x(10)/x(16)**

Título.



tta_cod_parcela

character

x(02)

Parcela.



tta_val_abat_tit_ap

decimal

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

Valor Abatimento.



ttv_reccod_integr_apb_item_lote

recid

>>>>>>9

character

x(80)

Deverá receber o valor do atributo (tt_api_bord_lote_pagto_1.ttv_cod_table_child), para que haja relacionamento entre a temp-table de itens lote/borderô e esta temp-table Recid.




Definição:

def temp-table tt_integrapi_apb_abat_prev no-undo

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

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

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

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

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

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

        field tta_val_abat_tit_ap              as ap              as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Abatimento" column-label "Vl Abatimento"

        field ttv_reccod_integr_apb_item_lote     lote     as recid character format ">>>>>>9x(80)"

        .


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_apb_impto_impl_pendpend4

Conterá as informações dos impostos utilizados pelos itens(títulos) do lote/borderô de pagamento.

Entrada

...

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_reccod_integr_apb_item_lote

recid

character

x(80)>>>>>>9

 Deverá receber o valor do atributo (tt_integr_apbapi_bord_lote_pagto_1.ttv_reccod_table_child), para que haja relacionamento entre a temp-tables de itens lote/borderô e esta temp-table.



ttv_reccod_antecip_pef_pend

recid

character

x(80)>>>>>>9

 Relaciona as informações dos impostos utilizados pelos itens(títulos) do lote/borderô de pagamento a antecipação ou pagamento extra fornecedor que se está implantando. Se não, informar ?.



ttatta_cod_pais

character

x(3)

Código País.



tta_cod_unid_federac

character

x(3)

Unidade Federação.



tta_cod_imposto

character

x(5)

Código Imposto.



tta_cod_classif_impto

character

x(05)

Código da Classificação do Imposto.



tta_ind_clas_impto

character

X(14)

Indicador da Classe do Imposto.



tta_cod_plano_cta_ctbl

character

x(8)

Código do Plano de Contas. Não utilizado.



tta_cod_cta_ctbl

character

x(20)

Código da Conta Contábil. Não utilizado.



tta_cod_espec_docto

character

x(3)

Código da Espécie do Documento.



tta_cod_ser_docto

character

x(3)/x(5)**

Código da Série do Documento.



tta_cod_tit_ap

character

x(10)/x(16)**

Código do Título.



tta_cod_parcela

character

x(02)

Parcela.



tta_val_rendto_tribut

decimal

>,>>>,>>>,>>9.99

Valor do Rendimento Tributável.



tta_val_deduc_inss

decimal

>,>>>,>>>,>>9.99

Valor da Dedução INSS.



tta_val_deduc_depend

decimal

>,>>>,>>>,>>9.99

Valor da Dedução de Dependentes.



tta_val_deduc_pensao

decimal

>,>>>,>>>,>>9.99

Valor Dedução Pensão.



tta_val_outras_deduc_impto

decimal

>,>>>,>>>,>>9.99

Valor de Outras Deduções.



tta_val_base_liq_impto

decimal

>,>>>,>>>,>>9.99

Valor da Base Líquida Imposto.



tta_val_aliq_impto

decimal

>9.99

Valor da Alíquota.



tta_val_impto_ja_recolhid

decimal

>,>>>,>>>,>>9.99

Valor do Imposto Já Recolhido.



tta_val_imposto

decimal

>,>>>,>>>,>>9.99

Valor Imposto.



tta_dat_vencto_tit_ap

date

99/99/9999

Data Vencimento.



tta_cod_indic_econ

character

x(8)

Código do Indicador Econômico (Moeda).



tta_val_impto_indic_econ_impto

decimal

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

Valor do Imposto no Indicador Econômico do Imposto.



tta_des_text_histor

character

x(2000)

Texto do Histórico (Padrão ou Informado).



tta_cdn_fornec_favorec

Integer

>>>,>>>,>>9

Código do Fornecedor Favorecido.



tta_val_deduc_faixa_impto

decimal

>,>>>,>>>,>>9.99

Valor Dedução na Faixa do Imposto.



tta_num_id_tit_ap

integer

1E+10

Número de Identificação do Título a Pagar implantado.



tta_num_id_movto_tit_ap

integer

1E+10

Número de Identificação do Movimento gerado pela implantação do Titulo a Pagar.



tta_num_id_movto_cta_corren

integer

1E+10

Número de Identificação do Movimento da Conta Corrente gerado no Caixa e Bancos pelo movimento de implantação do Titulo a Pagar.



tta_cod_pais_ext

character

x(20)

Código do país Externo. Não utilizado.



tta_cod_cta_ctbl_ext

character

x(20)

Código da Conta Contábil Externa. Não utilizado.



tta_cod_sub_cta_ctbl_ext

character

x(15)

Código da Subconta Externa. Este campo deverá ser obrigatoriamente preenchido caso o campo tta_cod_cta_ctbl_ext estiver preenchido.



ttv_cod_tip_fluxo_financ_ext

character

x(12)

Código do Tipo Fluxo Financeiro Externo. Não utilizado.



ttv_cod_table_child

character

x(80)

Deverá receber a string(rowid(tt_api_apb_impto_impl_pend4))




Definição:

def temp-table tt_integrapi_apb_impto_impl_pend pend4 no-undo

      field field ttv_reccod_integr_apb_item_lote     lote     as recid character format ">>>>>>9x(80)"   

    field ttv_reccod_antecip_pef_pend         as recid format ">>>>>>9"pend         as character format "x(80)"

        field tta_cod_pais                     pais                     as character format "x(3)" label "País" column-label "País"

        field tta_cod_unid_federac             federac             as character format "x(3)" label "Unidade Federa‡ãoEstado" column-label "UF"

        field tta_cod_imposto                  as character imposto                  as character format "x(5)" label "Imposto" column-label "ImpostoImp"

        field tta_cod_classif_impto            as impto            as character format "x(05)" initial "00000" label "Class Classificação Imposto" column-label "Class Classif Imposto"

        field tta_ind_clas_impto               impto               as character format "X(14)" initial "Retido" label "Classe Imposto" column-label "Classe Imposto"

        field tta_cod_plano_cta_ctbl           ctbl           as character format "x(8)" label "Plano Contas" column-label "Plano Contas"

        field tta_cod_cta_ctbl                 ctbl                 as character format "x(20)" label "Conta Cont bilContábil" column-label "Conta Cont bilContábil"

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

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

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

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

        field tta_val_rendto_tribut            as tribut            as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Rendto Tribut velTributável" column-label "Vl Rendto Tribut"

        field tta_val_deduc_inss               inss               as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Dedu‡ão Dedução Inss" column-label "Dedu‡ão Dedução Inss"

        field tta_val_deduc_depend             depend             as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Dedu‡ão Dedução Dependentes" column-label "Dedu‡ão Dedução Dependentes"

        field tta_val_deduc_pensao             pensao             as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Deducao Dedução Pensão" column-label "Deducao Dedução Pensão"

        field tta_val_outras_deduc_impto       impto       as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Outras Dedu‡äesDeduções" column-label "Outras Dedu‡äesDeduções"

        field tta_val_base_liq_impto           impto           as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Base Líquida Imposto" column-label "Base Líquida Imposto"

        field tta_val_aliq_impto               impto               as decimal format ">9.999999" decimals 2 4 initial 0.00 label "Alíquota" column-label "Aliq"

        field tta_val_impto_ja_recolhid        as recolhid        as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Imposto Recolhido" column-label "Imposto Recolhido"

        field tta_val_imposto                  as imposto                  as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Imposto" column-label "Vl Imposto"

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

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

        field tta_val_impto_indic_econ_impto   impto   as decimal format "->>>,>>>,>>9.99" decimals 2 initial 0 label "Val Finalid Impto" column-label "Val Finalid Impto"

        field tta_des_text_histor              as histor              as character format "x(2000)" label "Hist¢ricoHistórico" column-label "Hist¢ricoHistórico"

        field tta_cdn_fornec_favorec           favorec           as Integer format ">>>,>>>,>>9" initial 0 label "Fornec Favorecido" column-label "Fornec Favorecido"

        field tta_val_deduc_faixa_impto        as impto        as decimal format ">,>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Deducao" column-label "Valor Dedu‡ãoDedução"

        field tta_num_id_tit_ap                as ap                as integer format "9999999999999999999" initial 0 label "Token Tit Tít AP" column-label "Token Tit Tít AP"

        field tta_num_id_movto_tit_ap          as ap          as integer format "9999999999" initial 0 label "Token Movto Tit Tít AP" column-label "Id Tit Tít AP"

        field tta_num_id_movto_cta_corren      as corren      as integer format "9999999999999999999" initial 0 label "ID Movto Conta" column-label "ID Movto Conta"

        field tta_cod_pais_ext                 ext                 as character format "x(20)" label "País Externo" column-label "País Externo"

        field tta_cod_cta_ctbl_ext             ext             as character format "x(20)" label "Conta Contab Extern" column-label "Conta Contab Extern"

        field tta_cod_sub_cta_ctbl_ext         ext         as character format "x(15)" label "Sub Conta Externa" column-label "Sub Conta Externa"

        field ttv_cod_tip_fluxo_financ_ext     ext     as character format "x(12)" label "Tipo Fluxo Financ" column-label "Tipo Fluxo Financ"

    field ttv_cod_table_child              as character format "x(80)"

        index tt_impto_impl_pend_ap_integr     integr     is primary unique

                    ttv_reccod_integr_apb_item_lote     lote     ascending

                    tta_cod_pais                     ascending

          pais                     ascending          tta_cod_unid_federac             federac             ascending         

          tta_cod_imposto                  ascending

          imposto                  ascending          tta_cod_classif_impto            ascendingimpto            ascending

        index tt_impto_impl_pend_ap_integr_ant is uniqueant 

                    ttv_reccod_antecip_pef_pend         pend         ascending

                    tta_cod_pais                     ascending

          pais                     ascending          tta_cod_unid_federac             federac             ascending         

          tta_cod_imposto                  ascending

          ttaimposto                  ascending          tta_cod_classif_impto            ascendingimpto            ascending

        .


Tabela Temporária

Descrição

Entrada/Saída

tt_logapi_erroscambio_atualiz

Conterá as informações referentes aos erros encontrados durante as validações para a criação dos títulos.

ems5

Contém os dados do Contrato de Câmbio

EntradaSaída


(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttattv_cod_table_estabchild

character

x(80)




ttv_cod_table_parent

character

3) / x(580)*

Estabelecimento




ttattv_cod_contrat_refercambio

character

x(1015)

Referência

tta_num_seq_refer

integer

>>>9

Código do Contrato de Câmbio



ttv_dat_contrat_cambio_import

date

99/99/9999

Data do Contrato de Câmbio ImportaçãoSequência



ttv_num_contrat_id_mensagemcambio

integer

>>>>,>>9999999999

Número Identificador do erroContrato de Câmbio



ttv_descod_estab_msgcontrat_errocambio

character

x(3) / x(605)*

Estabelecimento do Contrato de CâmbioMensagem Erro



ttv_cod_desrefer_msgcontrat_ajudacambio

character

x(4010)

Mensagem AjudaReferência do Contrato de Câmbio



ttv_inddat_tip_relacto

character

X(15)

Tipo Relacionamento

ttv_num_relacto

integer

>>>>,>>9

refer_contrat_cambio

date

99/99/9999

Data de Referência do Contrato de CâmbioRelacionamento




Definição:

def temp-table tt_logapi_erroscambio_atualiz ems5 no-undo

        field ttattv_cod_estab                    as _table_child              as character format "x(580)" label "Estabelecimento" column-label "Estab"    field tta_cod_refer                   

    field ttv_cod_table_parent             as character format "x(10)" label "Referência" column-label "Referência80)"   

    field ttattv_numcod_seq_refer                as integer format ">>>9" initial 0 label "Sequência" column-label "Seq"

    field ttv_num_mensagem                 as integer format ">>>>,>>9" label "Número" column-label "Número Mensagem"

    field ttv_des_msg_erro                 as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"

contrat_cambio           as character format "x(15)"

    field ttv_dat_contrat_cambio_import    as date format "99/99/9999"

    field ttv_num_contrat_id_cambio        as integer format "999999999"

    field ttv_cod_estab_contrat_cambio         field ttv_des_msg_ajuda                as character format "x(40)" label "Mensagem Ajuda" column-label "Mensagem Ajuda"    field ttv_ind_tip_relacto              5)"

    field ttv_cod_refer_contrat_cambio     as character format "Xx(1510)" label "Tipo Relacionamento" column-label "Tipo Relac"

    field ttv_num_relacto                  as integer format ">>>>,>>9" label "Relacionamento" column-label "Relacionamento"

    .

Tabela Temporária

Descrição

Entrada/Saída

tt_integr_cambio_ems5

Contém os dados do Contrato de Câmbio

Entrada

(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

...

Atributo

...

Tipo

...

Formato

...

Descrição

...

Obrig.

...

Evol.

    field ttv_dat_refer_contrat_cambio     as date format "99/99/9999"

    index tt_rec_index                     is primary unique

          ttv_cod_table_parent             ascending

          ttv_cod_table_child              ascending
    .


Tabela Temporária

Descrição

Entrada/Saída

tt_api_1099

Foi incluída nesta evolução para a api_integr_apb_pagto_2. Para que a API faça o tratamento do 1099 para os clientes dos EUA.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_cod_table_parent

character

X(80)




ttv_val_1099

decimal

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




tta_cod_tax_ident_number

character

x(15)

Tax Id Number



tta_ind_tip_trans_1099

character

X(50)

Tipo Transacao 1099




...

ttv_rec_table_child

...

recid

...

>>>>>>9

...

ttv_rec_table_parent

...

recid

...

>>>>>>9

...

ttv_cod_contrat_cambio

...

char

...

x(15)

...

Código do Contrato de Câmbio

...

ttv_dat_contrat_cambio_import

...

date

...

99/99/9999

...

Data do Contrato de Câmbio Importação

...

ttv_num_contrat_id_cambio

...

integer

...

999999999

...

Identificador do Contrato de Câmbio

...

ttv_cod_estab_contrat_cambio

...

char

...

x(3) / x(5)*

...

Estabelecimento do Contrato de Câmbio

...

ttv_cod_refer_contrat_cambio

...

char

...

x(10)

...

Referência do Contrato de Câmbio

...

ttv_dat_refer_contrat_cambio

...

date

...

99/99/9999

...

Data de Referência do Contrato de Câmbio

Definição:

def temp-table tt_integrapi_cambio_ems5 1099 no-undo

        field ttv_reccod_table_child              as recid format ">>>>>>9"    parent             as character format "x(80)"

    field ttv_val_1099                     as decimal format "->>,>>>,>>>,>>9.99" decimals 2

    field tta_cod_tax_ident_number         rec_table_parent             as recid format ">>>>>>9"    field ttv_cod_contrat_cambio           as character format "x(15)"

    field ttv_dat_contrat_cambio_import    as date format "99/99/9999"

    field ttv_num_contrat_id_cambio        as integer format "999999999"

    field ttv_cod_estab_contrat_cambio     as character format "x(5)"

    field ttv_cod_refer_contrat_cambio     as character format "x(10)"

    field ttv_dat_refer_contrat_cambio     as date format "99/99/9999"

    index tt_rec_index                     is primary unique

          ttv_rec_table_parent             ascending

          ttv_rec_table_child              ascending

label "Tax Id Number" column-label "Tax Id Number"

    field tta_ind_tip_trans_1099           as character format "X(50)" initial "Rents" label "Tipo Transacao 1099" column-label "Tipo Transacao 1099"

    index tt_rec_index                     is primary unique

          ttv_cod_table_parent             ascending
        .


Tabela Temporária

Descrição

Entrada/Saída

tt_1099Foi incluída nesta evolução para a api_integr_apb_pagto_2. Para que a API faça o tratamento do 1099 para os clientes dos EUA.

Entrada

_aux_1

Tabela temporária que conterá o log do lote/borderô de pagamento a ser importado, que identifica se a baixa deve ser feita no estabelecimento do título ou do lote de pagamento.

Entrada

AtributoAtributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_reccod_table_parentparent 

recid

>>>>>>9

ttv_val_1099

decimal

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

tta_cod_tax_ident_number

character

x(15)

Tax Id Number

tta_ind_tip_trans_1099

character

X(50)

Tipo Transacao 1099

character

x(80)

Deverá receber tt_api_apb_pagto.ttv_cod_table_parent. Tanto para lote como para borderô o processo é o mesmo.



tta_log_bxa_estab_tit_ap

logical

Sim/Não

Deverá ser informado como (yes) quando se deseja que o lote do pagamento ou borderô considerem o estabelecimento do título para a baixa, ou (no) para não considerar o estabelecimento do título, ou seja, considera              o estabelecimento do próprio lote ou borderô.



tta_log_bord_darf

logical

Sim/Não

Indica que é um borderô de DARF.



tta_log_bord_gps

logical

Sim/Não

Indica que é um borderô de GPS.




Definição:

def temp-table tt_1099 _api_apb_pagto_aux_1 no-undo

        field ttv_reccod_table_parent             as recid format ">>>>>>9"

    field ttv_val_1099                     as decimal format "->>,>>>,>>>,>>9.99" decimals 2

    field tta_cod_tax_ident_number         as character format "x(15)" label "Tax Id Number" column-label "Tax Id Number"

    field tta_ind_tip_trans_1099           as character format "X(50)" initial "Rents" label "Tipo Transacao 1099" column-label "Tipo Transacao 1099"

    index tt_rec_index                     is primary unique

          ttv_rec_table_parent             ascending

parent             as character format "x(80)"

    field tta_log_bxa_estab_tit_ap         as logical format "Sim/Não" initial no label "Baixa Estabelec" column-label "Baixa Estabelec"

    field tta_log_bord_darf                as logical format "Sim/Não" initial no label "Borderô DARF" column-label "Borderô DARF"

    field tta_log_bord_gps                 as logical format "Sim/Não" initial no label "Bordero GPS" column-label "Bordero GPS"
        .


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_apb_pagtobord_lote_auxpg_1a

Tabela temporária que conterá o log do lote/borderô de pagamento a ser importado, que identifica se a baixa deve ser feita no estabelecimento do título ou do lote de pagamentode atualiza data de Vencimento dos impostos vinculados ao titulo.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_reccod_table_parent

recid

>>>>>>9

Deverá receber o recid (tt_integr_apb_pagto) tanto para lote como para borderô o processo é o mesmo.

character

x(80)




ttvtta_log_bxaatualiz_estabtit_titimpto_apvinc

logical

Sim/NãoDeverá ser informado como (yes) quando se deseja que o lote do pagamento ou borderô considerem o estabelecimento do título para a baixa, ou (no) para não considerar o estabelecimento do título, ou seja, considera              o estabelecimento do próprio lote ou borderô.

tta_log_bord_darf

logical

Sim/Não

Indica que é um borderô de DARF.

tta_log_bord_gps

logical

Sim/Não

Indica que é um borderô de GPS.





Definição:

def temp-table tt_integrapi_apb_pagtobord_lote_auxpg_1 a no-undo

        field ttv_reccod_table_parent             as recid format ">>>>>>9"

    field tta_log_bxa_estab_tit_ap         as logical format "Sim/Não" initial no label "Baixa Estabelec" column-label "Baixa Estabelec"

parent             as character format "x(80)"

    field ttv_log_atualiz_tit_impto_vinc       field tta_log_bord_darf                as logical format "Sim/Não" initial no label "Borderô DARF" column-label "Borderô DARF"

    field tta_log_bord_gps                 as logical format "Sim/Não" initial no label "Borderô GPS" column-label "Borderô GPS"


        .


Tabela Temporária

Descrição

Entrada/Saída

tt_integrapi_apb_bord_lote_pg_a

Tabela temporária que conterá o log de atualiza data de Vencimento dos impostos vinculados ao titulo.

params_generic

Conterá campos novos das temp-tables passadas como parâmetro.

Entrada e SaídaEntrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_reccod_tablerow_parentid

recid

character

X(80)>>>>>>9




ttv_log_atualiz_tit_impto_vinc

logical

_cod_tabela

character

X(28)

Tabela



ttv_cod_campo

character

X(25)

Campo



ttv_cod_valor

character

X(8)

ValorSim/Não




Definição:

def temp-table tt_integrapi_apb_bord_lote_pg_a params_generic no-undo

        field ttv_reccod_table_parent             as recid format ">>>>>>9"    row_id                   as character format "x(80)"

    field ttv_log_atualiz_tit_impto_vinc   as logical format "Sim/Não" initial no

    .

Tabela Temporária

Descrição

Entrada/Saída

tt_params_generic_api

Conterá campos novos das temp-tables passadas como parâmetro.

Entrada e Saída

...

Atributo

...

Tipo

...

Formato

...

Descrição

...

Obrig.

...

Evol.

cod_tabela                   as character format "x(28)" label "Tabela" column-label "Tabela"

    field ttv_cod_campo                    as character format "x(35)" label "

...

ttv_rec_id

...

recid

...

>>>>>>9

...

ttv_cod_tabela

...

character

...

X(28)

...

Tabela

...

ttv_cod_campo

...

character

...

X(25)

...

Campo

...

ttv_cod_valor

...

character

...

X(8)

...

Valor

Definição:

def temp-table tt_params_generic_api no-undo

    field ttv_rec_id                       as recid format ">>>>>>9"

    field ttv_cod_tabela                   as character format "x(28)" label "Tabela" column-label "Tabela"

    field ttv_cod_campo                    as character format "x(25)" label "Campo" column-label "Campo"   

    field ttv_cod_valor                    as valor                    as character format "x(8)" label "Valor" column-label "Valor"

        index tt_idx_param_generic             generic             is primary unique

                    ttv_cod_tabela                   ascending

          ttv_rec_id                       ascending

          ttv_cod_campo                    ascending

tabela                   ascending

          ttv_cod_row_id                   ascending

          ttv_cod_campo                    ascending
        .


Exemplo Criação temp-table tt_api_params_generic_api:

create tt_api_params_generic_api.

assign tt_api_params_generic_api.ttv_rec_id     = (Campo Recid da temp-table) tt_integrcod_row_id     = tt_api_bord_lote_pagto_1.ttv_reccod_table_child

tt_api_params_generic_api.ttv_cod_campo  = 'Zera Saldo Prev/Prov':U

       tt       tt_api_params_generic_api.ttv_cod_tabela = ' tt_integr_apb_abat_prev_provis':U

       tt       tt_api_params_generic_api.ttv_cod_valor  = (Valor Do Zera Saldo).


PIX Datasul

O PIX é um novo modo de Pagamento disponibilizado pelo Banco Central que poderá ser utilizado no pagamento de títulos através de Transferências bancária ou liquidação de Boletos. 

Para o pagamentos de Boletos poderão ser utilizado o QR-Code, dessa forma serão disponibilizados dois campos para guardar os dados do QR-Code e o TXID.

Esses campos serão necessários em pagamentos cuja a forma de pagamento forem:

  • PIX Qr-code mesmo banco
  • PIX QrCode outro banco

QR CODE: Chave/URL endereçamento capturada a partir da leitura do QR CODE. 

TXID:  Código de identificação da transação é opcional e poderá ser informada no pagamento escritural conforme o leitaute CNAB 240 de cada banco. 

Para pagamentos através de transferências PIX será possível informar uma Chave Pix, para isso basta informar o campo cod_chave_pix_tit. Poderá também informar no pagamento que deseja assumir a Chave Pix Preferencial conforme chave informada no Cadastro do Fornecedor Financeiro, basta informar o campo log_chave_prefer

Exemplo de Utilização da tt_api_params_generic:

create tt_api_params_generic.
assign tt_api_params_generic.ttv_cod_tabela = "tt_integr_bord_lote_pagto_1."
            tt_api_params_generic.ttv_cod_row_id = tt_api_bord_lote_pagto_1.ttv_cod_table_child
            tt_api_params_generic.ttv_cod_campo = "cod_txid"
            tt_api_params_generic.ttv_cod_valor = "12544".

create tt_api_params_generic.
assign tt_api_params_generic.ttv_cod_tabela = "tt_integr_bord_lote_pagto_1."
            tt_api_params_generic.ttv_cod_row_id = tt_api_bord_lote_pagto_1.ttv_cod_table_child
            tt_api_params_generic.ttv_cod_campo = "dsl_qrcode"
            tt_api_params_generic.ttv_cod_valor = "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000 5204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D " .

create tt_api_params_generic.
assign tt_api_params_generic.ttv_cod_tabela = "tt_integr_bord_lote_pagto_1."
            tt_api_params_generic.ttv_cod_row_id = tt_api_bord_lote_pagto_1.ttv_cod_table_child
            tt_api_params_generic.ttv_cod_campo = "cod_chave_pix_tit"
            tt_api_params_generic.ttv_cod_valor = "554788554477" .

create tt_api_params_generic.
assign tt_api_params_generic.ttv_cod_tabela = "tt_integr_bord_lote_pagto_1."
           tt_api_params_generic.ttv_cod_row_id = tt_api_bord_lote_pagto_1.ttv_cod_table_child
           tt_api_params_generic.ttv_cod_campo = "log_chave_prefer"
           tt_api_params_generic.ttv_cod_valor = "yes" .

PIX sem Chave

Conforme leiaute dos bancos, é possível gerar um PIX com os dados bancários do fornecedor, sem a necessidade de informar a Chave PIX.

O objetivo é permitir informar os dados bancários ao realizar um pagamento via PIX Transferência, além disso será necessário informar o tipo da Conta corrente selecionada para envio no arquivo de remessa escritural.

Para pagamentos através de transferências PIX é preciso identificar que trata-se de um PIX sem Chave através do Campo PIX Sem Chave.

create tt_api_params_generic.
assign tt_api_params_generic.ttv_cod_tabela = "tt_integr_bord_lote_pagto_1."
           tt_api_params_generic.ttv_cod_row_id = tt_api_bord_lote_pagto_1.ttv_cod_table_child
           tt_api_params_generic.ttv_cod_campo = "log_pix_sem_chave"
           tt_api_params_generic.ttv_cod_valor = "yes" .

Quando selecionada a opção PIX sem Chave, deverão ser informados os dados da conta bancária para realizar a transferência.


Processo Jurídico (REINF):

Para os títulos que possuem INSS e estão marcados como Mão-de-Obra ou Empreitada é possível informar um processo jurídico e o valor que será descontado da base de cálculo do imposto relacionado a esse processo.

Informações necessárias:

- Número do Processo Jurídico (cod_process_judic): Esse campo é opcional. Porém, caso informado deverá existir no Cadastro de Processos (cd2021). 
- Valor não retido (val_nao_retid): Este campo é opcional, quando informado utiliza o valor informado para cálculo de imposto e será necessário informar o número do processo jurídico. Quando ele não for informado será calculado o valor não retido com base no percentual de dedução informado no processo jurídico. Observação: Ao informar valores com decimais a quebra deverá ser feita utilizando vírgula.


Abaixo, exemplo dos registros relacionados:


  • Para informar um Processo Jurídico:

        create tt_api_params_generic.

        assign tt_api_params_generic.ttv_cod_tabela = 'tt_integr_apb_impto_impl_pend4'
                    tt_api_params_generic.ttv_cod_row_id = tt_api_apb_impto_impl_pend4.ttv_cod_table_child
                    tt_api_params_generic.ttv_cod_campo = "cod_process_judic"
                    tt_api_params_generic.ttv_cod_valor = "00000000124548787878".


  • Para informar o Valor não Retido:

        create  tt_api_params_generic.
        assign tt_api_params_generic.ttv_cod_tabela = 'tt_integr_apb_impto_impl_pend4'
                   tt_api_params_generic.ttv_cod_row_id = tt_api_apb_impto_impl_pend4.ttv_cod_table_child
                   tt_api_params_generic.ttv_cod_campo = "val_nao_retid"
                   tt_api_params_generic.ttv_cod_valor = "50,12". 



Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros_atualiz

Conterá as informações referentes aos erros encontrados durante as validações para a criação dos títulos.

Saída


(*) A partir da 5.07A o estabelecimento passa a ter cinco dígitos.

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_estab

character

x(3) / x(5)*

Estabelecimento



tta_cod_refer

character

x(10)

Referência



tta_num_seq_refer

integer

>>>9

Sequência



ttv_num_mensagem

integer

>>>>,>>9

Número do erro



ttv_des_msg_erro

character

x(60)

Mensagem Erro



ttv_des_msg_ajuda

character

x(40)

Mensagem Ajuda



ttv_ind_tip_relacto

character

X(15)

Tipo Relacionamento



ttv_num_relacto

integer

>>>>,>>9

Relacionamento




Definição:

def temp-table tt_log_erros_atualiz no-undo

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

    field tta_cod_refer                    as character format "x(10)" label "Referência" column-label "Referência"

    field tta_num_seq_refer                as integer format ">>>9" initial 0 label "Sequência" column-label "Seq"

    field ttv_num_mensagem                 as integer format ">>>>,>>9" label "Número" column-label "Número Mensagem"

    field ttv_des_msg_erro                 as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"

    field ttv_des_msg_ajuda                as character format "x(40)" label "Mensagem Ajuda" column-label "Mensagem Ajuda"

    field ttv_ind_tip_relacto              as character format "X(15)" label "Tipo Relacionamento" column-label "Tipo Relac"

    field ttv_num_relacto                  as integer format ">>>>,>>9" label "Relacionamento" column-label "Relacionamento"

    .