Compartilhar via

Arrecadação de fundos NXT da 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 de captação de recursos para gerenciar campanhas, fundos, recursos e pacotes.

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 entidades de captação de recursos encontradas no NXT de Borda do Raiser, incluindo:

  • Campaigns
  • Fundos
  • Contestações
  • Packages
  • 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 campanha

Atualiza um anexo de campanha.
Atualizar um anexo de fundo

Atualiza um anexo de fundo.
Atualizar um anexo de recurso

Atualiza um anexo de recurso.
Atualizar um campo personalizado de campanha

Atualiza um campo personalizado de campanha.
Atualizar um campo personalizado de recurso

Atualiza um campo personalizado de recurso.
Atualizar um campo personalizado do fundo

Atualiza um campo personalizado do fundo.
Atualizar um fundo

Atualiza um fundo.
Atualizar um recurso

Atualiza um recurso.
Atualizar um recurso constituinte

Atualiza um recurso constituinte.
Atualizar uma campanha

Atualiza uma campanha.
Criar um anexo de campanha

Cria um novo anexo de campanha.
Criar um anexo de fundo

Cria um novo anexo de fundo.
Criar um anexo de recurso

Cria um novo anexo de recurso.
Criar um campo personalizado de campanha

Cria um novo campo personalizado de campanha.
Criar um campo personalizado de recurso

Cria um novo campo personalizado de recurso.
Criar um campo personalizado do fundo

Cria um novo campo personalizado do fundo.
Criar um fundo

Cria um novo fundo.
Criar um recurso

Cria um novo recurso.
Criar um recurso constituinte

Cria um novo recurso constituinte.
Criar uma campanha

Cria uma nova campanha.
Listar anexos de campanha

Lista os anexos de uma campanha.
Listar anexos de fundos

Lista os anexos de um fundo.
Listar anexos de recurso

Lista os anexos de um recurso.
Listar campanhas

Retorna uma lista de campanhas.
Listar campos personalizados da campanha

Lista os campos personalizados para uma campanha.
Listar campos personalizados de recurso

Lista os campos personalizados para um recurso.
Listar campos personalizados do fundo

Lista os campos personalizados para um fundo.
Listar fundos

Retorna uma lista de fundos.
Listar pacotes

Retorna uma lista de pacotes.
Listar recursos

Retorna uma lista de recursos.
Listar recursos constituintes

Lista os apelos de um constituinte.
Listar relações constituintes do fundo

Lista as relações constituintes de um fundo.
Listar relações de fundos constituintes

Lista as relações de fundo para um constituinte.
Obter um fundo

Retorna informações sobre um fundo.
Obter um pacote

Retorna informações sobre um pacote.
Obter um recurso

Retorna informações sobre um recurso.
Obter uma campanha

Retorna informações sobre uma campanha.

Atualizar um anexo de campanha

ID da operação:
EditCampaignAttachment

Atualiza um anexo de campanha.

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 anexo de fundo

ID da operação:
EditFundAttachment

Atualiza um anexo de fundo.

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 anexo de recurso

ID da operação:
EditAppealAttachment

Atualiza um anexo de recurso.

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 campanha

ID da operação:
EditCampaignCustomField

Atualiza um campo personalizado de campanha.

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 um campo personalizado de recurso

ID da operação:
EditAppealCustomField

Atualiza um campo personalizado de recurso.

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 um campo personalizado do fundo

ID da operação:
EditFundCustomField

Atualiza um campo personalizado do fundo.

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 um fundo

ID da operação:
EditFund

Atualiza um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 id True integer

A ID de registro do sistema do fundo a ser atualizado.
ID de pesquisa
 fund_id string

O identificador definido pelo usuário para o fundo.
Description
 description string

A descrição do fundo.
Data de início
 start_date date

A data de início do fundo (por exemplo: '2005-09-18').
Data de término
 end_date date

A data de término do fundo (por exemplo: '2005-09-18').
Categoria
 fund_category_id integer

A categoria de fundo.
Tipo
 fund_type_id integer

O tipo de fundo.
Goal
 goal double

O valor de destino a ser arrecadado para o fundo.
Anotações
 notes string

As anotações associadas ao fundo.
Restrito?
 restricted boolean

O fundo está restrito a usuários específicos?
Inativo?
 inactive boolean

O fundo está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID da Campanha
 campaign_id integer

A ID de uma campanha associada ao fundo.
ID de recurso padrão
 default_appeal_id integer

A ID do recurso padrão associado ao fundo.

Atualizar um recurso

ID da operação:
EditAppeal

Atualiza um recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso
 id True integer

A ID do registro do sistema do recurso a ser atualizado.
ID de pesquisa
 appeal_id string

O identificador definido pelo usuário para o recurso.
Description
 description string

A descrição do recurso.
Data de início
 start_date date

A data de início do recurso (por exemplo: '2005-09-18').
Data de término
 end_date date

A data de término do recurso (por exemplo: '2005-09-18').
Categoria
 appeal_category_id integer

A categoria de recurso.
Goal
 goal double

O valor de destino a ser gerado por meio do recurso.
Valor padrão do presente
 default_gift_amount double

A quantidade monetária do presente padrão. Essa propriedade usa como padrão 0,00 se nenhuma quantidade for especificada.
Número solicitado
 number_solicited integer

O número de eleitores solicitados no recurso.
Anotações
 notes string

As anotações associadas ao recurso.
ID de campanha padrão
 campaign_id integer

A ID de uma campanha associada ao recurso.
ID do fundo padrão
 default_fund_id integer

A ID do fundo padrão associado ao recurso.
Inativo?
 inactive boolean

O recurso está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?

Atualizar um recurso constituinte

ID da operação:
EditConstituentAppeal

Atualiza um recurso constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso constituído
 id True integer

A ID do registro do sistema do recurso constituinte a ser atualizado.
Descrição do recurso
 appeal_description string

A descrição do recurso; usado para pesquisar a ID do registro de apelação.
Descrição do pacote
 package_description string

A descrição do pacote; usado para pesquisar a ID do registro do pacote.
Date
 appeal_date date

A data do recurso constituinte (por exemplo: '2005-09-18').
Resposta
 response_description string

A longa descrição da resposta para o recurso constituinte.
Segmento de marketing
 marketing_segment string

O segmento de marketing associado ao recurso constituinte.
Código-fonte de marketing
 marketing_source_code string

O código-fonte de marketing associado ao recurso constituinte.
ID de endereçamento
 mailing_id integer

A ID de endereçamento do recurso constituinte.
Número do localizador
 market_finder_number string

O número do localizador de mercado associado ao recurso constituinte.
Comments
 comments string

Os comentários associados ao recurso constituinte.

Atualizar uma campanha

ID da operação:
EditCampaign

Atualiza uma campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Campanha
 id True integer

A ID de registro do sistema da campanha a ser atualizada.
ID de pesquisa
 campaign_id string

O identificador definido pelo usuário para a campanha.
Description
 description string

A descrição da campanha.
Data de início
 start_date date

A data de início da campanha (por exemplo: '2005-09-18').
Data de término
 end_date date

A data de término da campanha (por exemplo: '2005-09-18').
Categoria
 campaign_category_id integer

A categoria da campanha.
Goal
 goal double

O valor de destino a ser arrecadado através da campanha.
Anotações
 notes string

As anotações associadas à campanha.
Inativo?
 inactive boolean

A campanha está inativa (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID do fundo padrão
 default_fund_id integer

A ID do fundo padrão associado à campanha.

Criar um anexo de campanha

ID da operação:
CreateCampaignAttachment

Cria um novo anexo de campanha.

Parâmetros

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

A ID do registro do sistema da campanha 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 campanha criado

Corpo
FundraisingApi.CreatedCampaignAttachment

Criar um anexo de fundo

ID da operação:
CreateFundAttachment

Cria um novo anexo de fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 parent_id True string

A ID do registro do sistema do fundo associado 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 fundo criado

Corpo
FundraisingApi.CreatedFundAttachment

Criar um anexo de recurso

ID da operação:
CreateAppealAttachment

Cria um novo anexo de recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso
 parent_id True string

A ID do registro do sistema do recurso associado 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 recurso criado

Corpo
FundraisingApi.CreatedAppealAttachment

Criar um campo personalizado de campanha

ID da operação:
CreateCampaignCustomField

Cria um novo campo personalizado de campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
body
 body True dynamic

Um objeto que representa o campo personalizado a ser criado.

Retornos

Campo personalizado de campanha criado

Corpo
FundraisingApi.CreatedCampaignCustomField

Criar um campo personalizado de recurso

ID da operação:
CreateAppealCustomField

Cria um novo campo personalizado de recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
body
 body True dynamic

Um objeto que representa o campo personalizado a ser criado.

Retornos

Campo personalizado de recurso criado

Corpo
FundraisingApi.CreatedAppealCustomField

Criar um campo personalizado do fundo

ID da operação:
CreateFundCustomField

Cria um novo campo personalizado do fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
body
 body True dynamic

Um objeto que representa o campo personalizado a ser criado.

Retornos

Campo personalizado do fundo criado

Corpo
FundraisingApi.CreatedFundCustomField

Criar um fundo

ID da operação:
CreateFund

Cria um novo fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de pesquisa
 fund_id True string

O identificador definido pelo usuário para o fundo.
Description
 description True string

A descrição do fundo.
Data de início
 start_date date

A data de início do fundo (por exemplo: '2005-09-18').
Data de término
 end_date date

A data de término do fundo (por exemplo: '2005-09-18').
Categoria
 fund_category_id integer

A categoria de fundo.
Tipo
 fund_type_id integer

O tipo de fundo.
Goal
 goal double

O valor de destino a ser arrecadado para o fundo.
Anotações
 notes string

As anotações associadas ao fundo.
Restrito?
 restricted boolean

O fundo está restrito a usuários específicos?
Inativo?
 inactive boolean

O fundo está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID da Campanha
 campaign_id integer

A ID de uma campanha associada ao fundo.
ID de recurso padrão
 default_appeal_id integer

A ID do recurso padrão associado ao fundo.

Retornos

Fundo criado

Corpo
NXTDataIntegrationApi.CreatedFund

Criar um recurso

ID da operação:
CreateAppeal

Cria um novo recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de pesquisa
 appeal_id True string

O identificador definido pelo usuário para o recurso.
Description
 description True string

A descrição do recurso.
Data de início
 start_date date

A data de início do recurso (por exemplo: '2005-09-18').
Data de término
 end_date date

A data de término do recurso (por exemplo: '2005-09-18').
Categoria
 appeal_category_id integer

A categoria de recurso.
Goal
 goal double

O valor de destino a ser gerado por meio do recurso.
Valor padrão do presente
 default_gift_amount double

A quantidade monetária do presente padrão. Essa propriedade usa como padrão 0,00 se nenhuma quantidade for especificada.
Número solicitado
 number_solicited integer

O número de eleitores solicitados no recurso.
Anotações
 notes string

As anotações associadas ao recurso.
ID de campanha padrão
 campaign_id integer

A ID de uma campanha associada ao recurso.
ID do fundo padrão
 default_fund_id integer

A ID do fundo padrão associado ao recurso.
Inativo?
 inactive boolean

O recurso está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?

Retornos

Recurso criado

Corpo
NXTDataIntegrationApi.CreatedAppeal

Criar um recurso constituinte

ID da operação:
CreateConstituentAppeal

Cria um novo recurso constituinte.

Parâmetros

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

A ID de registro do sistema do constituinte associado ao recurso constituinte.
Descrição do recurso
 appeal_description True string

A descrição do recurso; usado para pesquisar a ID do registro de apelação.
Descrição do pacote
 package_description string

A descrição do pacote; usado para pesquisar a ID do registro do pacote.
Date
 appeal_date date

A data do recurso constituinte (por exemplo: '2005-09-18').
Resposta
 response_description string

A longa descrição da resposta para o recurso constituinte.
Segmento de marketing
 marketing_segment string

O segmento de marketing associado ao recurso constituinte.
Código-fonte de marketing
 marketing_source_code string

O código-fonte de marketing associado ao recurso constituinte.
ID de endereçamento
 mailing_id integer

A ID de endereçamento do recurso constituinte.
Número do localizador
 market_finder_number string

O número do localizador de mercado associado ao recurso constituinte.
Comments
 comments string

Os comentários associados ao recurso constituinte.
ID de importação
 import_id string

A ID de importação do recurso constituinte.

Retornos

Recurso constituinte criado

Corpo
NXTDataIntegrationApi.CreatedConstituentAppeal

Criar uma campanha

ID da operação:
CreateCampaign

Cria uma nova campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de pesquisa
 campaign_id True string

O identificador definido pelo usuário para a campanha.
Description
 description True string

A descrição da campanha.
Data de início
 start_date date

A data de início da campanha (por exemplo: '2005-09-18').
Data de término
 end_date date

A data de término da campanha (por exemplo: '2005-09-18').
Categoria
 campaign_category_id integer

A categoria da campanha.
Goal
 goal double

O valor de destino a ser arrecadado através da campanha.
Anotações
 notes string

As anotações associadas à campanha.
Inativo?
 inactive boolean

A campanha está inativa (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID do fundo padrão
 default_fund_id integer

A ID do fundo padrão associado à campanha.

Retornos

Campanha criada

Corpo
NXTDataIntegrationApi.CreatedCampaign

Listar anexos de campanha

ID da operação:
ListCampaignAttachments

Lista os anexos de uma campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Campanha
 campaign_id True string

A ID de registro do sistema da campanha.

Retornos

Attachments

Corpo
FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Listar anexos de fundos

ID da operação:
ListFundAttachments

Lista os anexos de um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 fund_id True string

A ID do registro do sistema do fundo.

Retornos

Attachments

Corpo
FundraisingApi.ApiCollectionOfFundAttachmentRead

Listar anexos de recurso

ID da operação:
ListAppealAttachments

Lista os anexos de um recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso
 appeal_id True string

A ID do registro do sistema do recurso.

Retornos

Attachments

Corpo
FundraisingApi.ApiCollectionOfAppealAttachmentRead

Listar campanhas

ID da operação:
ListCampaigns

Retorna uma lista de campanhas.

Parâmetros

Nome Chave Obrigatório Tipo Description
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 campanhas inativas?
Adicionado em ou após
 date_added date-time

Filtre os resultados para campanhas criadas em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após
 last_modified date-time

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

Retornos

Campaigns

Corpo
FundraisingApi.ApiCollectionOfCampaignRead

Listar campos personalizados da campanha

ID da operação:
ListCampaignCustomFields

Lista os campos personalizados para uma campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Campanha
 campaign_id True string

A ID de registro do sistema da campanha.

Retornos

Campos Personalizados

Corpo
FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

Listar campos personalizados de recurso

ID da operação:
ListAppealCustomFields

Lista os campos personalizados para um recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso
 appeal_id True string

A ID do registro do sistema do recurso.

Retornos

Campos Personalizados

Corpo
FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Listar campos personalizados do fundo

ID da operação:
ListFundCustomFields

Lista os campos personalizados para um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 fund_id True string

A ID do registro do sistema do fundo.

Retornos

Campos Personalizados

Corpo
FundraisingApi.ApiCollectionOfFundCustomFieldRead

Listar fundos

ID da operação:
ListFunds

Retorna uma lista de fundos.

Parâmetros

Nome Chave Obrigatório Tipo Description
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 fundos inativos?
Adicionado em ou após
 date_added date-time

Filtre os resultados para fundos criados em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após
 last_modified date-time

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

Retornos

Fundos

Corpo
FundraisingApi.ApiCollectionOfFundRead

Listar pacotes

ID da operação:
ListPackages

Retorna uma lista de pacotes.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso
 appeal_id string

Representa uma lista separada por vírgulas de IDs de registro do sistema de apelação para filtrar os resultados. Por exemplo, "506.918" retorna apenas pacotes para recurso 506 ou recurso 918.
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 pacotes inativos?
Adicionado em ou após
 date_added date-time

Filtre os resultados para pacotes criados em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após
 last_modified date-time

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

Retornos

Packages

Corpo
FundraisingApi.ApiCollectionOfPackageRead

Listar recursos

ID da operação:
ListAppeals

Retorna uma lista de recursos.

Parâmetros

Nome Chave Obrigatório Tipo Description
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 recursos inativos?
Adicionado em ou após
 date_added date-time

Filtre os resultados para recursos criados em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após
 last_modified date-time

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

Retornos

Contestações

Corpo
FundraisingApi.ApiCollectionOfAppealRead

Listar recursos constituintes

ID da operação:
ListConstituentAppeals

Lista os apelos de 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

Recursos constituintes

Corpo
ConstituentApi.ApiCollectionOfConstituentAppealRead

Listar relações constituintes do fundo

ID da operação:
ListFundConstituentRelationships

Lista as relações constituintes de um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 fundId True integer

A ID do registro do sistema do fundo.
Limit
 limit integer

Representa o número de registros a serem retornados.
Offset
 offset integer

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

Retornos

Relações constituintes

Corpo
NXTDataIntegrationApi.ConstituentRelationshipCollection

Listar relações de fundos constituintes

ID da operação:
ListConstituentFundRelationships

Lista as relações de fundo para um constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
 constituentId True integer

A ID do registro do sistema do constituinte.
Limit
 limit integer

Representa o número de registros a serem retornados.
Offset
 offset integer

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

Retornos

Relações de fundo

Corpo
NXTDataIntegrationApi.FundRelationshipCollection

Obter um fundo

ID da operação:
GetFund

Retorna informações sobre um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 fund_id True string

A ID do registro do sistema do fundo a ser obtido.

Retornos

Fundo

Corpo
FundraisingApi.FundRead

Obter um pacote

ID da operação:
GetPackage

Retorna informações sobre um pacote.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Pacote
 package_id True string

A ID do registro do sistema do pacote a ser obtido.

Retornos

Package

Corpo
FundraisingApi.PackageRead

Obter um recurso

ID da operação:
GetAppeal

Retorna informações sobre um recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID de recurso
 appeal_id True string

A ID do registro do sistema do recurso a ser obtido.

Retornos

Appeal

Corpo
FundraisingApi.AppealRead

Obter uma campanha

ID da operação:
GetCampaign

Retorna informações sobre uma campanha.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da Campanha
 campaign_id True string

A ID de registro do sistema da campanha a ser obtido.

Retornos

Campanha

Corpo
FundraisingApi.CampaignRead

Definições

ConstituentApi.ApiCollectionOfConstituentAppealRead

Recursos constituintes

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.ConstituentAppealRead

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

ConstituentApi.ConstituentAppealRead

Recurso constituinte

Nome Caminho Tipo Description
ID
 id string

A ID de registro do sistema do recurso constituinte.
ID
 appeal.id string

A ID do registro do sistema do recurso.
descrição
 appeal.description string

A descrição do recurso.
ID
 package.id string

A ID do registro do sistema do pacote.
descrição
 package.description string

A descrição do pacote.
Date
 date date-time

A data do recurso constituinte.
Resposta
 response string

A resposta para o recurso constituinte.
Segmento de marketing
 marketing_segment string

O segmento de marketing para o recurso constituinte.
Código-fonte de marketing
 marketing_source_code string

O código-fonte de marketing para o recurso constituinte.
ID de endereçamento
 mailing_id string

O identificador de endereçamento definido pelo usuário para o recurso constituinte.
Número do localizador
 finder_number string

O número do localizador de marketing para o recurso constituinte.
Comments
 comments string

Comentários do usuário para o recurso constituinte.

FundraisingApi.ApiCollectionOfAppealAttachmentRead

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 FundraisingApi.AppealAttachmentRead

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

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

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 FundraisingApi.AppealCustomFieldRead

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

FundraisingApi.ApiCollectionOfAppealRead

Contestaçõ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 FundraisingApi.AppealRead

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

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

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 FundraisingApi.CampaignAttachmentRead

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

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

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 FundraisingApi.CampaignCustomFieldRead

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

FundraisingApi.ApiCollectionOfCampaignRead

Campaigns

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 FundraisingApi.CampaignRead

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

FundraisingApi.ApiCollectionOfFundAttachmentRead

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 FundraisingApi.FundAttachmentRead

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

FundraisingApi.ApiCollectionOfFundCustomFieldRead

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 FundraisingApi.FundCustomFieldRead

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

FundraisingApi.ApiCollectionOfFundRead

Fundos

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 FundraisingApi.FundRead

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

FundraisingApi.ApiCollectionOfPackageRead

Packages

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 FundraisingApi.PackageRead

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

FundraisingApi.AppealAttachmentRead

Anexo

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do anexo.
ID de recurso
 parent_id string

A ID do registro do sistema do recurso associado 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.

FundraisingApi.AppealCustomFieldRead

Campo personalizado

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do campo personalizado.
ID de recurso
 parent_id string

A ID do registro do sistema do recurso associado 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.

FundraisingApi.AppealRead

Appeal

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do recurso.
Categoria
 category string

A categoria do recurso.
Data de inclusão
 date_added date-time

A data em que o recurso foi criado.
Data modificada
 date_modified date-time

A data em que o recurso foi modificado pela última vez.
Description
 description string

O nome de exibição do recurso.
Data de término
 end_date date-time

A data de término do recurso.
value
 goal.value double

O valor monetário.
Inativo?
 inactive boolean

O recurso está ativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa
 lookup_id string

O identificador definido pelo usuário para o recurso.
Data de início
 start_date date-time

A data de início do recurso.

FundraisingApi.CampaignAttachmentRead

Anexo

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do anexo.
ID da Campanha
 parent_id string

A ID do registro do sistema da campanha 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.

FundraisingApi.CampaignCustomFieldRead

Campo personalizado

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do campo personalizado.
ID da Campanha
 parent_id string

A ID do registro do sistema da campanha 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.

FundraisingApi.CampaignRead

Campanha

Nome Caminho Tipo Description
ID
 id string

A ID de registro do sistema da campanha.
Categoria
 category string

A categoria da campanha.
Data de inclusão
 date_added date-time

A data em que a campanha foi criada.
Data modificada
 date_modified date-time

A data em que a campanha foi modificada pela última vez.
Description
 description string

O nome de exibição da campanha.
Data de término
 end_date date-time

A data de término da campanha.
value
 goal.value double

O valor monetário.
Inativo?
 inactive boolean

A campanha está inativa (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa
 lookup_id string

O identificador definido pelo usuário para a campanha.
Data de início
 start_date date-time

A data de início da campanha.

FundraisingApi.CreatedAppealAttachment

Anexo de recurso criado

Nome Caminho Tipo Description
ID
 id string

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

FundraisingApi.CreatedAppealCustomField

Campo personalizado de recurso criado

Nome Caminho Tipo Description
ID
 id string

A ID do campo personalizado de apelo recém-criado.

FundraisingApi.CreatedCampaignAttachment

Anexo de campanha criado

Nome Caminho Tipo Description
ID
 id string

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

FundraisingApi.CreatedCampaignCustomField

Campo personalizado de campanha criado

Nome Caminho Tipo Description
ID
 id string

A ID do campo personalizado da campanha recém-criado.

FundraisingApi.CreatedFundAttachment

Anexo de fundo criado

Nome Caminho Tipo Description
ID
 id string

A ID do anexo do fundo recém-criado.

FundraisingApi.CreatedFundCustomField

Campo personalizado do fundo criado

Nome Caminho Tipo Description
ID
 id string

A ID do campo personalizado do fundo recém-criado.

FundraisingApi.FundAttachmentRead

Anexo

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do anexo.
ID do fundo
 parent_id string

A ID do registro do sistema do fundo associado 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.

FundraisingApi.FundCustomFieldRead

Campo personalizado

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do campo personalizado.
ID do fundo
 parent_id string

A ID do registro do sistema do fundo associado 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.

FundraisingApi.FundRead

Fundo

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do fundo.
Categoria
 category string

A categoria do fundo.
Data de inclusão
 date_added date-time

A data em que o fundo foi criado.
Data modificada
 date_modified date-time

A data em que o fundo foi modificado pela última vez.
Description
 description string

O nome de exibição do fundo.
Data de término
 end_date date-time

A data de término do fundo.
value
 goal.value double

O valor monetário.
Inativo?
 inactive boolean

O fundo está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa
 lookup_id string

O identificador definido pelo usuário para o fundo.
Data de início
 start_date date-time

A data de início do fundo.
Tipo
 type string

O tipo do fundo.

FundraisingApi.PackageRead

Package

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do pacote.
ID de recurso
 appeal_id string

A ID do registro do sistema do recurso associado a este pacote.
Categoria
 category string

A categoria do pacote.
Data de inclusão
 date_added date-time

A data em que o pacote foi criado.
Data modificada
 date_modified date-time

A data em que o pacote foi modificado pela última vez.
value
 default_gift_amount.value double

O valor monetário.
Description
 description string

O nome de exibição do pacote.
Data de término
 end date-time

A data de término do pacote.
value
 goal.value double

O valor monetário.
Inativo?
 inactive boolean

O pacote está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa
 lookup_id string

O identificador definido pelo usuário para o pacote.
Anotações
 notes string

As anotações no pacote.
Contagem de destinatários
 recipient_count integer

O número de destinatários do pacote.
Data de início
 start date-time

A data de início do pacote.

NXTDataIntegrationApi.ConstituentRelationship

Nome Caminho Tipo Description
ID do Constituinte
 relation_id integer

A ID do registro do sistema do constituinte relacionado.
Descrição da relação
 relation_description string

A descrição da relação.
Tipo de relação
 relationship_type string

O tipo de relação.
Tipo de relação recíproca
 reciprocal_relationship_type string

O tipo de relação recíproca.
Data de
 date_from date-time

A data de início da relação.
Data para
 date_to date-time

A data de término da relação.
Anotações
 notes string

As anotações da relação.

NXTDataIntegrationApi.ConstituentRelationshipCollection

Relações constituintes

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 NXTDataIntegrationApi.ConstituentRelationship

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

NXTDataIntegrationApi.CreatedAppeal

Recurso criado

Nome Caminho Tipo Description
ID
 id string

A ID do recurso recém-criado.

NXTDataIntegrationApi.CreatedCampaign

Campanha criada

Nome Caminho Tipo Description
ID
 id string

A ID da campanha recém-criada.

NXTDataIntegrationApi.CreatedConstituentAppeal

Recurso constituinte criado

Nome Caminho Tipo Description
ID
 id string

A ID do recurso constituinte recém-criado.

NXTDataIntegrationApi.CreatedFund

Fundo criado

Nome Caminho Tipo Description
ID
 id string

A ID do fundo recém-criado.

NXTDataIntegrationApi.FundRelationship

Nome Caminho Tipo Description
ID do fundo
 relation_id integer

A ID de registro do sistema do fundo relacionado.
Descrição da relação
 relation_description string

A descrição da relação.
Tipo de relação
 relationship_type string

O tipo de relação.
Tipo de relação recíproca
 reciprocal_relationship_type string

O tipo de relação recíproca.
Data de
 date_from date-time

A data de início da relação.
Data para
 date_to date-time

A data de término da relação.
Anotações
 notes string

As anotações da relação.

NXTDataIntegrationApi.FundRelationshipCollection

Relações de fundo

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 NXTDataIntegrationApi.FundRelationship

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