Partilhar via


Blackbaud CRM Prospect (Visualização)

O Blackbaud CRM é uma solução abrangente de software de angariação de fundos e gestão de doadores de nível empresarial criada especificamente para organizações sem fins lucrativos e toda a comunidade social. Use o conector Prospect para gerenciar prospects, planos e oportunidades.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Editora Blackbaud, Inc.
Sítio Web https://www.blackbaud.com/products/blackbaud-crm
Política de privacidade https://www.blackbaud.com/privacy-shield
Categorias Vendas e CRM; Produtividade

O Blackbaud CRM é o sistema de gestão de angariação de fundos mais poderoso do mundo, criado especificamente para equipas de angariação de fundos de ensino superior e sem fins lucrativos à escala empresarial.

Esse conector é construído com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar clientes potenciais e entidades relacionadas encontradas no Blackbaud CRM.

Para mais informações, consulte a documentação.

Pré-requisitos

Para usar esse conector, você deve ter uma conta Blackbaud ID com acesso a um ou mais ambientes Blackbaud.

Além disso, o administrador da sua organização também deve executar uma ação de nível de administrador dentro do sistema para permitir que esse conector acesse seu ambiente Blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de configuração inicial .

Como obter credenciais?

O administrador da sua organização enviará um convite para o ambiente Blackbaud CRM da organização e configurará as permissões da sua conta de utilizador no ambiente. Não são necessárias credenciais adicionais para usar esse conector.

Problemas conhecidos e limitações

O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às suas permissões de usuário dentro do ambiente.

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar um cliente potencial

Atualiza um prospect.

Atualizar um relatório de contatos

Atualiza um relatório de contato.

Atualizar uma etapa do plano de mordomia

Atualiza uma etapa do plano de mordomia.

Atualizar uma etapa importante do plano de doação

Atualiza uma etapa importante do plano de doação.

Atualizar uma oportunidade

Atualiza uma oportunidade de plano de prospect.

Criar um círculo eleitoral em potencial

Cria um novo círculo eleitoral prospetivo para um eleitorado.

Criar um plano de mordomia

Cria um novo plano de administração para um prospect.

Criar um relatório de contato não planejado

Cria um novo relatório de contato não planejado para um plano.

Criar uma etapa do plano de mordomia

Cria uma nova etapa do plano de mordomia.

Criar uma oportunidade

Cria uma nova oportunidade de plano de prospeção.

Crie um grande plano de doação

Cria um novo plano de doação importante para um prospect.

Crie uma etapa importante do plano de doação

Cria uma nova etapa principal do plano de doação.

Excluir um plano de administração

Exclui um plano de mordomia.

Excluir um plano de doação principal

Exclui um plano de doação importante.

Excluir uma etapa do plano de administração

Exclui uma etapa do plano de mordomia.

Excluir uma etapa importante do plano de doação

Exclui uma etapa importante do plano de doação.

Excluir uma oportunidade

Exclui uma oportunidade de plano de cliente potencial.

Listar oportunidades do plano

Lista as oportunidades para um plano de prospect.

Listar planos de prospeção

Lista os planos para um prospect.

Obtenha um grande plano de doação

Retorna informações para um plano de doação principal.

Obter um resumo do cliente potencial

Devolve informações de prospeção para um constituinte.

Procurar clientes potenciais

Procura registros de clientes potenciais usando os critérios de filtro fornecidos.

Procurar oportunidades de prospeção

Procura registros de oportunidades de clientes potenciais usando os critérios de filtro fornecidos.

Receba uma oportunidade

Retorna informações para uma oportunidade de plano de prospect.

Atualizar um cliente potencial

Atualiza um prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registro do sistema do componente potencial a ser atualizado.

ID do Gestor
prospect_manager_fundraiser_id string

O ID de registro do sistema do componente do gerente de prospeção.

Situação
prospect_status string

O status do prospeto.

Atualizar um relatório de contatos

Atualiza um relatório de contato.

Parâmetros

Name Chave Necessário Tipo Description
ID do relatório
contact_report_id True string

