Compartilhar via


Perspectiva do BLACKbaud CRM (versão prévia)

A Blackbaud CRM é uma solução abrangente de software de captação de recursos e gerenciamento de doadores de nível empresarial criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social. Use o conector Prospect para gerenciar perspectivas, planos e oportunidades.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte do Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Publicador Blackbaud, Inc.
Site 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 captação de recursos mais poderoso do mundo, criado para equipes de arrecadação de fundos sem fins lucrativos e de ensino superior em escala empresarial.

Esse conector é baseado na API SKY da Blackbaud e fornece operações para ajudar a gerenciar perspectivas e entidades relacionadas encontradas no BLACKbaud CRM.

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

Pré-requisitos

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

Além disso, o administrador da sua organização também deve executar uma ação no nível do 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 instalação inicial .

Como obter credenciais?

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

Problemas e limitações conhecidos

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

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar um relatório de contatos

Atualiza um relatório de contatos.

Atualizar uma etapa do plano de administração

Atualiza uma etapa do plano de administração.

Atualizar uma etapa principal do plano de concessão

Atualiza uma etapa principal do plano de concessão.

Atualizar uma oportunidade

Atualiza uma oportunidade de plano de perspectiva.

Atualizar uma perspectiva

Atualiza uma perspectiva.

Criar um eleitorado de perspectiva

Cria um novo eleitorado de perspectiva para um constituinte.

Criar um plano de administração

Cria um novo plano de administração para uma perspectiva.

Criar um plano de doação principal

Cria um novo grande plano de doação para uma perspectiva.

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 de plano de administração

Cria uma nova etapa de plano de administração.

Criar uma etapa principal do plano de doação

Cria uma nova etapa principal do plano de concessão.

Criar uma oportunidade

Cria uma nova oportunidade de plano de perspectiva.

Excluir um plano de administração

Exclui um plano de administração.

Excluir um plano de doação principal

Exclui um plano principal de doação.

Excluir uma etapa do plano de administração

Exclui uma etapa do plano de administração.

Excluir uma etapa principal do plano de doação

Exclui uma etapa principal do plano de concessão.

Excluir uma oportunidade

Exclui uma oportunidade de plano de perspectiva.

Listar oportunidades de plano

Lista as oportunidades para um plano de perspectiva.

Listar planos de perspectiva

Lista os planos para uma perspectiva.

Obter um plano de doação principal

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

Obter um resumo de perspectiva

Retorna informações de perspectiva para um constituinte.

Obter uma oportunidade

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

Pesquisar oportunidades de perspectiva

Pesquisa registros de oportunidade de perspectiva usando os critérios de filtro especificados.

Pesquisar perspectivas

Pesquisa registros de perspectiva usando os critérios de filtro especificados.

Atualizar um relatório de contatos

Atualiza um relatório de contatos.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Relatório
contact_report_id True string

A ID do 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

A ID de registro do sistema do componente de arrecadação de fundos do proprietário do relatório de contatos.

Data real
actual_date date

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

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Etapa
prospect_plan_status string

O estágio da etapa de plano.

Método contact
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 da etapa.

Comment
comment string

O comentário da etapa.

Atualizar uma etapa do plano de administração

Atualiza uma etapa do plano de administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da etapa
step_id True string

A ID de registro do sistema da etapa do plano de administração a ser atualizada.

Objective
objective string

O objetivo da etapa. Limite de caracteres: 100.

Data de destino
target_date date

A data de destino da etapa (por exemplo: '2005-09-18').

Trancado?
date_locked boolean

A data de destino está bloqueada?

Evento durante todo o dia?
all_day_event boolean

A interação é um evento durante todo o dia?

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 da etapa.

Situação
status string

O status da etapa de plano.

Categoria
category string

A categoria da etapa de plano.

Atribuído a
constituent_id string

A ID do registro do sistema do constituinte de arrecadação de fundos do proprietário da etapa.

Método contact
contact_method string

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

Frequência
recurs string

A frequência da etapa.

Data de início
start_date date

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

Data de término
end_date date

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

Próxima data de destino
next_target_date date

A próxima data de destino da etapa (por exemplo: '2005-09-18').

Conectar-se a
link_type string

O tipo de registro conectado à etapa.

ID do benefício
benefit_id string

A ID do registro do sistema do benefício conectado.

ID do evento
event_id string

A ID do registro do sistema do evento conectado.

ID de endereçamento
mailing_id string

A ID do registro do sistema do endereçamento conectado.

