Documento de API

Objetivo

Efetuar a alteração dos títulos do contas a receber. 

Parâmetro Entrada API Alteração Títulos/Contas a Receber:

...

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

Funcionamento

Executar o programa API(utilizar o nome externo), da seguinte forma:

def var v_hdl_program as Handle no-undo. 

run prgfin/acr/acr711zv.py persistent set v_hdl_program .

run pi_main_code_integr_acr_alter_tit_acr_novo_14 in v_hdl_program

...

                                             Input  table tt_params_generic_api). 

Delete procedure v_hdl_program.

Tabelas Temporárias

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

...

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

...

def temp-table tt_alter_tit_acr_base_5 no-undo

...

          tta_num_seq_tit_acr              ascending.

...

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

...

def temp-table tt_alter_tit_acr_cheq no-undo

...

          tta_num_cheque                   ascending.

...

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

...

Atributo

...

Tipo

...

Formato

...

Descrição

...

Obrig.

...

Evol.

...

tta_cod_estab

...

...

(

...

Estabelecimento

...

...

**) Caso esteja alterando um título do Contas a Receber de tipo de cobrança normal para tipo de cobrança especial, deverá informar a sequência 0 (zero) no campo tt_alter_tit_acr_cobr_espec_2.tta_num_

...

seq_tit_acr

...

integer

...

9999999999

...

Token Cta Receber

...

...

...

. Caso esteja alterando um título do Contas a Receber já existente de cobrança especial, deverá informar a sequência já existente do título do Contas a Receber (exemplo: tit_acr_cobr_especial.num_seq_tit_acr).

...

def temp-table tt_alter_tit_acr_cobr_espec_2 no-undo

...

          tta_num_seq_tit_acr              ascending.

...

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

...

def temp-table tt_alter_tit_acr_comis_1 no-undo

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

&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" < "5.07A" &THEN

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

&ENDIF

def temp-table tt_alter_tit_acr_comis_1 no-undo&IF "{&emsfin_version}" >= "5.07A" AND "{&emsfin_version}" < "9.99" &THEN

    field tta_cod_estab                    empresa                  as Character character format "x(53)" label "EstabelecimentoEmpresa" column-label "EstabEmpresa"

&ENDIF&IF "{&emsfin_version}" >= "" AND "{&emsfin_version}" < "5.07A" &THEN

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

&ENDIF

&IF "{&emsfin_version}" >= "5.07A" AND "{&emsfin_version}" < "9.99" &THEN

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

&ENDIF

    field tta_num_id_tit_acr               as num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

...

          tta_num_id_tit_acr               ascending. 

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

def temp-table tt_alter_tit_acr_impto_retid_2 no-undo

...

          tta_num_impto_refer_tit_acr      ascending. 

...

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

...

def temp-table tt_alter_tit_acr_iva no-undo

...

          tta_num_seq                      ascending. 

...

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

def temp-table tt_alter_tit_acr_ped_vda no-undo

...

    field tta_cod_ped_vda                  as character format "x(1215)" label "Pedido Venda" column-label "Pedido Venda"

    field tta_cod_ped_vda_repres           as character format "x(1230)" label "Pedido Repres" column-label "Pedido Repres"

...

          tta_cod_ped_vda                  ascending.

...

...

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

(**) Liberado o centro de custo com 20 posições, a partir de maio/2011.

...

def temp-table tt_alter_tit_acr_rateio no-undo

...

    field tta_log_impto_val_agreg          as logical format "Sim/NÆo" initial no label "Impto Val Agreg" column-label "Imp Vl Agr"

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

    field tta_cod_unid_federac             as character format "x(3)" label "Unidade Federa‡Æo" column-label "UF"

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

    field tta_cod_classif_impto            as character format "x(05)" initial "00000" label "Class Imposto" column-label "Class Imposto"

    field tta_dat_transacao                as date format "99/99/9999" initial today label "Data Transa‡Æo" column-label "Dat Transac"

    index tt_relac_tit_acr               

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending.

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

def temp-table tt_alter_tit_acr_rat_desp_rec no-undo

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

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

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

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

    field tta_cod_unid_negoc               as character format "x(3)" label "Unid Neg¢cio" column-label "Un Neg"

    field tta_cod_tip_abat                 as character format "x(8)" label "Tipo de Abatimento" column-label "Tipo de Abatimento"

    field tta_val_perc_rat_ctbz            as decimal format ">>9.99" decimals 2 initial 0 label "Perc Rateio" column-label "% Rat"

    field tta_ind_tip_aprop_recta_despes   as character format "x(20)" label "Tipo Apropria‡Æo" column-label "Tipo Apropria‡Æo"

    field tta_num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

    field tta_num_id_aprop_despes_recta    as integer format "9999999999" initial 0 label "Id Apropria‡Æo" column-label "Id Apropria‡Æo"

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

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

    index tt_aprpdspa_id                   is primary unique

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending

          tta_cod_plano_cta_ctbl           ascending

          tta_cod_cta_ctbl                 ascending

          tta_cod_unid_negoc               ascending

          tta_cod_tip_fluxo_financ         ascending

          tta_num_id_aprop_despes_recta    ascending

    index tt_aprpdspa_token                is unique

          tta_cod_estab                    ascending

          tta_num_id_aprop_despes_recta    ascending.

def temp-table tt_log_erros_alter_tit_acr no-undo

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

    field tta_num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

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

    field ttv_cod_tip_msg_dwb              as character format "x(12)" label "Tipo Mensagem" column-label "Tipo 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_wgh_focus                    as widget-handle format ">>>>>>9"

    index tt_relac_tit_acr               

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending

          ttv_num_mensagem                 ascending.

def temp-table tt_alter_tit_acr_cobr_esp_2_c no-undo

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

    field tta_num_id_tit_acr               as integer format "999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

    field tta_cod_admdra_cartao_cr         as character format "x(5)" label "Administradora" column-label "Administradora"

    field tta_cod_band                     as character format "x(10)" label "Bandeira" column-label "Bandeira"

    field tta_cod_tid                      as character format "x(10)" label "TID" column-label "TID"

    field tta_cod_terminal                 as character format "x(8)" label "Nr Terminal" column-label "Nr Terminal".

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 character format "x(8)" label "Valor" column-label "Valor"

    index tt_idx_param_generic             is primary unique

          ttv_cod_tabela                   ascending

          ttv_rec_id                       ascending

          ttv_cod_campo                    ascending.

" column-label "Imp Vl Agr"

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

    field tta_cod_unid_federac             as character format "x(3)" label "Unidade Federa‡Æo" column-label "UF"

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

    field tta_cod_classif_impto            as character format "x(05)" initial "00000" label "Class Imposto" column-label "Class Imposto"

    field tta_dat_transacao                as date format "99/99/9999" initial today label "Data Transa‡Æo" column-label "Dat Transac"

    index tt_relac_tit_acr               

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending.

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

def temp-table tt_alter_tit_acr_rat_desp_rec no-undo

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

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

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

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

    field tta_cod_unid_negoc               as character format "x(3)" label "Unid Neg¢cio" column-label "Un Neg"

    field tta_cod_tip_abat                 as character format "x(8)" label "Tipo de Abatimento" column-label "Tipo de Abatimento"

    field tta_val_perc_rat_ctbz            as decimal format ">>9.99" decimals 2 initial 0 label "Perc Rateio" column-label "% Rat"

    field tta_ind_tip_aprop_recta_despes   as character format "x(20)" label "Tipo Apropria‡Æo" column-label "Tipo Apropria‡Æo"

    field tta_num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

    field tta_num_id_aprop_despes_recta    as integer format "9999999999" initial 0 label "Id Apropria‡Æo" column-label "Id Apropria‡Æo"

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

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

    index tt_aprpdspa_id                   is primary unique

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending

          tta_cod_plano_cta_ctbl           ascending

          tta_cod_cta_ctbl                 ascending

          tta_cod_unid_negoc               ascending

          tta_cod_tip_fluxo_financ         ascending

          tta_num_id_aprop_despes_recta    ascending

    index tt_aprpdspa_token                is unique

          tta_cod_estab                    ascending

          tta_num_id_aprop_despes_recta    ascending.

