Dados do Documento

Nome

Fachada Oportunidades

Descrição

Nome Físico

fchcrm/fchcrm1007api.p

Include com Parâmetros

fchcrm/fchcrm1007.i

Release Inicial

12.1.8

Versão de Integração

N/A

Data Liberação

N/A

Banco

Mdtcrm

Tabela

crm_oportun_vda

Aplicativo

Portal CRM

Evolução

Versão

12.1.8

Programa

fchcrm/fchcrm1007api.p

ttFilter

Atributo

Tipo

Formato

Descrição

Obrigatório

c_table  

character

Tabela

Sim

c_property            

character

Propriedade

Sim

c_value         

character

Valor    

Sim

ttOportunidade

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id  

integer

Cod. Identificador

Sim

des_oportun_vda            

character

Descrição oportunidade

Sim

dsl_oportun_vda         

character

Observação oportunidade

Não

num_id_pessoa

integer

Numero Id pessoa

Sim

num_id_usuar_respons

integer

Numero Id responsável

Sim

num_id_estrateg_vda

integer

Numero Id estratégia

Sim

num_id_fase

integer

Numero Id fase

Sim

num_id_probab

integer

Numero Id probabilidade

Não

num_id_campanha

integer

Numero Id campanha

Não

num_id_moed

integer

Numero Id Moeda

Não

num_id_usuar

integer

Numero Id usuário cadastro

Sim

val_bgc

Decimal

Valor BGC

Não

val_oportun_vda

Decimal

Valor da oportunidade

Não

val_med_vida

Decimal

Valor médio vida

Não

val_realzdo_simul

Decimal

Valor realizado simulação

Não

qti_nume_vida

integer

Quantidade vidas

Não

qti_nume_vida_realzdo

integer

Quantidade vidas realizado

Não

dat_cadastro

Date

Data cadastro

Sim

dat_fechto_oportun

Date

Data fechamento

Não

dat_prev_fechto

Date

Data previsão fechamento

Não

log_suspenso

Logical

Suspenso

Sim

log_anexo

Logical

Possui anexo

Não

ttEstrategia

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

des_estrateg_vda

character

Descrição estratégia

Sim

dat_inic

Date

Data inicial

Sim

dat_fim

Date

Data final

Sim

log_inclui_acao

Logical

Inclui ação

Sim

ttFaseDesenvolvimento

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

Integer

Cod. Identificador

Sim

num_id_estrateg_vda

Interger

Numero Id estratégia

Sim

num_id_fase

Integer

Numero Id fase

Sim

des_fase

Character

Descrição fase

Sim

log_fechto_fase

Logical

Fase fechada

Sim

log_fase_perdido

Logical

Fase perdida

Sim

log_permite_exc

Logical

Permite exclusão

Sim

log_permite_alter

Logical

Permite alteração

Sim

num_order

Integer

Numero ordem

Sim

idi_cor_con

Integer

Cor consulta

Sim

ttCampanha

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_campanha

character

Nome campanha

Sim

ttProbabilidade

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

des_probab_fechto

character

Descrição probabilidade

Sim

log_suspenso

logical

Suspenso

Sim

ttConta

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_razao_social

Character

Nome razão social

Sim

cod_pessoa_erp

Character

Código pessoa ERP

Sim

nom_email_1

Character

Nome email 1

Não

nom_email_2

Character

Nome email 2

Não

log_acesso

Logical

Possui acesso

Sim

ttResponsavel

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_usuar

character

Nome usuário

Sim

nom_email

character

Nome email

Não

ttUsuarioAbertura

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_usuar

character

Nome usuário

Sim

nom_email

character

Nome email

Não

ttContato

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

num_id_oportun

Integer

Numero Id oportunidade

Sim

num_id_pessoa

Integer

Numero Id pessoa

Sim

nom_razao_social

Character

Nome razão social

Sim

cod_pessoa_erp

Character

Código pessoa ERP

Sim

nom_email_1

Character

Nome email 1

Não

nom_email_2

