Angariação de fundos Blackbaud Raisers Edge NXT
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 de arrecadação de fundos para gerenciar campanhas, fundos, recursos e pacotes.
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 entidades de arrecadação de fundos encontradas no The Raiser's Edge NXT, incluindo:
- Campaigns
- Fundos
- Recursos
- Packages
- 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
| Atualizar um anexo de campanha |
Atualiza um anexo de campanha. |
| Atualizar um anexo de fundo |
Atualiza um anexo de fundo. |
| Atualizar um anexo de recurso |
Atualiza um anexo de recurso. |
| Atualizar um campo personalizado de campanha |
Atualiza um campo personalizado de campanha. |
| Atualizar um campo personalizado de recurso |
Atualiza um campo personalizado de recurso. |
| Atualizar um campo personalizado do fundo |
Atualiza um campo personalizado do fundo. |
| Atualizar um fundo |
Atualiza um fundo. |
| Atualizar um recurso |
Atualiza um recurso. |
| Atualizar um recurso constituinte |
Atualiza um recurso constituinte. |
| Atualizar uma campanha |
Atualiza uma campanha. |
| Criar um anexo de campanha |
Cria um novo anexo de campanha. |
| Criar um anexo de fundo |
Cria uma nova penhora de fundo. |
| Criar um anexo de recurso |
Cria um novo anexo de recurso. |
| Criar um campo personalizado de campanha |
Cria um novo campo personalizado de campanha. |
| Criar um campo personalizado de fundo |
Cria um novo campo personalizado de fundo. |
| Criar um campo personalizado de recurso |
Cria um novo campo personalizado de recurso. |
| Criar um fundo |
Cria um novo fundo. |
| Criar um recurso |
Cria um novo recurso. |
| Criar um recurso constituinte |
Cria um novo apelo constituinte. |
| Criar uma campanha |
Cria uma nova campanha. |
| Listar anexos de campanha |
Lista os anexos de uma campanha. |
| Listar anexos de fundos |
Lista os anexos de um fundo. |
| Listar anexos de recurso |
Lista os anexos para um recurso. |
| Listar campanhas |
Retorna uma lista de campanhas. |
| Listar campos personalizados da campanha |
Lista os campos personalizados de uma campanha. |
| Listar campos personalizados de recurso |
Lista os campos personalizados para um recurso. |
| Listar campos personalizados do fundo |
Lista os campos personalizados de um fundo. |
| Listar fundos |
Devolve uma lista de fundos. |
| Listar pacotes |
Retorna uma lista de pacotes. |
| Listar recursos |
Devolve uma lista de recursos. |
| Listar recursos constituintes |
Enumera os recursos para um constituinte. |
| Listar relações com fundos constituintes |
Lista as relações de fundo para um constituinte. |
| Listar relações entre os constituintes do fundo |
Lista as relações constituintes de um fundo. |
| Obtenha um pacote |
Retorna informações sobre um pacote. |
| Obter um fundo |
Devolve informações sobre um fundo. |
| Receba um recurso |
Retorna informações sobre um recurso. |
| Receba uma campanha |
Retorna informações sobre uma campanha. |
Atualizar um anexo de campanha
Atualiza um anexo de campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | string |
O ID de registro do sistema do anexo a ser atualizado. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Atualizar um anexo de fundo
Atualiza um anexo de fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | string |
O ID de registro do sistema do anexo a ser atualizado. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Atualizar um anexo de recurso
Atualiza um anexo de recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | string |
O ID de registro do sistema do anexo a ser atualizado. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Atualizar um campo personalizado de campanha
Atualiza um campo personalizado de campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do campo personalizado
|
custom_field_id | True | string |
O ID de registro do sistema do campo personalizado a ser atualizado. |
|
body
|
body | True | dynamic |
Um objeto que representa as propriedades do campo personalizado a ser atualizado. |
Atualizar um campo personalizado de recurso
Atualiza um campo personalizado de recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do campo personalizado
|
custom_field_id | True | string |
O ID de registro do sistema do campo personalizado a ser atualizado. |
|
body
|
body | True | dynamic |
Um objeto que representa as propriedades do campo personalizado a ser atualizado. |
Atualizar um campo personalizado do fundo
Atualiza um campo personalizado do fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do campo personalizado
|
custom_field_id | True | string |
O ID de registro do sistema do campo personalizado a ser atualizado. |
|
body
|
body | True | dynamic |
Um objeto que representa as propriedades do campo personalizado a ser atualizado. |
Atualizar um fundo
Atualiza um fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Fundo
|
id | True | integer |
O ID de registo do sistema do fundo a atualizar. |
|
ID de pesquisa
|
fund_id | string |
O identificador definido pelo utilizador para o fundo. |
|
|
Description
|
description | string |
A descrição do fundo. |
|
|
Data de início
|
start_date | date |
Data de início do fundo (ex: «2005-09-18»). |
|
|
Data de fim
|
end_date | date |
A data-limite para o fundo (ex: «2005-09-18»). |
|
|
Categoria
|
fund_category_id | integer |
A categoria do fundo. |
|
|
Tipo
|
fund_type_id | integer |
O tipo de fundo. |
|
|
Objetivo
|
goal | double |
O valor-alvo a angariar para o fundo. |
|
|
Observações
|
notes | string |
As notas associadas ao fundo. |
|
|
Restrito?
|
restricted | boolean |
O fundo é restrito a usuários específicos? |
|
|
Inativo?
|
inactive | boolean |
O fundo está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
|
|
ID da Campanha
|
campaign_id | integer |
O ID de uma campanha associada ao fundo. |
|
|
ID de recurso padrão
|
default_appeal_id | integer |
O ID do recurso por defeito associado ao fundo. |
Atualizar um recurso
Atualiza um recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do recurso
|
id | True | integer |
O ID de registro do sistema do recurso a ser atualizado. |
|
ID de pesquisa
|
appeal_id | string |
O identificador definido pelo usuário para o recurso. |
|
|
Description
|
description | string |
A descrição do recurso. |
|
|
Data de início
|
start_date | date |
Data de início do recurso (ex: «2005-09-18»). |
|
|
Data de fim
|
end_date | date |
Data final do recurso (ex: «2005-09-18»). |
|
|
Categoria
|
appeal_category_id | integer |
A categoria de recurso. |
|
|
Objetivo
|
goal | double |
O valor-alvo a angariar através do recurso. |
|
|
Valor padrão do presente
|
default_gift_amount | double |
O valor monetário do presente padrão. O padrão dessa propriedade é 0,00 se nenhum valor for especificado. |
|
|
Número solicitado
|
number_solicited | integer |
O número de constituintes requeridos no recurso. |
|
|
Observações
|
notes | string |
As notas associadas ao recurso. |
|
|
ID de campanha padrão
|
campaign_id | integer |
O ID de uma campanha associada ao recurso. |
|
|
ID do fundo de proteção por defeito
|
default_fund_id | integer |
O ID do fundo de proteção associado ao recurso. |
|
|
Inativo?
|
inactive | boolean |
O recurso está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
Atualizar um recurso constituinte
Atualiza um recurso constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Recurso constituinte ID
|
id | True | integer |
O ID de registro do sistema do recurso constituinte para atualização. |
|
Descrição do recurso
|
appeal_description | string |
A descrição do recurso; usado para procurar o ID do registro de recurso. |
|
|
Descrição do pacote
|
package_description | string |
A descrição do pacote; usado para procurar o ID de registro do pacote. |
|
|
Date
|
appeal_date | date |
A data do recurso constituinte (ex: «2005-09-18»). |
|
|
Resposta
|
response_description | string |
A longa descrição da resposta para o recurso constituinte. |
|
|
Segmento de marketing
|
marketing_segment | string |
O segmento de marketing associado ao apelo constituinte. |
|
|
Código fonte de marketing
|
marketing_source_code | string |
O código-fonte de marketing associado ao recurso constituinte. |
|
|
ID para correspondência
|
mailing_id | integer |
O documento de identificação do recurso constituinte. |
|
|
Número do localizador
|
market_finder_number | string |
O número do localizador de mercado associado ao recurso constituinte. |
|
|
Comments
|
comments | string |
Os comentários associados ao recurso constituinte. |
Atualizar uma campanha
Atualiza uma campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
id | True | integer |
O ID de registro do sistema da campanha a ser atualizada. |
|
ID de pesquisa
|
campaign_id | string |
O identificador definido pelo usuário para a campanha. |
|
|
Description
|
description | string |
A descrição da campanha. |
|
|
Data de início
|
start_date | date |
A data de início da campanha (ex: '2005-09-18'). |
|
|
Data de fim
|
end_date | date |
A data final da campanha (ex: '2005-09-18'). |
|
|
Categoria
|
campaign_category_id | integer |
A categoria da campanha. |
|
|
Objetivo
|
goal | double |
O valor alvo a angariar através da campanha. |
|
|
Observações
|
notes | string |
As notas associadas à campanha. |
|
|
Inativo?
|
inactive | boolean |
A campanha está inativa (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de fim)? |
|
|
ID do fundo de proteção por defeito
|
default_fund_id | integer |
O ID do fundo padrão associado à campanha. |
Criar um anexo de campanha
Cria um novo anexo de campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
parent_id | True | string |
O ID de registo do sistema da campanha associado ao anexo. |
|
Tipo
|
type | True | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). Este campo assume como padrão a data e hora atuais se não for fornecido. |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Devoluções
Anexo de campanha criado
Criar um anexo de fundo
Cria uma nova penhora de fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Fundo
|
parent_id | True | string |
O ID de registo do sistema do fundo associado à penhora. |
|
Tipo
|
type | True | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). Este campo assume como padrão a data e hora atuais se não for fornecido. |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Devoluções
Penhora de fundo criada
Criar um anexo de recurso
Cria um novo anexo de recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do recurso
|
parent_id | True | string |
O ID de registo do sistema do recurso associado à penhora. |
|
Tipo
|
type | True | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (ex: '2020-09-18T04:13:56Z'). Este campo assume como padrão a data e hora atuais se não for fornecido. |
|
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Devoluções
Recurso criado
Criar um campo personalizado de campanha
Cria um novo campo personalizado de campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Um objeto que representa o campo personalizado a ser criado. |
Devoluções
Campo personalizado de campanha criado
Criar um campo personalizado de fundo
Cria um novo campo personalizado de fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Um objeto que representa o campo personalizado a ser criado. |
Devoluções
Campo personalizado do fundo criado
Criar um campo personalizado de recurso
Cria um novo campo personalizado de recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Um objeto que representa o campo personalizado a ser criado. |
Devoluções
Campo personalizado de recurso criado
Criar um fundo
Cria um novo fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de pesquisa
|
fund_id | True | string |
O identificador definido pelo utilizador para o fundo. |
|
Description
|
description | True | string |
A descrição do fundo. |
|
Data de início
|
start_date | date |
Data de início do fundo (ex: «2005-09-18»). |
|
|
Data de fim
|
end_date | date |
A data-limite para o fundo (ex: «2005-09-18»). |
|
|
Categoria
|
fund_category_id | integer |
A categoria do fundo. |
|
|
Tipo
|
fund_type_id | integer |
O tipo de fundo. |
|
|
Objetivo
|
goal | double |
O valor-alvo a angariar para o fundo. |
|
|
Observações
|
notes | string |
As notas associadas ao fundo. |
|
|
Restrito?
|
restricted | boolean |
O fundo é restrito a usuários específicos? |
|
|
Inativo?
|
inactive | boolean |
O fundo está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
|
|
ID da Campanha
|
campaign_id | integer |
O ID de uma campanha associada ao fundo. |
|
|
ID de recurso padrão
|
default_appeal_id | integer |
O ID do recurso por defeito associado ao fundo. |
Devoluções
Fundo criado
Criar um recurso
Cria um novo recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de pesquisa
|
appeal_id | True | string |
O identificador definido pelo usuário para o recurso. |
|
Description
|
description | True | string |
A descrição do recurso. |
|
Data de início
|
start_date | date |
Data de início do recurso (ex: «2005-09-18»). |
|
|
Data de fim
|
end_date | date |
Data final do recurso (ex: «2005-09-18»). |
|
|
Categoria
|
appeal_category_id | integer |
A categoria de recurso. |
|
|
Objetivo
|
goal | double |
O valor-alvo a angariar através do recurso. |
|
|
Valor padrão do presente
|
default_gift_amount | double |
O valor monetário do presente padrão. O padrão dessa propriedade é 0,00 se nenhum valor for especificado. |
|
|
Número solicitado
|
number_solicited | integer |
O número de constituintes requeridos no recurso. |
|
|
Observações
|
notes | string |
As notas associadas ao recurso. |
|
|
ID de campanha padrão
|
campaign_id | integer |
O ID de uma campanha associada ao recurso. |
|
|
ID do fundo de proteção por defeito
|
default_fund_id | integer |
O ID do fundo de proteção associado ao recurso. |
|
|
Inativo?
|
inactive | boolean |
O recurso está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
Devoluções
Recurso criado
Criar um recurso constituinte
Cria um novo apelo constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituent_id | True | integer |
O ID de registo do sistema do constituinte associado ao recurso constituinte. |
|
Descrição do recurso
|
appeal_description | True | string |
A descrição do recurso; usado para procurar o ID do registro de recurso. |
|
Descrição do pacote
|
package_description | string |
A descrição do pacote; usado para procurar o ID de registro do pacote. |
|
|
Date
|
appeal_date | date |
A data do recurso constituinte (ex: «2005-09-18»). |
|
|
Resposta
|
response_description | string |
A longa descrição da resposta para o recurso constituinte. |
|
|
Segmento de marketing
|
marketing_segment | string |
O segmento de marketing associado ao apelo constituinte. |
|
|
Código fonte de marketing
|
marketing_source_code | string |
O código-fonte de marketing associado ao recurso constituinte. |
|
|
ID para correspondência
|
mailing_id | integer |
O documento de identificação do recurso constituinte. |
|
|
Número do localizador
|
market_finder_number | string |
O número do localizador de mercado associado ao recurso constituinte. |
|
|
Comments
|
comments | string |
Os comentários associados ao recurso constituinte. |
|
|
ID de importação
|
import_id | string |
O ID de importação do recurso constituinte. |
Devoluções
Recurso constituinte criado
Criar uma campanha
Cria uma nova campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de pesquisa
|
campaign_id | True | string |
O identificador definido pelo usuário para a campanha. |
|
Description
|
description | True | string |
A descrição da campanha. |
|
Data de início
|
start_date | date |
A data de início da campanha (ex: '2005-09-18'). |
|
|
Data de fim
|
end_date | date |
A data final da campanha (ex: '2005-09-18'). |
|
|
Categoria
|
campaign_category_id | integer |
A categoria da campanha. |
|
|
Objetivo
|
goal | double |
O valor alvo a angariar através da campanha. |
|
|
Observações
|
notes | string |
As notas associadas à campanha. |
|
|
Inativo?
|
inactive | boolean |
A campanha está inativa (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de fim)? |
|
|
ID do fundo de proteção por defeito
|
default_fund_id | integer |
O ID do fundo padrão associado à campanha. |
Devoluções
Campanha criada
Listar anexos de campanha
Lista os anexos de uma campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O ID de registro do sistema da campanha. |
Devoluções
Attachments
Listar anexos de fundos
Lista os anexos de um fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Fundo
|
fund_id | True | string |
O ID de registo do sistema do fundo. |
Devoluções
Attachments
Listar anexos de recurso
Lista os anexos para um recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do recurso
|
appeal_id | True | string |
O ID de registro do sistema do recurso. |
Devoluções
Attachments
Listar campanhas
Retorna uma lista de campanhas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
|
|
Incluir inativos?
|
include_inactive | boolean |
Incluir campanhas inativas? |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para campanhas criadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z'). |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtre os resultados para campanhas modificadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z'). |
Devoluções
Campaigns
Listar campos personalizados da campanha
Lista os campos personalizados de uma campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O ID de registro do sistema da campanha. |
Devoluções
Campos personalizados
Listar campos personalizados de recurso
Lista os campos personalizados para um recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do recurso
|
appeal_id | True | string |
O ID de registro do sistema do recurso. |
Devoluções
Campos personalizados
Listar campos personalizados do fundo
Lista os campos personalizados de um fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Fundo
|
fund_id | True | string |
O ID de registo do sistema do fundo. |
Devoluções
Campos personalizados
Listar fundos
Devolve uma lista de fundos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
|
|
Incluir inativos?
|
include_inactive | boolean |
Incluir fundos inativos? |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para fundos criados na ou após a data especificada (ex: '2020-09-18T04:13:56Z'). |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtre os resultados para fundos modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z'). |
Devoluções
Fundos
Listar pacotes
Retorna uma lista de pacotes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
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 pacotes para recurso 506 ou recurso 918. |
|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
|
|
Incluir inativos?
|
include_inactive | boolean |
Incluir pacotes inativos? |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para pacotes criados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z'). |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtre os resultados para pacotes modificados na data especificada ou após ela (ex: '2020-09-18T04:13:56Z'). |
Devoluções
Packages
Listar recursos
Devolve uma lista de recursos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Compensação
|
offset | integer |
Representa o número de registros a serem ignorados. Para utilização com paginação. |
|
|
Incluir inativos?
|
include_inactive | boolean |
Incluir recursos inativos? |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para recursos criados na ou após a data especificada (ex: '2020-09-18T04:13:56Z'). |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtrar os resultados para recursos modificados na ou após a data especificada (ex: '2020-09-18T04:13:56Z'). |
Devoluções
Recursos
Listar recursos constituintes
Enumera os recursos 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
Recursos constituintes
Listar relações com fundos constituintes
Lista as relações de fundo para um constituinte.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do constituinte
|
constituentId | True | integer |
O ID de registo do sistema do constituinte. |
|
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
Relações com o fundo
Listar relações entre os constituintes do fundo
Lista as relações constituintes de um fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Fundo
|
fundId | True | integer |
O ID de registo do sistema do fundo. |
|
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
Relações constituintes
Obtenha um pacote
Retorna informações sobre um pacote.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do pacote
|
package_id | True | string |
O ID de registro do sistema do pacote a ser obtido. |
Devoluções
Package
Obter um fundo
Devolve informações sobre um fundo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Fundo
|
fund_id | True | string |
O ID de registro do sistema do fundo a ser obtido. |
Devoluções
Fundo
Receba um recurso
Retorna informações sobre um recurso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do recurso
|
appeal_id | True | string |
O ID de registro do sistema do recurso a ser obtido. |
Devoluções
Appeal
Receba uma campanha
Retorna informações sobre uma campanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Campanha
|
campaign_id | True | string |
O ID de registro do sistema da campanha a ser obtida. |
Devoluções
Campanha
Definições
ConstituentApi.ApiCollectionOfConstituentAppealRead
Recursos constituintes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of ConstituentApi.ConstituentAppealRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
ConstituentApi.ConstituentAppealRead
Recurso constituinte
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do recurso constituinte. |
|
ID
|
appeal.id | string |
O ID de registro do sistema do recurso. |
|
descrição
|
appeal.description | string |
A descrição do recurso. |
|
ID
|
package.id | string |
O ID de registro do sistema do pacote. |
|
descrição
|
package.description | string |
A descrição do pacote. |
|
Date
|
date | date-time |
Data do recurso constituinte. |
|
Resposta
|
response | string |
Resposta ao recurso constituinte. |
|
Segmento de marketing
|
marketing_segment | string |
O segmento de marketing para o apelo constituinte. |
|
Código fonte de marketing
|
marketing_source_code | string |
O código-fonte de marketing para o recurso constituinte. |
|
ID para correspondência
|
mailing_id | string |
O identificador de correspondência definido pelo utilizador para o recurso constituinte. |
|
Número do localizador
|
finder_number | string |
O número do localizador de marketing para o recurso constituinte. |
|
Comments
|
comments | string |
Comentários do usuário para o recurso constituinte. |
Angariação de fundosApi.ApiCollectionOfAppealAttachmentRead
Attachments
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.AppealAttachmentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfAppealCustomFieldRead
Campos personalizados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.AppealCustomFieldRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfAppealRead
Recursos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.AppealRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfCampaignAttachmentRead
Attachments
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.CampaignAttachmentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfCampaignCustomFieldRead
Campos personalizados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.CampaignCustomFieldRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfCampaignRead
Campaigns
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.CampaignRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfFundAttachmentRead
Attachments
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.FundAttachmentRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfFundCustomFieldRead
Campos personalizados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.FundCustomFieldRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de FundosApi.ApiCollectionOfFundRead
Fundos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.FundRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.ApiCollectionOfPackageRead
Packages
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of FundraisingApi.PackageRead |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
Angariação de fundosApi.RecursoAnexoLer
Attachment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do anexo. |
|
ID do recurso
|
parent_id | string |
O ID de registo do sistema do recurso associado à penhora. |
|
Tipo
|
type | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
Date
|
date | date-time |
A data do anexo. |
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
URL da miniatura
|
thumbnail_url | string |
O URL de uma miniatura. Para anexos físicos que são apenas imagens. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos. |
|
Tipo de conteúdo
|
content_type | string |
O tipo de conteúdo. Apenas para anexos físicos. |
|
Tamanho do ficheiro
|
file_size | integer |
O tamanho do arquivo em bytes. Apenas para anexos físicos. |
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Angariação de fundosApi.AppealCustomFieldRead
Campo personalizado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema do campo personalizado. |
|
ID do recurso
|
parent_id | string |
O ID de registro do sistema do recurso associado ao campo personalizado. |
|
Categoria
|
category | string |
A categoria de campo personalizado. |
|
Tipo
|
type | string |
O tipo de dados que o campo personalizado representa. |
|
Valor
|
value |
O valor do campo personalizado. |
|
|
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. |
Angariação de fundosApi.AppealRead
Appeal
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do recurso. |
|
Categoria
|
category | string |
Quanto à categoria do recurso. |
|
Data de adição
|
date_added | date-time |
A data em que o recurso foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o recurso foi modificado pela última vez. |
|
Description
|
description | string |
O nome de exibição do recurso. |
|
Data de fim
|
end_date | date-time |
A data final do recurso. |
|
valor
|
goal.value | double |
O valor monetário. |
|
Inativo?
|
inactive | boolean |
O recurso está ativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o recurso. |
|
Data de início
|
start_date | date-time |
A data de início do recurso. |
Angariação de fundosApi.CampanhaAnexoLer
Attachment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do anexo. |
|
ID da Campanha
|
parent_id | string |
O ID de registo do sistema da campanha associado ao anexo. |
|
Tipo
|
type | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
Date
|
date | date-time |
A data do anexo. |
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
URL da miniatura
|
thumbnail_url | string |
O URL de uma miniatura. Para anexos físicos que são apenas imagens. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos. |
|
Tipo de conteúdo
|
content_type | string |
O tipo de conteúdo. Apenas para anexos físicos. |
|
Tamanho do ficheiro
|
file_size | integer |
O tamanho do arquivo em bytes. Apenas para anexos físicos. |
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Angariação de fundosApi.CampaignCustomFieldRead
Campo personalizado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema do campo personalizado. |
|
ID da Campanha
|
parent_id | string |
O ID de registro do sistema da campanha associado ao campo personalizado. |
|
Categoria
|
category | string |
A categoria de campo personalizado. |
|
Tipo
|
type | string |
O tipo de dados que o campo personalizado representa. |
|
Valor
|
value |
O valor do campo personalizado. |
|
|
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. |
Angariação de fundosApi.CampaignRead
Campanha
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema da campanha. |
|
Categoria
|
category | string |
A categoria da campanha. |
|
Data de adição
|
date_added | date-time |
A data em que a campanha foi criada. |
|
Data de modificação
|
date_modified | date-time |
A data em que a campanha foi modificada pela última vez. |
|
Description
|
description | string |
O nome para exibição da campanha. |
|
Data de fim
|
end_date | date-time |
A data de fim da campanha. |
|
valor
|
goal.value | double |
O valor monetário. |
|
Inativo?
|
inactive | boolean |
A campanha está inativa (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de fim)? |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para a campanha. |
|
Data de início
|
start_date | date-time |
A data de início da campanha. |
Angariação de fundosApi.CreatedAppealAttachment
Recurso criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do anexo de recurso recém-criado. |
Angariação de fundosApi.CreatedAppealCustomField
Campo personalizado de recurso criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do campo personalizado de recurso recém-criado. |
Angariação de fundosApi.CreatedCampaignAttachment
Anexo de campanha criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do anexo de campanha recém-criado. |
Angariação de fundosApi.CreatedCampaignCustomField
Campo personalizado de campanha criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do campo personalizado da campanha recém-criada. |
FundraisingApi.CreatedFundAttachment
Penhora de fundo criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do anexo de fundo recém-criado. |
Angariação de fundosApi.CreatedFundCustomField
Campo personalizado do fundo criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do campo personalizado de fundo recém-criado. |
Angariação de fundosApi.FundAttachmentRead
Attachment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do anexo. |
|
ID do Fundo
|
parent_id | string |
O ID de registo do sistema do fundo associado à penhora. |
|
Tipo
|
type | string |
O tipo de anexo. Os anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word, que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Os anexos de links são links para arquivos como imagens, postagens de blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
Date
|
date | date-time |
A data do anexo. |
|
URL
|
url | string |
O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos. |
|
Nome do ficheiro
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID do ficheiro
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos. |
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos. |
|
URL da miniatura
|
thumbnail_url | string |
O URL de uma miniatura. Para anexos físicos que são apenas imagens. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos. |
|
Tipo de conteúdo
|
content_type | string |
O tipo de conteúdo. Apenas para anexos físicos. |
|
Tamanho do ficheiro
|
file_size | integer |
O tamanho do arquivo em bytes. Apenas para anexos físicos. |
|
Etiquetas
|
tags | array of string |
As tags associadas ao anexo. |
Angariação de fundosApi.FundCustomFieldRead
Campo personalizado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema do campo personalizado. |
|
ID do Fundo
|
parent_id | string |
O ID de registro do sistema do fundo associado ao campo personalizado. |
|
Categoria
|
category | string |
A categoria de campo personalizado. |
|
Tipo
|
type | string |
O tipo de dados que o campo personalizado representa. |
|
Valor
|
value |
O valor do campo personalizado. |
|
|
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. |
Angariação de fundosApi.FundRead
Fundo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registo do sistema do fundo. |
|
Categoria
|
category | string |
A categoria do fundo. |
|
Data de adição
|
date_added | date-time |
A data em que o fundo foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o fundo foi modificado pela última vez. |
|
Description
|
description | string |
O nome de exibição do fundo. |
|
Data de fim
|
end_date | date-time |
A data final do fundo. |
|
valor
|
goal.value | double |
O valor monetário. |
|
Inativo?
|
inactive | boolean |
O fundo está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo utilizador para o fundo. |
|
Data de início
|
start_date | date-time |
A data de início do fundo. |
|
Tipo
|
type | string |
O tipo de fundo. |
Angariação de fundosApi.PackageRead
Package
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID de registro do sistema do pacote. |
|
ID do recurso
|
appeal_id | string |
O ID de registro do sistema do recurso associado a este pacote. |
|
Categoria
|
category | string |
A categoria do pacote. |
|
Data de adição
|
date_added | date-time |
A data em que o pacote foi criado. |
|
Data de modificação
|
date_modified | date-time |
A data em que o pacote foi modificado pela última vez. |
|
valor
|
default_gift_amount.value | double |
O valor monetário. |
|
Description
|
description | string |
O nome para exibição do pacote. |
|
Data de fim
|
end | date-time |
A data final do pacote. |
|
valor
|
goal.value | double |
O valor monetário. |
|
Inativo?
|
inactive | boolean |
O pacote está inativo (ou seja, a data atual é posterior a qualquer data de início e antes de qualquer data de término)? |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o pacote. |
|
Observações
|
notes | string |
As notas na embalagem. |
|
Contagem de destinatários
|
recipient_count | integer |
O número de destinatários do pacote. |
|
Data de início
|
start | date-time |
A data de início do pacote. |
NXTDataIntegrationApi.ConstituentRelationship
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do constituinte
|
relation_id | integer |
O ID de registo do sistema do componente relacionado. |
|
Descrição da relação
|
relation_description | string |
A descrição da relação. |
|
Tipo de relação
|
relationship_type | string |
O tipo de relacionamento. |
|
Tipo de relação recíproca
|
reciprocal_relationship_type | string |
O tipo de relação recíproca. |
|
Data de
|
date_from | date-time |
A data de início da relação. |
|
Data para
|
date_to | date-time |
A data de fim da relação. |
|
Observações
|
notes | string |
As notas de relação. |
NXTDataIntegrationApi.ConstituentRelationshipCollection
Relações constituintes
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor. |
|
valor
|
value | array of NXTDataIntegrationApi.ConstituentRelationship |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |
NXTDataIntegrationApi.CreatedAppeal
Recurso criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do recurso recém-criado. |
NXTDataIntegrationApi.CreatedCampaign
Campanha criada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID da campanha recém-criada. |
NXTDataIntegrationApi.CreatedConstituentAppeal
Recurso constituinte criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A identificação do recurso constituinte recém-criado. |
NXTDataIntegrationApi.CreatedFund
Fundo criado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O ID do fundo recém-criado. |
NXTDataIntegrationApi.FundRelationship
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Fundo
|
relation_id | integer |
O ID de registo do sistema do fundo relacionado. |
|
Descrição da relação
|
relation_description | string |
A descrição da relação. |
|
Tipo de relação
|
relationship_type | string |
O tipo de relacionamento. |
|
Tipo de relação recíproca
|
reciprocal_relationship_type | string |
O tipo de relação recíproca. |
|
Data de
|
date_from | date-time |
A data de início da relação. |
|
Data para
|
date_to | date-time |
A data de fim da relação. |
|
Observações
|
notes | string |
As notas de relação. |
NXTDataIntegrationApi.FundRelationshipCollection
Relações com o fundo
| 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.FundRelationship |
O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção. |