def temp-table tt_log_erros_alter_tit_acr no-undo

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

    field tta_num_id_tit_acr               as integer format "9999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

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

    field ttv_cod_tip_msg_dwb              as character format "x(12)" label "Tipo Mensagem" column-label "Tipo 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_wgh_focus                    as widget-handle format ">>>>>>9"

    index tt_relac_tit_acr               

          tta_cod_estab                    ascending

          tta_num_id_tit_acr               ascending

          ttv_num_mensagem                 ascending.

def temp-table tt_alter_tit_acr_cobr_esp_2_c no-undo

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

    field tta_num_id_tit_acr               as integer format "999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"

    field tta_cod_admdra_cartao_cr         as character format "x(5)" label "Administradora" column-label "Administradora"

    field tta_cod_band                     as character format "x(10)" label "Bandeira" column-label "Bandeira"

    field tta_cod_tid                      as character format "x(10)" label "TID" column-label "TID"

    field tta_cod_terminal                 as character format "x(8)" label "Nr Terminal" column-label "Nr Terminal".

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 character format "x(8)" label "Valor" column-label "Valor"

    index tt_idx_param_generic             is primary unique

          ttv_cod_tabela                   ascending

          ttv_rec_id                       ascending

          ttv_cod_campo                    ascending.

Exemplo Criação temp-table tt_params_generic_api para campo “val_perc_desc_antecip”:

create tt_params_generic_api.

assign tt_params_generic_api.ttv_rec_id     = (Campo Recid da Tabela tit_acr)

       tt_params_generic_api.ttv_cod_campo  = '% Antecip':U

       tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U

       tt_params_generic_api.ttv_cod_valor  = (Valor Do % Dias Antecipado).

REINF:

Mão-de-Obra ou Empreitada (REINF):

Caso o título seja de um cliente do tipo Mão-de-Obra ou Empreitada será necessário informar alguns dados para o REINF. Para alterar essas informações através da API será necessário que o cliente do título esteja relacionado a uma pessoa jurídica e o tipo da espécie do título seja 'Normal' e a origem do título seja de implantação direto no módulo de Contas a Receber.

Informações necessárias:

- Mão de Obra ou Empreitada (log_mdo_emptda): Indica se o título representa um recebimento relacionado à mão-de-obra ou empreitada. Valores possíveis 'yes', 'no', 'sim' ou 'não'. 

- Número do Tipo Serviço Mão-de-Obra (num_tip_serv_mdo ): Número corresponde ao tipo de serviço prestado. Esse campo é obrigatório caso o campo anterior seja 'yes' ou 'Sim'. O código deverá estar cadastrado no sistema na rotina Código de Serviço do INSS (CD1050). 

- Tipo Inscrição Obra (num_tip_obra): Caso a obra esteja vinculada a um CNPJ deverá ser informado '1', caso esteja vinculada a um CNO deverá ser informado '4'.

- Código da Obra (cod_obra): Esse campo é opcional. Porém, caso informado deverá existir na rotina Códigos de obras (cd2023).

Processo Jurídico (REINF):

Para os títulos que possuem INSS estão marcados como Mão-de-Obra ou Empreitada é possível informar um processo jurídico e o valor de imposto não retido em virtude desse 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) e será necessário informar o valor não retido. 

- Valor não retido (val_nao_retid): Este campo é opcional, quando informado será necessário informar o número do processo jurídico. Quando ele não for informado será calculado o valor não retido.

-INSS: Este campo é opcional no Contas a Receber. Caso informado o campo Base de Cálculo também deve ser informado.

-Base de Cálculo: Valor da Base de Cálculo do INSS. Este campo não é obrigatório.

