Blackbaud RENXT Gifts

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

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

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Suporte do Blackbaud
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Metadados do conector
Publicador	Blackbaud, Inc.
Site	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Política de privacidade	https://www.blackbaud.com/privacy-shield
Categorias	Vendas e CRM; Produtividade

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

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

Presentes e resumos constituintes
Lotes de presentes
Recibos
Reconhecimento
e muito mais...

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

Pré-requisitos

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

Além disso, o administrador da sua organização também deve executar uma ação no nível do administrador dentro do sistema para permitir que esse conector acesse seu ambiente blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de instalação inicial .

Como obter credenciais?

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

Problemas e limitações conhecidos

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

Limitações

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

Ações

Adicionar um presente ao lote	Adicione um presente ao lote de presentes especificado.
Atualizar detalhes de confirmação do presente	Atualiza os detalhes de confirmação de um presente.
Atualizar detalhes do recibo do presente	Atualiza os detalhes do recibo de um presente.
Atualizar um anexo de presente	Atualiza um anexo de presente.
Atualizar um campo personalizado de presente	Atualiza um campo personalizado de presente.
Atualizar um reconhecimento de tributo de presente	Atualiza um reconhecimento de tributo de presente.
Atualizar um tributo a presentes	Atualiza um tributo de presente.
Atualizar uma declaração de imposto constituinte	Atualiza uma declaração de imposto constituinte.
Atualizar uma nota de presente	Atualiza uma nota de presente.
Criar um anexo de presente	Cria um novo anexo de presente.
Criar um campo personalizado de presente	Cria um novo campo personalizado de presente.
Criar um lote de presentes	Cria um novo lote de presentes.
Criar um pagamento de promessa	Cria um novo pagamento de promessa.
Criar um presente	Cria um novo presente.
Criar um presente de estoque	Cria um novo presente de estoque.
Criar um tributo de presente	Cria um novo tributo de presente.
Criar uma declaração de imposto constituinte	Cria uma nova declaração fiscal do Gift Aid para um constituinte.
Criar uma nota de presente	Cria uma nova nota de presente.
Criar uma promessa	Cria uma nova promessa.
Listar anexos de presentes	Lista os anexos de um presente.
Listar campos personalizados de presentes	Lista os campos personalizados para um presente.
Listar declarações fiscais constituintes	Lista as declarações fiscais do Gift Aid para um constituinte (aplicável apenas para versões do Reino Unido).
Listar lotes de presentes	Liste os lotes de presentes.
Listar notas sobre presentes	Lista as anotações de um presente.
Listar pagamentos de promessas	Lista os pagamentos de uma promessa.
Listar parcelas de promessa	Lista as parcelas de uma promessa.
Listar presentes	Retorna uma lista de presentes.
Listar reconhecimentos de tributo a presentes	Liste os reconhecimentos de um tributo de presente.
Listar tributos de presentes	Lista os tributos de um presente.
Obter a concessão do tempo de vida do constituinte	Retorna o tempo de vida dando resumo para um constituinte.
Obter o maior presente constituinte	Retorna o maior presente para um constituinte.
Obter o primeiro presente constituinte	Retorna o primeiro presente para um constituinte.
Obter o último presente constituinte	Retorna o último presente para um constituinte.
Obter um presente	Retorna informações sobre um presente.
Obter um presente por ID de pesquisa	Retorna a ID de registro do sistema de um presente da ID de pesquisa especificada.
Vender um presente de ações	Atualiza um presente de ações a ser vendido.

Adicionar um presente ao lote

ID da operação:: AddGiftToBatch

Adicione um presente ao lote de presentes especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lote	batch_id	True	string	O lote ao qual o presente será adicionado.
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte associado ao presente.
Quantidade	value	True	double	A quantidade do presente.
Date	date	True	date	A data do presente (por exemplo: '2020-09-18').
Tipo	type	True	string	O tipo de presente.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
quantidade	value	True	double	A quantidade da divisão do presente.
Método de pagamento	payment_method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação (aplicável somente quando a forma de pagamento é "PersonalCheck").
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Referência	reference		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
dia	d		integer	O dia na data difusa.
month	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, o anonimato padrão do doador será usado.
Subtipo	subtype		string	O subtipo do presente.
Comment	reference		string	Notas para acompanhar 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.
Usar créditos de arrecadação de fundos?	default_fundraiser_credits		boolean	Usar os créditos padrão de arrecadação de fundos?
Usar créditos suaves?	default_soft_credits		boolean	Usar os créditos soft padrão?
Círculo eleitoral	constituency		string	O eleitorado do presente.
Status da postagem	post_status		string	O status da postagem do presente.
Data da postagem	post_date		date	A data em que o presente foi postado (ex: '2020-09-18').
Status do recebimento	status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	A quantidade do recibo do presente.
Data de recebimento	date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').

Retornos

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

Results: GiftApi.BatchGiftAddResults

Atualizar detalhes de confirmação do presente

ID da operação:: EditGiftAcknowledgement

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de confirmação	acknowledgement_id	True	string	A ID de registro do sistema da confirmação do presente a ser atualizada. Ele usa a ID do presente pai como seu valor.
Situação	status		string	O status da confirmação. Quando o status é definido como DoNotAcknowledge, a carta e a data devem ser nulas. Quando o status é definido como NeedsAcknowledgement, a data deve ser nula.
Date	date		date-time	A data associada à confirmação (por exemplo: '2020-09-18T04:13:56Z').
Letra	letter		string	A carta associada à confirmação.

Atualizar detalhes do recibo do presente

ID da operação:: EditGiftReceipt

Atualiza os detalhes do recibo de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do recibo	receipt_id	True	string	A ID do registro do sistema do recibo de presente a ser atualizado. Ele usa a 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.
Quantidade	value		double	O valor do recibo.
Date	date		date-time	A data no recibo (por exemplo: '2020-09-18T04:13:56Z').
Número	number		integer	O número do recibo.

Atualizar um anexo de presente

ID da operação:: EditGiftAttachment

Atualiza um anexo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do anexo	attachment_id	True	string	A ID do registro do sistema do anexo a ser atualizado.
Nome	name		string	O nome do anexo. Limite de caracteres: 150.
Date	date		date-time	A data do anexo (por exemplo: '2020-09-18T04:13:56Z').
URL	url		string	A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.
Etiquetas	tags		array of string	As marcas associadas ao anexo.

Atualizar um campo personalizado de presente

ID da operação:: EditGiftCustomField

Atualiza um campo personalizado de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do campo personalizado	custom_field_id	True	string	A ID do registro do sistema do campo personalizado a ser atualizado.
body	body	True	dynamic	Um objeto que representa as propriedades do campo personalizado a ser atualizado.

Atualizar um reconhecimento de tributo de presente

ID da operação:: EditGiftTributeAcknowledgee

Atualiza um reconhecimento de tributo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de reconhecimento de presente	gift_tribute_acknowledgee_id	True	integer	A ID do registro do sistema do tributo do presente reconhece a atualização.
Letra	letter		integer	A carta enviada ao reconhecimento.
Data da carta	letter_date		date-time	A data em que a carta foi enviada.

Atualizar um tributo a presentes

ID da operação:: EditGiftTribute

Atualiza um tributo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tributo do presente	gift_tribute_id	True	integer	A ID do registro do sistema do tributo de presente a ser atualizado.
Tipo de tributo	tribute_type		integer	O tipo de tributo.
Confirmar status	acknowledge		string	O status de reconhecimento do tributo de presente.

Atualizar uma declaração de imposto constituinte

ID da operação:: EditTaxDeclaration

Atualiza uma declaração de imposto constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da declaração de imposto	tax_declaration_id	True	integer	A ID de registro do sistema da declaração de imposto a ser atualizada.
Início da declaração	declaration_starts		date-time	A data em que a declaração de imposto é iniciada (por exemplo: '2020-09-18T04:13:56Z').
Termina a declaração	declaration_ends		date-time	A data em que a declaração de imposto termina (por exemplo: '2020-09-18T04:13:56Z').
Declaração feita	declaration_made		date-time	A data em que a declaração de imposto foi feita (por exemplo: '2020-09-18T04:13:56Z').
Indicator	declaration_indicator		string	O indicador de declaração.
Source	declaration_source		string	A origem da declaração.
Confirmação enviada	confirmation_sent		date-time	A data em que a confirmação foi enviada (por exemplo: '2020-09-18T04:13:56Z').
Confirmação retornada	confirmation_returned		date-time	A data em que a confirmação foi retornada (por exemplo: '2020-09-18T04:13:56Z').
Paga imposto	constituent_pays_tax		string	Indica se o constituinte paga imposto.
Situação	tax_payer_status		string	O status do contribuinte.
Comments	tax_notes		string	Comentários sobre a declaração de imposto.
Sequence	sequence		integer	A sequência numérica associada à declaração de imposto.

Atualizar uma nota de presente

ID da operação:: EditGiftNote

Atualiza uma nota de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da anotação	id	True	integer	A ID do registro do sistema da nota a ser atualizada.
Tipo	note_type_id		integer	O tipo de anotação.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Resumo	summary		string	O resumo da anotação. Limite de caracteres: 255.
Observação	text		string	O texto da anotação.
Autor	author		string	O autor da anotação. Limite de caracteres: 50.

Criar um anexo de presente

ID da operação:: CreateGiftAttachment

Cria um novo anexo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	parent_id	True	string	A ID do registro do sistema do presente associado ao anexo.
Tipo	type	True	string	O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente.
Nome	name		string	O nome do anexo. Limite de caracteres: 150.
Date	date		date-time	A data do anexo (por exemplo: '2020-09-18T04:13:56Z'). Esse campo usa como padrão a data e a hora atuais, se não for fornecido.
URL	url		string	A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.
Nome do arquivo	file_name		string	O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID de Arquivo	file_id		string	O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID da miniatura	thumbnail_id		string	O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos.
Etiquetas	tags		array of string	As marcas associadas ao anexo.

Retornos

Anexo de presente criado

Corpo: GiftApi.CreatedGiftAttachment

Criar um campo personalizado de presente

ID da operação:: CreateGiftCustomField

Cria um novo campo personalizado de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Retornos

Campo personalizado de presente criado

Corpo: GiftApi.CreatedGiftCustomField

Criar um lote de presentes

ID da operação:: CreateGiftBatch

Cria um novo lote de presentes.

Parâmetros

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

Retornos

Lote de presentes criado

Corpo: GiftBatchApi.CreatedBatch

Criar um pagamento de promessa

ID da operação:: CreatePledgePayment

Cria um novo pagamento de promessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	id	True	string	A ID do registro do sistema do constituinte.
Quantidade	value	True	double	O valor do pagamento da promessa.
Date	gift_date	True	date	A data de pagamento da promessa (por exemplo: '2020-09-18').
quantidade	value	True	double	A quantidade da divisão do presente.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
Método de pagamento	method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação.
Referência	reference_number		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
É anônimo?	anonymous		boolean	O presente é anônimo? Se nenhum valor for fornecido, o anonimato padrão do doador será usado.
penhor	pledge_id		string	A ID do registro do sistema da promessa que está sendo paga.
parcela	installment_id		string	A ID de registro do sistema da parcela que está sendo paga.
quantidade	amount_applied		double	O valor aplicado à parcela.
Subtipo	name		string	O subtipo do presente.
Comment	comments		string	Anotações para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Código do presente	value		string	O código presente associado ao presente.
Círculo eleitoral	value		string	O eleitorado do presente.
Status da postagem	gift_post_status		string	O status da postagem do presente.
Data da postagem	gift_post_date		date	A data em que o presente será postado (ex: '2020-09-18').
Status do recebimento	receipt_status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	A quantidade do recibo do presente.
Data de recebimento	receipt_date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').
COO	receipt_number		integer	O número do recibo.
Pilha de recibos	value		string	A pilha de recibos.
Confirmar status	status	True	string	O status de confirmação do presente.
Data de confirmação	acknowledgement_date		date	A data em que o presente foi reconhecido (ex: '2020-09-18').
Letra	value		string	A carta associada à confirmação.
tipo	credit_type	True	string	O tipo de crédito de reconhecimento.
ID do destinatário	constituent_id	True	string	A ID do registro do sistema do destinatário do crédito de reconhecimento.
quantidade	value	True	double	O valor creditado ao destinatário.