O ID de registro do sistema do relatório de contato a ser atualizado.

Objective
objective string

O objetivo da etapa. Limite de caracteres: 100.

Proprietário
owner_id string

O ID de registro do sistema do constituinte da arrecadação de fundos do proprietário do relatório de contato.

Data real
actual_date date

A data real da etapa (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fase
prospect_plan_status string

O estágio para a etapa do plano.

Método de contacto
interaction_type string

O método de contato de interação para a etapa.

Categoria
interaction_category string

A categoria de interação de etapa.

Subcategoria
interaction_subcategory string

A subcategoria de interação de etapa.

Comment
comment string

O comentário da etapa.

Atualizar uma etapa do plano de mordomia

Atualiza uma etapa do plano de mordomia.

Parâmetros

Name Chave Necessário Tipo Description
ID do passo
step_id True string

O ID de registro do sistema da etapa do plano de administração a ser atualizado.

Objective
objective string

O objetivo da etapa. Limite de caracteres: 100.

Data alvo
target_date date

Data-limite (ex: «2005-09-18»).

Bloqueado?
date_locked boolean

A data-alvo está bloqueada?

Evento de dia inteiro?
all_day_event boolean

A interação é um evento de dia inteiro?

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário para a etapa.

Situação
status string

O status da etapa do plano.

Categoria
category string

A categoria da etapa do plano.

Atribuído a
constituent_id string

O ID de registo do sistema do constituinte da angariação de fundos do proprietário do passo.

Método de contacto
contact_method string

O método de contato de interação para a etapa.

Frequência
recurs string

A frequência do passo.

Data de início
start_date date

A data real da etapa (ex: '2005-09-18').

Data de fim
end_date date

A data real da etapa (ex: '2005-09-18').

Próxima data prevista
next_target_date date

A próxima etapa: data-limite (ex: "2005-09-18").

Ligue-se a
link_type string

O tipo de registro conectado à etapa.

ID do benefício
benefit_id string

O ID de registro do sistema do benefício conectado.

ID do Evento
event_id string

A ID de registro do sistema do evento conectado.

ID para correspondência
mailing_id string

O ID de registro do sistema da correspondência conectada.

Data real
actual_date date

A data real da etapa (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Atualizar uma etapa importante do plano de doação

Atualiza uma etapa importante do plano de doação.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
v_prospect_plan_id True string

O ID de registro do sistema do plano de doação principal.

ID do passo
step_id True string

O ID de registro do sistema da etapa principal do plano de doação a ser atualizado.

Objective
objective string

O objetivo da etapa. Limite de caracteres: 100.

Tipo
prospect_plan_status string

O estágio para a etapa do plano.

Situação
status string

O status da etapa do plano.

Data prevista
expected_date date

A data prevista da etapa (ex: '2005-09-18').

Proprietário
owner_id string

O ID de registo do sistema do constituinte da angariação de fundos do proprietário do passo.

Comment
comment string

O comentário da etapa.

Método de contacto
interaction_type string

O método de contato de interação para a etapa.

Categoria
interaction_category string

A categoria de interação de etapa.

Subcategoria
interaction_subcategory string

A subcategoria de interação de etapa.

Evento de dia inteiro?
is_all_day_event boolean

A interação é um evento de dia inteiro?

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário para a etapa.

Data real
actual_date date

A data real da etapa (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Outra localização
other_location string

O outro local para a interação da etapa. Limite de caracteres: 300.

Atualizar uma oportunidade

Atualiza uma oportunidade de plano de prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID da oportunidade
opportunity_id True string

O ID de registro do sistema da oportunidade de atualização.

Situação
status string

O status da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Valor esperado de pedido
expected_ask_amount double

O valor esperado pede.

Data prevista para a pergunta
expected_ask_date date

A data prevista para a pergunta (ex: '2005-09-18').

Probabilidade
likelihood_type_code string

A oportunidade é provável.

Pedir montante
ask_amount double

O valor pedido.

Pedir data
ask_date date

A data de pedido (ex: '2005-09-18').

Montante aceite
accepted_amount double

O valor pedido aceito.

Data de resposta
response_date date

A data de resposta (ex: '2005-09-18').

Comment
comment string

O comentário da oportunidade.

Moeda da transação
transaction_currency string

A moeda da transação.

Criar um círculo eleitoral em potencial

Cria um novo círculo eleitoral prospetivo para um eleitorado.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Data de
date_from date

Data de início do círculo eleitoral (ex: «2005-09-18»).

Data para
date_to date

Data de termo para o círculo eleitoral (ex: «2005-09-18»).

Devoluções

Círculo eleitoral prospetivo criado

Criar um plano de mordomia

Cria um novo plano de administração para um prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID do prospeto
constituent_id True string

O ID de registro do sistema do componente prospeto.

Nome
name True string

O nome do plano. Limite de caracteres: 100.

Tipo
plan_type_id string

O tipo de plano.

Subtipo
plan_sub_type_id string

O subtipo de plano.

Data de início
start_date date

Data de início do plano (ex: '2005-09-18').

ID do Gestor
manager_id string

O ID de registo do sistema do gestor potencial de angariação de fundos.

Data de início do gestor
manager_start_date date

Data de início do gestor (ex: '2005-09-18').

ID
constituent_id True string

O ID de registro do sistema do componente steward.

função
role string

O papel de mordomo.

data de início
start_date date

A data de início do steward (ex: '2005-09-18').

Devoluções

Criação de plano de mordomia

Criar um relatório de contato não planejado

Cria um novo relatório de contato não planejado para um plano.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
prospect_plan_id True string

O ID de registro do sistema do plano de doação principal.

Objective
objective True string

O objetivo da etapa. Limite de caracteres: 100.

Proprietário
owner_id string

O ID de registro do sistema do constituinte da arrecadação de fundos do proprietário do relatório de contato.

Data real
actual_date True date

A data real da etapa (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fase
prospect_plan_status True string

O estágio para a etapa do plano.

Método de contacto
interaction_type True string

O método de contato de interação para a etapa.

Categoria
interaction_category string

A categoria de interação de etapa.

Subcategoria
interaction_subcategory string

A subcategoria de interação de etapa.

Comment
comment True string

O comentário da etapa.

ID
fundraiser_id True string

O ID de registo do sistema do constituinte da angariação de fundos.

ID
constituent_id True string

O ID de registo do sistema do constituinte participante.

Devoluções

Relatório de contato não planejado criado

Criar uma etapa do plano de mordomia

Cria uma nova etapa do plano de mordomia.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
stewardship_plan_id True string

O ID de registro do sistema do plano de mordomia.

Objective
objective True string

O objetivo da etapa. Limite de caracteres: 100.

Data alvo
target_date True date

Data-limite (ex: «2005-09-18»).

Bloqueado?
date_locked boolean

A data-alvo está bloqueada?

Evento de dia inteiro?
all_day_event boolean

A interação é um evento de dia inteiro?

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário para a etapa.

Situação
status_code string

O status da etapa do plano.

Categoria
category string

A categoria da etapa do plano.

Atribuído a
constituent_id string

O ID de registo do sistema do constituinte da angariação de fundos do proprietário do passo.

Método de contacto
contact_method string

O método de contato de interação para a etapa.

Frequência
recurs True string

A frequência do passo.

Data de início
start_date date

A data real da etapa (ex: '2005-09-18').

Data de fim
end_date date

A data real da etapa (ex: '2005-09-18').

Próxima data prevista
next_target_date date

A próxima etapa: data-limite (ex: "2005-09-18").

Ligue-se a
link_type_code string

O tipo de registro conectado à etapa.

ID do benefício
benefit_id string

O ID de registro do sistema do benefício conectado.

ID do Evento
event_id string

A ID de registro do sistema do evento conectado.

ID para correspondência
mailing_id string

O ID de registro do sistema da correspondência conectada.

Data real
actual_date date

A data real da etapa (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

ID
constituent_id True string

O ID de registo do sistema do constituinte participante.

ID do plano
prospect_plan_id True string

O ID de registro do sistema do plano associado.

Devoluções

Criação da etapa do plano de mordomia

Criar uma oportunidade

Cria uma nova oportunidade de plano de prospeção.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
prospect_plan_id True string

O ID de registro do sistema do plano de prospect.

Situação
status True string

O status da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Valor esperado de pedido
expected_ask_amount double

O valor esperado pede.

Data prevista para a pergunta
expected_ask_date date

A data prevista para a pergunta (ex: '2005-09-18').

Probabilidade
likelihood_type_code string

A oportunidade é provável.

Pedir montante
ask_amount double

O valor pedido.

Pedir data
ask_date date

A data de pedido (ex: '2005-09-18').

Montante aceite
accepted_amount double

O valor pedido aceito.

Data de resposta
response_date date

A data de resposta (ex: '2005-09-18').

Comment
comment string

O comentário da oportunidade.

Moeda da transação
transaction_currency string

A moeda da transação.

Devoluções

Criação de oportunidade de prospeção

Crie um grande plano de doação

Cria um novo plano de doação importante para um prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID do prospeto
prospect_id True string

O ID de registro do sistema do componente prospeto.

Nome
prospect_plan_name True string

O nome do plano. Limite de caracteres: 100.

Tipo
prospect_plan_type True string

O tipo de plano.

Data de início
start_date date

Data de início do plano (ex: '2005-09-18').

Narrativa
narrative string

A narrativa do plano. Limite de caracteres: 1000.

ID do gestor principal
primary_manager_fundraiser_id string

O ID de registro do sistema do principal captador de fundos do gerente de prospetos.

Data de início da primária
primary_manager_date_from date

A data de início do gestor principal (ex: '2005-09-18').

ID do gestor secundário
secondary_manager_fundraiser_id string

O ID de registro do sistema do angariador de fundos secundário do gestor de prospetos.

Data de início secundária
secondary_manager_date_from date

A data de início do gestor secundário (ex: '2005-09-18').

ID
constituent_id True string

O ID de registo do sistema do participante constituinte.

função
plan_participant_role string

O papel do participante.

ID
fundraiser_id True string

O ID de registo do sistema do constituinte secundário da angariação de fundos.

função
solicitor_role string

O papel de angariador de fundos.

start
date_from date

Data de início da angariação de fundos secundária (ex: '2005-09-18').

Devoluções

Criou um grande plano de doações

Crie uma etapa importante do plano de doação

Cria uma nova etapa principal do plano de doação.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
prospect_plan_id True string

O ID de registro do sistema do plano de doação principal.

Objective
objective True string

O objetivo da etapa. Limite de caracteres: 100.

Tipo
prospect_plan_status True string

O estágio para a etapa do plano.

Situação
status True string

O status da etapa do plano.

Data prevista
expected_date True date

A data prevista da etapa (ex: '2005-09-18').

Proprietário
owner_id string

O ID de registo do sistema do constituinte da angariação de fundos do proprietário do passo.

Comment
comment string

O comentário da etapa.

Método de contacto
interaction_type string

O método de contato de interação para a etapa.

Categoria
interaction_category string

A categoria de interação de etapa.

Subcategoria
interaction_subcategory string

A subcategoria de interação de etapa.

Evento de dia inteiro?
is_all_day_event boolean

A interação é um evento de dia inteiro?

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário para a etapa.

Data real
actual_date date

A data real da etapa (ex: '2005-09-18').

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Localização
location string

A localização do passo.

Outra localização
other_location string

O outro local para a interação da etapa. Limite de caracteres: 300.

ID
fundraiser_id True string

O ID de registo do sistema do constituinte da angariação de fundos.

ID
constituent_id True string

O ID de registo do sistema do constituinte participante.

Devoluções

Criou uma grande etapa do plano de doação

Excluir um plano de administração

Exclui um plano de mordomia.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
plan_id True string

A ID de registro do sistema do plano de administração a ser excluído.

Excluir um plano de doação principal

Exclui um plano de doação importante.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
plan_id True string

O ID de registro do sistema do plano principal de doação para excluir.

Excluir uma etapa do plano de administração

Exclui uma etapa do plano de mordomia.

Parâmetros

Name Chave Necessário Tipo Description
ID do passo
step_id True string

O ID de registro do sistema da etapa do plano de administração a ser excluída.

Excluir uma etapa importante do plano de doação

Exclui uma etapa importante do plano de doação.

Parâmetros

Name Chave Necessário Tipo Description
ID do passo
step_id True string

O ID de registro do sistema da etapa principal do plano de doação a ser excluída.

Excluir uma oportunidade

Exclui uma oportunidade de plano de cliente potencial.

Parâmetros

Name Chave Necessário Tipo Description
ID da oportunidade
opportunity_id True string

O ID de registro do sistema da oportunidade de exclusão.

Listar oportunidades do plano

Lista as oportunidades para um plano de prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
plan_id True string

O ID de registro do sistema do plano de prospect.

Situação
status string

Filtre os resultados para oportunidades com o status especificado.

Devoluções

Oportunidades

Listar planos de prospeção

Lista os planos para um prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registro do sistema do componente prospeto.

Incluir inativos?
include_inactive_plans boolean

Incluir planos inativos?

Devoluções

Planos de prospeção

Obtenha um grande plano de doação

Retorna informações para um plano de doação principal.

Parâmetros

Name Chave Necessário Tipo Description
ID do plano
plan_id True string

O ID de registro do sistema do plano de doação principal.

Devoluções

Plano de doações principais

Obter um resumo do cliente potencial

Devolve informações de prospeção para um constituinte.

Parâmetros

Name Chave Necessário Tipo Description
ID do constituinte
constituent_id True string

O ID de registo do sistema do constituinte.

Devoluções

Resumo do prospeto

Procurar clientes potenciais

Procura registros de clientes potenciais usando os critérios de filtro fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Nome da chave
key_name string

O nome da chave constituinte (sobrenome para indivíduos, nome da organização para organizações).

Nome próprio
first_name string

O primeiro nome do constituinte.

ID de pesquisa
lookup_id string

O ID de pesquisa do constituinte.

Número de telefone
phone_number string

O número de telefone do constituinte.

Country
country string

Um filtro para o país de endereço do constituinte.

Address
address_block string

Um filtro para o bloco de endereços constituinte.

City
city string

Um filtro para a cidade de endereço do constituinte.

Estado
state string

Um filtro para o estado do endereço do constituinte.

Código postal
post_code string

Um filtro para o código postal do endereço constituinte.

Corresponde exatamente?
exact_match_only boolean

Corresponde exatamente a todos os critérios?

Círculo eleitoral
constituency string

Um filtro para o círculo eleitoral do constituinte.

Só perspetivas?
only_prospects boolean

Incluir apenas potenciais constituintes?

Só angariadores de fundos?
only_fundraisers boolean

Incluir apenas os constituintes da angariação de fundos?

Só pessoal?
only_staff boolean

Incluir apenas os componentes do pessoal?

Só voluntários?
only_volunteers boolean

Incluir apenas voluntários?

Só primária?
only_primary_address boolean

Pesquise apenas endereços primários?

Incluir falecido?
include_deceased boolean

Incluir eleitores falecidos?

Incluir inativos?
include_inactive boolean

Incluir constituintes inativos?

Usa a pesquisa difusa?
fuzzy_search_on_name boolean

Usa pesquisa difusa no nome?

Limite
limit integer

Representa o número de registros a serem retornados.

Devoluções

Resultados da pesquisa

Procurar oportunidades de prospeção

Procura registros de oportunidades de clientes potenciais usando os critérios de filtro fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
Nome da chave
keyname string

O nome da chave constituinte (sobrenome para indivíduos, nome da organização para organizações).

Nome próprio
firstname string

O primeiro nome do constituinte.

ID de pesquisa
lookup_id string

O ID de pesquisa do constituinte.

Corresponde exatamente?
exactmatchonly boolean

Corresponde exatamente a todos os critérios?

Situação
status string

Filtre os resultados para o status de oportunidade especificado.

Pedir data
ask_date date

Filtre os resultados com base na data de solicitação da oportunidade.

Pedir montante
ask_amount double

Filtre os resultados com base no valor de solicitação de oportunidade.

ID de utilizador da designação
designationuserid string

Filtrar os resultados para o ID de registro do sistema do usuário de designação especificado

Só perspetivas?
only_prospects boolean

Incluir apenas potenciais constituintes?

Só angariadores de fundos?
only_fundraisers boolean

Incluir apenas os constituintes da angariação de fundos?

Só pessoal?
only_staff boolean

Incluir apenas os componentes do pessoal?

Só voluntários?
only_volunteers boolean

Incluir apenas voluntários?

Só primária?
only_primary_address boolean

Pesquise apenas endereços primários?

Incluir falecido?
includedeceased boolean

Incluir eleitores falecidos?

Incluir inativos?
includeinactive boolean

Incluir constituintes inativos?

Verificar apelido?
checknickname boolean

Verificar apelido ao pesquisar?

Verificar aliases?
checkaliases boolean

Verificar aliases ao pesquisar?

Verificar IDs de pesquisa alt?
checkalternatelookupids boolean

Verificar IDs de pesquisa alternativos ao pesquisar?

Limite
limit integer

Representa o número de registros a serem retornados.

Devoluções

Resultados da pesquisa

Receba uma oportunidade

Retorna informações para uma oportunidade de plano de prospect.

Parâmetros

Name Chave Necessário Tipo Description
ID da oportunidade
opportunity_id True string

O ID de registro do sistema da oportunidade de atualização.

Devoluções

Oportunidade

Definições

Prsmg.CreatedMajorGivingPlan

Criou um grande plano de doações

Name Caminho Tipo Description
ID
id string

O ID do plano de doação principal recém-criado.

Prsmg.CreatedMajorGivingPlanStep

Criou uma grande etapa do plano de doação

Name Caminho Tipo Description
ID
id string

O ID da etapa do plano de doação principal recém-criada.

Prsmg.CreatedProspectConstituency

Círculo eleitoral prospetivo criado

Name Caminho Tipo Description
ID
id string

O ID do círculo eleitoral prospetivo recém-criado.

Prsmg.CreatedProspectOpportunity

Criação de oportunidade de prospeção

Name Caminho Tipo Description
ID
id string

O ID da oportunidade de cliente potencial recém-criada.

Prsmg.CreatedStewardshipPlan

Criação de plano de mordomia

Name Caminho Tipo Description
ID
id string

A ID do plano de administração recém-criado.

Prsmg.CreatedStewardshipPlanStep

Criação da etapa do plano de mordomia

Name Caminho Tipo Description
ID
id string

A ID da etapa do plano de administração recém-criada.

Prsmg.CreatedUnplannedContactReport

Relatório de contato não planejado criado

Name Caminho Tipo Description
ID
id string

A ID do relatório de contato não planejado recém-criado.

Prsmg.MajorGivingPlan

Plano de doações principais

Name Caminho Tipo Description
ID do prospeto
prospect_id string

O ID de registro do sistema do prospect.

Nome do prospeto
prospect string

O nome do prospeto.

Nome
prospect_plan_name string

O principal dando nome ao plano.

Tipo
prospect_plan_type string

O tipo de plano de prospect.

Data de início do ano fiscal
fiscal_year_start_date date-time

A data de início do ano fiscal.

Data de fim do exercício fiscal
fiscal_year_end_date date-time

A data de fim do ano fiscal.

Steps
steps array of Prsmg.MajorGivingPlanStep

As etapas do plano.

Prsmg.MajorGivingPlanStep

Etapa principal do plano de doação

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da etapa principal do plano de doação.

Planejar ID da etapa da estrutura de tópicos
plan_outline_step_id string

A ID de registro do sistema da etapa de estrutura de tópicos do plano.

Objective
objective string

O objetivo da etapa.

Tipo
prospect_plan_status string

O estágio para a etapa do plano.

Situação
status string

O status da etapa do plano.

Data prevista
expected_date date

A etapa data esperada.

Proprietário
fundraiser_id string

O ID de registo do sistema do constituinte da angariação de fundos do proprietário do passo.

Evento de dia inteiro?
all_day_event boolean

A interação é um evento de dia inteiro?

hora
expected_start_time.hour integer

A hora.

minuto
expected_start_time.minute integer

O minuto.

hora
expected_end_time.hour integer

A hora.

minuto
expected_end_time.minute integer

O minuto.

Fuso horário
time_zone_entry string

O fuso horário para a etapa.

Data real
actual_date date

A data real da etapa (ex: '2005-09-18').

hora
actual_start_time.hour integer

A hora.

minuto
actual_start_time.minute integer

O minuto.

hora
actual_end_time.hour integer

A hora.

minuto
actual_end_time.minute integer

O minuto.

Comment
comment string

O comentário da etapa.

Método de contacto
interaction_type string

O método de contato de interação para a etapa.

Categoria
interaction_category string

A categoria de interação de etapa.

Subcategoria
interaction_subcategory string

A subcategoria de interação de etapa.

Localização
location string

O local de interação da etapa.

Outra localização
other_location string

O outro local para a interação da etapa.

Angariações de fundos adicionais
additional_fundraisers array of Prsmg.MajorGivingPlanStepAdditionalFundraiser

A etapa interage angariações de fundos adicionais.

Participants
participants array of Prsmg.MajorGivingPlanStepParticipant

Os participantes da interação da etapa.

Prsmg.MajorGivingPlanStepAdicionalAngariação de fundos

Plano de doações principais etapa angariação de fundos adicional

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do principal angariador de fundos da etapa do plano de doação.

ID da angariação de fundos
fundraiser_id string

O ID de registro do sistema do principal constituinte da etapa de arrecadação de fundos do plano de doação.

Prsmg.MajorGivingPlanStepParticipante

Participante principal da etapa do plano de doação

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do participante principal da etapa do plano de doação.

ID do Participante
constituent_id string

O ID de registro do sistema do componente participante da etapa principal do plano de doação.

Prsmg.PlanOpportunity

Oportunidade

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Situação
status string

O status da oportunidade.

Montante
amount double

O valor da oportunidade.

Data prevista para a pergunta
expected_ask_date date-time

A data prevista para a oportunidade.

Pedir data
ask_date date-time

A data de pedido para a oportunidade.

Data de resposta
response_date date-time

A data de resposta para a oportunidade.

ID da moeda base
base_currency_id string

O ID de registro do sistema da moeda base para a oportunidade.

Prsmg.PlanOpportunityCollection

Oportunidades

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Prsmg.PlanOpportunity

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Prsmg.ProspectOpportunitySearchResult

Resultado da pesquisa

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da oportunidade.

Situação
status string

O status da oportunidade.

Pedir montante
ask_amount double

A oportunidade pede valor.

Pedir data
ask_date date-time

A data de pedido para a oportunidade.

Designação
designation date-time

A designação da oportunidade.

ID da moeda da transação
transaction_currency_id string

O ID de registro do sistema da moeda da transação para a oportunidade.

Tipo de plano
prospect_plan_type string

O tipo de plano de prospect.

Nome do plano
prospect_plan_name string

O nome do plano de prospect.

ID de pesquisa
lookup_id string

O ID de pesquisa para o cliente potencial.

Nome do prospeto
name string

O nome do prospeto.

Prsmg.ProspectOpportunitySearchResultCollection

Resultados da pesquisa

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of Prsmg.ProspectOpportunitySearchResult

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Prsmg.ProspectOpportunity

Oportunidade

Name Caminho Tipo Description
Header
header string

O cabeçalho da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Situação
status string

O status da oportunidade.

Valor esperado de pedido
expected_ask_amount double

A oportunidade esperada pedir montante.

Data prevista para a pergunta
expected_ask_date date-time

A data prevista para a oportunidade.

Probabilidade
likelihood_type_code string

A oportunidade é provável.

Pedir montante
ask_amount double

A oportunidade pede valor.

Pedir data
ask_date date-time

A data de pedido para a oportunidade.

Montante aceite
accepted_amount double

O valor da oportunidade aceite.

Data de resposta
response_date date-time

A data de resposta para a oportunidade.

ID da moeda da transação
transaction_currency string

O ID de registro do sistema da moeda da transação para a oportunidade.

Comment
comment string

O comentário da oportunidade.

ID do prospeto
prospect_id string

O ID de registro do sistema do prospect.

Nome do plano de prospeção
prospect_plan string

O nome do plano de prospect.

Denominações
designation array of Prsmg.ProspectOpportunityDesignation

As designações de oportunidade.

Prsmg.ProspectOpportunityDesignation

Designação de oportunidade de prospeção

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da designação de oportunidade do prospect.

ID de designação
designation_id string

O ID de registo do sistema da designação.

Montante
amount double

O montante da designação.

Método de financiamento
funding_method string

O método de financiamento da designação.

categoria
category string

A categoria de designação.

tipo
type string

O tipo de designação.

código de uso
use string

O código de utilização da designação.

constituinte
constituent string

O componente de designação.

constituinte
constituent_name string

O nome constituinte da designação.

ID da moeda da transação
transaction_currency_id string

O ID de registro do sistema da moeda da transação de designação.

sequência
sequence integer

A sequência de designação.

Prsmg.ProspectPlan

Plano de prospeção

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do plano de prospect.

Nome
plan_name string

O nome do plano de prospect.

Tipo
plan_type string

O tipo de plano de prospect.

É mordomia?
stewardship_plan boolean

É um plano de mordomia?

Ativo?
active boolean

O plano está ativo?

Data de início
start_date date-time

A data de início do plano.

Próxima ID de interação
next_interaction_id string

O ID de registro do sistema da próxima interação.

Data de adição
date_added date

A data em que o plano foi adicionado.

Prsmg.ProspectPlanCollection

Planos de prospeção

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.

valor
value array of Prsmg.ProspectPlan

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Prsmg.ProspectSearchResult

Resultado da pesquisa

Name Caminho Tipo Description
ID
id string

O ID de registo do sistema do constituinte.

Nome
name string

O nome do constituinte. Para indivíduos, esse campo calculado indica o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino.

Gestor de prospeção
prospect_manager string

O gestor de prospeção do constituinte.

Gestor(es) principal(is)
primary_managers string

O(s) gestor(es) principal(is) do plano.

ID de pesquisa
lookup_id string

O identificador definido pelo utilizador para o constituinte.

Nome da ordenação
sort_constituent_name string

O nome da classificação constituinte.

Tipo de constituinte
constituent_type string

O tipo constituinte.

Address
address string

Endereço preferencial do eleitor.

City
city string

A cidade de endereço preferida do eleitor.

Estado
state string

O endereço preferencial do eleitor, indica.

Código postal
post_code string

Código postal do endereço preferencial do eleitor.

Telemóvel
phone string

O telefone do eleitor.

Prsmg.ProspectSearchResultCollection

Resultados da pesquisa

Name Caminho Tipo Description
Contar
count integer

O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação.

valor
value array of Prsmg.ProspectSearchResult

O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Prsmg.ProspectSummary

Resumo do prospeto

Name Caminho Tipo Description
É prospeto?
prospect boolean

O constituinte é uma perspetiva?

Está sinalizado?
flagged boolean

O prospeto está sinalizado?

Situação
prospect_status string

O status do prospeto.

Nome do gerente
prospect_manager_name string

O nome do gerente de prospect.

ID do Gestor
prospect_manager_fundraiser_id string

O ID de registro do sistema do componente do gerente de prospeção.

Data de início
prospect_manager_start_date date-time

A data de início do gerente de prospect.