Data real
actual_date date

A data real da etapa (por exemplo: '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 principal do plano de concessão

Atualiza uma etapa principal do plano de concessão.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
v_prospect_plan_id True string

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

ID da etapa
step_id True string

A ID de registro do sistema da etapa principal do plano de fornecimento para atualizar.

Objective
objective string

O objetivo da etapa. Limite de caracteres: 100.

Tipo
prospect_plan_status string

O estágio da etapa de plano.

Situação
status string

O status da etapa de plano.

Data esperada
expected_date date

A data esperada da etapa (por exemplo: '2005-09-18').

Proprietário
owner_id string

A ID do registro do sistema do constituinte de arrecadação de fundos do proprietário da etapa.

Comment
comment string

O comentário da etapa.

Método contact
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 da etapa.

Evento durante todo o dia?
is_all_day_event boolean

A interação é um evento durante todo o dia?

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 da etapa.

Data real
actual_date date

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

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Outro local
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 perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da oportunidade
opportunity_id True string

A ID de registro do sistema da oportunidade de atualizar.

Situação
status string

O status da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Valor de solicitação esperado
expected_ask_amount double

O valor de solicitação esperado.

Data de pergunta esperada
expected_ask_date date

A data de pergunta esperada (por exemplo: '2005-09-18').

Probabilidade
likelihood_type_code string

A probabilidade de oportunidade.

Valor da solicitação
ask_amount double

O valor da solicitação.

Data da pergunta
ask_date date

A data da pergunta (por exemplo: '2005-09-18').

Valor aceito
accepted_amount double

O valor de solicitação aceito.

Data da resposta
response_date date

A data da resposta (por exemplo: '2005-09-18').

Comment
comment string

O comentário de oportunidade.

Moeda da transação
transaction_currency string

A moeda da transação.

Atualizar uma perspectiva

Atualiza uma perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
constituent_id True string

A ID do registro do sistema do constituinte de perspectiva a ser atualizado.

ID do gerente
prospect_manager_fundraiser_id string

A ID do registro do sistema do constituinte do gerenciador de perspectivas.

Situação
prospect_status string

O status da perspectiva.

Criar um eleitorado de perspectiva

Cria um novo eleitorado de perspectiva para um constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
constituent_id True string

A ID do registro do sistema do constituinte.

Data de
date_from date

A data de início do eleitorado (por exemplo: '2005-09-18').

Data para
date_to date

A data de término do eleitorado (por exemplo: '2005-09-18').

Retornos

Criação do eleitorado de perspectiva

Criar um plano de administração

Cria um novo plano de administração para uma perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de perspectiva
constituent_id True string

A ID do registro do sistema do constituinte de perspectiva.

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 do plano.

Data de início
start_date date

A data de início do plano (por exemplo: '2005-09-18').

ID do gerente
manager_id string

A ID do registro do sistema do gerente de arrecadação de fundos.

Data de início do gerente
manager_start_date date

A data de início do gerente (por exemplo: '2005-09-18').

ID
constituent_id True string

A ID do registro do sistema do constituinte do administrador.

função
role string

O papel de administrador.

data de início
start_date date

A data de início do administrador (por exemplo: '2005-09-18').

Retornos

Plano de administração criado

Criar um plano de doação principal

Cria um novo grande plano de doação para uma perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de perspectiva
prospect_id True string

A ID do registro do sistema do constituinte de perspectiva.

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

A data de início do plano (por exemplo: '2005-09-18').

Narrativa
narrative string

A narrativa do plano. Limite de caracteres: 1000.

ID do gerente primário
primary_manager_fundraiser_id string

A ID do registro do sistema da principal arrecadação de fundos do gerente de perspectivas.

Data de início primária
primary_manager_date_from date

A data de início do gerente primário (por exemplo: '2005-09-18').

ID do gerente secundário
secondary_manager_fundraiser_id string

A ID do registro do sistema da arrecadação de fundos do gerente secundário.

Data de início secundária
secondary_manager_date_from date

A data de início do gerente secundário (por exemplo: '2005-09-18').

ID
constituent_id True string

A ID do registro do sistema do participante constituinte.

função
plan_participant_role string

A função de participante.

ID
fundraiser_id True string

A ID de registro do sistema do constituinte secundário da arrecadação de fundos.

função
solicitor_role string

O papel da arrecadação de fundos.

start
date_from date

A data de início da arrecadação de fundos secundária (por exemplo: '2005-09-18').

Retornos

Plano de doação principal criado

Criar um relatório de contato não planejado

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
prospect_plan_id True string

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

Objective
objective True string

O objetivo da etapa. Limite de caracteres: 100.

Proprietário
owner_id string

A ID de registro do sistema do componente de arrecadação de fundos do proprietário do relatório de contatos.

Data real
actual_date True date

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

hora
hour integer

A hora.

minuto
minute integer

O minuto.

hora
hour integer

A hora.

minuto
minute integer

O minuto.

Etapa
prospect_plan_status True string

O estágio da etapa de plano.

Método contact
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 da etapa.

Comment
comment True string

O comentário da etapa.

ID
fundraiser_id True string

A ID do registro do sistema do constituinte da arrecadação de fundos.

ID
constituent_id True string

A ID do registro do sistema do participante constituinte.

Retornos

Relatório de contato não planejado criado

Criar uma etapa de plano de administração

Cria uma nova etapa de plano de administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
stewardship_plan_id True string

A ID de registro do sistema do plano de administração.

Objective
objective True string

O objetivo da etapa. Limite de caracteres: 100.

Data de destino
target_date True date

A data de destino da etapa (por exemplo: '2005-09-18').

Trancado?
date_locked boolean

A data de destino está bloqueada?

Evento durante todo o dia?
all_day_event boolean

A interação é um evento durante todo o dia?

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 da etapa.

Situação
status_code string

O status da etapa de plano.

Categoria
category string

A categoria da etapa de plano.

Atribuído a
constituent_id string

A ID do registro do sistema do constituinte de arrecadação de fundos do proprietário da etapa.

Método contact
contact_method string

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

Frequência
recurs True string

A frequência da etapa.

Data de início
start_date date

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

Data de término
end_date date

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

Próxima data de destino
next_target_date date

A próxima data de destino da etapa (por exemplo: '2005-09-18').

Conectar-se a
link_type_code string

O tipo de registro conectado à etapa.

ID do benefício
benefit_id string

A ID do registro do sistema do benefício conectado.

ID do evento
event_id string

A ID do registro do sistema do evento conectado.

ID de endereçamento
mailing_id string

A ID do registro do sistema do endereçamento conectado.

Data real
actual_date date

A data real da etapa (por exemplo: '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

A ID do registro do sistema do participante constituinte.

ID do plano
prospect_plan_id True string

A ID do registro do sistema do plano associado.

Retornos

Etapa do plano de administração criado

Criar uma etapa principal do plano de doação

Cria uma nova etapa principal do plano de concessão.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
prospect_plan_id True string

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

Objective
objective True string

O objetivo da etapa. Limite de caracteres: 100.

Tipo
prospect_plan_status True string

O estágio da etapa de plano.

Situação
status True string

O status da etapa de plano.

Data esperada
expected_date True date

A data esperada da etapa (por exemplo: '2005-09-18').

Proprietário
owner_id string

A ID do registro do sistema do constituinte de arrecadação de fundos do proprietário da etapa.

Comment
comment string

O comentário da etapa.

Método contact
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 da etapa.

Evento durante todo o dia?
is_all_day_event boolean

A interação é um evento durante todo o dia?

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 da etapa.

Data real
actual_date date

A data real da etapa (por exemplo: '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

O local da etapa.

Outro local
other_location string

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

ID
fundraiser_id True string

A ID do registro do sistema do constituinte da arrecadação de fundos.

ID
constituent_id True string

A ID do registro do sistema do participante constituinte.

Retornos

Etapa do plano de concessão principal criada

Criar uma oportunidade

Cria uma nova oportunidade de plano de perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
prospect_plan_id True string

A ID de registro do sistema do plano de perspectiva.

Situação
status True string

O status da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Valor de solicitação esperado
expected_ask_amount double

O valor de solicitação esperado.

Data de pergunta esperada
expected_ask_date date

A data de pergunta esperada (por exemplo: '2005-09-18').

Probabilidade
likelihood_type_code string

A probabilidade de oportunidade.

Valor da solicitação
ask_amount double

O valor da solicitação.

Data da pergunta
ask_date date

A data da pergunta (por exemplo: '2005-09-18').

Valor aceito
accepted_amount double

O valor de solicitação aceito.

Data da resposta
response_date date

A data da resposta (por exemplo: '2005-09-18').

Comment
comment string

O comentário de oportunidade.

Moeda da transação
transaction_currency string

A moeda da transação.

Retornos

Oportunidade de perspectiva criada

Excluir um plano de administração

Exclui um plano de administração.

Parâmetros

Nome Chave Obrigató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 principal de doação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
plan_id True string

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

Excluir uma etapa do plano de administração

Exclui uma etapa do plano de administração.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da etapa
step_id True string

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

Excluir uma etapa principal do plano de doação

Exclui uma etapa principal do plano de concessão.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da etapa
step_id True string

A ID do registro do sistema da etapa principal do plano de concessão a ser excluída.

Excluir uma oportunidade

Exclui uma oportunidade de plano de perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da oportunidade
opportunity_id True string

A ID do registro do sistema da oportunidade de excluir.

Listar oportunidades de plano

Lista as oportunidades para um plano de perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
plan_id True string

A ID de registro do sistema do plano de perspectiva.

Situação
status string

Filtre os resultados para oportunidades com o status especificado.

Retornos

Oportunidades

Listar planos de perspectiva

Lista os planos para uma perspectiva.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
constituent_id True string

A ID do registro do sistema do constituinte de perspectiva.

Incluir inativo?
include_inactive_plans boolean

Incluir planos inativos?

Retornos

Planos de perspectiva

Obter um plano de doação principal

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Plano
plan_id True string

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

Retornos

Plano de doação principal

Obter um resumo de perspectiva

Retorna informações de perspectiva para um constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
constituent_id True string

A ID do registro do sistema do constituinte.

Retornos

Resumo da perspectiva

Obter uma oportunidade

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

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da oportunidade
opportunity_id True string

A ID de registro do sistema da oportunidade de atualizar.

Retornos

Oportunidade

Pesquisar oportunidades de perspectiva

Pesquisa registros de oportunidade de perspectiva usando os critérios de filtro especificados.

Parâmetros

Nome Chave Obrigató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
firstname string

O nome do constituinte.

ID de pesquisa
lookup_id string

A ID de pesquisa constituinte.

Corresponde exatamente?
exactmatchonly boolean

Corresponder a todos os critérios exatamente?

Situação
status string

Filtre os resultados para o status de oportunidade especificado.

Data da pergunta
ask_date date

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

Valor da solicitação
ask_amount double

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

ID do usuário de designação
designationuserid string

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

Só perspectivas?
only_prospects boolean

Incluir somente eleitores de perspectiva?

Só arrecadação de fundos?
only_fundraisers boolean

Incluir apenas eleitores de arrecadação de fundos?

Só funcionários?
only_staff boolean

Incluir somente os eleitores da equipe?

Só voluntários?
only_volunteers boolean

Incluir apenas voluntários?

Somente primário?
only_primary_address boolean

Pesquisar apenas endereços primários?

Incluir falecido?
includedeceased boolean

Incluir eleitores falecidos?

Incluir inativo?
includeinactive boolean

Incluir componentes 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 alternativas ao pesquisar?

Limit
limit integer

Representa o número de registros a serem retornados.

Retornos

Resultados da pesquisa

Pesquisar perspectivas

Pesquisa registros de perspectiva usando os critérios de filtro especificados.

Parâmetros

Nome Chave Obrigató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
first_name string

O nome do constituinte.

ID de pesquisa
lookup_id string

A ID de pesquisa constituinte.

Número de telefone
phone_number string

O número de telefone constituinte.

País
country string

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

Endereço
address_block string

Um filtro para o bloco de endereços constituinte.

City
city string

Um filtro para a cidade de endereço constituinte.

Estado
state string

Um filtro para o estado de endereço constituinte.

CEP
post_code string

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

Corresponde exatamente?
exact_match_only boolean

Corresponder a todos os critérios exatamente?

Círculo eleitoral
constituency string

Um filtro para o eleitorado do constituinte.

Só perspectivas?
only_prospects boolean

Incluir somente eleitores de perspectiva?

Só arrecadação de fundos?
only_fundraisers boolean

Incluir apenas eleitores de arrecadação de fundos?

Só funcionários?
only_staff boolean

Incluir somente os eleitores da equipe?

Só voluntários?
only_volunteers boolean

Incluir apenas voluntários?

Somente primário?
only_primary_address boolean

Pesquisar apenas endereços primários?

Incluir falecido?
include_deceased boolean

Incluir eleitores falecidos?

Incluir inativo?
include_inactive boolean

Incluir componentes inativos?

Usar pesquisa difusa?
fuzzy_search_on_name boolean

Usar pesquisa difusa no nome?

Limit
limit integer

Representa o número de registros a serem retornados.

Retornos

Resultados da pesquisa

Definições

Prsmg.CreatedMajorGivingPlan

Plano de doação principal criado

Nome Caminho Tipo Description
ID
id string

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

Prsmg.CreatedMajorGivingPlanStep

Etapa do plano de concessão principal criada

Nome Caminho Tipo Description
ID
id string

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

Prsmg.CreatedProspectConstituency

Criação do eleitorado de perspectiva

Nome Caminho Tipo Description
ID
id string

A ID do eleitorado de perspectiva recém-criado.

Prsmg.CreatedProspectOpportunity

Oportunidade de perspectiva criada

Nome Caminho Tipo Description
ID
id string

A ID da oportunidade de perspectiva recém-criada.

Prsmg.CreatedStewardshipPlan

Plano de administração criado

Nome Caminho Tipo Description
ID
id string

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

Prsmg.CreatedStewardshipPlanStep

Etapa do plano de administração criado

Nome Caminho Tipo Description
ID
id string

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

Prsmg.CreatedUnplannedContactReport

Relatório de contato não planejado criado

Nome Caminho Tipo Description
ID
id string

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

Prsmg.MajorGivingPlan

Plano de doação principal

Nome Caminho Tipo Description
ID de perspectiva
prospect_id string

A ID do registro do sistema da perspectiva.

Nome da perspectiva
prospect string

O nome da perspectiva.

Nome
prospect_plan_name string

O nome principal do plano de doação.

Tipo
prospect_plan_type string

O tipo de plano de perspectiva.

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

A data de início do ano fiscal.

Data de término do ano fiscal
fiscal_year_end_date date-time

A data de término do ano fiscal.

Steps
steps array of Prsmg.MajorGivingPlanStep

As etapas do plano.

Prsmg.MajorGivingPlanStep

Etapa principal do plano de doação

Nome Caminho Tipo Description
ID
id string

A ID de registro do sistema da etapa principal do plano de fornecimento.

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

A ID do 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 da etapa de plano.

Situação
status string

O status da etapa de plano.

Data esperada
expected_date date

A data esperada da etapa.

Proprietário
fundraiser_id string

A ID do registro do sistema do constituinte de arrecadação de fundos do proprietário da etapa.

Evento durante todo o dia?
all_day_event boolean

A interação é um evento durante todo o dia?

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 da etapa.

Data real
actual_date date

A data real da etapa (por exemplo: '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 contact
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 da etapa.

Localização
location string

O local de interação da etapa.

Outro local
other_location string

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

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

A interação de etapas adicionais arrecadação de fundos.

Participantes
participants array of Prsmg.MajorGivingPlanStepParticipant

Os participantes da interação da etapa.

Prsmg.MajorGivingPlanStepAdditionalFundraiser

Grande etapa do plano de doação adicional arrecadação de fundos

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema da maior arrecadação de fundos do plano de doação.

ID da arrecadação de fundos
fundraiser_id string

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

Prsmg.MajorGivingPlanStepParticipant

Participante principal da etapa do plano de doação

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do participante da etapa principal do plano de fornecimento.

ID do participante
constituent_id string

A ID de registro do sistema do componente participante da etapa principal do plano de fornecimento.

Prsmg.PlanOpportunity

Oportunidade

Nome Caminho Tipo Description
ID
id string

A ID de registro do sistema da oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Situação
status string

O status da oportunidade.

Quantidade
amount double

O valor da oportunidade.

Data de pergunta esperada
expected_ask_date date-time

A data de solicitação esperada para a oportunidade.

Data da pergunta
ask_date date-time

A data da solicitação para a oportunidade.

Data da resposta
response_date date-time

A data de resposta da oportunidade.

ID da moeda base
base_currency_id string

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

Prsmg.PlanOpportunityCollection

Oportunidades

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of Prsmg.PlanOpportunity

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

Prsmg.ProspectOpportunitySearchResult

Resultado da pesquisa

Nome Caminho Tipo Description
ID
id string

A ID de registro do sistema da oportunidade.

Situação
status string

O status da oportunidade.

Valor da solicitação
ask_amount double

A oportunidade pede valor.

Data da pergunta
ask_date date-time

A data da solicitação para a oportunidade.

Designação
designation date-time

A designação de oportunidade.

ID da moeda de transação
transaction_currency_id string

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

Tipo de plano
prospect_plan_type string

O tipo de plano de perspectiva.

Nome do plano
prospect_plan_name string

O nome do plano de perspectiva.

ID de pesquisa
lookup_id string

A ID de pesquisa para a perspectiva.

Nome da perspectiva
name string

O nome da perspectiva.

Prsmg.ProspectOpportunitySearchResultCollection

Resultados da pesquisa

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação.

value
value array of Prsmg.ProspectOpportunitySearchResult

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

Prsmg.ProspectOpportunity

Oportunidade

Nome Caminho Tipo Description
Header
header string

O cabeçalho de oportunidade.

Tipo
opportunity_type string

O tipo de oportunidade.

Situação
status string

O status da oportunidade.

Valor de solicitação esperado
expected_ask_amount double

A oportunidade esperada é a quantidade de solicitação.

Data de pergunta esperada
expected_ask_date date-time

A data de solicitação esperada para a oportunidade.

Probabilidade
likelihood_type_code string

A probabilidade de oportunidade.

Valor da solicitação
ask_amount double

A oportunidade pede valor.

Data da pergunta
ask_date date-time

A data da solicitação para a oportunidade.

Valor aceito
accepted_amount double

O valor aceito pela oportunidade.

Data da resposta
response_date date-time

A data de resposta da oportunidade.

ID da moeda de transação
transaction_currency string

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

Comment
comment string

O comentário de oportunidade.

ID de perspectiva
prospect_id string

A ID do registro do sistema da perspectiva.

Nome do plano de perspectiva
prospect_plan string

O nome do plano de perspectiva.

Designações
designation array of Prsmg.ProspectOpportunityDesignation

As designações de oportunidade.

Prsmg.ProspectOpportunityDesignation

Designação de oportunidade de perspectiva

Nome Caminho Tipo Description
ID
id string

A ID de registro do sistema da designação de oportunidade de perspectiva.

ID de designação
designation_id string

A ID do registro do sistema da designação.

quantidade
amount double

O valor da designação.

método de financiamento
funding_method string

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

categoria
category string

A categoria de designação.

tipo
type string

O tipo de designação.

usar código
use string

A designação usa código.

constituinte
constituent string

O constituinte de designação.

constituinte
constituent_name string

O nome constituinte da designação.

ID da moeda de transação
transaction_currency_id string

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

sequência
sequence integer

A sequência de designação.

Prsmg.ProspectPlan

Plano de perspectiva

Nome Caminho Tipo Description
ID
id string

A ID de registro do sistema do plano de perspectiva.

Nome
plan_name string

O nome do plano de perspectiva.

Tipo
plan_type string

O tipo de plano de perspectiva.

A administração é?
stewardship_plan boolean

É um plano de administração?

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

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

Data de inclusão
date_added date

A data em que o plano foi adicionado.

Prsmg.ProspectPlanCollection

Planos de perspectiva

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.

value
value array of Prsmg.ProspectPlan

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

Prsmg.ProspectSearchResult

Resultado da pesquisa

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do constituinte.

Nome
name string

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

Gerente de perspectiva
prospect_manager string

O gerente de perspectivas do constituinte.

Gerentes primários
primary_managers string

Os gerentes de planos primários.

ID de pesquisa
lookup_id string

O identificador definido pelo usuário para o constituinte.

Nome de ordenação
sort_constituent_name string

O nome da classificação constituinte.

Tipo de constituinte
constituent_type string

O tipo constituinte.

Endereço
address string

O endereço preferencial do constituinte.

City
city string

A cidade de endereço preferencial do constituinte.

Estado
state string

O estado de endereço preferencial do constituinte.

Cp
post_code string

O código postal de endereço preferencial do constituinte.

Telefone
phone string

O telefone do constituinte.

Prsmg.ProspectSearchResultCollection

Resultados da pesquisa

Nome Caminho Tipo Description
Contagem
count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação.

value
value array of Prsmg.ProspectSearchResult

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

Prsmg.ProspectSummary

Resumo da perspectiva

Nome Caminho Tipo Description
A perspectiva é?
prospect boolean

O constituinte é uma perspectiva?

Está sinalizado?
flagged boolean

A perspectiva está sinalizada?

Situação
prospect_status string

O status da perspectiva.

Nome do gerente
prospect_manager_name string

O nome do gerente de perspectiva.

ID do gerente
prospect_manager_fundraiser_id string

A ID do registro do sistema do constituinte do gerenciador de perspectivas.

Data de início
prospect_manager_start_date date-time

A data de início do gerente de perspectiva.