Retornos

Presente criado

Corpo: GiftApi.CreatedGift

Criar um presente

ID da operação:: CreateGift

Cria um novo presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte associado ao presente.
Quantidade	value	True	double	A quantidade do presente.
Date	date	True	date	A data do presente (por exemplo: '2020-09-18').
Tipo	type	True	string	O tipo de presente.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
quantidade	value	True	double	A quantidade da divisão do presente.
Método de pagamento	payment_method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação (aplicável somente quando a forma de pagamento é "PersonalCheck").
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Referência	reference		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
dia	d		integer	O dia na data difusa.
month	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, o anonimato padrão do doador será usado.
Subtipo	subtype		string	O subtipo do presente.
Comment	reference		string	Notas para acompanhar 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.
Usar créditos de arrecadação de fundos?	default_fundraiser_credits		boolean	Usar os créditos padrão de arrecadação de fundos?
Usar créditos suaves?	default_soft_credits		boolean	Usar os créditos soft padrão?
Círculo eleitoral	constituency		string	O eleitorado do presente.
Prefixo do lote	batch_prefix		string	O prefixo a ser usado para presentes em lotes. Isso deve incluir pelo menos uma letra e é necessá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 em lote).
Status da postagem	post_status		string	O status da postagem do presente.
Data da postagem	post_date		date	A data em que o presente foi postado (ex: '2020-09-18').
Status do recebimento	status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	A quantidade do recibo do presente.
Data de recebimento	date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').

Retornos

Presente criado

Corpo: GiftApi.CreatedGift

Criar um presente de estoque

ID da operação:: CreateStock

Cria um novo presente de estoque.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	id	True	string	A ID do registro do sistema do constituinte.
Quantidade	value	True	double	A quantidade do presente.
Date	gift_date	True	date	A data do presente (por exemplo: '2020-09-18').
Emissor	issuer		string	O emissor das ações.
Símbolo do emissor	symbol		string	O símbolo do emissor de ações.
Número de unidades	units		integer	O número de unidades de estoque.
Preço médio por unidade	unit_price		double	O preço médio por unidade.
quantidade	value	True	double	A quantidade da divisão do presente.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
Método de pagamento	method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação.
Referência	reference_number		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
É anônimo?	anonymous		boolean	O presente é anônimo? Se nenhum valor for fornecido, o anonimato padrão do doador será usado.
Subtipo	name		string	O subtipo do presente.
Comment	comments		string	Anotações para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Código do presente	value		string	O código presente associado ao presente.
Círculo eleitoral	value		string	O eleitorado do presente.
Status da postagem	gift_post_status		string	O status da postagem do presente.
Data da postagem	gift_post_date		date	A data em que o presente será postado (ex: '2020-09-18').
Status do recebimento	receipt_status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	A quantidade do recibo do presente.
Data de recebimento	receipt_date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').
COO	receipt_number		integer	O número do recibo.
Pilha de recibos	value		string	A pilha de recibos.
Confirmar status	status	True	string	O status de confirmação do presente.
Data de confirmação	acknowledgement_date		date	A data em que o presente foi reconhecido (ex: '2020-09-18').
Letra	value		string	A carta associada à confirmação.
tipo	credit_type	True	string	O tipo de crédito de reconhecimento.
ID do destinatário	constituent_id	True	string	A ID do registro do sistema do destinatário do crédito de reconhecimento.
quantidade	value	True	double	O valor creditado ao destinatário.

Retornos

Presente criado

Corpo: GiftApi.CreatedGift

Criar um tributo de presente

ID da operação:: CreateGiftTribute

Cria um novo tributo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	integer	A ID do registro do sistema do presente associado ao tributo do presente.
ID do tributo	tribute_id	True	integer	A ID do registro do sistema do tributo associado ao tributo do presente.

Retornos

Tributo de presente criado

Corpo: NXTDataIntegrationApi.CreatedGiftTribute

Criar uma declaração de imposto constituinte

ID da operação:: CreateTaxDeclaration

Cria uma nova declaração fiscal do Gift Aid para um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	integer	A ID do registro do sistema do constituinte.
Início da declaração	declaration_starts	True	date-time	A data em que a declaração de imposto é iniciada (por exemplo: '2020-09-18T04:13:56Z').
Termina a declaração	declaration_ends		date-time	A data em que a declaração de imposto termina (por exemplo: '2020-09-18T04:13:56Z').
Declaração feita	declaration_made		date-time	A data em que a declaração de imposto foi feita (por exemplo: '2020-09-18T04:13:56Z').
Indicator	declaration_indicator		string	O indicador de declaração.
Source	declaration_source		string	A origem da declaração.
Confirmação enviada	confirmation_sent		date-time	A data em que a confirmação foi enviada (por exemplo: '2020-09-18T04:13:56Z').
Confirmação retornada	confirmation_returned		date-time	A data em que a confirmação foi retornada (por exemplo: '2020-09-18T04:13:56Z').
Paga imposto	constituent_pays_tax		string	Indica se o constituinte paga imposto.
Situação	tax_payer_status		string	O status do contribuinte.
Comments	tax_notes		string	Comentários sobre a declaração de imposto.
Sequence	sequence		integer	A sequência numérica associada à declaração de imposto.

Retornos

Declaração de imposto criada

Corpo: NXTDataIntegrationApi.CreatedTaxDeclaration

Criar uma nota de presente

ID da operação:: CreateGiftNote

Cria uma nova nota de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	integer	A ID do registro do sistema do presente associado à anotação.
Tipo	note_type_id	True	integer	O tipo de anotação.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Resumo	summary		string	O resumo da anotação. Limite de caracteres: 255.
Observação	text		string	O texto da anotação.
Autor	author		string	O autor da anotação. Limite de caracteres: 50.

Retornos

Anotação criada

Corpo: NXTDataIntegrationApi.CreatedGiftNote

