Подарки Blackbaud RENXT

Blackbaud Raiser Edge NXT — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества. Используйте соединитель "Подарки" для управления подарками.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка Blackbaud
URL https://www.blackbaud.com/support
Адрес электронной почты skyapi@blackbaud.com
Метаданные соединителя
Publisher Blackbaud, Inc.
Website https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Политика конфиденциальности https://www.blackbaud.com/privacy-shield
Категории Продажи и CRM; Продуктивность

Edge NXT Raiser — это комплексное облачное решение для сбора средств и программного обеспечения для управления донорами, созданное специально для некоммерческих организаций и всего социального хорошего сообщества.

Этот соединитель построен на основе API Sky Blackbaud и предоставляет операции для управления подарками и связанными сущностями, найденными в Edge NXT The Raiser, в том числе:

  • Подарки и составляющие, предоставляющие сводки
  • Пакеты подарков
  • Получения
  • Благодарности
  • и другие...

Дополнительные сведения см. в документации.

Предпосылки

Чтобы использовать этот соединитель, у вас должна быть учетная запись Blackbaud ID с доступом к одной или нескольким средам Blackbaud.

Кроме того, администратор вашей организации также должен выполнять действия уровня администратора в системе, чтобы этот соединитель мог получить доступ к вашей среде Blackbaud. Дополнительные сведения об этих предварительных требованиях см. в документации по начальной настройке .

Как получить учетные данные?

Администратор вашей организации отправит вам приглашение в среду NXT edge организации и настроит разрешения учетной записи пользователя в среде. Для использования этого соединителя дополнительные учетные данные не требуются.

Известные проблемы и ограничения

Соединитель будет работать в контексте учетной записи пользователя и, следовательно, будет применяться к вашим разрешениям пользователя в среде.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Вывод списка вложений подарков

Перечисляет вложения для подарка.
Вывод списка настраиваемых полей подарка

Перечисляет настраиваемые поля для подарка.
Добавление подарка в пакет

Добавьте подарок в указанный пакет подарков.
Обновление вложения подарка

Обновляет вложение подарка.
Обновление дани подарка

Обновляет дань подарка.
Обновление декларации о налоговом налоге

Обновляет составное налоговое объявление.
Обновление настраиваемого поля подарка

Обновляет настраиваемое поле подарка.
Обновление подарочной заметки

Обновляет подарочную заметку.
Обновление подтверждения дани подарка

Обновляет подтверждение подарка.
Обновление сведений о подтверждении подарков

Обновляет сведения о подтверждении для подарка.
Обновление сведений о получении подарков

Обновляет сведения о квитанции для подарка.
Перечисление дани подарков

Перечисляет дань за подарок.
Перечисление заметок о подарках

Выводит заметки для подарка.
Перечисление обязательств по выпуску

Перечисляет предложения по залогу.
Перечисление пакетов подарков

Перечисление пакетов подарков.
Перечисление платежей по залогу

Перечисляет платежи за залог.
Перечисление подарков дань подтверждений

Перечислить признания за подарок дань.
Перечисление составляющих налоговых объявлений

Перечисляет налоговые декларации о подарочной помощи для составляющих (только применимых для версий Великобритании).
Получение первого подарка

Возвращает первый подарок для составляющих.
Получение подарка

Возвращает сведения о подарке.
Получение подарка по идентификатору подстановки

Возвращает системный идентификатор записи подарка из указанного идентификатора подстановки.
Получение последнего подарка

Возвращает последний подарок для компонента.
Получение составляющих времени существования

Возвращает время существования, предоставляющее сводку для составляющих.
Получить составляющий величайший подарок

Возвращает величайший подарок для составляющих.
Продажа стокового подарка

Обновляет стоковый подарок для продажи.
Создание вложения подарка

Создает новое вложение подарка.
Создание дани подарка

Создает новую дань подарка.
Создание налоговой декларации

Создает новое объявление о налоге на предоставление помощи для избирателей.
Создание настраиваемого поля подарка

Создает новое настраиваемое поле подарка.
Создание обещания

Создает новое обещание.
Создание пакета подарков

Создает новый пакет подарков.
Создание платежа по залогу

Создает новый платеж по залогу.
Создание подарка

Создает новый подарок.
Создание подарка акций

Создает новый подарок акций.
Создание подарочной заметки

Создает новую заметку о подарке.
Список подарков

Возвращает список подарков.

Вывод списка вложений подарков

Идентификатор операции:
ListGiftAttachments

Перечисляет вложения для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True string

Системный идентификатор записи подарка.

Возвращаемое значение

Attachments

Тело
GiftApi.ApiCollectionOfGiftAttachmentRead

Вывод списка настраиваемых полей подарка

Идентификатор операции:
ListGiftCustomFields

Перечисляет настраиваемые поля для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True string

Системный идентификатор записи подарка.

Возвращаемое значение

Пользовательские поля

Тело
GiftApi.ApiCollectionOfGiftCustomFieldRead

Добавление подарка в пакет

Идентификатор операции:
AddGiftToBatch

Добавьте подарок в указанный пакет подарков.

Параметры

Имя Ключ Обязательно Тип Описание
Batch
 batch_id True string

Пакет, в который будет добавлен подарок.
Составной идентификатор
 constituent_id True string

Системный идентификатор записи компонента, связанного с подарком.
Сумма
 value True double

Сумма подарка.
Date
 date True date

Дата подарка (например, '2020-09-18').
Тип
 type True string

Тип подарка.
Идентификатор кампании
 campaign_id string

Системный идентификатор кампании, связанной с разделением подарка.
Идентификатор фонда
 fund_id True string

Системный идентификатор фонда, связанного с разделением подарка.
Идентификатор апелляции
 appeal_id string

Системный идентификатор апелляции, связанной с разделением подарка.
Идентификатор пакета
 package_id string

Системный идентификатор пакета, связанного с разделением подарка.
количество
 value True double

Количество разделенного подарка.
Метод оплаты
 payment_method True string

Метод оплаты.
Контрольный номер
 check_number string

Номер проверки (применяется только при использовании метода оплаты "PersonalCheck").
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Reference
 reference string

Ссылка на оплату (применимо только при использовании метода оплаты — "Other").
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Является ли анонимным?
 is_anonymous boolean

Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию.
Подтип
 subtype string

Подтип подарка.
Комментарий
 reference string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
Используйте кредиты на сбор средств?
 default_fundraiser_credits boolean

Используйте кредиты на сбор средств по умолчанию?
Используйте мягкие кредиты?
 default_soft_credits boolean

Используйте мягкие кредиты по умолчанию?
Избирательный округ
 constituency string

Избирательный округ подарка.
Состояние публикации
 post_status string

Состояние записи подарка.
Дата публикации
 post_date date

Дата отправки подарка (например, "2020-09-18").
Состояние квитанции
 status True string

Состояние получения подарка.
Сумма по чеку
 value True double

Сумма квитанции для подарка.
Дата прихода
 date date

Дата получения подарка (например, "2020-09-18").

Возвращаемое значение

Содержит коллекцию записей об ошибках пакетного подарка и пакетных подарков, добавленных операцией.

Results
GiftApi.BatchGiftAddResults

Обновление вложения подарка

Идентификатор операции:
EditGiftAttachment

Обновляет вложение подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор вложения
 attachment_id True string

Идентификатор системной записи для обновления вложения.
Имя
 name string

Имя вложения. Ограничение символов: 150.
Date
 date date-time

