Árvore de páginas

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 Cadastro de Marketplace.


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_3 (input p_cdn_mktplace, input-output table tt_movto_mktplace_imp,  output table tt_log_erros, input v_log_import_valid). 

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 Cadastro de Marketplace.

v_log_import_valid: Determinará que irá realizar a validação da conciliação no momento que importa. 

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(15)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_ind_movto_concilcharacterX(15)Movimento ConciliaçãoSimNão informar, será preenchido com o tipo de transação da transação do Cadastro de Marketplace com base no campo tta_cod_trans_mktplace.
tta_val_movtodecimal->>,>>>,>>>,>>9.99Valor MovimentoNãoSomente informar se tta_cod_trans_mktplace NÃO for do tipo Liquidação no Cadastro de Marketplace. Pode receber valores negativos.
tta_val_perc_comisdecimal>>9.9999Percentual ComissãoSimSomente informar se tta_cod_trans_mktplace for do tipo Liquidação no Cadastro de Marketplace
tta_val_comisdecimal>>>,>>>,>>9.9999Valor ComissãoNãoSomente informar se tta_cod_trans_mktplace for do tipo Liquidação no Cadastro de Marketplace
tta_val_repas_brutdecimal->>,>>>,>>>,>>9.99Vl Repasse BrutoNãoSomente informar se tta_cod_trans_mktplace for do tipo Liquidação no Cadastro de Marketplace
tta_val_repas_liqdecimal->>,>>>,>>>,>>9.99Vl Repasse LíquidoNãoSomente informar se tta_cod_trans_mktplace for do tipo Liquidação no Cadastro de Marketplace
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
tta_cod_estabcharacterx(5)EstabelecimentoNão
tta_cod_espec_doctocharacterx(3)Espécie DocumentoNão
tta_cod_ser_doctocharacterx(5)Série DocumentoNão
tta_cod_tit_acr characterx(16)TítuloNão
tta_cod_parcelacharacterx(02)ParcelaNão
tta_cod_trans_mktplace characterx(20)Cod TransaçãoNãoTransação do marketplace cadastrada no Cadastro de Marketplace
ttv_val_fretedecimal->>,>>>,>>>,>>9.99Valor FreteNão
tta_num_id_tit_acrinteger999999999ID Token Título a ReceberNão Não deve ser informado. Para vincular o movimento marketplace a um título a receber específico use os campos tta_cod_estab, tta_cod_espec_docto, tta_cod_ser_docto, tta_cod_tit_acr e tta_cod_parcela


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(15)" 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)" 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.9999" decimals 4 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"
    field tta_cod_estab                    as character format "x(5)" label "Estabelecimento" column-label "Estab"
    field tta_cod_espec_docto              as character format "x(3)" label "Esp‚cie Documento" column-label "Esp‚cie"
    field tta_cod_ser_docto                as character format "x(5)" label "S‚rie Documento" column-label "S‚rie"
    field tta_cod_tit_acr                  as character format "x(16)" label "T¡tulo" column-label "T¡tulo"
    field tta_cod_parcela                  as character format "x(02)" label "Parcela" column-label "Parcela"
    field tta_cod_trans_mktplace           as character format "x(20)" label "Cod Transa‡Æo" column-label "Cod Transa‡Æo"
    field ttv_val_frete                    as decimal format "->>,>>>,>>>,>>9.99" decimals 2 label "Valor Frete" column-label "Valor Frete"
    field tta_num_id_tit_acr               as integer format "999999999" initial 0 label "Token Cta Receber" column-label "Token Cta Receber"
    .

Tabela Temporária

Descrição

Entrada/Saída

tt_log_erros

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

Saída

Atributo

Tipo

Formato

Descrição

ttv_num_seq

character

x(3)

Seq

ttv_num_cod_erro

Integer

>>>,>>9

Número Erro

ttv_des_erro

integer

>>>>,>>9

Incosistência

ttv_des_ajuda

character

x(50)

Ajuda


def temp-table tt_log_erros no-undo

field ttv_num_seq as integer format ">>>,>>9" label "Seqüência" column-label "Seq"
field ttv_num_cod_erro as integer format ">>>>,>>9" label "Número" column-label "Número"
field ttv_des_erro as character format "x(50)" label "Inconsistência" column-label "Inconsistência"
field ttv_des_ajuda as character format "x(50)" label "Ajuda" column-label "Ajuda"
index tt_id
ttv_num_seq ascending
ttv_num_cod_erro ascending
.

Para maiores informações consulta Tutoriais - Conciliação Marketplace