Blackbaud Raisers Edge NXT Gifts
Blackbaud Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。 ギフトを管理するには、Gifts コネクタを使用します。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Blackbaud サポート |
| [URL] | https://www.blackbaud.com/support |
| メール | skyapi@blackbaud.com |
| Connector Metadata | |
|---|---|
| 発行者 | Blackbaud, Inc. |
| Web サイト | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| プライバシー ポリシー | https://www.blackbaud.com/privacy-shield |
| カテゴリー | 販売と CRM、生産性 |
Raiser's Edge NXT は、非営利団体と社会貢献コミュニティ全体のために特別に構築された、包括的なクラウドベースの資金調達および寄付者管理ソフトウェア ソリューションです。
このコネクタは Blackbaud の SKY API 上に構築されていて、The Raiser's Edge NXT 内の以下のようなギフトおよび関連エンティティを管理するのに役立つ操作を提供します。
- ギフトとスタッフの寄付の概要
- 贈与バッチ
- 領収書
- 確認
- その他...
詳細については、ドキュメントを参照してください。
前提条件
このコネクタを使用するには、1 つ以上の Blackbaud 環境にアクセスできる Blackbaud ID アカウントが必要です。
さらに、組織の管理者は、この コネクタが Blackbaud 環境にアクセスできるようにするために、システム内で管理者レベルのアクションも実行する必要があります。 これらの前提条件の詳細については、初期設定ドキュメントを参照してください。
資格情報の入手方法
組織の管理者は、組織の Raiser's Edge NXT 環境への招待状を送信し、環境内でユーザー アカウントのアクセス許可を構成します。 このコネクタを使用するために追加の資格情報は必要ありません。
既知の問題と制限事項
コネクタはユーザー アカウントのコンテキストで機能するため、環境内のユーザー アクセス許可が適用されます。
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ギフト カスタム フィールドを一覧表示する |
ギフトのカスタム フィールドを一覧表示します。 |
| ギフト トリビュート アクノリッジを一覧表示する |
ギフト トリビュート アクノリッジを一覧表示します。 |
| ギフト トリビュート アクノリッジを更新する |
ギフト トリビュート アクノリッジを更新します。 |
| ギフト トリビュートを一覧表示する |
ギフト トリビュートを一覧表示します。 |
| ギフト トリビュートを作成する |
ギフトに対する新しいトリビュートを作成します。 |
| ギフト トリビュートを更新する |
ギフト トリビュートを更新します。 |
| ギフト バッチの一覧 |
ギフト バッチを一覧で表示します。 |
| ギフト バッチを作成する |
新しいギフト バッチを作成します。 |
| ギフト メモを一覧表示する |
ギフト メモを一覧表示します。 |
| ギフト メモを作成する |
新しいギフト ノートを作成します。 |
| ギフト メモを更新する |
ギフト メモを更新します。 |
| ギフトのカスタム フィールドを作成する |
新しいギフトのカスタム フィールドを作成します。 |
| ギフトのカスタム フィールドを更新する |
ギフトのカスタム フィールドを更新します。 |
| ギフトの添付資料を一覧表示する |
ギフトの添付資料を一覧表示します。 |
| ギフトを一覧表示する |
ギフトの一覧が返されます。 |
| ギフトを作成する |
新しいギフトを作成します。 |
| ギフトを取得する |
ギフトに関する情報を返します。 |
| ギフト受信確認の詳細を更新する |
ギフトの受信確認の詳細を更新します。 |
| ギフト添付資料を作成する |
新しいギフト添付資料を作成します。 |
| ギフト添付資料を更新する |
ギフト添付資料を更新します。 |
| ギフト領収書の詳細を更新する |
ギフトの領収書の詳細を更新します。 |
| スタッフの最初のギフトを取得する |
スタッフに対する最初のギフトを返します。 |
| スタッフの最新ギフトを取得する |
スタッフの最新ギフトを返します。 |
| スタッフの最高ギフトを取得する |
スタッフに対する最大の贈与を返します。 |
| スタッフの生涯寄付を取得します |
スタッフの生涯寄付について概要を返します。 |
| スタッフの税申告を一覧表示する |
スタッフのギフト支援の税申告を一覧表示します (英国バージョンにのみ適用可能)。 |
| スタッフの税申告を作成する |
スタッフの新しいギフト支援の税申告を作成します。 |
| スタッフの税申告を更新する |
スタッフの税申告を更新します。 |
| バッチにギフトを追加する |
指定したギフト バッチにギフトを追加します。 |
| 検索 ID でギフトを取得する |
指定された検索 ID からギフトのシステム レコード IDを返します。 |
ギフト カスタム フィールドを一覧表示する
ギフトのカスタム フィールドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | string |
ギフトのシステム レコード ID。 |
戻り値
カスタム フィールド
ギフト トリビュート アクノリッジを一覧表示する
ギフト トリビュート アクノリッジを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト トリビュート ID
|
gift_tribute_id | True | integer |
ギフト トリビュートのシステム レコード ID。 |
戻り値
ギフト トリビュート アクノリッジ
ギフト トリビュート アクノリッジを更新する
ギフト トリビュート アクノリッジを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト トリビュート アクノリッジ ID
|
gift_tribute_acknowledgee_id | True | integer |
更新するギフト トリビュート アクノリッジのシステム レコード ID。 |
|
レター
|
letter | integer |
アクノリッジに送信されたレター。 |
|
|
レター日付
|
letter_date | date-time |
レターが送信された日付。 |
ギフト トリビュートを一覧表示する
ギフト トリビュートを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | integer |
ギフトのシステム レコード ID。 |
戻り値
ギフト トリビュート
ギフト トリビュートを作成する
ギフトに対する新しいトリビュートを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | integer |
ギフト トリビュートに関連付けられたギフトのシステム レコード ID。 |
|
トリビュート ID
|
tribute_id | True | integer |
ギフト トリビュートに関連付けられたトリビュートのシステム レコード ID。 |
戻り値
作成したギフト トリビュート
ギフト トリビュートを更新する
ギフト トリビュートを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト トリビュート ID
|
gift_tribute_id | True | integer |
更新するギフト トリビュートのシステム レコード ID。 |
|
トリビュート タイプ
|
tribute_type | integer |
トリビュートのタイプ。 |
|
|
確認状態
|
acknowledge | string |
ギフト トリビュートの確認状態。 |
ギフト バッチの一覧
ギフト バッチを一覧で表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バッチ番号
|
batch_number | string |
指定した数と一致する結果に対するフィルターを表します。 |
|
|
承認済みかどうか
|
approved | boolean |
ギフト バッチの状態に対するフィルターを表します。 |
|
|
例外があるかどうか
|
has_exceptions | boolean |
ギフト バッチが例外を含むかどうかに対するフィルターを表します。 |
|
|
制限
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大値は 5000 です。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
|
|
検索テキスト
|
search_text | string |
バッチの説明やバッチ番号のフィールドに含まれるテキストに対するフィルターを表します。 |
|
|
作成者
|
created_by | string |
指定したユーザーが作成したギフト バッチに対するフィルターを表します。 |
戻り値
贈与バッチ
ギフト バッチを作成する
新しいギフト バッチを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
内容
|
batch_description | string |
バッチの説明。 |
|
|
見積もり件数
|
expected_number | integer |
バッチが含む贈与の予想数。 |
|
|
見積もり合計
|
expected_batch_total | double |
バッチが含む贈与の合計額。 |
|
|
バッチ番号
|
batch_number | string |
バッチに固有の一意識別子。 |
戻り値
作成した贈与バッチ
ギフト メモを一覧表示する
ギフト メモを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | integer |
ギフトのシステム レコード ID。 |
|
制限
|
limit | integer |
返されるレコード数を表します。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
戻り値
ギフト メモ
ギフト メモを作成する
新しいギフト ノートを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | integer |
メモに関連付けられたギフトのシステム レコード ID。 |
|
タイプ
|
note_type_id | True | integer |
メモのタイプ。 |
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
概要
|
summary | string |
ノートの概要。 文字数制限: 255。 |
|
|
メモ
|
text | string |
メモ テキスト。 |
|
|
作成者
|
author | string |
メモの作成者。 文字数制限: 50。 |
戻り値
作成されたメモ
ギフト メモを更新する
ギフト メモを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メモ ID
|
id | True | integer |
更新するメモのシステム レコード ID。 |
|
タイプ
|
note_type_id | integer |
メモの種類。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
概要
|
summary | string |
ノートの概要。 文字数制限: 255。 |
|
|
メモ
|
text | string |
メモ テキスト。 |
|
|
作成者
|
author | string |
メモの作成者。 文字数制限: 50。 |
ギフトのカスタム フィールドを作成する
新しいギフトのカスタム フィールドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
本文
|
body | True | dynamic |
作成するカスタム フィールドを表すオブジェクト。 |
戻り値
作成したギフト カスタム フィールド
ギフトのカスタム フィールドを更新する
ギフトのカスタム フィールドを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
カスタム フィールド ID
|
custom_field_id | True | string |
更新するカスタム フィールドのシステム レコード ID。 |
|
本文
|
body | True | dynamic |
更新するカスタム フィールドのプロパティを表すオブジェクト。 |
ギフトの添付資料を一覧表示する
ギフトの添付資料を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | string |
贈与のシステム レコード ID。 |
戻り値
Attachments
ギフトを一覧表示する
ギフトの一覧が返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
一覧
|
list_id | string |
指定したリストに含まれるギフト セットをフィルター処理するために使用するリスト識別子を定義します。 この値が設定されている場合、他の指定されたフィルターは無視されます。 |
|
|
タイプ
|
gift_type | string |
結果をフィルタリングするギフトの種類のコンマ区切り一覧を表します。 たとえば、"MatchingGiftPledge,RecurringGift" は、ギフトの種類 MatchingGiftPledge または RecurringGift のみを返します。 |
|
|
スタッフ ID
|
constituent_id | string |
結果をフィルター処理する、スタッフ システム レコード ID のコンマ区切りリストを表します。 たとえば、"280,1232" では、スタッフ 280 とスタッフ 1232 からのギフトのみが返ります。 |
|
|
キャンペーン ID
|
campaign_id | string |
結果をフィルター処理する、キャンペーン システム レコード ID のコンマ区切りリストを表します。 たとえば、"506,918" では、キャンペーン 506 とキャンペーン 918 に対するギフトのみが返ります。 |
|
|
資金 ID
|
fund_id | string |
結果をフィルター処理する、資金システム レコード ID のコンマ区切りリストを表します。 たとえば、"506,918" では、資金 506 と資金 918 に対するギフトのみが返ります。 |
|
|
アピール ID
|
appeal_id | string |
結果をフィルター処理する、異議申し立てシステム レコード ID のコンマ区切りリストを表します。 たとえば、"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,Acknowledged" は、DoNotAcknowledge または Acknowledged としてマークされているギフトのみを返します。 |
|
|
並べ替え基準
|
sort | string |
結果を並べ替えるフィールドの一覧を表します。 結果は既定で昇順の並べ替えであり、'-' 記号は降順の並べ替えを示します。 たとえば "date_added,-date" では、贈与を "date_added" フィールドで昇順に並べ替え、次に "贈与の日付" フィールドで降順に並べ替えます。 date_modified フィールドのみ、または date_added フィールドのみを指定する場合、贈与を適切にソートできるように、sort_token パラメーターを next_link URL に追加します。 |
|
|
以降に追加
|
date_added | date-time |
指定した日付以降に作成された贈与に対して、結果をフィルターします (例: '2020-09-18T04:13:56Z')。 |
|
|
以降に修正済
|
last_modified | date-time |
指定した日付以降に変更された贈与に対して、結果をフィルターします (例: '2020-09-18T04:13:56Z')。 |
戻り値
ギフト
ギフトを作成する
新しいギフトを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | string |
ギフトに関連付けられたスタッフのシステム レコード ID。 |
|
金額
|
value | True | double |
ギフトの金額。 |
|
日
|
date | True | date |
贈与の日付 (例: '2020-09-18')。 |
|
タイプ
|
type | True | string |
ギフトの種類。 |
|
キャンペーン ID
|
campaign_id | string |
贈与分割に関連付けられたキャンペーンのシステム レコード ID。 |
|
|
資金 ID
|
fund_id | True | string |
贈与分割に関連付けられた資金のシステム レコード ID。 |
|
異議申し立て ID
|
appeal_id | string |
贈与分割に関連付けられた異議申し立てのシステム レコード ID。 |
|
|
パッケージ ID
|
package_id | string |
贈与分割に関連付けられたパッケージのシステム レコード ID。 |
|
|
金額
|
value | True | double |
贈与分割の金額。 |
|
支払方法
|
payment_method | True | string |
支払方法。 |
|
小切手番号
|
check_number | string |
小切手番号 (支払方法が "個人的小切手" の場合のみ適用されます)。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
参照
|
reference | string |
支払参照 (支払方法が "その他" の場合のみ適用されます)。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
匿名かどうか
|
is_anonymous | boolean |
匿名贈与かどうか 値を指定しない場合は、既定の寄付者の匿名性を使用します。 |
|
|
サブタイプ
|
subtype | string |
ギフトのサブタイプ。 |
|
|
コメント
|
reference | string |
ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。 |
|
|
検索 ID
|
lookup_id | string |
このギフトのユーザーが定義した識別子。 |
|
|
基金調達者クレジットを使用しますか?
|
default_fundraiser_credits | boolean |
既定の基金調達者クレジットを使用しますか? |
|
|
ソフト クレジットを使用しますか?
|
default_soft_credits | boolean |
既定のソフト クレジットを使用しますか? |
|
|
購買者層
|
constituency | string |
ギフトの購買者層。 |
|
|
バッチ接頭辞
|
batch_prefix | string |
バッチ ギフトに使用する接頭辞。 これには少なくとも 1 文字が含まれている必要があり、'バッチ番号' に値がある場合に必要になります。 |
|
|
バッチ番号
|
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
ギフトを取得する
ギフトに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
gift_id | True | string |
取得するギフトのシステム レコード ID。 |
戻り値
ギフト
ギフト受信確認の詳細を更新する
ギフトの受信確認の詳細を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
受信確認 ID
|
acknowledgement_id | True | string |
更新するギフト受信確認のシステム レコード ID。 親ギフトの ID を値として使用します。 |
|
ステータス
|
status | string |
受信確認のステータス。 ステータスが DoNotAcknowledge に設定されている場合、文字と日付は null である必要があります。 ステータスが NeedsAcknowledgement に設定されている場合、日付は null である必要があります。 |
|
|
日
|
date | date-time |
受信確認に関連付けられた日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
レター
|
letter | string |
受信確認に関連付けられた文字。 |
ギフト添付資料を作成する
新しいギフト添付資料を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
parent_id | True | string |
添付資料に関連付けられたギフトのシステム レコード ID。 |
|
タイプ
|
type | True | string |
添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。 |
|
件名
|
name | string |
添付資料の名前。 文字数制限: 150。 |
|
|
日
|
date | date-time |
添付資料の日付 (例: '2020-09-18T04:13:56Z')。 指定しない場合、このフィールドは既定で現在の日時になります。 |
|
|
URL
|
url | string |
添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。 |
|
|
ファイル名
|
file_name | string |
ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。 |
|
|
ファイル ID
|
file_id | string |
ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。 |
|
|
サムネイル ID
|
thumbnail_id | string |
サムネイルの識別子。 文字数制限: 36。 物理的な添付ファイルのみ。 |
|
|
Tags
|
tags | array of string |
添付ファイルに関連付けられているタグ |
戻り値
作成したギフトの添付ファイル
ギフト添付資料を更新する
ギフト添付資料を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Attachment ID
|
attachment_id | True | string |
更新する添付資料のシステム レコード ID。 |
|
件名
|
name | string |
添付資料の名前。 文字数制限: 150。 |
|
|
日
|
date | date-time |
添付資料の日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
URL
|
url | string |
添付資料の URL。 これはリンク添付ファイルに必要であり、物理的な添付ファイルには適用されません。 |
|
|
Tags
|
tags | array of string |
添付ファイルに関連付けられているタグ |
ギフト領収書の詳細を更新する
ギフトの領収書の詳細を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
領収書 ID
|
receipt_id | True | string |
更新するギフト領収書のシステム レコード ID。 親ギフトの ID を値として使用します。 |
|
ステータス
|
status | string |
贈与の領収書の状態。 ステータスが NeedsReceipt または DoNotReceipt に設定されている場合、領収書の日付は null である必要があります。 |
|
|
値
|
value | double |
金額。 |
|
|
日
|
date | date-time |
領収書の日付 (例: '2020-09-18T04:13:56Z')。 |
|
|
Number
|
number | integer |
領収書の番号。 |
スタッフの最初のギフトを取得する
スタッフに対する最初のギフトを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | string |
スタッフのシステム レコード ID。 |
戻り値
寄付の概要
スタッフの最新ギフトを取得する
スタッフの最新ギフトを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | string |
スタッフのシステム レコード ID。 |
戻り値
寄付の概要
スタッフの最高ギフトを取得する
スタッフに対する最大の贈与を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | string |
スタッフのシステム レコード ID。 |
戻り値
寄付の概要
スタッフの生涯寄付を取得します
スタッフの生涯寄付について概要を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | string |
スタッフのシステム レコード ID。 |
戻り値
生涯寄付
スタッフの税申告を一覧表示する
スタッフのギフト支援の税申告を一覧表示します (英国バージョンにのみ適用可能)。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | integer |
スタッフのシステム レコード ID。 |
|
Limit
|
limit | integer |
返されるレコード数を表します。 既定値は 500 です。 最大数はありません。 |
|
|
オフセット
|
offset | integer |
スキップするレコード数を表します。 改ページで使用します。 |
戻り値
税申告
スタッフの税申告を作成する
スタッフの新しいギフト支援の税申告を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
スタッフ ID
|
constituent_id | True | integer |
スタッフのシステム レコード ID。 |
|
申告の開始
|
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')。 |
|
|
インジケーター
|
declaration_indicator | string |
申告のインジケーター。 |
|
|
Source
|
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 |
スタッフが税を支払うかどうかを示します。 |
|
|
Status
|
tax_payer_status | string |
納税者の状態。 |
|
|
Comments
|
tax_notes | string |
税申告のコメント。 |
|
|
シークエンス
|
sequence | integer |
税申告に関連付けられた数列。 |
戻り値
作成された税申告
スタッフの税申告を更新する
スタッフの税申告を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
税申告 ID
|
tax_declaration_id | True | integer |
更新する税申告のシステム レコード ID。 |
|
申告の開始
|
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')。 |
|
|
インジケーター
|
declaration_indicator | string |
申告のインジケーター。 |
|
|
Source
|
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 |
スタッフが税を支払うかどうかを示します。 |
|
|
Status
|
tax_payer_status | string |
納税者の状態。 |
|
|
Comments
|
tax_notes | string |
税申告のコメント。 |
|
|
シークエンス
|
sequence | integer |
税申告に関連付けられた数列。 |
バッチにギフトを追加する
指定したギフト バッチにギフトを追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バッチ
|
batch_id | True | string |
ギフトを追加する対象のバッチ。 |
|
スタッフ ID
|
constituent_id | True | string |
ギフトに関連付けられたスタッフのシステム レコード ID。 |
|
金額
|
value | True | double |
ギフトの金額。 |
|
日
|
date | True | date |
贈与の日付 (例: '2020-09-18')。 |
|
タイプ
|
type | True | string |
ギフトの種類。 |
|
キャンペーン ID
|
campaign_id | string |
贈与分割に関連付けられたキャンペーンのシステム レコード ID。 |
|
|
資金 ID
|
fund_id | True | string |
贈与分割に関連付けられた資金のシステム レコード ID。 |
|
異議申し立て ID
|
appeal_id | string |
贈与分割に関連付けられた異議申し立てのシステム レコード ID。 |
|
|
パッケージ ID
|
package_id | string |
贈与分割に関連付けられたパッケージのシステム レコード ID。 |
|
|
金額
|
value | True | double |
贈与分割の金額。 |
|
支払方法
|
payment_method | True | string |
支払方法。 |
|
小切手番号
|
check_number | string |
小切手番号 (支払方法が "個人的小切手" の場合のみ適用されます)。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
参照
|
reference | string |
支払参照 (支払方法が "その他" の場合のみ適用されます)。 |
|
|
日
|
d | integer |
あいまいな日付で表した日。 |
|
|
月
|
m | integer |
あいまいな日付で表した月。 |
|
|
年
|
y | integer |
あいまいな日付で表した年。 |
|
|
匿名かどうか
|
is_anonymous | boolean |
匿名贈与かどうか 値を指定しない場合は、既定の寄付者の匿名性を使用します。 |
|
|
サブタイプ
|
subtype | string |
ギフトのサブタイプ。 |
|
|
コメント
|
reference | string |
ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。 |
|
|
検索 ID
|
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')。 |
戻り値
バッチ ギフト エラー レコードのコレクションと、この操作で追加したバッチ ギフトを含みます
検索 ID でギフトを取得する
指定された検索 ID からギフトのシステム レコード IDを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索 ID
|
giftlookupid | True | string |
ギフトの検索 ID。 |
戻り値
ギフト ID マップ
定義
ConstituentApi.AppealRead
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
アピールのシステム レコード ID。 |
|
説明
|
description | string |
異議申し立ての説明。 |
ConstituentApi.CampaignRead
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
キャンペーンのシステム レコード ID。 |
|
description
|
description | string |
キャンペーンの説明。 |
ConstituentApi.FundRead
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
資金のシステム レコード ID。 |
|
説明
|
description | string |
資金の説明。 |
ConstituentApi.GivingSummaryRead
寄付の概要
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
贈与のシステム レコード ID。 |
|
タイプ
|
type | string |
ギフトの種類。 |
|
日
|
date | date-time |
ギフトの日付。 |
|
値
|
amount.value | double |
金額。 |
|
異議申し立て
|
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 |
スタッフが寄付を受けた合計年数。 |
|
値
|
total_giving.value | double |
金額。 |
|
値
|
total_pledge_balance.value | double |
金額。 |
|
値
|
total_received_giving.value | double |
金額。 |
|
値
|
total_committed_matching_gifts.value | double |
金額。 |
|
価値
|
total_received_matching_gifts.value | double |
金額。 |
|
価値
|
total_soft_credits.value | double |
金額。 |
GiftApi.AcknowledgementRead
受信確認
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
date
|
date | date-time |
受信確認に関連付けられた日付。 |
|
レター
|
letter | string |
受信確認に関連付けられた文字。 |
|
状態
|
status | string |
受信確認のステータス。 有効な値: ACKNOWLEDGED、NEEDSACKNOWLEDGEMENT、DONOTACKNOWLEDGE。 |
GiftApi.ApiCollectionOfGiftAttachmentRead
Attachments
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of GiftApi.GiftAttachmentRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
GiftApi.ApiCollectionOfGiftCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of GiftApi.GiftCustomFieldRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
GiftApi.ApiCollectionOfGiftRead
ギフト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of GiftApi.GiftRead |
応答が含む項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
GiftApi.BatchGiftAddResults
バッチ ギフト エラー レコードのコレクションと、この操作で追加したバッチ ギフトを含みます
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
エラー
|
errors | array of GiftApi.GiftBatchGiftError |
ギフトを追加するバッチ操作に関連するギフトのバッチ エラー |
|
ギフト
|
gifts | array of GiftApi.BatchGiftRead |
ギフトを追加するバッチ操作によって追加したバッチ ギフト コレクション |
GiftApi.GiftBatchGiftError
項目をバッチに追加できないようにする例外を表します。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
影響を受けるフィールド
|
affected_field | string |
エラーの影響を受けるフィールド |
|
バッチ ID
|
batch_id | string |
バッチのシステム レコード ID |
|
例外エラー コード
|
exception_error_code | integer |
例外エラー コード |
|
例外エラー メッセージ
|
exception_error_message | string |
例外エラー メッセージ |
|
例外エラー名
|
exception_error_name | string |
例外エラーの名前 |
|
ギフト ID
|
gift_id | string |
贈与のシステム レコード ID |
|
検索 ID
|
lookup_id | string |
このギフトのユーザーが定義した識別子。 |
GiftApi.BatchGiftRead
バッチ ギフト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
バッチ ID
|
batch_id | string |
ギフトを追加した対象バッチの ID。 |
|
エラー
|
errors | array of GiftApi.GiftBatchGiftError |
バッチ贈与に関連付けられたエラー。 |
|
ID
|
id | string |
バッチ贈与のシステム レコード ID。 |
|
スタッフ ID
|
constituent_id | string |
ギフトに関連付けられたスタッフのシステム レコード ID。 |
|
種類
|
type | string |
ギフトの種類。 |
|
サブタイプ
|
subtype | string |
ギフトのサブタイプ。 |
|
日付
|
date | date-time |
ギフトの日付。 |
|
値
|
amount.value | double |
金額。 |
|
値
|
balance.value | double |
金額。 |
|
バッチ番号
|
batch_number | string |
このギフトに関連付けられたバッチ番号。 |
|
状態
|
gift_status | string |
贈与の状態。 |
|
匿名かどうか
|
is_anonymous | boolean |
匿名贈与かどうか |
|
購買者層
|
constituency | string |
ギフトの購買者層。 |
|
検索 ID
|
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 | string |
ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。 |
|
日
|
recurring_gift_status_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
recurring_gift_status_date.m | integer |
あいまいな日付で表した月。 |
|
年
|
recurring_gift_status_date.y | integer |
あいまいな日付で表した年。 |
|
頻度
|
recurring_gift_schedule.frequency | string |
表示する定期的なギフトの分割頻度。 有効な値は、WEEKLY、EVERY_TWO_WEEKS、EVERY_FOUR_WEEKS、MONTHLY、QUARTERLY、ANNUALLY です。 |
|
開始
|
recurring_gift_schedule.start_date | date-time |
定期的な贈与が開始される日付です。 |
|
終了
|
recurring_gift_schedule.end_date | date-time |
定期的な贈与の終了日。 |
|
値
|
gift_aid_amount.value | double |
金額。 |
|
贈与補助の見込み評価の状態
|
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 | array of GiftApi.PaymentRead |
贈与の支払。 |
|
リンクしている贈与
|
linked_gifts | array of string |
この贈与とリンクしている他の贈与の識別子。 |
|
追加した日付
|
date_added | date-time |
ギフトを作成した日。 |
|
変更日
|
date_modified | date-time |
ギフトを最後に変更した日。 |
GiftApi.CreatedGift
作成済みギフト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたギフトの ID。 |
GiftApi.CreatedGiftAttachment
作成済みギフト添付資料
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたギフト添付資料の ID。 |
GiftApi.CreatedGiftCustomField
作成済みギフトのカスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成されたギフトのカスタム フィールドの ID。 |
GiftApi.GiftAttachmentRead
添付
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
添付資料のシステム レコード ID。 |
|
ギフト ID
|
parent_id | string |
添付資料に関連付けられたギフトのシステム レコード ID。 |
|
タイプ
|
type | string |
添付資料の種類。 物理的な添付資料は、ローカルまたはネットワークに保存されている画像、PDF、Word 文書などのアップロードされたファイルです。 これらはシステムに保存および管理されます。 リンク添付資料は、オンラインまたはクラウド ストレージ アカウントにある画像、ブログ投稿、または YouTube ビデオにリンクしています。 それらは外部に保存および管理されます。 |
|
件名
|
name | string |
添付資料の名前。 文字数制限: 150。 |
|
日
|
date | date-time |
添付資料の日付。 |
|
URL
|
url | string |
添付資料の URL。 これはリンク添付資料に必要であり、物理的な添付資料には適用されません。 |
|
ファイル名
|
file_name | string |
ファイルの名前。 文字数制限: 36。 物理的な添付資料のみ。 |
|
ファイル ID
|
file_id | string |
ファイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。 |
|
サムネイル ID
|
thumbnail_id | string |
サムネイルの識別子。 文字数制限: 36。 物理的な添付資料のみ。 |
|
サムネイル URL
|
thumbnail_url | string |
サムネイルの URL。 画像のみの物理的な添付資料の場合。 アクセスを 60 分に制限する、時間期限付きの署名が含まれます。 |
|
コンテンツ タイプ
|
content_type | string |
コンテンツの種類。 物理的な添付資料のみ。 |
|
ファイル サイズ
|
file_size | integer |
ファイル サイズ (バイト数)。 物理的な添付ファイルのみ。 |
|
タグ
|
tags | array of string |
添付ファイルに関連付けられているタグ |
GiftApi.GiftCustomFieldRead
カスタム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
カスタム フィールドのシステム レコード ID。 |
|
ギフト ID
|
parent_id | string |
カスタム フィールドに関連付けられたギフトのシステム レコード ID。 |
|
カテゴリ
|
category | string |
カスタム フィールド カテゴリ。 |
|
タイプ
|
type | string |
カスタム フィールドが表すデータの種類。 |
|
値
|
value |
カスタム フィールドの値。 |
|
|
テキスト値
|
text_value | string |
カスタム フィールドのテキスト値。 |
|
番号値
|
number_value | integer |
カスタム フィールドの数値。 |
|
日付値
|
date_value | date |
カスタム フィールドの日付値。 |
|
通貨値
|
currency_value | double |
カスタム フィールドの通貨値。 |
|
ブール値
|
boolean_value | boolean |
カスタム フィールドのブール値。 |
|
テーブル エントリ値
|
codetableentry_value | string |
カスタム フィールドのテーブル エントリ値。 |
|
スタッフ ID 値
|
constituentid_value | string |
カスタム フィールドのスタッフ ID 値。 |
|
日
|
fuzzydate_value.d | integer |
あいまいな日付の中の日。 |
|
月
|
fuzzydate_value.m | integer |
あいまいな日付の中の月。 |
|
年
|
fuzzydate_value.y | integer |
あいまいな日付の中の年。 |
|
日付
|
date | date |
カスタム フィールドの日付。 |
|
コメント
|
comment | string |
カスタム フィールドのコメント。 文字数制限: 50。 |
|
追加した日付
|
date_added | date-time |
カスタム フィールドが作成された日付。 |
|
変更日
|
date_modified | date-time |
カスタム フィールドが最終変更された日付。 |
GiftApi.GiftFundraiserRead
ギフト資金調達者
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
値
|
amount.value | double |
金額。 |
|
資金調達者 ID
|
constituent_id | string |
ギフトに関連付けられた資金調達者のスタッフ システム レコード ID。 |
GiftApi.GiftRead
贈答業
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
贈与のシステム レコード ID。 |
|
スタッフ ID
|
constituent_id | string |
ギフトに関連付けられたスタッフのシステム レコード ID。 |
|
タイプ
|
type | string |
ギフトの種類。 |
|
サブタイプ
|
subtype | string |
ギフトのサブタイプ。 |
|
日
|
date | date-time |
ギフトの日付。 |
|
値
|
amount.value | double |
金額。 |
|
値
|
balance.value | double |
金額。 |
|
バッチ番号
|
batch_number | string |
このギフトに関連付けられたバッチ番号。 |
|
ステータス
|
gift_status | string |
贈与の状態。 |
|
匿名?
|
is_anonymous | boolean |
匿名贈与かどうか |
|
購買者層
|
constituency | string |
ギフトの購買者層。 |
|
検索 ID
|
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 | string |
ギフトに関する特別な情報 (ギフトに対するモチベーションや、現物ギフトの詳しい説明など) を追跡するメモです。 |
|
日
|
recurring_gift_status_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
recurring_gift_status_date.m | integer |
あいまいな日付で表した月。 |
|
年
|
recurring_gift_status_date.y | integer |
あいまいな日付で表した年。 |
|
頻度
|
recurring_gift_schedule.frequency | string |
表示する定期的なギフトの分割頻度。 有効な値は、WEEKLY、EVERY_TWO_WEEKS、EVERY_FOUR_WEEKS、MONTHLY、QUARTERLY、ANNUALLY です。 |
|
開始
|
recurring_gift_schedule.start_date | date-time |
定期的な贈与が開始される日付です。 |
|
終了
|
recurring_gift_schedule.end_date | date-time |
定期的な贈与の終了日。 |
|
値
|
gift_aid_amount.value | double |
金額。 |
|
ギフト支援の条件状態
|
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 | array of GiftApi.PaymentRead |
贈与の支払。 |
|
リンクしている贈与
|
linked_gifts | array of string |
この贈与とリンクしている他の贈与の識別子。 |
|
追加した日付
|
date_added | date-time |
ギフトを作成した日。 |
|
変更日
|
date_modified | date-time |
ギフトを最後に変更した日。 |
GiftApi.GiftSplitRead
ギフトの分割
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
ギフト分割のシステム レコード ID。 |
|
値
|
amount.value | double |
金額。 |
|
異議申し立て ID
|
appeal_id | string |
贈与分割に関連付けられた異議申し立てのシステム レコード ID。 |
|
キャンペーン ID
|
campaign_id | string |
贈与分割に関連付けられたキャンペーンのシステム レコード ID。 |
|
資金 ID
|
fund_id | string |
贈与分割に関連付けられた資金のシステム レコード ID。 |
|
値
|
gift_aid_amount.value | double |
金額。 |
|
贈与補助の見込み評価の状態
|
gift_aid_qualification_status | string |
ギフト分割のギフト支援の条件状態。 有効な値は: Qualified、NotQualified、および NotQualified。 対象は英国のみです。 |
|
パッケージ ID
|
package_id | string |
贈与分割に関連付けられたパッケージのシステム レコード ID。 |
GiftApi.ReceiptRead
入荷
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
値
|
amount.value | double |
金額。 |
|
日付
|
date | date-time |
領収書の日付。 |
|
数値
|
number | integer |
領収書の番号。 |
|
状態
|
status | string |
領収書の状態。 有効な値: RECEIPTED、NEEDSRECEIPT、DONOTRECEIPT。 |
GiftApi.PaymentRead
支払い
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アカウント トークン
|
account_token | string |
外部の支払いプロバイダーからトークン化されたアカウント情報 (例: クレジット カード)。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。 |
|
BBPS 構成 ID
|
bbps_configuration_id | string |
BBPS 構成 ID。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。 |
|
BBPS トランザクション ID
|
bbps_transaction_id | string |
BBPS トランザクション ID。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。 |
|
日
|
check_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
check_date.m | integer |
あいまいな日付で表した月。 |
|
年
|
check_date.y | integer |
あいまいな日付で表した年。 |
|
小切手番号
|
check_number | string |
小切手番号。 "PersonalCheck" の支払方法にのみ適用されます。 |
|
チェックアウト トランザクション ID
|
checkout_transaction_id | string |
チェックアウト トランザクション ID。 "CreditCard" と "DirectDebit" の支払方法にのみ適用されます。 |
|
支払方法
|
payment_method | string |
支払方法。 有効な値を以下に示します。 |
|
参照
|
reference | string |
参照。 "その他" の支払方法にのみ適用されます。 |
|
日
|
reference_date.d | integer |
あいまいな日付で表した日。 |
|
月
|
reference_date.m | integer |
あいまいな日付で表した月。 |
|
年
|
reference_date.y | integer |
あいまいな日付で表した年。 |
GiftApi.SoftCreditRead
ソフト クレジット
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
ソフト クレジットのシステム レコード ID。 |
|
値
|
amount.value | double |
金額。 |
|
スタッフ ID
|
constituent_id | string |
ソフト クレジットに関連付けられたスタッフのシステム レコード ID。 |
|
ギフト ID
|
gift_id | string |
ソフト クレジットに関連付けられたギフトのシステム レコード ID。 |
GiftBatchApi.ApiCollectionOfGiftBatch
贈与バッチ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
カウント
|
count | integer |
応答が含む贈与バッチの合計数。 |
|
値
|
value | array of GiftBatchApi.GiftBatch |
応答が含む項目セット。 |
GiftBatchApi.CreatedBatch
作成した贈与バッチ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
batch_id | string |
新しく作成した贈与バッチのシステム レコード ID。 |
GiftBatchApi.GiftBatch
贈与バッチ オブジェクトを表します
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
バッチのシステム レコード ID。 |
|
説明
|
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
|
id | string |
新しく作成したメモの ID。 |
NXTDataIntegrationApi.CreatedGiftTribute
作成したギフト トリビュート
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成したギフト トリビュート の ID。 |
NXTDataIntegrationApi.CreatedTaxDeclaration
作成された税申告
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
新しく作成された税申告の ID。 |
NXTDataIntegrationApi.GiftIdMap
ギフト ID マップ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
system_record_id | integer |
ギフトのシステム レコード ID。 |
NXTDataIntegrationApi.GiftNote
メモ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ギフト ID
|
gift_id | integer |
メモに関連付けられたギフトのシステム レコード ID。 |
|
タイプ
|
type | string |
メモのタイプ。 |
|
日
|
date.d | integer |
あいまいな日付で表した日。 |
|
月
|
date.m | integer |
あいまいな日付で表した月。 |
|
年
|
date.y | integer |
あいまいな日付で表した年。 |
|
概要
|
summary | string |
ノートの概要。 |
|
メモ
|
text | string |
メモ テキスト。 |
|
作成者
|
author | string |
メモの作成者。 |
NXTDataIntegrationApi.GiftNoteCollection
ギフト メモ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of NXTDataIntegrationApi.GiftNote |
応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
NXTDataIntegrationApi.GiftTribute
ギフト トリビュート
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
ギフト トリビュートのシステム レコード ID。 |
|
ギフト ID
|
gift_id | integer |
ギフトのシステム レコード ID。 |
|
トリビュート ID
|
tribute_id | integer |
トリビュートのシステム レコード ID |
|
トリビュート タイプ
|
tribute_type | integer |
トリビュートのタイプ。 |
|
確認状態
|
acknowledge | string |
ギフト トリビュートの確認状態。 |
|
シーケンス
|
sequence | integer |
ギフト トリビュートのシーケンス。 |
NXTDataIntegrationApi.GiftTributeAcknowledgee
Raiser's Edge のギフト トリビュート アクノリッジのレコード。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
更新するギフト トリビュート アクノリッジのシステム レコード ID。 |
|
ギフト トリビュート ID
|
gift_tribute_id | integer |
ギフト トリビュートのシステム レコード ID。 |
|
自己確認?
|
self_acknowledge | boolean |
このアクノリッジは自己確認か? |
|
リレーションシップ ID
|
relationships_id | integer |
アクノリッジのリレーションシップのシステム レコード ID。 |
|
レター
|
letter | integer |
アクノリッジに送信されたレター。 |
|
レター日付
|
letter_date | date-time |
レターが送信された日付。 |
NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection
ギフト トリビュート アクノリッジ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of NXTDataIntegrationApi.GiftTributeAcknowledgee |
応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
NXTDataIntegrationApi.GiftTributeCollection
ギフト トリビュート
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of NXTDataIntegrationApi.GiftTribute |
応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |
NXTDataIntegrationApi.TaxDeclaration
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
declaration_id | integer | |
|
申告の開始
|
declaration_starts | date-time |
税申告を開始した日付。 |
|
申告の終了
|
declaration_ends | date-time |
税申告を終了した日付。 |
|
編成された申告
|
declaration_made | date-time |
税申告を行った日付。 |
|
インジケーター ID
|
declaration_indicator_id | integer |
申告のインジケーター ID。 |
|
インジケーター
|
declaration_indicator | string |
申告のインジケーター。 |
|
Source ID
|
declaration_source_id | integer |
申告のソース ID。 |
|
Source
|
declaration_source | string |
申告のソース。 |
|
送信された確認
|
confirmation_sent | date-time |
確認が送信された日付。 |
|
返された確認
|
confirmation_returned | date-time |
確認が返された日付。 |
|
税を支払う
|
constituent_pays_tax | string |
スタッフが税を支払うかどうかを示します。 |
|
状態 ID
|
tax_payer_status_id | integer |
納税者の状態 ID。 |
|
Status
|
tax_payer_status | string |
納税者の状態。 |
|
Comments
|
tax_notes | string |
税申告のコメント。 |
|
シークエンス
|
sequence | integer |
税申告に関連付けられた数列。 |
NXTDataIntegrationApi.TaxDeclarationCollection
税申告
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数
|
count | integer |
要求パラメーターを適用した後で、コレクションからの取得に使用できる項目数。 制限とオフセットのパラメーターは件数に影響しませんが、ページングに対応するために、値の結果セットが含む項目数に影響を与える場合があります。 |
|
値
|
value | array of NXTDataIntegrationApi.TaxDeclaration |
応答に含まれる項目セット。 これはコレクションが含む項目のサブセットである可能性があります。 |