Presentes Blackbaud RENXT
O Edge NXT da Blackbaud Raiser é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social. Use o conector Presentes para gerenciar presentes.
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 |
| 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 presentes e entidades relacionadas encontradas no The Raiser's Edge NXT, incluindo:
- Presentes e sumários de doação de constituintes
- Lotes de presentes
- Recibos
- Agradecimentos
- e mais...
Para mais informações, consulte a documentação.
Pré-requisitos
Para usar esse conector, você deve ter uma conta Blackbaud ID com acesso a um ou mais ambientes Blackbaud.
Além disso, o administrador da sua organização também deve executar uma ação de nível de administrador dentro do sistema para permitir que esse conector acesse seu ambiente Blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de configuração inicial .
Como obter credenciais?
O administrador da sua organização enviará um convite para o ambiente Raiser's Edge NXT da organização e configurará as permissões da sua conta de utilizador no ambiente. Não são necessárias credenciais adicionais para usar esse conector.
Problemas conhecidos e limitações
O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às suas permissões de usuário dentro do ambiente.
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar um presente ao lote |
Adicione um presente ao lote de presente especificado. |
| 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 anexo de presente |
Atualiza um anexo de presente. |
| Atualizar um campo personalizado de presente |
Atualiza um campo personalizado 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. |
| Atualize um agradecimento de homenagem de presente |
Atualiza um reconhecimento de homenagem de presente. |
| Atualize um tributo de presente |
Atualiza um tributo 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 compromisso |
Cria um novo compromisso. |
| Criar um lote de presente |
Cria um novo lote de presente. |
| Criar um pagamento de penhor |
Cria um novo pagamento de penhor. |
| 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 de Gift Aid para um constituinte. |
| Criar uma nota de presente |
Cria uma nova nota de presente. |
| Lista de homenagens a presentes reconhece |
Liste os agradecimentos por um tributo de presente. |
| Listar anexos de presentes |
Lista os anexos de um presente. |
| Listar as 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 campos personalizados de presentes |
Lista os campos personalizados de um presente. |
| Listar homenagens de presentes |
Lista as homenagens para um presente. |
| Listar lotes de presentes |
Liste os lotes de presente. |
| Listar notas de presente |
Lista as notas para um presente. |
| Listar pagamentos de penhor |
Lista os pagamentos de um penhor. |
| Listar parcelas de penhor |
Lista as parcelas de um penhor. |
| Listar presentes |
Devolve uma lista de presentes. |
| 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. |
| 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 presente |
Retorna informações sobre um presente. |
| Receba um presente por ID de pesquisa |
Retorna o ID de registro do sistema de um presente do ID de pesquisa especificado. |
| Venda um presente de ações |
Atualiza um presente de estoque para vender. |
Adicionar um presente ao lote
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 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 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 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 detalhes de confirmação do presente
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
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. |
|
|
Montante
|
value | double |
O valor do recibo. |
|
|
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 anexo de presente
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. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Atualizar um campo personalizado de presente
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 uma declaração de imposto constituinte
Atualiza uma declaração de imposto constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da declaração fiscal
|
tax_declaration_id | True | integer |
O ID de registo do sistema da declaração fiscal a atualizar. |
|
Início da declaração
|
declaration_starts | date-time |
A data de início da declaração fiscal (ex: '2020-09-18T04:13:56Z'). |
|
|
Fim da declaração
|
declaration_ends | date-time |
A data de término da declaração fiscal (ex: '2020-09-18T04:13:56Z'). |
|
|
Declaração feita
|
declaration_made | date-time |
A data em que a declaração fiscal foi feita (ex: '2020-09-18T04:13:56Z'). |
|
|
Indicator
|
declaration_indicator | string |
O indicador de declaração. |
|
|
Fonte
|
declaration_source | string |
A fonte da declaração. |
|
|
Confirmação enviada
|
confirmation_sent | date-time |
A data em que a confirmação foi enviada (ex: '2020-09-18T04:13:56Z'). |
|
|
Confirmação devolvida
|
confirmation_returned | date-time |
A data em que a confirmação foi devolvida (ex: '2020-09-18T04:13:56Z'). |
|
|
Paga imposto
|
constituent_pays_tax | string |
Indica se o constituinte paga imposto. |
|
|
Situação
|
tax_payer_status | string |
O estatuto de contribuinte. |
|
|
Comments
|
tax_notes | string |
Comentários à declaração fiscal. |
|
|
Sequence
|
sequence | integer |
A sequência numérica associada à declaração de imposto. |
Atualizar uma nota de presente
Atualiza uma nota de presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da nota
|
id | True | integer |
O ID de registro do sistema da nota a ser atualizada. |
|
Tipo
|
note_type_id | integer |
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: 255. |
|
|
Observação
|
text | string |
O texto da nota. |
|
|
Author
|
author | string |
O autor da nota. Limite de caracteres: 50. |
Atualize um agradecimento de homenagem de presente
Atualiza um reconhecimento de homenagem de presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de reconhecimento do tributo do presente
|
gift_tribute_acknowledgee_id | True | integer |
O ID de registro do sistema do tributo do presente confirma a atualização. |
|
Carta
|
letter | integer |
A carta enviada ao reconhecimento. |
|
|
Data da carta
|
letter_date | date-time |
A data em que a carta foi enviada. |
Atualize um tributo de presente
Atualiza um tributo de presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo do presente
|
gift_tribute_id | True | integer |
O ID de registro do sistema do tributo de presente a ser atualizado. |
|
Tipo de tributo
|
tribute_type | integer |
O tipo de homenagem. |
|
|
Reconhecer status
|
acknowledge | string |
O tributo do presente reconhece status. |
Criar um anexo de presente
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. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Devoluções
Acessório de presente criado
Criar um campo personalizado de presente
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
Criar um compromisso
Cria um novo compromisso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
id | True | string |
O ID de registo do sistema do constituinte. |
|
Montante
|
value | True | double |
O montante do penhor. |
|
Date
|
gift_date | True | date |
A data do compromisso (ex: '2020-09-18'). |
|
Frequência
|
frequency | True | string |
A periodicidade do parcelamento do penhor. |
|
# de parcelas
|
number_of_installments | True | integer |
O número de parcelas do penhor. |
|
Data de início
|
start_date | True | date |
A data de início do cronograma de promessa. |
|
Montante
|
value | True | double |
O valor do presente dividido. |
|
ID do fundo
|
fund_id | True | string |
O ID de registro do sistema do fundo 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 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. |
|
|
Método de pagamento
|
method | True | string |
O método de pagamento. |
|
Número do cheque
|
check_number | string |
O número do cheque. |
|
|
Reference
|
reference_number | string |
A referência de pagamento (aplicável apenas quando o método de pagamento é "Outros"). |
|
|
Enviar lembrete?
|
send_reminder | boolean |
Enviar lembretes de compromisso? |
|
|
É anónimo?
|
anonymous | boolean |
O presente é anónimo? Se nenhum valor for fornecido, será usado o anonimato padrão do doador. |
|
|
Subtipo
|
name | string |
O subtipo do presente. |
|
|
Comment
|
comments | string |
Notas 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 de presente
|
value | string |
O código de presente associado ao presente. |
|
|
Círculo eleitoral
|
value | string |
O eleitorado da dádiva. |
|
|
Estado da publicação
|
gift_post_status | string |
O status do post do presente. |
|
|
Data de publicação
|
gift_post_date | date |
A data em que o presente deve ser publicado (ex: '2020-09-18'). |
|
|
Situação
|
gift_status | string |
O status do compromisso. |
|
|
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. |
|
|
Estado do recibo
|
receipt_status | True | string |
O status de recebimento do presente. |
|
Valor do recibo
|
value | True | double |
O valor do recibo do presente. |
|
Data do recibo
|
receipt_date | date |
A data em que o presente foi recebido (ex: '2020-09-18'). |
|
|
Número do recibo
|
receipt_number | integer |
O número do recibo. |
|
|
Pilha de recibos
|
value | string |
A pilha de recibos. |
|
|
Reconhecer status
|
status | True | string |
O status de reconhecimento do presente. |
|
Reconhecer data
|
acknowledgement_date | date |
A data em que o presente foi reconhecido (ex: '2020-09-18'). |
|
|
Carta
|
value | string |
A carta associada ao reconhecimento. |
|
|
tipo
|
credit_type | True | string |
O tipo de crédito de reconhecimento. |
|
ID do destinatário
|
constituent_id | True | string |
O ID de registro do sistema do destinatário do crédito de reconhecimento. |
|
Montante
|
value | True | double |
O valor creditado ao destinatário. |
|
date
|
date | date |
A data do parcelamento (ex: '2020-09-18'). |
|
|
Montante
|
amount | double |
O valor da prestação. |
Devoluções
Presente criado
- Body
- GiftApi.CreatedGift
Criar um lote de presente
Cria um novo lote de presente.
Parâmetros
| Name | Chave | Necessário | 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
Criar um pagamento de penhor
Cria um novo pagamento de penhor.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
id | True | string |
O ID de registo do sistema do constituinte. |
|
Montante
|
value | True | double |
O montante do pagamento do penhor. |
|
Date
|
gift_date | True | date |
A data de pagamento do compromisso (ex: '2020-09-18'). |
|
Montante
|
value | True | double |
O valor do presente dividido. |
|
ID do fundo
|
fund_id | True | string |
O ID de registro do sistema do fundo 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 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. |
|
|
Método de pagamento
|
method | True | string |
O método de pagamento. |
|
Número do cheque
|
check_number | string |
O número do cheque. |
|
|
Reference
|
reference_number | string |
A referência de pagamento (aplicável apenas quando o método de pagamento é "Outros"). |
|
|
É anónimo?
|
anonymous | boolean |
O presente é anónimo? Se nenhum valor for fornecido, será usado o anonimato padrão do doador. |
|
|
Compromisso
|
pledge_id | string |
O sistema regista o ID do penhor que está a ser pago. |
|
|
parcelamento
|
installment_id | string |
O ID de registro do sistema da parcela que está sendo paga. |
|
|
Montante
|
amount_applied | double |
O valor aplicado à prestação. |
|
|
Subtipo
|
name | string |
O subtipo do presente. |
|
|
Comment
|
comments | string |
Notas 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 de presente
|
value | string |
O código de presente associado ao presente. |
|
|
Círculo eleitoral
|
value | string |
O eleitorado da dádiva. |
|
|
Estado da publicação
|
gift_post_status | string |
O status do post do presente. |
|
|
Data de publicação
|
gift_post_date | date |
A data em que o presente deve ser publicado (ex: '2020-09-18'). |
|
|
Estado do recibo
|
receipt_status | True | string |
O status de recebimento do presente. |
|
Valor do recibo
|
value | True | double |
O valor do recibo do presente. |
|
Data do recibo
|
receipt_date | date |
A data em que o presente foi recebido (ex: '2020-09-18'). |
|
|
Número do recibo
|
receipt_number | integer |
O número do recibo. |
|
|
Pilha de recibos
|
value | string |
A pilha de recibos. |
|
|
Reconhecer status
|
status | True | string |
O status de reconhecimento do presente. |
|
Reconhecer data
|
acknowledgement_date | date |
A data em que o presente foi reconhecido (ex: '2020-09-18'). |
|
|
Carta
|
value | string |
A carta associada ao reconhecimento. |
|
|
tipo
|
credit_type | True | string |
O tipo de crédito de reconhecimento. |
|
ID do destinatário
|
constituent_id | True | string |
O ID de registro do sistema do destinatário do crédito de reconhecimento. |
|
Montante
|
value | True | double |
O valor creditado ao destinatário. |
Devoluções
Presente criado
- Body
- GiftApi.CreatedGift
Criar um presente
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 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 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 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 presente de estoque
Cria um novo presente de estoque.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
id | True | string |
O ID de registo do sistema do constituinte. |
|
Montante
|
value | True | double |
O valor do presente. |
|
Date
|
gift_date | True | date |
A data do presente (ex: '2020-09-18'). |
|
Issuer
|
issuer | string |
O emissor de 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 mediano por unidade
|
unit_price | double |
O preço mediano por unidade. |
|
|
Montante
|
value | True | double |
O valor do presente dividido. |
|
ID do fundo
|
fund_id | True | string |
O ID de registro do sistema do fundo 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 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. |
|
|
Método de pagamento
|
method | True | string |
O método de pagamento. |
|
Número do cheque
|
check_number | string |
O número do cheque. |
|
|
Reference
|
reference_number | string |
A referência de pagamento (aplicável apenas quando o método de pagamento é "Outros"). |
|
|
É anónimo?
|
anonymous | boolean |
O presente é anónimo? Se nenhum valor for fornecido, será usado o anonimato padrão do doador. |
|
|
Subtipo
|
name | string |
O subtipo do presente. |
|
|
Comment
|
comments | string |
Notas 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 de presente
|
value | string |
O código de presente associado ao presente. |
|
|
Círculo eleitoral
|
value | string |
O eleitorado da dádiva. |
|
|
Estado da publicação
|
gift_post_status | string |
O status do post do presente. |
|
|
Data de publicação
|
gift_post_date | date |
A data em que o presente deve ser publicado (ex: '2020-09-18'). |
|
|
Estado do recibo
|
receipt_status | True | string |
O status de recebimento do presente. |
|
Valor do recibo
|
value | True | double |
O valor do recibo do presente. |
|
Data do recibo
|
receipt_date | date |
A data em que o presente foi recebido (ex: '2020-09-18'). |
|
|
Número do recibo
|
receipt_number | integer |
O número do recibo. |
|
|
Pilha de recibos
|
value | string |
A pilha de recibos. |
|
|
Reconhecer status
|
status | True | string |
O status de reconhecimento do presente. |
|
Reconhecer data
|
acknowledgement_date | date |
A data em que o presente foi reconhecido (ex: '2020-09-18'). |
|
|
Carta
|
value | string |
A carta associada ao reconhecimento. |
|
|
tipo
|
credit_type | True | string |
O tipo de crédito de reconhecimento. |
|
ID do destinatário
|
constituent_id | True | string |
O ID de registro do sistema do destinatário do crédito de reconhecimento. |
|
Montante
|
value | True | double |
O valor creditado ao destinatário. |
Devoluções
Presente criado
- Body
- GiftApi.CreatedGift
Criar um tributo de presente
Cria um novo tributo de presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de presente
|
gift_id | True | integer |
O sistema registra o ID do presente associado ao tributo do presente. |
|
ID do tributo
|
tribute_id | True | integer |
O sistema registra o ID do tributo associado ao tributo. |
Devoluções
Homenagem de presente criada
Criar uma declaração de imposto constituinte
Cria uma nova declaração fiscal de Gift Aid para um constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | integer |
O ID de registo do sistema do constituinte. |
|
Início da declaração
|
declaration_starts | True | date-time |
A data de início da declaração fiscal (ex: '2020-09-18T04:13:56Z'). |
|
Fim da declaração
|
declaration_ends | date-time |
A data de término da declaração fiscal (ex: '2020-09-18T04:13:56Z'). |
|
|
Declaração feita
|
declaration_made | date-time |
A data em que a declaração fiscal foi feita (ex: '2020-09-18T04:13:56Z'). |
|
|
Indicator
|
declaration_indicator | string |
O indicador de declaração. |
|
|
Fonte
|
declaration_source | string |
A fonte da declaração. |
|
|
Confirmação enviada
|
confirmation_sent | date-time |
A data em que a confirmação foi enviada (ex: '2020-09-18T04:13:56Z'). |
|
|
Confirmação devolvida
|
confirmation_returned | date-time |
A data em que a confirmação foi devolvida (ex: '2020-09-18T04:13:56Z'). |
|
|
Paga imposto
|
constituent_pays_tax | string |
Indica se o constituinte paga imposto. |
|
|
Situação
|
tax_payer_status | string |
O estatuto de contribuinte. |
|
|
Comments
|
tax_notes | string |
Comentários à declaração fiscal. |
|
|
Sequence
|
sequence | integer |
A sequência numérica associada à declaração de imposto. |
Devoluções
Declaração de imposto criada
Criar uma nota de presente
Cria uma nova nota de presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de presente
|
gift_id | True | integer |
O ID de registro do sistema do presente associado à nota. |
|
Tipo
|
note_type_id | True | integer |
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: 255. |
|
|
Observação
|
text | string |
O texto da nota. |
|
|
Author
|
author | string |
O autor da nota. Limite de caracteres: 50. |
Devoluções
Nota criada
Lista de homenagens a presentes reconhece
Liste os agradecimentos por um tributo de presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo do presente
|
gift_tribute_id | True | integer |
O sistema registra o ID do tributo do presente. |
Devoluções
Homenagem ao presente reconhece
Listar anexos de presentes
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
Listar as declarações fiscais constituintes
Lista as declarações fiscais do Gift Aid para um constituinte (aplicável apenas para versões do Reino Unido).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | integer |
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
Declarações fiscais
Listar campos personalizados de presentes
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
Listar homenagens de presentes
Lista as homenagens para um presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de presente
|
gift_id | True | integer |
O ID de registro do sistema do presente. |
Devoluções
Homenagens de presentes
Listar lotes de presentes
Liste os lotes de presente.
Parâmetros
| Name | Chave | Necessário | 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
Listar notas de presente
Lista as notas para um presente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de presente
|
gift_id | True | integer |
O ID de registro do sistema do presenteado. |
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
Devoluções
Notas de presente
Listar pagamentos de penhor
Lista os pagamentos de um penhor.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do compromisso
|
gift_id | True | string |
O ID de registo do sistema do compromisso. |
Devoluções
Payments
Listar parcelas de penhor
Lista as parcelas de um penhor.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do compromisso
|
gift_id | True | string |
O ID de registo do sistema do compromisso. |
Devoluções
Parcelamento
Listar presentes
Devolve uma lista de presentes.
Parâmetros
| Name | Chave | Necessário | 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 IDs de registro do sistema constituinte 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 IDs de registro do sistema 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 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 do recurso
|
appeal_id | string |
Representa uma lista separada por vírgulas de IDs de registro do sistema 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. |
|
|
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,-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 ao URL next_link para garantir que os presentes sejam classificados de forma estável. |
|
|
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
Obtenha a doação vitalícia do constituinte
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
Obtenha o último presente do constituinte
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
Receba o maior presente do constituinte
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
Receba o primeiro presente do constituinte
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
Receba um presente
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 presente por ID de pesquisa
Retorna o ID de registro do sistema de um presente do ID de pesquisa especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de pesquisa
|
giftlookupid | True | string |
O ID de pesquisa do presente. |
Devoluções
Mapa de ID de presente
Venda um presente de ações
Atualiza um presente de estoque para vender.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de presente
|
gift_id | True | string |
O ID de registro do sistema do presente de estoque para vender. |
|
Data de venda
|
stock_sale_date | True | date |
A data em que as ações foram vendidas (ex: '2005-09-18'). |
|
Valor de venda
|
stock_sale_value | True | double |
O valor da venda de ações. |
|
Taxa de corretagem
|
broker_fee | double |
A taxa de corretagem de ações vendida. |
|
|
Estado da publicação
|
post_status | string |
O status do post do presente vendido. |
|
|
Data de publicação
|
post_date | date |
A data de publicação do stock vendido (ex: '2020-09-18'). |
|
|
Observações
|
notes | string |
As notas para o estoque vendido. Limite de caracteres: 255. |
|
|
Issuer
|
issuer | string |
O emissor de 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 mediano por unidade
|
unit_price | double |
O preço mediano por unidade vendida. |
Definições
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.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 do presente. |
|
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. |
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 montante total dado pelo constituinte. |
|
valor
|
total_pledge_balance.value | double |
O saldo total do penhor não pago para o constituinte. |
|
valor
|
total_received_giving.value | double |
O montante total recebido dado pelo constituinte. |
|
valor
|
total_committed_matching_gifts.value | double |
Este campo calculado calcula o montante total de compromissos de doação correspondentes atribuídos ao constituinte. |
|
valor
|
total_received_matching_gifts.value | double |
O montante total dos pagamentos relativos a promessas de doação correspondentes atribuídos ao constituinte. |
|
valor
|
total_soft_credits.value | double |
O montante total dos créditos em condições favoráveis aplicados ao constituinte. |
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 do presente. |
|
valor
|
balance.value | double |
O saldo remanescente no presente. |
|
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 |
Este campo calculado calcula o valor total qualificado do imposto recuperado do Gift Aid em todos os gift_splits para este presente. Apenas para o Reino Unido. |
|
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. |
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
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. |
|
|
Valor do texto
|
text_value | string |
O valor de texto do campo personalizado. |
|
Valor do número
|
number_value | integer |
O valor numérico do campo personalizado. |
|
Valor da data
|
date_value | date |
O valor de data do campo personalizado. |
|
Valor da moeda
|
currency_value | double |
O valor da moeda do campo personalizado. |
|
Valor booleano
|
boolean_value | boolean |
O valor booleano do campo personalizado. |
|
Valor de entrada da tabela
|
codetableentry_value | string |
O valor de entrada de tabela do campo personalizado. |
|
Valor da ID do constituinte
|
constituentid_value | string |
O valor de ID do constituinte do campo personalizado. |
|
day
|
fuzzydate_value.d | integer |
O dia na data difusa. |
|
mês
|
fuzzydate_value.m | integer |
O mês na data difusa. |
|
ano
|
fuzzydate_value.y | integer |
O ano na data difusa. |
|
Date
|
date | date |
A data no campo personalizado. |
|
Comment
|
comment | string |
O comentário no campo personalizado. Limite de caracteres: 50. |
|
Data de adição
|
date_added | date-time |
A data em que o campo personalizado foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o campo personalizado foi modificado pela última vez. |
GiftApi.GiftFundraiserLeia
Angariação de fundos para presentes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
valor
|
amount.value | double |
O valor creditado à angariação de fundos para o presente. |
|
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 do presente. |
|
valor
|
balance.value | double |
O saldo remanescente no presente. |
|
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 |
Este campo calculado calcula o valor total qualificado do imposto recuperado do Gift Aid em todos os gift_splits para este presente. Apenas para o Reino Unido. |
|
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 do presente dividido. |
|
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 do imposto recuperado do auxílio presente para esta doação dividida. Apenas para o Reino Unido. |
|
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 do recibo. |
|
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 montante do crédito em condições favoráveis. |
|
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. |
Gift2Api.PledgeInstallment
Representa o objeto installment.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema da parcela. |
|
date
|
date | date-time |
A data do parcelamento. |
|
ano
|
year | integer |
O ano da data do parcelamento. |
|
valor
|
amount.value | double |
O valor da prestação. |
|
saldo
|
balance | double |
O saldo da prestação. |
|
saldo remanescente do penhor
|
remaining_pledge_balance | double |
O saldo remanescente do penhor. |
|
sequência
|
sequence | integer |
A sequência de ordem de exibição de parcelamento. |
Gift2Api.PledgeInstallmentCollection
Parcelamento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Data de início
|
start_date | date-time |
A data em que o cronograma 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. |
|
parcelamento
|
installments | array of Gift2Api.PledgeInstallment |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Gift2Api.PledgePagamento
Representa o objeto de pagamento de penhor.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da parcela
|
installment_id | string |
O ID de registro do sistema da parcela que está sendo paga. |
|
ID do presente
|
payment_gift_id | string |
O ID de registro do sistema do presente de pagamento. |
|
valor
|
amount_applied.value | double |
O valor aplicado à prestação. |
Gift2Api.PledgePaymentCollection
Payments
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pledge_payments
|
pledge_payments | array of Gift2Api.PledgePayment |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
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. |
NXTDataIntegrationApi.CreatedGiftNote
Nota criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da nota recém-criada. |
NXTDataIntegrationApi.CreatedGiftTribute
Homenagem de presente criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do tributo de presente recém-criado. |
NXTDataIntegrationApi.CreatedTaxDeclaration
Declaração de imposto criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da declaração de imposto recém-criada. |
NXTDataIntegrationApi.GiftIdMap
Mapa de ID de presente
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
system_record_id | integer |
O ID de registro do sistema de presente. |
NXTDataIntegrationApi.GiftNote
Observação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID de presente
|
gift_id | integer |
O ID de registro do sistema do presente 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. |
|
Author
|
author | string |
O autor da nota. |
NXTDataIntegrationApi.GiftNoteCollection
Notas de presente
| 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 NXTDataIntegrationApi.GiftNote |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
NXTDataIntegrationApi.GiftTribute
Presente de homenagem
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O sistema registra o ID do tributo do presente. |
|
ID de presente
|
gift_id | integer |
O ID de registro do sistema do presente. |
|
ID do tributo
|
tribute_id | integer |
O ID de registro do sistema do tributo. |
|
Tipo de tributo
|
tribute_type | integer |
O tipo de homenagem. |
|
Reconhecer status
|
acknowledge | string |
O tributo do presente reconhece status. |
|
Sequence
|
sequence | integer |
A sequência do tributo ao presente. |
NXTDataIntegrationApi.GiftTributeAcknowledgee
Um presente de homenagem ao recorde de reconhecimento em Raiser's Edge.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O sistema registra o ID do reconhecimento do tributo do presente. |
|
ID do tributo do presente
|
gift_tribute_id | integer |
O sistema registra o ID do tributo do presente. |
|
É autorreconhecimento?
|
self_acknowledge | boolean |
Este reconhecimento é um autorreconhecimento? |
|
ID de relacionamentos
|
relationships_id | integer |
O ID de registro do sistema da relação para o reconhecimento. |
|
Carta
|
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 ao presente reconhece
| 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 NXTDataIntegrationApi.GiftTributeAcknowledgee |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
NXTDataIntegrationApi.GiftTributeCollection
Homenagens de 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 NXTDataIntegrationApi.GiftTribute |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
NXTDataIntegrationApi.TaxDeclaration
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
declaration_id | integer | |
|
Início da declaração
|
declaration_starts | date-time |
A data de início da declaração de imposto. |
|
Fim da declaração
|
declaration_ends | date-time |
A data de término da declaração de imposto. |
|
Declaração feita
|
declaration_made | date-time |
A data em que a declaração fiscal foi feita. |
|
ID do indicador
|
declaration_indicator_id | integer |
O ID do indicador de declaração. |
|
Indicator
|
declaration_indicator | string |
O indicador de declaração. |
|
ID de origem
|
declaration_source_id | integer |
O ID de origem da declaração. |
|
Fonte
|
declaration_source | string |
A fonte da declaração. |
|
Confirmação enviada
|
confirmation_sent | date-time |
A data em que a confirmação foi enviada. |
|
Confirmação devolvida
|
confirmation_returned | date-time |
A data em que a confirmação foi devolvida. |
|
Paga imposto
|
constituent_pays_tax | string |
Indica se o constituinte paga imposto. |
|
Status ID
|
tax_payer_status_id | integer |
O ID do status do contribuinte. |
|
Situação
|
tax_payer_status | string |
O estatuto de contribuinte. |
|
Comments
|
tax_notes | string |
Comentários à declaração fiscal. |
|
Sequence
|
sequence | integer |
A sequência numérica associada à declaração de imposto. |
NXTDataIntegrationApi.TaxDeclarationCollection
Declarações fiscais
| 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 NXTDataIntegrationApi.TaxDeclaration |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |