Componentes NXT do Blackbaud Raisers Edge
O Blackbaud Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social. Use o conector Constituintes para gerenciar detalhes biográficos constituintes, informações de contato e relações.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | - | Não disponível |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte do Blackbaud |
| URL | https://www.blackbaud.com/support |
| skyapi@blackbaud.com |
| Metadados do conector | |
|---|---|
| Publicador | Blackbaud, Inc. |
| Site | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Política de privacidade | https://www.blackbaud.com/privacy-shield |
| Categorias | Vendas e CRM; Produtividade |
O Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social.
Esse conector é criado com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar constituintes e entidades relacionadas encontradas no NXT de Borda do Raiser, incluindo:
- Constituintes
- Addresses
- Telefones e emails
- Aliases
- Campos Personalizados
- Anotações
- Attachments
- Relationships
- e muito mais...
Para obter mais informações, veja a documentação.
Pré-requisitos
Para usar esse conector, você deve ter uma conta de ID do Blackbaud com acesso a um ou mais ambientes Blackbaud.
Além disso, o administrador da sua organização também deve executar uma ação no nível do administrador dentro do sistema para permitir que esse conector acesse seu ambiente blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de instalação inicial .
Como obter credenciais?
O administrador da sua organização enviará um convite para o ambiente do Raiser's Edge NXT da organização e configurará suas permissões de conta de usuário dentro do ambiente. Não são necessárias credenciais adicionais para usar esse conector.
Problemas e limitações conhecidos
O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às permissões do usuário dentro do ambiente.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar um alias constituinte |
Atualiza um alias constituinte. |
| Atualizar um anexo constituinte |
Atualiza um anexo constituinte. |
| Atualizar um campo personalizado constituinte |
Atualiza um campo personalizado constituinte. |
| Atualizar um constituinte |
Atualiza um constituinte. |
| Atualizar um código constituinte |
Atualiza um código constituinte. |
| Atualizar um código de solicitação constituinte |
Atualiza um código de solicitação constituinte. |
| Atualizar um endereço constituinte |
Atualiza um endereço constituinte. |
| Atualizar um endereço de email constituinte |
Atualiza um endereço de email constituinte. |
| Atualizar um formato de nome constituinte |
Atualiza um formato de nome constituinte. |
| Atualizar um formato de nome primário constituinte |
Atualiza o formato de nome primário para um constituinte. |
| Atualizar um telefone constituinte |
Atualiza um telefone constituinte. |
| Atualizar uma educação constituinte |
Atualiza uma educação constituinte. |
| Atualizar uma imagem de perfil constituinte |
Atualiza a imagem de perfil atual para um constituinte. |
| Atualizar uma nota constituinte |
Atualiza uma nota constituinte. |
| Atualizar uma presença online constituinte |
Atualiza uma presença online constituinte. |
| Atualizar uma relação constituinte |
Atualiza uma relação para um constituinte. Se houver uma relação recíproca, ela também será modificada para refletir as alterações. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro. |
| Converter em constituinte |
Converte um não constituinte em um constituinte. |
| Criar um alias constituinte |
Cria um novo alias constituinte. |
| Criar um anexo constituinte |
Cria um novo anexo constituinte. |
| Criar um campo personalizado constituinte |
Cria um novo campo personalizado constituinte. |
| Criar um constituinte da organização |
Cria um novo constituinte da organização. |
| Criar um constituinte individual |
Cria um novo constituinte individual. |
| Criar um código constituinte |
Cria um novo código constituinte. |
| Criar um código de solicitação constituinte |
Cria um novo código de solicitação constituinte. |
| Criar um endereço constituinte |
Cria um novo endereço constituinte. |
| Criar um endereço de email constituinte |
Cria um novo endereço de email constituinte. |
| Criar um formato de nome constituinte |
Cria um novo formato de nome constituinte. |
| Criar um formato de nome primário constituinte |
Cria um formato de nome primário para um constituinte. |
| Criar um reconhecimento de tributo |
Cria um novo reconhecimento de tributo. |
| Criar um registro de consentimento constituinte |
Cria um novo registro de consentimento constituinte. |
| Criar um relacionamento de organização |
Cria uma nova relação de organização. Se a relação for com outro constituinte, uma relação recíproca será criada para esse constituinte. |
| Criar um telefone constituinte |
Cria um novo telefone constituinte. |
| Criar um tributo constituinte |
Cria um novo tributo constituinte. |
| Criar uma atribuição de arrecadação de fundos |
Cria uma nova tarefa de arrecadação de fundos. |
| Criar uma educação constituinte |
Cria uma nova educação constituinte. |
| Criar uma nota constituinte |
Cria uma nova nota constituinte. |
| Criar uma presença online constituinte |
Cria uma nova presença online constituinte. |
| Criar uma relação individual |
Cria uma nova relação individual. Se a relação for com outro constituinte, uma relação recíproca será criada para esse constituinte. |
| Excluir um código constituinte |
Exclui um código constituinte. |
| Listar aliases constituintes |
Lista os aliases de um constituinte. |
| Listar anexos constituintes |
Lista os anexos de um constituinte. |
| Listar anotações constituintes |
Lista as anotações de um constituinte. |
| Listar arrecadações de fundos constituintes |
Lista as atribuições de arrecadação de fundos para um constituinte. |
| Listar associações constituintes |
Lista as associações de um constituinte. |
| Listar atribuições de arrecadação de fundos |
Liste as tarefas para uma arrecadação de fundos. |
| Listar campos personalizados constituintes |
Lista os campos personalizados para um constituinte. |
| Listar constituintes |
Retorna uma lista de constituintes. |
| Listar códigos constituintes |
Lista os códigos constituintes para um constituinte. |
| Listar códigos de solicitação constituintes |
Lista os códigos de solicitação para um constituinte. |
| Listar educaçãos constituintes |
Lista os registros de educação de um constituinte. |
| Listar endereços constituintes |
Lista os endereços de um constituinte. |
| Listar endereços de email constituintes |
Lista os endereços de email de um constituinte. |
| Listar presenças online constituintes |
Lista as presenças online de um constituinte. |
| Listar reconhecimentos de tributo |
Lista os reconhecimentos de um tributo. |
| Listar registros de consentimento do constituinte |
Lista os registros de consentimento de um constituinte. |
| Listar relações constituintes |
Lista as relações de um constituinte. |
| Listar telefones constituintes |
Lista os telefones de um constituinte. |
| Listar tributos constituintes |
Lista os tributos para um constituinte. |
| Obter resumo do formato de nome constituinte |
Retorna o resumo do formato de nome de um constituinte. |
| Obter um constituinte |
Retorna informações sobre um constituinte. |
| Obter um constituinte por ID de pesquisa |
Retorna a ID de registro do sistema de um constituinte da ID de pesquisa especificada. |
| Obter um tributo constituinte |
Retorna detalhes sobre um tributo constituinte. |
| Obter uma imagem de perfil constituinte |
Retorna a imagem de perfil atual de um constituinte. |
| Pesquisar componentes duplicados |
Pesquisa registros de contato individuais, de organização e relacionados e classifica possíveis duplicatas com base nos filtros de pesquisa especificados. Os registros que correspondem a vários filtros são classificados como duplicatas potenciais. |
| Pesquisar um constituinte |
Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Dá suporte ao nome, sobrenome, nome preferencial, nome antigo, alias, endereço de email, número de telefone, endereço ou ID de pesquisa. Combinações de nomes como nome e sobrenome ou nome preferencial e sobrenome são válidas, mas caso contrário, a pesquisa só dá suporte a um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras ortografias alternativas. Essa pesquisa não dá suporte a caracteres curinga como * ou ?. Os resultados da pesquisa são limitados a 500 registros. |
| Pesquisar um constituinte (aprimorado) |
Pesquisa registros constituintes usando os critérios de filtro especificados. |
Atualizar um alias constituinte
Atualiza um alias constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Alias ID
|
alias_id | True | string |
A ID do registro do sistema do alias a ser atualizado. |
|
Alias
|
name | string |
O nome a ser usado como alias do constituinte. Limite de caracteres: 100. |
|
|
Tipo
|
type | string |
O tipo de alias. |
Atualizar um anexo constituinte
Atualiza um anexo constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | string |
A ID do registro do sistema do anexo a ser atualizado. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (por exemplo: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As marcas associadas ao anexo. |
Atualizar um campo personalizado constituinte
Atualiza um campo personalizado constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do campo personalizado
|
custom_field_id | True | string |
A ID do registro do sistema do campo personalizado a ser atualizado. |
|
body
|
body | True | dynamic |
Um objeto que representa as propriedades do campo personalizado a ser atualizado. |
Atualizar um constituinte
Atualiza um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID de registro do sistema do constituinte a ser atualizada. |
|
Title
|
title | string |
O título primário do constituinte (somente para indivíduos). |
|
|
Nome
|
first | string |
O nome do constituinte (somente para indivíduos). Limite de caracteres: 50. |
|
|
Sobrenome
|
last | string |
O sobrenome do constituinte (somente para indivíduos). Limite de caracteres: 100. |
|
|
Nome da organização
|
name | string |
Para indivíduos, esse é um campo computado que não é aplicável para operações de edição. Para a organização, esse campo é necessário e representa o nome da organização. Limite de caracteres: 100. |
|
|
Sufixo
|
suffix | string |
O sufixo primário do constituinte (somente para indivíduos). |
|
|
Nome preferencial
|
preferred_name | string |
O nome preferencial do constituinte (somente para indivíduos). Limite de caracteres: 50. |
|
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o constituinte. |
|
|
Gênero
|
gender | string |
O gênero do constituinte (somente para indivíduos). |
|
|
Nome do meio
|
middle | string |
O nome do meio do constituinte (somente para indivíduos). Limite de caracteres: 50. |
|
|
Nome antigo
|
former_name | string |
O nome antigo do constituinte (somente para indivíduos). Limite de caracteres: 100. |
|
|
Título 2
|
title_2 | string |
O título secundário do constituinte (somente para indivíduos). |
|
|
Sufixo 2
|
suffix_2 | string |
O sufixo secundário do constituinte (somente para indivíduos). |
|
|
Estado civil
|
marital_status | string |
O estado civil do constituinte (somente para indivíduos). |
|
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte dá anonimamente? |
|
|
Não solicita nenhum email?
|
requests_no_email | boolean |
O constituinte não solicita nenhum email? |
|
|
É um advogado?
|
is_solicitor | boolean |
O constituinte é um advogado? |
|
|
Nenhum endereço válido?
|
no_valid_address | boolean |
O constituinte não tem endereços válidos? |
|
|
Inativo?
|
inactive | boolean |
O constituinte está inativo? |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Terra natal
|
birthplace | string |
O local de nascimento do constituinte (somente para indivíduos). |
|
|
Etnia
|
ethnicity | string |
A etnia do constituinte (somente para indivíduos). |
|
|
Meta
|
target | string |
O destino do constituinte. |
|
|
Rendimento
|
income | string |
A renda do constituinte (somente para pessoas físicas). |
|
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
|
Religião
|
religion | string |
A religião do constituinte (somente para indivíduos). |
|
|
Setor
|
industry | string |
A indústria do constituinte (somente para organizações). |
|
|
Número de funcionários
|
num_employees | integer |
O número de funcionários da organização. |
|
|
Corresponde a presentes?
|
matches_gifts | boolean |
A organização corresponde a presentes? |
|
|
Fator presente correspondente
|
matching_gift_factor | double |
O fator presente correspondente (somente para organizações). |
|
|
Correspondência mínima por presente
|
value | double |
A quantidade mínima de correspondência por presente para o constituinte (somente para organizações). |
|
|
Correspondência máxima por presente
|
value | double |
A quantidade máxima de correspondência por presente para o constituinte (somente para organizações). |
|
|
Correspondência mínima por constit
|
value | double |
O total mínimo de correspondência para o constituinte (somente para organizações). |
|
|
Correspondência máxima por constit
|
value | double |
O total máximo de correspondências para o constituinte (somente para organizações). |
|
|
Notas de presente correspondentes
|
matching_gift_notes | string |
As notas de presente correspondentes para o constituinte (somente para organizações). |
|
|
Falecido?
|
deceased | boolean |
O constituinte está falecido (somente para indivíduos)? |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
Atualizar um código constituinte
Atualiza um código constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do código constituinte
|
constituent_code_id | True | string |
A ID do registro do sistema do código constituinte a ser atualizado. |
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Sequence
|
sequence | integer |
A sequência numérica associada ao código constituinte. |
Atualizar um código de solicitação constituinte
Atualiza um código de solicitação constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Solicitar ID de código
|
constituent_solicit_code_id | True | string |
A ID do registro do sistema do código de solicitação a ser atualizado. |
|
Solicitar código
|
solicit_code | string |
Instruções de comunicação e/ou restrições para um constituinte. |
|
|
Data de início
|
start_date | date |
A data de início do código de solicitação (por exemplo: '2005-09-18'). |
|
|
Data de término
|
end_date | date |
A data de término do código de solicitação (por exemplo: '2005-09-18'). |
Atualizar um endereço constituinte
Atualiza um endereço constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do endereço
|
address_id | True | string |
A ID do registro do sistema do endereço a ser atualizado. |
|
Tipo de endereço
|
type | string |
O tipo de endereço. |
|
|
País
|
country | string |
O país do endereço (pode ser a ID, o nome ou a abreviação). |
|
|
Linhas de endereço
|
address_lines | string |
As linhas de endereço. |
|
|
City
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
Estado
|
state | string |
O estado do endereço. |
|
|
CEP
|
postal_code | string |
O código postal do endereço. |
|
|
Subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
Município
|
county | string |
A região do endereço. |
|
|
Fonte de informações
|
information_source | string |
A fonte de informações do endereço. |
|
|
Região
|
region | string |
A região do endereço. |
|
|
CARROÇA
|
cart | string |
A rota da transportadora (CART) para o endereço. |
|
|
LOTE
|
lot | string |
A linha de viagem (LOT) para o endereço. |
|
|
DPC
|
dpc | string |
O código do ponto de entrega (DPC) para o endereço. |
|
|
Válido a partir de
|
start | date |
A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18'). |
|
|
Válida até
|
end | date |
A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18'). |
|
|
Primário?
|
preferred | boolean |
Este é o endereço preferencial do constituinte? |
|
|
Não enviar emails?
|
do_not_mail | boolean |
O constituinte pode ser contatado neste endereço? |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
Atualizar um endereço de email constituinte
Atualiza um endereço de email constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do endereço de email
|
email_address_id | True | string |
A ID do registro do sistema do endereço de email a ser atualizado. |
|
Tipo de email
|
type | string |
O tipo de endereço de email. |
|
|
Endereço de email
|
address | string |
O endereço de email. |
|
|
Primário?
|
primary | boolean |
Este é o endereço de email principal do constituinte? |
|
|
Não enviar email?
|
do_not_email | boolean |
O constituinte pode ser contatado neste endereço de email? |
|
|
Inativo?
|
inactive | boolean |
Esse endereço de email está inativo? |
Atualizar um formato de nome constituinte
Atualiza um formato de nome constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do formato de nome
|
name_format_id | True | string |
A ID do registro do sistema do formato de nome a ser atualizado. |
|
Tipo
|
type | string |
O tipo de formato de nome. |
|
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Atualizar um formato de nome primário constituinte
Atualiza o formato de nome primário para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do formato de nome
|
primary_name_format_id | True | string |
A ID do registro do sistema do formato de nome primário a ser atualizado. |
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Atualizar um telefone constituinte
Atualiza um telefone constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do telefone
|
phone_id | True | string |
A ID do registro do sistema do telefone a ser atualizado. |
|
Tipo
|
type | string |
O tipo de telefone. |
|
|
Número
|
number | string |
O número de telefone. |
|
|
Primário?
|
primary | boolean |
Este é o telefone primário do constituinte? |
|
|
Não ligar?
|
do_not_call | boolean |
O constituinte pode ser contatado neste número? |
|
|
Inativo?
|
inactive | boolean |
Esse número de telefone está inativo? |
Atualizar uma educação constituinte
Atualiza uma educação constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da educação
|
education_id | True | string |
A ID de registro do sistema do registro educacional a ser atualizado. |
|
Escola
|
school | string |
O nome da escola/estabelecimento. |
|
|
Tipo
|
type | string |
O tipo de educação. |
|
|
Classe de
|
class_of | string |
O ano em que o constituinte se formou. |
|
|
Situação
|
status | string |
O status da educação. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Grau
|
degree | string |
O grau recebido. |
|
|
GPA
|
gpa | double |
A média de pontos de nota. |
|
|
Assunto de estudo
|
subject_of_study | string |
O assunto do estudo. |
|
|
Primário?
|
primary | boolean |
Esta é a associação de escola primária do constituinte? |
|
|
Majors
|
majors | array of string |
Os principais cursos de estudo. |
|
|
Menores
|
minors | array of string |
Os cursos secundários de estudo. |
|
|
Campus
|
campus | string |
O campus. Limite de caracteres: 50. |
|
|
Organização social
|
social_organization | string |
A organização social. Limite de caracteres: 50. |
|
|
Nome conhecido
|
known_name | string |
O nome conhecido. Limite de caracteres: 50. |
|
|
Classe de grau
|
class_of_degree | string |
A classe de grau. |
|
|
Departamento
|
department | string |
O nome do departamento de educação. |
|
|
Faculdade
|
faculty | string |
O nome da faculdade. |
|
|
Número de registro
|
registration_number | string |
O número do registro. Limite de caracteres: 50. |
Atualizar uma imagem de perfil constituinte
Atualiza a imagem de perfil atual para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte cuja imagem de perfil deve ser atualizada. |
|
Nome do arquivo
|
file_name | True | string |
O nome do arquivo. |
|
ID do documento
|
document_id | True | uuid |
O identificador do documento. |
|
ID da miniatura
|
thumbnail_id | True | uuid |
O identificador do documento em miniatura. |
Atualizar uma nota constituinte
Atualiza uma nota constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da anotação
|
note_id | True | string |
A ID do registro do sistema da nota a ser atualizada. |
|
Tipo
|
type | string |
O tipo de anotação. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Resumo
|
summary | string |
O resumo da anotação. Limite de caracteres: 50. |
|
|
Observação
|
text | string |
O texto da anotação. |
Atualizar uma presença online constituinte
Atualiza uma presença online constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de presença online
|
online_presence_id | True | string |
A ID de registro do sistema da presença online a ser atualizada. |
|
Tipo
|
type | string |
O tipo de presença online. |
|
|
Link
|
address | string |
O endereço da Web para a presença online. |
|
|
Primário?
|
primary | boolean |
Esta é a principal presença online do constituinte? |
|
|
Inativo?
|
inactive | boolean |
Essa presença online está inativa? |
Atualizar uma relação constituinte
Atualiza uma relação para um constituinte. Se houver uma relação recíproca, ela também será modificada para refletir as alterações. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da relação
|
relationship_id | True | string |
A ID do registro do sistema da relação a ser atualizada. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, em uma relação entre um constituinte masculino e um irmão feminino, o tipo de relação recíproca seria irmão. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
O cônjuge é?
|
is_spouse | boolean |
O indivíduo relacionado é o cônjuge do constituinte (aplica-se apenas às relações entre indivíduos)? |
|
|
É o chefe de família constituinte?
|
is_constituent_head_of_household | boolean |
O constituinte é o chefe da casa? |
|
|
O cônjuge é o chefe da casa?
|
is_spouse_head_of_household | boolean |
O cônjuge é o chefe da casa? |
|
|
Anotações
|
comment | string |
Notas adicionais sobre a relação. |
|
|
O contato é?
|
is_organization_contact | boolean |
O constituinte representa essa organização como um contato (aplica-se apenas a relações entre organizações e indivíduos)? |
|
|
Os negócios primários são os principais?
|
is_primary_business | boolean |
Esse é o principal negócio do constituinte (aplica-se apenas às relações entre organizações e indivíduos)? |
|
|
Tipo de contato
|
organization_contact_type | string |
Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas a relações entre organizações e indivíduos. |
|
|
Cargo
|
position | string |
A posição do indivíduo na organização. Aplica-se apenas a relações entre organizações e indivíduos. Limite de caracteres: 50. |
Converter em constituinte
Converte um não constituinte em um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID não constituinte
|
non_constituent_id | True | string |
A ID do registro do sistema do registro não constituinte a ser convertido. |
|
ID
|
id | string |
A ID do registro do sistema do código constituinte. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
sequência
|
sequence | integer |
A sequência do código constituinte. |
Retornos
Constituinte convertido
Criar um alias constituinte
Cria um novo alias constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao alias. |
|
Alias
|
name | True | string |
O nome a ser usado como alias do constituinte. Limite de caracteres: 100. |
|
Tipo
|
type | string |
O tipo de alias. |
Retornos
Alias constituinte criado
Criar um anexo constituinte
Cria um novo anexo constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
parent_id | True | string |
A ID do registro do sistema do constituinte associado ao anexo. |
|
Tipo
|
type | True | string |
O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
|
Date
|
date | date-time |
A data do anexo (por exemplo: '2020-09-18T04:13:56Z'). Esse campo usa como padrão a data e a hora atuais, se não for fornecido. |
|
|
URL
|
url | string |
A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos. |
|
|
Nome do arquivo
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos. |
|
|
ID de Arquivo
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos. |
|
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos. |
|
|
Etiquetas
|
tags | array of string |
As marcas associadas ao anexo. |
Retornos
Anexo constituinte criado
Criar um campo personalizado constituinte
Cria um novo campo personalizado constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Um objeto que representa o campo personalizado a ser criado. |
Retornos
Campo personalizado constituinte criado
Criar um constituinte da organização
Cria um novo constituinte da organização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
name | True | string |
O nome da organização. Limite de caracteres: 100. |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o constituinte. |
|
|
tipo
|
type | True | string |
O tipo de endereço. |
|
country
|
country | string |
O país do endereço (pode ser a ID, o nome ou a abreviação). |
|
|
Linhas
|
address_lines | string |
As linhas de endereço. Limite de caracteres: 150. |
|
|
city
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
estado
|
state | string |
O estado do endereço. |
|
|
código postal
|
postal_code | string |
O código postal do endereço. Limite de caracteres: 12. |
|
|
subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
condado
|
county | string |
A região do endereço. |
|
|
start
|
start | date |
A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18'). |
|
|
término
|
end | date |
A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18'). |
|
|
tipo
|
type | True | string |
O tipo de telefone. |
|
número
|
number | True | string |
O número de telefone. |
|
é primário?
|
primary | boolean |
Este é o número de telefone primário do constituinte? |
|
|
tipo
|
type | True | string |
O tipo de endereço de email. |
|
address
|
address | True | string |
O endereço de email. |
|
é primário?
|
primary | boolean |
Este é o endereço de email principal do constituinte? |
|
|
tipo
|
type | True | string |
O tipo de presença online. |
|
address
|
address | True | string |
O endereço da Web para a presença online. |
|
é primário?
|
primary | boolean |
Esta é a principal presença online do constituinte? |
|
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte dá anonimamente? |
|
|
Não solicita nenhum email?
|
requests_no_email | boolean |
O constituinte não solicita nenhum email? |
|
|
É um advogado?
|
is_solicitor | boolean |
O constituinte é um advogado? |
|
|
Nenhum endereço válido?
|
no_valid_address | boolean |
O constituinte não tem endereços válidos? |
|
|
Meta
|
target | string |
O destino do constituinte. |
|
|
Rendimento
|
income | string |
A renda do constituinte. |
|
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
|
Setor
|
industry | string |
A indústria do constituinte. |
|
|
Número de funcionários
|
num_employees | integer |
O número de funcionários da organização. |
|
|
Corresponde a presentes?
|
matches_gifts | boolean |
A organização corresponde a presentes? |
|
|
Fator presente correspondente
|
matching_gift_factor | double |
O fator presente correspondente. |
|
|
Correspondência mínima por presente
|
value | double |
A quantidade mínima de correspondência por presente para o constituinte. |
|
|
Correspondência máxima por presente
|
value | double |
A quantidade máxima de correspondência por presente para o constituinte. |
|
|
Correspondência mínima por constit
|
value | double |
O total mínimo de correspondência para o constituinte. |
|
|
Correspondência máxima por constit
|
value | double |
O total máximo de correspondências para o constituinte. |
|
|
Notas de presente correspondentes
|
matching_gift_notes | string |
As notas de presente correspondentes para o constituinte. |
|
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
Retornos
Constituinte da organização criado
Criar um constituinte individual
Cria um novo constituinte individual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | string |
O título primário do constituinte. |
|
|
Nome
|
first | string |
O nome do constituinte. Limite de caracteres: 50. |
|
|
Sobrenome
|
last | True | string |
O sobrenome do constituinte. Limite de caracteres: 100. |
|
Sufixo
|
suffix | string |
O sufixo primário do constituinte. |
|
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o constituinte. |
|
|
tipo
|
type | True | string |
O tipo de endereço. |
|
country
|
country | string |
O país do endereço (pode ser a ID, o nome ou a abreviação). |
|
|
Linhas
|
address_lines | string |
As linhas de endereço. Limite de caracteres: 150. |
|
|
city
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
estado
|
state | string |
O estado do endereço. |
|
|
código postal
|
postal_code | string |
O código postal do endereço. Limite de caracteres: 12. |
|
|
subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
condado
|
county | string |
A região do endereço. |
|
|
start
|
start | date |
A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18'). |
|
|
término
|
end | date |
A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18'). |
|
|
tipo
|
type | True | string |
O tipo de telefone. |
|
número
|
number | True | string |
O número de telefone. |
|
é primário?
|
primary | boolean |
Este é o número de telefone primário do constituinte? |
|
|
tipo
|
type | True | string |
O tipo de endereço de email. |
|
address
|
address | True | string |
O endereço de email. |
|
é primário?
|
primary | boolean |
Este é o endereço de email principal do constituinte? |
|
|
tipo
|
type | True | string |
O tipo de presença online. |
|
address
|
address | True | string |
O endereço da Web para a presença online. |
|
é primário?
|
primary | boolean |
Esta é a principal presença online do constituinte? |
|
|
Nome preferencial
|
preferred_name | string |
O nome preferencial do constituinte. Limite de caracteres: 50. |
|
|
Nome do meio
|
middle | string |
O nome do meio do constituinte. Limite de caracteres: 50. |
|
|
Nome antigo
|
former_name | string |
O nome antigo do constituinte. Limite de caracteres: 100. |
|
|
Título 2
|
title_2 | string |
O título secundário do constituinte. |
|
|
Sufixo 2
|
suffix_2 | string |
O sufixo secundário do constituinte. |
|
|
Gênero
|
gender | string |
O gênero do constituinte. |
|
|
Estado civil
|
marital_status | string |
O estado civil do constituinte. |
|
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte dá anonimamente? |
|
|
Não solicita nenhum email?
|
requests_no_email | boolean |
O constituinte não solicita nenhum email? |
|
|
É um advogado?
|
is_solicitor | boolean |
O constituinte é um advogado? |
|
|
Nenhum endereço válido?
|
no_valid_address | boolean |
O constituinte não tem endereços válidos? |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Terra natal
|
birthplace | string |
O local de nascimento do constituinte. |
|
|
Etnia
|
ethnicity | string |
A etnia do constituinte. |
|
|
Meta
|
target | string |
O destino do constituinte. |
|
|
Rendimento
|
income | string |
A renda do constituinte. |
|
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
|
Religião
|
religion | string |
A religião do constituinte. |
|
|
Destinatário personalizado?
|
custom_format | boolean |
O destinatário primário é um formato personalizado? |
|
|
Formato do destinatário
|
configuration_id | string |
Configuração do destinatário primário (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado do destinatário
|
formatted_name | string |
Nome formatado do destinatário primário (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
|
|
Saudação personalizada?
|
custom_format | boolean |
A saudação primária é um formato personalizado? |
|
|
Formato de saudação
|
configuration_id | string |
Configuração de saudação primária (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado de saudação
|
formatted_name | string |
Nome formatado de saudação primária (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
|
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
Retornos
Constituinte individual criado
Criar um código constituinte
Cria um novo código constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao código constituinte. |
|
Código constituinte
|
description | True | string |
O código constituinte. |
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Sequence
|
sequence | integer |
A sequência numérica associada ao código constituinte. |
Retornos
Código constituinte criado
Criar um código de solicitação constituinte
Cria um novo código de solicitação constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao código de solicitação. |
|
Solicitar código
|
solicit_code | True | string |
Instruções de comunicação e/ou restrições para um constituinte. |
|
Data de início
|
start_date | date |
A data de início do código de solicitação (por exemplo: '2005-09-18'). |
|
|
Data de término
|
end_date | date |
A data de término do código de solicitação (por exemplo: '2005-09-18'). |
Retornos
Código de solicitação constituinte criado
Criar um endereço constituinte
Cria um novo endereço constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao endereço. |
|
Tipo de endereço
|
type | True | string |
O tipo de endereço. |
|
País
|
country | string |
O país do endereço (pode ser a ID, o nome ou a abreviação). |
|
|
Linhas de endereço
|
address_lines | string |
As linhas de endereço. |
|
|
City
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
|
Estado
|
state | string |
O estado do endereço. |
|
|
CEP
|
postal_code | string |
O código postal do endereço. |
|
|
Subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
|
Município
|
county | string |
A região do endereço. |
|
|
Fonte de informações
|
information_source | string |
A fonte de informações do endereço. |
|
|
Região
|
region | string |
A região do endereço. |
|
|
CARROÇA
|
cart | string |
A rota da transportadora (CART) para o endereço. |
|
|
LOTE
|
lot | string |
A linha de viagem (LOT) para o endereço. |
|
|
DPC
|
dpc | string |
O código do ponto de entrega (DPC) para o endereço. |
|
|
Válido a partir de
|
start | date |
A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18'). |
|
|
Válida até
|
end | date |
A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18'). |
|
|
Primário?
|
preferred | boolean |
Este é o endereço preferencial do constituinte? |
|
|
Não enviar emails?
|
do_not_mail | boolean |
O constituinte pode ser contatado neste endereço? |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
Retornos
Endereço constituinte criado
Criar um endereço de email constituinte
Cria um novo endereço de email constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao endereço de email. |
|
Tipo de email
|
type | True | string |
O tipo de endereço de email. |
|
Endereço de email
|
address | True | string |
O endereço de email. |
|
Primário?
|
primary | boolean |
Este é o endereço de email principal do constituinte? |
|
|
Não enviar email?
|
do_not_email | boolean |
O constituinte pode ser contatado neste endereço de email? |
|
|
Inativo?
|
inactive | boolean |
Esse endereço de email está inativo? |
Retornos
Endereço de email constituinte criado
Criar um formato de nome constituinte
Cria um novo formato de nome constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Tipo
|
type | True | string |
O tipo de formato de nome. |
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Retornos
Formato de nome criado
Criar um formato de nome primário constituinte
Cria um formato de nome primário para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Tipo
|
primary_type | True | string |
O tipo de formato de nome primário. |
|
Formato de nome personalizado?
|
custom_format | boolean |
É um formato personalizado? |
|
|
Formato
|
configuration_id | string |
Configuração de formato de nome (necessária, a menos que um formato personalizado seja usado). |
|
|
Nome personalizado
|
formatted_name | string |
Nome formatado (necessário quando um formato personalizado é usado). Limite de caracteres: 255. |
Retornos
Formato de nome criado
Criar um reconhecimento de tributo
Cria um novo reconhecimento de tributo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo
|
tribute_id | True | integer |
A ID do registro do sistema do tributo associado ao reconhecimento. |
|
ID da relação
|
relationship_id | integer |
A ID de registro do sistema da relação (se nula, isso representa um autoconhecê-lo). |
|
|
ID da carta
|
letter_id | integer |
A ID da carta. |
Retornos
Reconhecimento de tributo criado
Criar um registro de consentimento constituinte
Cria um novo registro de consentimento constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao registro de consentimento. |
|
Channel
|
channel | True | string |
O canal ao qual a resposta de consentimento se aplica. |
|
Categoria
|
category | string |
A categoria à qual a resposta de consentimento se aplica. |
|
|
Source
|
source | string |
A origem da resposta de consentimento do constituinte. |
|
|
Resposta
|
constituent_consent_response | True | string |
Como o constituinte respondeu ao consentimento do canal/categoria especificado. |
|
Date
|
consent_date | True | date-time |
A data em que a resposta de consentimento foi recebida (por exemplo: '2020-09-18T04:13:56Z'). |
|
Instrução de consentimento
|
consent_statement | string |
A declaração à qual o constituinte respondeu ao fornecer consentimento. |
|
|
Aviso de privacidade
|
privacy_notice | string |
O aviso de privacidade fornecido ao constituinte. |
Retornos
Consentimento constituinte criado
Criar um relacionamento de organização
Cria uma nova relação de organização. Se a relação for com outro constituinte, uma relação recíproca será criada para esse constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado à relação. |
|
ID da relação
|
relation_id | True | string |
A ID de registro do sistema da organização relacionada. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com a organização relacionada. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
O contato é?
|
is_organization_contact | boolean |
O constituinte representa essa organização como um contato? |
|
|
Tipo de contato
|
organization_contact_type | string |
Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. |
|
|
Cargo
|
position | string |
A posição do indivíduo na organização. Limite de caracteres: 50. |
|
|
Os negócios primários são os principais?
|
is_primary_business | boolean |
Este é o principal negócio do constituinte? |
|
|
Anotações
|
comment | string |
Notas adicionais sobre a relação. |
Retornos
Relação de organização criada
Criar um telefone constituinte
Cria um novo telefone constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado ao telefone. |
|
Tipo
|
type | True | string |
O tipo de telefone. |
|
Número
|
number | True | string |
O número de telefone. |
|
Primário?
|
primary | boolean |
Este é o telefone primário do constituinte? |
|
|
Não ligar?
|
do_not_call | boolean |
O constituinte pode ser contatado neste número? |
|
|
Inativo?
|
inactive | boolean |
Esse número de telefone está inativo? |
Retornos
Telefone constituinte criado
Criar um tributo constituinte
Cria um novo tributo constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_record_id | True | integer |
A ID do registro do sistema do constituinte associado ao tributo. |
|
Tipo de tributo
|
tribute_type_id | True | integer |
O tipo de tributo. |
|
Description
|
description | string |
A descrição do tributo. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
ID do fundo padrão
|
default_fund_id | integer |
A ID de registro do sistema do fundo padrão associado ao tributo. |
|
|
Anotações
|
notes | string |
As notas do tributo. |
|
|
Ativo?
|
is_active | boolean |
Esse tributo está ativo? |
Retornos
Tributo constituinte criado
Criar uma atribuição de arrecadação de fundos
Cria uma nova tarefa de arrecadação de fundos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da arrecadação de fundos
|
fundraiser_id | True | string |
A ID do registro do sistema da arrecadação de fundos. |
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte atribuído. |
|
Tipo
|
type | string |
O tipo de arrecadação de fundos. |
|
|
Início da atribuição
|
start | date-time |
A data de início da atribuição (por exemplo: '2020-09-18T04:13:56Z'). |
|
|
Termina a atribuição
|
end | date-time |
A data de término da atribuição (por exemplo: '2020-09-18T04:13:56Z'). |
|
|
Quantidade
|
value | True | double |
O valor da meta para a arrecadação de fundos solicitar do constituinte atribuído. |
|
ID da Campanha
|
campaign_id | string |
A ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados. |
|
|
ID do fundo
|
fund_id | string |
A ID de registro do sistema do fundo ao qual os presentes resultantes serão aplicados. |
|
|
ID de recurso
|
appeal_id | string |
A ID do registro do sistema do recurso ao qual os presentes resultantes serão aplicados. |
Retornos
Criação de atribuição de arrecadação de fundos
Criar uma educação constituinte
Cria uma nova educação constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID de registro do sistema do constituinte associado à educação. |
|
Escola
|
school | True | string |
O nome da escola/estabelecimento. |
|
Tipo
|
type | string |
O tipo de educação. |
|
|
Classe de
|
class_of | string |
O ano em que o constituinte se formou. |
|
|
Situação
|
status | string |
O status da educação. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Grau
|
degree | string |
O grau recebido. |
|
|
GPA
|
gpa | double |
A média de pontos de nota. |
|
|
Assunto de estudo
|
subject_of_study | string |
O assunto do estudo. |
|
|
Primário?
|
primary | boolean |
Esta é a associação de escola primária do constituinte? |
|
|
Majors
|
majors | array of string |
Os principais cursos de estudo. |
|
|
Menores
|
minors | array of string |
Os cursos secundários de estudo. |
|
|
Campus
|
campus | string |
O campus. Limite de caracteres: 50. |
|
|
Organização social
|
social_organization | string |
A organização social. Limite de caracteres: 50. |
|
|
Nome conhecido
|
known_name | string |
O nome conhecido. Limite de caracteres: 50. |
|
|
Classe de grau
|
class_of_degree | string |
A classe de grau (aplicável somente para versões do Reino Unido). |
|
|
Departamento
|
department | string |
O nome do departamento de educação (aplicável apenas para versões do Reino Unido). |
|
|
Faculdade
|
faculty | string |
O nome do corpo docente (aplicável somente para versões do Reino Unido). |
|
|
Número de registro
|
registration_number | string |
O número de registro (aplicável somente para versões do Reino Unido). Limite de caracteres: 50. |
Retornos
Educação constituinte criada
Criar uma nota constituinte
Cria uma nova nota constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado à anotação. |
|
Tipo
|
type | True | string |
O tipo de anotação. |
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
Resumo
|
summary | string |
O resumo da anotação. Limite de caracteres: 50. |
|
|
Observação
|
text | string |
O texto da anotação. |
|
|
Autor
|
author | string |
O autor da anotação. Se não for fornecido, terá um conjunto padrão com base na conta do usuário. Limite de caracteres: 50. |
Retornos
Anotação constituinte criada
Criar uma presença online constituinte
Cria uma nova presença online constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado à presença online. |
|
Tipo
|
type | True | string |
O tipo de presença online. |
|
Link
|
address | True | string |
O endereço da Web para a presença online. |
|
Primário?
|
primary | boolean |
Esta é a principal presença online do constituinte? |
|
|
Inativo?
|
inactive | boolean |
Essa presença online está inativa? |
Retornos
Presença online constituinte criada
Criar uma relação individual
Cria uma nova relação individual. Se a relação for com outro constituinte, uma relação recíproca será criada para esse constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte associado à relação. |
|
ID da relação
|
relation_id | True | string |
A ID do registro do sistema do indivíduo relacionado. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, em uma relação entre um constituinte masculino e um irmão feminino, o tipo de relação recíproca seria irmão. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
dia
|
d | integer |
O dia na data difusa. |
|
|
month
|
m | integer |
O mês na data difusa. |
|
|
ano
|
y | integer |
O ano na data difusa. |
|
|
O cônjuge é?
|
is_spouse | boolean |
O indivíduo relacionado é o cônjuge do constituinte? |
|
|
É o chefe de família constituinte?
|
is_constituent_head_of_household | boolean |
O constituinte é o chefe da casa? |
|
|
O cônjuge é o chefe da casa?
|
is_spouse_head_of_household | boolean |
O cônjuge é o chefe da casa? |
|
|
Anotações
|
comment | string |
Notas adicionais sobre a relação. |
Retornos
Relação individual criada
Excluir um código constituinte
Exclui um código constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do código constituinte
|
constituent_code_id | True | string |
A ID do registro do sistema do código constituinte a ser excluído. |
Listar aliases constituintes
Lista os aliases de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Aliases
Listar anexos constituintes
Lista os anexos de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Attachments
Listar anotações constituintes
Lista as anotações de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Anotações
Listar arrecadações de fundos constituintes
Lista as atribuições de arrecadação de fundos para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Incluir inativo?
|
include_inactive | boolean |
Incluir atribuições inativas de arrecadação de fundos? |
Retornos
Atribuições de arrecadação de fundos
Listar associações constituintes
Lista as associações de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Associações
Listar atribuições de arrecadação de fundos
Liste as tarefas para uma arrecadação de fundos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da arrecadação de fundos
|
fundraiser_id | True | string |
A ID do registro do sistema da arrecadação de fundos para quem as atribuições devem ser retornadas. |
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Assignments
Listar campos personalizados constituintes
Lista os campos personalizados para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Campos Personalizados
Listar constituintes
Retorna uma lista de constituintes.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
List
|
list_id | string |
Define um identificador de lista usado para filtrar o conjunto de constituintes para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
|
|
Código constituinte
|
constituent_code | string |
Representa um código constituinte para filtrar a lista. Por exemplo, "Membro do Conselho" retorna somente os constituintes com um código constituinte membro do conselho. |
|
|
ID do Constituinte
|
constituent_id | string |
Representa uma lista separada por vírgulas de IDs de registro do sistema constituinte para filtrar os resultados. Por exemplo, "280.1232" retorna apenas o constituinte 280 ou o constituinte 1232. |
|
|
Categoria de campo personalizado
|
custom_field_category | string |
Representa uma categoria de campo personalizada para filtrar os resultados. Por exemplo, "Aniversário" retorna somente os constituintes com um campo personalizado de Aniversário ativo. |
|
|
Status da arrecadação de fundos
|
fundraiser_status | string |
Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo, Nenhum" retorna apenas os eleitores cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para esse filtro são Ativo, Inativo e Nenhum. |
|
|
Incluir falecido?
|
include_deceased | boolean |
Incluir eleitores falecidos na resposta? |
|
|
Incluir inativo?
|
include_inactive | boolean |
Incluir componentes inativos na resposta? |
|
|
CEP
|
postal_code | string |
Representa uma lista separada por vírgulas de códigos postais para filtrar os resultados. Por exemplo, "29466,29492" retorna apenas os constituintes cujo endereço preferencial tem um código postal que começa com 29466 ou 29492, como 29466, 29492 ou 29492-0727. |
|
|
Adicionado em ou após
|
date_added | date-time |
Filtre os resultados para os constituintes criados em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z'). |
|
|
Modificado em ou após
|
last_modified | date-time |
Filtre os resultados para os constituintes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z'). |
|
|
Classificado por
|
sort | string |
Representa uma lista de campos para classificar os resultados. Os resultados estão em ordem crescente por padrão e um sinal '-' indica ordem decrescente. Por exemplo, "date_added,-last" classifica os constituintes pelo campo "date_added" em ordem crescente e, em seguida, pelo campo "último" em ordem decrescente. |
Retornos
Constituintes
Listar códigos constituintes
Lista os códigos constituintes para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Códigos constituintes
Listar códigos de solicitação constituintes
Lista os códigos de solicitação para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Solicitar códigos
Listar educaçãos constituintes
Lista os registros de educação de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Educações
Listar endereços constituintes
Lista os endereços de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Incluir inativo?
|
include_inactive | boolean |
Incluir endereços inativos? |
Retornos
Addresses
Listar endereços de email constituintes
Lista os endereços de email de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Incluir inativo?
|
include_inactive | boolean |
Incluir endereços de email inativos? |
Retornos
Endereços de email
Listar presenças online constituintes
Lista as presenças online de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Incluir inativo?
|
include_inactive | boolean |
Incluir presenças online inativas? |
Retornos
Presenças online
Listar reconhecimentos de tributo
Lista os reconhecimentos de um tributo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo
|
tributeId | True | integer |
A ID do registro do sistema do tributo. |
Retornos
Reconhecimentos de tributo
Listar registros de consentimento do constituinte
Lista os registros de consentimento de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Mais recente apenas?
|
most_recent_only | boolean |
Incluir apenas os registros de consentimento mais recentes para cada combinação de categoria de canal na resposta? |
Retornos
Registros de consentimento
Listar relações constituintes
Lista as relações de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. Não há no máximo. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Relationships
Listar telefones constituintes
Lista os telefones de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
|
Incluir inativo?
|
include_inactive | boolean |
Incluir telefones inativos? |
Retornos
Telefones
Listar tributos constituintes
Lista os tributos para um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituentId | True | integer |
A ID do registro do sistema do constituinte. |
Retornos
Tributos
Obter resumo do formato de nome constituinte
Retorna o resumo do formato de nome de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte. |
Retornos
Resumo do formato de nome
Obter um constituinte
Retorna informações sobre um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID de registro do sistema do constituinte a ser obtido. |
Retornos
Constituinte
Obter um constituinte por ID de pesquisa
Retorna a ID de registro do sistema de um constituinte da ID de pesquisa especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de pesquisa
|
constituent_id | True | string |
A ID de pesquisa constituinte. |
Retornos
Mapa da ID constituinte
Obter um tributo constituinte
Retorna detalhes sobre um tributo constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do tributo
|
tribute_id | True | string |
A ID do tributo. |
Retornos
Tributo
Obter uma imagem de perfil constituinte
Retorna a imagem de perfil atual de um constituinte.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Constituinte
|
constituent_id | True | string |
A ID do registro do sistema do constituinte para o qual a imagem de perfil deve ser recuperada. |
Retornos
Imagem do perfil
Pesquisar componentes duplicados
Pesquisa registros de contato individuais, de organização e relacionados e classifica possíveis duplicatas com base nos filtros de pesquisa especificados. Os registros que correspondem a vários filtros são classificados como duplicatas potenciais.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Sobrenome/nome da organização
|
last_org_name | True | string |
Um filtro para registros que correspondem ao sobrenome ou ao nome da organização especificado. |
|
Nome
|
first_name | string |
Um filtro para registros individuais que correspondem ao nome especificado. |
|
|
Nome do meio
|
middle_name | string |
Um filtro para registros individuais que correspondem ao nome do meio especificado. |
|
|
Sufixo
|
suffix | string |
Um filtro para registros individuais que correspondem ao sufixo especificado. |
|
|
Bloco de endereços
|
address_block | string |
Um filtro para registros que correspondem ao bloco de endereço especificado. |
|
|
City
|
city | string |
Um filtro para registros que correspondem à cidade especificada. |
|
|
Estado
|
state | string |
Um filtro para registros que correspondem ao estado especificado. |
|
|
CEP
|
post_code | string |
Um filtro para registros que correspondem ao código postal especificado. |
|
|
Email
|
array |
Um filtro para registros que correspondem aos endereços de email especificados. |
||
|
Telefone
|
phone | array |
Um filtro para registros que correspondem aos números de telefone especificados. |
|
|
Pesquisar indivíduos?
|
search_individuals | boolean |
Pesquisar registros individuais duplicados? |
|
|
Pesquisar aliases?
|
search_aliases | boolean |
Pesquisar pelo alias, conforme especificado pelo parâmetro sobrenome/nome da organização? |
|
|
Pesquisar contatos?
|
search_contacts | boolean |
Pesquisar registros de contato de relação? |
|
|
Limit
|
limit | integer |
O número de registros a serem retornados ao paginar os resultados (Padrão = 3). |
|
|
Offset
|
offset | integer |
O número de registros a serem ignoradas ao paginar os resultados. |
Retornos
Resultados da pesquisa duplicados
Pesquisar um constituinte
Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Dá suporte ao nome, sobrenome, nome preferencial, nome antigo, alias, endereço de email, número de telefone, endereço ou ID de pesquisa. Combinações de nomes como nome e sobrenome ou nome preferencial e sobrenome são válidas, mas caso contrário, a pesquisa só dá suporte a um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras ortografias alternativas. Essa pesquisa não dá suporte a caracteres curinga como * ou ?. Os resultados da pesquisa são limitados a 500 registros.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
search_text | True | string |
O texto da pesquisa. Dá suporte ao nome, sobrenome, nome preferencial, nome antigo, alias, endereço de email, número de telefone, endereço ou ID de pesquisa. Combinações de nomes como nome e sobrenome ou nome preferencial e sobrenome são válidas, mas caso contrário, a pesquisa só dá suporte a um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras ortografias alternativas. Essa pesquisa não dá suporte a caracteres curinga como * ou ?. Os resultados da pesquisa são limitados a 500 registros. |
|
Status da arrecadação de fundos
|
fundraiser_status | string |
Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo, Nenhum" retorna apenas os eleitores cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para esse filtro são Ativo, Inativo e Nenhum. |
|
|
Incluir inativo?
|
include_inactive | boolean |
Incluir componentes inativos na resposta? |
|
|
Campo de pesquisa
|
search_field | string |
Representa um campo no qual pesquisar. Atualmente, ele só dá suporte a lookup_id. Se for fornecido com search_text, um constituinte com lookup_id que corresponda ao search_text será retornado. |
|
|
Usar uma pesquisa estrita?
|
strict_search | boolean |
Excluir constituintes cujos nomes soam como o texto de pesquisa, mas são escritos de forma diferente? |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000. |
|
|
Offset
|
offset | integer |
Representa o número de registros a serem ignoradas. Para uso com paginação. |
Retornos
Resultados da pesquisa
Pesquisar um constituinte (aprimorado)
Pesquisa registros constituintes usando os critérios de filtro especificados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
first_name | string |
Nome constituinte. |
|
|
Sobrenome
|
last_name | string |
Sobrenome constituinte. |
|
|
ID de pesquisa
|
lookup_id | string |
ID de pesquisa constituinte. |
|
|
Endereço de email
|
string |
Endereço de email constituinte. |
||
|
Número de telefone
|
phone_number | string |
Número de telefone. |
|
|
Limit
|
limit | integer |
Representa o número de registros a serem retornados. O padrão é 500. O máximo é 1000. |
|
|
Linhas de endereço
|
address_lines | string |
Linhas de endereço. |
|
|
City
|
city | string |
Cidade do endereço. |
|
|
Estado
|
state | string |
Estado do endereço. |
|
|
CEP
|
post_code | string |
Endereço postal code. |
|
|
Incluir alias?
|
include_alias | boolean |
Incluir alias ao pesquisar o sobrenome? |
|
|
Tipo de pseudônimo
|
alias_type | string |
Tipo de alias. |
|
|
Incluir nome de solteira?
|
include_maiden_name | boolean |
Incluir o nome de solteira ao pesquisar o sobrenome? |
Retornos
Constituintes
Definições
CommPrefApi.ConstituentConsentRead
Representa uma entidade de consentimento para um constituinte.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do registro de consentimento. |
|
Channel
|
channel | string |
O canal ao qual a resposta de consentimento se aplica. |
|
Categoria
|
category | string |
A categoria à qual a resposta de consentimento se aplica. |
|
Source
|
source | string |
A origem da resposta de consentimento do constituinte. |
|
Resposta
|
constituent_consent_response | string |
Como o constituinte respondeu ao consentimento do canal/categoria especificado. |
|
Date
|
consent_date | date-time |
A data em que a resposta de consentimento foi recebida. |
|
Instrução de consentimento
|
consent_statement | string |
A declaração à qual o constituinte respondeu ao fornecer consentimento. |
|
Aviso de privacidade
|
privacy_notice | string |
O aviso de privacidade fornecido ao constituinte. |
|
Data de inclusão
|
date_added | date-time |
A data em que a resposta de consentimento foi adicionada. |
|
Adicionado por
|
user_name | string |
O usuário que adicionou a resposta de consentimento. |
CommPrefApi.ConstituentConsentReadCollection
Registros de consentimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de registros de consentimento na lista. |
|
value
|
value | array of CommPrefApi.ConstituentConsentRead |
O conjunto de registros de consentimento incluído na resposta. |
CommPrefApi.ConstituentSolicitCodeRead
Solicitar código
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema do código de solicitação constituinte. |
|
Solicitar código
|
solicit_code | string |
Instruções de comunicação e/ou restrições para um constituinte. |
|
Data de início
|
start_date | date |
A data de início do código de solicitação (por exemplo: '2005-09-18'). |
|
Data de término
|
end_date | date |
A data de término do código de solicitação (por exemplo: '2005-09-18'). |
CommPrefApi.ConstituentSolicitCodeReadCollection
Solicitar códigos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de códigos de solicitação constituintes na lista. |
|
value
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
O conjunto de códigos de solicitação constituintes incluídos na resposta. |
CommPrefApi.CreatedConstituentConsent
Consentimento constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro de consentimento recém-criado. |
CommPrefApi.CreatedConstituentSolicitCode
Código de solicitação constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do código de solicitação constituinte recém-criado. |
ConstituentApi.AddressRead
Endereço
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do endereço. |
|
Tipo
|
type | string |
O tipo de endereço. |
|
País
|
country | string |
O país do endereço (pode ser a ID, o nome ou a abreviação). |
|
Linhas de endereço
|
address_lines | string |
As linhas de endereço. |
|
City
|
city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
Estado
|
state | string |
O estado do endereço. |
|
CEP
|
postal_code | string |
O código postal do endereço. |
|
Subúrbio
|
suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
Município
|
county | string |
A região do endereço. |
|
Endereço formatado
|
formatted_address | string |
O endereço formatado no formato configurado do país. |
|
Fonte de informações
|
information_source | string |
A fonte de informações do endereço. |
|
Região
|
region | string |
A região do endereço. |
|
CARROÇA
|
cart | string |
A rota da transportadora (CART) para o endereço. |
|
LOTE
|
lot | string |
A linha de viagem (LOT) para o endereço. |
|
DPC
|
dpc | string |
O código do ponto de entrega (DPC) para o endereço. |
|
Válido a partir de
|
start | date-time |
A data em que o constituinte começou a residir neste endereço. |
|
Válida até
|
end | date-time |
A data em que o constituinte deixou de residir neste endereço. |
|
Primário?
|
preferred | boolean |
Este é o endereço preferencial do constituinte? |
|
Inativo?
|
inactive | boolean |
O endereço está inativo (ou seja, a data atual é antes de qualquer data de término)? |
|
Não enviar emails?
|
do_not_mail | boolean |
O constituinte pode ser contatado neste endereço? |
|
dia
|
seasonal_start.d | integer |
O dia na data difusa. |
|
month
|
seasonal_start.m | integer |
O mês na data difusa. |
|
ano
|
seasonal_start.y | integer |
O ano na data difusa. |
|
dia
|
seasonal_end.d | integer |
O dia na data difusa. |
|
month
|
seasonal_end.m | integer |
O mês na data difusa. |
|
ano
|
seasonal_end.y | integer |
O ano na data difusa. |
|
Data de inclusão
|
date_added | date-time |
A data em que o endereço foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o endereço foi modificado pela última vez. |
ConstituentApi.AliasRead
Alias
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do alias. |
|
Alias
|
name | string |
O nome a ser usado como alias do constituinte. |
|
Tipo
|
type | string |
O tipo de alias. |
ConstituentApi.ApiCollectionOfAddressRead
Addresses
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.AddressRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.AliasRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
Attachments
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.ConstituentAttachmentRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfConstituentCodeRead
Códigos constituintes
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.ConstituentCodeRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
Campos Personalizados
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.ConstituentCustomFieldRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfConstituentRead
Constituintes
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.ConstituentRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfEducationRead
Educações
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.EducationRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfEmailAddressRead
Endereços de email
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.EmailAddressRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
Atribuições de arrecadação de fundos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.FundraiserAssignmentRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfMembershipRead
Associações
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.MembershipRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfNoteRead
Anotações
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.NoteRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
Presenças online
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.OnlinePresenceRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfPhoneRead
Telefones
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.PhoneRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfRelationshipRead
Relationships
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.RelationshipRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ApiCollectionOfSearchResultRead
Resultados da pesquisa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.SearchResultRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.ConstituentAttachmentRead
Anexo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do anexo. |
|
ID do Constituinte
|
parent_id | string |
A ID do registro do sistema do constituinte associado ao anexo. |
|
Tipo
|
type | string |
O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente. |
|
Nome
|
name | string |
O nome do anexo. Limite de caracteres: 150. |
|
Date
|
date | date-time |
A data do anexo. |
|
URL
|
url | string |
A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos. |
|
Nome do arquivo
|
file_name | string |
O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos. |
|
ID de Arquivo
|
file_id | string |
O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos. |
|
ID da miniatura
|
thumbnail_id | string |
O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos. |
|
URL de miniatura
|
thumbnail_url | string |
A URL de uma miniatura. Para anexos físicos que são somente imagens. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos. |
|
Tipo de conteúdo
|
content_type | string |
O tipo de conteúdo. Somente para anexos físicos. |
|
Tamanho do arquivo
|
file_size | integer |
O tamanho do arquivo em bytes. Somente para anexos físicos. |
|
Etiquetas
|
tags | array of string |
As marcas associadas ao anexo. |
ConstituentApi.ConstituentCodeRead
Código constituinte
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do código constituinte. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado ao código constituinte. |
|
Código constituinte
|
description | string |
O código constituinte. |
|
dia
|
start.d | integer |
O dia na data difusa. |
|
month
|
start.m | integer |
O mês na data difusa. |
|
ano
|
start.y | integer |
O ano na data difusa. |
|
dia
|
end.d | integer |
O dia na data difusa. |
|
month
|
end.m | integer |
O mês na data difusa. |
|
ano
|
end.y | integer |
O ano na data difusa. |
|
Inativo?
|
inactive | boolean |
O código constituinte está inativo? |
|
Sequence
|
sequence | integer |
A sequência numérica associada ao código constituinte. |
|
Data de inclusão
|
date_added | date-time |
A data em que o código constituinte foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o código constituinte foi modificado pela última vez. |
ConstituentApi.ConstituentCustomFieldRead
Campo personalizado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do campo personalizado. |
|
ID do Constituinte
|
parent_id | string |
A ID do registro do sistema do constituinte associado ao campo personalizado. |
|
Categoria
|
category | string |
A categoria de campo personalizado. |
|
Tipo
|
type | string |
O tipo de dados que o campo personalizado representa. |
|
Value
|
value |
O valor do campo personalizado. |
|
|
Valor do texto
|
text_value | string |
O valor do texto do campo personalizado. |
|
Valor do número
|
number_value | integer |
O valor numérico do campo personalizado. |
|
Valor da data
|
date_value | date |
O valor de data do campo personalizado. |
|
Valor da moeda
|
currency_value | double |
O valor da moeda do campo personalizado. |
|
Valor booliano
|
boolean_value | boolean |
O valor booliano do campo personalizado. |
|
Valor de entrada da tabela
|
codetableentry_value | string |
O valor de entrada da tabela do campo personalizado. |
|
Valor da ID constituinte
|
constituentid_value | string |
O valor da ID do constituinte do campo personalizado. |
|
dia
|
fuzzydate_value.d | integer |
O dia na data difusa. |
|
month
|
fuzzydate_value.m | integer |
O mês na data difusa. |
|
ano
|
fuzzydate_value.y | integer |
O ano na data difusa. |
|
Date
|
date | date |
A data no campo personalizado. |
|
Comment
|
comment | string |
O comentário no campo personalizado. Limite de caracteres: 50. |
|
Data de inclusão
|
date_added | date-time |
A data em que o campo personalizado foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o campo personalizado foi modificado pela última vez. |
ConstituentApi.ConstituentRead
Constituinte
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema para o constituinte. Isso não é o mesmo que o identificador de constituinte definível pelo usuário, que é armazenado no lookup_id. |
|
Tipo
|
type | string |
O tipo de constituinte. |
|
Title
|
title | string |
O título primário do constituinte (somente para indivíduos). |
|
Nome
|
first | string |
O nome do constituinte (somente para indivíduos). |
|
Sobrenome
|
last | string |
O sobrenome do constituinte (somente para indivíduos). |
|
Nome
|
name | string |
Para indivíduos, esse campo é o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. Para organizações, esse é o nome da organização. |
|
Nome preferencial
|
preferred_name | string |
O nome preferencial do constituinte (somente para indivíduos). |
|
Sufixo
|
suffix | string |
O sufixo primário do constituinte (somente para indivíduos). |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o constituinte. |
|
ID
|
email.id | string |
A ID do registro do sistema do endereço de email. |
|
tipo
|
email.type | string |
O tipo de endereço de email. |
|
address
|
email.address | string |
O endereço de email. |
|
não enviar email?
|
email.do_not_email | boolean |
O constituinte pode ser contatado neste endereço de email? |
|
inativo?
|
email.inactive | boolean |
Esse endereço de email está inativo? |
|
data adicionada
|
email.date_added | date-time |
A data em que o endereço de email foi criado. |
|
data modificada
|
email.date_modified | date-time |
A data em que o endereço de email foi modificado pela última vez. |
|
ID
|
phone.id | string |
A ID do registro do sistema do telefone. |
|
tipo
|
phone.type | string |
O tipo de telefone. |
|
número
|
phone.number | string |
O número de telefone. |
|
não ligar?
|
phone.do_not_call | boolean |
O constituinte pode ser contatado neste número? |
|
inativo?
|
phone.inactive | boolean |
Esse número de telefone está inativo? |
|
data adicionada
|
phone.date_added | date-time |
A data em que o telefone foi criado. |
|
data modificada
|
phone.date_modified | date-time |
A data em que o telefone foi modificado pela última vez. |
|
ID
|
online_presence.id | string |
A ID do registro do sistema da presença online. |
|
tipo
|
online_presence.type | string |
O tipo de presença online. |
|
link
|
online_presence.address | string |
O endereço da Web para a presença online. |
|
inativo?
|
online_presence.inactive | boolean |
Essa presença online está inativa? |
|
data adicionada
|
online_presence.date_added | date-time |
A data em que a presença online foi criada. |
|
data modificada
|
online_presence.date_modified | date-time |
A data em que a presença online foi modificada pela última vez. |
|
ID
|
address.id | string |
A ID do registro do sistema do endereço. |
|
tipo
|
address.type | string |
O tipo de endereço. |
|
country
|
address.country | string |
O país do endereço (pode ser a ID, o nome ou a abreviação). |
|
Linhas
|
address.address_lines | string |
As linhas de endereço. |
|
city
|
address.city | string |
A cidade do endereço (não use em combinação com o campo Subúrbio). |
|
estado
|
address.state | string |
O estado do endereço. |
|
código postal
|
address.postal_code | string |
O código postal do endereço. |
|
subúrbio
|
address.suburb | string |
O subúrbio do endereço (não use em combinação com o campo Cidade). |
|
condado
|
address.county | string |
A região do endereço. |
|
Formatado
|
address.formatted_address | string |
O endereço formatado no formato configurado do país. |
|
válido de
|
address.start | date-time |
A data em que o constituinte começou a residir neste endereço. |
|
válido para
|
address.end | date-time |
A data em que o constituinte deixou de residir neste endereço. |
|
inativo?
|
address.inactive | boolean |
O endereço está inativo (ou seja, a data atual é antes de qualquer data de término)? |
|
não enviar emails?
|
address.do_not_mail | boolean |
O constituinte pode ser contatado neste endereço? |
|
dia
|
address.seasonal_start.d | integer |
O dia na data difusa. |
|
month
|
address.seasonal_start.m | integer |
O mês na data difusa. |
|
ano
|
address.seasonal_start.y | integer |
O ano na data difusa. |
|
dia
|
address.seasonal_end.d | integer |
O dia na data difusa. |
|
month
|
address.seasonal_end.m | integer |
O mês na data difusa. |
|
ano
|
address.seasonal_end.y | integer |
O ano na data difusa. |
|
data adicionada
|
address.date_added | date-time |
A data em que o endereço foi criado. |
|
data modificada
|
address.date_modified | date-time |
A data em que o endereço foi modificado pela última vez. |
|
Gênero
|
gender | string |
O gênero do constituinte (somente para indivíduos). |
|
Nome do meio
|
middle | string |
O nome do meio do constituinte (somente para indivíduos). |
|
Nome antigo
|
former_name | string |
O nome antigo do constituinte (somente para indivíduos). |
|
Título 2
|
title_2 | string |
O título secundário do constituinte (somente para indivíduos). |
|
Sufixo 2
|
suffix_2 | string |
O sufixo secundário do constituinte (somente para indivíduos). |
|
Staus conjugal
|
marital_status | string |
O estado civil do constituinte (somente para indivíduos). |
|
Dá anonimamente?
|
gives_anonymously | boolean |
O constituinte dá anonimamente? |
|
Não solicita nenhum email?
|
requests_no_email | boolean |
O constituinte não solicita nenhum email? |
|
É um advogado?
|
is_solicitor | boolean |
O constituinte é um advogado? |
|
Nenhum endereço válido?
|
no_valid_address | boolean |
O constituinte não tem endereços válidos? |
|
Inativo?
|
inactive | boolean |
O constituinte está inativo? |
|
dia
|
birthdate.d | integer |
O dia na data difusa. |
|
month
|
birthdate.m | integer |
O mês na data difusa. |
|
ano
|
birthdate.y | integer |
O ano na data difusa. |
|
Terra natal
|
birthplace | string |
O local de nascimento do constituinte (somente para indivíduos). |
|
Etnia
|
ethnicity | string |
A etnia do constituinte (somente para indivíduos). |
|
Meta
|
target | string |
O destino do constituinte. |
|
Rendimento
|
income | string |
A renda do constituinte (somente para pessoas físicas). |
|
Tipo de recibo
|
receipt_type | string |
O tipo de recibo do constituinte. |
|
Religião
|
religion | string |
A religião do constituinte (somente para indivíduos). |
|
Setor
|
industry | string |
A indústria do constituinte (somente para organizações). |
|
Número de funcionários
|
num_employees | integer |
O número de funcionários da organização. |
|
Corresponde a presentes?
|
matches_gifts | boolean |
A organização corresponde a presentes? |
|
Fator presente correspondente
|
matching_gift_factor | double |
O fator presente correspondente (somente para organizações). |
|
value
|
matching_gift_per_gift_min.value | double |
O valor da quantidade. |
|
value
|
matching_gift_per_gift_max.value | double |
O valor da quantidade. |
|
value
|
matching_gift_total_min.value | double |
O valor da quantidade. |
|
value
|
matching_gift_total_max.value | double |
O valor da quantidade. |
|
Notas de presente correspondentes
|
matching_gift_notes | string |
As notas de presente correspondentes para o constituinte (somente para organizações). |
|
Idade
|
age | integer |
A idade do constituinte, conforme calculado com base na propriedade de data de nascimento (somente para indivíduos). |
|
Falecido?
|
deceased | boolean |
O constituinte está falecido (somente para indivíduos)? |
|
dia
|
deceased_date.d | integer |
O dia na data difusa. |
|
month
|
deceased_date.m | integer |
O mês na data difusa. |
|
ano
|
deceased_date.y | integer |
O ano na data difusa. |
|
Status da arrecadação de fundos
|
fundraiser_status | string |
Indica se o constituinte é uma arrecadação de fundos (somente para indivíduos). |
|
É memorial?
|
is_memorial | boolean |
O constituinte é uma honra/memorial? |
|
ID
|
spouse.id | string |
A ID do registro do sistema do cônjuge. |
|
nome próprio
|
spouse.first | string |
O nome do cônjuge. |
|
apelido
|
spouse.last | string |
O sobrenome do cônjuge. |
|
é o chefe da casa?
|
spouse.is_head_of_household | boolean |
O cônjuge é o chefe da casa? |
|
Data de inclusão
|
date_added | date-time |
A data em que o constituinte foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o constituinte foi modificado pela última vez. |
ConstituentApi.ConvertConstituent
Constituinte convertido
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do constituinte convertido. |
ConstituentApi.CreatedConstituentAddress
Endereço constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do endereço constituinte recém-criado. |
ConstituentApi.CreatedConstituentAlias
Alias constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do alias constituinte recém-criado. |
ConstituentApi.CreatedConstituentAttachment
Anexo constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do anexo constituinte recém-criado. |
ConstituentApi.CreatedConstituentCode
Código constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do código constituinte recém-criado. |
ConstituentApi.CreatedConstituentCustomField
Campo personalizado constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do campo personalizado constituinte recém-criado. |
ConstituentApi.CreatedConstituentEducation
Educação constituinte criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da educação constituinte recém-criada. |
ConstituentApi.CreatedConstituentEmailAddress
Endereço de email constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do endereço de email constituinte recém-criado. |
ConstituentApi.CreatedConstituentNote
Anotação constituinte criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da nota constituinte recém-criada. |
ConstituentApi.CreatedConstituentOnlinePresence
Presença online constituinte criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da presença online constituinte recém-criada. |
ConstituentApi.CreatedConstituentPhone
Telefone constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do telefone constituinte recém-criado. |
ConstituentApi.CreatedIndividualConstituent
Constituinte individual criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do constituinte individual recém-criado. |
ConstituentApi.CreatedIndividualRelationship
Relação individual criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da relação individual recém-criada. |
ConstituentApi.CreatedNameFormat
Formato de nome criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do formato de nome recém-criado. |
ConstituentApi.CreatedOrganizationConstituent
Constituinte da organização criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do constituinte da organização recém-criado. |
ConstituentApi.CreatedOrganizationRelationship
Relação de organização criada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da relação de organização recém-criada. |
ConstituentApi.DuplicateSearchResult
Resultado da pesquisa duplicada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema para o constituinte. |
|
Nome
|
name | string |
O nome do constituinte. Para indivíduos, esse campo computado indica o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. |
|
Nome de exibição
|
display_name | string |
O nome de exibição do constituinte. |
|
Endereço
|
formatted_address | string |
O endereço primário formatado para o constituinte. |
|
Falecido?
|
deceased | boolean |
O constituinte está morto? |
|
É um constituinte?
|
is_constituent | boolean |
O registro é um constituinte? |
|
ID de pesquisa
|
constituent_id | string |
O identificador definido pelo usuário para o constituinte. |
|
Data de inclusão
|
date_added | date-time |
A data em que o constituinte foi adicionado. |
|
Classificação
|
rank | string |
A classificação de pesquisa que indica no que o constituinte foi correspondido. |
ConstituentApi.DuplicateSearchResultCollection
Resultados da pesquisa duplicados
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of ConstituentApi.DuplicateSearchResult |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
ConstituentApi.EducationRead
Educação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema da educação. |
|
ID do Constituinte
|
constituent_id | string |
A ID de registro do sistema do constituinte associado à educação. |
|
Escola
|
school | string |
O nome da escola/estabelecimento. |
|
Tipo
|
type | string |
O tipo de educação. |
|
Classe de
|
class_of | string |
O ano em que o constituinte se formou. |
|
Situação
|
status | string |
O status da educação. |
|
dia
|
date_entered.d | integer |
O dia na data difusa. |
|
month
|
date_entered.m | integer |
O mês na data difusa. |
|
ano
|
date_entered.y | integer |
O ano na data difusa. |
|
dia
|
date_left.d | integer |
O dia na data difusa. |
|
month
|
date_left.m | integer |
O mês na data difusa. |
|
ano
|
date_left.y | integer |
O ano na data difusa. |
|
dia
|
date_graduated.d | integer |
O dia na data difusa. |
|
month
|
date_graduated.m | integer |
O mês na data difusa. |
|
ano
|
date_graduated.y | integer |
O ano na data difusa. |
|
Grau
|
degree | string |
O grau recebido. |
|
GPA
|
gpa | double |
A média de pontos de nota. |
|
Majors
|
majors | array of string |
Os principais cursos de estudo. |
|
Menores
|
minors | array of string |
Os cursos secundários de estudo. |
|
O ensino fundamental é?
|
primary | boolean |
Esta é a associação de escola primária do constituinte? |
|
Campus
|
campus | string |
O campus. |
|
Organização social
|
social_organization | string |
A organização social. |
|
Nome conhecido
|
known_name | string |
O nome conhecido. |
|
Classe de grau
|
class_of_degree | string |
A classe de grau. |
|
Departamento
|
department | string |
O nome do departamento de educação. |
|
Faculdade
|
faculty | string |
O nome da faculdade. |
|
Número de registro
|
registration_number | string |
O número do registro. |
|
Assunto de estudo
|
subject_of_study | string |
O assunto do estudo. |
|
Data de inclusão
|
date_added | date-time |
A data em que a educação foi criada. |
|
Data modificada
|
date_modified | date-time |
A data em que a educação foi modificada pela última vez. |
ConstituentApi.EmailAddressRead
Endereço de email
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do endereço de email. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado ao endereço de email. |
|
Tipo de email
|
type | string |
O tipo de endereço de email. |
|
Endereço de email
|
address | string |
O endereço de email. |
|
Primário?
|
primary | boolean |
Este é o endereço de email principal do constituinte? |
|
Não enviar email?
|
do_not_email | boolean |
O constituinte pode ser contatado neste endereço de email? |
|
Inativo?
|
inactive | boolean |
Esse endereço de email está inativo? |
|
Data de inclusão
|
date_added | date-time |
A data em que o endereço de email foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o endereço de email foi modificado pela última vez. |
ConstituentApi.FundraiserAssignmentRead
Atribuição de arrecadação de fundos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema da tarefa de arrecadação de fundos. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte atribuída à arrecadação de fundos. |
|
ID da arrecadação de fundos
|
fundraiser_id | string |
A ID do registro do sistema da arrecadação de fundos. |
|
Tipo
|
type | string |
O tipo de arrecadação de fundos. |
|
value
|
amount.value | double |
O valor monetário. |
|
ID da Campanha
|
campaign_id | string |
A ID de registro do sistema da campanha à qual aplicar presentes resultantes. |
|
ID do fundo
|
fund_id | string |
A ID de registro do sistema do fundo a que os presentes resultantes devem ser aplicados. Se um fundo restrito for selecionado, somente campanhas e recursos associados a esse fundo poderão ser selecionados. |
|
ID de recurso
|
appeal_id | string |
A ID do registro do sistema do recurso que a arrecadação de fundos deve usar para solicitar presentes. |
|
Data de início
|
start | date-time |
A data de início da tarefa de arrecadação de fundos. |
|
Data de término
|
end | date-time |
A data de término da tarefa de arrecadação de fundos. |
ConstituentApi.MembershipMemberRead
Membro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do membro. |
|
ID do Constituinte
|
constituent_id | string |
A ID de registro do sistema do constituinte associado ao membro. |
|
É membro primário?
|
primary | boolean |
Esse é o membro primário? |
ConstituentApi.MembershipRead
Membership
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID de registro do sistema da associação. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado à associação. |
|
Programa
|
program | string |
O programa de associação. |
|
Categoria
|
category | string |
A categoria de associação. |
|
Subcategoria
|
subcategory | string |
A subcategoria de associação. |
|
Situação
|
standing | string |
O status de associação. |
|
Expira
|
expires | date-time |
A data em que a associação expira. |
|
Unido
|
joined | date-time |
A data em que a associação se torna ativa. |
|
value
|
dues.value | double |
O valor monetário. |
|
Members
|
members | array of ConstituentApi.MembershipMemberRead |
O conjunto de membros que pertencem à associação. |
|
Data de inclusão
|
date_added | date-time |
A data em que a associação foi criada. |
|
Data modificada
|
date_modified | date-time |
A data em que a associação foi modificada pela última vez. |
ConstituentApi.NameFormatRead
Os formatos de nome definem como abordar os constituintes nas comunicações. Como você se refere aos indivíduos define o tom de suas comunicações com eles e o quão bem eles recebem suas interações.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do formato de nome. |
|
tipo
|
type | string |
O tipo de formato de nome. |
|
formato personalizado?
|
custom_format | boolean |
Esse é um formato personalizado? |
|
ID de configuração
|
configuration_id | string |
A ID de configuração do formato de nome (para formatos não personalizados). |
|
nome formatado
|
formatted_name | string |
O nome formatado (para formatos personalizados). |
ConstituentApi.NameFormatSummaryRead
Resumo do formato de nome
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
primary_addressee.id | string |
A ID do registro do sistema do formato de nome. |
|
tipo
|
primary_addressee.primary_type | string |
O tipo de formato de nome. |
|
formato personalizado?
|
primary_addressee.custom_format | boolean |
Esse é um formato personalizado? |
|
ID de configuração
|
primary_addressee.configuration_id | string |
A ID de configuração do formato de nome (para formatos não personalizados). |
|
nome formatado
|
primary_addressee.formatted_name | string |
O nome formatado (para formatos personalizados). |
|
ID
|
primary_salutation.id | string |
A ID do registro do sistema do formato de nome. |
|
tipo
|
primary_salutation.primary_type | string |
O tipo de formato de nome. |
|
formato personalizado?
|
primary_salutation.custom_format | boolean |
Esse é um formato personalizado? |
|
ID de configuração
|
primary_salutation.configuration_id | string |
A ID de configuração do formato de nome (para formatos não personalizados). |
|
nome formatado
|
primary_salutation.formatted_name | string |
O nome formatado (para formatos personalizados). |
|
Formatos de nome adicionais
|
additional_name_formats | array of ConstituentApi.NameFormatRead |
Os formatos de nome adicionais do constituinte. |
ConstituentApi.NoteRead
Observação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema da anotação. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado à anotação. |
|
Tipo
|
type | string |
O tipo de anotação. |
|
dia
|
date.d | integer |
O dia na data difusa. |
|
month
|
date.m | integer |
O mês na data difusa. |
|
ano
|
date.y | integer |
O ano na data difusa. |
|
Resumo
|
summary | string |
O resumo da anotação. |
|
Observação
|
text | string |
O texto da anotação. |
|
Data de inclusão
|
date_added | date-time |
A data em que a anotação foi criada. |
|
Data modificada
|
date_modified | date-time |
A data em que a anotação foi modificada pela última vez. |
ConstituentApi.OnlinePresenceRead
Presença online
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema da presença online. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado à presença online. |
|
Tipo
|
type | string |
O tipo de presença online. |
|
Link
|
address | string |
O endereço da Web para a presença online. |
|
Primário?
|
primary | boolean |
Esta é a principal presença online do constituinte? |
|
Inativo?
|
inactive | boolean |
Essa presença online está inativa? |
|
Data de inclusão
|
date_added | date-time |
A data em que a presença online foi criada. |
|
Data modificada
|
date_modified | date-time |
A data em que a presença online foi modificada pela última vez. |
ConstituentApi.PhoneRead
Telefone
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do telefone. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado ao telefone. |
|
Tipo
|
type | string |
O tipo de telefone. |
|
Número
|
number | string |
O número de telefone. |
|
Primário?
|
primary | boolean |
Este é o telefone primário do constituinte? |
|
Não ligar?
|
do_not_call | boolean |
O constituinte pode ser contatado neste número? |
|
Inativo?
|
inactive | boolean |
Esse número de telefone está inativo? |
|
Data de inclusão
|
date_added | date-time |
A data em que o telefone foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o telefone foi modificado pela última vez. |
ConstituentApi.ProfilePictureRead
Imagem do perfil
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado à imagem de perfil. |
|
URL
|
url | string |
A URL da imagem de perfil. A URL contém uma assinatura associada ao tempo que limita o acesso a 60 minutos. |
|
URL de miniatura
|
thumbnail_url | string |
A URL de uma miniatura da imagem de perfil. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos. |
ConstituentApi.RelationshipRead
Relationship
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema da relação. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte associado à relação. |
|
ID da relação
|
relation_id | string |
A ID de registro do sistema do indivíduo ou organização relacionado. |
|
ID de relação recíproca
|
reciprocal_relationship_id | string |
O identificador do registro de relação recíproca. Esse valor é somente leitura e é gerado automaticamente quando a relação é criada. As alterações feitas nesse registro também serão refletidas na recíproca, com exceção da propriedade comments. |
|
Nome
|
name | string |
O nome do constituinte relacionado. Se o constituinte relacionado for um indivíduo, esse será o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. |
|
Tipo
|
type | string |
O tipo de relação que a relação representa. |
|
Tipo recíproco
|
reciprocal_type | string |
Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, em uma relação entre um constituinte masculino e um irmão feminino, o tipo de relação recíproca seria irmão. |
|
dia
|
start.d | integer |
O dia na data difusa. |
|
month
|
start.m | integer |
O mês na data difusa. |
|
ano
|
start.y | integer |
O ano na data difusa. |
|
dia
|
end.d | integer |
O dia na data difusa. |
|
month
|
end.m | integer |
O mês na data difusa. |
|
ano
|
end.y | integer |
O ano na data difusa. |
|
O cônjuge é?
|
is_spouse | boolean |
O indivíduo relacionado é o cônjuge do constituinte (aplica-se apenas às relações entre indivíduos)? |
|
É o chefe de família constituinte?
|
is_constituent_head_of_household | boolean |
O constituinte é o chefe da casa? |
|
O cônjuge é o chefe da casa?
|
is_spouse_head_of_household | boolean |
O cônjuge é o chefe da casa? |
|
Anotações
|
comment | string |
O comentário sobre a relação. |
|
O contato é?
|
is_organization_contact | boolean |
O constituinte representa essa organização como um contato (aplica-se apenas a relações entre organizações e indivíduos)? |
|
Os negócios primários são os principais?
|
is_primary_business | boolean |
Esse é o principal negócio do constituinte (aplica-se apenas às relações entre organizações e indivíduos)? |
|
Tipo de contato
|
organization_contact_type | string |
Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas a relações entre organizações e indivíduos. |
|
Cargo
|
position | string |
A posição do indivíduo na organização. Aplica-se apenas a relações entre organizações e indivíduos. |
|
Data de inclusão
|
date_added | date-time |
A data em que a relação foi criada. |
|
Data modificada
|
date_modified | date-time |
A data em que a relação foi modificada pela última vez. |
ConstituentApi.SearchResultRead
Resultado da pesquisa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema do constituinte. |
|
Nome
|
name | string |
O nome do constituinte. Para indivíduos, esse campo computado indica o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. |
|
Endereço
|
address | string |
O endereço preferencial do constituinte. |
|
Falecido?
|
deceased | boolean |
O constituinte está morto? |
|
Email
|
string |
O endereço de email do constituinte. |
|
|
Status da arrecadação de fundos
|
fundraiser_status | string |
O status de arrecadação de fundos do constituinte. Para indivíduos, esse campo computado indica se o constituinte é Ativo, Inativo ou Nenhum. Para as organizações, esse valor sempre será Nenhum. |
|
Inativo?
|
inactive | boolean |
O constituinte está inativo? |
|
ID de pesquisa
|
lookup_id | string |
O identificador definido pelo usuário para o constituinte. |
FundraisingApi.ApiCollectionOfFundraiserAssignmentRead
Assignments
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of FundraisingApi.FundraiserAssignmentRead |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
FundraisingApi.CreatedFundraiserAssignment
Criação de atribuição de arrecadação de fundos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID da recém-criada tarefa de arrecadação de fundos. |
FundraisingApi.FundraiserAssignmentRead
Assignment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do registro do sistema da tarefa de arrecadação de fundos. |
|
ID do Constituinte
|
constituent_id | string |
A ID do registro do sistema do constituinte atribuído. |
|
Tipo
|
type | string |
O tipo de arrecadação de fundos. |
|
Início da atribuição
|
start | date-time |
A data de início da atribuição. |
|
Termina a atribuição
|
end | date-time |
A data de término da atribuição. |
|
value
|
amount.value | double |
O valor monetário. |
|
ID da Campanha
|
campaign_id | string |
A ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados. |
|
ID do fundo
|
fund_id | string |
A ID de registro do sistema do fundo ao qual os presentes resultantes serão aplicados. |
|
ID de recurso
|
appeal_id | string |
A ID do registro do sistema do recurso ao qual os presentes resultantes serão aplicados. |
NXTDataIntegrationApi.ConstituentIdMap
Mapa da ID constituinte
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
system_record_id | integer |
A ID do registro do sistema constituinte. |
NXTDataIntegrationApi.ConstituentSearchResult
Resultado da pesquisa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
record_id | integer |
A ID do registro do sistema do constituinte. |
|
ID de pesquisa
|
constituent_id | string |
A ID do constituinte. |
|
Indicador de chave
|
key_indicator | string |
O indicador de chave para o registro. |
|
Nome
|
first_name | string |
O nome (somente indivíduos). |
|
Sobrenome
|
last_name | string |
O sobrenome (somente indivíduos). |
|
Nome do meio
|
middle_name | string |
O nome do meio (somente indivíduos). |
|
Nome preferencial
|
preferred_name | string |
O nome preferencial (somente indivíduos). |
|
Nome antigo
|
maiden_name | string |
O nome anterior (somente indivíduos). |
|
Título 1
|
title1 | string |
O título 1 (somente indivíduos). |
|
Sufixo 1
|
suffix1 | string |
O sufixo 1 (somente indivíduos). |
|
Gênero
|
gender | string |
O gênero constituinte (somente indivíduos). |
|
dia
|
birth_date.d | integer |
O dia na data difusa. |
|
month
|
birth_date.m | integer |
O mês na data difusa. |
|
ano
|
birth_date.y | integer |
O ano na data difusa. |
|
Nome do cônjuge
|
spouse_first_name | string |
O nome do cônjuge (somente indivíduos). |
|
Sobrenome do cônjuge
|
spouse_last_name | string |
O sobrenome do cônjuge (somente indivíduos). |
|
Nome da organização
|
org_name | string |
O nome da organização (somente organizações). |
|
Bloco de endereços
|
address_block | string |
O bloco de endereços. |
|
Cidade e estado
|
address_city_state | string |
A cidade e o estado do endereço. |
|
CEP
|
address_post_code | string |
O código de postagem de endereço. |
|
Endereço de e-mail principal
|
primary_email | string |
O email primário. |
|
Número de telefone primário
|
primary_phone | string |
O telefone primário. |
|
Alias correspondente
|
matched_alias | string |
O nome do alias correspondente (somente indivíduos). |
|
Email correspondente
|
matched_email | string |
O endereço de email correspondente. |
|
Telefone correspondente
|
matched_phone | string |
O número de telefone correspondente. |
|
É um constituinte?
|
is_constituent | boolean |
O registro é um constituinte? |
|
Está morto?
|
is_deceased | boolean |
O registro está morto? |
|
Está inativo?
|
is_inactive | boolean |
O registro está inativo? |
NXTDataIntegrationApi.ConstituentSearchResultCollection
Constituintes
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
results
|
results | array of NXTDataIntegrationApi.ConstituentSearchResult |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
NXTDataIntegrationApi.CreatedConstituentTribute
Tributo constituinte criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do tributo constituinte recém-criado. |
NXTDataIntegrationApi.CreatedTributeAcknowledgee
Reconhecimento de tributo criado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
A ID do tributo recém-criado reconhece. |
NXTDataIntegrationApi.Tribute
Tributo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID do registro do sistema do tributo. |
|
ID do Constituinte
|
constituent_record_id | integer |
A ID do registro do sistema do constituinte associado ao tributo. |
|
Tipo de tributo
|
tribute_type_name | string |
O tipo de tributo. |
|
ID do tipo tributo
|
tribute_type_id | integer |
A ID do tipo tributo. |
|
Description
|
description | string |
A descrição do tributo. |
|
dia
|
start_date.d | integer |
O dia na data difusa. |
|
month
|
start_date.m | integer |
O mês na data difusa. |
|
ano
|
start_date.y | integer |
O ano na data difusa. |
|
dia
|
end_date.d | integer |
O dia na data difusa. |
|
month
|
end_date.m | integer |
O mês na data difusa. |
|
ano
|
end_date.y | integer |
O ano na data difusa. |
|
ID do fundo padrão
|
default_fund_id | integer |
A ID de registro do sistema do fundo padrão associado ao tributo. |
|
Anotações
|
notes | string |
As notas do tributo. |
|
Ativo?
|
is_active | boolean |
Esse tributo está ativo? |
|
Sequence
|
sequence | integer |
A sequência de tributo. |
|
Data de inclusão
|
date_added | date-time |
A data em que o tributo foi criado. |
|
Data modificada
|
date_modified | date-time |
A data em que o tributo foi modificado pela última vez. |
NXTDataIntegrationApi.TributeAcknowledgee
Reconhecimento de tributo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
A ID do registro do sistema do tributo reconhece. |
|
ID do tributo
|
tribute_id | integer |
A ID do registro do sistema do tributo associado ao reconhecimento. |
|
ID da relação
|
relationships_id | integer |
A ID de registro do sistema da relação (se nula, isso representa um autoconhecê-lo). |
|
ID da carta
|
letter | integer |
A ID da carta. |
|
Sequence
|
sequence | integer |
O tributo reconhece a sequência. |
NXTDataIntegrationApi.TributeAcknowledgeeCollection
Reconhecimentos de tributo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of NXTDataIntegrationApi.TributeAcknowledgee |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |
NXTDataIntegrationApi.TributeCollection
Tributos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
count | integer |
O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor. |
|
value
|
value | array of NXTDataIntegrationApi.Tribute |
O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção. |