Character

Nome email 2

Não

log_acesso

Logical

Possui acesso

Sim

num_id_niv_decis

Integer

Numero Id nível decisão

Sim

nom_niv_decis

character

Nome nível decisão

Não

ttProduto

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

num_id_oportun

Integer

Numero Id oportunidade

Sim

num_id_produt

Integer

Numero Id produto

Sim

nom_produt

Character

Nome produto

Sim

cod_item_erp

Character

Código item ERP

Sim

num_id_umd_vda

Integer

Numero Id unidade venda

Sim

nom_unid_medid

Character

Nome unidade medida

Não

cod_unid_medid_erp

Character

Código unidade medida ERP

Não

num_id_refer

Integer

Numero Id referencia

Sim

nom_refer

Character

Nome referencia

Não

num_id_tab_preco

Integer

Numero Id tabela de preço

Sim

nom_tab_preco

character

Nome tabela de preço

Não

qtd_item

Decimal

Quantidade item

Sim

val_item_clien

Decimal

Valor item cliente

Não

val_item_repres

Decimal

Valor item representante

Não

val_preco_unit

Decimal

Valor preço unitário

Sim

val_tot_itens

Decimal

Valor total itens

Sim

log_perdido

Logical

Item perdido

Não

dsl_observacao

character

Observação

Não

ttRevenda

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

num_id_oportun

Integer

Numero Id oportunidade

Sim

num_id_pessoa

Integer

Numero Id pessoa

Sim

nom_pessoa

Character

Nome pessoa

Não

num_id_contat

Integer

Numero Id contato

Sim

nom_contat

Character

Nome contato

Não

num_seq

Integer

Numero sequencia

Não

val_oportun_vda

Decimal

Valor oportunidade

Não

dsl_observacao

character

Observação

Não

ttRevendaConta

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_razao_social

Character

Nome razão social

Sim

cod_pessoa_erp

Character

Código pessoa ERP

Sim

nom_email_1

Character

Nome email 1

Não

nom_email_2

Character

Nome email 2

Não

log_acesso

Logical

Possui acesso

Sim

ttRevendaContato

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_razao_social

Character

Nome razão social

Sim

nom_email_1

Character

Nome email 1

Não

nom_email_2

Character

Nome email 2

Não

ttConcorrente

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

num_id_oportun

Integer

Numero Id oportunidade

Sim

num_id_pessoa

Integer

Numero Id pessoa

Sim

nom_pessoa

Character

Nome pessoa

Não

num_id_contat

Integer

Numero Id contato

Sim

nom_contat

Character

Nome contato

Não

num_seq

Integer

Numero sequencia

Sim

val_oportun_vda

Decimal

Valor oportunidade

Sim

dsl_observacao

character

Observação

Não

ttConcorrenteConta

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_razao_social

Character

Nome razão social

Sim

cod_pessoa_erp

Character

Código pessoa ERP

Sim

nom_email_1

Character

Nome email 1

Não

nom_email_2

Character

Nome email 2

Não

log_acesso

Logical

Possui acesso

Sim

ttConcorrenteContato

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_razao_social

Character

Nome razão social

Sim

nom_email_1

Character

Nome email 1

Não

nom_email_2

Character

Nome email 2

Não

ttGanhoPerda

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

num_id_oportun

Integer

Numero Id oportunidade

Sim

num_id_motiv_ganho

Integer

Nomero Id motivo

Sim

des_motivo

Character

Descrição motivo

Não

log_ganho_motiv

Logical

Motivo ganho

Sim

num_id_oportun_produt

Integer

Numero Id produto

Não

nom_produt

character

Nome produto

Não

ttPontoForteFraco

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

num_id_oportun

Integer

Numero Id oportunidade

Sim

num_id_pto_fort

Integer

Numero Id ponto forte

Sim

des_pto

Character

Descrição ponto forte

Não

val_peso

Decimal

Valor peso

Sim

log_pto

Logical

Ponto forte

Sim

ttSalesOrder

Atributo

