Partilhar via


Blackbaud Raisers Edge NXT Prospects

O Edge NXT da Blackbaud Raiser é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social. Use o conector Prospects para gerenciar prospects, oportunidades e classificações.

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-raisers-edge-nxt
Política de privacidade https://www.blackbaud.com/privacy-shield
Categorias Vendas e CRM; Produtividade

O Raiser's Edge NXT é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social do bem.

Este conector é construído sobre a API SKY da Blackbaud e fornece operações para ajudar a gerenciar clientes potenciais e entidades relacionadas encontradas no The Raiser's Edge NXT, incluindo:

  • Perspetivas
  • Oportunidades
  • Classificações
  • e mais...

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 Raiser's Edge NXT 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 anexo de oportunidade

Atualiza um anexo de oportunidade.

Atualizar um campo personalizado de oportunidade

Atualiza um campo personalizado de oportunidade.

Atualizar uma oportunidade

Atualiza uma oportunidade.

Criar um anexo de oportunidade

Cria um novo anexo de oportunidade.

Criar um campo personalizado de oportunidade

Cria um novo campo personalizado de oportunidade.

Criar uma classificação de constituinte

Cria uma nova classificação de constituinte.

Criar uma oportunidade

Cria uma nova oportunidade.

Listar anexos de oportunidade

Lista os anexos de uma oportunidade.

Listar campos personalizados de oportunidade

Lista os campos personalizados para uma oportunidade.

Listar classificações de constituintes

Devolve a lista de classificações de um constituinte.

Listar oportunidades

Devolve uma lista de oportunidades.

Obter o estatuto de potencial eleitor

Devolve o estado de prospeção atual de um constituinte.

Receba uma oportunidade

Retorna informações sobre uma oportunidade. Nota: Este ponto de extremidade retorna a propriedade status com uma latência de cerca de 10 minutos.

Atualizar um anexo de oportunidade

Atualiza um anexo de oportunidade.

Parâmetros

Name Chave Necessário Tipo Description
ID do anexo
attachment_id True string

O ID de registro do sistema do anexo a ser atualizado.

Nome
name string

O nome do anexo. Limite de caracteres: 150.

Date
date date-time

A data do anexo (ex: '2020-09-18T04:13:56Z').

URL
url string

O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos.

Etiquetas
tags array of string

As tags associadas ao anexo.

Atualizar um campo personalizado de oportunidade

Atualiza um campo personalizado de oportunidade.

Parâmetros

Name Chave Necessário Tipo Description
ID do campo personalizado
custom_field_id True string

O ID de registro do sistema do campo personalizado a ser atualizado.

body
body True dynamic

Um objeto que representa as propriedades do campo personalizado a ser atualizado.

Atualizar uma oportunidade

Atualiza uma oportunidade.

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.

Propósito
purpose string

O uso pretendido para qualquer dinheiro angariado como resultado da oportunidade.

Nome
name string

O nome que identifica a oportunidade ao longo do programa, como em listas ou em registros de constituintes. Limite de caracteres: 255.

Situação
status string

O status que indica onde a oportunidade está no processo de solicitação.

Deadline
deadline date-time

A data do objetivo para a oportunidade de resultar em um presente (ex: '2020-09-18T04:13:56Z').

Pedir data
ask_date date-time

A data em que a solicitação foi feita (ex: '2020-09-18T04:13:56Z').

valor
value double

O valor monetário.

Data prevista
expected_date date-time

A data em que se espera que o prospeto dê em resposta à oportunidade (ex: '2020-09-18T04:13:56Z').

valor
value double

O valor monetário.

Data de financiamento
funded_date date-time

A data em que o prospeto deu em resposta à oportunidade (ex: '2020-09-18T04:13:56Z').

valor
value double

O valor monetário.

ID da Campanha
campaign_id string

O ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais de angariação de fundos.

ID do Fundo
fund_id string