Observação: Para todos campos valores da tabela temporária "tt_params_generic_api" ao informar valores com decimais a quebra deverá ser feita utilizando string(9.99).

Exemplo Criação temp-table tt_params_generic_api para campo Mão de Obra Empreitada:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'log_mdo_emptda':U
tt_params_generic_api.ttv_cod_valor = 'yes'.

Obs. Campo utilizado para o REINF.

Exemplo Criação temp-table tt_params_generic_api para campo Número Tipo Serviço Mão de Obra :

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'num_tip_serv_mdo':U
tt_params_generic_api.ttv_cod_valor = '3'. /*deve existir no cd1050*/

Obs. Campo utilizado para o REINF.

Exemplo Criação temp-table tt_params_generic_api para campo Número Tipo Obra:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'num_tip_obra':U
tt_params_generic_api.ttv_cod_valor = '4'. /*válidos apenas 1 = CNPJ e 4 = CNO - caso não informar este campo o valor default assumido é 1*/

Obs. Campo utilizado para o REINF.

Exemplo Criação temp-table tt_params_generic_api para campo Código Obra:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'cod_obra':U
tt_params_generic_api.ttv_cod_valor = '12'. /*deve existir no cd2023*/

Obs. Campo utilizado para o REINF.

Exemplo Criação temp-table tt_params_generic_api para campo Código Processo Judicial:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela ='tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'cod_process_judic':U 
tt_params_generic_api.ttv_cod_valor = '111222333'. /*deve existir no cd2021*/

Obs. Campo utilizado para o REINF.

Exemplo Criação temp-table tt_params_generic_api para campo Valor Não Retido:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'val_nao_retid':U
tt_params_generic_api.ttv_cod_valor = string(55.12).

Obs. Campo utilizado para o REINF.

Exemplo Criação temp-table tt_params_generic_api para campo Valor Base Cálculo INSS :

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'val_base_calc_inss':U
tt_params_generic_api.ttv_cod_valor = string(6500.12).

Exemplo Criação temp-table tt_params_generic_api para campo Valor Crédito INSS:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da Tabela tit_acr)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'val_cr_inss':U
tt_params_generic_api.ttv_cod_valor = string(885.78).

PIX:

A modalidade de Cobrança PIX segundo os layouts dos bancos possuem informações diferentes da cobrança escritural normal e estas precisam estar disponíveis para alteração pelo usuário.

Informações necessárias:

- campo dsl_pix_link - Link gerado para pagamento do Qr Code estático ou dinâmico. Será retornado pelo Banco neste primeiro momento.

- campo des_url_loc_payload_json - URL presente no EMV do QR Code dinâmico e que contém os dados da cobrança

- campo dsl_emv_qr_code - EMV do QR Code dinâmico ou estático. Esse campo deve ser utilizado no processo de geração de imagem (base64). 

Exemplo Criação temp-table tt_params_generic_api para campo Link:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da temp-table de Título de Alteração)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'v_dsl_pix_link':U.

E no campo tt_params_generic_api_id.ttv_cod_valor indicar pix link fornecido pelo banco.

Exemplo Criação temp-table tt_params_generic_api para campo URL :

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da temp-table de Título de Alteração)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'v_des_url_localiz_json':U
tt_params_generic_api.ttv_cod_valor = char(100).

E no campo tt_params_generic_api_id.ttv_cod_valor indicar URL presente no EMV do QR Code fornecido pelo banco.

Exemplo Criação temp-table tt_params_generic_api para campo EMV:

create tt_params_generic_api.
assign tt_params_generic_api.ttv_rec_id = (Campo Recid da temp-table de Título de Alteração)
tt_params_generic_api.ttv_cod_tabela = 'tt_alter_tit_acr_base_5':U
tt_params_generic_api.ttv_cod_campo = 'v_dsl_emv_qrcode':U.

E no campo tt_params_generic_api_id.ttv_cod_valor indicar URL presente no EMV do QR Code fornecido pelo banco.