Criar uma promessa

ID da operação:: CreatePledge

Cria uma nova promessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	id	True	string	A ID do registro do sistema do constituinte.
Quantidade	value	True	double	A quantidade da promessa.
Date	gift_date	True	date	A data da promessa (por exemplo: '2020-09-18').
Frequência	frequency	True	string	A frequência de parcelamento da promessa.
Nº de parcelas	number_of_installments	True	integer	O número de parcelas da promessa.
Data de início	start_date	True	date	A data em que a agenda de promessas é iniciada.
quantidade	value	True	double	A quantidade da divisão do presente.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
Método de pagamento	method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação.
Referência	reference_number		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
Enviar lembrete?	send_reminder		boolean	Enviar lembretes de promessa?
É anônimo?	anonymous		boolean	O presente é anônimo? Se nenhum valor for fornecido, o anonimato padrão do doador será usado.
Subtipo	name		string	O subtipo do presente.
Comment	comments		string	Anotações para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Código do presente	value		string	O código presente associado ao presente.
Círculo eleitoral	value		string	O eleitorado do presente.
Status da postagem	gift_post_status		string	O status da postagem do presente.
Data da postagem	gift_post_date		date	A data em que o presente será postado (ex: '2020-09-18').
Situação	gift_status		string	O status da promessa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Status do recebimento	receipt_status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	A quantidade do recibo do presente.
Data de recebimento	receipt_date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').
COO	receipt_number		integer	O número do recibo.
Pilha de recibos	value		string	A pilha de recibos.
Confirmar status	status	True	string	O status de confirmação do presente.
Data de confirmação	acknowledgement_date		date	A data em que o presente foi reconhecido (ex: '2020-09-18').
Letra	value		string	A carta associada à confirmação.
tipo	credit_type	True	string	O tipo de crédito de reconhecimento.
ID do destinatário	constituent_id	True	string	A ID do registro do sistema do destinatário do crédito de reconhecimento.
quantidade	value	True	double	O valor creditado ao destinatário.
date	date		date	A data da parcela (por exemplo: '2020-09-18').
quantidade	amount		double	O valor da parcela.

Retornos

Presente criado

Corpo: GiftApi.CreatedGift

Listar anexos de presentes

ID da operação:: ListGiftAttachments

Lista os anexos de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente.

Retornos

Attachments

Corpo: GiftApi.ApiCollectionOfGiftAttachmentRead

Listar campos personalizados de presentes

ID da operação:: ListGiftCustomFields

Lista os campos personalizados para um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente.

Retornos

Campos Personalizados

Corpo: GiftApi.ApiCollectionOfGiftCustomFieldRead

Listar declarações fiscais constituintes

ID da operação:: ListConstituentTaxDeclarations

Lista as declarações fiscais do Gift Aid para um constituinte (aplicável apenas para versões do Reino Unido).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	integer	A ID do registro do sistema do constituinte.
Limit	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. Não há no máximo.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação.

Retornos

Declarações fiscais

Corpo: NXTDataIntegrationApi.TaxDeclarationCollection

Listar lotes de presentes

ID da operação:: ListGiftBatches

Liste os lotes de presentes.

Parâmetros

Nome	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 presentes.
Tem exceções?	has_exceptions	boolean	Representa um filtro para saber se o lote de presentes contém exceções.
Limit	limit	integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000.
Offset	offset	integer	Representa o número de registros a serem ignoradas. Para uso com paginação.
Pesquisar texto	search_text	string	Representa um filtro para o texto incluído nos campos de descrição do lote ou número de lote.
Criado por	created_by	string	Representa um filtro para lotes de presentes criados pelo usuário especificado.

Retornos

Lotes de presentes

Corpo: GiftBatchApi.ApiCollectionOfGiftBatch

Listar notas sobre presentes

ID da operação:: ListGiftNotes

Lista as anotações de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	integer	A ID do registro do sistema do giftt.
Limit	limit		integer	Representa o número de registros a serem retornados.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação.

Retornos

Notas sobre presentes

Corpo: NXTDataIntegrationApi.GiftNoteCollection

Listar pagamentos de promessas

ID da operação:: ListPledgePayments

Lista os pagamentos de uma promessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da promessa	gift_id	True	string	A ID de registro do sistema da promessa.

Retornos

Payments

Corpo: Gift2Api.PledgePaymentCollection

Listar parcelas de promessa

ID da operação:: ListPledgeInstallments

Lista as parcelas de uma promessa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da promessa	gift_id	True	string	A ID de registro do sistema da promessa.

Retornos

Parcelas

Corpo: Gift2Api.PledgeInstallmentCollection

Listar presentes

ID da operação:: ListGifts

Retorna uma lista de presentes.

Parâmetros

Nome	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 presentes 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 IDs de registro do sistema constituinte para filtrar os resultados. Por exemplo, "280.1232" retorna apenas presentes do constituinte 280 ou constituinte 1232.
ID da Campanha	campaign_id	string	Representa uma lista separada por vírgulas de IDs de registro do sistema de campanha para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para a campanha 506 ou a campanha 918.
ID do fundo	fund_id	string	Representa uma lista separada por vírgulas de IDs de registro do sistema de fundos para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para financiar 506 ou financiar 918.
ID de recurso	appeal_id	string	Representa uma lista separada por vírgulas de IDs de registro do sistema de apelação para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para apelar 506 ou apelar 918.
Limit	limit	integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000.
Offset	offset	integer	Representa o número de registros a serem ignoradas. Para uso com paginação.
Data de início do presente	start_gift_date	date-time	Representa um filtro para presentes com uma data de presente na data especificada (por exemplo: '2020-09-18T04:13:56Z').
Data de término do presente	end_gift_date	date-time	Representa um filtro para presentes com uma data de presente em ou antes da data especificada (por exemplo: '2020-09-18T04:13:56Z').
Inicie o valor do presente	start_gift_amount	double	Representa um filtro para presentes com uma quantidade maior ou igual à quantidade especificada.
Valor final do presente	end_gift_amount	double	Representa um filtro para presentes com uma quantidade menor ou igual à quantidade especificada.
Status da postagem	post_status	string	Representa uma lista separada por vírgulas de status de postagem de presentes para filtrar os resultados. Por exemplo, "DoNotPost,Posted" retorna apenas presentes marcados como DoNotPost ou Posted.
Status do recebimento	receipt_status	string	Representa uma lista separada por vírgulas de status de recebimento de presentes para filtrar os resultados. Por exemplo, "DoNotReceipt,Receipted" retorna apenas presentes marcados como DoNotReceipt ou Receipted.
Status de confirmação	acknowledgement_status	string	Representa uma lista separada por vírgulas de status de confirmação de presentes para filtrar os resultados. Por exemplo, "DoNotAcknowledge,Acknowledged" retorna apenas presentes marcados como DoNotAcknowledge ou Acknowledged.
Classificado por	sort	string	Representa uma lista de campos para classificar os resultados. Os resultados estão em ordem crescente por padrão e um sinal '-' indica ordem decrescente. Por exemplo, "date_added,-date" classifica os presentes pelo campo "date_added" em ordem crescente e, em seguida, pelo campo "data do presente" em ordem decrescente. Se apenas o campo date_modified ou apenas o campo date_added for fornecido, isso adicionará o parâmetro sort_token à URL next_link para garantir que os presentes sejam classificados de forma apunhalada.
Adicionado em ou após	date_added	date-time	Filtre os resultados para presentes criados em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para presentes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Presentes

