Blackbaud Raisers Edge NXT (Pré-visualização)

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.

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 entidades encontradas no The Raiser's Edge NXT, incluindo:

Constituintes
Presentes
Ações
Observações
Campos personalizados
Campaigns
Fundos
Recursos
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 o NXT do The Raiser's Edge. 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	500	60 segundos

Ações

Adicionar registos a uma lista	Adicione um conjunto de registros a uma lista existente.
Adicionar um presente ao lote	Adicione um presente ao lote de presente especificado.
Atualizar a presença online de um constituinte	Atualiza uma presença online do constituinte.
Atualizar detalhes de confirmação do presente	Atualiza os detalhes de confirmação de um presente.
Atualizar detalhes do recibo de presente	Atualiza os detalhes do recibo de um presente.
Atualizar um alias constituinte	Atualiza um alias constituinte.
Atualizar um anexo constituinte	Atualiza um anexo constituinte.
Atualizar um anexo de ação	Atualiza um anexo de ação.
Atualizar um anexo de campanha	Atualiza um anexo de campanha.
Atualizar um anexo de fundo	Atualiza um anexo de fundo.
Atualizar um anexo de oportunidade	Atualiza um anexo de oportunidade.
Atualizar um anexo de presente	Atualiza um anexo de presente.
Atualizar um anexo de recurso	Atualiza um anexo de recurso.
Atualizar um campo personalizado de ação	Atualiza um campo personalizado de ação.
Atualizar um campo personalizado de campanha	Atualiza um campo personalizado de campanha.
Atualizar um campo personalizado de oportunidade	Atualiza um campo personalizado de oportunidade.
Atualizar um campo personalizado de presente	Atualiza um campo personalizado de presente.
Atualizar um campo personalizado de recurso	Atualiza um campo personalizado de recurso.
Atualizar um campo personalizado do constituinte	Atualiza um campo personalizado do constituinte.
Atualizar um campo personalizado do fundo	Atualiza um campo personalizado do fundo.
Atualizar um constituinte	Atualiza um constituinte.
Atualizar um código constituinte	Atualiza um código constituinte.
Atualizar um código de solicitação de constituinte	Atualiza um código de solicitação constituinte.
Atualizar um endereço de constituinte	Atualiza um endereço constituinte.
Atualizar um endereço de e-mail constituinte	Atualiza um endereço de e-mail constituinte.
Atualizar um evento	Atualiza os detalhes sobre um evento.
Atualizar um participante	Atualiza os detalhes sobre um participante.
Atualizar um telefone constituinte	Atualiza um telefone constituinte.
Atualizar uma ação constituinte	Atualiza uma ação constituinte.
Atualizar uma educação constituinte	Atualiza uma educação constituinte.
Atualizar uma foto de perfil do constituinte	Atualiza a foto de perfil atual de um constituinte.
Atualizar uma nota constituinte	Atualiza uma nota constituinte.
Atualizar uma oportunidade	Atualiza uma oportunidade.
Atualizar uma opção de participante	Atualiza os detalhes sobre uma opção de participante.
Atualizar uma relação constituinte	Atualiza uma relação para um constituinte. Se existe uma relação recíproca, ela também é modificada para refletir as mudanças. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.
Campos personalizados de ação de lista	Lista os campos personalizados de uma ação.
Criar um alias constituinte	Cria um novo alias constituinte.
Criar um anexo constituinte	Cria um novo anexo constituinte.
Criar um anexo de ação	Cria um novo anexo de ação.
Criar um anexo de campanha	Cria um novo anexo de campanha.
Criar um anexo de fundo	Cria uma nova penhora de fundo.
Criar um anexo de oportunidade	Cria um novo anexo de oportunidade.
Criar um anexo de presente	Cria um novo anexo de presente.
Criar um anexo de recurso	Cria um novo anexo de recurso.
Criar um campo personalizado constituinte	Cria um novo campo personalizado constituinte.
Criar um campo personalizado de ação	Cria um novo campo personalizado de ação.
Criar um campo personalizado de campanha	Cria um novo campo personalizado de campanha.
Criar um campo personalizado de fundo	Cria um novo campo personalizado de fundo.
Criar um campo personalizado de oportunidade	Cria um novo campo personalizado de oportunidade.
Criar um campo personalizado de presente	Cria um novo campo personalizado de presente.
Criar um campo personalizado de recurso	Cria um novo campo personalizado de recurso.
Criar um constituinte da organização	Cria um novo componente da organização.
Criar um constituinte individual	Cria um novo constituinte individual.
Criar um código constituinte	Cria um novo código constituinte.
Criar um código de solicitação constituinte	Cria um novo código de solicitação constituinte.
Criar um endereço de constituinte	Cria um novo endereço constituinte.
Criar um endereço de e-mail constituinte	Cria um novo endereço de e-mail constituinte.
Criar um evento	Cria um novo evento.
Criar um local de documento	Cria um novo identificador de documento exclusivo e um local de carregamento para uso com anexos físicos. A resposta incluirá instruções sobre onde e como carregar o conteúdo do documento.
Criar um lote de presente	Cria um novo lote de presente.
Criar um pagamento de taxa de participante	Cria um novo pagamento de taxa para um participante.
Criar um participante	Cria um novo participante para um evento.
Criar um presente	Cria um novo presente.
Criar um registo de consentimento de constituinte	Cria um novo registro de consentimento constituinte.
Criar um telefone constituinte	Cria um novo telefone constituinte.
Criar uma atribuição de angariação de fundos	Cria uma nova atribuição de angariação de fundos.
Criar uma ação constituinte	Cria uma nova ação constituinte.
Criar uma classificação de constituinte	Cria uma nova classificação de constituinte.
Criar uma doação de participante	Cria uma nova doação para um participante.
Criar uma educação constituinte	Cria uma nova educação constituinte.
Criar uma lista a partir de um conjunto de registos	Cria uma nova lista filtrada para o conjunto de registros especificado.
Criar uma nota constituinte	Cria uma nova nota constituinte.
Criar uma oportunidade	Cria uma nova oportunidade.
Criar uma opção de participante	Cria uma nova opção de participante para um participante.
Criar uma opção de participante do evento	Cria uma nova opção de participante para um evento.
Criar uma presença online constituinte	Cria uma nova presença online constituinte.
Criar uma relação de organização	Cria uma nova relação de organização. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte.
Criar uma relação individual	Cria uma nova relação individual. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte.
Criar uma taxa de evento	Cria uma nova taxa para um evento.
Criar uma taxa de participante	Cria uma nova taxa para um participante.
Lista de angariadores de fundos constituintes	Lista as atribuições de angariação de fundos para um constituinte.
Lista de constituintes	Devolve uma lista de constituintes.
Lista de códigos constituintes	Lista os códigos constituintes de um constituinte.
Lista de notas constituintes	Lista as notas para um constituinte.
Listar anexos constituintes	Lista os anexos de um constituinte.
Listar anexos de ação	Lista os anexos de uma ação.
Listar anexos de campanha	Lista os anexos de uma campanha.
Listar anexos de fundos	Lista os anexos de um fundo.
Listar anexos de oportunidade	Lista os anexos de uma oportunidade.
Listar anexos de presentes	Lista os anexos de um presente.
Listar anexos de recurso	Lista os anexos para um recurso.
Listar as formações dos constituintes	Lista os registros educacionais de um constituinte.
Listar as taxas de participação	Lista as taxas para um participante.
Listar atribuições de angariação de fundos	Liste as atribuições para uma angariação de fundos.
Listar ações	Retorna uma lista de ações.
Listar ações constituintes	Lista as ações para um constituinte.
Listar campanhas	Retorna uma lista de campanhas.
Listar campos personalizados constituintes	Lista os campos personalizados de um constituinte.
Listar campos personalizados da campanha	Lista os campos personalizados de uma campanha.
Listar campos personalizados de oportunidade	Lista os campos personalizados para uma oportunidade.
Listar campos personalizados de presentes	Lista os campos personalizados de um presente.
Listar campos personalizados de recurso	Lista os campos personalizados para um recurso.
Listar campos personalizados do fundo	Lista os campos personalizados de um fundo.
Listar classificações de constituintes	Devolve a lista de classificações de um constituinte.
Listar códigos de solicitação de constituintes	Lista os códigos de solicitação para um constituinte.
Listar doações de participantes	Lista as doações para um participante.
Listar endereços de constituintes	Lista os endereços de um constituinte.
Listar endereços de e-mail constituintes	Lista os endereços de e-mail de um constituinte.
Listar eventos	Retorna uma lista de eventos.
Listar fundos	Devolve uma lista de fundos.
Listar lotes de presentes	Liste os lotes de presente.
Listar oportunidades	Devolve uma lista de oportunidades.
Listar opções de participantes	Lista as opções de participante para um participante.
Listar opções de participantes do evento	Lista as opções de participantes para um evento.
Listar pacotes	Retorna uma lista de pacotes.
Listar pagamentos de taxas de participante	Lista os pagamentos de taxas para um participante.
Listar participantes do evento	Lista os participantes de um evento.
Listar presentes	Devolve uma lista de presentes.
Listar presenças online constituintes	Lista as presenças online de um constituinte.
Listar pseudónimos constituintes	Lista os aliases de um constituinte.
Listar recursos	Devolve uma lista de recursos.
Listar registros de consentimento dos constituintes	Lista os registros de consentimento de um constituinte.
Listar relações constituintes	Lista as relações de um constituinte.
Listar taxas de eventos	Lista as taxas para um evento.
Listar telefones constituintes	Lista os telefones de um constituinte.
Obtenha a doação vitalícia do constituinte	Devolve o tempo de vida dando resumo para um constituinte.
Obtenha o último presente do constituinte	Devolve o presente mais recente para um constituinte.
Obtenha um pacote	Retorna informações sobre um pacote.
Obter o estatuto de potencial eleitor	Devolve o estado de prospeção atual de um constituinte.
Obter um constituinte	Devolve informações sobre um constituinte.
Obter um fundo	Devolve informações sobre um fundo.
Obter um participante	Retorna informações sobre um participante específico do evento.
Obter uma ação constituinte	Retorna informações sobre uma ação constituinte.
Obter uma foto de perfil do constituinte	Retorna a foto de perfil atual de um constituinte.
Procurar um constituinte	Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Suporta nome, sobrenome, nome preferencial, nome anterior, alias, endereço de e-mail, número de telefone, endereço ou ID de pesquisa. Combinações de nomes, como nome e sobrenome ou nome e sobrenome preferidos, são válidas, mas, caso contrário, a pesquisa suporta apenas um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras grafias alternativas. Esta pesquisa não suporta caracteres curinga como * ou ?. Os resultados da pesquisa estão limitados a 500 registos.
Receba o maior presente do constituinte	Devolve o maior presente para um constituinte.
Receba o primeiro presente do constituinte	Devolve o primeiro presente para um constituinte.
Receba um evento	Retorna informações sobre um evento.
Receba um presente	Retorna informações sobre um presente.
Receba um recurso	Retorna informações sobre um recurso.
Receba uma campanha	Retorna informações sobre uma campanha.
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.
Suprimir um código constituinte	Elimina um código constituinte.

Adicionar registos a uma lista

ID da Operação:: AppendIDsToList

Adicione um conjunto de registros a uma lista existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de lista	list_type	True	string	O tipo de lista.
List	list_id	True	string	O ID de registro do sistema da lista.
ID(s)	ids	True	array of string	Os identificadores únicos dos registos a adicionar à lista (máximo de 100 000 valores).

Adicionar um presente ao lote

ID da Operação:: AddGiftToBatch

Adicione um presente ao lote de presente especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Batch	batch_id	True	string	O lote ao qual o presente será adicionado.
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado ao presente.
Montante	value	True	double	O valor monetário do presente.
Date	date	True	date	A data do presente (ex: '2020-09-18').
Tipo	type	True	string	O tipo de presente.
ID da campanha	campaign_id		string	O ID de registro do sistema da campanha associado à divisão do presente.
ID do fundo	fund_id	True	string	O ID de registro do sistema do fundo associado à divisão do presente.
ID do recurso	appeal_id		string	O ID de registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	O ID de registro do sistema do pacote associado à divisão do presente.
Montante	value	True	double	O valor monetário do presente dividido.
Método de pagamento	payment_method	True	string	O método de pagamento.
Número do cheque	check_number		string	O número do cheque (aplicável apenas quando o método de pagamento é "PersonalCheck").
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Reference	reference		string	A referência de pagamento (aplicável apenas quando o método de pagamento é "Outros").
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É anónimo?	is_anonymous		boolean	O presente é anónimo? Se nenhum valor for fornecido, será usado o anonimato padrão do doador.
Subtipo	subtype		string	O subtipo do presente.
Comment	reference		string	Notas para rastrear detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Utilizar créditos para angariação de fundos?	default_fundraiser_credits		boolean	Utilizar os créditos de angariação de fundos por defeito?
Usa créditos suaves?	default_soft_credits		boolean	Utilizar os créditos suaves por defeito?
Círculo eleitoral	constituency		string	O eleitorado da dádiva.
Estado da publicação	post_status		string	O status do post do presente.
Data de publicação	post_date		date	A data em que o presente foi publicado (ex: '2020-09-18').
Estado do recibo	status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	O valor monetário do recibo do presente.
Data do recibo	date		date	A data em que o presente foi recebido (ex: '2020-09-18').

Devoluções

Contém uma coleção de registros de erro de presentes em lote e os presentes em lote que a operação adicionou

Results: GiftApi.BatchGiftAddResults

Atualizar a presença online de um constituinte

ID da Operação:: EditConstituentOnlinePresence

Atualiza uma presença online do constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de presença online	online_presence_id	True	string	O ID de registo do sistema da presença online a atualizar.
Tipo	type		string	O tipo de presença online.
Link	address		string	O endereço Web da presença online.
Primária?	primary		boolean	Esta é a principal presença online do eleitor?
Inativo?	inactive		boolean	Esta presença online está inativa?

Atualizar detalhes de confirmação do presente

ID da Operação:: EditGiftAcknowledgement

Atualiza os detalhes de confirmação de um presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de confirmação	acknowledgement_id	True	string	O ID de registro do sistema da confirmação do presente a ser atualizado. Ele usa o ID do presente pai como seu valor.
Situação	status		string	O status do reconhecimento. Quando o status é definido como DoNotAcknowledge, letra e data devem ser nulas. Quando o status é definido como NeedsAcknowledgement, a data deve ser nula.
Date	date		date-time	A data associada ao reconhecimento (ex: '2020-09-18T04:13:56Z').
Carta	letter		string	A carta associada ao reconhecimento.

Atualizar detalhes do recibo de presente

ID da Operação:: EditGiftReceipt

Atualiza os detalhes do recibo de um presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do recibo	receipt_id	True	string	O ID de registro do sistema do recibo de presente a ser atualizado. Ele usa o ID do presente pai como seu valor.
Situação	status		string	O status de recebimento do presente. Quando o status é definido como NeedsReceipt ou DoNotReceipt, a data de recebimento deve ser nula.
valor	value		double	O valor monetário.
Date	date		date-time	A data no recibo (ex: '2020-09-18T04:13:56Z').
Número	number		integer	O número do recibo.

Atualizar um alias constituinte

ID da Operação:: EditConstituentAlias

Atualiza um alias constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Alias ID	alias_id	True	string	O ID de registro do sistema do alias a ser atualizado.
Alias	name		string	O nome a utilizar como pseudónimo do constituinte. Limite de caracteres: 100.
Tipo	type		string	O tipo de alias.

Atualizar um anexo constituinte

ID da Operação:: EditConstituentAttachment

Atualiza um anexo constituinte.

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.

Atualizar um anexo de ação

ID da Operação:: EditActionAttachment

Atualiza um anexo de ação.

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.

Atualizar um anexo de campanha

ID da Operação:: EditCampaignAttachment

Atualiza um anexo de campanha.

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.

Atualizar um anexo de fundo

ID da Operação:: EditFundAttachment

Atualiza um anexo de fundo.

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.

Atualizar um anexo de oportunidade

ID da Operação:: EditOpportunityAttachment

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.

Atualizar um anexo de presente

ID da Operação:: EditGiftAttachment

Atualiza um anexo de presente.

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.

Atualizar um anexo de recurso

ID da Operação:: EditAppealAttachment

Atualiza um anexo de recurso.

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.

Atualizar um campo personalizado de ação

ID da Operação:: EditActionCustomField

Atualiza um campo personalizado de ação.

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

ID da Operação:: EditCampaignCustomField

Atualiza um campo personalizado de campanha.

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

ID da Operação:: EditOpportunityCustomField

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

ID da Operação:: EditGiftCustomField

Atualiza um campo personalizado de presente.

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

ID da Operação:: EditAppealCustomField

Atualiza um campo personalizado de recurso.

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

ID da Operação:: EditConstituentCustomField

Atualiza um campo personalizado do constituinte.

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

ID da Operação:: EditFundCustomField

Atualiza um campo personalizado do fundo.

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

ID da Operação:: EditConstituent