Tipo

Formato

Descrição

Obrigatório

orderNumber

integer

Numero pedido

Sim

customerOrderNumber

Character

Numero pedido cliente

Sim

orderValue

Decimal

Valor pedido

Sim

dtDelivery

Character

Data entrega

Sim

situation

Integer

Situação

Sim

opportunityId

Integer

Numero Id oportunidade

Sim

campaignId

Integer

Numero Id campanha

Não

quotation

Logical

Cotação

Sim

ttFunilVendas

Atributo

Tipo

Formato

Descrição

Obrigatório

sequence

integer

Sequencia

Sim

phaseId

Integer

Numero Id fase

Sim

phaseName

Character

Nome fase

Sim

phaseColor

Character

Cor fase

Sim

phaseValue

Decimal

Valor fase

Sim

allOpp

Character

Todas oportunidades

Sim

realizedValue

Decimal

Valor realizado

Sim

ttRankingOportunidade

Atributo

Tipo

Formato

Descrição

Obrigatório

id

integer

Cod. Identificador

Sim

cName

Character

Nome

Sim

accountId

Integer

Numero Id conta

Sim

accountName

Character

Nome conta

Sim

dValue

Decimal

Valor

Sim

ttMoeda

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id

integer

Cod. Identificador

Sim

nom_moeda

Character

Nome moeda

Sim

nom_prefix_moeda

Character

Nome prefixo moeda

Sim

cod_moed_erp

Character

Código moeda ERP

Sim

ttMetaUsuar

Atributo

Tipo

Formato

Descrição

Obrigatório

num_id_meta

integer

Numero Id meta

Sim

num_id_usuar

Integer

Numero Id usuário

Sim

num_id_fase

Integer

Numero Id fase

Sim

findOpportunity

Requisito

N/A

Sintaxe

findOpportunity (INPUT  i_start, INPUT i_end, INPUT c_properties, INPUT c_values, INPUT c_orderBy, INPUT c_asc, INPUT l_count, INPUT i_type, OUTPUT i_count, OUTPUT DATASET DSCRMOportunidade, OUTPUT TABLE RowErrors)

Descrição

Retorna os registros (query) conforme parâmetros informados.

Parâmetros

Descrição

i_start

Valor inicial da faixa de registros

i_end

Valor final da faixa de registros

c_properties

Propriedades

c_values

Valores

c_orderBy

Campo para ordenação

c_asc

Ascendente ou Decrescente

l_count

Contador

i_type

Tipo

i_count

Quantidade de registros selecionados

DATASET DSCRMOportunidade

Dataset com os registros selecionados

TABLE RowErros

Tabela de erros

Retorno

A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

quickSearchCount

Requisito

N/A

Sintaxe

quickSearchCount (INPUT c_where, INPUT c_value, OUTPUT i_count)

Descrição

Verifica oportunidades que contenham o valor digitado na pesquisa rápida.

Parâmetros

Descrição

c_where

Condição

c_value

Valor

i_count

Contador

Retorno

A API/BO irá retornar a quantidade de registros que atendem a condição.

advancedSearchCount

Requisito

N/A

Sintaxe

advancedSearchCount (INPUT c_where, INPUT TABLE ttFilter, OUTPUT i_count)

Descrição

Verifica oportunidades que atendam os valores do filtro avançado.

Parâmetros

Descrição

c_where

Condição

TABLE ttFilter

Tabela Filtro

i_count

Contador

Retorno

A API/BO irá retornar a quantidade de registros que atendem a pesquisa avançada.

getOpportunity

Requisito

N/A

Sintaxe