Дата вложения (например, '2020-09-18T04:13:56Z').
URL
 url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.
Метки
 tags array of string

Теги, связанные с вложением.

Обновление дани подарка

Идентификатор операции:
EditGiftTribute

Обновляет дань подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор дани подарка
 gift_tribute_id True integer

Системный идентификатор дани подарка для обновления.
Тип дани
 tribute_type integer

Тип дани.
Состояние подтверждения
 acknowledge string

Подарок дань признает статус.

Обновление декларации о налоговом налоге

Идентификатор операции:
EditTaxDeclaration

Обновляет составное налоговое объявление.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор налогового объявления
 tax_declaration_id True integer

Системный идентификатор налоговой декларации для обновления.
Начало объявления
 declaration_starts date-time

Дата начала налогового объявления (например, '2020-09-18T04:13:56Z').
Объявление заканчивается
 declaration_ends date-time

Дата окончания налогового объявления (например, "2020-09-18T04:13:56Z".
Объявление сделано
 declaration_made date-time

Дата объявления налога была сделана (например, "2020-09-18T04:13:56Z".
Indicator
 declaration_indicator string

Индикатор объявления.
Исходный материал
 declaration_source string

Источник объявления.
Отправлено подтверждение
 confirmation_sent date-time

Дата отправки подтверждения (например, "2020-09-18T04:13:56Z").
Подтверждение возвращено
 confirmation_returned date-time

Дата возврата подтверждения (например, "2020-09-18T04:13:56Z").
Платит налог
 constituent_pays_tax string

Указывает, платит ли составляющий налог.
Состояние
 tax_payer_status string

Статус плательщика налогов.
Comments
 tax_notes string

Комментарии к налоговому объявлению.
Последовательность
 sequence integer

Числовая последовательность, связанная с налоговым объявлением.

Обновление настраиваемого поля подарка

Идентификатор операции:
EditGiftCustomField

Обновляет настраиваемое поле подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор настраиваемого поля
 custom_field_id True string

Идентификатор системной записи настраиваемого поля для обновления.
body
 body True dynamic

Объект, представляющий свойства настраиваемого поля для обновления.

Обновление подарочной заметки

Идентификатор операции:
EditGiftNote

Обновляет подарочную заметку.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор заметки
 id True integer

Идентификатор системной записи для обновления заметки.
Тип
 note_type_id integer

Тип заметки.
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Сводка
 summary string

Сводка по заметкам. Ограничение символов: 255.
Замечание
 text string

Текст заметки.
Author
 author string

Автор заметок. Ограничение символов: 50.

Обновление подтверждения дани подарка

Идентификатор операции:
EditGiftTributeAcknowledgee

Обновляет подтверждение подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Подарок дань признает идентификатор
 gift_tribute_acknowledgee_id True integer

Системный идентификатор записи дани подарка подтверждает обновление.
Письмо
 letter integer

Письмо, отправленное в подтверждение.
Дата письма
 letter_date date-time

Дата отправки письма.

Обновление сведений о подтверждении подарков

Идентификатор операции:
EditGiftAcknowledgement

Обновляет сведения о подтверждении для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подтверждения
 acknowledgement_id True string

Системный идентификатор подтверждения подарка для обновления. Он использует идентификатор родительского подарка в качестве значения.
Состояние
 status string

Состояние подтверждения. Если для параметра состояния задано значение DoNotAcknowledge, буква и дата должны иметь значение NULL. Если для параметра состояния задано значение NeedsAcknowledgement, дата должна иметь значение NULL.
Date
 date date-time

Дата, связанная с подтверждением (например, '2020-09-18T04:13:56Z').
Письмо
 letter string

Письмо, связанное с подтверждением.

Обновление сведений о получении подарков

Идентификатор операции:
EditGiftReceipt

Обновляет сведения о квитанции для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор квитанции
 receipt_id True string

Системный идентификатор квитанции о подарке для обновления. Он использует идентификатор родительского подарка в качестве значения.
Состояние
 status string

Состояние получения подарка. Если для параметра status задано значение NeedsReceipt или DoNotReceipt, дата получения должна иметь значение NULL.
Сумма
 value double

Сумма квитанции.
Date
 date date-time

Дата получения (например, '2020-09-18T04:13:56Z').
Number
 number integer

Номер квитанции.

Перечисление дани подарков

Идентификатор операции:
ListGiftTributes

Перечисляет дань за подарок.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True integer

Системный идентификатор записи подарка.

Возвращаемое значение

Дар дань

Тело
NXTDataIntegrationApi.GiftTributeCollection

Перечисление заметок о подарках

Идентификатор операции:
ListGiftNotes

Выводит заметки для подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True integer

Системный идентификатор записи подарка.
Лимит
 limit integer

Представляет количество возвращаемых записей.
Смещение
 offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Возвращаемое значение

Заметки о подарках

Тело
NXTDataIntegrationApi.GiftNoteCollection

Перечисление обязательств по выпуску

Идентификатор операции:
ListPledgeInstallments

Перечисляет предложения по залогу.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор залога
 gift_id True string

Системный идентификатор записи залога.

Возвращаемое значение

Рассрочку

Тело
Gift2Api.PledgeInstallmentCollection

Перечисление пакетов подарков

Идентификатор операции:
ListGiftBatches

Перечисление пакетов подарков.

Параметры

Имя Ключ Обязательно Тип Описание
Номер пакета
 batch_number string

Представляет фильтр для результатов, соответствующих указанному числу.
Одобренный?
 approved boolean

Представляет фильтр для состояния пакета подарков.
Есть ли исключения?
 has_exceptions boolean

Представляет фильтр, содержащий ли пакет подарков исключения.
Лимит
 limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000.
Смещение
 offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.
Поиск текста
 search_text string

Представляет фильтр для текста, включенного в описание пакета или поля номера пакета.
Кем создано:
 created_by string

Представляет фильтр для пакетов подарков, созданных указанным пользователем.

Возвращаемое значение

Пакеты подарков

Тело
GiftBatchApi.ApiCollectionOfGiftBatch

Перечисление платежей по залогу

Идентификатор операции:
ListPledgePayments

Перечисляет платежи за залог.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор залога
 gift_id True string

Системный идентификатор записи залога.

Возвращаемое значение

Payments

Тело
Gift2Api.PledgePaymentCollection

Перечисление подарков дань подтверждений

Идентификатор операции:
ListGiftTributeAcknowledgees

Перечислить признания за подарок дань.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор дани подарка
 gift_tribute_id True integer

Системный идентификатор дани подарка.

Возвращаемое значение

Дар дань признается

Тело
NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

Перечисление составляющих налоговых объявлений

Идентификатор операции:
ListConstituentTaxDeclarations

Перечисляет налоговые декларации о подарочной помощи для составляющих (только применимых для версий Великобритании).

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True integer

Системный идентификатор записи компонента.
Лимит
 limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение не существует.
Смещение
 offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.

Возвращаемое значение

Налоговые объявления

Тело
NXTDataIntegrationApi.TaxDeclarationCollection

Получение первого подарка

Идентификатор операции:
GetConstituentFirstGift

Возвращает первый подарок для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Предоставление сводки

Тело
ConstituentApi.GivingSummaryRead

Получение подарка

Идентификатор операции:
GetGift

Возвращает сведения о подарке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True string

Системный идентификатор записи подарка для получения.

Возвращаемое значение

Подарок

Тело
GiftApi.GiftRead

Получение подарка по идентификатору подстановки

Идентификатор операции:
GetGiftIdFromLookupId

Возвращает системный идентификатор записи подарка из указанного идентификатора подстановки.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подстановки
 giftlookupid True string

Идентификатор подстановки подарка.

Возвращаемое значение

Карта идентификатора подарка

Тело
NXTDataIntegrationApi.GiftIdMap

Получение последнего подарка

Идентификатор операции:
GetConstituentLatestGift

Возвращает последний подарок для компонента.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Предоставление сводки

Тело
ConstituentApi.GivingSummaryRead

Получение составляющих времени существования

Идентификатор операции:
GetConstituentLifetimeGiving

Возвращает время существования, предоставляющее сводку для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Время существования

Тело
ConstituentApi.LifetimeGivingRead

Получить составляющий величайший подарок

Идентификатор операции:
GetConstituentGreatestGift

Возвращает величайший подарок для составляющих.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True string

Системный идентификатор записи компонента.

Возвращаемое значение

Предоставление сводки

Тело
ConstituentApi.GivingSummaryRead

Продажа стокового подарка

Идентификатор операции:
SellStockGift

Обновляет стоковый подарок для продажи.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True string

Системный идентификатор запасного подарка для продажи.
Дата продажи
 stock_sale_date True date

Дата продажи акций (например, "2005-09-18").
Значение продажи
 stock_sale_value True double

Стоимость акции продажи.
Плата брокера
 broker_fee double

Проданный фондовый брокер сбор.
Состояние публикации
 post_status string

Состояние публикации проданного подарка.
Дата публикации
 post_date date

Дата публикации проданных акций (например, "2020-09-18".
Примечания.
 notes string

Заметки о проданных акциях. Ограничение символов: 255.
Issuer
 issuer string

Издатель акций.
Символ издателя
 symbol string

Символ издателя акций.
Количество единиц
 units integer

Количество проданных единиц.
Цена медиана на единицу
 unit_price double

Медианная цена за единицу продана.

Создание вложения подарка

Идентификатор операции:
CreateGiftAttachment

Создает новое вложение подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 parent_id True string

Системный идентификатор записи подарка, связанного с вложением.
Тип
 type True string

Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или документы Word, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом.
Имя
 name string

Имя вложения. Ограничение символов: 150.
Date
 date date-time

Дата вложения (например, '2020-09-18T04:13:56Z'). Это поле по умолчанию использует текущую дату и время, если она не указана.
URL
 url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.
Имя файла
 file_name string

Имя файла. Ограничение символов: 36. Только для физических вложений.
Идентификатор файла
 file_id string

Идентификатор файла. Ограничение символов: 36. Только для физических вложений.
Идентификатор эскиза
 thumbnail_id string

Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений.
Метки
 tags array of string

Теги, связанные с вложением.

Возвращаемое значение

Созданное вложение подарка

Тело
GiftApi.CreatedGiftAttachment

Создание дани подарка

Идентификатор операции:
CreateGiftTribute

Создает новую дань подарка.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True integer

Системный идентификатор подарка, связанного с данью подарка.
Идентификатор дани
 tribute_id True integer

Системный идентификатор дани, связанной с даром дани.

Возвращаемое значение

Созданная дань подарка

Тело
NXTDataIntegrationApi.CreatedGiftTribute

Создание налоговой декларации

Идентификатор операции:
CreateTaxDeclaration

Создает новое объявление о налоге на предоставление помощи для избирателей.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True integer

Системный идентификатор записи компонента.
Начало объявления
 declaration_starts True date-time

Дата начала налогового объявления (например, '2020-09-18T04:13:56Z').
Объявление заканчивается
 declaration_ends date-time

Дата окончания налогового объявления (например, "2020-09-18T04:13:56Z".
Объявление сделано
 declaration_made date-time

Дата объявления налога была сделана (например, "2020-09-18T04:13:56Z".
Indicator
 declaration_indicator string

Индикатор объявления.
Исходный материал
 declaration_source string

Источник объявления.
Отправлено подтверждение
 confirmation_sent date-time

Дата отправки подтверждения (например, "2020-09-18T04:13:56Z").
Подтверждение возвращено
 confirmation_returned date-time

Дата возврата подтверждения (например, "2020-09-18T04:13:56Z").
Платит налог
 constituent_pays_tax string

Указывает, платит ли составляющий налог.
Состояние
 tax_payer_status string

Статус плательщика налогов.
Comments
 tax_notes string

Комментарии к налоговому объявлению.
Последовательность
 sequence integer

Числовая последовательность, связанная с налоговым объявлением.

Возвращаемое значение

Созданное налоговое объявление

Тело
NXTDataIntegrationApi.CreatedTaxDeclaration

Создание настраиваемого поля подарка

Идентификатор операции:
CreateGiftCustomField

Создает новое настраиваемое поле подарка.

Параметры

Имя Ключ Обязательно Тип Описание
body
 body True dynamic

Объект, представляющий настраиваемое поле для создания.

Возвращаемое значение

Созданное настраиваемое поле подарка

Тело
GiftApi.CreatedGiftCustomField

Создание обещания

Идентификатор операции:
CreatePledge

Создает новое обещание.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 id True string

Системный идентификатор записи компонента.
Сумма
 value True double

Сумма залога.
Date
 gift_date True date

Дата залога (например, "2020-09-18").
Частота
 frequency True string

Частота рассрочки для залога.
# установки
 number_of_installments True integer

Количество рассрочок для залога.
Начальная дата
 start_date True date

Дата начала расписания залога.
количество
 value True double

Количество разделенного подарка.
Идентификатор фонда
 fund_id True string

Системный идентификатор фонда, связанного с разделением подарка.
Идентификатор кампании
 campaign_id string

Системный идентификатор кампании, связанной с разделением подарка.
Идентификатор апелляции
 appeal_id string

Системный идентификатор апелляции, связанной с разделением подарка.
Идентификатор пакета
 package_id string

Системный идентификатор пакета, связанного с разделением подарка.
Метод оплаты
 method True string

Метод оплаты.
Контрольный номер
 check_number string

Контрольный номер.
Reference
 reference_number string

Ссылка на оплату (применимо только при использовании метода оплаты — "Other").
Отправить напоминание?
 send_reminder boolean

Отправить напоминания о обещании?
Является ли анонимным?
 anonymous boolean

Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию.
Подтип
 name string

Подтип подарка.
Комментарий
 comments string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
Подарочный код
 value string

Код подарка, связанный с подарком.
Избирательный округ
 value string

Избирательный округ подарка.
Состояние публикации
 gift_post_status string

Состояние записи подарка.
Дата публикации
 gift_post_date date

Дата отправки подарка (например, "2020-09-18").
Состояние
 gift_status string

Состояние залога.
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Состояние квитанции
 receipt_status True string

Состояние получения подарка.
Сумма по чеку
 value True double

Сумма квитанции для подарка.
Дата прихода
 receipt_date date

Дата получения подарка (например, "2020-09-18").
Номер получения
 receipt_number integer

Номер квитанции.
Стек квитанций
 value string

Стек квитанций.
Состояние подтверждения
 status True string

Статус подтверждения подарка.
Дата подтверждения
 acknowledgement_date date

Дата подтверждения подарка (например, "2020-09-18").
Письмо
 value string

Письмо, связанное с подтверждением.
type
 credit_type True string

Тип кредита распознавания.
Идентификатор получателя
 constituent_id True string

Системный идентификатор записи получателя кредита распознавания.
количество
 value True double

Сумма, кредитуемая получателю.
date
 date date

Дата установки (например, "2020-09-18").
количество
 amount double

Сумма установки.

Возвращаемое значение

Созданный подарок

Тело
GiftApi.CreatedGift

Создание пакета подарков

Идентификатор операции:
CreateGiftBatch

Создает новый пакет подарков.

Параметры

Имя Ключ Обязательно Тип Описание
Description
 batch_description string

Описание пакета.
Ожидаемое число
 expected_number integer

Количество подарков, ожидаемых в пакете.
Ожидаемый итог
 expected_batch_total double

Общее значение подарков в пакете.
Номер пакета
 batch_number string

Уникальный идентификатор, характерный для пакета.

Возвращаемое значение

Создан пакет подарков

Тело
GiftBatchApi.CreatedBatch

Создание платежа по залогу

Идентификатор операции:
CreatePledgePayment

Создает новый платеж по залогу.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 id True string

Системный идентификатор записи компонента.
Сумма
 value True double

Сумма выплаты залога.
Date
 gift_date True date

Дата оплаты залога (например, "2020-09-18").
количество
 value True double

Количество разделенного подарка.
Идентификатор фонда
 fund_id True string

Системный идентификатор фонда, связанного с разделением подарка.
Идентификатор кампании
 campaign_id string

Системный идентификатор кампании, связанной с разделением подарка.
Идентификатор апелляции
 appeal_id string

Системный идентификатор апелляции, связанной с разделением подарка.
Идентификатор пакета
 package_id string

Системный идентификатор пакета, связанного с разделением подарка.
Метод оплаты
 method True string

Метод оплаты.
Контрольный номер
 check_number string

Контрольный номер.
Reference
 reference_number string

Ссылка на оплату (применимо только при использовании метода оплаты — "Other").
Является ли анонимным?
 anonymous boolean

Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию.
залог
 pledge_id string

Системный идентификатор платной записи.
взнос
 installment_id string

Системный идентификатор платной записи.
количество
 amount_applied double

Сумма, примененная к установке.
Подтип
 name string

Подтип подарка.
Комментарий
 comments string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
Подарочный код
 value string

Код подарка, связанный с подарком.
Избирательный округ
 value string

Избирательный округ подарка.
Состояние публикации
 gift_post_status string

Состояние записи подарка.
Дата публикации
 gift_post_date date

Дата отправки подарка (например, "2020-09-18").
Состояние квитанции
 receipt_status True string

Состояние получения подарка.
Сумма по чеку
 value True double

Сумма квитанции для подарка.
Дата прихода
 receipt_date date

Дата получения подарка (например, "2020-09-18").
Номер получения
 receipt_number integer

Номер квитанции.
Стек квитанций
 value string

Стек квитанций.
Состояние подтверждения
 status True string

Статус подтверждения подарка.
Дата подтверждения
 acknowledgement_date date

Дата подтверждения подарка (например, "2020-09-18").
Письмо
 value string

Письмо, связанное с подтверждением.
type
 credit_type True string

Тип кредита распознавания.
Идентификатор получателя
 constituent_id True string

Системный идентификатор записи получателя кредита распознавания.
количество
 value True double

Сумма, кредитуемая получателю.

Возвращаемое значение

Созданный подарок

Тело
GiftApi.CreatedGift

Создание подарка

Идентификатор операции:
CreateGift

Создает новый подарок.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 constituent_id True string

Системный идентификатор записи компонента, связанного с подарком.
Сумма
 value True double

Сумма подарка.
Date
 date True date

Дата подарка (например, '2020-09-18').
Тип
 type True string

Тип подарка.
Идентификатор кампании
 campaign_id string

Системный идентификатор кампании, связанной с разделением подарка.
Идентификатор фонда
 fund_id True string

Системный идентификатор фонда, связанного с разделением подарка.
Идентификатор апелляции
 appeal_id string

Системный идентификатор апелляции, связанной с разделением подарка.
Идентификатор пакета
 package_id string

Системный идентификатор пакета, связанного с разделением подарка.
количество
 value True double

Количество разделенного подарка.
Метод оплаты
 payment_method True string

Метод оплаты.
Контрольный номер
 check_number string

Номер проверки (применяется только при использовании метода оплаты "PersonalCheck").
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Reference
 reference string

Ссылка на оплату (применимо только при использовании метода оплаты — "Other").
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Является ли анонимным?
 is_anonymous boolean

Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию.
Подтип
 subtype string

Подтип подарка.
Комментарий
 reference string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
Используйте кредиты на сбор средств?
 default_fundraiser_credits boolean

Используйте кредиты на сбор средств по умолчанию?
Используйте мягкие кредиты?
 default_soft_credits boolean

Используйте мягкие кредиты по умолчанию?
Избирательный округ
 constituency string

Избирательный округ подарка.
Префикс пакетной службы
 batch_prefix string

Префикс, используемый для пакетных подарков. Это должно содержать по крайней мере одну букву и требуется, если "Номер пакетной службы" имеет значение.
Номер пакета
 batch_number string

Номер пакета. Ограничение символов: 50 (включая префикс пакетной службы).
Состояние публикации
 post_status string

Состояние записи подарка.
Дата публикации
 post_date date

Дата отправки подарка (например, "2020-09-18").
Состояние квитанции
 status True string

Состояние получения подарка.
Сумма по чеку
 value True double

Сумма квитанции для подарка.
Дата прихода
 date date

Дата получения подарка (например, "2020-09-18").

Возвращаемое значение

Созданный подарок

Тело
GiftApi.CreatedGift

Создание подарка акций

Идентификатор операции:
CreateStock

Создает новый подарок акций.

Параметры

Имя Ключ Обязательно Тип Описание
Составной идентификатор
 id True string

Системный идентификатор записи компонента.
Сумма
 value True double

Сумма подарка.
Date
 gift_date True date

Дата подарка (например, '2020-09-18').
Issuer
 issuer string

Издатель акций.
Символ издателя
 symbol string

Символ издателя акций.
Количество единиц
 units integer

Количество единиц акций.
Цена медиана на единицу
 unit_price double

Медианная цена за единицу.
количество
 value True double

Количество разделенного подарка.
Идентификатор фонда
 fund_id True string

Системный идентификатор фонда, связанного с разделением подарка.
Идентификатор кампании
 campaign_id string

Системный идентификатор кампании, связанной с разделением подарка.
Идентификатор апелляции
 appeal_id string

Системный идентификатор апелляции, связанной с разделением подарка.
Идентификатор пакета
 package_id string

Системный идентификатор пакета, связанного с разделением подарка.
Метод оплаты
 method True string

Метод оплаты.
Контрольный номер
 check_number string

Контрольный номер.
Reference
 reference_number string

Ссылка на оплату (применимо только при использовании метода оплаты — "Other").
Является ли анонимным?
 anonymous boolean

Является ли подарок анонимным? Если значение не указано, будет использоваться анонимность донора по умолчанию.
Подтип
 name string

Подтип подарка.
Комментарий
 comments string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
Подарочный код
 value string

Код подарка, связанный с подарком.
Избирательный округ
 value string

Избирательный округ подарка.
Состояние публикации
 gift_post_status string

Состояние записи подарка.
Дата публикации
 gift_post_date date

Дата отправки подарка (например, "2020-09-18").
Состояние квитанции
 receipt_status True string

Состояние получения подарка.
Сумма по чеку
 value True double

Сумма квитанции для подарка.
Дата прихода
 receipt_date date

Дата получения подарка (например, "2020-09-18").
Номер получения
 receipt_number integer

Номер квитанции.
Стек квитанций
 value string

Стек квитанций.
Состояние подтверждения
 status True string

Статус подтверждения подарка.
Дата подтверждения
 acknowledgement_date date

Дата подтверждения подарка (например, "2020-09-18").
Письмо
 value string

Письмо, связанное с подтверждением.
type
 credit_type True string

Тип кредита распознавания.
Идентификатор получателя
 constituent_id True string

Системный идентификатор записи получателя кредита распознавания.
количество
 value True double

Сумма, кредитуемая получателю.

Возвращаемое значение

Созданный подарок

Тело
GiftApi.CreatedGift

Создание подарочной заметки

Идентификатор операции:
CreateGiftNote

Создает новую заметку о подарке.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор подарка
 gift_id True integer

Системный идентификатор записи подарка, связанного с заметкой.
Тип
 note_type_id True integer

Тип заметки.
day
 d integer

День в нечеткой дате.
month
 m integer

Месяц в нечеткой дате.
год
 y integer

Год в нечеткой дате.
Сводка
 summary string

Сводка по заметкам. Ограничение символов: 255.
Замечание
 text string

Текст заметки.
Author
 author string

Автор заметок. Ограничение символов: 50.

Возвращаемое значение

Созданная заметка

Тело
NXTDataIntegrationApi.CreatedGiftNote

Список подарков

Идентификатор операции:
ListGifts

Возвращает список подарков.

Параметры

Имя Ключ Обязательно Тип Описание
List
 list_id string

Определяет идентификатор списка, используемый для фильтрации набора подарков в указанный список. Если это значение задано, другие указанные фильтры будут игнорироваться.
Тип
 gift_type string

Представляет разделенный запятыми список типов подарков для фильтрации результатов. Например, "MatchingGiftPledge,RecurringGift" возвращает только подарки типа MatchingGiftPledge или ПовторяющийсяGift.
Составной идентификатор
 constituent_id string

Представляет список идентификаторов записей системы, разделенных запятыми, чтобы отфильтровать результаты. Например, "280,1232" возвращает только подарки от составляющих 280 или составляющих 1232.
Идентификатор кампании
 campaign_id string

Представляет разделенный запятыми список идентификаторов системных записей кампании для фильтрации результатов. Например, "506,918" возвращает только подарки кампании 506 или кампании 918.
Идентификатор фонда
 fund_id string

Представляет разделенный запятыми список идентификаторов записей системы фонда для фильтрации результатов. Например, "506 918" возвращает только подарки для финансирования 506 или фонда 918.
Идентификатор апелляции
 appeal_id string

Представляет разделенный запятыми список идентификаторов записей системы апелляции для фильтрации результатов. Например, "506 918" возвращает только подарки для обращения 506 или апелляции 918.
Лимит
 limit integer

Представляет количество возвращаемых записей. Значение по умолчанию — 500. Максимальное значение — 5000.
Смещение
 offset integer

Представляет количество пропускаемых записей. Для использования с разбивкой на страницы.
Дата начала подарка
 start_gift_date date-time

Представляет фильтр для подарков с датой подарка или после указанной даты (например, "2020-09-18T04:13:56Z").
Дата окончания подарка
 end_gift_date date-time

Представляет фильтр для подарков с датой подарка или до указанной даты (например, "2020-09-18T04:13:56Z").
Начать сумму подарка
 start_gift_amount double

Представляет фильтр для подарков с суммой больше или равно указанной сумме.
Сумма подарка
 end_gift_amount double

Представляет фильтр для подарков с суммой меньше или равно указанной сумме.
Состояние публикации
 post_status string

Представляет разделенный запятыми список состояний отправки подарков для фильтрации результатов. Например, "DoNotPost,Posted" возвращает только подарки, помеченные как DoNotPost или Posted.
Состояние квитанции
 receipt_status string

Представляет разделенный запятыми список состояний получения подарков для фильтрации результатов. Например, "DoNotReceipt,Receipted" возвращает только подарки, помеченные как DoNotReceipt или Receipted.
Состояние подтверждения
 acknowledgement_status string

Представляет разделенный запятыми список состояний подтверждения подарка для фильтрации результатов. Например, "DoNotAcknowledge" возвращает только подарки, помеченные как DoNotAcknowledge или Acknowledged.
Сортировка по
 sort string

Представляет список полей для сортировки результатов по. Результаты по умолчанию находятся в порядке возрастания, а знак "-" обозначает убывание. Например, "date_added,-date" сортирует подарки по полю "date_added" по возрастанию, а затем по полю "дата подарка" в порядке убывания. Если предоставляется только поле date_modified или только поле date_added, то это добавляет параметр sort_token в URL-адрес next_link, чтобы убедиться, что подарки сортируются стабильно.
Добавлен или после
 date_added date-time

Отфильтруйте результаты по подаркам, созданным по указанной дате (например, "2020-09-18T04:13:56Z").
Изменено или после
 last_modified date-time

Отфильтруйте результаты до подарков, измененных по указанной дате (например, "2020-09-18T04:13:56Z").

Возвращаемое значение

Подарки

Тело
GiftApi.ApiCollectionOfGiftRead

Определения

ConstituentApi.AppealRead

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор системной записи апелляции.
описание
 description string

Описание апелляции.

ConstituentApi.CampaignRead

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор системной записи кампании.
описание
 description string

Описание кампании.

ConstituentApi.FundRead

Имя Путь Тип Описание
Идентификатор
 id string

Системный идентификатор фонда.
описание
 description string

Описание фонда.

ConstituentApi.GivingSummaryRead

Предоставление сводки

Имя Путь Тип Описание
Идентификатор
 id string

Системный идентификатор записи подарка.
Тип
 type string

Тип подарка.
Date
 date date-time

Дата подарка.
value
 amount.value double

Сумма подарка.
Appeal
 appeals array of ConstituentApi.AppealRead

Набор апелляций, связанных с подарком.
кампания
 campaigns array of ConstituentApi.CampaignRead

Набор кампаний, связанных с подарком.
Фонд
 funds array of ConstituentApi.FundRead

Набор средств, связанных с подарком.

ConstituentApi.LifetimeGivingRead

Время существования

Имя Путь Тип Описание
За несколько лет подряд
 consecutive_years_given integer

Число последовательных лет, которое дало составная часть.
Общее количество лет, указанных
 total_years_given integer

Общее количество лет, которое дало составная часть.
value
 total_giving.value double

Общая сумма, указанная составной частью.
value
 total_pledge_balance.value double

Общий неоплачиваемый баланс залога для составляющих.
value
 total_received_giving.value double

Общая полученная сумма, указанная составной частью.
value
 total_committed_matching_gifts.value double

Это вычисляемое поле вычисляет общее количество соответствующих обязательств подарков, которые относятся к составляющим.
value
 total_received_matching_gifts.value double

Общая сумма платежей по отношению к соответства обещаниям о дарениях, приписываемых избирателям.
value
 total_soft_credits.value double

Общая сумма мягких кредитов, применяемых к составляющим.

GiftApi.AcknowledgementRead

Признание

Имя Путь Тип Описание
date
 date date-time

Дата, связанная с подтверждением.
буква
 letter string

Письмо, связанное с подтверждением.
статус
 status string

Состояние подтверждения. Доступные значения: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT и DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of GiftApi.GiftAttachmentRead

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

GiftApi.ApiCollectionOfGiftCustomFieldRead

Пользовательские поля

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of GiftApi.GiftCustomFieldRead

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

GiftApi.ApiCollectionOfGiftRead

Подарки

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of GiftApi.GiftRead

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

GiftApi.BatchGiftAddResults

Содержит коллекцию записей об ошибках пакетного подарка и пакетных подарков, добавленных операцией.

Имя Путь Тип Описание
Ошибки
 errors array of GiftApi.GiftBatchGiftError

Ошибки пакетного подарка, связанные с операцией добавления пакетного подарка
Подарки
 gifts array of GiftApi.BatchGiftRead

Коллекция пакетных подарков, добавленных операцией добавления пакетного подарка

GiftApi.GiftBatchGiftError

Представляет исключения, предотвращающие добавление элементов в пакет.

Имя Путь Тип Описание
затронутого поля
 affected_field string

Поле, затронутого ошибкой
идентификатор пакетной службы
 batch_id string

Идентификатор системной записи пакета
Код ошибки исключения
 exception_error_code integer

Код ошибки исключения
Сообщение об ошибке исключения
 exception_error_message string

Сообщение об ошибке исключения
Имя ошибки исключения
 exception_error_name string

Имя ошибки исключения
Идентификатор подарка
 gift_id string

Системный идентификатор записи подарка
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.

GiftApi.BatchGiftRead

Пакетный подарок

Имя Путь Тип Описание
идентификатор пакетной службы
 batch_id string

Идентификатор пакета, к которому был добавлен подарок.
Ошибки
 errors array of GiftApi.GiftBatchGiftError

Ошибки, связанные с пакетным подарком.
Идентификатор
 id string

Системный идентификатор записи пакетного подарка.
составной идентификатор
 constituent_id string

Системный идентификатор записи компонента, связанного с подарком.
type
 type string

Тип подарка.
подтип
 subtype string

Подтип подарка.
date
 date date-time

Дата подарка.
value
 amount.value double

Сумма подарка.
value
 balance.value double

Баланс, оставшийся на подарок.
номер пакета
 batch_number string

Номер пакета, связанный с этим подарком.
статус
 gift_status string

Состояние подарка.
анонимный?
 is_anonymous boolean

Является ли подарок анонимным?
избирательный округ
 constituency string

Избирательный округ подарка.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
origin
 origin string

Происхождение подарка.
состояние записи
 post_status string

Общее состояние записи реестра подарка. Доступные значения: Posted, NotPosted и DoNotPost. Если для post_status задано значение DoNotPost>, post_date должно иметь значение NULL. Если для него задано значение NotPosted, post_date требуется, но остается редактируемым. Если задано значение Posted, post_date требуется и больше не редактируется.
дата публикации
 post_date date-time

Дата, когда подарок был размещен в общем реестре.
справочник
 reference string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде.
day
 recurring_gift_status_date.d integer

День в нечеткой дате.
month
 recurring_gift_status_date.m integer

Месяц в нечеткой дате.
год
 recurring_gift_status_date.y integer

Год в нечеткой дате.
frequency
 recurring_gift_schedule.frequency string

Частота установки повторяющегося подарка для просмотра. Доступные значения: WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, ЕЖЕКВАРТАЛЬНО, ЕЖЕГОДНО.
start
 recurring_gift_schedule.start_date date-time

Дата начала повторяющегося подарка.
конец
 recurring_gift_schedule.end_date date-time

Дата окончания повторяющегося подарка.
value
 gift_aid_amount.value double

Это вычисленное поле вычисляет общую квалифицированную сумму налога, возвращенную из подарочной помощи во всех gift_splits для этого подарка. Только для Великобритании.
Статус квалификации подарочной помощи
 gift_aid_qualification_status string

Это вычисляемое поле определяет состояние квалификации "Помощь подарка" на основе сведений о налоговом объявлении и формате базы данных. Доступные значения: Qualified, NotQualified и PartlyQualified. Только для Великобритании.
подарочный код
 gift_code string

Значение кода подарка, связанное с подарком.
разделение подарков
 gift_splits array of GiftApi.GiftSplitRead

Набор подарков расщепляется, связанный с подарком.
сбор средств
 fundraisers array of GiftApi.GiftFundraiserRead

Набор сборов средств, получающих кредит на подарок.
Мягкие кредиты
 soft_credits array of GiftApi.SoftCreditRead

Набор мягких кредитов, связанных с подарком.
Получения
 receipts array of GiftApi.ReceiptRead

Набор квитанций, связанных с подарком.
Благодарности
 acknowledgements array of GiftApi.AcknowledgementRead

Набор подтверждений, связанных с подарком.
Payments
 payments array of GiftApi.PaymentRead

Платежи по подароку.
Связанные подарки
 linked_gifts array of string

Идентификаторы других подарков, связанных с этим подарком.
Дата добавления
 date_added date-time

Дата создания подарка.
Дата изменения
 date_modified date-time

Дата последнего изменения подарка.

GiftApi.CreatedGift

Созданный подарок

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор только что созданного подарка.

GiftApi.CreatedGiftAttachment

Созданное вложение подарка

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор только что созданного вложения подарка.

GiftApi.CreatedGiftCustomField

Созданное настраиваемое поле подарка

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор только что созданного настраиваемого поля подарка.

GiftApi.GiftAttachmentRead

Вложение

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор системной записи вложения.
Идентификатор подарка
 parent_id string

Системный идентификатор записи подарка, связанного с вложением.
Тип
 type string

Тип вложения. Физические вложения отправляются в файлы, такие как изображения, PDF-файлы или документы Word, сохраненные локально или в сети. Они хранятся и управляются в системе. Ссылки на вложения — это ссылки на такие файлы, как изображения, записи блога или видео YouTube, которые находятся в Сети или в облачной учетной записи хранения. Они хранятся и управляются внешним образом.
Имя
 name string

Имя вложения. Ограничение символов: 150.
Date
 date date-time

Дата вложения.
URL
 url string

URL-адрес для вложения. Это необходимо для вложений ссылок и неприменимо для физических вложений.
Имя файла
 file_name string

Имя файла. Ограничение символов: 36. Только для физических вложений.
Идентификатор файла
 file_id string

Идентификатор файла. Ограничение символов: 36. Только для физических вложений.
Идентификатор эскиза
 thumbnail_id string

Идентификатор эскиза. Ограничение символов: 36. Только для физических вложений.
URL-адрес эскиза
 thumbnail_url string

URL-адрес эскиза. Для физических вложений, которые являются только изображениями. Содержит сигнатуру с привязкой к времени, которая ограничивает доступ к 60 минутам.
Тип контента
 content_type string

Тип контента. Только для физических вложений.
Размер файла
 file_size integer

Размер файла в байтах. Только для физических вложений.
Метки
 tags array of string

Теги, связанные с вложением.

GiftApi.GiftCustomFieldRead

Настраиваемое поле

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор системной записи настраиваемого поля.
Идентификатор подарка
 parent_id string

Идентификатор системной записи подарка, связанного с настраиваемым полем.
Категория
 category string

Категория настраиваемого поля.
Тип
 type string

Тип данных, которые представляет настраиваемое поле.
Ценность
 value

Значение настраиваемого поля.
Текстовое значение
 text_value string

Текстовое значение настраиваемого поля.
Числовое значение
 number_value integer

Числовое значение настраиваемого поля.
Значение даты
 date_value date

Значение даты настраиваемого поля.
Значение валюты
 currency_value double

Значение валюты настраиваемого поля.
Логическое значение
 boolean_value boolean

Логическое значение настраиваемого поля.
Значение записи таблицы
 codetableentry_value string

Значение записи таблицы настраиваемого поля.
Значение составного идентификатора
 constituentid_value string

Значение составного идентификатора настраиваемого поля.
day
 fuzzydate_value.d integer

День в нечеткой дате.
month
 fuzzydate_value.m integer

Месяц в нечеткой дате.
год
 fuzzydate_value.y integer

Год в нечеткой дате.
Date
 date date

Дата настраиваемого поля.
Комментарий
 comment string

Комментарий к пользовательскому полю. Ограничение символов: 50.
Дата добавления
 date_added date-time

Дата создания настраиваемого поля.
Дата изменения
 date_modified date-time

Дата последнего изменения настраиваемого поля.

GiftApi.GiftFundraiserRead

Сбор средств для подарков

Имя Путь Тип Описание
value
 amount.value double

Сумма, кредитуемая сбором средств за подарок.
Идентификатор сборов средств
 constituent_id string

Составной системный идентификатор сбора средств, связанный с подарком.

GiftApi.GiftRead

Подарок

Имя Путь Тип Описание
Идентификатор
 id string

Системный идентификатор записи подарка.
Составной идентификатор
 constituent_id string

Системный идентификатор записи компонента, связанного с подарком.
Тип
 type string

Тип подарка.
Подтип
 subtype string

Подтип подарка.
Date
 date date-time

Дата подарка.
value
 amount.value double

Сумма подарка.
value
 balance.value double

Баланс, оставшийся на подарок.
Номер пакета
 batch_number string

Номер пакета, связанный с этим подарком.
Состояние
 gift_status string

Состояние подарка.
Анонимный?
 is_anonymous boolean

Является ли подарок анонимным?
Избирательный округ
 constituency string

Избирательный округ подарка.
Идентификатор подстановки
 lookup_id string

Определяемый пользователем идентификатор для подарка.
Происхождение
 origin string

Происхождение подарка.
Состояние публикации
 post_status string

Общее состояние записи реестра подарка. Доступные значения: Posted, NotPosted и DoNotPost. Если для post_status задано значение DoNotPost>, post_date должно иметь значение NULL. Если для него задано значение NotPosted, post_date требуется, но остается редактируемым. Если задано значение Posted, post_date требуется и больше не редактируется.
Дата публикации
 post_date date-time

Дата, когда подарок был размещен в общем реестре.
Reference
 reference string

Примечания для отслеживания специальных сведений о подарке, например мотивации за ним или подробное описание подарка в виде.
day
 recurring_gift_status_date.d integer

День в нечеткой дате.
month
 recurring_gift_status_date.m integer

Месяц в нечеткой дате.
год
 recurring_gift_status_date.y integer

Год в нечеткой дате.
frequency
 recurring_gift_schedule.frequency string

Частота установки повторяющегося подарка для просмотра. Доступные значения: WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, ЕЖЕКВАРТАЛЬНО, ЕЖЕГОДНО.
start
 recurring_gift_schedule.start_date date-time

Дата начала повторяющегося подарка.
конец
 recurring_gift_schedule.end_date date-time

Дата окончания повторяющегося подарка.
value
 gift_aid_amount.value double

Это вычисленное поле вычисляет общую квалифицированную сумму налога, возвращенную из подарочной помощи во всех gift_splits для этого подарка. Только для Великобритании.
Статус квалификации по оказанию помощи в подарок
 gift_aid_qualification_status string

Это вычисляемое поле определяет состояние квалификации "Помощь подарка" на основе сведений о налоговом объявлении и формате базы данных. Доступные значения: Qualified, NotQualified и PartlyQualified. Только для Великобритании.
Подарочный код
 gift_code string

Значение кода подарка, связанное с подарком.
Разделение подарков
 gift_splits array of GiftApi.GiftSplitRead

Набор подарков расщепляется, связанный с подарком.
Сбор средств
 fundraisers array of GiftApi.GiftFundraiserRead

Набор сборов средств, получающих кредит на подарок.
Мягкие кредиты
 soft_credits array of GiftApi.SoftCreditRead

Набор мягких кредитов, связанных с подарком.
Получения
 receipts array of GiftApi.ReceiptRead

Набор квитанций, связанных с подарком.
Благодарности
 acknowledgements array of GiftApi.AcknowledgementRead

Набор подтверждений, связанных с подарком.
Payments
 payments array of GiftApi.PaymentRead

Платежи по подароку.
Связанные подарки
 linked_gifts array of string

Идентификаторы других подарков, связанных с этим подарком.
Дата добавления
 date_added date-time

Дата создания подарка.
Дата изменения
 date_modified date-time

Дата последнего изменения подарка.

GiftApi.GiftSplitRead

Разделение подарков

Имя Путь Тип Описание
Идентификатор
 id string

Системный идентификатор записи разделения подарка.
value
 amount.value double

Количество разделенного подарка.
Идентификатор апелляции
 appeal_id string

Системный идентификатор апелляции, связанной с разделением подарка.
Идентификатор кампании
 campaign_id string

Системный идентификатор кампании, связанной с разделением подарка.
Идентификатор фонда
 fund_id string

Системный идентификатор фонда, связанного с разделением подарка.
value
 gift_aid_amount.value double

Сумма налога, отвоеванной от подарочной помощи для этого подарка раскол. Только для Великобритании.
Статус квалификации подарочной помощи
 gift_aid_qualification_status string

Статус подарочной помощи для разделения подарка. Доступные значения: "Квалифицировано" и "NotQualified". Только для Великобритании.
Идентификатор пакета
 package_id string

Системный идентификатор пакета, связанного с разделением подарка.

GiftApi.ReceiptRead

Приход

Имя Путь Тип Описание
value
 amount.value double

Сумма квитанции.
date
 date date-time

Дата получения.
число/номер
 number integer

Номер квитанции.
статус
 status string

Состояние квитанции. Доступные значения: RECEIPTED, NEEDSRECEIPT и DONOTRECEIPT.

GiftApi.PaymentRead

Уплата

Имя Путь Тип Описание
маркер учетной записи
 account_token string

Сведения о маркеризованной учетной записи (например, кредитная карта) от внешнего поставщика платежей. Применяется только к методам оплаты "CreditCard" и DirectDebit.
Идентификатор конфигурации BBPS
 bbps_configuration_id string

Идентификатор конфигурации BBPS. Применяется только к методам оплаты "CreditCard" и DirectDebit.
Идентификатор транзакции BBPS
 bbps_transaction_id string

Идентификатор транзакции BBPS. Применяется только к методам оплаты "CreditCard" и DirectDebit.
day
 check_date.d integer

День в нечеткой дате.
month
 check_date.m integer

Месяц в нечеткой дате.
год
 check_date.y integer

Год в нечеткой дате.
контрольный номер
 check_number string

Контрольный номер. Применяется только к методу оплаты "PersonalCheck".
Идентификатор транзакции для выхода
 checkout_transaction_id string

Идентификатор транзакции для вырезки. Применяется только к методам оплаты "CreditCard" и DirectDebit.
Метод оплаты
 payment_method string

Метод оплаты. Доступные значения перечислены ниже.
справочник
 reference string

Ссылка. Применяется только к методу оплаты "Other".
day
 reference_date.d integer

День в нечеткой дате.
month
 reference_date.m integer

Месяц в нечеткой дате.
год
 reference_date.y integer

Год в нечеткой дате.

GiftApi.SoftCreditRead

Мягкий кредит

Имя Путь Тип Описание
Идентификатор
 id string

Системный идентификатор записи мягкого кредита.
value
 amount.value double

Сумма мягкого кредита.
составной идентификатор
 constituent_id string

Системный идентификатор записи компонента, связанного с мягким кредитом.
Идентификатор подарка
 gift_id string

Системный идентификатор подарка, связанного с мягким кредитом.

Gift2Api.PledgeInstallment

Представляет объект установки.

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор системной записи для установки.
date
 date date-time

Дата установки.
год
 year integer

Год установки.
value
 amount.value double

Сумма установки.
равновесие
 balance double

Баланс установки.
оставшийся баланс залога
 remaining_pledge_balance double

Оставшийся баланс залога.
последовательность
 sequence integer

Последовательность заказа на установку.

Gift2Api.PledgeInstallmentCollection

Рассрочку

Имя Путь Тип Описание
Начальная дата
 start_date date-time

Дата начала расписания подарков.
Частота
 frequency string

Частота расписания подарков.
Токен параллелизма
 concurrency_token string

Маркер параллелизма.
Рассрочку
 installments array of Gift2Api.PledgeInstallment

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

Gift2Api.PledgePayment

Представляет объект оплаты залога.

Имя Путь Тип Описание
Идентификатор установки
 installment_id string

Системный идентификатор платной записи.
Идентификатор подарка
 payment_gift_id string

Системный идентификатор платежа.
value
 amount_applied.value double

Сумма, примененная к установке.

Gift2Api.PledgePaymentCollection

Payments

Имя Путь Тип Описание
pledge_payments
 pledge_payments array of Gift2Api.PledgePayment

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

GiftBatchApi.ApiCollectionOfGiftBatch

Пакеты подарков

Имя Путь Тип Описание
Численность
 count integer

Общее количество пакетов подарков в ответе.
value
 value array of GiftBatchApi.GiftBatch

Набор элементов, включенных в ответ.

GiftBatchApi.CreatedBatchCh

Создан пакет подарков

Имя Путь Тип Описание
Идентификатор
 batch_id string

Системный идентификатор записей только что созданного пакета подарков.

GiftBatchApi.GiftBatch

Представляет объект пакета подарков

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор системной записи пакета.
описание
 batch_description string

Описание пакета.
номер пакета
 batch_number string

Номер пакета
проецируемый номер
 projected_number_of_gifts integer

Прогнозируемый номер подарков в пакете.
фактическое число
 number_of_gifts integer

Фактическое количество подарков в пакете.
прогнозируемый объем
 projected_amount double

Проецируемого значения подарков в пакете.
фактическая сумма
 actual_amount double

Фактическое значение подарков в пакете.
есть исключения?
 has_exceptions boolean

Есть ли в пакете исключения?
одобренный?
 is_approved boolean

Утвержден ли пакет?
Кем создано:
 created_by string

Имя пользователя, создавшего пакет.
Создано
 created_on date-time

Дата создания пакета.

NXTDataIntegrationApi.CreatedGiftNote

Созданная заметка

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор только что созданной заметки.

NXTDataIntegrationApi.CreatedGiftTribute

Созданная дань подарка

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор только что созданного дара дань.

NXTDataIntegrationApi.CreatedTaxDeclaration

Созданное налоговое объявление

Имя Путь Тип Описание
Идентификатор
 id string

Идентификатор только что созданного налогового объявления.

NXTDataIntegrationApi.GiftIdMap

Карта идентификатора подарка

Имя Путь Тип Описание
Идентификатор
 system_record_id integer

Идентификатор записи системы подарков.

NXTDataIntegrationApi.GiftNote

Замечание

Имя Путь Тип Описание
Идентификатор подарка
 gift_id integer

Системный идентификатор записи подарка, связанного с заметкой.
Тип
 type string

Тип заметки.
day
 date.d integer

День в нечеткой дате.
month
 date.m integer

Месяц в нечеткой дате.
год
 date.y integer

Год в нечеткой дате.
Сводка
 summary string

Сводка по заметкам.
Замечание
 text string

Текст заметки.
Author
 author string

Автор заметки.

NXTDataIntegrationApi.GiftNoteCollection

Заметки о подарках

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of NXTDataIntegrationApi.GiftNote

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

NXTDataIntegrationApi.GiftTribute

Подарок дань

Имя Путь Тип Описание
Идентификатор
 id integer

Системный идентификатор дани подарка.
Идентификатор подарка
 gift_id integer

Системный идентификатор записи подарка.
Идентификатор дани
 tribute_id integer

Системный идентификатор записи дани.
Тип дани
 tribute_type integer

Тип дани.
Состояние подтверждения
 acknowledge string

Подарок дань признает статус.
Последовательность
 sequence integer

Последовательность дани подарка.

NXTDataIntegrationApi.GiftTributeAcknowledgee

Подарок дань признает запись в Raiser Edge.

Имя Путь Тип Описание
Идентификатор
 id integer

Системный идентификатор записи дани подарка признается.
Идентификатор дани подарка
 gift_tribute_id integer

Системный идентификатор дани подарка.
Самоузнание?
 self_acknowledge boolean

Это признание самоузнание?
Идентификатор связей
 relationships_id integer

Идентификатор системной записи связи для подтверждения.
Письмо
 letter integer

Письмо, отправленное в подтверждение.
Дата письма
 letter_date date-time

Дата отправки письма.

NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

Дар дань признается

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of NXTDataIntegrationApi.GiftTributeAcknowledgee

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

NXTDataIntegrationApi.GiftTributeCollection

Дар дань

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of NXTDataIntegrationApi.GiftTribute

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.

NXTDataIntegrationApi.TaxDeclaration

Имя Путь Тип Описание
Идентификатор
 declaration_id integer
Начало объявления
 declaration_starts date-time

Дата начала налогового объявления.
Объявление заканчивается
 declaration_ends date-time

Дата окончания налоговой декларации.
Объявление сделано
 declaration_made date-time

Дата создания налогового объявления.
Идентификатор индикатора
 declaration_indicator_id integer

Идентификатор индикатора объявления.
Indicator
 declaration_indicator string

Индикатор объявления.
Исходный идентификатор
 declaration_source_id integer

Идентификатор источника объявления.
Исходный материал
 declaration_source string

Источник объявления.
Отправлено подтверждение
 confirmation_sent date-time

Дата отправки подтверждения.
Подтверждение возвращено
 confirmation_returned date-time

Дата возврата подтверждения.
Платит налог
 constituent_pays_tax string

Указывает, платит ли составляющий налог.
Идентификатор состояния
 tax_payer_status_id integer

Идентификатор статуса плательщика налогов.
Состояние
 tax_payer_status string

Статус плательщика налогов.
Comments
 tax_notes string

Комментарии к налоговому объявлению.
Последовательность
 sequence integer

Числовая последовательность, связанная с налоговым объявлением.

NXTDataIntegrationApi.TaxDeclarationCollection

Налоговые объявления

Имя Путь Тип Описание
Численность
 count integer

Количество элементов, доступных для извлечения в коллекцию после применения любых параметров запроса. Параметры ограничения и смещения не влияют на число, но для упрощения разбиения по страницам они могут повлиять на количество элементов в результирующем наборе значений.
value
 value array of NXTDataIntegrationApi.TaxDeclaration

Набор элементов, включенных в ответ. Это может быть подмножество элементов в коллекции.