Compartilhar via


Perspectivas NXT do Blackbaud Raisers Edge

O Blackbaud Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social. Use o conector Prospects para gerenciar perspectivas, oportunidades e classificações.

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-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 captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social.

Esse conector é criado com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar perspectivas e entidades relacionadas encontradas no NXT de Borda do Raiser, incluindo:

  • Perspectivas
  • Oportunidades
  • Avaliações
  • e muito mais...

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 Raiser's Edge NXT 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 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 constituinte

Cria uma nova classificação constituinte.

Criar uma oportunidade

Cria uma nova oportunidade.

Listar anexos de oportunidade

Lista os anexos para uma oportunidade.

Listar campos personalizados de oportunidade

Lista os campos personalizados para uma oportunidade.

Listar classificações constituintes

Retorna a lista de classificações para um constituinte.

Listar oportunidades

Retorna uma lista de oportunidades.

Obter status de perspectiva constituinte

Retorna o status de perspectiva atual para um constituinte.

Obter uma oportunidade

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

Atualizar um anexo de oportunidade

Atualiza um anexo de oportunidade.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do anexo
attachment_id True string

A ID do 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 (por exemplo: '2020-09-18T04:13:56Z').

URL
url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.

Etiquetas
tags array of string

As marcas associadas ao anexo.

Atualizar um campo personalizado de oportunidade

Atualiza um campo personalizado de oportunidade.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do campo personalizado
custom_field_id True string

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

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

A ID de registro do sistema da oportunidade de atualizar.

Propósito
purpose string

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

Nome
name string

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

Situação
status string

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

Data limite
deadline date-time

A data da meta para a oportunidade de resultar em um presente (por exemplo: '2020-09-18T04:13:56Z').

Data da pergunta
ask_date date-time

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

value
value double

O valor monetário.

Data esperada
expected_date date-time

A data em que a perspectiva deve ceder em resposta à oportunidade (por exemplo: '2020-09-18T04:13:56Z').

value
value double

O valor monetário.

Data financiada
funded_date date-time

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

value
value double

O valor monetário.

ID da Campanha
campaign_id string

A ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.

ID do fundo
fund_id string

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

ID do Constituinte
constituent_id string

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

value
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

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

A ID do registro do sistema da oportunidade associada ao anexo.

Tipo
type True string

O tipo de anexo. 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. Anexos de link são links para arquivos como imagens, postagens no 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 (por exemplo: '2020-09-18T04:13:56Z'). Esse campo usa como padrão a data e a hora atuais, se não for fornecido.

URL
url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.

Nome do arquivo
file_name string

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

ID de Arquivo
file_id string

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

ID da miniatura
thumbnail_id string

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

Etiquetas
tags array of string

As marcas associadas ao anexo.

Retornos

Anexo de oportunidade criado

Criar um campo personalizado de oportunidade

Cria um novo campo personalizado de oportunidade.

Parâmetros

Nome Chave Obrigatório Tipo Description
body
body True dynamic

Um objeto que representa o campo personalizado a ser criado.

Retornos

Anexo de oportunidade criado

Criar uma classificação constituinte

Cria uma nova classificação constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
body
body True dynamic

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

Retornos

Classificação constituinte criada

Criar uma oportunidade

Cria uma nova oportunidade.

Parâmetros

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

A ID do registro do sistema do constituinte associado à oportunidade.

Propósito
purpose True string

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

Nome
name True string

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

Situação
status string

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

Data limite
deadline date-time

A data da meta para a oportunidade de resultar em um presente (por exemplo: '2020-09-18T04:13:56Z').

Data da pergunta
ask_date date-time

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

value
value double

O valor monetário.

Data esperada
expected_date date-time

A data em que a perspectiva deve ceder em resposta à oportunidade (por exemplo: '2020-09-18T04:13:56Z').

value
value double

O valor monetário.

Data financiada
funded_date date-time

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

value
value double

O valor monetário.

ID da Campanha
campaign_id string

A ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.

ID do fundo
fund_id string

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

ID do Constituinte
constituent_id string

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

value
value double

O valor monetário.

Inativo?
inactive boolean

A oportunidade está inativa?

Retornos

Oportunidade criada

Listar anexos de oportunidade

Lista os anexos para uma oportunidade.

Parâmetros

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

A ID de registro do sistema da oportunidade.

Retornos

Attachments

Listar campos personalizados de oportunidade

Lista os campos personalizados para uma oportunidade.

Parâmetros

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

A ID de registro do sistema da oportunidade.

Retornos

Campos Personalizados

Listar classificações constituintes

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

Incluir inativo?
include_inactive boolean

Incluir classificações inativas?

Só mais recente?
most_recent_only boolean

Incluir apenas as classificações mais recentes?

Retornos

Avaliações

Listar oportunidades

Retorna uma lista de oportunidades.

Parâmetros

Nome Chave Obrigatório Tipo Description
List
list_id string

Define um identificador de lista usado para filtrar o conjunto de oportunidades para aqueles incluídos 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 constituinte 1232.

Limit
limit integer

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

Offset
offset integer

Representa o número de registros a serem ignoradas. Para uso com paginação.

Incluir inativo?
include_inactive boolean

Incluir oportunidades inativas?

Adicionado em ou após
date_added date-time

Filtre os resultados para oportunidades criadas na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Modificado em ou após
last_modified date-time

Filtre os resultados para oportunidades modificadas na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Oportunidades

Obter status de perspectiva constituinte

Retorna o status de perspectiva atual 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 para o qual o status de perspectiva deve ser recuperado.

Retornos

Status de perspectiva

Obter uma oportunidade

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

Parâmetros

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

A ID de registro do sistema da oportunidade de obter.

Retornos

Oportunidade

Definições

ConstituentApi.ApiCollectionOfRatingRead

Avaliações

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

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

ConstituentApi.CreatedConstituentRating

Classificação constituinte criada

Nome Caminho Tipo Description
ID
id string

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

ConstituentApi.ProspectStatusRead

Status de perspectiva

Nome Caminho Tipo Description
Situação
status string

O status de perspectiva atual do constituinte.

Dias decorridos
days_elapsed integer

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

Data de início
start date-time

A data de início do status de perspectiva.

Comments
comments string

Os comentários sobre o status da perspectiva.

ConstituentApi.RatingRead

Rating

Nome Caminho Tipo Description
ID
id string

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

ID do Constituinte
constituent_id string

A ID do registro do sistema do constituinte associado à classificação.

Source
source string

A origem 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

Esse campo computado indica o tipo de dados que a classificação representa com base na propriedade de categoria.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Attachments

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

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

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Campos Personalizados

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

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

OpportunityApi.ApiCollectionOfOpportunityRead

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

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

OpportunityApi.CreatedOpportunity

Oportunidade criada

Nome Caminho Tipo Description
ID
id string

A ID da oportunidade recém-criada.

OpportunityApi.CreatedOpportunityAttachment

Anexo de oportunidade criado

Nome Caminho Tipo Description
ID
id string

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

OpportunityApi.CreatedOpportunityCustomField

Anexo de oportunidade criado

Nome Caminho Tipo Description
ID
id string

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

OpportunityApi.Fundraiser

Arrecadação de fundos

Nome Caminho Tipo Description
ID do Constituinte
constituent_id string

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

value
credit_amount.value double

O valor monetário.

OpportunityApi.OpportunityAttachmentRead

Anexo

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do anexo.

ID da oportunidade
parent_id string

A ID do registro do sistema da oportunidade associada ao anexo.

Tipo
type string

O tipo de anexo. 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. Anexos de link são links para arquivos como imagens, postagens no 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

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.

Nome do arquivo
file_name string

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

ID de Arquivo
file_id string

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

ID da miniatura
thumbnail_id string

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

URL de miniatura
thumbnail_url string

A URL de uma miniatura. Para anexos físicos que são somente imagens. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos.

Tipo de conteúdo
content_type string

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

Tamanho do arquivo
file_size integer

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

Etiquetas
tags array of string

As marcas associadas ao anexo.

OpportunityApi.OpportunityCustomFieldRead

Campo personalizado

Nome Caminho Tipo Description
ID
id string

A ID do registro do sistema do campo personalizado.

ID da oportunidade
parent_id string

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

Value
value

O valor do campo personalizado.

Valor do texto
text_value string

O valor do 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 booliano
boolean_value boolean

O valor booliano do campo personalizado.

Valor de entrada da tabela
codetableentry_value string

O valor de entrada da tabela do campo personalizado.

Valor da ID constituinte
constituentid_value string

O valor da ID do constituinte do campo personalizado.

dia
fuzzydate_value.d integer

O dia na data difusa.

month
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 inclusão
date_added date-time

A data em que o campo personalizado foi criado.

Data modificada
date_modified date-time

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

OpportunityApi.OpportunityRead

Oportunidade

Nome Caminho Tipo Description
ID
id string

A ID de registro do sistema da oportunidade.

ID do Constituinte
constituent_id string

A ID do registro do sistema do constituinte associado à oportunidade.

Propósito
purpose string

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

Nome
name string

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

Situação
status string

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

Data limite
deadline date-time

A data da meta para a oportunidade de resultar em um presente.

Data da pergunta
ask_date date-time

A data em que a solicitação foi feita.

value
ask_amount.value double

O valor monetário.

Data esperada
expected_date date-time

A data em que se espera que a perspectiva seja fornecida em resposta à oportunidade.

value
expected_amount.value double

O valor monetário.

Data financiada
funded_date date-time

A data em que a perspectiva deu em resposta à oportunidade.

value
funded_amount.value double

O valor monetário.

ID da Campanha
campaign_id string

A ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.

ID do fundo
fund_id string

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

Arrecadação de fundos
fundraisers array of OpportunityApi.Fundraiser

O conjunto de IDs de registro do sistema para as arrecadações de fundos atribuídas à oportunidade.

Inativo?
inactive boolean

A oportunidade está inativa?

linked_gifts
linked_gifts array of string

As IDs de registro do sistema dos presentes relacionados à oportunidade.

Data de inclusão
date_added date-time

A data em que a oportunidade foi criada.

Data modificada
date_modified date-time

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