Atualiza 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 a atualizar.
Title	title		string	O título principal do constituinte (apenas para pessoas singulares).
Nome próprio	first		string	Nome próprio do constituinte (apenas para pessoas singulares). Limite de caracteres: 50.
Apelido	last		string	Apelido do eleitor (apenas para pessoas singulares). Limite de caracteres: 100.
Nome da organização	name		string	Para indivíduos, este é um campo computado que não é aplicável para operações de edição. Para organização, este campo é obrigatório e representa o nome da organização. Limite de caracteres: 100.
Sufixo	suffix		string	Sufixo primário do constituinte (apenas para indivíduos).
Nome preferido	preferred_name		string	O nome preferido do constituinte (apenas para pessoas singulares). Limite de caracteres: 50.
ID de pesquisa	lookup_id		string	O identificador definido pelo utilizador para o constituinte.
Sexo	gender		string	O sexo do constituinte (apenas para indivíduos).
Nome do meio	middle		string	Nome do meio do constituinte (apenas para pessoas singulares). Limite de caracteres: 50.
Antigo nome	former_name		string	O nome anterior do constituinte (apenas para pessoas singulares). Limite de caracteres: 100.
Título 2	title_2		string	O título secundário do constituinte (apenas para pessoas singulares).
Sufixo 2	suffix_2		string	Sufixo secundário do constituinte (apenas para indivíduos).
Estado civil	marital_status		string	O estado civil do constituinte (apenas para pessoas singulares).
Dá anonimamente?	gives_anonymously		boolean	O constituinte doa anonimamente?
Inativo?	inactive		boolean	O constituinte está inativo?
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Local de nascimento	birthplace		string	O local de nascimento do constituinte (apenas para indivíduos).
Etnicidade	ethnicity		string	A etnia do constituinte (apenas para indivíduos).
Rendimentos	income		string	O rendimento do constituinte (apenas para pessoas singulares).
Religião	religion		string	A religião do constituinte (apenas para indivíduos).
Indústria	industry		string	A indústria do constituinte (apenas para organizações).
Número de empregados	num_employees		integer	O número de funcionários na organização.
Combina presentes?	matches_gifts		boolean	A organização combina presentes?
Fator de presente correspondente	matching_gift_factor		double	O fator de presente correspondente (apenas para organizações).
Min match por presente	value		double	O valor mínimo correspondente por presente para o constituinte (apenas para organizações).
Máximo de correspondência por presente	value		double	O valor máximo correspondente por presente para o constituinte (apenas para organizações).
Min match por constit	value		double	O total mínimo correspondente para o constituinte (apenas para organizações).
Correspondência máxima por constit	value		double	O total máximo correspondente para o constituinte (apenas para organizações).
Notas de presente correspondentes	matching_gift_notes		string	As notas de presente correspondentes para o constituinte (apenas para organizações).
Falecido?	deceased		boolean	O constituinte faleceu (apenas para pessoas singulares)?
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Atualizar um código constituinte

ID da Operação:: EditConstituentCode

Atualiza um código constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do código constituinte	constituent_code_id	True	string	O ID de registo do sistema do código constituinte a atualizar.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Sequence	sequence		integer	A sequência numérica associada ao código constituinte.

Atualizar um código de solicitação de constituinte

ID da Operação:: EditConstituentSolicitCode

Atualiza um código de solicitação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do código de solicitação	constituent_solicit_code_id	True	string	O ID de registro do sistema do código de solicitação a ser atualizado.
Solicitar código	solicit_code		string	Instruções de comunicação e/ou restrições para um componente.
Data de início	start_date		date	A data de início do código de solicitação (ex: '2005-09-18').
Data de fim	end_date		date	A data final do código de solicitação (ex: '2005-09-18').

Atualizar um endereço de constituinte

ID da Operação:: EditConstituentAddress

Atualiza um endereço constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do endereço	address_id	True	string	O ID de registro do sistema do endereço a ser atualizado.
Tipo de endereço	type		string	O tipo de endereço.
Country	country		string	O país do endereço (pode ser o ID, nome ou abreviatura).
Linhas de endereço	address_lines		string	As linhas de endereço.
City	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
Estado	state		string	O estado do endereço.
Código postal	postal_code		string	O código postal do endereço.
Subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
Concelho	county		string	O município do endereço.
Fonte de informação	information_source		string	A fonte de informação para o endereço.
Região	region		string	A região do endereço.
CARRINHO	cart		string	A rota da transportadora (CART) para o endereço.
LOTE	lot		string	A linha de viagem (LOT) para o endereço.
CPD	dpc		string	O código do ponto de entrega (DPC) para o endereço.
Válido a partir de	start		date	A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»).
Válido para	end		date	A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»).
Primária?	preferred		boolean	É este o endereço preferido do eleitor?
Não envia?	do_not_mail		boolean	O constituinte pode ser contactado neste endereço?
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Atualizar um endereço de e-mail constituinte

ID da Operação:: EditConstituentEmailAddress

Atualiza um endereço de e-mail constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do endereço de e-mail	email_address_id	True	string	O ID de registro do sistema do endereço de e-mail a ser atualizado.
Tipo de e-mail	type		string	O tipo de endereço de e-mail.
Endereço de e-mail	address		string	O endereço de e-mail.
Primária?	primary		boolean	Este é o endereço de e-mail principal do eleitor?
Não envia e-mail?	do_not_email		boolean	O constituinte pode ser contactado através deste endereço de correio eletrónico?
Inativo?	inactive		boolean	Este endereço de e-mail está inativo?

Atualizar um evento

ID da Operação:: EditEvent

Atualiza os detalhes sobre um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID de registro do sistema do evento a ser atualizado.
Nome do evento	name		string	O nome do evento.
Description	description		string	A descrição do evento.
Categoria	name	True	string	O nome da categoria.
Data de início	start_date		date	A data de início do evento (ex: '2020-09-18').
Hora de início	start_time		string	A hora de início do evento (ex: '07:30').
Data de fim	end_date		date	A data final do evento (ex: '2020-09-18').
Hora de fim	end_time		string	A hora de fim do evento (ex: '07:30').
ID de pesquisa	lookup_id		string	A ID de pesquisa do evento.
Capacidade	capacity		integer	O número de pessoas que podem assistir ao evento.
Objetivo	goal		double	O objetivo monetário do evento.
ID da Campanha	campaign_id		string	O ID de registo do sistema da campanha associada ao evento.
ID do Fundo	fund_id		string	O ID de registo do sistema do fundo associado ao evento.
Inativo?	inactive		boolean	O evento está ativo?

Atualizar um participante

ID da Operação:: EditParticipant

Atualiza os detalhes sobre um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registro do sistema do participante a ser atualizado.
ID do constituinte	constituent_id		string	O ID de constituinte do participante.
ID do anfitrião	host_id		string	O ID do registo de participante do anfitrião.
Estado de RSVP	rsvp_status		string	O status do envolvimento do participante com o evento.
Participou?	attended		boolean	O participante compareceu ao evento?
Estado do convite	invitation_status		string	O estado do convite ao participante.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Nível de participação	name	True	string	O nome do nível de participação.

Atualizar um telefone constituinte

ID da Operação:: EditConstituentPhone

Atualiza um telefone constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de telefone	phone_id	True	string	O ID de registro do sistema do telefone a ser atualizado.
Tipo	type		string	O tipo de telefone.
Número	number		string	O número de telefone.
Primária?	primary		boolean	Este é o telefone principal do eleitor?
Não liga?	do_not_call		boolean	O constituinte pode ser contactado através deste número?
Inativo?	inactive		boolean	Este número de telefone está inativo?

Atualizar uma ação constituinte

ID da Operação:: EditAction

Atualiza uma ação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação a ser atualizada.
Categoria	category		string	O canal ou intenção da interação constituinte.
Concluído?	completed		boolean	A ação está concluída? Se o sistema estiver configurado para usar status de ação personalizados, esse valor será baseado no valor de status da ação.
Concluído a	completed_date		date-time	A data em que a ação foi concluída (ex: '2020-09-18T04:13:56Z').
Date	date		date-time	A data da ação (ex: '2020-09-18T04:13:56Z').
Observação	description		string	A explicação detalhada que elabora o resumo da ação.
Direction	direction		string	A direção da ação.
Angariação(ões) de fundos	fundraisers		array of string	O conjunto de IDs de registro do sistema para os angariadores de fundos associados à ação.
Localização	location		string	O local da ação.
ID da oportunidade	opportunity_id		string	O ID de registro do sistema da oportunidade associada à ação.
Outcome	outcome		string	O resultado da ação.
Priority	priority		string	A prioridade da ação.
Hora de início	start_time		string	A hora de início da ação. Usa o tempo de 24 horas no formato HH:mm.
Hora de fim	end_time		string	A hora de fim da ação. Usa o tempo de 24 horas no formato HH:mm.
Situação	status		string	O status da ação.
Resumo	summary		string	A breve descrição da ação que aparece na parte superior do registro. Limite de caracteres: 255.
Tipo	type		string	Descrição adicional da ação para complementar a categoria.

Atualizar uma educação constituinte

ID da Operação:: EditConstituentEducation

Atualiza uma educação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de escolaridade	education_id	True	string	O ID do registro do sistema do registro educacional a ser atualizado.
Escola	school		string	O nome da escola/estabelecimento.
Tipo	type		string	O tipo de educação.
Classe de	class_of		string	O ano em que o constituinte se formou.
Situação	status		string	O estatuto da educação.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Licenciatura	degree		string	O grau recebido.
GPA	gpa		double	A média de pontos da nota.
Objeto de estudo	subject_of_study		string	O objeto de estudo.
Primária?	primary		boolean	Esta é a associação de escolas primárias do constituinte?
Majors	majors		array of string	Os principais cursos de estudo.
Menores	minors		array of string	Os cursos menores de estudo.
Campus	campus		string	O campus. Limite de caracteres: 50.
Organização social	social_organization		string	A organização social. Limite de caracteres: 50.
Nome conhecido	known_name		string	O nome conhecido. Limite de caracteres: 50.
Classe de grau	class_of_degree		string	A classe de grau.
Departamento	department		string	O nome do departamento de educação.
Corpo Docente	faculty		string	O nome da faculdade.
Número de registo	registration_number		string	O número de registo. Limite de caracteres: 50.

Atualizar uma foto de perfil do constituinte

ID da Operação:: EditConstituentProfilePicture

Atualiza a foto de perfil atual 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 cuja foto de perfil deve ser atualizada.
Nome do ficheiro	file_name	True	string	O nome do arquivo.
ID do documento	document_id	True	uuid	O identificador do documento.
ID da miniatura	thumbnail_id	True	uuid	O identificador do documento em miniatura.

Atualizar uma nota constituinte

ID da Operação:: EditConstituentNote

Atualiza uma nota constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da nota	note_id	True	string	O ID de registro do sistema da nota a ser atualizada.
Tipo	type		string	O tipo de nota.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Resumo	summary		string	O resumo da nota. Limite de caracteres: 50.
Observação	text		string	O texto da nota.

Atualizar uma oportunidade

ID da Operação:: EditOpportunity

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?

Atualizar uma opção de participante

ID da Operação:: EditParticipantOption

Atualiza os detalhes sobre uma opção de participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da opção do participante	option_id	True	string	O ID de registro do sistema da opção de participante a ser atualizada.
Valor	option_value	True	string	A resposta do participante à opção.

Atualizar uma relação constituinte

ID da Operação:: EditConstituentRelationship

Atualiza uma relação para um constituinte. Se existe uma relação recíproca, ela também é modificada para refletir as mudanças. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de relacionamento	relationship_id	True	string	O ID de registro do sistema da relação a ser atualizada.
Tipo	type		string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type		string	Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, numa relação entre um constituinte masculino e um irmão do sexo feminino, o tipo de relação recíproca seria irmão.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É cônjuge?	is_spouse		boolean	A pessoa coligada é cônjuge do constituinte (aplica-se apenas às relações entre particulares)?
O constituinte é chefe de família?	is_constituent_head_of_household		boolean	O constituinte é o chefe do agregado familiar?
O cônjuge é chefe de família?	is_spouse_head_of_household		boolean	O cônjuge é o chefe de família?
Observações	comment		string	Notas adicionais sobre a relação.
É contacto?	is_organization_contact		boolean	O constituinte representa esta organização como um contacto (aplica-se apenas às relações entre organizações e indivíduos)?
O negócio é principal?	is_primary_business		boolean	Este é o negócio principal do constituinte (aplica-se apenas às relações entre organizações e indivíduos)?
Tipo de contacto	organization_contact_type		string	Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas às relações entre organizações e indivíduos.
Position	position		string	A posição do indivíduo na organização. Aplica-se apenas às relações entre organizações e indivíduos. Limite de caracteres: 50.

Campos personalizados de ação de lista

ID da Operação:: ListActionCustomFields

Lista os campos personalizados de uma ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação.

Devoluções

Campos personalizados

Body: ConstituentApi.ApiCollectionOfActionCustomFieldRead

Criar um alias constituinte

ID da Operação:: CreateConstituentAlias

Cria um novo alias constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado ao alias.
Alias	name	True	string	O nome a utilizar como pseudónimo do constituinte. Limite de caracteres: 100.
Tipo	type		string	O tipo de alias.

Devoluções

Alias constituinte criado

Body: ConstituentApi.CreatedConstituentAlias

Criar um anexo constituinte

ID da Operação:: CreateConstituentAttachment

Cria um novo anexo constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	parent_id	True	string	O ID de registo do sistema do constituinte associado 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.

Devoluções

Anexação constituinte criada

Body: ConstituentApi.CreatedConstituentAttachment

Criar um anexo de ação

ID da Operação:: CreateActionAttachment

Cria um novo anexo de ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	parent_id	True	string	O ID de registro do sistema da ação 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.

Devoluções

Anexo de ação criado

Body: ConstituentApi.CreatedActionAttachment

Criar um anexo de campanha

ID da Operação:: CreateCampaignAttachment

Cria um novo anexo de campanha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	parent_id	True	string	O ID de registo do sistema da campanha associado 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.

Devoluções

Anexo de campanha criado

Body: FundraisingApi.CreatedCampaignAttachment

Criar um anexo de fundo

ID da Operação:: CreateFundAttachment

Cria uma nova penhora de fundo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Fundo	parent_id	True	string	O ID de registo do sistema do fundo associado à penhora.
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.

Devoluções

Penhora de fundo criada

Body: FundraisingApi.CreatedFundAttachment

Criar um anexo de oportunidade

ID da Operação:: CreateOpportunityAttachment

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.

Devoluções

Anexo de oportunidade criado

Body: OpportunityApi.CreatedOpportunityAttachment

Criar um anexo de presente

ID da Operação:: CreateGiftAttachment

Cria um novo anexo de presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de presente	parent_id	True	string	O ID de registro do sistema do presente associado 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.

Devoluções

Acessório de presente criado

Body: GiftApi.CreatedGiftAttachment

Criar um anexo de recurso

ID da Operação:: CreateAppealAttachment

Cria um novo anexo de recurso.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do recurso	parent_id	True	string	O ID de registo do sistema do recurso associado à penhora.
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.

Devoluções

Recurso criado

Body: FundraisingApi.CreatedAppealAttachment

Criar um campo personalizado constituinte

ID da Operação:: CreateConstituentCustomField

Cria um novo campo personalizado constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado constituinte criado

Body: ConstituentApi.CreatedConstituentCustomField

Criar um campo personalizado de ação

ID da Operação:: CreateActionCustomField

Cria um novo campo personalizado de ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado de ação criado

Body: ConstituentApi.CreatedActionCustomField

Criar um campo personalizado de campanha

ID da Operação:: CreateCampaignCustomField

Cria um novo campo personalizado de campanha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado de campanha criado

Body: FundraisingApi.CreatedCampaignCustomField

Criar um campo personalizado de fundo

ID da Operação:: CreateFundCustomField

Cria um novo campo personalizado de fundo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado do fundo criado

Body: FundraisingApi.CreatedFundCustomField

Criar um campo personalizado de oportunidade

ID da Operação:: CreateOpportunityCustomField

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

Body: OpportunityApi.CreatedOpportunityCustomField

Criar um campo personalizado de presente

ID da Operação:: CreateGiftCustomField

Cria um novo campo personalizado de presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado de presente criado

Body: GiftApi.CreatedGiftCustomField

Criar um campo personalizado de recurso

ID da Operação:: CreateAppealCustomField

Cria um novo campo personalizado de recurso.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado de recurso criado

Body: FundraisingApi.CreatedAppealCustomField

Criar um constituinte da organização

ID da Operação:: CreateOrganizationConstituent

Cria um novo componente da organização.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome da organização. Limite de caracteres: 100.
ID de pesquisa	lookup_id		string	O identificador definido pelo utilizador para o constituinte.
tipo	type	True	string	O tipo de endereço.
country	country		string	O país do endereço (pode ser o ID, nome ou abreviatura).
linhas	address_lines		string	As linhas de endereço. Limite de caracteres: 150.
city	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
state	state		string	O estado do endereço.
código postal	postal_code		string	O código postal do endereço. Limite de caracteres: 12.
subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
concelho	county		string	O município do endereço.
start	start		date	A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»).
fim	end		date	A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»).
tipo	type	True	string	O tipo de telefone.
número	number	True	string	O número de telefone.
é primário?	primary		boolean	Este é o principal número de telefone do eleitor?
tipo	type	True	string	O tipo de endereço de e-mail.
address	address	True	string	O endereço de e-mail.
é primário?	primary		boolean	Este é o endereço de e-mail principal do eleitor?
tipo	type	True	string	O tipo de presença online.
address	address	True	string	O endereço Web da presença online.
é primário?	primary		boolean	Esta é a principal presença online do eleitor?
Dá anonimamente?	gives_anonymously		boolean	O constituinte doa anonimamente?
Indústria	industry		string	A indústria do constituinte.
Número de empregados	num_employees		integer	O número de funcionários na organização.
Combina presentes?	matches_gifts		boolean	A organização combina presentes?
Fator de presente correspondente	matching_gift_factor		double	O fator de presente correspondente.
Min match por presente	value		double	O valor mínimo correspondente por presente para o constituinte.
Máximo de correspondência por presente	value		double	O valor máximo correspondente por presente para o constituinte.
Min match por constit	value		double	O total mínimo correspondente para o constituinte.
Correspondência máxima por constit	value		double	O total máximo correspondente para o constituinte.
Notas de presente correspondentes	matching_gift_notes		string	As notas de presente correspondentes para o constituinte.

Devoluções

Constituinte da organização criada

Body: ConstituentApi.CreatedOrganizationConstituent

Criar um constituinte individual

ID da Operação:: CreateIndividualConstituent

Cria um novo constituinte individual.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Title	title		string	O título principal do constituinte.
Nome próprio	first		string	Primeiro nome do eleitor. Limite de caracteres: 50.
Apelido	last	True	string	Apelido do eleitor. Limite de caracteres: 100.
Sufixo	suffix		string	Sufixo primário do constituinte.
ID de pesquisa	lookup_id		string	O identificador definido pelo utilizador para o constituinte.
tipo	type	True	string	O tipo de endereço.
country	country		string	O país do endereço (pode ser o ID, nome ou abreviatura).
linhas	address_lines		string	As linhas de endereço. Limite de caracteres: 150.
city	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
state	state		string	O estado do endereço.
código postal	postal_code		string	O código postal do endereço. Limite de caracteres: 12.
subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
concelho	county		string	O município do endereço.
start	start		date	A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»).
fim	end		date	A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»).
tipo	type	True	string	O tipo de telefone.
número	number	True	string	O número de telefone.
é primário?	primary		boolean	Este é o principal número de telefone do eleitor?
tipo	type	True	string	O tipo de endereço de e-mail.
address	address	True	string	O endereço de e-mail.
é primário?	primary		boolean	Este é o endereço de e-mail principal do eleitor?
tipo	type	True	string	O tipo de presença online.
address	address	True	string	O endereço Web da presença online.
é primário?	primary		boolean	Esta é a principal presença online do eleitor?
Nome preferido	preferred_name		string	O nome preferido do eleitor. Limite de caracteres: 50.
Nome do meio	middle		string	O nome do meio do constituinte. Limite de caracteres: 50.
Antigo nome	former_name		string	O antigo nome do constituinte. Limite de caracteres: 100.
Título 2	title_2		string	Título secundário do constituinte.
Sufixo 2	suffix_2		string	Sufixo secundário do constituinte.
Sexo	gender		string	O género do constituinte.
Estado civil	marital_status		string	O estado civil do constituinte.
Dá anonimamente?	gives_anonymously		boolean	O constituinte doa anonimamente?
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Local de nascimento	birthplace		string	O local de nascimento do constituinte.
Etnicidade	ethnicity		string	A etnia do constituinte.
Rendimentos	income		string	A renda para o constituinte.
Religião	religion		string	A religião do constituinte.
Destinatário personalizado?	custom_format		boolean	O destinatário principal é um formato personalizado?
Formato do destinatário	configuration_id		string	Configuração do destinatário principal (necessária, a menos que seja usado um formato personalizado).
Nome personalizado do destinatário	formatted_name		string	Nome formatado do destinatário principal (necessário quando um formato personalizado é usado). Limite de caracteres: 255.
Saudação personalizada?	custom_format		boolean	A saudação primária é um formato personalizado?
Formato de saudação	configuration_id		string	Configuração de saudação primária (necessária, a menos que um formato personalizado seja usado).
Nome personalizado de saudação	formatted_name		string	Nome formatado de saudação primária (necessário quando um formato personalizado é usado). Limite de caracteres: 255.

Devoluções

Constituinte individual criado

Body: ConstituentApi.CreatedIndividualConstituent

Criar um código constituinte

ID da Operação:: CreateConstituentCode

Cria um novo código constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte associado ao código do constituinte.
Código constituinte	description	True	string	O código constituinte.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Sequence	sequence		integer	A sequência numérica associada ao código constituinte.

Devoluções

Código constituinte criado

Body: ConstituentApi.CreatedConstituentCode

Criar um código de solicitação constituinte

ID da Operação:: CreateConstituentSolicitCode

Cria um novo código de solicitação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte associado ao código de solicitação.
Solicitar código	solicit_code	True	string	Instruções de comunicação e/ou restrições para um componente.
Data de início	start_date		date	A data de início do código de solicitação (ex: '2005-09-18').
Data de fim	end_date		date	A data final do código de solicitação (ex: '2005-09-18').

Devoluções

Código de solicitação constituinte criado

Body: CommPrefApi.CreatedConstituentSolicitCode

Criar um endereço de constituinte

ID da Operação:: CreateConstituentAddress

Cria um novo endereço constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte associado ao endereço.
Tipo de endereço	type	True	string	O tipo de endereço.
Country	country		string	O país do endereço (pode ser o ID, nome ou abreviatura).
Linhas de endereço	address_lines		string	As linhas de endereço.
City	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
Estado	state		string	O estado do endereço.
Código postal	postal_code		string	O código postal do endereço.
Subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
Concelho	county		string	O município do endereço.
Fonte de informação	information_source		string	A fonte de informação para o endereço.
Região	region		string	A região do endereço.
CARRINHO	cart		string	A rota da transportadora (CART) para o endereço.
LOTE	lot		string	A linha de viagem (LOT) para o endereço.
CPD	dpc		string	O código do ponto de entrega (DPC) para o endereço.
Válido a partir de	start		date	A data em que o constituinte começou a residir neste endereço (ex: «2005-09-18»).
Válido para	end		date	A data em que o constituinte deixou de residir neste endereço (ex: «2005-09-18»).
Primária?	preferred		boolean	É este o endereço preferido do eleitor?
Não envia?	do_not_mail		boolean	O constituinte pode ser contactado neste endereço?
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Devoluções

Endereço constituinte criado

Body: ConstituentApi.CreatedConstituentAddress

Criar um endereço de e-mail constituinte

ID da Operação:: CreateConstituentEmailAddress

Cria um novo endereço de e-mail constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado ao endereço de e-mail.
Tipo de e-mail	type	True	string	O tipo de endereço de e-mail.
Endereço de e-mail	address	True	string	O endereço de e-mail.
Primária?	primary		boolean	Este é o endereço de e-mail principal do eleitor?
Não envia e-mail?	do_not_email		boolean	O constituinte pode ser contactado através deste endereço de correio eletrónico?
Inativo?	inactive		boolean	Este endereço de e-mail está inativo?

Devoluções

Endereço de e-mail constituinte criado

Body: ConstituentApi.CreatedConstituentEmailAddress

Criar um evento

ID da Operação:: CreateEvent