O ID de registro do sistema do fundo associado à oportunidade. O fundo designa a finalidade financeira específica de um donativo e identifica a conta financeira desse donativo.

ID do constituinte
constituent_id string

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

valor
value double

O valor monetário.

Inativo?
inactive boolean

A oportunidade está inativa?

Criar um anexo de oportunidade

Cria um novo anexo de oportunidade.

Parâmetros

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

O ID de registro do sistema da oportunidade associada ao anexo.

Tipo
type True string

O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente.

Nome
name string

O nome do anexo. Limite de caracteres: 150.

Date
date date-time

A data do anexo (ex: '2020-09-18T04:13:56Z'). Este campo assume como padrão a data e hora atuais se não for fornecido.

URL
url string

O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos.

Nome do ficheiro
file_name string

O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.

ID do ficheiro
file_id string

O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.

ID da miniatura
thumbnail_id string

O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos.

Etiquetas
tags array of string

As tags associadas ao anexo.

Devoluções

Anexo de oportunidade criado

Criar um campo personalizado de oportunidade

Cria um novo campo personalizado de oportunidade.

Parâmetros

Name Chave Necessário Tipo Description
body
body True dynamic

Um objeto que representa o campo personalizado a ser criado.

Devoluções

Anexo de oportunidade criado

Criar uma classificação de constituinte

Cria uma nova classificação de constituinte.

Parâmetros

Name Chave Necessário Tipo Description
body
body True dynamic

Um objeto que representa a classificação a ser criada.

Devoluções

Classificação constituinte criada

Criar uma oportunidade

Cria uma nova oportunidade.

Parâmetros

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

O ID de registro do sistema do constituinte associado à oportunidade.

Propósito
purpose True string

O uso pretendido para qualquer dinheiro angariado como resultado da oportunidade.

Nome
name True string

O nome que identifica a oportunidade ao longo do programa, como em listas ou em registros de constituintes. Limite de caracteres: 255.

Situação
status string

O status que indica onde a oportunidade está no processo de solicitação.

Deadline
deadline date-time

A data do objetivo para a oportunidade de resultar em um presente (ex: '2020-09-18T04:13:56Z').

Pedir data
ask_date date-time

A data em que a solicitação foi feita (ex: '2020-09-18T04:13:56Z').

valor
value double

O valor monetário.

Data prevista
expected_date date-time

A data em que se espera que o prospeto dê em resposta à oportunidade (ex: '2020-09-18T04:13:56Z').

valor
value double

O valor monetário.

Data de financiamento
funded_date date-time

A data em que o prospeto deu em resposta à oportunidade (ex: '2020-09-18T04:13:56Z').

valor
value double

O valor monetário.

ID da Campanha
campaign_id string

O ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais de angariação de fundos.

ID do Fundo
fund_id string

O ID de registro do sistema do fundo associado à oportunidade. O fundo designa a finalidade financeira específica de um donativo e identifica a conta financeira desse donativo.

ID do constituinte
constituent_id string

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

valor
value double

O valor monetário.

Inativo?
inactive boolean

A oportunidade está inativa?

Devoluções

Oportunidade criada

Listar anexos de oportunidade

Lista os anexos de uma oportunidade.

Parâmetros

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

O ID de registro do sistema da oportunidade.

Devoluções

Attachments

Listar campos personalizados de oportunidade

Lista os campos personalizados para uma oportunidade.

Parâmetros

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

O ID de registro do sistema da oportunidade.

Devoluções

Campos personalizados

Listar classificações de constituintes

Devolve a lista de classificações de 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

Incluir inativos?
include_inactive boolean

Incluir classificações inativas?

Só mais recente?
most_recent_only boolean

Incluir apenas as classificações mais recentes?

Devoluções

Classificações

Listar oportunidades

Devolve uma lista de oportunidades.

Parâmetros

Name Chave Necessário Tipo Description
List
list_id string

Define um identificador de lista usado para filtrar o conjunto de oportunidades para aquelas incluídas na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.

ID do constituinte
constituent_id string

Representa uma lista separada por vírgulas de IDs de registro do sistema constituinte para filtrar os resultados. Por exemplo, "280,1232" retorna apenas oportunidades do constituinte 280 ou do constituinte 1232.

Limite
limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000.

Compensação
offset integer

Representa o número de registros a serem ignorados. Para utilização com paginação.

Incluir inativos?
include_inactive boolean

Incluir oportunidades inativas?

Adicionado em ou após
date_added date-time

Filtre os resultados para oportunidades criadas na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Modificado em ou após
last_modified date-time

Filtre os resultados para oportunidades modificadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').

Devoluções

Oportunidades

Obter o estatuto de potencial eleitor

Devolve o estado de prospeção atual de um constituinte.

Parâmetros

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

O ID do registo do sistema do constituinte para o qual o estatuto de cliente potencial deve ser recuperado.

Devoluções

Status do prospeto

Receba uma oportunidade

Retorna informações sobre uma oportunidade. Nota: Este ponto de extremidade retorna a propriedade status com uma latência de cerca de 10 minutos.

Parâmetros

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

O ID de registro do sistema da oportunidade de obter.

Devoluções

Oportunidade

Definições

ConstituentApi.ApiCollectionOfRatingRead

Classificações

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 ConstituentApi.RatingRead

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

ConstituentApi.CreatedConstituentRating

Classificação constituinte criada

Name Caminho Tipo Description
ID
id string

O ID da classificação constituinte recém-criada.

ConstituentApi.ProspectStatusRead

Status do prospeto

Name Caminho Tipo Description
Situação
status string

Situação atual do eleitor.

Dias decorridos
days_elapsed integer

Número total de dias no status atual do prospect com base na data de início.

Data de início
start date-time

A data de início do status do prospect.

Comments
comments string

Os comentários sobre o status do prospeto.

ConstituentApi.RatingRead

Rating

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da classificação.

ID do constituinte
constituent_id string

O ID de registo do sistema do componente associado à classificação.

Fonte
source string

A fonte da nova classificação.

Categoria
category string

A categoria da classificação.

Date
date date-time

A data da classificação.

Description
value

O valor da classificação.

Comments
comment string

Um comentário sobre a classificação.

Inativo?
inactive boolean

A classificação está inativa?

Tipo
type string

Este campo calculado indica o tipo de dados que a classificação representa com base na propriedade category.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Attachments

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 OpportunityApi.OpportunityAttachmentRead

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

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Campos personalizados

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 OpportunityApi.OpportunityCustomFieldRead

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

OpportunityApi.ApiCollectionOfOpportunityRead

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 OpportunityApi.OpportunityRead

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

OpportunityApi.CreatedOpportunity

Oportunidade criada

Name Caminho Tipo Description
ID
id string

O ID da oportunidade recém-criada.

OpportunityApi.CreatedOpportunityAttachment

Anexo de oportunidade criado

Name Caminho Tipo Description
ID
id string

A ID do anexo de oportunidade recém-criado.

OpportunityApi.CreatedOpportunityCustomField

Anexo de oportunidade criado

Name Caminho Tipo Description
ID
id string

A ID do anexo de oportunidade recém-criado.

OportunidadeApi.Angariação de fundos

Angariação de fundos

Name Caminho Tipo Description
ID do constituinte
constituent_id string

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

valor
credit_amount.value double

O valor monetário.

OpportunityApi.OpportunityAttachmentRead

Anexo

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema do anexo.

ID da oportunidade
parent_id string

O ID de registro do sistema da oportunidade associada ao anexo.

Tipo
type string

O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente.

Nome
name string

O nome do anexo. Limite de caracteres: 150.

Date
date date-time

A data do anexo.

URL
url string

O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos.

Nome do ficheiro
file_name string