getOpportunity (INPUT i_id, OUTPUT DATASET DSCRMOportunidade, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados da oportunidade setada no parâmetro para tela de detalhe.

Parâmetros

Descrição

i_id

Código identificador sequencial

DATASET DSCRMOportunidade

Dataset com os registros selecionados

TABLE RowErros

Tabela de erros

Retorno

A API/BO irá retornar o registro selecionado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getDescription

Requisito

N/A

Sintaxe

getDescription (INPUT i_id, INPUT c_description, OUTPUT TABLE RowErrors)

Descrição

Retorna a descrição longa (observação) da oportunidade.

Parâmetros

Descrição

i_id

Codigo Identificador Sequencial

c_description

Descrição da Oportunidade

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar a descrição do registro selecionado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunity

Requisito

N/A

Sintaxe

persistOpportunity (INPUT i_id, INPUT TABLE ttOportunidadeVO, DATASET DSCRMOportunidade, OUTPUT TABLE RowErrors)

Descrição

Cria ou atualiza oportunidade de venda.

Parâmetros

Descrição

i_id

Codigo Identificador Sequencial

TABLE ttOportunidadeVO

Tabela Oportunidade

DATASET DSCRMOportunidade

Dataset com os registros selecionados

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar ou atualizar a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunity

Requisito

N/A

Sintaxe

deleteOpportunity (INPUT i_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui a oportunidade de venda.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

findOpportunityAfterRowFill

Requisito

N/A

Sintaxe

findOpportunityAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de oportunidade.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findOpportunityBeforeRowFill

Requisito

N/A

Sintaxe

findOpportunityBeforeRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas antes do preenchimento da temp-table de oportunidade.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findOpportunityAccountAfterRowFill

Requisito

N/A

Sintaxe

findOpportunityAccountAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de conta.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findOpportunityContactAfterRowFill

Requisito

N/A

Sintaxe

findOpportunityContactAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de contato.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findOpportunityProductAfterRowFill

Requisito

N/A

Sintaxe

findOpportunityProductAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de produto.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findOpportunityResaleAccountAfterRowFill

Requisito

N/A

Sintaxe

findOpportunityResaleAccountAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de revenda.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findOpportunityCompetitorAccountAfterRowFill

Requisito

N/A

Sintaxe

findOpportunityCompetitorAccountAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de concorrente.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findGainLossAfterRowFill

Requisito

N/A

Sintaxe

findGainLossAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de ganho e perda.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findPhaseAfterRowFill

Requisito

N/A

Sintaxe

findPhaseAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de fase.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findCurrencyAfterRowFill

Requisito

N/A

Sintaxe

findCurrencyAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de moeda.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

findStrongWeakPointAfterRowFill

Requisito

N/A

Sintaxe

findStrongWeakPointAfterRowFill (INPUT DATASET DSCRMOportunidade)

Descrição

Executa as instruções nele descritas após preenchimento da temp-table de ponto forte e fraco.

Parâmetros

Descrição

DATASET DSCRMOportunidade

Dataset com os registros selecionados

Retorno

A API/BO irá executar este método, não enviando retorno.

getAllStrategies

Requisito

N/A

Sintaxe

getAllStrategies (INPUT l_only_valid, OUTPUT TABLE ttEstrategia, OUTPUT TABLE RowErrors)

Descrição

Retorna todas as estratégias de venda.

Parâmetros

Descrição

l_only_valid

Somente estratégias válidas.

TABLE ttEstrategia

Tabela Estrategia de Venda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar todas as estratégias de venda cadastradas ou somente as válidas para a data. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getStrategy

Requisito

N/A

Sintaxe

getStrategy (INPUT i_strategy, OUTPUT TABLE ttEstrategia, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados da estratégia de venda.

Parâmetros

Descrição

i_strategy

Código Identificador Sequencial

TABLE ttEstrategia

Tabela Estrategia de Venda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os dados da estratégia de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getAllPhases

Requisito

N/A

Sintaxe

getAllPhases (INPUT i_strategy, OUTPUT TABLE ttFaseDesenvolvimento, OUTPUT TABLE RowErrors)

Descrição

Retorna as fases relacionadas a estratégia de venda.

Parâmetros

Descrição

i_strategy

Código Identificador Sequencial

TABLE ttFaseDesenvolvimento

Tabela Fase Desenvolvimento

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar as fases relacionadas a estratégia de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getPhaseDev

Requisito

N/A

Sintaxe

getPhaseDev (INPUT i_phase_dev, OUTPUT TABLE ttFaseDesenvolvimento, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados da fase da estratégia de venda.

Parâmetros

Descrição

i_phase_dev

Código Identificador Sequencial

TABLE ttFaseDesenvolvimento

Tabela Fase Desenvolvimento

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os dados da fase da estratégia de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getAllProbabilities

Requisito

N/A

Sintaxe

getAllProbabilities (OUTPUT TABLE ttProbabilidade, OUTPUT TABLE RowErrors)

Descrição

Retorna as probabilidades de venda cadastradas.

Parâmetros

Descrição

TABLE ttProbabilidade

Tabela Probabilidade

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar as probabilidades de venda cadastradas na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getSalesOrder

Requisito

N/A

Sintaxe

getSalesOrder (INPUT i_opportunity, OUTPUT TABLE ttSalesOrder, OUTPUT TABLE RowErrors)

Descrição

Retorna as cotações e pedidos de venda relacionados a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttSalesOrder

Tabela Pedido de Venda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar as cotações e pedidos de venda relacionados a oportunidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

generateSalesOrder

Requisito

N/A

Sintaxe

generateSalesOrder (INPUT i_opportunity, INPUT l_cotation, OUTPUT log_erro, OUTPUT TABLE RowErrors)

Descrição

Gera a cotação ou pedido de venda para a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

l_cotation

Indicador de cotação

log_erro

Indicador de erro ao gerar cotação

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá gerar cotação ou pedido de venda (conforme parametro) para a oportunidade e se gerou erros. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

proceedToNextStage

Requisito

N/A

Sintaxe

proceedToNextStage (INPUT i_opportunity, INPUT i_campaign, INPUT i_action, INPUT i_result, OUTPUT TABLE RowErrors)

Descrição

Prosseguir para a próxima ação.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial Oportunidade

i_campaign

Código Identificador Sequencial Campanha

i_action

Código Identificador Sequencial Ação

i_result

Código Identificador Sequencial Resultado

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá prosseguir para a próxima ação. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityProducts

Requisito

N/A

Sintaxe

getOpportunityProducts (INPUT i_opportunity, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors)

Descrição

Retorna os produtos relacionadas a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttProduto

Tabela Produto

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os produtos relacionadas a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityProduct

Requisito

N/A

Sintaxe

getOpportunityProduct (INPUT i_opportunity_product, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados do produto.

Parâmetros

Descrição

i_opportunity_product

Código Identificador Sequencial

TABLE ttProduto

Tabela Produto

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os dados do produto solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunityProduct

Requisito

N/A

Sintaxe

deleteOpportunityProduct (INPUT i_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui o produto da oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir o produto selecionado da oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunityProduct

Requisito

N/A

Sintaxe

persistOpportunityProduct (INPUT i_opportunity, INPUT i_product, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors)

Descrição

Cria ou atualiza o registro de relacionamento do produto com a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial Oportunidade

i_product

Código Identificador Sequencial Produto da Oportunidade

ttProduto

Tabela Produto

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar ou atualizar o registro de relacionamento do produto com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityGainLosses

Requisito

N/A

Sintaxe

getOpportunityGainLosses (INPUT i_opportunity, OUTPUT TABLE ttGanhoPerda, OUTPUT TABLE RowErrors)

Descrição

Retorna os motivos de ganho ou perda relacionados a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttGanhoPerda

Tabela Motivos Ganho e Perda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os motivos de ganho ou perda relacionados a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunityGainLoss

Requisito

N/A

Sintaxe

deleteOpportunityGainLoss (INPUT i_opportunity_gain_loss, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui o motivo de ganho ou perda da oportunidade.

Parâmetros

Descrição

i_opportunity_gain_loss

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir o motivo de ganho ou perda selecionado da oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunityGainLoss

Requisito

N/A

Sintaxe

persistOpportunityGainLoss (INPUT i_opportunity, OUTPUT TABLE ttGanhoPerda, OUTPUT TABLE RowErrors)

Descrição

Cria o registro de relacionamento do motivo de ganho ou perda com a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

ttGanhoPerda

Tabela Motivo Ganho e Perda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar o registro de relacionamento do motivo de ganho ou perda com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityStrongWeaks

Requisito

N/A

Sintaxe

getOpportunityStrongWeaks (INPUT i_opportunity, OUTPUT TABLE ttPontoForteFraco, OUTPUT TABLE RowErrors)

Descrição

Retorna os pontos fortes ou fracos relacionados a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttPontoForteFraco

Tabela Pontos Forte e Fraco

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os pontos fortes ou fracos relacionados a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunityStrongWeak

Requisito

N/A

Sintaxe

deleteOpportunityStrongWeak (INPUT i_opportunity_strong_weak, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui o ponto forte ou fraco da oportunidade.

Parâmetros

Descrição

i_opportunity_strong_weak

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir o ponto forte ou fraco selecionado da oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunityStrongWeak

Requisito

N/A

Sintaxe

persistOpportunityStrongWeak (INPUT i_opportunity, OUTPUT TABLE ttPontoForteFraco, OUTPUT TABLE RowErrors)

Descrição

Cria o registro de relacionamento do ponto forte ou fraco com a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

ttPontoForteFraco

Tabela Ponto Forte e Fraco

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar o registro de relacionamento do ponto forte ou fraco com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityResales

Requisito

N/A

Sintaxe

getOpportunityResales (INPUT i_opportunity, OUTPUT TABLE ttRevenda, OUTPUT TABLE RowErrors)

Descrição

Retorna as revendas relacionados a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttRevenda

Tabela Revenda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar as revendas relacionadas a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunityResale

Requisito

N/A

Sintaxe

deleteOpportunityResale (INPUT i_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui a revenda da oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir a revenda selecionada da oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunityResale

Requisito

N/A

Sintaxe

persistOpportunityResale (INPUT i_opportunity, OUTPUT TABLE ttRevenda, OUTPUT TABLE RowErrors)

Descrição

Cria o registro de relacionamento da revenda com a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

ttRevenda

Tabela Revenda

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar o registro de relacionamento da revenda com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityCompetitors

Requisito

N/A

Sintaxe

getOpportunityCompetitors (INPUT i_opportunity, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors)

Descrição

Retorna os concorrentes relacionados a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttConcorrente

Tabela Concorrente

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os concorrentes relacionados a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityCompetitor

Requisito

N/A

Sintaxe

getOpportunityCompetitor (INPUT i_opportunity_competitor, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados do concorrente.

Parâmetros

Descrição

i_opportunity_competitor

Código Identificador Sequencial

TABLE ttConcorrente

Tabela Concorrente

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os dados do concorrente solicitado. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunityCompetitor

Requisito

N/A

Sintaxe

deleteOpportunityCompetitor (INPUT i_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui o concorrente da oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir o concorrente selecionado da oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunityCompetitor

Requisito

N/A

Sintaxe

persistOpportunityCompetitor (INPUT i_opportunity, INPUT i_competitor, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors)

Descrição

Cria e atualiza o registro de relacionamento do concorrente com a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial Oportunidade

i_competitor

Código Identificador Sequencial Concorrente da Oportunidade

ttConcorrente

Tabela Concorrente

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar ou atualizar o registro de relacionamento do concorrente com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityContacts

Requisito

N/A

Sintaxe

getOpportunityContacts (INPUT i_opportunity, OUTPUT TABLE ttContato, OUTPUT TABLE RowErrors)

Descrição

Retorna os contatos relacionados a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

TABLE ttContato

Tabela Contato

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os contatos relacionados a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

deleteOpportunityContact

Requisito

N/A

Sintaxe

deleteOpportunityContact (INPUT i_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors)

Descrição

Exclui o contato da oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

l_ok

Indentificador sucesso

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá excluir o contato selecionado da oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

persistOpportunityContact

Requisito

N/A

Sintaxe

persistOpportunityContact (INPUT i_opportunity, OUTPUT TABLE ttContato, OUTPUT TABLE RowErrors)

Descrição

Cria o registro de relacionamento do contato com a oportunidade.

Parâmetros

Descrição

i_opportunity

Código Identificador Sequencial

ttContato

Tabela Contato

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá criar o registro de relacionamento do contato com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityFunnel

Requisito

N/A

Sintaxe

getOpportunityFunnel (INPUT dtPrevStart, INPUT dtPrevEnd,

INPUT dtCloseStart, INPUT dtCloseEnd, INPUT dtRegistStart, INPUT dtRegistEnd, INPUT funnelType, INPUT suspended, INPUT strategyId, INPUT campaignId, INPUT responsibleId, INPUT overallGoals, OUTPUT TABLE ttFunilVendas, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados para o gráfico de funil de vendas.

Parâmetros

Descrição

dtPrevStart

Data previsão inicial

dtPrevEnd

Data previsão final

dtCloseStart

Data fechamento inicial

dtCloseEnd

Data fechamento final

dtRegistStart

Data cadastro inicial

dtRegistEnd

Data cadastro final

funnelType

Tipo de funil

suspended

Suspensos

strategyId

Codigo Identificador Sequencial da Estratégia

campaignId

Codigo Identificador Sequencial da Campanha

responsibleId

Codigo Identificador Sequencial do Responsável

overallGoals

Metas gerais

TABLE ttFunilVendas

Tabela Funil de Vendas

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar a tabela com os dados do funil de vendas. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getOpportunityRanking

Requisito

N/A

Sintaxe

getOpportunityRanking (INPUT imax, INPUT dtStart, INPUT dtEnd, INPUT suspended, INPUT strategyId, INPUT campaignId, INPUT phaseId, INPUT responsibleId, OUTPUT TABLE ttRankingOportunidade, OUTPUT TABLE RowErrors)

Descrição

Retorna os dados para o gráfico do ranking de oportunidades.

Parâmetros

Descrição

imax

Quantidade máxima de colunas

dtStart

Data inicial

dtEnd

Data final

suspended

Suspensos

strategyId

Codigo Identificador Sequencial da Estratégia

campaignId

Codigo Identificador Sequencial da Campanha

phaseId

Codigo Identificador Sequencial da Fase

responsibleId

Codigo Identificador Sequencial do Responsável

TABLE ttRankingOportunidade

Tabela Ranking Oportunidades

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar a tabela com o ranking de oportunidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

validateStrategy

Requisito

N/A

Sintaxe

validateStrategy (INPUT strategyId, OUTPUT TABLE RowErrors)

Descrição

Valida a estratégia de vendas, se existe fases e metas parametrizadas.

Parâmetros

Descrição

strategyId

Código Identificador Sequencial

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá validar a estratégia de vendas. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

ValidUseHier

Requisito

N/A

Sintaxe

ValidUseHier (OUTPUT pl-acessGeral, OUTPUT pl-UsaRegraTime)

Descrição

Valida se possui nível de acesso geral ou específico.

Parâmetros

Descrição

pl-acessGeral

Acesso geral

pl-UsaRegraTime

Acesso Regra de Times

Retorno

A API/BO irá validar o nível de acesso e retornar qual o tipo válido.

getResponsible

Requisito

N/A

Sintaxe

getResponsible (INPUT accountId, OUTPUT TABLE ttResponsavel, OUTPUT TABLE RowErrors)

Descrição

Retorna os usuário responsáveis relacionados a conta.

Parâmetros

Descrição

accountId

Código Identificador Sequencial

TABLE ttResponsavel

Tabela Responsavel

TABLE RowErrors

Tabela de erros

Retorno

A API/BO irá retornar os usuários responsáveis relacionados a conta solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.