Á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/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_

comis

mktplace_

repres_geracao2

imp

Conterá as informações dos movimentos

a serem integradas com o ACR

Entrada

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

marketplaces que serão gerados para o Marketplace informado

Entrada/Saída

AtributoDescrição

Atributo

Tipo
FormatoDescrição
Obrig.
Obrigatório
Evol.

tta_cod_estab

Observação
tta_cod_
empresa

character

x(3)

Empresa

Sim

tta_cdn_repres

Integer

>>>,>>9

Representante

Sim

id_trans
characterx(
3) / x(5)*
30)ID TransaçãoNão

Estabelecimento

Sim

tta_cod_
espec
ped_
docto
vdacharacterx(
3
15)
Espécie Documento
Pedido VendaSimSerá o campo usado para encontrar o título a receber no processamento da conciliação
tta_des_
cod
ped_
ser
movto_
docto
mktplacecharacterx(
3
40)

Série Documento

Pedido Movto MarketNão
Sim

tta_cod_
tit
nota_
acr
fisccharacterx(
10
16)
Título
Nota Fiscal
Sim
Não
tta_
cod
nom_
parcela
clientecharacterx(
02
40)
Parcela
Nome Cliente
Sim
Não
tta_
cod
dat_
refer
compra

character

x(10)

Referência

Sim

tta_cod_usuario

character

x(12)

Usuário

Sim

tta_dat_transacao
date99/99/9999Data CompraNão
tta_dat_pagtodate99/99/9999Data
Transação
PagamentoSimSerá a data usada para liquidar os títulos a receber
tta_
ind
des_
trans
parc_
acr
pagtocharacter
X
x(
29
40)
Transação
Parcela Pagto
Sim
Não
tta_ind
_sit
_movto_
comis
concilcharacterX(
18
15)
Situação
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
_ind_tip
_cod_trans_mktplace.
tta_val_movto

character

X(20)

Tipo Movimento

Sim

tta_ind_natur_lancto_ctbl

character

X(02)

Natureza

Sim

tta_val_base_calc_comis

decimal

decimal->>,>>>,>>>,>>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.99

Base Calc Comis

Vl Repasse BrutoNãoSomente informar se tta_cod_trans_mktplace for do tipo Liquidação no Cadastro de Marketplace
Sim
tta_val_
movto
repas_
comis
liqdecimal->>,>>>,>>>,>>9.99

Valor Movimento

Vl 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
Sim
tta_num_id
_tit_acr
_concil_mktplaceinteger999999999ID Concil MktplaceNãoRetornará o número da conciliação criada
tta_num_movto_mktplaceinteger

9999999999

Token Cta Receber
999999999Movto MarketplaceNãoRetornará o número do movimento criado
tta_des_
histor
lin_
movto_comis
importcharacterx(
40
2000)Linha Importada
Histórico
NãoNão informar
tta_
num_id_movto_tit_acr

integer

9999999999

Token Movto Tit ACR

Sim

cod_estabcharacterx(5)EstabelecimentoNão
tta_cod_espec_doctocharacterx(3)Espécie DocumentoNão
tta_cod_ser_doctocharacterx(5)Série DocumentoNão

tta_ind_trans_comis

character

X(30)

Transação Comissão

Sim

tta_cod_
unid
tit_
negoc
acr characterx(
3
16)
Unid Negócio
TítuloNão

ttv_log_consid_movto_pagto

logical

"Sim/Não"

Considera Pagto

Sim


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

tta_dat_emis_docto

date

99/99/9999

Data  Emissão

Sim

tta_cdn_motiv_movto_comis

Integer

>>>9

Código Motiv Movto


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"

    index tt_id_movto_comis              

          tta_cod_empresa                  ascending

          tta_cdn_repres                   ascending.

OBSERVAÇÕES:

...

    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_

movto

log_

comis_erro

erros

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.

movimentos

Entrada

Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

tta_cod_empresa

ttv_num_seq

character

x(3)

Empresa

Seq

tta

ttv_num_

cdn

cod_

repres

erro

Integer

>>>,>>9

Representante

Número Erro

ttv_

num_seq_movto_comis_

des_erro

integer

>>>>,>>9

Num Sequência

Incosistência

ttv_des_

mensagem

character

x(50)

Mensagem

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

          tta_cdn_repres                   ascending

...

ttv_num_

...

cod_erro ascending
.

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