Cria um novo evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do evento	name	True	string	O nome do evento.
Description	description		string	A descrição do evento.
Categoria	name	True	string	O nome da categoria.
Data de início	start_date	True	date	A data de início do evento (ex: '2020-09-18').
Hora de início	start_time		string	A hora de início do evento (ex: '07:30').
Data de fim	end_date		date	A data final do evento (ex: '2020-09-18').
Hora de fim	end_time		string	A hora de fim do evento (ex: '07:30)'.
ID de pesquisa	lookup_id		string	A ID de pesquisa do evento.
Capacidade	capacity		integer	O número de pessoas que podem assistir ao evento.
Objetivo	goal		double	O objetivo monetário do evento.
ID da Campanha	campaign_id		string	O ID de registo do sistema da campanha associada ao evento.
ID do Fundo	fund_id		string	O ID de registo do sistema do fundo associado ao evento.
Inativo?	inactive		boolean	O evento está ativo?

Devoluções

Evento criado

Body: EventApi.CreatedEvent

Criar um local de documento

ID da Operação:: CreateDocument

Cria um novo identificador de documento exclusivo e um local de carregamento para uso com anexos físicos. A resposta incluirá instruções sobre onde e como carregar o conteúdo do documento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome do ficheiro	file_name		string	O nome do ficheiro do documento a carregar.
Incluir miniatura?	upload_thumbnail		boolean	Incluir um local de documento em miniatura?

Devoluções

Definição do ficheiro

Body: ConstituentApi.FileDefinition

Criar um lote de presente

ID da Operação:: CreateGiftBatch

Cria um novo lote de presente.

Parâmetros

Name	Chave	Tipo	Description
Description	batch_description	string	A descrição do lote.
Número esperado	expected_number	integer	O número de presentes esperados no lote.
Total esperado	expected_batch_total	double	O valor total dos presentes no lote.
Número do lote	batch_number	string	O identificador exclusivo específico do lote.

Devoluções

Lote de presente criado

Body: GiftBatchApi.CreatedBatch

Criar um pagamento de taxa de participante

ID da Operação:: CreateParticipantFeePayment

Cria um novo pagamento de taxa para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.
ID de presente	gift_id	True	string	O ID de registro systetm do presente ao qual a taxa de participante está vinculada.
Montante aplicado	applied_amount	True	double	O valor do pagamento que se aplica às taxas de participação.

Devoluções

Pagamento da taxa de participante criada

Body: EventApi.CreatedParticipantFeePayment

Criar um participante

ID da Operação:: CreateParticipant

Cria um novo participante para um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID de registro do sistema do evento.
ID do constituinte	constituent_id	True	string	O ID de constituinte do participante.
ID do anfitrião	host_id		string	O ID do registo de participante do anfitrião.
Estado de RSVP	rsvp_status		string	O status do envolvimento do participante com o evento.
Participou?	attended		boolean	O participante compareceu ao evento?
Estado do convite	invitation_status		string	O estado do convite ao participante.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Nível de participação	name	True	string	O nome do nível de participação.

Devoluções

Participante criado

Body: EventApi.CreatedParticipant

Criar um presente

ID da Operação:: CreateGift

Cria um novo presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado ao presente.
Montante	value	True	double	O valor monetário do presente.
Date	date	True	date	A data do presente (ex: '2020-09-18').
Tipo	type	True	string	O tipo de presente.
ID da campanha	campaign_id		string	O ID de registro do sistema da campanha associado à divisão do presente.
ID do fundo	fund_id	True	string	O ID de registro do sistema do fundo associado à divisão do presente.
ID do recurso	appeal_id		string	O ID de registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	O ID de registro do sistema do pacote associado à divisão do presente.
Montante	value	True	double	O valor monetário do presente dividido.
Método de pagamento	payment_method	True	string	O método de pagamento.
Número do cheque	check_number		string	O número do cheque (aplicável apenas quando o método de pagamento é "PersonalCheck").
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Reference	reference		string	A referência de pagamento (aplicável apenas quando o método de pagamento é "Outros").
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É anónimo?	is_anonymous		boolean	O presente é anónimo? Se nenhum valor for fornecido, será usado o anonimato padrão do doador.
Subtipo	subtype		string	O subtipo do presente.
Comment	reference		string	Notas para rastrear detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Utilizar créditos para angariação de fundos?	default_fundraiser_credits		boolean	Utilizar os créditos de angariação de fundos por defeito?
Usa créditos suaves?	default_soft_credits		boolean	Utilizar os créditos suaves por defeito?
Círculo eleitoral	constituency		string	O eleitorado da dádiva.
Prefixo do lote	batch_prefix		string	O prefixo a ser usado para presentes em lote. Tal deve incluir pelo menos uma letra e é obrigatório quando «Número do lote» tem um valor.
Número do lote	batch_number		string	O número do lote. Limite de caracteres: 50 (incluindo o prefixo do lote).
Estado da publicação	post_status		string	O status do post do presente.
Data de publicação	post_date		date	A data em que o presente foi publicado (ex: '2020-09-18').
Estado do recibo	status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	O valor monetário do recibo do presente.
Data do recibo	date		date	A data em que o presente foi recebido (ex: '2020-09-18').

Devoluções

Presente criado

Body: GiftApi.CreatedGift

Criar um registo de consentimento de constituinte

ID da Operação:: CreateConstituentConsent

Cria um novo registro de consentimento constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID do registo do sistema do constituinte associado ao registo de consentimento.
Channel	channel	True	string	O canal ao qual a resposta de consentimento se aplica.
Categoria	category		string	A categoria à qual a resposta de consentimento se aplica.
Fonte	source		string	A fonte da resposta de consentimento do constituinte.
Resposta	constituent_consent_response	True	string	Como o constituinte respondeu ao consentimento para o canal/categoria especificado.
Date	consent_date	True	date-time	A data em que a resposta de consentimento foi recebida (ex: '2020-09-18T04:13:56Z').
Declaração de consentimento	consent_statement		string	A declaração a que o constituinte respondeu ao dar o seu consentimento.
Aviso de privacidade	privacy_notice		string	A declaração de privacidade fornecida ao constituinte.

Devoluções

Consentimento constituinte criado

Body: CommPrefApi.CreatedConstituentConsent

Criar um telefone constituinte

ID da Operação:: CreateConstituentPhone

Cria um novo telefone constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado ao telefone.
Tipo	type	True	string	O tipo de telefone.
Número	number	True	string	O número de telefone.
Primária?	primary		boolean	Este é o telefone principal do eleitor?
Não liga?	do_not_call		boolean	O constituinte pode ser contactado através deste número?
Inativo?	inactive		boolean	Este número de telefone está inativo?

Devoluções

Telefone constituinte criado

Body: ConstituentApi.CreatedConstituentPhone

Criar uma atribuição de angariação de fundos

ID da Operação:: CreateFundraiserAssignment

Cria uma nova atribuição de angariação de fundos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da angariação de fundos	fundraiser_id	True	string	O ID de registo do sistema da angariação de fundos.
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do componente atribuído.
Tipo	type		string	O tipo de angariação de fundos.
Início da atribuição	start		date-time	A data de início da atribuição.
Fim da atribuição	end		date-time	A data final da atribuição.
Montante	value	True	double	O valor da meta para a angariação de fundos solicitar ao constituinte atribuído.
ID da Campanha	campaign_id		string	O ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados.
ID do Fundo	fund_id		string	O ID de registo do sistema do fundo ao qual os donativos resultantes serão aplicados.
ID do recurso	appeal_id		string	O sistema registra o ID do recurso ao qual os presentes resultantes serão aplicados.

Devoluções

Criação de atribuição de angariação de fundos

Body: FundraisingApi.CreatedFundraiserAssignment

Criar uma ação constituinte

ID da Operação:: CreateAction

Cria uma nova ação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado à ação.
Categoria	category	True	string	O canal ou intenção da interação constituinte.
Concluído?	completed		boolean	A ação está concluída? Se o sistema estiver configurado para usar status de ação personalizados, esse valor será baseado no valor de status da ação.
Concluído a	completed_date		date-time	A data em que a ação foi concluída (ex: '2020-09-18T04:13:56Z').
Date	date	True	date-time	A data da ação (ex: '2020-09-18T04:13:56Z').
Observação	description		string	A explicação detalhada que elabora o resumo da ação.
Direction	direction		string	A direção da ação.
Angariação(ões) de fundos	fundraisers		array of string	O conjunto de IDs de registro do sistema para os angariadores de fundos associados à ação.
Localização	location		string	O local da ação.
ID da oportunidade	opportunity_id		string	O ID de registro do sistema da oportunidade associada à ação.
Outcome	outcome		string	O resultado da ação.
Priority	priority		string	A prioridade da ação.
Hora de início	start_time		string	A hora de início da ação. Usa o tempo de 24 horas no formato HH:mm.
Hora de fim	end_time		string	A hora de fim da ação. Usa o tempo de 24 horas no formato HH:mm.
Situação	status		string	O status da ação.
Resumo	summary		string	A breve descrição da ação que aparece na parte superior do registro. Limite de caracteres: 255.
Tipo	type		string	Descrição adicional da ação para complementar a categoria.

Devoluções

Ação criada

Body: ConstituentApi.CreatedAction

Criar uma classificação de constituinte

ID da Operação:: CreateConstituentRating

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

Body: ConstituentApi.CreatedConstituentRating

Criar uma doação de participante

ID da Operação:: CreateParticipantDonation

Cria uma nova doação para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.
ID de presente	gift_id	True	string	O ID de registro systetm do presente ao qual a doação do participante está vinculada.

Devoluções

Criação de doação de participantes

Body: EventApi.CreatedParticipantDonation

Criar uma educação constituinte

ID da Operação:: CreateConstituentEducation

Cria uma nova educação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte associado à educação.
Escola	school	True	string	O nome da escola/estabelecimento.
Tipo	type		string	O tipo de educação.
Classe de	class_of		string	O ano em que o constituinte se formou.
Situação	status		string	O estatuto da educação.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Licenciatura	degree		string	O grau recebido.
GPA	gpa		double	A média de pontos da nota.
Objeto de estudo	subject_of_study		string	O objeto de estudo.
Primária?	primary		boolean	Esta é a associação de escolas primárias do constituinte?
Majors	majors		array of string	Os principais cursos de estudo.
Menores	minors		array of string	Os cursos menores de estudo.
Campus	campus		string	O campus. Limite de caracteres: 50.
Organização social	social_organization		string	A organização social. Limite de caracteres: 50.
Nome conhecido	known_name		string	O nome conhecido. Limite de caracteres: 50.
Classe de grau	class_of_degree		string	A classe de grau (aplicável apenas para versões do Reino Unido).
Departamento	department		string	O nome do departamento de educação (aplicável apenas para versões do Reino Unido).
Corpo Docente	faculty		string	O nome da faculdade (aplicável apenas para versões do Reino Unido).
Número de registo	registration_number		string	O número de registo (aplicável apenas às versões do Reino Unido). Limite de caracteres: 50.

Devoluções

Criou a educação constituinte

Body: ConstituentApi.CreatedConstituentEducation

Criar uma lista a partir de um conjunto de registos

ID da Operação:: CreateListFromIDs

Cria uma nova lista filtrada para o conjunto de registros especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome	name	True	string	O nome da lista. Limite de caracteres: 50.
Description	description	True	string	A descrição da lista.
Tipo de lista	list_type	True	string	Determina o tipo de lista a ser criada.
Permissions	list_permissions	True	string	Determina se outros usuários podem acessar a lista.
ID(s)	ids	True	array of string	Os identificadores únicos para os registos contidos na lista (máximo de 100 000 valores).

Devoluções

Lista criada

Body: ListApi.CreatedList

Criar uma nota constituinte

ID da Operação:: CreateConstituentNote

Cria uma nova nota constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte associado à nota.
Tipo	type	True	string	O tipo de nota.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Resumo	summary		string	O resumo da nota. Limite de caracteres: 50.
Observação	text		string	O texto da nota.

Devoluções

Nota constituinte criada

Body: ConstituentApi.CreatedConstituentNote

Criar uma oportunidade

ID da Operação:: CreateOpportunity

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

Body: OpportunityApi.CreatedOpportunity

Criar uma opção de participante

ID da Operação:: CreateParticipantOption

Cria uma nova opção de participante para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID do participante.
body	body	True	dynamic	Um objeto que representa a opção de participante a ser criada.

Devoluções

Opção de participante criada

Body: EventApi.CreatedParticipantOption

Criar uma opção de participante do evento

ID da Operação:: CreateEventParticipantOption

Cria uma nova opção de participante para um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID do evento.
Nome	name	True	string	O nome da opção de participante do evento.
Tipo de entrada	input_type	True	string	Os tipos de valores que os participantes podem usar para fornecer respostas.
Permitir seleção múltipla?	multi_select		boolean	Permitir mais de um valor para listas?
nome	name		string	O nome da opção de lista.
sequência	sequence		integer	A sequência baseada em 0 usada para ordenar.

Devoluções

Opção de participante do evento criado

Body: EventApi.CreatedEventParticipantOption

Criar uma presença online constituinte

ID da Operação:: CreateConstituentOnlinePresence

Cria uma nova presença online constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte associado à presença online.
Tipo	type	True	string	O tipo de presença online.
Link	address	True	string	O endereço Web da presença online.
Primária?	primary		boolean	Esta é a principal presença online do eleitor?
Inativo?	inactive		boolean	Esta presença online está inativa?

Devoluções

Presença online constituinte criada

Body: ConstituentApi.CreatedConstituentOnlinePresence

Criar uma relação de organização

ID da Operação:: CreateOrganizationRelationship

Cria uma nova relação de organização. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado à relação.
ID da relação	relation_id	True	string	O ID de registro do sistema da organização relacionada.
Tipo	type		string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type		string	Descreve a relação do constituinte com a organização relacionada.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É contacto?	is_organization_contact		boolean	O constituinte representa esta organização como um contacto?
Tipo de contacto	organization_contact_type		string	Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato.
Position	position		string	A posição do indivíduo na organização. Limite de caracteres: 50.
O negócio é principal?	is_primary_business		boolean	Este é o principal negócio do eleitor?
Observações	comment		string	Notas adicionais sobre a relação.

Devoluções

Relacionamento organizacional criado

Body: ConstituentApi.CreatedOrganizationRelationship

Criar uma relação individual

ID da Operação:: CreateIndividualRelationship

Cria uma nova relação individual. Se a relação for com outro constituinte, cria-se uma relação de reciprocidade para esse constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado à relação.
ID da relação	relation_id	True	string	O ID de registro do sistema do indivíduo relacionado.
Tipo	type		string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type		string	Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, numa relação entre um constituinte masculino e um irmão do sexo feminino, o tipo de relação recíproca seria irmão.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É cônjuge?	is_spouse		boolean	O parente é cônjuge do constituinte?
O constituinte é chefe de família?	is_constituent_head_of_household		boolean	O constituinte é o chefe do agregado familiar?
O cônjuge é chefe de família?	is_spouse_head_of_household		boolean	O cônjuge é o chefe de família?
Observações	comment		string	Notas adicionais sobre a relação.

Devoluções

Relacionamento individual criado

Body: ConstituentApi.CreatedIndividualRelationship

Criar uma taxa de evento

ID da Operação:: CreateEventFee

Cria uma nova taxa para um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID de registro do sistema do evento.
Nome	name	True	string	O nome da taxa.
Montante da taxa	cost	True	double	O montante de dinheiro associado à taxa.
Montante da contribuição	contribution_amount	True	double	O valor da taxa que é uma doação acima dos custos do evento.

Devoluções

Taxa de evento criada

Body: EventApi.CreatedEventFee

Criar uma taxa de participante

ID da Operação:: CreateParticipantFee

Cria uma nova taxa para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.
ID do Evento	event_id	True	string	A ID de registro do sistema do evento.
Taxa	event_fee_id	True	string	A taxa do evento.
Quantidade	quantity	True	integer	A quantidade comprada.
Montante da taxa	fee_amount	True	double	O montante de dinheiro associado à taxa.
Montante da contribuição	contribution_amount	True	double	O valor da taxa que é uma doação acima dos custos do evento. Este é o valor que normalmente aparece nos recibos.
day	d		integer	O dia na data difusa.
mês	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Devoluções

Taxa de participante criada

Body: EventApi.CreatedParticipantFee

Lista de angariadores de fundos constituintes

ID da Operação:: ListConstituentFundraiserAssignments

Lista as atribuições de angariação de fundos para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.
Incluir inativos?	include_inactive		boolean	Incluir tarefas inativas de angariação de fundos?

Devoluções

Trabalhos para angariação de fundos

Body: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Lista de constituintes

ID da Operação:: ListConstituents

Devolve uma lista de constituintes.

Parâmetros

Name	Chave	Tipo	Description
List	list_id	string	Define um identificador de lista usado para filtrar o conjunto de componentes para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
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.
Código constituinte	constituent_code	string	Representa um código constituinte para filtrar a lista. Por exemplo, "Membro do Conselho de Administração" devolve apenas os constituintes com um código de constituinte do Conselho de Administração.
ID do constituinte	constituent_id	string	Representa uma lista separada por vírgulas de identificadores constituintes para filtrar os resultados. Por exemplo, "280,1232" retorna apenas o constituinte 280 ou o constituinte 1232.
Categoria de campo personalizado	custom_field_category	string	Representa uma categoria de campo personalizada para filtrar os resultados. Por exemplo, "Aniversário" retorna apenas componentes com um campo personalizado de aniversário ativo.
Estatuto de angariador de fundos	fundraiser_status	string	Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo,Nenhum" retorna apenas constituintes cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para este filtro são Ativo, Inativo e Nenhum.
Incluir falecido?	include_deceased	boolean	Incluir constituintes falecidos na resposta?
Incluir inativos?	include_inactive	boolean	Incluir constituintes inativos na resposta?
Código postal	postal_code	string	Representa uma lista separada por vírgulas de códigos postais para filtrar os resultados. Por exemplo, "29466,29492" retorna apenas constituintes cujo endereço preferido tem um código postal que começa com 29466 ou 29492, como 29466, 29492 ou 29492-0727.
Adicionado em ou após	date_added	date-time	Filtre os resultados para constituintes criados na data especificada ou após essa data (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtrar os resultados para componentes modificados na data especificada ou após essa data (ex: «2020-09-18T04:13:56Z»).
Ordenado por	sort	string	Representa uma lista de campos pelos quais classificar os resultados. Os resultados estão em ordem crescente por padrão, e um sinal '-' indica ordem decrescente. Por exemplo, "date_added,-last" classifica os constituintes pelo campo "date_added" em ordem crescente e, em seguida, pelo "último" campo em ordem decrescente.

Devoluções

Constituintes

Body: ConstituentApi.ApiCollectionOfConstituentRead

Lista de códigos constituintes

ID da Operação:: ListConstituentCodes

Lista os códigos constituintes 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.

Devoluções

Códigos constituintes

Body: ConstituentApi.ApiCollectionOfConstituentCodeRead

Lista de notas constituintes

ID da Operação:: ListConstituentNotes

Lista as notas para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Observações

Body: ConstituentApi.ApiCollectionOfNoteRead

Listar anexos constituintes

ID da Operação:: ListConstituentAttachments

Lista os anexos 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.

Devoluções

Attachments

Body: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

Listar anexos de ação

ID da Operação:: ListActionAttachments

Lista os anexos de uma ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação.

Devoluções

Attachments

Body: ConstituentApi.ApiCollectionOfActionAttachmentRead

Listar anexos de campanha

ID da Operação:: ListCampaignAttachments

Lista os anexos de uma campanha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	campaign_id	True	string	O ID de registro do sistema da campanha.

Devoluções

Attachments

Body: FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Listar anexos de fundos

ID da Operação:: ListFundAttachments

Lista os anexos de um fundo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Fundo	fund_id	True	string	O ID de registo do sistema do fundo.

Devoluções

Attachments

Body: FundraisingApi.ApiCollectionOfFundAttachmentRead

Listar anexos de oportunidade

ID da Operação:: ListOpportunityAttachments

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

Body: OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Listar anexos de presentes

ID da Operação:: ListGiftAttachments

Lista os anexos de um presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de presente	gift_id	True	string	O ID de registro do sistema do presente.

Devoluções

Attachments

Body: GiftApi.ApiCollectionOfGiftAttachmentRead

Listar anexos de recurso

ID da Operação:: ListAppealAttachments

Lista os anexos para um recurso.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do recurso	appeal_id	True	string	O ID de registro do sistema do recurso.

Devoluções

Attachments

Body: FundraisingApi.ApiCollectionOfAppealAttachmentRead

Listar as formações dos constituintes

ID da Operação:: ListConstituentEducations

Lista os registros educacionais 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.

Devoluções

Formação Académica

Body: ConstituentApi.ApiCollectionOfEducationRead

Listar as taxas de participação

ID da Operação:: ListParticipantFees

Lista as taxas para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.
Limite	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Compensação	offset		integer	Representa o número de registros a serem ignorados. Para utilização com paginação. O padrão é 0.

Devoluções

Taxas

Body: EventApi.ApiCollectionOfParticipantFee

Listar atribuições de angariação de fundos

ID da Operação:: ListFundraiserAssignments

Liste as atribuições para uma angariação de fundos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da angariação de fundos	fundraiser_id	True	string	O ID de registo do sistema do angariador de fundos para o qual as atribuições devem ser devolvidas.
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.

Devoluções

Assignments

Body: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Listar ações

ID da Operação:: ListActions

Retorna uma lista de ações.

Parâmetros

Name	Chave	Tipo	Description
List	list_id	string	Define um identificador de lista usado para filtrar o conjunto de ações para aquelas incluídas na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
Estado calculado	computed_status	string	Representa um filtro para resultados com base no status da ação calculada. Os valores disponíveis são Open, Completed ou PastDue.
Situação	status_code	string	Representa um código de status de ação para filtrar os resultados (aplicável somente quando o sistema está configurado para usar códigos de status de ação). Por exemplo, "Pendente" retorna ações com um status de "Pendente".
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.
Adicionado em ou após	date_added	date-time	Filtre os resultados para ações criadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para ações modificadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').

Devoluções

Ações

Body: ConstituentApi.ApiCollectionOfActionRead

Listar ações constituintes

ID da Operação:: ListConstituentActions

Lista as ações para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Ações

Body: ConstituentApi.ApiCollectionOfActionRead

Listar campanhas

ID da Operação:: ListCampaigns

Retorna uma lista de campanhas.

Parâmetros

Name	Chave	Tipo	Description
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 campanhas inativas?
Adicionado em ou após	date_added	date-time	Filtre os resultados para campanhas criadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para campanhas modificadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').

Devoluções

Campaigns

Body: FundraisingApi.ApiCollectionOfCampaignRead

Listar campos personalizados constituintes

ID da Operação:: ListConstituentCustomFields

Lista os campos personalizados 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.

Devoluções

Campos personalizados

Body: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Listar campos personalizados da campanha

ID da Operação:: ListCampaignCustomFields

Lista os campos personalizados de uma campanha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	campaign_id	True	string	O ID de registro do sistema da campanha.

Devoluções

Campos personalizados

Body: FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

Listar campos personalizados de oportunidade

ID da Operação:: ListOpportunityCustomFields

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

Body: OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Listar campos personalizados de presentes

ID da Operação:: ListGiftCustomFields

Lista os campos personalizados de um presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de presente	gift_id	True	string	O ID de registro do sistema do presente.

Devoluções

Campos personalizados

Body: GiftApi.ApiCollectionOfGiftCustomFieldRead

Listar campos personalizados de recurso

ID da Operação:: ListAppealCustomFields

Lista os campos personalizados para um recurso.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do recurso	appeal_id	True	string	O ID de registro do sistema do recurso.

Devoluções

Campos personalizados

Body: FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Listar campos personalizados do fundo

ID da Operação:: ListFundCustomFields

Lista os campos personalizados de um fundo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Fundo	fund_id	True	string	O ID de registo do sistema do fundo.

Devoluções

Campos personalizados

Body: FundraisingApi.ApiCollectionOfFundCustomFieldRead

Listar classificações de constituintes

ID da Operação:: ListConstituentRatings

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

Body: ConstituentApi.ApiCollectionOfRatingRead

Listar códigos de solicitação de constituintes

ID da Operação:: ListConstituentSolicitCodes

Lista os códigos de solicitação para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Solicitar códigos

Body: CommPrefApi.ConstituentSolicitCodeReadCollection

Listar doações de participantes

ID da Operação:: ListParticipantDonations

Lista as doações para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.
Limite	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Compensação	offset		integer	Representa o número de registros a serem ignorados. Para utilização com paginação. O padrão é 0.

Devoluções

Doações

Body: EventApi.ApiCollectionOfParticipantDonation

Listar endereços de constituintes

ID da Operação:: ListConstituentAddresses

Lista os endereços 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 endereços inativos?

Devoluções

Addresses

Body: ConstituentApi.ApiCollectionOfAddressRead

Listar endereços de e-mail constituintes

ID da Operação:: ListConstituentEmailAddresses

Lista os endereços de e-mail 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 endereços de e-mail inativos?

Devoluções

Endereços de e-mail

Body: ConstituentApi.ApiCollectionOfEmailAddressRead

Listar eventos

ID da Operação:: ListEvents

Retorna uma lista de eventos.

Parâmetros

Name	Chave	Tipo	Description
Categoria	category	string	Filtrar com base na categoria do evento.
Data de início a partir de	start_date_from	date	Filtre os resultados para eventos com data de início na data especificada ou após essa data (ex: '2020-09-18').
Data de início para	start_date_to	date	Filtre os resultados para eventos com data de início na data especificada ou antes dela (ex: '2020-09-18').
Incluir inativos?	include_inactive	boolean	Incluir eventos inativos?
Limite	limit	integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Compensação	offset	integer	Representa o número de registros a serem ignorados. Para utilização com paginação.
ID do Evento	event_id	string	Filtre os eventos que correspondem à ID de registro do sistema especificada.
Nome	name	string	Filtre eventos que correspondam ao nome especificado.
Adicionado em ou após	date_added	date-time	Filtre os resultados para eventos criados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para eventos modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Events

Body: EventApi.ApiCollectionOfEventListEntry

Listar fundos

ID da Operação:: ListFunds

Devolve uma lista de fundos.

Parâmetros

Name	Chave	Tipo	Description
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 fundos inativos?
Adicionado em ou após	date_added	date-time	Filtre os resultados para fundos criados 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 fundos modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Fundos

Body: FundraisingApi.ApiCollectionOfFundRead

Listar lotes de presentes

ID da Operação:: ListGiftBatches

Liste os lotes de presente.

Parâmetros

Name	Chave	Tipo	Description
Número do lote	batch_number	string	Representa um filtro para resultados que correspondem ao número especificado.
Aprovado?	approved	boolean	Representa um filtro para o status do lote de presente.
Tem exceções?	has_exceptions	boolean	Representa um filtro para saber se o lote de presente contém exceções.
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.
Pesquisar texto	search_text	string	Representa um filtro para o texto incluído nos campos Descrição do lote ou Número do lote.
Criado por	created_by	string	Representa um filtro para lotes de presentes criados pelo usuário especificado.

Devoluções

Lotes de presentes

Body: GiftBatchApi.ApiCollectionOfGiftBatch

Listar oportunidades

ID da Operação:: ListOpportunities

Devolve uma lista de oportunidades.

Parâmetros

Name	Chave	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 identificadores constituintes 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

Body: OpportunityApi.ApiCollectionOfOpportunityRead

Listar opções de participantes

ID da Operação:: ListParticipantOptions

Lista as opções de participante para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.

Devoluções

Opções dos participantes

Body: EventApi.ApiCollectionOfParticipantOption

Listar opções de participantes do evento

ID da Operação:: ListEventParticipantOptions

Lista as opções de participantes para um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID do evento.

Devoluções

Opções dos participantes no evento

Body: EventApi.ApiCollectionOfEventParticipantOption

Listar pacotes

ID da Operação:: ListPackages

Retorna uma lista de pacotes.

Parâmetros

Name	Chave	Tipo	Description
ID do recurso	appeal_id	string	Representa uma lista separada por vírgulas de identificadores de recurso para filtrar os resultados. Por exemplo, "506.918" retorna apenas pacotes para recurso 506 ou recurso 918.
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 pacotes inativos?
Adicionado em ou após	date_added	date-time	Filtre os resultados para pacotes criados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para pacotes modificados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').

Devoluções

Packages

Body: FundraisingApi.ApiCollectionOfPackageRead

Listar pagamentos de taxas de participante

ID da Operação:: ListParticipantFeePayments

Lista os pagamentos de taxas para um participante.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.
Limite	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Compensação	offset		integer	Representa o número de registros a serem ignorados. Para utilização com paginação. O padrão é 0.

Devoluções

Pagamento de taxas

Body: EventApi.ApiCollectionOfParticipantFeePayment

Listar participantes do evento

ID da Operação:: ListEventParticipants

Lista os participantes de um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID de registro do sistema do evento.
Estado de RSVP	rsvp_status		string	Filtre os participantes com base no status de RSVP.
Estado do convite	invitation_status		string	Filtre os participantes com base no status do convite.
Nível de participação	participation_level		string	Filtre os participantes com base no nível de envolvimento.
Participou?	attended_filter		boolean	Filtro para incluir ou excluir participantes marcados como participantes.
Taxas pagas?	fees_paid_filter		boolean	Filtrar para incluir ou excluir participantes que pagaram suas taxas.
Limite	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Compensação	offset		integer	Representa o número de registros a serem ignorados. Para utilização com paginação.
É um constituinte?	is_constituent_filter		boolean	Filtro para incluir ou excluir participantes que são constituintes.
Tem um e-mail elegível?	email_eligible_filter		boolean	Filtrar para incluir ou excluir participantes com base no fato de eles terem um endereço de e-mail principal que não está marcado como Não enviar e-mail?
Tem um telefone elegível?	phone_call_eligible_filter		boolean	Filtre para incluir ou excluir participantes com base no fato de eles terem um número de telefone principal que não esteja marcado como Não ligar.
Nome	name		string	Filtro para participantes que correspondem ao nome especificado.
Adicionado em ou após	date_added		date-time	Filtre os resultados para participantes criados 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 participantes modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Participants

Body: EventApi.ApiCollectionOfParticipantListEntry

Listar presentes

ID da Operação:: ListGifts

Devolve uma lista de presentes.

Parâmetros

Name	Chave	Tipo	Description
List	list_id	string	Define um identificador de lista usado para filtrar o conjunto de presentes para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
Tipo	gift_type	string	Representa uma lista separada por vírgulas de tipos de presente para filtrar os resultados. Por exemplo, "MatchingGiftPledge,RecurringGift" retorna apenas presentes do tipo MatchingGiftPledge ou RecurringGift.
ID do constituinte	constituent_id	string	Representa uma lista separada por vírgulas de identificadores constituintes para filtrar os resultados. Por exemplo, "280,1232" devolve apenas presentes do constituinte 280 ou do constituinte 1232.
ID da Campanha	campaign_id	string	Representa uma lista separada por vírgulas de identificadores de campanha para filtrar os resultados. Por exemplo, "506.918" devolve apenas presentes para a campanha 506 ou campanha 918.
ID do Fundo	fund_id	string	Representa uma lista separada por vírgulas de identificadores de fundos para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para financiar 506 ou financiar 918.
ID do recurso	appeal_id	string	Representa uma lista separada por vírgulas de identificadores de recurso para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para apelar 506 ou apelar 918.
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.
Data de início do presente	start_gift_date	date-time	Representa um filtro para presentes com uma data de presente na ou após a data especificada (ex: '2020-09-18T04:13:56Z').
Data de fim do presente	end_gift_date	date-time	Representa um filtro para presentes com uma data de presente na ou antes da data especificada (ex: '2020-09-18T04:13:56Z').
Comece o valor do presente	start_gift_amount	double	Representa um filtro para presentes com um valor maior ou igual ao valor especificado.
Valor final do presente	end_gift_amount	double	Representa um filtro para presentes com um valor menor ou igual ao valor especificado.
Estado da publicação	post_status	string	Representa uma lista separada por vírgulas de status de postagem de presente para filtrar os resultados. Por exemplo, "DoNotPost,Posted" retorna apenas presentes marcados como DoNotPost ou Posted.
Estado do recibo	receipt_status	string	Representa uma lista separada por vírgulas de status de recibos de presente para filtrar os resultados. Por exemplo, "DoNotReceipt,Receipted" retorna apenas presentes marcados como DoNotReceipt ou Receiveded.
Estado de confirmação	acknowledgement_status	string	Representa uma lista separada por vírgulas de status de confirmação de presente para filtrar os resultados. Por exemplo, "DoNotAcknowledge,Acknowledged" retorna apenas presentes marcados como DoNotAcknowledge ou Acknowledged.
Adicionado em ou após	date_added	date-time	Filtre os resultados para presentes criados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para presentes modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Presentes

Body: GiftApi.ApiCollectionOfGiftRead

Listar presenças online constituintes

ID da Operação:: ListConstituentOnlinePresences

Lista as presenças online 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 presenças online inativas?

Devoluções

Presenças online

Body: ConstituentApi.ApiCollectionOfOnlinePresenceRead

Listar pseudónimos constituintes

ID da Operação:: ListConstituentAliases

Lista os aliases 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.

Devoluções

Aliases

Body: ConstituentApi.ApiCollectionOfAliasRead

Listar recursos

ID da Operação:: ListAppeals

Devolve uma lista de recursos.

Parâmetros

Name	Chave	Tipo	Description
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 recursos inativos?
Adicionado em ou após	date_added	date-time	Filtre os resultados para recursos criados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtrar os resultados para recursos modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z').

Devoluções

Recursos

Body: FundraisingApi.ApiCollectionOfAppealRead

Listar registros de consentimento dos constituintes

ID da Operação:: ListConstituentConsents

Lista os registros de consentimento 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.
Apenas mais recente?	most_recent_only		boolean	Incluir apenas os registros de consentimento mais recentes para cada combinação de categoria de canal na resposta?

Devoluções

Registos de consentimento

Body: CommPrefApi.ConstituentConsentReadCollection

Listar relações constituintes

ID da Operação:: ListConstituentRelationships

Lista as relaçõ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.
Limite	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. Não há um máximo.
Compensação	offset		integer	Representa o número de registros a serem ignorados. Para utilização com paginação.

Devoluções

Relações

Body: ConstituentApi.ApiCollectionOfRelationshipRead

Listar taxas de eventos

ID da Operação:: ListEventFees

Lista as taxas para um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	A ID de registro do sistema do evento.

Devoluções

Taxas

Body: EventApi.ApiCollectionOfEventFee

Listar telefones constituintes

ID da Operação:: ListConstituentPhones

Lista os telefones 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 telefones inativos?

Devoluções

Telefones

Body: ConstituentApi.ApiCollectionOfPhoneRead

Obtenha a doação vitalícia do constituinte

ID da Operação:: GetConstituentLifetimeGiving

Devolve o tempo de vida dando resumo para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Doação vitalícia

Body: ConstituentApi.LifetimeGivingRead

Obtenha o último presente do constituinte

ID da Operação:: GetConstituentLatestGift

Devolve o presente mais recente para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Apresentação de um resumo

Body: ConstituentApi.GivingSummaryRead

Obtenha um pacote

ID da Operação:: GetPackage

Retorna informações sobre um pacote.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do pacote	package_id	True	string	O ID de registro do sistema do pacote a ser obtido.

Devoluções

Package

Body: FundraisingApi.PackageRead

Obter o estatuto de potencial eleitor

ID da Operação:: GetConstituentProspectStatus

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

Body: ConstituentApi.ProspectStatusRead

Obter um constituinte

ID da Operação:: GetConstituent

Devolve informações sobre um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte a ser obtido.

Devoluções

Constituinte

Body: ConstituentApi.ConstituentRead

Obter um fundo

ID da Operação:: GetFund

Devolve informações sobre um fundo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Fundo	fund_id	True	string	O ID de registro do sistema do fundo a ser obtido.

Devoluções

Fundo

Body: FundraisingApi.FundRead

Obter um participante

ID da Operação:: GetParticipant

Retorna informações sobre um participante específico do evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Participante	participant_id	True	string	O ID de registo do sistema do participante.

Devoluções

Participante

Body: EventApi.Participant

Obter uma ação constituinte

ID da Operação:: GetAction

Retorna informações sobre uma ação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação a ser obtida.

Devoluções

Ação

Body: ConstituentApi.ActionRead

Obter uma foto de perfil do constituinte

ID da Operação:: GetConstituentProfilePicture

Retorna a foto de perfil atual 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 para o qual a foto de perfil deve ser recuperada.

Devoluções

Imagem do perfil

Body: ConstituentApi.ProfilePictureRead

Procurar um constituinte

ID da Operação:: SearchConstituent

Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Suporta nome, sobrenome, nome preferencial, nome anterior, alias, endereço de e-mail, número de telefone, endereço ou ID de pesquisa. Combinações de nomes, como nome e sobrenome ou nome e sobrenome preferidos, são válidas, mas, caso contrário, a pesquisa suporta apenas um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras grafias alternativas. Esta pesquisa não suporta caracteres curinga como * ou ?. Os resultados da pesquisa estão limitados a 500 registos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Pesquisar texto	search_text	True	string	O texto da pesquisa. Suporta nome, sobrenome, nome preferencial, nome anterior, alias, endereço de e-mail, número de telefone, endereço ou ID de pesquisa. Combinações de nomes, como nome e sobrenome ou nome e sobrenome preferidos, são válidas, mas, caso contrário, a pesquisa suporta apenas um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras grafias alternativas. Esta pesquisa não suporta caracteres curinga como * ou ?. Os resultados da pesquisa estão limitados a 500 registos.
Estatutos de angariação de fundos	fundraiser_status		string	Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo,Nenhum" retorna apenas constituintes cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para este filtro são Ativo, Inativo e Nenhum.
Incluir inativos?	include_inactive		boolean	Incluir constituintes inativos na resposta?
Campo de pesquisa	search_field		string	Representa um campo para pesquisar. Atualmente, ele só suporta lookup_id. Se for fornecido com search_text, um constituinte com lookup_id que corresponda ao search_text será devolvido.
Usa uma pesquisa rigorosa?	strict_search		boolean	Excluir constituintes cujos nomes soam como o texto de pesquisa, mas são escritos de forma diferente?
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.

Devoluções

Resultados da pesquisa

Body: ConstituentApi.ApiCollectionOfSearchResultRead

Receba o maior presente do constituinte

ID da Operação:: GetConstituentGreatestGift

Devolve o maior presente para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Apresentação de um resumo

Body: ConstituentApi.GivingSummaryRead

Receba o primeiro presente do constituinte

ID da Operação:: GetConstituentFirstGift

Devolve o primeiro presente para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Apresentação de um resumo

Body: ConstituentApi.GivingSummaryRead

Receba um evento

ID da Operação:: GetEvent

Retorna informações sobre um evento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Evento	event_id	True	string	O ID de registro do sistema do evento a ser obtido.

Devoluções

Event

Body: EventApi.Event

Receba um presente

ID da Operação:: GetGift

Retorna informações sobre um presente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de presente	gift_id	True	string	O ID de registro do sistema do presente a receber.

Devoluções

Presente

Body: GiftApi.GiftRead

Receba um recurso

ID da Operação:: GetAppeal

Retorna informações sobre um recurso.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do recurso	appeal_id	True	string	O ID de registro do sistema do recurso a ser obtido.

Devoluções

Appeal

Body: FundraisingApi.AppealRead

Receba uma campanha

ID da Operação:: GetCampaign

Retorna informações sobre uma campanha.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Campanha	campaign_id	True	string	O ID de registro do sistema da campanha a ser obtida.

Devoluções

Campanha

Body: FundraisingApi.CampaignRead

Receba uma oportunidade

ID da Operação:: GetOpportunity

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

Body: OpportunityApi.OpportunityRead

Suprimir um código constituinte

ID da Operação:: DeleteConstituentCode

Elimina um código constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do código constituinte	constituent_code_id	True	string	O ID de registo do sistema do código constituinte a eliminar.

Definições

CommPrefApi.ConstituentConsentRead

Representa uma entidade de consentimento para um constituinte.

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do registro de consentimento.
Channel	channel	string	O canal ao qual a resposta de consentimento se aplica.
Categoria	category	string	A categoria à qual a resposta de consentimento se aplica.
Fonte	source	string	A fonte da resposta de consentimento do constituinte.
Resposta	constituent_consent_response	string	Como o constituinte respondeu ao consentimento para o canal/categoria especificado.
Date	consent_date	date-time	A data em que a resposta de consentimento foi recebida.
Declaração de consentimento	consent_statement	string	A declaração a que o constituinte respondeu ao dar o seu consentimento.
Aviso de privacidade	privacy_notice	string	A declaração de privacidade fornecida ao constituinte.
Data de adição	date_added	date-time	A data em que a resposta de consentimento foi adicionada.
Adicionado(a) por	user_name	string	O usuário que adicionou a resposta de consentimento.

CommPrefApi.ConstituentConsentReadCollection

Registos de consentimento

Name	Caminho	Tipo	Description
Contar	count	integer	O número de registros de consentimento na lista.
valor	value	array of CommPrefApi.ConstituentConsentRead	O conjunto de registros de consentimento incluídos na resposta.

CommPrefApi.ConstituentSolicitCodeRead

Solicitar código

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do código de solicitação constituinte.
Solicitar código	solicit_code	string	Instruções de comunicação e/ou restrições para um componente.
Data de início	start_date	date	A data de início do código de solicitação (ex: '2005-09-18').
Data de fim	end_date	date	A data final do código de solicitação (ex: '2005-09-18').

CommPrefApi.ConstituentSolicitCodeReadCollection

Solicitar códigos

Name	Caminho	Tipo	Description
Contar	count	integer	O número de códigos de solicitação constituintes na lista.
valor	value	array of CommPrefApi.ConstituentSolicitCodeRead	O conjunto de códigos de solicitação constituintes incluídos na resposta.

CommPrefApi.CreatedConstituentConsent

Consentimento constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do registro de consentimento recém-criado.

CommPrefApi.CreatedConstituentSolicitCode

Código de solicitação constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do código de solicitação do constituinte recém-criado.

ConstituentApi.ActionAttachmentRead

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID da ação	parent_id	string	O ID de registro do sistema da ação 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.

ConstituentApi.ActionCustomFieldRead

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID da ação	parent_id	string	A ID de registro do sistema da ação 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.
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.

ConstituentApi.ActionRead

Ação

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da ação.
ID do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado à ação.
Categoria	category	string	O canal ou intenção da interação constituinte.
Concluído?	completed	boolean	A ação está concluída? Se o sistema estiver configurado para usar status de ação personalizados, esse valor será baseado no valor de status da ação.
Concluído a	completed_date	date-time	A data em que a ação foi concluída.
Date	date	date-time	A data da ação.
Observação	description	string	A explicação detalhada que elabora o resumo da ação.
Direction	direction	string	A direção da ação.
Angariação(ões) de fundos	fundraisers	array of string	O conjunto de IDs de registro do sistema para os angariadores de fundos associados à ação.
Localização	location	string	O local da ação.
ID da oportunidade	opportunity_id	string	O ID de registro do sistema da oportunidade associada à ação.
Outcome	outcome	string	O resultado da ação.
Priority	priority	string	A prioridade da ação.
Hora de início	start_time	string	A hora de início da ação. Usa o tempo de 24 horas no formato HH:mm.
Hora de fim	end_time	string	A hora de fim da ação. Usa o tempo de 24 horas no formato HH:mm.
Situação	status	string	O status da ação.
Código de estado	status_code	string	O código de status da ação. Essa propriedade só é retornada quando o sistema está configurado para usar status de ação personalizada.
Estado calculado	computed_status	string	O status da ação calculada. Se o sistema não estiver configurado para usar status de ação personalizados, esse campo calculará o status com base nas propriedades completed e date. Caso contrário, o campo calcula o status com base na propriedade date da ação e se a propriedade Action Status da ação está configurada como concluída.
Resumo	summary	string	A breve descrição da ação que aparece na parte superior do registro. Limite de caracteres: 255.
Tipo	type	string	Descrição adicional da ação para complementar a categoria.
Data de adição	date_added	date-time	A data em que a ação foi criada.
Data de modificação	date_modified	date-time	A data em que a ação foi modificada pela última vez.

ConstituentApi.AddressRead

Address

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do endereço.
Tipo	type	string	O tipo de endereço.
Country	country	string	O país do endereço (pode ser o ID, nome ou abreviatura).
Linhas de endereço	address_lines	string	As linhas de endereço.
City	city	string	A cidade do endereço (não use em combinação com o campo Subúrbio).
Estado	state	string	O estado do endereço.
Código postal	postal_code	string	O código postal do endereço.
Subúrbio	suburb	string	O subúrbio do endereço (não use em combinação com o campo Cidade).
Concelho	county	string	O município do endereço.
Endereço formatado	formatted_address	string	O endereço formatado no formato configurado do país.
Fonte de informação	information_source	string	A fonte de informação para o endereço.
Região	region	string	A região do endereço.
CARRINHO	cart	string	A rota da transportadora (CART) para o endereço.
LOTE	lot	string	A linha de viagem (LOT) para o endereço.
CPD	dpc	string	O código do ponto de entrega (DPC) para o endereço.
Válido a partir de	start	date-time	A data em que o constituinte passou a residir neste endereço.
Válido para	end	date-time	A data em que o constituinte deixou de residir neste endereço.
Primária?	preferred	boolean	É este o endereço preferido do eleitor?
Inativo?	inactive	boolean	O endereço está inativo (ou seja, a data atual é anterior a qualquer data de término)?
Não envia?	do_not_mail	boolean	O constituinte pode ser contactado neste endereço?
day	seasonal_start.d	integer	O dia na data difusa.
mês	seasonal_start.m	integer	O mês na data difusa.
ano	seasonal_start.y	integer	O ano na data difusa.
day	seasonal_end.d	integer	O dia na data difusa.
mês	seasonal_end.m	integer	O mês na data difusa.
ano	seasonal_end.y	integer	O ano na data difusa.
Data de adição	date_added	date-time	A data em que o endereço foi criado.
Data de modificação	date_modified	date-time	A data em que o endereço foi modificado pela última vez.

ConstituentApi.AliasRead

Alias

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do alias.
Alias	name	string	O nome a utilizar como pseudónimo do constituinte.
Tipo	type	string	O tipo de alias.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

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.AddressRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfActionAttachmentRead

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 ConstituentApi.ActionAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

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 ConstituentApi.ActionCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfActionRead

Açõ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.ActionRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfAliasRead

Aliases

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.AliasRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

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 ConstituentApi.ConstituentAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Códigos constituintes

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.ConstituentCodeRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

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 ConstituentApi.ConstituentCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfConstituentRead

Constituintes

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.ConstituentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfEducationRead

Formação Académica

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.EducationRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfEmailAddressRead

Endereços de e-mail

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.EmailAddressRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Trabalhos para angariação de fundos

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.FundraiserAssignmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfNoteRead

Observaçõ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.NoteRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Presenças online

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.OnlinePresenceRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfPhoneRead

Telefones

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.PhoneRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

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

Relaçõ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.RelationshipRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfSearchResultRead

Resultados da pesquisa

Name	Caminho	Tipo	Description
Contar	count	integer	O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. 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.SearchResultRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.AppealRead

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do recurso.
descrição	description	string	A descrição do recurso.

ConstituentApi.CampaignRead

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da campanha.
descrição	description	string	A descrição da campanha.

ConstituentApi.ConstituentAttachmentRead

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID do constituinte	parent_id	string	O ID de registo do sistema do constituinte associado 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.

ConstituentApi.ConstituentCodeRead

Código constituinte

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do código constituinte.
ID do constituinte	constituent_id	string	O ID de registo do sistema do constituinte associado ao código do constituinte.
Código constituinte	description	string	O código constituinte.
day	start.d	integer	O dia na data difusa.
mês	start.m	integer	O mês na data difusa.
ano	start.y	integer	O ano na data difusa.
day	end.d	integer	O dia na data difusa.
mês	end.m	integer	O mês na data difusa.
ano	end.y	integer	O ano na data difusa.
Inativo?	inactive	boolean	O código constituinte está inativo?
Sequence	sequence	integer	A sequência numérica associada ao código constituinte.
Data de adição	date_added	date-time	A data em que o código constituinte foi criado.
Data de modificação	date_modified	date-time	A data em que o código constituinte foi modificado pela última vez.

ConstituentApi.ConstituentCustomFieldRead

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID do constituinte	parent_id	string	O ID de registro do sistema do componente associado 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.
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.

ConstituentApi.ConstituentRead

Constituinte

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema para o constituinte. Isso não é o mesmo que o identificador de constituinte definido pelo usuário, que é armazenado no lookup_id.
Tipo	type	string	O tipo de constituinte.
Title	title	string	O título principal do constituinte (apenas para pessoas singulares).
Nome próprio	first	string	Nome próprio do constituinte (apenas para pessoas singulares).
Apelido	last	string	Apelido do eleitor (apenas para pessoas singulares).
Nome	name	string	Para indivíduos, este campo é o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. Para as organizações, este é o nome da organização.
Nome preferido	preferred_name	string	O nome preferido do constituinte (apenas para pessoas singulares).
Sufixo	suffix	string	Sufixo primário do constituinte (apenas para indivíduos).
ID de pesquisa	lookup_id	string	O identificador definido pelo utilizador para o constituinte.
ID	email.id	string	O ID de registro do sistema do endereço de e-mail.
tipo	email.type	string	O tipo de endereço de e-mail.
address	email.address	string	O endereço de e-mail.
não enviar e-mail?	email.do_not_email	boolean	O constituinte pode ser contactado através deste endereço de correio eletrónico?
inativo?	email.inactive	boolean	Este endereço de e-mail está inativo?
data adicionada	email.date_added	date-time	A data em que o endereço de e-mail foi criado.
Data de modificação	email.date_modified	date-time	A data em que o endereço de e-mail foi modificado pela última vez.
ID	phone.id	string	O ID de registro do sistema do telefone.
tipo	phone.type	string	O tipo de telefone.
número	phone.number	string	O número de telefone.
não liga?	phone.do_not_call	boolean	O constituinte pode ser contactado através deste número?
inativo?	phone.inactive	boolean	Este número de telefone está inativo?
data adicionada	phone.date_added	date-time	A data em que o telefone foi criado.
Data de modificação	phone.date_modified	date-time	A data em que o telefone foi modificado pela última vez.
ID	online_presence.id	string	O ID de registo do sistema da presença online.
tipo	online_presence.type	string	O tipo de presença online.
ligação	online_presence.address	string	O endereço Web da presença online.
inativo?	online_presence.inactive	boolean	Esta presença online está inativa?
data adicionada	online_presence.date_added	date-time	A data em que a presença online foi criada.
Data de modificação	online_presence.date_modified	date-time	A data em que a presença online foi modificada pela última vez.
ID	address.id	string	O ID de registro do sistema do endereço.
tipo	address.type	string	O tipo de endereço.
country	address.country	string	O país do endereço (pode ser o ID, nome ou abreviatura).
linhas	address.address_lines	string	As linhas de endereço.
city	address.city	string	A cidade do endereço (não use em combinação com o campo Subúrbio).
state	address.state	string	O estado do endereço.
código postal	address.postal_code	string	O código postal do endereço.
subúrbio	address.suburb	string	O subúrbio do endereço (não use em combinação com o campo Cidade).
concelho	address.county	string	O município do endereço.
formatado	address.formatted_address	string	O endereço formatado no formato configurado do país.
válido a partir de	address.start	date-time	A data em que o constituinte passou a residir neste endereço.
válido para	address.end	date-time	A data em que o constituinte deixou de residir neste endereço.
inativo?	address.inactive	boolean	O endereço está inativo (ou seja, a data atual é anterior a qualquer data de término)?
não envia?	address.do_not_mail	boolean	O constituinte pode ser contactado neste endereço?
day	address.seasonal_start.d	integer	O dia na data difusa.
mês	address.seasonal_start.m	integer	O mês na data difusa.
ano	address.seasonal_start.y	integer	O ano na data difusa.
day	address.seasonal_end.d	integer	O dia na data difusa.
mês	address.seasonal_end.m	integer	O mês na data difusa.
ano	address.seasonal_end.y	integer	O ano na data difusa.
data adicionada	address.date_added	date-time	A data em que o endereço foi criado.
Data de modificação	address.date_modified	date-time	A data em que o endereço foi modificado pela última vez.
Sexo	gender	string	O sexo do constituinte (apenas para indivíduos).
Nome do meio	middle	string	Nome do meio do constituinte (apenas para pessoas singulares).
Antigo nome	former_name	string	O nome anterior do constituinte (apenas para pessoas singulares).
Título 2	title_2	string	O título secundário do constituinte (apenas para pessoas singulares).
Sufixo 2	suffix_2	string	Sufixo secundário do constituinte (apenas para indivíduos).
Estado conjugal	marital_status	string	O estado civil do constituinte (apenas para pessoas singulares).
Dá anonimamente?	gives_anonymously	boolean	O constituinte doa anonimamente?
Inativo?	inactive	boolean	O constituinte está inativo?
day	birthdate.d	integer	O dia na data difusa.
mês	birthdate.m	integer	O mês na data difusa.
ano	birthdate.y	integer	O ano na data difusa.
Local de nascimento	birthplace	string	O local de nascimento do constituinte (apenas para indivíduos).
Etnicidade	ethnicity	string	A etnia do constituinte (apenas para indivíduos).
Rendimentos	income	string	O rendimento do constituinte (apenas para pessoas singulares).
Religião	religion	string	A religião do constituinte (apenas para indivíduos).
Indústria	industry	string	A indústria do constituinte (apenas para organizações).
Número de empregados	num_employees	integer	O número de funcionários na organização.
Combina presentes?	matches_gifts	boolean	A organização combina presentes?
Fator de presente correspondente	matching_gift_factor	double	O fator de presente correspondente (apenas para organizações).
Min match por presente	matching_gift_per_gift_min.value	double	O valor mínimo correspondente por presente para o constituinte (apenas para organizações).
Máximo de correspondência por presente	matching_gift_per_gift_max.value	double	O valor máximo correspondente por presente para o constituinte (apenas para organizações).
Min match por constit	matching_gift_total_min.value	double	O total mínimo correspondente para o constituinte (apenas para organizações).
Correspondência máxima por constit	matching_gift_total_max.value	double	O total máximo correspondente para o constituinte (apenas para organizações).
Notas de presente correspondentes	matching_gift_notes	string	As notas de presente correspondentes para o constituinte (apenas para organizações).
Idade	age	integer	A idade do constituinte, calculada com base na propriedade da data de nascimento (apenas para indivíduos).
Falecido?	deceased	boolean	O constituinte faleceu (apenas para pessoas singulares)?
day	deceased_date.d	integer	O dia na data difusa.
mês	deceased_date.m	integer	O mês na data difusa.
ano	deceased_date.y	integer	O ano na data difusa.
Estatuto de angariador de fundos	fundraiser_status	string	Indica se o constituinte é um angariador de fundos (apenas para pessoas singulares).
ID	spouse.id	string	O ID de registo do sistema do cônjuge.
Nome próprio	spouse.first	string	Nome próprio do cônjuge.
Apelido	spouse.last	string	Apelido do cônjuge.
é chefe de família?	spouse.is_head_of_household	boolean	O cônjuge é o chefe de família?
Data de adição	date_added	date-time	A data em que o constituinte foi criado.
Data de modificação	date_modified	date-time	A data em que o constituinte foi modificado pela última vez.

ConstituentApi.CreatedAction

Ação criada

Name	Caminho	Tipo	Description
ID	id	string	A ID da ação recém-criada.

ConstituentApi.CreatedActionAttachment

Anexo de ação criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do anexo de ação recém-criado.

ConstituentApi.CreatedActionCustomField

Campo personalizado de ação criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado de ação recém-criado.

ConstituentApi.CreatedConstituentAddress

Endereço constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do endereço do constituinte recém-criado.

ConstituentApi.CreatedConstituentAlias

Alias constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do alias constituinte recém-criado.

ConstituentApi.CreatedConstituentAttachment

Anexação constituinte criada

Name	Caminho	Tipo	Description
ID	id	string	A ID do anexo constituinte recém-criado.

ConstituentApi.CreatedConstituentCode

Código constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do código constituinte recém-criado.

ConstituentApi.CreatedConstituentCustomField

Campo personalizado constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado constituinte recém-criado.

ConstituentApi.CreatedConstituentEducation

Criou a educação constituinte

Name	Caminho	Tipo	Description
ID	id	string	O ID da educação constituinte recém-criada.

ConstituentApi.CreatedConstituentEmailAddress

Endereço de e-mail constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do endereço de e-mail do constituinte recém-criado.

ConstituentApi.CreatedConstituentNote

Nota constituinte criada

Name	Caminho	Tipo	Description
ID	id	string	O ID da nota constituinte recém-criada.

ConstituentApi.CreatedConstituentOnlinePresence

Presença online constituinte criada

Name	Caminho	Tipo	Description
ID	id	string	O ID da presença online do constituinte recém-criado.

ConstituentApi.CreatedConstituentPhone

Telefone constituinte criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do telefone constituinte recém-criado.

ConstituentApi.CreatedConstituentRating

Classificação constituinte criada

Name	Caminho	Tipo	Description
ID	id	string	O ID da classificação constituinte recém-criada.

ConstituentApi.CreatedIndividualConstituent

Constituinte individual criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do constituinte individual recém-criado.

ConstituentApi.CreatedIndividualRelationship

Relacionamento individual criado

Name	Caminho	Tipo	Description
ID	id	string	A ID da relação individual recém-criada.

ConstituentApi.CreatedOrganizationConstituent

Constituinte da organização criada

Name	Caminho	Tipo	Description
ID	id	string	A ID do constituinte da organização recém-criado.

ConstituentApi.CreatedOrganizationRelationship

Relacionamento organizacional criado

Name	Caminho	Tipo	Description
ID	id	string	A ID da relação de organização recém-criada.

ConstituentApi.EducationRead

Education

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da educação.
ID do constituinte	constituent_id	string	O ID de registo do sistema do constituinte associado à educação.
Escola	school	string	O nome da escola/estabelecimento.
Tipo	type	string	O tipo de educação.
Classe de	class_of	string	O ano em que o constituinte se formou.
Situação	status	string	O estatuto da educação.
day	date_entered.d	integer	O dia na data difusa.
mês	date_entered.m	integer	O mês na data difusa.
ano	date_entered.y	integer	O ano na data difusa.
day	date_left.d	integer	O dia na data difusa.
mês	date_left.m	integer	O mês na data difusa.
ano	date_left.y	integer	O ano na data difusa.
day	date_graduated.d	integer	O dia na data difusa.
mês	date_graduated.m	integer	O mês na data difusa.
ano	date_graduated.y	integer	O ano na data difusa.
Licenciatura	degree	string	O grau recebido.
GPA	gpa	double	A média de pontos da nota.
Majors	majors	array of string	Os principais cursos de estudo.
Menores	minors	array of string	Os cursos menores de estudo.
O ensino primário?	primary	boolean	Esta é a associação de escolas primárias do constituinte?
Campus	campus	string	O campus.
Organização social	social_organization	string	A organização social.
Nome conhecido	known_name	string	O nome conhecido.
Classe de grau	class_of_degree	string	A classe de grau.
Departamento	department	string	O nome do departamento de educação.
Corpo Docente	faculty	string	O nome da faculdade.
Número de registo	registration_number	string	O número de registo.
Objeto de estudo	subject_of_study	string	O objeto de estudo.
Data de adição	date_added	date-time	A data em que a educação foi criada.
Data de modificação	date_modified	date-time	A data em que a educação foi modificada pela última vez.

ConstituentApi.EmailAddressRead

Endereço de e-mail

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do endereço de e-mail.
ID do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado ao endereço de e-mail.
Tipo de e-mail	type	string	O tipo de endereço de e-mail.
Endereço de e-mail	address	string	O endereço de e-mail.
Primária?	primary	boolean	Este é o endereço de e-mail principal do eleitor?
Não envia e-mail?	do_not_email	boolean	O constituinte pode ser contactado através deste endereço de correio eletrónico?
Inativo?	inactive	boolean	Este endereço de e-mail está inativo?
Data de adição	date_added	date-time	A data em que o endereço de e-mail foi criado.
Data de modificação	date_modified	date-time	A data em que o endereço de e-mail foi modificado pela última vez.

ConstituentApi.FileDefinition

Definição do ficheiro

Name	Caminho	Tipo	Description
ID do ficheiro	file_id	string	O identificador do arquivo.
URL	file_upload_request.url	string	O URL a ser usado para a solicitação de upload.
método	file_upload_request.method	string	O método HTTP a ser usado com a solicitação de upload.
headers	file_upload_request.headers	array of ConstituentApi.Header	Os cabeçalhos a serem fornecidos ao fazer a solicitação.
ID da miniatura	thumbnail_id	string	O identificador da miniatura.
URL	thumbnail_upload_request.url	string	O URL a ser usado para a solicitação de upload.
método	thumbnail_upload_request.method	string	O método HTTP a ser usado com a solicitação de upload.
headers	thumbnail_upload_request.headers	array of ConstituentApi.Header	Os cabeçalhos a serem fornecidos ao fazer a solicitação.

ConstituentApi.FundraiserAssignmentLer

Atribuição de angariação de fundos

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema da atribuição de angariação de fundos.
ID do constituinte	constituent_id	string	O ID de registo do sistema do constituinte atribuído à angariação de fundos.
ID da angariação de fundos	fundraiser_id	string	O ID de registo do sistema da angariação de fundos.
Tipo	type	string	O tipo de angariação de fundos.
valor	amount.value	double	O valor monetário.
ID da Campanha	campaign_id	string	O ID de registro do sistema da campanha para aplicar os presentes resultantes.
ID do Fundo	fund_id	string	O ID de registo do sistema do fundo a que todos os donativos resultantes devem ser aplicados. Se um fundo restrito for selecionado, apenas as campanhas e recursos associados a esse fundo poderão ser selecionados.
ID do recurso	appeal_id	string	O ID de registo do sistema do recurso que o angariador de fundos deve utilizar para solicitar presentes.
Data de início	start	date-time	Data de início da atribuição da angariação de fundos.
Data de fim	end	date-time	Data de término da atribuição da angariação de fundos.

ConstituentApi.FundRead

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do fundo.
descrição	description	string	A descrição do fundo.

ConstituentApi.GivingSummaryRead

Apresentação de um resumo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do presente.
Tipo	type	string	O tipo de presente.
Date	date	date-time	A data do presente.
valor	amount.value	double	O valor monetário.
Appeal	appeals	array of ConstituentApi.AppealRead	O conjunto de apelos associados à dádiva.
Campanha	campaigns	array of ConstituentApi.CampaignRead	O conjunto de campanhas associadas ao presente.
Fundo	funds	array of ConstituentApi.FundRead	O conjunto de fundos associados à doação.

Cabeçalho da solicitação usado para carregar o anexo físico.

Name	Caminho	Tipo	Description
nome	name	string	O nome do cabeçalho.
valor	value	string	O valor para o cabeçalho.

ConstituentApi.LifetimeGivingRead

Doação vitalícia

Name	Caminho	Tipo	Description
Anos consecutivos administrados	consecutive_years_given	integer	O número de anos consecutivos que o constituinte deu.
Total de anos administrados	total_years_given	integer	O número total de anos que o constituinte deu.
valor	total_giving.value	double	O valor monetário.
valor	total_pledge_balance.value	double	O valor monetário.
valor	total_received_giving.value	double	O valor monetário.
valor	total_committed_matching_gifts.value	double	O valor monetário.
valor	total_received_matching_gifts.value	double	O valor monetário.
valor	total_soft_credits.value	double	O valor monetário.

ConstituentApi.NoteRead

Observação

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da nota.
ID do constituinte	constituent_id	string	O ID de registo do sistema do constituinte associado à nota.
Tipo	type	string	O tipo de nota.
day	date.d	integer	O dia na data difusa.
mês	date.m	integer	O mês na data difusa.
ano	date.y	integer	O ano na data difusa.
Resumo	summary	string	O resumo da nota.
Observação	text	string	O texto da nota.
Data de adição	date_added	date-time	A data em que a nota foi criada.
Data de modificação	date_modified	date-time	A data em que a nota foi modificada pela última vez.

ConstituentApi.OnlinePresenceRead

Presença online

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema da presença online.
ID do constituinte	constituent_id	string	O ID de registo do sistema do constituinte associado à presença online.
Tipo	type	string	O tipo de presença online.
Link	address	string	O endereço Web da presença online.
Primária?	primary	boolean	Esta é a principal presença online do eleitor?
Inativo?	inactive	boolean	Esta presença online está inativa?
Data de adição	date_added	date-time	A data em que a presença online foi criada.
Data de modificação	date_modified	date-time	A data em que a presença online foi modificada pela última vez.

ConstituentApi.PhoneRead

Telemóvel

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do telefone.
ID do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado ao telefone.
Tipo	type	string	O tipo de telefone.
Número	number	string	O número de telefone.
Primária?	primary	boolean	Este é o telefone principal do eleitor?
Não liga?	do_not_call	boolean	O constituinte pode ser contactado através deste número?
Inativo?	inactive	boolean	Este número de telefone está inativo?
Data de adição	date_added	date-time	A data em que o telefone foi criado.
Data de modificação	date_modified	date-time	A data em que o telefone foi modificado pela última vez.

ConstituentApi.ProfilePictureRead

Imagem do perfil

Name	Caminho	Tipo	Description
ID do constituinte	constituent_id	string	O ID de registo do sistema do constituinte associado à foto de perfil.
URL	url	string	O URL da foto de perfil. O URL contém uma assinatura com limite de tempo que limita o acesso a 60 minutos.
URL da miniatura	thumbnail_url	string	O URL de uma miniatura da foto do perfil. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos.

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.

ConstituentApi.RelationshipRead

Relacionamento

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da relação.
ID do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado à relação.
ID da relação	relation_id	string	O ID de registro do sistema do indivíduo ou organização relacionado.
ID de relacionamento recíproco	reciprocal_relationship_id	string	O identificador para o registro de relacionamento recíproco. Esse valor é somente leitura e é gerado automaticamente quando a relação é criada. As alterações feitas nesse registro também serão refletidas na recíproca, com exceção da propriedade comments.
Nome	name	string	O nome do constituinte relacionado. Se o constituinte relacionado for um indivíduo, este será o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino.
Tipo	type	string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type	string	Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, numa relação entre um constituinte masculino e um irmão do sexo feminino, o tipo de relação recíproca seria irmão.
day	start.d	integer	O dia na data difusa.
mês	start.m	integer	O mês na data difusa.
ano	start.y	integer	O ano na data difusa.
day	end.d	integer	O dia na data difusa.
mês	end.m	integer	O mês na data difusa.
ano	end.y	integer	O ano na data difusa.
É cônjuge?	is_spouse	boolean	A pessoa coligada é cônjuge do constituinte (aplica-se apenas às relações entre particulares)?
O constituinte é chefe de família?	is_constituent_head_of_household	boolean	O constituinte é o chefe do agregado familiar?
O cônjuge é chefe de família?	is_spouse_head_of_household	boolean	O cônjuge é o chefe de família?
Observações	comment	string	O comentário sobre a relação.
É contacto?	is_organization_contact	boolean	O constituinte representa esta organização como um contacto (aplica-se apenas às relações entre organizações e indivíduos)?
O negócio é principal?	is_primary_business	boolean	Este é o negócio principal do constituinte (aplica-se apenas às relações entre organizações e indivíduos)?
Tipo de contacto	organization_contact_type	string	Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas às relações entre organizações e indivíduos.
Position	position	string	A posição do indivíduo na organização. Aplica-se apenas às relações entre organizações e indivíduos.
Data de adição	date_added	date-time	A data em que a relação foi criada.
Data de modificação	date_modified	date-time	A data em que a relação foi modificada pela última vez.

ConstituentApi.SearchResultRead

Resultado da pesquisa

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do constituinte.
Nome	name	string	O nome do constituinte. Para indivíduos, esse campo calculado indica o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino.
Address	address	string	Endereço preferencial do eleitor.
Falecido?	deceased	boolean	O constituinte faleceu?
Email	email	string	Endereço de correio eletrónico do constituinte.
Estatuto de angariador de fundos	fundraiser_status	string	O estatuto de angariador de fundos do eleitor. Para indivíduos, este campo calculado indica se o constituinte é Ativo, Inativo ou Nenhum. Para as organizações, este valor será sempre Nenhum.
Inativo?	inactive	boolean	O constituinte está inativo?
ID de pesquisa	lookup_id	string	O identificador definido pelo utilizador para o constituinte.

EventApi.AdministrativeArea

Define o modelo de dados usado para a área administrativa de um endereço (por exemplo, estado nos EUA).

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro da área administrativa.
nome	name	string	O nome da área administrativa.
breve descrição	short_description	string	A breve descrição da área administrativa.

EventApi.ApiCollectionOfEventFee

Taxas

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 EventApi.EventFee	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfEventListEntry

Events

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 EventApi.EventListEntry	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfEventParticipantOption

Opções dos participantes no evento

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 EventApi.EventParticipantOption	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfParticipantDonation

Doaçõ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 EventApi.ParticipantDonation	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfParticipantFee

Taxas

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 EventApi.ParticipantFee	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfParticipantFeePayment

Pagamento de taxas

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 EventApi.ParticipantFeePayment	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfParticipantListEntry

Participants

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 EventApi.ParticipantListEntry	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.ApiCollectionOfParticipantOption

Opções dos participantes

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 EventApi.ParticipantOption	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

EventApi.Country

Define o modelo de dados usado para o país de um endereço.

Name	Caminho	Tipo	Description
ID	id	string	O ID do registo do país.
nome a apresentar	display_name	string	O nome de exibição do país.
Código ISO	iso_alpha2_code	string	O código ISO 3166-1 alpha-2 para o país.

EventApi.CreatedEvent

Evento criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do evento recém-criado.

EventApi.CreatedEventFee

Taxa de evento criada

Name	Caminho	Tipo	Description
ID	id	string	A ID da taxa de evento recém-criada.

EventApi.CreatedEventParticipantOption

Opção de participante do evento criado

Name	Caminho	Tipo	Description
ID	id	string	A ID da opção de participante do evento recém-criada.

EventApi.CreatedParticipant

Participante criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do participante recém-criado.

EventApi.CreatedParticipantDonation

Criação de doação de participantes

Name	Caminho	Tipo	Description
ID	id	string	O ID da doação de participante recém-criada.

EventApi.CreatedParticipantFee

Taxa de participante criada

Name	Caminho	Tipo	Description
ID	id	string	O ID da taxa de participante recém-criada.

EventApi.CreatedParticipantFeePayment

Pagamento da taxa de participante criada

Name	Caminho	Tipo	Description
ID	id	string	O ID do pagamento da taxa de participante recém-criada.

EventApi.CreatedParticipantOption

Opção de participante criada

Name	Caminho	Tipo	Description
ID	id	string	A ID da opção de participante recém-criada.

EventApi.Event

Event

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do evento. Isso não é o mesmo que o identificador de evento definido pelo usuário, que é armazenado no lookup_id.
Nome	name	string	O nome do evento.
Description	description	string	A descrição do evento.
Data de início	start_date	date	A data de início do evento.
Hora de início	start_time	string	A hora de início do evento.
Data de fim	end_date	date	A data final do evento.
Hora de fim	end_time	string	A hora de término do evento.
Categoria	category	EventApi.EventCategory	Categoria de evento é a categorização personalizada para o evento.
ID de pesquisa	lookup_id	string	A ID de pesquisa do evento.
Localização	location	EventApi.Location	Define o modelo de dados usado para um local.
Capacidade	capacity	integer	O número de pessoas que podem assistir ao evento.
Objetivo	goal	double	O objetivo monetário do evento.
ID da Campanha	campaign_id	string	O ID de registo do sistema da campanha associada ao evento.
ID do Fundo	fund_id	string	O ID de registo do sistema do fundo associado ao evento.
Inativo?	inactive	boolean	O evento está inativo?
Data de adição	date_added	date-time	A data em que o evento foi criado.
Data de modificação	date_modified	date-time	A data em que o evento foi modificado pela última vez.

EventApi.EventCategory

Categoria de evento é a categorização personalizada para o evento.

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da categoria de evento.
nome	name	string	O nome da categoria do evento.
inativo?	inactive	boolean	Esta categoria está inativa?

EventApi.EventFee

As taxas do evento são o valor que uma organização cobra para que indivíduos ou organizações participem ou participem do evento.

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da taxa do evento.
nome	name	string	O nome da taxa do evento.
Montante	cost	double	O custo da taxa.
Montante da contribuição	contribution_amount	double	O valor dedutível do imposto para esta taxa.
número vendido	number_sold	integer	O número de taxas vendidas.

EventApi.EventListEntry

Event

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do evento.
Nome	name	string	O nome do evento.
Data de início	start_date	date	A data de início do evento.
Hora de início	start_time	string	A hora de início do evento.
Data de fim	end_date	date	A data final do evento.
Hora de fim	end_time	string	A hora de término do evento.
Categoria	category	EventApi.EventCategory	Categoria de evento é a categorização personalizada para o evento.
ID de pesquisa	lookup_id	string	A ID de pesquisa do evento.
Capacidade	capacity	integer	O número de pessoas que podem assistir ao evento.
Participação	attending_count	integer	O número de participantes do evento que planejam participar.
Presenças	attended_count	integer	O número de participantes do evento.
Convidados	invited_count	integer	O número de convidados para o evento.
Receitas	revenue	double	A receita realizada do evento.
Objetivo	goal	double	O objetivo monetário do evento.
Percentagem do objetivo	percent_of_goal	integer	A receita realizada como uma porcentagem da receita da meta.
Inativo?	inactive	boolean	O evento está inativo?
Data de adição	date_added	date-time	A data em que o evento foi criado.
Data de modificação	date_modified	date-time	A data em que o evento foi modificado pela última vez.

EventApi.EventParticipantOption

As opções dos participantes do evento são campos que coletam detalhes sobre os participantes, como tamanhos de camisetas, preferências de refeição ou solicitações de assentos. Defina opções e seus valores para um evento e, em seguida, adicione respostas para cada participante.

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da opção de participante do evento.
nome	name	string	O nome da opção de participante do evento.
tipo de entrada	input_type	string	O tipo de opção de participante do evento.
permitir a seleção múltipla?	multi_select	boolean	Permitir mais de um valor para listas?
list_options	list_options	array of EventApi.EventParticipantOptionListOption	As opções de lista disponíveis.
adicionado pelo usuário	added_by_user	string	A ID do usuário que adicionou a opção.
modificado pelo usuário	updated_by_user	string	O ID do usuário que modificou a opção.
adicionado por serviço	added_by_service	string	O nome do serviço que adicionou essa opção.
modificado pelo serviço	updated_by_service	string	O nome do serviço que modificou essa opção.
data adicionada	date_added	date-time	A data em que a opção foi criada.
Data de modificação	date_updated	date-time	A data em que a opção foi modificada pela última vez.
versão	version	integer	O número da versão da opção.

EventApi.EventParticipantOptionListOption

Uma opção de lista de opções de participante do evento

Name	Caminho	Tipo	Description
ID	id	string	O ID da opção de lista
nome	name	string	O nome da opção de lista
sequência	sequence	integer	A sequência usada para ordenar as opções da lista

EventApi.Locality

Define o modelo de dados usado para a localidade de um endereço.

Name	Caminho	Tipo	Description
ID	id	string	A ID do registro do registro de localidade.
nome	name	string	O nome da localidade.

EventApi.Location

Define o modelo de dados usado para um local.

Name	Caminho	Tipo	Description
nome	name	string	O nome do local.
linhas de endereço	address_lines	string	As linhas de endereço do local.
código postal	postal_code	string	O código postal do local.
Localidade	locality	EventApi.Locality	Define o modelo de dados usado para a localidade de um endereço.
área administrativa	administrative_area	EventApi.AdministrativeArea	Define o modelo de dados usado para a área administrativa de um endereço (por exemplo, estado nos EUA).
área subadministrativa	sub_administrative_area	EventApi.SubAdministrativeArea	Define o modelo de dados usado para a área subadministrativa de um endereço (por exemplo, cidade nos EUA).
country	country	EventApi.Country	Define o modelo de dados usado para o país de um endereço.
Endereço formatado	formatted_address	string	O endereço formatado do local

EventApi.Membership

Informações de filiação para o participante.

Name	Caminho	Tipo	Description
Categoria de membro	category	EventApi.MembershipCategory	A categoria de membro do indivíduo.

EventApi.MembershipCategory

A categoria de membro do indivíduo.

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da categoria de associação.
nome	name	string	O nome da categoria de associação.

EventApi.Participante

Participante

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do participante.
ID do constituinte	constituent_id	string	O ID de constituinte do participante.
ID do Evento	event_id	string	O ID de registro do sistema do evento que está sendo participado.
ID do anfitrião	host_id	string	O ID do registo de participante do anfitrião.
Estado de RSVP	rsvp_status	string	O status do envolvimento do participante com o evento.
Participou?	attended	boolean	O participante compareceu ao evento?
Estado do convite	invitation_status	string	O estado do convite ao participante.
day	rsvp_date.d	integer	O dia na data difusa.
mês	rsvp_date.m	integer	O mês na data difusa.
ano	rsvp_date.y	integer	O ano na data difusa.
day	invitation_date.d	integer	O dia na data difusa.
mês	invitation_date.m	integer	O mês na data difusa.
ano	invitation_date.y	integer	O ano na data difusa.
Nível de participação	participation_level	EventApi.ParticipationLevel	Os níveis de participação são o nível de envolvimento que os participantes têm num evento.
Data de adição	date_added	date-time	A data em que o participante foi criado.
Data de modificação	date_modified	date-time	A data em que o participante foi modificado pela última vez.

EventApi.ParticipantDonation

Define um modelo de dados para uma doação de participante

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da doação do participante.
ID do presente	gift_id	string	O ID de registro do sistema do presente ao qual a doação do participante está vinculada.

EventApi.ParticipantFee

Define um modelo de dados para uma taxa de participante

Name	Caminho	Tipo	Description
ID	id	string	O ID da taxa de participante.
ID do participante	participant_id	string	O ID do registo ao qual a taxa de participante está associada.
quantidade	quantity	integer	A quantidade comprada.
Montante da taxa	fee_amount	double	O valor da taxa de participação.
Montante da contribuição	tax_receiptable_amount	double	O valor dedutível do imposto para esta taxa.
day	date.d	integer	O dia na data difusa.
mês	date.m	integer	O mês na data difusa.
ano	date.y	integer	O ano na data difusa.
Taxa do evento	event_fee	EventApi.EventFee	As taxas do evento são o valor que uma organização cobra para que indivíduos ou organizações participem ou participem do evento.

EventApi.ParticipantFeePayment

Define um modelo de dados para o pagamento de uma taxa de participante

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do pagamento da taxa de participante.
ID do participante	participant_id	string	O ID de registo do sistema do participante ao qual o pagamento da taxa de participante está ligado.
ID do presente	gift_id	string	O ID de registro do sistema do presente ao qual o pagamento da taxa de participante está vinculado.
Montante aplicado	applied_amount	double	O valor aplicado do pagamento da taxa de participante.

EventApi.ParticipantListEntry

Participante

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do participante.
ID de contato	contact_id	string	O ID do contacto que participa no evento.
Estado de RSVP	rsvp_status	string	O status do envolvimento do participante com o evento.
Participou?	attended	boolean	O participante compareceu ao evento?
Estado do convite	invitation_status	string	O estado do convite ao participante.
day	rsvp_date.d	integer	O dia na data difusa.
mês	rsvp_date.m	integer	O mês na data difusa.
ano	rsvp_date.y	integer	O ano na data difusa.
Nível de participação	participation_level	EventApi.ParticipationLevel	Os níveis de participação são o nível de envolvimento que os participantes têm num evento.
Title	title	string	Título do participante.
Nome próprio	first_name	string	Nome próprio do participante.
Apelido	last_name	string	Apelido do participante.
Nome	name	string	Nome completo do participante.
Nome preferido	preferred_name	string	Nome preferido do participante.
Sufixo	suffix	string	Sufixo do participante.
ID de pesquisa	lookup_id	string	O LookupId do participante.
Email	email	string	O endereço de e-mail do participante.
Não envia e-mail?	do_not_email	boolean	O participante pode ser contactado através deste endereço de e-mail?
Telemóvel	phone	string	O número de telefone do participante.
Não liga?	do_not_call	boolean	O participante pode ser contactado através deste número?
Nome do meio	middle_name	string	Nome do meio do participante.
Antigo nome	former_name	string	O nome anterior do participante.
É um constituinte?	is_constituent	boolean	O participante é um constituinte?
Classe de	class_of	string	A turma de formandos do participante.
Total das taxas de inscrição	total_registration_fees	double	A soma dos valores dos honorários do participante.
Total pago	total_paid	double	A soma dos presentes pagos pelo participante com um tipo de Taxas de Inscrição.
Assento	seat	string	A atribuição do lugar ao participante.
Tag de nome	name_tag	string	A tag de nome do participante
Data de adição	date_added	date-time	A data em que o participante foi criado.
Data de modificação	date_modified	date-time	A data em que o participante foi modificado pela última vez.
ID de contacto	host.contact_id	string	O ID do contacto que participa no evento.
ID do participante	host.participant_id	string	O ID do participante.
nome	host.name	string	Nome completo do participante.
hóspedes	guests	array of EventApi.ParticipantListParticipantSummary	Os convidados do participante.
Associações	memberships	array of EventApi.Membership	As informações de filiação para o participante.

EventApi.ParticipantListParticipantSummary

Informações resumidas básicas do participante.

Name	Caminho	Tipo	Description
ID de contacto	contact_id	string	O ID do contacto que participa no evento.
ID do participante	participant_id	string	O ID do participante.
nome	name	string	Nome completo do participante.

EventApi.ParticipantOption

A opção de participante associada a um determinado participante

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da opção de participante.
ID do participante	participant_id	string	O ID de registo do sistema do participante.
ID do evento	event_id	string	A ID de registro do sistema do evento.
ID da opção do participante do evento	event_participant_option_id	string	O ID de registro do sistema da opção de participante do evento.
valor	option_value	string	A resposta do participante à opção.
adicionado pelo usuário	added_by_user	string	A ID do usuário que adicionou a opção de participante.
modificado pelo usuário	updated_by_user	string	O ID do usuário que modificou a opção de participante.
adicionado por serviço	added_by_service	string	O nome do serviço que adicionou essa opção de participante.
modificado pelo serviço	updated_by_service	string	O nome do serviço que modificou essa opção de participante.
data adicionada	date_added	date-time	A data em que a opção de participante foi criada.
Data de modificação	date_updated	date-time	A data em que a opção do participante foi modificada pela última vez.

EventApi.ParticipationLevel

Os níveis de participação são o nível de envolvimento que os participantes têm num evento.

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do nível de participação.
nome	name	string	O nome do nível de participação.
inativo?	is_inactive	boolean	O nível de participação está inativo?

EventApi.SubAdministrativeArea

Define o modelo de dados usado para a área subadministrativa de um endereço (por exemplo, cidade nos EUA).

Name	Caminho	Tipo	Description
ID	id	string	O ID da área subadministrativa.
nome	name	string	O nome da área subadministrativa.

Angariação de fundosApi.ApiCollectionOfAppealAttachmentRead

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 FundraisingApi.AppealAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfAppealCustomFieldRead

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 FundraisingApi.AppealCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfAppealRead

Recursos

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 FundraisingApi.AppealRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfCampaignAttachmentRead

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 FundraisingApi.CampaignAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfCampaignCustomFieldRead

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 FundraisingApi.CampaignCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfCampaignRead

Campaigns

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 FundraisingApi.CampaignRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfFundAttachmentRead

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 FundraisingApi.FundAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfFundCustomFieldRead

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 FundraisingApi.FundCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de FundosApi.ApiCollectionOfFundRead

Fundos

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 FundraisingApi.FundRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de FundosApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

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 FundraisingApi.FundraiserAssignmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.ApiCollectionOfPackageRead

Packages

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 FundraisingApi.PackageRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

Angariação de fundosApi.RecursoAnexoLer

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID do recurso	parent_id	string	O ID de registo do sistema do recurso associado à penhora.
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.

Angariação de fundosApi.AppealCustomFieldRead

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID do recurso	parent_id	string	O ID de 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.
Valor	value		O valor do campo personalizado.
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.

Angariação de fundosApi.AppealRead

Appeal

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do recurso.
Categoria	category	string	Quanto à categoria do recurso.
Data de adição	date_added	date-time	A data em que o recurso foi criado.
Data de modificação	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 fim	end_date	date-time	A data final do recurso.
valor	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	O recurso está ativo (ou seja, a data atual é posterior a 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.

Angariação de fundosApi.CampanhaAnexoLer

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID da Campanha	parent_id	string	O ID de registo do sistema da campanha associado 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.

Angariação de fundosApi.CampaignCustomFieldRead

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID da Campanha	parent_id	string	O ID de registro do sistema da campanha associado 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.
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.

Angariação de fundosApi.CampaignRead

Campanha

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da campanha.
Categoria	category	string	A categoria da campanha.
Data de adição	date_added	date-time	A data em que a campanha foi criada.
Data de modificação	date_modified	date-time	A data em que a campanha foi modificada pela última vez.
Description	description	string	O nome para exibição da campanha.
Data de fim	end_date	date-time	A data de fim da campanha.
valor	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	A campanha está inativa (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de fim)?
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.

Angariação de fundosApi.CreatedAppealAttachment

Recurso criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do anexo de recurso recém-criado.

Angariação de fundosApi.CreatedAppealCustomField

Campo personalizado de recurso criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado de recurso recém-criado.

Angariação de fundosApi.CreatedCampaignAttachment

Anexo de campanha criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do anexo de campanha recém-criado.

Angariação de fundosApi.CreatedCampaignCustomField

Campo personalizado de campanha criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado da campanha recém-criada.

Angariação de fundosApi.CriadoAngariação de fundosAtribuição

Criação de atribuição de angariação de fundos

Name	Caminho	Tipo	Description
ID	id	string	O ID da atribuição de angariação de fundos recém-criada.

FundraisingApi.CreatedFundAttachment

Penhora de fundo criada

Name	Caminho	Tipo	Description
ID	id	string	O ID do anexo de fundo recém-criado.

Angariação de fundosApi.CreatedFundCustomField

Campo personalizado do fundo criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado de fundo recém-criado.

Angariação de FundosApi.Angariação de FundosAtribuiçãoLer

Assignment

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema da atribuição de angariação de fundos.
ID do constituinte	constituent_id	string	O ID de registo do sistema do componente atribuído.
Tipo	type	string	O tipo de angariação de fundos.
Início da atribuição	start	date-time	A data de início da atribuição.
Fim da atribuição	end	date-time	A data final da atribuição.
valor	amount.value	double	O valor monetário.
ID da Campanha	campaign_id	string	O ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados.
ID do Fundo	fund_id	string	O ID de registo do sistema do fundo ao qual os donativos resultantes serão aplicados.
ID do recurso	appeal_id	string	O sistema registra o ID do recurso ao qual os presentes resultantes serão aplicados.

Angariação de fundosApi.FundAttachmentRead

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID do Fundo	parent_id	string	O ID de registo do sistema do fundo associado à penhora.
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.

Angariação de fundosApi.FundCustomFieldRead

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID do Fundo	parent_id	string	O ID de 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.
Valor	value		O valor do campo personalizado.
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.

Angariação de fundosApi.FundRead

Fundo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do fundo.
Categoria	category	string	A categoria do fundo.
Data de adição	date_added	date-time	A data em que o fundo foi criado.
Data de modificação	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 fim	end_date	date-time	A data final do fundo.
valor	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	O fundo está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)?
ID de pesquisa	lookup_id	string	O identificador definido pelo utilizador para o fundo.
Data de início	start_date	date-time	A data de início do fundo.
Tipo	type	string	O tipo de fundo.

Angariação de fundosApi.PackageRead

Package

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do pacote.
ID do recurso	appeal_id	string	O ID de registro do sistema do recurso associado a este pacote.
Categoria	category	string	A categoria do pacote.
Data de adição	date_added	date-time	A data em que o pacote foi criado.
Data de modificação	date_modified	date-time	A data em que o pacote foi modificado pela última vez.
valor	default_gift_amount.value	double	O valor monetário.
Description	description	string	O nome para exibição do pacote.
Data de fim	end	date-time	A data final do pacote.
valor	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	O pacote está inativo (ou seja, a data atual é posterior a 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.
Observações	notes	string	As notas na embalagem.
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.

GiftApi.AgradecimentoLer

Agradecimento

Name	Caminho	Tipo	Description
date	date	date-time	A data associada ao reconhecimento.
carta	letter	string	A carta associada ao reconhecimento.
estado	status	string	O status do reconhecimento. Os valores disponíveis são: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT e DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

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 GiftApi.GiftAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

GiftApi.ApiCollectionOfGiftCustomFieldLeia

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 GiftApi.GiftCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

GiftApi.ApiCollectionOfGiftRead

Presentes

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 GiftApi.GiftRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

GiftApi.BatchGiftAddResults

Contém uma coleção de registros de erro de presentes em lote e os presentes em lote que a operação adicionou

Name	Caminho	Tipo	Description
erros	errors	array of GiftApi.GiftBatchGiftError	Os erros de presente em lote associados à operação de adição de presente em lote
presentes	gifts	array of GiftApi.BatchGiftRead	A coleta de presentes em lote que foram adicionados pela operação de adição de presente em lote

GiftApi.GiftBatchGiftError

Representa exceções que impedem que itens sejam adicionados ao lote.

Name	Caminho	Tipo	Description
Campo afetado	affected_field	string	O campo afetado pelo erro
ID do lote	batch_id	string	O ID de registro do sistema do lote
Código de erro de exceção	exception_error_code	integer	O código de erro de exceção
Mensagem de erro de exceção	exception_error_message	string	A mensagem de erro de exceção
Nome do erro de exceção	exception_error_name	string	O nome do erro de exceção
ID do presente	gift_id	string	O ID de registro do sistema do presente
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.

GiftApi.BatchGiftRead

Presente de lote

Name	Caminho	Tipo	Description
ID do lote	batch_id	string	A ID do lote ao qual o presente foi adicionado.
erros	errors	array of GiftApi.GiftBatchGiftError	Os erros associados ao presente em lote.
ID	id	string	O ID de registro do sistema do presente de lote.
identificação do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado ao presente.
tipo	type	string	O tipo de presente.
Subtipo	subtype	string	O subtipo do presente.
date	date	date-time	A data do presente.
valor	amount.value	double	O valor monetário.
valor	balance.value	double	O valor monetário.
número do lote	batch_number	string	O número do lote associado a este presente.
estado	gift_status	string	O estatuto da dádiva.
anônimo?	is_anonymous	boolean	O presente é anónimo?
Círculo eleitoral	constituency	string	O eleitorado da dádiva.
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.
origin	origin	string	A origem do dom.
status do post	post_status	string	O status de postagem do razão do presente. Os valores disponíveis são Posted, NotPost e DoNotPost. Quando post_status é definido como DoNotPost>, post_date deve ser null. Quando é definido como NotPosted, post_date é necessário, mas permanece editável. Quando é definido como Postado, post_date é necessário e não é mais editável.
data de publicação	post_date	date-time	A data em que o presente foi postado na contabilidade.
referenciar	reference	string	Notas para rastrear detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
day	recurring_gift_status_date.d	integer	O dia na data difusa.
mês	recurring_gift_status_date.m	integer	O mês na data difusa.
ano	recurring_gift_status_date.y	integer	O ano na data difusa.
frequência	recurring_gift_schedule.frequency	string	Frequência de parcelamento do presente recorrente para visualizar. Os valores disponíveis são SEMANAIS, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MENSAIS, TRIMESTRAIS, ANUAIS.
start	recurring_gift_schedule.start_date	date-time	Data em que o presente recorrente deve começar.
fim	recurring_gift_schedule.end_date	date-time	Data em que o presente recorrente deve terminar.
valor	gift_aid_amount.value	double	O valor monetário.
Status de qualificação do Gift Aid	gift_aid_qualification_status	string	Este campo calculado determina o status de qualificação do Gift Aid com base nas informações da declaração fiscal e no formato do banco de dados. Os valores disponíveis são: Qualified, NotQualified e PartlyQualified. Apenas para o Reino Unido.
código de presente	gift_code	string	O valor do código de presente associado ao presente.
Divisão de presentes	gift_splits	array of GiftApi.GiftSplitRead	O conjunto de presentes divide-se associado ao presente.
angariação de fundos	fundraisers	array of GiftApi.GiftFundraiserRead	O conjunto de angariadores de fundos que recebem crédito pelo presente.
Créditos suaves	soft_credits	array of GiftApi.SoftCreditRead	O conjunto de créditos suaves associados ao presente.
Recibos	receipts	array of GiftApi.ReceiptRead	O conjunto de recibos associados ao presente.
Agradecimentos	acknowledgements	array of GiftApi.AcknowledgementRead	O conjunto de reconhecimentos associados ao dom.
Payments	payments	array of GiftApi.PaymentRead	Os pagamentos sobre o presente.
Ofertas vinculadas	linked_gifts	array of string	Os identificadores de outros presentes que estão ligados a este presente.
Data de adição	date_added	date-time	A data em que o presente foi criado.
Data de modificação	date_modified	date-time	A data em que o presente foi modificado pela última vez.

GiftApi.CreatedGift

Presente criado

Name	Caminho	Tipo	Description
ID	id	string	O ID do presente recém-criado.

GiftApi.CreatedGiftAttachment

Acessório de presente criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do anexo de presente recém-criado.

GiftApi.CreatedGiftCustomField

Campo personalizado de presente criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado de presente recém-criado.

GiftApi.GiftAttachmentLeia

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID de presente	parent_id	string	O ID de registro do sistema do presente associado 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.

GiftApi.GiftCustomFieldLeia

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID de presente	parent_id	string	O ID de registro do sistema do presente associado 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.
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.

GiftApi.GiftFundraiserLeia

Angariação de fundos para presentes

Name	Caminho	Tipo	Description
valor	amount.value	double	O valor monetário.
ID da angariação de fundos	constituent_id	string	O sistema constituinte regista o ID da angariação de fundos associada ao presente.

GiftApi.GiftRead

Presente

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do presente.
ID do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado ao presente.
Tipo	type	string	O tipo de presente.
Subtipo	subtype	string	O subtipo do presente.
Date	date	date-time	A data do presente.
valor	amount.value	double	O valor monetário.
valor	balance.value	double	O valor monetário.
Número do lote	batch_number	string	O número do lote associado a este presente.
Situação	gift_status	string	O estatuto da dádiva.
Anónimo?	is_anonymous	boolean	O presente é anónimo?
Círculo eleitoral	constituency	string	O eleitorado da dádiva.
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.
Origem	origin	string	A origem do dom.
Estado da publicação	post_status	string	O status de postagem do razão do presente. Os valores disponíveis são Posted, NotPost e DoNotPost. Quando post_status é definido como DoNotPost>, post_date deve ser null. Quando é definido como NotPosted, post_date é necessário, mas permanece editável. Quando é definido como Postado, post_date é necessário e não é mais editável.
Data de publicação	post_date	date-time	A data em que o presente foi postado na contabilidade.
Reference	reference	string	Notas para rastrear detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
day	recurring_gift_status_date.d	integer	O dia na data difusa.
mês	recurring_gift_status_date.m	integer	O mês na data difusa.
ano	recurring_gift_status_date.y	integer	O ano na data difusa.
frequência	recurring_gift_schedule.frequency	string	Frequência de parcelamento do presente recorrente para visualizar. Os valores disponíveis são SEMANAIS, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MENSAIS, TRIMESTRAIS, ANUAIS.
start	recurring_gift_schedule.start_date	date-time	Data em que o presente recorrente deve começar.
fim	recurring_gift_schedule.end_date	date-time	Data em que o presente recorrente deve terminar.
valor	gift_aid_amount.value	double	O valor monetário.
Status de qualificação do auxílio presente	gift_aid_qualification_status	string	Este campo calculado determina o status de qualificação do Gift Aid com base nas informações da declaração fiscal e no formato do banco de dados. Os valores disponíveis são: Qualified, NotQualified e PartlyQualified. Apenas para o Reino Unido.
Código de presente	gift_code	string	O valor do código de presente associado ao presente.
Divisão de presentes	gift_splits	array of GiftApi.GiftSplitRead	O conjunto de presentes divide-se associado ao presente.
Angariação de fundos	fundraisers	array of GiftApi.GiftFundraiserRead	O conjunto de angariadores de fundos que recebem crédito pelo presente.
Créditos suaves	soft_credits	array of GiftApi.SoftCreditRead	O conjunto de créditos suaves associados ao presente.
Recibos	receipts	array of GiftApi.ReceiptRead	O conjunto de recibos associados ao presente.
Agradecimentos	acknowledgements	array of GiftApi.AcknowledgementRead	O conjunto de reconhecimentos associados ao dom.
Payments	payments	array of GiftApi.PaymentRead	Os pagamentos sobre o presente.
Ofertas vinculadas	linked_gifts	array of string	Os identificadores de outros presentes que estão ligados a este presente.
Data de adição	date_added	date-time	A data em que o presente foi criado.
Data de modificação	date_modified	date-time	A data em que o presente foi modificado pela última vez.

GiftApi.GiftSplitRead

Divisão do presente

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da divisão do presente.
valor	amount.value	double	O valor monetário.
ID do recurso	appeal_id	string	O ID de registro do sistema do recurso associado à divisão do presente.
ID da campanha	campaign_id	string	O ID de registro do sistema da campanha associado à divisão do presente.
ID do fundo	fund_id	string	O ID de registro do sistema do fundo associado à divisão do presente.
valor	gift_aid_amount.value	double	O valor monetário.
Status de qualificação do Gift Aid	gift_aid_qualification_status	string	O status de qualificação do presente ajuda da divisão do presente. Os valores disponíveis são: Qualificado e Não Qualificado. Apenas para o Reino Unido.
ID do pacote	package_id	string	O ID de registro do sistema do pacote associado à divisão do presente.

GiftApi.ReceiptRead

Receipt

Name	Caminho	Tipo	Description
valor	amount.value	double	O valor monetário.
date	date	date-time	A data no recibo.
número	number	integer	O número do recibo.
estado	status	string	O status do recibo. Os valores disponíveis são: RECEIPTED, NEEDSRECEIPT e DONOTRECEIPT.

GiftApi.PagamentoLeia

Pagamento

Name	Caminho	Tipo	Description
token de conta	account_token	string	As informações da conta tokenizada (por exemplo, cartão de crédito) do provedor de pagamento externo. Apenas se aplica aos métodos de pagamento de "Cartão de Crédito" e "DirectDebit".
ID de configuração do BBPS	bbps_configuration_id	string	O ID de configuração do BBPS. Apenas se aplica aos métodos de pagamento de "Cartão de Crédito" e "DirectDebit".
ID da transação BBPS	bbps_transaction_id	string	O ID da transação BBPS. Apenas se aplica aos métodos de pagamento de "Cartão de Crédito" e "DirectDebit".
day	check_date.d	integer	O dia na data difusa.
mês	check_date.m	integer	O mês na data difusa.
ano	check_date.y	integer	O ano na data difusa.
número de verificação	check_number	string	O número do cheque. Aplica-se apenas ao método de pagamento de "PersonalCheck".
ID da transação de checkout	checkout_transaction_id	string	O ID da transação de checkout. Apenas se aplica aos métodos de pagamento de "Cartão de Crédito" e "DirectDebit".
método de pagamento	payment_method	string	O método de pagamento. Os valores disponíveis estão listados abaixo.
referenciar	reference	string	A referência. Aplica-se apenas ao método de pagamento de "Outros".
day	reference_date.d	integer	O dia na data difusa.
mês	reference_date.m	integer	O mês na data difusa.
ano	reference_date.y	integer	O ano na data difusa.

GiftApi.SoftCreditRead

Crédito em condições favoráveis

Name	Caminho	Tipo	Description
ID	id	string	O ID de registo do sistema do crédito em condições preferenciais.
valor	amount.value	double	O valor monetário.
identificação do constituinte	constituent_id	string	O ID de registo do sistema do constituinte associado ao crédito em condições favoráveis.
ID do presente	gift_id	string	O ID de registo do sistema do presente associado ao crédito em condições favoráveis.

GiftBatchApi.ApiCollectionOfGiftBatch

Lotes de presentes

Name	Caminho	Tipo	Description
Contar	count	integer	O número total de lotes de presentes na resposta.
valor	value	array of GiftBatchApi.GiftBatch	O conjunto de itens incluídos na resposta.

GiftBatchApi.CreatedBatch

Lote de presente criado

Name	Caminho	Tipo	Description
ID	batch_id	string	A ID de registro do sistema do lote de presente recém-criado.

GiftBatchApi.GiftBatch

Representa o objeto de lote de presente

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do lote.
descrição	batch_description	string	A descrição do lote.
número do lote	batch_number	string	O número do lote
número projetado	projected_number_of_gifts	integer	O número projetado de presentes no lote.
número real	number_of_gifts	integer	O número real de presentes no lote.
Montante previsto	projected_amount	double	O valor projetado dos presentes no lote.
montante real	actual_amount	double	O valor real dos presentes no lote.
tem exceções?	has_exceptions	boolean	O lote tem exceções?
aprovado?	is_approved	boolean	O lote está aprovado?
Criado por	created_by	string	O nome do usuário que criou o lote.
Criado a	created_on	date-time	A data em que o lote foi criado.

ListApi.CreatedList

Lista criada

Name	Caminho	Tipo	Description
ID	id	string	A ID da lista recém-criada.

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.

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

Partilhar via

Blackbaud Raisers Edge NXT (Pré-visualização)

Pré-requisitos

Como obter credenciais?

Problemas conhecidos e limitações

Limites de Limitação

Ações

Adicionar registos a uma lista

Parâmetros

Adicionar um presente ao lote

Parâmetros

Devoluções

Atualizar a presença online de um constituinte

Parâmetros

Atualizar detalhes de confirmação do presente

Parâmetros

Atualizar detalhes do recibo de presente

Parâmetros

Atualizar um alias constituinte

Parâmetros

Atualizar um anexo constituinte

Parâmetros

Atualizar um anexo de ação

Parâmetros

Atualizar um anexo de campanha

Parâmetros

Atualizar um anexo de fundo

Parâmetros

Atualizar um anexo de oportunidade

Parâmetros

Atualizar um anexo de presente

Parâmetros

Atualizar um anexo de recurso

Parâmetros

Atualizar um campo personalizado de ação

Parâmetros

Atualizar um campo personalizado de campanha

Parâmetros

Atualizar um campo personalizado de oportunidade

Parâmetros

Atualizar um campo personalizado de presente

Parâmetros

Atualizar um campo personalizado de recurso

Parâmetros

Atualizar um campo personalizado do constituinte

Parâmetros

Atualizar um campo personalizado do fundo

Parâmetros

Atualizar um constituinte

Parâmetros

Atualizar um código constituinte

Parâmetros

Atualizar um código de solicitação de constituinte

Parâmetros

Atualizar um endereço de constituinte

Parâmetros

Atualizar um endereço de e-mail constituinte

Parâmetros

Atualizar um evento

Parâmetros

Atualizar um participante

Parâmetros

Atualizar um telefone constituinte

Parâmetros

Atualizar uma ação constituinte

Parâmetros

Atualizar uma educação constituinte

Parâmetros

Atualizar uma foto de perfil do constituinte

Parâmetros

Atualizar uma nota constituinte

Parâmetros

Atualizar uma oportunidade

Parâmetros

Atualizar uma opção de participante

Parâmetros

Atualizar uma relação constituinte

Parâmetros

Campos personalizados de ação de lista

Parâmetros