Corpo: GiftApi.ApiCollectionOfGiftRead

Listar reconhecimentos de tributo a presentes

ID da operação:: ListGiftTributeAcknowledgees

Liste os reconhecimentos de um tributo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do tributo do presente	gift_tribute_id	True	integer	A ID do registro do sistema do tributo do presente.

Retornos

Homenagem de presente reconhece

Corpo: NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

Listar tributos de presentes

ID da operação:: ListGiftTributes

Lista os tributos de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	integer	A ID do registro do sistema do presente.

Retornos

Tributos a presentes

Corpo: NXTDataIntegrationApi.GiftTributeCollection

Obter a concessão do tempo de vida do constituinte

ID da operação:: GetConstituentLifetimeGiving

Retorna o tempo de vida dando resumo para um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte.

Retornos

Concessão de tempo de vida

Corpo: ConstituentApi.LifetimeGivingRead

Obter o maior presente constituinte

ID da operação:: GetConstituentGreatestGift

Retorna o maior presente para um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte.

Retornos

Dando resumo

Corpo: ConstituentApi.GivingSummaryRead

Obter o primeiro presente constituinte

ID da operação:: GetConstituentFirstGift

Retorna o primeiro presente para um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte.

Retornos

Dando resumo

Corpo: ConstituentApi.GivingSummaryRead

Obter o último presente constituinte

ID da operação:: GetConstituentLatestGift

Retorna o último presente para um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte.

Retornos

Dando resumo

Corpo: ConstituentApi.GivingSummaryRead

Obter um presente

ID da operação:: GetGift

Retorna informações sobre um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente a ser obtido.

Retornos

Presente

Corpo: GiftApi.GiftRead

Obter um presente por ID de pesquisa

ID da operação:: GetGiftIdFromLookupId

Retorna a ID de registro do sistema de um presente da ID de pesquisa especificada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de pesquisa	giftlookupid	True	string	A ID da pesquisa do presente.

Retornos

Mapa da ID do presente

Corpo: NXTDataIntegrationApi.GiftIdMap

Vender um presente de ações

ID da operação:: SellStockGift

Atualiza um presente de ações a ser vendido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente de ações a ser vendido.
Data de venda	stock_sale_date	True	date	A data em que a ação foi vendida (por exemplo: '2005-09-18').
Valor de venda	stock_sale_value	True	double	O valor da venda de ações.
Taxa do agente	broker_fee		double	A taxa de agente de ações vendida.
Status da postagem	post_status		string	O status da postagem do presente vendido.
Data da postagem	post_date		date	A data postada da ação vendida (por exemplo: '2020-09-18').
Anotações	notes		string	As notas para as ações vendidas. Limite de caracteres: 255.
Emissor	issuer		string	O emissor das ações.
Símbolo do emissor	symbol		string	O símbolo do emissor de ações.
Número de unidades	units		integer	O número de unidades vendidas.
Preço médio por unidade	unit_price		double	O preço médio por unidade vendida.

Definições

ConstituentApi.AppealRead

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

ConstituentApi.CampaignRead

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

ConstituentApi.FundRead

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do fundo.
descrição	description	string	A descrição do fundo.

ConstituentApi.GivingSummaryRead

Dando resumo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do presente.
Tipo	type	string	O tipo de presente.
Date	date	date-time	A data do presente.
value	amount.value	double	A quantidade do presente.
Appeal	appeals	array of ConstituentApi.AppealRead	O conjunto de apelos associados ao presente.
Campanha	campaigns	array of ConstituentApi.CampaignRead	O conjunto de campanhas associadas ao presente.
Fundo	funds	array of ConstituentApi.FundRead	O conjunto de fundos associados ao presente.

ConstituentApi.LifetimeGivingRead

Concessão de tempo de vida

Nome	Caminho	Tipo	Description
Anos consecutivos dados	consecutive_years_given	integer	O número de anos consecutivos que o constituinte deu.
Total de anos dados	total_years_given	integer	O número total de anos que o constituinte deu.
value	total_giving.value	double	O valor total dado pelo constituinte.
value	total_pledge_balance.value	double	O saldo total de promessas não pagas para o constituinte.
value	total_received_giving.value	double	O valor total recebido pelo constituinte.
value	total_committed_matching_gifts.value	double	Esse campo computado calcula a quantidade total de compromissos de presentes correspondentes atribuídos ao constituinte.
value	total_received_matching_gifts.value	double	O valor total dos pagamentos referentes às promessas de presente correspondentes atribuídas ao constituinte.
value	total_soft_credits.value	double	A quantidade total de créditos suaves aplicados ao constituinte.

GiftApi.AcknowledgementRead

Reconhecimento

