Documento de Fachada
Produto: | Datasul |
| Ocorrência: | Documentação da Fachada |
Dados do Documento | |
Nome | Fachada Oportunidades |
Descrição |
|
Nome Físico | fchcrm/fchcrm1007.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/fchcrm1007.p |
Objetivo
Realizar a manutenção de oportunidades.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
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 |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
REST_GET | ||
Requisito | N/A | |
Sintaxe | REST_GET (INPUT QP_start, INPUT QP_end, INPUT QP_properties, INPUT QP_values, INPUT QP_orderBy, INPUT QP_asc, INPUT QP_count, INPUT QP_type, OUTPUT REST_count, OUTPUT DATASET DSCRMOportunidade, OUTPUT TABLE RowErrors) | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
QP_start | Valor inicial da faixa de registros | |
QP_end | Valor final da faixa de registros | |
QP_properties | Propriedades | |
QP_values | Valores | |
QP_orderBy | Campo para ordenação | |
QP_asc | Ascendente ou Decrescente | |
QP_count | Contador | |
QP_type | Tipo | |
REST_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. | |
REST_GET_detail | ||
Requisito | N/A | |
Sintaxe | REST_GET_detail (INPUT PP_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 | |
PP_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. | |
REST_GET_description |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_description (INPUT PP_id, INPUT dsl_oportun_vda, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna a descrição longa (observação) da oportunidade. |
| |
Parâmetros | Descrição |
| |
PP_id | Codigo Identificador Sequencial |
| |
dsl_oportun_vda | 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. |
| |
REST_POST |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST (INPUT TABLE ttOportunidadeVO, DATASET DSCRMOportunidade, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova oportunidade de venda. |
| |
Parâmetros | Descrição |
| |
TABLE ttOportunidadeVO | Tabela Oportunidade |
| |
DATASET DSCRMOportunidade | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a oportunidade de venda cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_PUT |
| ||
Requisito | N/A |
| |
Sintaxe | REST_PUT (INPUT PP_id, INPUT TABLE ttOportunidadeVO, DATASET DSCRMOportunidade, OUTPUT TABLE RowErrors) |
| |
Descrição | Atualiza oportunidade de venda. |
| |
Parâmetros | Descrição |
| |
PP_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á atualizar a oportunidade de venda solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_DELETE |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE (INPUT PP_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui a oportunidade de venda. |
| |
Parâmetros | Descrição |
| |
PP_id | 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. |
| |
Metodo Negócio
REST_GET_strategies |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_strategies (INPUT QP_only_valid, OUTPUT TABLE ttEstrategia, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todas as estratégias de venda. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_strategy |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_strategy (INPUT QP_strategy, OUTPUT TABLE ttEstrategia, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os dados da estratégia de venda. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_phase |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_phase (INPUT QP_strategy, OUTPUT TABLE ttFaseDesenvolvimento, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna as fases relacionadas a estratégia de venda. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_phase_dev |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_phase_dev (INPUT QP_phase_dev, OUTPUT TABLE ttFaseDesenvolvimento, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os dados da fase da estratégia de venda. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_probability |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_probability (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. |
| |
REST_GET_salesorder |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_salesorder (INPUT QP_opportunity, OUTPUT TABLE ttSalesOrder, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna as cotações e pedidos de venda relacionados a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_generatesalesorder |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_generatesalesorder (INPUT QP_opportunity, INPUT QP_cotation, OUTPUT log_erro, OUTPUT TABLE RowErrors) |
| |
Descrição | Gera a cotação ou pedido de venda para a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_opportunity | Código Identificador Sequencial |
| |
QP_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. |
| |
REST_GET_product |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_product (INPUT QP_opportunity, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os produtos relacionadas a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_opportunity_product |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_opportunity_product (INPUT QP_opportunity_product, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os dados do produto. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_DELETE_product |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_product (INPUT QP_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o produto da oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_POST_product |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_product (INPUT QP_opportunity, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria o registro de relacionamento do produto com a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_opportunity | Código Identificador Sequencial |
| |
ttProduto | Tabela Produto |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá criar o registro de relacionamento do produto com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_PUT_product |
| ||
Requisito | N/A |
| |
Sintaxe | REST_PUT_product (INPUT QP_opportunity, INPUT QP_product, OUTPUT TABLE ttProduto, OUTPUT TABLE RowErrors) |
| |
Descrição | Atualiza o registro de relacionamento do produto com a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_opportunity | Código Identificador Sequencial Oportunidade |
| |
QP_product | Código Identificador Sequencial Produto da Oportunidade |
| |
ttProduto | Tabela Produto |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá atualizar o registro de relacionamento do produto com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_GET_gain_loss |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_gain_loss (INPUT QP_opportunity, OUTPUT TABLE ttGanhoPerda, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os motivos de ganho ou perda relacionados a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_DELETE_gain_loss |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_gain_loss (INPUT QP_opportunity_gain_loss, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o motivo de ganho ou perda da oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_POST_gain_loss |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_gain_loss (INPUT QP_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 |
| |
QP_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. |
| |
REST_GET_strong_weak |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_strong_weak (INPUT QP_opportunity, OUTPUT TABLE ttPontoForteFraco, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os pontos fortes ou fracos relacionados a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_DELETE_strong_weak |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_strong_weak (INPUT QP_opportunity_strong_weak, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o ponto forte ou fraco da oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_POST_strong_weak |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_strong_weak (INPUT QP_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 |
| |
QP_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. |
| |
REST_GET_resale |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_resale (INPUT QP_opportunity, OUTPUT TABLE ttRevenda, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna as revendas relacionados a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_DELETE_resale |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_resale (INPUT QP_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui a revenda da oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_POST_resale |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_resale (INPUT QP_opportunity, OUTPUT TABLE ttRevenda, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria o registro de relacionamento da revenda com a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_competitor |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_competitor (INPUT QP_opportunity, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os concorrentes relacionados a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_opportunity_competitor |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_opportunity_competitor (INPUT QP_opportunity_competitor, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os dados do concorrente. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_DELETE_competitor |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_competitor (INPUT QP_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o concorrente da oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_POST_competitor |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_competitor (INPUT QP_opportunity, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria o registro de relacionamento do concorrente com a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_opportunity | Código Identificador Sequencial |
| |
ttConcorrente | Tabela Concorrente |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá criar o registro de relacionamento do concorrente com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_PUT_competitor |
| ||
Requisito | N/A |
| |
Sintaxe | REST_PUT_competitor (INPUT QP_opportunity, INPUT QP_competitor, OUTPUT TABLE ttConcorrente, OUTPUT TABLE RowErrors) |
| |
Descrição | Atualiza o registro de relacionamento do concorrente com a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_opportunity | Código Identificador Sequencial Oportunidade |
| |
QP_competitor | Código Identificador Sequencial Concorrente da Oportunidade |
| |
ttConcorrente | Tabela Concorrente |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá atualizar o registro de relacionamento do concorrente com a oportunidade de venda. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
REST_GET_contact |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_contact (INPUT QP_opportunity, OUTPUT TABLE ttContato, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os contatos relacionados a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_DELETE_contact |
| ||
Requisito | N/A |
| |
Sintaxe | REST_DELETE_contact (INPUT QP_opportunity, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o contato da oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_POST_contact |
| ||
Requisito | N/A |
| |
Sintaxe | REST_POST_contact (INPUT QP_opportunity, OUTPUT TABLE ttContato, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria o registro de relacionamento do contato com a oportunidade. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_getopportunityfunnel |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_getopportunityfunnel (INPUT QP_dtPrevStart, INPUT QP_dtPrevEnd, INPUT QP_dtCloseStart, INPUT QP_dtCloseEnd, INPUT QP_dtRegistStart, INPUT QP_dtRegistEnd, INPUT QP_funnelType, INPUT QP_suspended, INPUT QP_strategyId, INPUT QP_campaignId, INPUT QP_responsibleId, INPUT QP_overallGoals, OUTPUT TABLE ttFunilVendas, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os dados para o gráfico de funil de vendas. |
| |
Parâmetros | Descrição |
| |
QP_dtPrevStart | Data previsão inicial |
| |
QP_dtPrevEnd | Data previsão final |
| |
QP_dtCloseStart | Data fechamento inicial |
| |
QP_dtCloseEnd | Data fechamento final |
| |
QP_dtRegistStart | Data cadastro inicial |
| |
QP_dtRegistEnd | Data cadastro final |
| |
QP_funnelType | Tipo de funil |
| |
QP_suspended | Suspensos |
| |
QP_strategyId | Codigo Identificador Sequencial da Estratégia |
| |
QP_campaignId | Codigo Identificador Sequencial da Campanha |
| |
QP_responsibleId | Codigo Identificador Sequencial do Responsável |
| |
QP_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. |
| |
REST_GET_getopportunityranking |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_getopportunityranking (INPUT QP_max, INPUT QP_dtStart, INPUT QP_dtEnd, INPUT QP_suspended, INPUT QP_strategyId, INPUT QP_campaignId, INPUT QP_phaseId, INPUT QP_ responsibleId, OUTPUT TABLE ttRankingOportunidade, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os dados para o gráfico do ranking de oportunidades. |
| |
Parâmetros | Descrição |
| |
QP_max | Quantidade máxima de colunas |
| |
QP_dtStart | Data inicial |
| |
QP_dtEnd | Data final |
| |
QP_suspended | Suspensos |
| |
QP_strategyId | Codigo Identificador Sequencial da Estratégia |
| |
QP_campaignId | Codigo Identificador Sequencial da Campanha |
| |
QP_phaseId | Codigo Identificador Sequencial da Fase |
| |
QP_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. |
| |
REST_GET_validateestrategy |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_validateestrategy (INPUT QP_strategyId, OUTPUT TABLE RowErrors) |
| |
Descrição | Valida a estratégia de vendas, se existe fases e metas parametrizadas. |
| |
Parâmetros | Descrição |
| |
QP_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. |
| |
REST_GET_responsible |
| ||
Requisito | N/A |
| |
Sintaxe | REST_GET_responsible (INPUT QP_account, OUTPUT TABLE ttResponsavel, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna os usuário responsáveis relacionados a conta. |
| |
Parâmetros | Descrição |
| |
QP_account | 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. |
| |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas