Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/acr/acr563za

Objetivo

Gerar movimentos dos Marketplaces para conciliação dos repasses realizados pelos mesmos

Funcionamento

1. No programa que irá chamar está API, devem ser definidas as temp-table (tt_movto_mktplace_imp) e temp-table (tt_log_erros). Além disso, deverá ser informado o código do Marketplace que deverá estar cadastrado no programa acr067aa.


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

def var v_hdl_programa as handle no-undo.

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

run pi_main_api_concil_mktplace_arq_imp in v_hdl_programa (input v_cdn_mktplace, input-output  table tt_movto_mktplace_imp, output table tt_log_erros).

delete procedure v_hdl_programa.


3. Após a execução do programa, deve ser testada a temp-table de erro (tt_log_erros), para verificar se houveram ou não erros durante o processo de importação.

Parâmetro entrada

v_cdn_mktplace: Determinará para qual Marketplace será gerada a conciliação e seus movimentos. O código informado deverá estar cadastrado no programa acr067aa.

Tabelas Temporárias


Tabela Temporária

Descrição

Entrada/Saída

tt_movto_mktplace_imp

Conterá as informações dos movimentos marketplaces que serão gerados para o Marketplace informado

Entrada/Saída

AtributoDescriçãoFormatoDescriçãoObrigatórioObservação
tta_cod_id_transcharacterx(30)ID TransaçãoNão
tta_cod_ped_vdacharacterx(12)Pedido VendaSimSerá o campo usado para encontrar o título a receber no processamento da conciliação
tta_des_ped_movto_mktplacecharacterx(40)Pedido Movto MarketNão
tta_cod_nota_fisccharacterx(16)Nota FiscalNão
tta_nom_clientecharacterx(40)Nome ClienteNão
tta_dat_compradate99/99/9999Data CompraNão
tta_dat_pagtodate99/99/9999Data PagamentoSimSerá a data usada para liquidar os títulos a receber
tta_des_parc_pagtocharacterx(40)Parcela PagtoNão
tta_des_movto_mktplacecharacterx(80)Movimento MarketplacNão
tta_ind_movto_concilcharacterX(15)Movimento ConciliaçãoSimDeve ser Liquidação ou Não tratado
tta_val_movtodecimal->>,>>>,>>>,>>9.99Valor MovimentoNãoSomente informar se tta_ind_movto_concil não for liquidação. Pode receber valores negativos.
tta_val_perc_comisdecimal>>9.99Percentual ComissãoSimSomente informar se tta_ind_movto_concil for liquidação
tta_val_comisdecimal>>>,>>>,>>9.9999Valor ComissãoNãoSomente informar se tta_ind_movto_concil for liquidação
tta_val_repas_brutdecimal->>,>>>,>>>,>>9.99Vl Repasse BrutoNãoSomente informar se tta_ind_movto_concil for liquidação
tta_val_repas_liqdecimal->>,>>>,>>>,>>9.99Vl Repasse LíquidoNãoSomente informar se tta_ind_movto_concil for liquidação
tta_num_lin_importainteger>>>>,>>9Linha ImportaçãoNãoNão informar
tta_num_id_concil_mktplaceinteger999999999ID Concil MktplaceNãoRetornará o número da conciliação criada
tta_num_movto_mktplaceinteger999999999Movto MarketplaceNãoRetornará o número do movimento criado
tta_des_lin_importcharacterx(2000)Linha ImportadaNãoNão informar

def temp-table tt_movto_mktplace_imp no-undo
field tta_cod_id_trans as character format "x(30)" label "ID Transação" column-label "ID Transação"
field tta_cod_ped_vda as character format "x(12)" label "Pedido Venda" column-label "Pedido Venda"
field tta_des_ped_movto_mktplace as character format "x(40)" label "Pedido Movto Market" column-label "Pedido Movto Market"
field tta_cod_nota_fisc as character format "x(16)" label "Nota Fiscal" column-label "Nota Fiscal"
field tta_nom_cliente as character format "x(40)" label "Nome Cliente" column-label "Nome Cliente"
field tta_dat_compra as date format "99/99/9999" initial ? label "Data Compra" column-label "Dt Compra"
field tta_dat_pagto as date format "99/99/9999" initial today label "Data Pagamento" column-label "Data Pagto"
field tta_des_parc_pagto as character format "x(40)" label "Desc Parcela Pagto" column-label "Desc Cal Pagto"
field tta_des_movto_mktplace as character format "x(80)" label "Movimento Marketplac" column-label "Movimento Marketplac"
field tta_ind_movto_concil as character format "X(15)" initial "Liquidação" label "Movimento Concil" column-label "Movimento Concil"
field tta_val_movto as decimal format "->>,>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Vl Movto"
field tta_val_perc_comis as decimal format ">>9.99" decimals 2 initial 0 label "Percentual Comissão" column-label "Perc Comis"
field tta_val_comis as decimal format ">>>,>>>,>>9.9999" decimals 4 initial 0 label "Valor Comissão" column-label "Valor Comissão"
field tta_val_repas_brut as decimal format "->>,>>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Repasse Bruto" column-label "Vl Rep Brut"
field tta_val_repas_liq as decimal format "->>,>>>,>>>,>>9.99" decimals 2 initial 0 label "Vl Repasse Líquido" column-label "Vl Rep Liq"
field tta_num_lin_importa as integer format ">>>>,>>9" initial 0 label "Linha Importação" column-label "Linha Importação"
field tta_num_id_concil_mktplace as integer format "999999999" initial 0 label "ID Concil Mktplace" column-label "ID Concil Mktplace"
field tta_num_movto_mktplace as integer format "999999999" initial 0 label "Movto Marketplace" column-label "Movto Marketplace"
field tta_des_lin_import as character format "x(2000)" label "Linha Importada" column-label "Linha Importada"
.


OBSERVAÇÕES:

  1. 1.  Caso a natureza do lançamento seja um débito a data Emissão do documento será igual a data de transação, caso contrario a data de emissão será gravada com o valor informado no campo tta_dat_emis_docto.


Tabela Temporária

Descrição

Entrada/Saída

tt_movto_comis_erro

Conterá as informações de erros na integração, é a temp-table (tt_movto_comis_erro) que retorna os possíveis problemas na integração dos registros.

Entrada

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_empresa

character

x(3)

Empresa



tta_cdn_repres

Integer

>>>,>>9

Representante



ttv_num_seq_movto_comis_erro

integer

>>>>,>>9

Num Sequência



ttv_des_mensagem

character

x(50)

Mensagem



ttv_des_ajuda

character

x(50)

Ajuda




def temp-table tt_movto_comis_erro no-undo

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

    field tta_cdn_repres                   as Integer format ">>>,>>9" initial 0 label "Representante" column-label "Representante"

    field ttv_num_seq_movto_comis_erro     as integer format ">>>>,>>9" label "Num Sequência" column-label "Num Sequência"

    field ttv_des_mensagem                 as character format "x(50)" label "Mensagem" column-label "Mensagem"

    field ttv_des_ajuda                    as character format "x(50)" label "Ajuda" column-label "Ajuda"

    index tt_id_movto                    

          tta_cod_empresa                  ascending

          tta_cdn_repres                   ascending

          ttv_num_seq_movto_comis_erro     ascending.