O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.

ID do ficheiro
file_id string

O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.

ID da miniatura
thumbnail_id string

O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos.

URL da miniatura
thumbnail_url string

O URL de uma miniatura. Para anexos físicos que são apenas imagens. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos.

Tipo de conteúdo
content_type string

O tipo de conteúdo. Apenas para anexos físicos.

Tamanho do ficheiro
file_size integer

O tamanho do arquivo em bytes. Apenas para anexos físicos.

Etiquetas
tags array of string

As tags associadas ao anexo.

OpportunityApi.OpportunityCustomFieldRead

Campo personalizado

Name Caminho Tipo Description
ID
id string

A ID de registro do sistema do campo personalizado.

ID da oportunidade
parent_id string

O ID de registro do sistema da oportunidade associada ao campo personalizado.

Categoria
category string

A categoria de campo personalizado.

Tipo
type string

O tipo de dados que o campo personalizado representa.

Valor
value

O valor do campo personalizado.

Valor do texto
text_value string

O valor de texto do campo personalizado.

Valor do número
number_value integer

O valor numérico do campo personalizado.

Valor da data
date_value date

O valor de data do campo personalizado.

Valor da moeda
currency_value double

O valor da moeda do campo personalizado.

Valor booleano
boolean_value boolean

O valor booleano do campo personalizado.

Valor de entrada da tabela
codetableentry_value string

O valor de entrada de tabela do campo personalizado.

Valor da ID do constituinte
constituentid_value string

O valor de ID do constituinte do campo personalizado.

day
fuzzydate_value.d integer

O dia na data difusa.

mês
fuzzydate_value.m integer

O mês na data difusa.

ano
fuzzydate_value.y integer

O ano na data difusa.

Date
date date

A data no campo personalizado.

Comment
comment string

O comentário no campo personalizado. Limite de caracteres: 50.

Data de adição
date_added date-time

A data em que o campo personalizado foi criado.

Data de modificação
date_modified date-time

A data em que o campo personalizado foi modificado pela última vez.

OpportunityApi.OpportunityRead

Oportunidade

Name Caminho Tipo Description
ID
id string

O ID de registro do sistema da oportunidade.

ID do constituinte
constituent_id string

O ID de registro do sistema do constituinte associado à oportunidade.

Propósito
purpose string

O uso pretendido para qualquer dinheiro angariado como resultado da oportunidade.

Nome
name string

O nome que identifica a oportunidade ao longo do programa, como em listas ou em registros de constituintes. Limite de caracteres: 255.

Situação
status string

O status que indica onde a oportunidade está no processo de solicitação.

Deadline
deadline date-time

A data do objetivo para a oportunidade de resultar em um presente.

Pedir data
ask_date date-time

A data em que o pedido foi feito.

valor
ask_amount.value double

O valor monetário.

Data prevista
expected_date date-time

A data em que se espera que o prospect dê em resposta à oportunidade.

valor
expected_amount.value double

O valor monetário.

Data de financiamento
funded_date date-time

A data em que o prospeto deu em resposta à oportunidade.

valor
funded_amount.value double

O valor monetário.

ID da Campanha
campaign_id string

O ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais de angariação de fundos.

ID do Fundo
fund_id string

O ID de registro do sistema do fundo associado à oportunidade. O fundo designa a finalidade financeira específica de um donativo e identifica a conta financeira desse donativo.

Angariação(ões) de fundos
fundraisers array of OpportunityApi.Fundraiser

O conjunto de IDs de registro do sistema para os angariadores de fundos atribuídos à oportunidade.

Inativo?
inactive boolean

A oportunidade está inativa?

linked_gifts
linked_gifts array of string

O sistema registra IDs dos presentes relacionados à oportunidade.

Data de adição
date_added date-time

A data em que a oportunidade foi criada.

Data de modificação
date_modified date-time

A data em que a oportunidade foi modificada pela última vez.