Nome	Caminho	Tipo	Description
date	date	date-time	A data associada à confirmação.
letra	letter	string	A carta associada à confirmação.
status	status	string	O status da confirmação. Os valores disponíveis são: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT e DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of GiftApi.GiftAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftApi.ApiCollectionOfGiftCustomFieldRead

Campos Personalizados

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of GiftApi.GiftCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftApi.ApiCollectionOfGiftRead

Presentes

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of GiftApi.GiftRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftApi.BatchGiftAddResults

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

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

GiftApi.GiftBatchGiftError

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

Nome	Caminho	Tipo	Description
campo afetado	affected_field	string	O campo afetado pelo erro
ID do lote	batch_id	string	A ID do 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	A ID do registro do sistema do presente
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.

GiftApi.BatchGiftRead

Presente em lote

Nome	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	A ID do registro do sistema do presente do lote.
ID do constituinte	constituent_id	string	A ID do 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.
value	amount.value	double	A quantidade do presente.
value	balance.value	double	O saldo restante no presente.
número do lote	batch_number	string	O número do lote associado a este presente.
status	gift_status	string	O status do presente.
anônimo?	is_anonymous	boolean	O presente é anônimo?
clientes	constituency	string	O eleitorado do presente.
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.
origem	origin	string	A origem do presente.
pós-status	post_status	string	O status de postagem geral do razão do presente. Os valores disponíveis são Posted, NotPosted e DoNotPost. Quando post_status é definido como DoNotPost>, post_date deve ser nulo. Quando ele é definido como NotPosted, post_date é necessário, mas permanece editável. Quando ele é definido como Postado, post_date é necessário e não é mais editável.
data da postagem	post_date	date-time	A data em que o presente foi postado no razão geral.
referência	reference	string	Notas para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
dia	recurring_gift_status_date.d	integer	O dia na data difusa.
month	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 a ser exibido. Os valores disponíveis são WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.
start	recurring_gift_schedule.start_date	date-time	Data em que o presente recorrente deve começar.
término	recurring_gift_schedule.end_date	date-time	Data em que o presente recorrente deve terminar.
value	gift_aid_amount.value	double	Esse campo computado calcula a quantidade total qualificada de impostos recuperados do Gift Aid em todos os gift_splits deste presente. Apenas para o Reino Unido.
status de qualificação de auxílio-presente	gift_aid_qualification_status	string	Esse campo computado determina o status de qualificação do Gift Aid com base nas informações da declaração de imposto e no formato de banco de dados. Os valores disponíveis são: Qualificado, NotQualificado e Parcialmente Qualificado. Apenas para o Reino Unido.
código de presente	gift_code	string	O valor do código presente associado ao presente.
divisões de presentes	gift_splits	array of GiftApi.GiftSplitRead	O conjunto de divisões de presentes associadas ao presente.
arrecadação de fundos	fundraisers	array of GiftApi.GiftFundraiserRead	O conjunto de arrecadações 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.
Reconhecimento	acknowledgements	array of GiftApi.AcknowledgementRead	O conjunto de confirmações associadas ao presente.
Payments	payments	array of GiftApi.PaymentRead	Os pagamentos do presente.
Presentes vinculados	linked_gifts	array of string	Os identificadores de outros presentes que estão vinculados a este presente.
Data de inclusão	date_added	date-time	A data em que o presente foi criado.
Data modificada	date_modified	date-time	A data em que o presente foi modificado pela última vez.

GiftApi.CreatedGift

Presente criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do presente recém-criado.

GiftApi.CreatedGiftAttachment

Anexo de presente criado

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

GiftApi.CreatedGiftCustomField

Campo personalizado de presente criado

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

GiftApi.GiftAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID do presente	parent_id	string	A ID do registro do sistema do presente associado ao anexo.
Tipo	type	string	O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente.
Nome	name	string	O nome do anexo. Limite de caracteres: 150.
Date	date	date-time	A data do anexo.
URL	url	string	A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.
Nome do arquivo	file_name	string	O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID de Arquivo	file_id	string	O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID da miniatura	thumbnail_id	string	O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos.
URL de miniatura	thumbnail_url	string	A URL de uma miniatura. Para anexos físicos que são somente imagens. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos.
Tipo de conteúdo	content_type	string	O tipo de conteúdo. Somente para anexos físicos.
Tamanho do arquivo	file_size	integer	O tamanho do arquivo em bytes. Somente para anexos físicos.
Etiquetas	tags	array of string	As marcas associadas ao anexo.

GiftApi.GiftCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID do presente	parent_id	string	A ID do 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.
Value	value		O valor do campo personalizado.
Valor do texto	text_value	string	O valor do texto do campo personalizado.
Valor do número	number_value	integer	O valor numérico do campo personalizado.
Valor da data	date_value	date	O valor de data do campo personalizado.
Valor da moeda	currency_value	double	O valor da moeda do campo personalizado.
Valor booliano	boolean_value	boolean	O valor booliano do campo personalizado.
Valor de entrada da tabela	codetableentry_value	string	O valor de entrada da tabela do campo personalizado.
Valor da ID constituinte	constituentid_value	string	O valor da ID do constituinte do campo personalizado.
dia	fuzzydate_value.d	integer	O dia na data difusa.
month	fuzzydate_value.m	integer	O mês na data difusa.
ano	fuzzydate_value.y	integer	O ano na data difusa.
Date	date	date	A data no campo personalizado.
Comment	comment	string	O comentário no campo personalizado. Limite de caracteres: 50.
Data de inclusão	date_added	date-time	A data em que o campo personalizado foi criado.
Data modificada	date_modified	date-time	A data em que o campo personalizado foi modificado pela última vez.

GiftApi.GiftFundraiserRead

Arrecadação de presentes

Nome	Caminho	Tipo	Description
value	amount.value	double	O valor creditado à arrecadação de fundos para o presente.
ID de arrecadação de fundos	constituent_id	string	A ID do registro do sistema constituinte para a arrecadação de fundos associada ao presente.

GiftApi.GiftRead

Presente

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do presente.
ID do Constituinte	constituent_id	string	A ID do 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.
value	amount.value	double	A quantidade do presente.
value	balance.value	double	O saldo restante no presente.
Número do lote	batch_number	string	O número do lote associado a este presente.
Situação	gift_status	string	O status do presente.
Anônimo?	is_anonymous	boolean	O presente é anônimo?
Círculo eleitoral	constituency	string	O eleitorado do presente.
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.
Origin	origin	string	A origem do presente.
Status da postagem	post_status	string	O status de postagem geral do razão do presente. Os valores disponíveis são Posted, NotPosted e DoNotPost. Quando post_status é definido como DoNotPost>, post_date deve ser nulo. Quando ele é definido como NotPosted, post_date é necessário, mas permanece editável. Quando ele é definido como Postado, post_date é necessário e não é mais editável.
Data da postagem	post_date	date-time	A data em que o presente foi postado no razão geral.
Referência	reference	string	Notas para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
dia	recurring_gift_status_date.d	integer	O dia na data difusa.
month	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 a ser exibido. Os valores disponíveis são WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.
start	recurring_gift_schedule.start_date	date-time	Data em que o presente recorrente deve começar.
término	recurring_gift_schedule.end_date	date-time	Data em que o presente recorrente deve terminar.
value	gift_aid_amount.value	double	Esse campo computado calcula a quantidade total qualificada de impostos recuperados do Gift Aid em todos os gift_splits deste presente. Apenas para o Reino Unido.
Status de qualificação do auxílio-presente	gift_aid_qualification_status	string	Esse campo computado determina o status de qualificação do Gift Aid com base nas informações da declaração de imposto e no formato de banco de dados. Os valores disponíveis são: Qualificado, NotQualificado e Parcialmente Qualificado. Apenas para o Reino Unido.
Código do presente	gift_code	string	O valor do código presente associado ao presente.
Divisões de presentes	gift_splits	array of GiftApi.GiftSplitRead	O conjunto de divisões de presentes associadas ao presente.
Arrecadação de fundos	fundraisers	array of GiftApi.GiftFundraiserRead	O conjunto de arrecadações 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.
Reconhecimento	acknowledgements	array of GiftApi.AcknowledgementRead	O conjunto de confirmações associadas ao presente.
Payments	payments	array of GiftApi.PaymentRead	Os pagamentos do presente.
Presentes vinculados	linked_gifts	array of string	Os identificadores de outros presentes que estão vinculados a este presente.
Data de inclusão	date_added	date-time	A data em que o presente foi criado.
Data modificada	date_modified	date-time	A data em que o presente foi modificado pela última vez.

GiftApi.GiftSplitRead

Divisão de presentes

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da divisão de presentes.
value	amount.value	double	A quantidade da divisão do presente.
ID de recurso	appeal_id	string	A ID do registro do sistema do recurso associado à divisão do presente.
ID da campanha	campaign_id	string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID do fundo	fund_id	string	A ID do registro do sistema do fundo associado à divisão de presentes.
value	gift_aid_amount.value	double	A quantidade de impostos recuperados do auxílio-presente para esta divisão de presentes. Apenas para o Reino Unido.
status de qualificação de auxílio-presente	gift_aid_qualification_status	string	O status de qualificação do auxílio-presente da divisão de presentes. Os valores disponíveis são: Qualificado e NotQualificado. Apenas para o Reino Unido.
ID do pacote	package_id	string	A ID do registro do sistema do pacote associado à divisão de presentes.

GiftApi.ReceiptRead

Recebimento

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

GiftApi.PaymentRead

Pagamento

Nome	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. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
ID de configuração do BBPS	bbps_configuration_id	string	A ID de configuração do BBPS. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
ID da transação do BBPS	bbps_transaction_id	string	A ID da transação BBPS. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
dia	check_date.d	integer	O dia na data difusa.
month	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 de verificação. Aplica-se apenas à forma de pagamento de "PersonalCheck".
ID da transação de check-out	checkout_transaction_id	string	A ID da transação de check-out. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
forma de pagamento	payment_method	string	A forma de pagamento. Os valores disponíveis estão listados abaixo.
referência	reference	string	A referência. Aplica-se apenas à forma de pagamento de "Outros".
dia	reference_date.d	integer	O dia na data difusa.
month	reference_date.m	integer	O mês na data difusa.
ano	reference_date.y	integer	O ano na data difusa.

GiftApi.SoftCreditRead

Crédito suave

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do crédito reversível.
value	amount.value	double	O valor do crédito suave.
ID do constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao crédito reversível.
ID do presente	gift_id	string	A ID do registro do sistema do presente associado ao crédito reversível.

Gift2Api.PledgeInstallment

Representa o objeto de parcelamento.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do parcelamento.
date	date	date-time	A data da parcela.
ano	year	integer	O ano da data de parcelamento.
value	amount.value	double	O valor da parcela.
saldo	balance	double	O saldo da parcela.
saldo de promessa restante	remaining_pledge_balance	double	O saldo restante da promessa.
sequência	sequence	integer	A sequência de pedidos de exibição de parcela.

Gift2Api.PledgeInstallmentCollection

Parcelas

Nome	Caminho	Tipo	Description
Data de início	start_date	date-time	A data em que a agenda de presentes começa.
Frequência	frequency	string	A frequência da agenda de presentes.
Token de simultaneidade	concurrency_token	string	Um token de simultaneidade.
Parcelas	installments	array of Gift2Api.PledgeInstallment	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

Gift2Api.PledgePayment

Representa o objeto de pagamento de promessa.

Nome	Caminho	Tipo	Description
ID de parcelamento	installment_id	string	A ID de registro do sistema da parcela que está sendo paga.
ID do presente	payment_gift_id	string	A ID do registro do sistema do presente de pagamento.
value	amount_applied.value	double	O valor aplicado à parcela.

Gift2Api.PledgePaymentCollection

Payments

Nome	Caminho	Tipo	Description
pledge_payments	pledge_payments	array of Gift2Api.PledgePayment	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftBatchApi.ApiCollectionOfGiftBatch

Lotes de presentes

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

GiftBatchApi.CreatedBatch

Lote de presentes criado

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

GiftBatchApi.GiftBatch

Representa o objeto do lote de presentes

Nome	Caminho	Tipo	Description
ID	id	string	A ID do 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.
valor projetado	projected_amount	double	O valor projetado de presentes no lote.
valor 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 foi aprovado?
Criado por	created_by	string	O nome do usuário que criou o lote.
Criado em	created_on	date-time	A data em que o lote foi criado.

NXTDataIntegrationApi.CreatedGiftNote

Anotação criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da nota recém-criada.

NXTDataIntegrationApi.CreatedGiftTribute

Tributo de presente criado

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

NXTDataIntegrationApi.CreatedTaxDeclaration

Declaração de imposto criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da declaração de imposto recém-criada.

NXTDataIntegrationApi.GiftIdMap

Mapa da ID do presente

Nome	Caminho	Tipo	Description
ID	system_record_id	integer	A ID do registro do sistema de presentes.

NXTDataIntegrationApi.GiftNote

Observação

Nome	Caminho	Tipo	Description
ID do presente	gift_id	integer	A ID do registro do sistema do presente associado à anotação.
Tipo	type	string	O tipo de anotação.
dia	date.d	integer	O dia na data difusa.
month	date.m	integer	O mês na data difusa.
ano	date.y	integer	O ano na data difusa.
Resumo	summary	string	O resumo da anotação.
Observação	text	string	O texto da anotação.
Autor	author	string	O autor da anotação.

NXTDataIntegrationApi.GiftNoteCollection

Notas sobre presentes

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of NXTDataIntegrationApi.GiftNote	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

NXTDataIntegrationApi.GiftTribute

Tributo a presentes

Nome	Caminho	Tipo	Description
ID	id	integer	A ID do registro do sistema do tributo do presente.
ID do presente	gift_id	integer	A ID do registro do sistema do presente.
ID do tributo	tribute_id	integer	A ID do registro do sistema do tributo.
Tipo de tributo	tribute_type	integer	O tipo de tributo.
Confirmar status	acknowledge	string	O status de reconhecimento do tributo de presente.
Sequence	sequence	integer	A sequência de tributo de presente.

NXTDataIntegrationApi.GiftTributeAcknowledgee

Um tributo de presente reconhece o registro em Raiser's Edge.

Nome	Caminho	Tipo	Description
ID	id	integer	A ID do registro do sistema do tributo do presente reconhece.
ID do tributo do presente	gift_tribute_id	integer	A ID do registro do sistema do tributo do presente.
É autoconhecê-lo?	self_acknowledge	boolean	Isso reconhece uma auto-confirmação?
ID de relações	relationships_id	integer	A ID do registro do sistema da relação para o reconhecimento.
Letra	letter	integer	A carta enviada ao reconhecimento.
Data da carta	letter_date	date-time	A data em que a carta foi enviada.

NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

Homenagem de presente reconhece

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of NXTDataIntegrationApi.GiftTributeAcknowledgee	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

NXTDataIntegrationApi.GiftTributeCollection

Tributos a presentes

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of NXTDataIntegrationApi.GiftTribute	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

NXTDataIntegrationApi.TaxDeclaration

Nome	Caminho	Tipo	Description
ID	declaration_id	integer
Início da declaração	declaration_starts	date-time	A data em que a declaração de imposto é iniciada.
Termina a declaração	declaration_ends	date-time	A data em que a declaração de imposto termina.
Declaração feita	declaration_made	date-time	A data em que a declaração de imposto foi feita.
ID do indicador	declaration_indicator_id	integer	A ID do indicador de declaração.
Indicator	declaration_indicator	string	O indicador de declaração.
ID de origem	declaration_source_id	integer	A ID de origem da declaração.
Source	declaration_source	string	A origem da declaração.
Confirmação enviada	confirmation_sent	date-time	A data em que a confirmação foi enviada.
Confirmação retornada	confirmation_returned	date-time	A data em que a confirmação foi retornada.
Paga imposto	constituent_pays_tax	string	Indica se o constituinte paga imposto.
Status ID	tax_payer_status_id	integer	A ID do status do contribuinte.
Situação	tax_payer_status	string	O status do contribuinte.
Comments	tax_notes	string	Comentários sobre a declaração de imposto.
Sequence	sequence	integer	A sequência numérica associada à declaração de imposto.

NXTDataIntegrationApi.TaxDeclarationCollection

Declarações fiscais

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value	value	array of NXTDataIntegrationApi.TaxDeclaration	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

Compartilhar via

Blackbaud RENXT Gifts

Pré-requisitos

Como obter credenciais?

Problemas e limitações conhecidos

Limitações

Ações

Adicionar um presente ao lote

Parâmetros

Retornos

Atualizar detalhes de confirmação do presente

Parâmetros

Atualizar detalhes do recibo do presente

Parâmetros

Atualizar um anexo de presente

Parâmetros

Atualizar um campo personalizado de presente

Parâmetros

Atualizar um reconhecimento de tributo de presente

Parâmetros

Atualizar um tributo a presentes

Parâmetros

Atualizar uma declaração de imposto constituinte

Parâmetros

Atualizar uma nota de presente

Parâmetros

Criar um anexo de presente

Parâmetros

Retornos

Criar um campo personalizado de presente

Parâmetros

Retornos

Criar um lote de presentes

Parâmetros

Retornos

Criar um pagamento de promessa

Parâmetros

Retornos

Criar um presente

Parâmetros

Retornos

Criar um presente de estoque

Parâmetros

Retornos

Criar um tributo de presente

Parâmetros

Retornos

Criar uma declaração de imposto constituinte

Parâmetros

Retornos

Criar uma nota de presente

Parâmetros

Retornos

Criar uma promessa

Parâmetros

Retornos

Listar anexos de presentes

Parâmetros

Retornos

Listar campos personalizados de presentes

Parâmetros

Retornos

Listar declarações fiscais constituintes

Parâmetros

Retornos

Listar lotes de presentes

Parâmetros

Retornos

Listar notas sobre presentes

Parâmetros

Retornos

Listar pagamentos de promessas

Parâmetros

Retornos

Listar parcelas de promessa

Parâmetros

Retornos

Listar presentes

Parâmetros

Retornos