Blackbaud RENXT 禮品

Blackbaud Raiser 的 Edge NXT 是一款全面的基於雲的籌款和捐助者管理軟件解決方案，專為非營利組織和整個社會公益社區構建。使用「禮品」聯結器來管理禮品。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	Blackbaud 支持
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

連接器中繼資料
Publisher	布萊克博德公司
網站	https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
隱私策略	https://www.blackbaud.com/privacy-shield
類別	銷售和客戶關係管理;生產力

Raiser 的 Edge NXT 是一款全面的基於雲的籌款和捐助者管理軟件解決方案，專為非營利組織和整個社會公益社區構建。

該連接器建立在 Blackbaud 的 SKY API 之上，並提供操作來幫助管理 The Raiser's Edge NXT 中的禮物和相關實體，包括：

禮物和選民捐贈摘要
禮品批次
收益
致謝
不勝枚舉...

如需詳細資訊，請檢視文件。

先決條件

若要使用此連接器，您必須擁有 Blackbaud ID 帳戶，才能存取一或多個 Blackbaud 環境。

此外，您組織的管理員還必須在系統內執行管理員層級動作，才能讓此連接器存取您的 Blackbaud 環境。有關這些先決條件的詳細資訊，請參閱初始設定文件。

如何取得憑證？

您組織的管理員將向您發送組織的 Raiser's Edge NXT 環境的邀請，並在環境中配置您的用戶帳戶權限。使用此連接器不需要其他認證。

已知問題與限制

連接器將在您的使用者帳戶的內容中運作，因此將受限於您在環境中的使用者權限。

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

出售股票禮品	更新要出售的庫存禮物。
列出成分稅申報	列出選民的禮品援助稅務申報表（僅適用於英國版本）。
列出承諾分期付款	列出承諾的分期付款。
列出禮品批次	列出禮品批次。
列出禮品自訂欄位	列出禮物的自訂欄位。
列出禮物	傳回禮物清單。
列出禮物筆記	列出禮物的備註。
列出禮物致敬	列出禮物致敬的致謝。
列出禮物貢品	列出禮物的貢品。
列出禮物附件	列出禮物的附件。
列出質押付款	列出質押的付款。
創建禮物致敬	創建新的禮物貢品。
將禮物添加到批次	將禮品新增至指定的禮品批次。
建立成分稅申報表	為選民建立新的禮品援助稅務聲明。
建立承諾	建立新的承諾。
建立禮品批次	建立新的禮品批次。
建立禮品自訂欄位	建立新的禮物自訂欄位。
建立禮物便條	建立新的禮品便條。
建立禮物附件	建立新的禮物附件。
建立質押付款	建立新的質押付款。
更新成分稅申報表	更新成分稅申報表。
更新禮品收據詳情	更新禮物的收據詳細資料。
更新禮品附註	更新禮品便條。
更新禮物確認詳情	更新禮物的通知詳細資料。
更新禮物自訂欄位	更新禮物自訂欄位。
更新禮物致敬	更新了禮物致敬。
更新禮物致敬確認	更新禮物致敬致謝。
更新禮物附件	更新禮物附件。
獲得成分股最新禮物	傳回選民的最新禮物。
獲得禮物	傳回有關禮物的資訊。
獲得選民最偉大的禮物	為選民返回最大的禮物。
獲得選民第一份禮物	為選民退回第一份禮物。
獲得選民終身捐贈	傳回選件的存留期給出摘要。
製作庫存禮物	建立新的庫存禮物。
製作禮物	創造一份新禮物。
透過查詢 ID 取得禮物	從指定的查閱 ID 傳回禮物的系統記錄 ID。

出售股票禮品

作業識別碼：: SellStockGift

更新要出售的庫存禮物。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	string	要出售的股票禮物的系統記錄 ID。
發售日期	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	每售出單位的中位數價格。

列出成分稅申報

作業識別碼：: ListConstituentTaxDeclarations

列出選民的禮品援助稅務申報表（僅適用於英國版本）。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	integer	成分的系統記錄 ID。
限制	limit		integer	代表要傳回的記錄數目。預設值為 500。沒有最大值。
Offset	offset		integer	代表要略過的記錄數。用於分頁。

傳回

稅務申報

身體: NXTDataIntegrationApi.TaxDeclarationCollection

列出承諾分期付款

作業識別碼：: ListPledgeInstallments

列出承諾的分期付款。

參數

名稱	機碼	必要	類型	Description
質押 ID	gift_id	True	string	質押的系統記錄 ID。

傳回

分期付款

身體: Gift2Api.PledgeInstallmentCollection

列出禮品批次

作業識別碼：: ListGiftBatches

列出禮品批次。

參數

名稱	機碼	類型	Description
批號	batch_number	string	代表符合指定數字之結果的篩選器。
批准？	approved	boolean	代表禮品批次狀態的篩選器。
有例外嗎？	has_exceptions	boolean	代表禮品批次是否包含例外狀況的篩選器。
限制	limit	integer	代表要傳回的記錄數目。預設值為 500。最大值為 5000。
Offset	offset	integer	代表要略過的記錄數。用於分頁。
搜尋文字	search_text	string	代表批次描述或批次編號欄位中包含的文字篩選器。
由...創建	created_by	string	代表指定使用者所建立的禮品批次的篩選器。

傳回

禮品批次

身體: GiftBatchApi.ApiCollectionOfGiftBatch

列出禮品自訂欄位

作業識別碼：: ListGiftCustomFields

列出禮物的自訂欄位。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	string	禮品的系統記錄 ID。

傳回

自訂欄位

身體: GiftApi.ApiCollectionOfGiftCustomFieldRead

列出禮物

作業識別碼：: ListGifts

傳回禮物清單。

參數

名稱	機碼	類型	Description
清單	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 的禮物。
基金編號	fund_id	string	代表以逗號分隔的基金系統記錄 ID 清單，以篩選結果。例如，「506,918」只會傳回基金 506 或基金 918 的禮物。
申訴 ID	appeal_id	string	代表以逗號分隔的申訴系統記錄 ID 清單，以篩選結果。例如，「506,918」只會退回對 506 提出申訴或向 918 提出申訴的禮物。
限制	limit	integer	代表要傳回的記錄數目。預設值為 500。最大值為 5000。
Offset	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字段，則這會在next_link URL中新增sort_token參數，以確保禮品的排序穩定。
添加日期或之後	date_added	date-time	篩選結果為在指定日期或之後建立的禮物（例如：「2020-09-18T04：13：56Z」）。
修改日期或之後	last_modified	date-time	將結果篩選為在指定日期或之後修改的禮物（例如：「2020-09-18T04：13：56Z」）。

傳回

禮物

身體: GiftApi.ApiCollectionOfGiftRead

列出禮物筆記

作業識別碼：: ListGiftNotes

列出禮物的備註。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	integer	禮品的系統記錄 ID。
限制	limit		integer	代表要傳回的記錄數目。
Offset	offset		integer	代表要略過的記錄數。用於分頁。

傳回

禮品筆記

身體: NXTDataIntegrationApi.GiftNoteCollection

列出禮物致敬

作業識別碼：: ListGiftTributeAcknowledgees

列出禮物致敬的致謝。

參數

名稱	機碼	必要	類型	Description
禮品致敬 ID	gift_tribute_id	True	integer	禮品貢品的系統記錄 ID。

傳回

禮物致敬

身體: NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

列出禮物貢品

作業識別碼：: ListGiftTributes

列出禮物的貢品。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	integer	禮品的系統記錄 ID。

傳回

禮品致敬

身體: NXTDataIntegrationApi.GiftTributeCollection

列出禮物附件

作業識別碼：: ListGiftAttachments

列出禮物的附件。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	string	禮品的系統記錄 ID。

傳回

Attachments

身體: GiftApi.ApiCollectionOfGiftAttachmentRead

列出質押付款

作業識別碼：: ListPledgePayments

列出質押的付款。

參數

名稱	機碼	必要	類型	Description
質押 ID	gift_id	True	string	質押的系統記錄 ID。

傳回

付款

身體: Gift2Api.PledgePaymentCollection

創建禮物致敬

作業識別碼：: CreateGiftTribute

創建新的禮物貢品。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	integer	與禮品貢品相關聯之禮品的系統記錄 ID。
致敬 ID	tribute_id	True	integer	與禮品貢品相關聯的貢品的系統記錄 ID。

傳回

創建禮物致敬

身體: NXTDataIntegrationApi.CreatedGiftTribute

將禮物添加到批次

作業識別碼：: AddGiftToBatch

將禮品新增至指定的禮品批次。

參數

名稱	機碼	必要	類型	Description
Batch	batch_id	True	string	將添加禮物的批次。
選區 ID	constituent_id	True	string	與禮品相關聯之成分的系統記錄 ID。
總數	value	True	double	禮物的金額。
Date	date	True	date	贈送日期（例如：「2020-09-18」）。
類型	type	True	string	禮物類型。
行銷活動ID	campaign_id		string	與禮品分割相關聯之行銷活動的系統記錄 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	reference		string	付款編號（僅適用於付款方式為「其他」的情況）。
天	d		integer	模糊約會中的一天。
個月	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

建立成分稅申報表

作業識別碼：: CreateTaxDeclaration

為選民建立新的禮品援助稅務聲明。

參數

名稱	機碼	必要	類型	Description
選區 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」）。
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	納稅人身份。
評論	tax_notes		string	稅務申報的註解。
Sequence	sequence		integer	與稅務申報相關聯的數值序列。

傳回

已建立的稅務申報

身體: NXTDataIntegrationApi.CreatedTaxDeclaration

建立承諾

作業識別碼：: CreatePledge

建立新的承諾。

參數

名稱	機碼	必要	類型	Description
選區 ID	id	True	string	成分的系統記錄 ID。
總數	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	與贈與分割相關聯之基金的系統記錄 ID。
行銷活動ID	campaign_id		string	與禮品分割相關聯之行銷活動的系統記錄 ID。
申訴 ID	appeal_id		string	與禮物分割相關聯的上訴的系統記錄 ID。
套件 ID	package_id		string	與禮品分割相關聯之封裝的系統記錄 ID。
付款方式	method	True	string	付款方式。
檢查號碼	check_number		string	支票號碼。
Reference	reference_number		string	付款編號（僅適用於付款方式為「其他」的情況）。
發送提醒？	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	承諾的狀態。
天	d		integer	模糊約會中的一天。
個月	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	與確認相關的信件。
型別	credit_type	True	string	辨識點數的類型。
收件者 ID	constituent_id	True	string	辨識點數收件者的系統記錄識別碼。
金額	value	True	double	貸記給收件者的金額。
date	date		date	分期付款日期（例如：「2020-09-18」）。
金額	amount		double	分期付款的金額。

傳回

創建的禮物

身體: GiftApi.CreatedGift

建立禮品批次

作業識別碼：: CreateGiftBatch

建立新的禮品批次。

參數

名稱	機碼	類型	Description
Description	batch_description	string	批次的描述。
預期數量	expected_number	integer	批次中預期的禮物數量。
預期總計	expected_batch_total	double	批次中禮物的總價值。
批號	batch_number	string	批次特有的唯一識別碼。

傳回

已建立禮品批次

身體: GiftBatchApi.CreatedBatch

建立禮品自訂欄位

作業識別碼：: CreateGiftCustomField

建立新的禮物自訂欄位。

參數

名稱	機碼	必要	類型	Description
body	body	True	dynamic	代表要建立的自訂欄位的物件。

傳回

已建立禮品自訂欄位

身體: GiftApi.CreatedGiftCustomField

建立禮物便條

作業識別碼：: CreateGiftNote

建立新的禮品便條。

參數

名稱	機碼	必要	類型	Description
禮品 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。

傳回

已建立附註

身體: NXTDataIntegrationApi.CreatedGiftNote

建立禮物附件

作業識別碼：: CreateGiftAttachment

建立新的禮物附件。

參數

名稱	機碼	必要	類型	Description
禮品 ID	parent_id	True	string	與附件相關聯之禮品的系統記錄 ID。
類型	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 個。僅適用於實體附件。
檔案 ID	file_id		string	檔案的識別碼。字元限制：36 個。僅適用於實體附件。
縮圖 ID	thumbnail_id		string	縮圖的識別碼。字元限制：36 個。僅適用於實體附件。
Tags	tags		array of string	與附件相關聯的標籤。

傳回

創建禮物附件

身體: GiftApi.CreatedGiftAttachment

建立質押付款

作業識別碼：: CreatePledgePayment

建立新的質押付款。

參數

名稱	機碼	必要	類型	Description
選區 ID	id	True	string	成分的系統記錄 ID。
總數	value	True	double	質押支付的金額。
Date	gift_date	True	date	質押付款日期（例如：「2020-09-18」）。
金額	value	True	double	禮物分割的金額。
基金編號	fund_id	True	string	與贈與分割相關聯之基金的系統記錄 ID。
行銷活動ID	campaign_id		string	與禮品分割相關聯之行銷活動的系統記錄 ID。
申訴 ID	appeal_id		string	與禮物分割相關聯的上訴的系統記錄 ID。
套件 ID	package_id		string	與禮品分割相關聯之封裝的系統記錄 ID。
付款方式	method	True	string	付款方式。
檢查號碼	check_number		string	支票號碼。
Reference	reference_number		string	付款編號（僅適用於付款方式為「其他」的情況）。
是匿名的嗎？	anonymous		boolean	禮物是匿名的嗎？如果未提供任何值，則會使用捐贈者的預設匿名性。
誓	pledge_id		string	正在支付的質押的系統記錄 ID。
分期付款	installment_id		string	正在支付的分期付款的系統記錄 ID。
金額	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	與確認相關的信件。
型別	credit_type	True	string	辨識點數的類型。
收件者 ID	constituent_id	True	string	辨識點數收件者的系統記錄識別碼。
金額	value	True	double	貸記給收件者的金額。

傳回

創建的禮物

身體: GiftApi.CreatedGift

更新成分稅申報表

作業識別碼：: EditTaxDeclaration

更新成分稅申報表。

參數

名稱	機碼	必要	類型	Description
稅務申報編號	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	納稅人身份。
評論	tax_notes		string	稅務申報的註解。
Sequence	sequence		integer	與稅務申報相關聯的數值序列。

更新禮品收據詳情

作業識別碼：: EditGiftReceipt

更新禮物的收據詳細資料。

參數

名稱	機碼	必要	類型	Description
收據 ID	receipt_id	True	string	要更新的禮品收據的系統記錄 ID。它使用父禮物的 ID 作為其值。
地位	status		string	禮物的接收狀態。當狀態設定為 NeedsReceipt 或 DoNotReceipt 時，收據日期應該為 Null。
總數	value		double	收據金額。
Date	date		date-time	收據上的日期（例如：「2020-09-18T04：13：56Z」）。
Number	number		integer	收據的編號。

更新禮品附註

作業識別碼：: EditGiftNote

更新禮品便條。

參數

名稱	機碼	必要	類型	Description
附註 ID	id	True	integer	要更新之附註的系統記錄 ID。
類型	note_type_id		integer	註記類型。
天	d		integer	模糊約會中的一天。
個月	m		integer	模糊日期中的月份。
年	y		integer	模糊日期中的年份。
總結	summary		string	註釋摘要。字元限制：255。
備註	text		string	註釋文字。
作者	author		string	筆記作者。字元限制：50。

更新禮物確認詳情

作業識別碼：: EditGiftAcknowledgement

更新禮物的通知詳細資料。

參數

名稱	機碼	必要	類型	Description
通知標識碼	acknowledgement_id	True	string	要更新的禮品確認的系統記錄 ID。它使用父禮物的 ID 作為其值。
地位	status		string	通知的狀態。當狀態設定為 DoNotRecognize 時，字母和日期應該為 Null。當狀態設定為 NeedsAcknowledgement 時，日期應該為 Null。
Date	date		date-time	與通知相關聯的日期（例如：「2020-09-18T04：13：56Z」）。
信	letter		string	與確認相關的信件。

更新禮物自訂欄位

作業識別碼：: EditGiftCustomField

更新禮物自訂欄位。

參數

名稱	機碼	必要	類型	Description
自訂欄位ID	custom_field_id	True	string	要更新之自訂欄位的系統記錄 ID。
body	body	True	dynamic	代表要更新之自訂欄位屬性的物件。

更新禮物致敬

作業識別碼：: EditGiftTribute

更新了禮物致敬。

參數

名稱	機碼	必要	類型	Description
禮品致敬 ID	gift_tribute_id	True	integer	要更新的禮物貢品的系統記錄ID。
貢品類型	tribute_type		integer	貢品類型。
確認狀態	acknowledge		string	禮物致敬確認狀態。

更新禮物致敬確認

作業識別碼：: EditGiftTributeAcknowledgee

更新禮物致敬致謝。

參數

名稱	機碼	必要	類型	Description
禮物致敬確認 ID	gift_tribute_acknowledgee_id	True	integer	禮品貢品的系統記錄 ID 確認更新。
信	letter		integer	寄給確認的信。
信件日期	letter_date		date-time	這封信的寄出日期。

更新禮物附件

作業識別碼：: EditGiftAttachment

更新禮物附件。

參數

名稱	機碼	必要	類型	Description
附件 ID	attachment_id	True	string	要更新之附件的系統記錄 ID。
名稱	name		string	附件的名稱。字元限制：150。
Date	date		date-time	附件的日期（例如：「2020-09-18T04：13：56Z」）。
URL	url		string	附件的 URL。這是連結附件所必需的，不適用於實體附件。
Tags	tags		array of string	與附件相關聯的標籤。

獲得成分股最新禮物

作業識別碼：: GetConstituentLatestGift

傳回選民的最新禮物。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	成分的系統記錄 ID。

傳回

給予總結

身體: ConstituentApi.GivingSummaryRead

獲得禮物

作業識別碼：: GetGift

傳回有關禮物的資訊。

參數

名稱	機碼	必要	類型	Description
禮品 ID	gift_id	True	string	要取得的禮物的系統記錄ID。

傳回

禮物

身體: GiftApi.GiftRead

獲得選民最偉大的禮物

作業識別碼：: GetConstituentGreatestGift

為選民返回最大的禮物。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	成分的系統記錄 ID。

傳回

給予總結

身體: ConstituentApi.GivingSummaryRead

獲得選民第一份禮物

作業識別碼：: GetConstituentFirstGift

為選民退回第一份禮物。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	成分的系統記錄 ID。

傳回

給予總結

身體: ConstituentApi.GivingSummaryRead

獲得選民終身捐贈

作業識別碼：: GetConstituentLifetimeGiving

傳回選件的存留期給出摘要。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	成分的系統記錄 ID。

傳回

終身捐贈

身體: ConstituentApi.LifetimeGivingRead

製作庫存禮物

作業識別碼：: CreateStock

建立新的庫存禮物。

參數

名稱	機碼	必要	類型	Description
選區 ID	id	True	string	成分的系統記錄 ID。
總數	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	與贈與分割相關聯之基金的系統記錄 ID。
行銷活動ID	campaign_id		string	與禮品分割相關聯之行銷活動的系統記錄 ID。
申訴 ID	appeal_id		string	與禮物分割相關聯的上訴的系統記錄 ID。
套件 ID	package_id		string	與禮品分割相關聯之封裝的系統記錄 ID。
付款方式	method	True	string	付款方式。
檢查號碼	check_number		string	支票號碼。
Reference	reference_number		string	付款編號（僅適用於付款方式為「其他」的情況）。
是匿名的嗎？	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	與確認相關的信件。
型別	credit_type	True	string	辨識點數的類型。
收件者 ID	constituent_id	True	string	辨識點數收件者的系統記錄識別碼。
金額	value	True	double	貸記給收件者的金額。

傳回

創建的禮物

身體: GiftApi.CreatedGift

製作禮物

作業識別碼：: CreateGift

創造一份新禮物。

參數

名稱	機碼	必要	類型	Description
選區 ID	constituent_id	True	string	與禮品相關聯之成分的系統記錄 ID。
總數	value	True	double	禮物的金額。
Date	date	True	date	贈送日期（例如：「2020-09-18」）。
類型	type	True	string	禮物類型。
行銷活動ID	campaign_id		string	與禮品分割相關聯之行銷活動的系統記錄 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	reference		string	付款編號（僅適用於付款方式為「其他」的情況）。
天	d		integer	模糊約會中的一天。
個月	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

透過查詢 ID 取得禮物

作業識別碼：: GetGiftIdFromLookupId

從指定的查閱 ID 傳回禮物的系統記錄 ID。

參數

名稱	機碼	必要	類型	Description
查詢標識碼	giftlookupid	True	string	禮物查詢 ID。

傳回

禮品 ID 地圖

身體: NXTDataIntegrationApi.GiftIdMap

定義

ConstituentApi.Appeal閱讀

名稱	路徑	類型	Description
ID	id	string	申訴的系統記錄 ID。
描述	description	string	上訴描述。

ConstituentApi.Campaign閱讀

名稱	路徑	類型	Description
ID	id	string	行銷活動的系統記錄ID。
描述	description	string	行銷活動說明。

ConstituentApi.Fund閱讀

名稱	路徑	類型	Description
ID	id	string	基金的系統記錄 ID。
描述	description	string	基金說明。

ConstituentApi.Giving摘要閱讀

給予總結

名稱	路徑	類型	Description
ID	id	string	禮品的系統記錄 ID。
類型	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

終身捐贈

名稱	路徑	類型	Description
連續年給出	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.鳴謝閱讀

鳴謝

名稱	路徑	類型	Description
date	date	date-time	與通知相關聯的日期。
字母	letter	string	與確認相關的信件。
狀態	status	string	通知的狀態。可用的值為：ACKNOWLEDGED、NEEDSACKNOWLEDGEMENT和DONOTACKNOWLEDGE。

GiftApi.ApiCollectionOfGiftAttachmentRead

Attachments

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of GiftApi.GiftAttachmentRead	回應中包含的專案集。這可能是集合中項目的子集。

GiftApi.ApiCollectionOfGiftCustomField閱讀

自訂欄位

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of GiftApi.GiftCustomFieldRead	回應中包含的專案集。這可能是集合中項目的子集。

GiftApi.ApiCollectionOfGiftRead

禮物

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of GiftApi.GiftRead	回應中包含的專案集。這可能是集合中項目的子集。

GiftApi.BatchGiftAdd結果

包含批次禮品錯誤記錄的集合，以及作業新增的批次禮品

名稱	路徑	類型	Description
錯誤	errors	array of GiftApi.GiftBatchGiftError	與批次禮品新增作業相關聯的批次禮品錯誤
禮物	gifts	array of GiftApi.BatchGiftRead	批次禮品新增作業所新增的批次禮品的集合

GiftApi.GiftBatchGift錯誤

代表防止項目新增至批次的例外狀況。

名稱	路徑	類型	Description
受影響的欄位	affected_field	string	受錯誤影響的欄位
批次識別碼	batch_id	string	批次的系統記錄識別碼
異常錯誤碼	exception_error_code	integer	例外狀況錯誤碼
異常錯誤訊息	exception_error_message	string	例外狀況錯誤訊息
異常狀況錯誤名稱	exception_error_name	string	例外狀況錯誤名稱
禮品編號	gift_id	string	禮品的系統記錄 ID
查閱標識碼	lookup_id	string	禮物的使用者定義識別碼。

GiftApi.BatchGiftRead

批量贈送

名稱	路徑	類型	Description
批次識別碼	batch_id	string	新增禮物的批次識別碼。
錯誤	errors	array of GiftApi.GiftBatchGiftError	與批次禮品相關聯的錯誤。
ID	id	string	批次贈品的系統記錄 ID。
組成 ID	constituent_id	string	與禮品相關聯之成分的系統記錄 ID。
型別	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是必需的，但仍可編輯。當它設定為已張貼時，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。
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	array of GiftApi.PaymentRead	禮物上的付款。
連結禮物	linked_gifts	array of string	與此禮物連結的其他禮物的識別碼。
新增日期	date_added	date-time	建立禮物的日期。
修改日期	date_modified	date-time	上次修改禮物的日期。

GiftApi.創建禮物

創建的禮物

名稱	路徑	類型	Description
ID	id	string	新建立的禮物的ID。

GiftApi.CreatedGiftAttachment

創建禮物附件

名稱	路徑	類型	Description
ID	id	string	新建立的禮品附件的 ID。

GiftApi.CreatedGiftCustomField

已建立禮品自訂欄位

名稱	路徑	類型	Description
ID	id	string	新建立的禮品自訂欄位的ID。

GiftApi.GiftAttachment閱讀

Attachment

名稱	路徑	類型	Description
ID	id	string	附件的系統記錄 ID。
禮品 ID	parent_id	string	與附件相關聯之禮品的系統記錄 ID。
類型	type	string	附件類型。實體附件是儲存在本機或網路上的上傳檔案，例如影像、PDF 或 Word 文件。它們在系統中儲存和管理。連結附件是指向線上或雲端儲存帳戶中的檔案（例如圖像、部落格文章或 YouTube 影片）的連結。它們在外部儲存和管理。
名稱	name	string	附件的名稱。字元限制：150。
Date	date	date-time	附件的日期。
URL	url	string	附件的 URL。這是連結附件所必需的，不適用於實體附件。
檔案名稱	file_name	string	檔案的檔名。字元限制：36 個。僅適用於實體附件。
檔案 ID	file_id	string	檔案的識別碼。字元限制：36 個。僅適用於實體附件。
縮圖 ID	thumbnail_id	string	縮圖的識別碼。字元限制：36 個。僅適用於實體附件。
縮圖網址	thumbnail_url	string	縮圖的 URL。適用於僅影像的實體附件。包含限制存取時間限制為 60 分鐘的限時簽名。
內容類型	content_type	string	內容類型。僅適用於實體附件。
檔案大小	file_size	integer	檔案大小（以位元組為單位）。僅適用於實體附件。
Tags	tags	array of string	與附件相關聯的標籤。

GiftApi.GiftCustomField閱讀

自訂欄位

名稱	路徑	類型	Description
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	date	自訂欄位上的日期。
評論	comment	string	自訂欄位上的註解。字元限制：50。
新增日期	date_added	date-time	建立自訂欄位的日期。
修改日期	date_modified	date-time	上次修改自訂欄位的日期。

GiftApi.Gift籌款活動閱讀

禮物籌款活動

名稱	路徑	類型	Description
value	amount.value	double	記入籌款活動的禮物金額。
籌款活動 ID	constituent_id	string	與禮物相關聯之籌款活動的組成系統記錄 ID。

GiftApi.GiftRead

禮物

名稱	路徑	類型	Description
ID	id	string	禮品的系統記錄 ID。
選區 ID	constituent_id	string	與禮品相關聯之成分的系統記錄 ID。
類型	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是必需的，但仍可編輯。當它設定為已張貼時，post_date是必填的，且無法再編輯。
發佈日期	post_date	date-time	禮物過帳到總帳的日期。
Reference	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。
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	array of GiftApi.PaymentRead	禮物上的付款。
連結禮物	linked_gifts	array of string	與此禮物連結的其他禮物的識別碼。
新增日期	date_added	date-time	建立禮物的日期。
修改日期	date_modified	date-time	上次修改禮物的日期。

GiftApi.GiftSplit閱讀

禮物分割

名稱	路徑	類型	Description
ID	id	string	禮品分割的系統記錄識別碼。
value	amount.value	double	禮物分割的金額。
申訴 ID	appeal_id	string	與禮物分割相關聯的上訴的系統記錄 ID。
行銷活動ID	campaign_id	string	與禮品分割相關聯之行銷活動的系統記錄 ID。
基金編號	fund_id	string	與贈與分割相關聯之基金的系統記錄 ID。
value	gift_aid_amount.value	double	從贈與援助中退回的稅額。僅適用於英國。
禮品援助資格狀態	gift_aid_qualification_status	string	禮品分割的禮品援助資格狀態。可用的值為：Qualified 和 NotQualified。僅適用於英國。
套件 ID	package_id	string	與禮品分割相關聯之封裝的系統記錄 ID。

GiftApi.收據讀取

收據

名稱	路徑	類型	Description
value	amount.value	double	收據的金額。
date	date	date-time	收據上的日期。
數字	number	integer	收據的編號。
狀態	status	string	收據的狀態。可用的值為：RECEIPTED、NEEDSRECEIPT 和 DONOTRECEIPT。

GiftApi.付款閱讀

付款

名稱	路徑	類型	Description
帳戶權杖	account_token	string	來自外部付款提供者的權杖化帳戶資訊（例如：信用卡）。只適用於「信用卡」及「直接扣賬」的付款方式。
BBPS 組態 ID	bbps_configuration_id	string	BBPS 組態 ID。只適用於「信用卡」及「直接扣賬」的付款方式。
BBPS 交易 ID	bbps_transaction_id	string	BBPS 交易 ID。只適用於「信用卡」及「直接扣賬」的付款方式。
天	check_date.d	integer	模糊約會中的一天。
個月	check_date.m	integer	模糊日期中的月份。
年	check_date.y	integer	模糊日期中的年份。
支票號碼	check_number	string	支票號碼。只適用於「個人支票」的付款方式。
結帳交易 ID	checkout_transaction_id	string	結帳交易ID。只適用於「信用卡」及「直接扣賬」的付款方式。
付款方式	payment_method	string	付款方式。下面列出了可用的值。
參考	reference	string	參考。只適用於「其他」之付款方式。
天	reference_date.d	integer	模糊約會中的一天。
個月	reference_date.m	integer	模糊日期中的月份。
年	reference_date.y	integer	模糊日期中的年份。

GiftApi.SoftCredit閱讀

軟信用

名稱	路徑	類型	Description
ID	id	string	軟性信用的系統記錄 ID。
value	amount.value	double	軟性信用額度的金額。
組成 ID	constituent_id	string	與軟性信用相關聯之成分的系統記錄 ID。
禮品編號	gift_id	string	與軟性信用相關聯之禮品的系統記錄 ID。

Gift2Api.PledgeInstallment

代表分期付款物件。

名稱	路徑	類型	Description
ID	id	string	分期付款的系統記錄 ID。
date	date	date-time	分期付款的日期。
年	year	integer	分期付款日期的年份。
value	amount.value	double	分期付款的金額。
餘額	balance	double	分期付款的餘額。
剩餘質押餘額	remaining_pledge_balance	double	質押的餘額。
序列	sequence	integer	分期付款顯示順序順序。

Gift2Api.PledgeInstallmentCollection

分期付款

名稱	路徑	類型	Description
開始日期	start_date	date-time	禮物排程開始的日期。
頻率	frequency	string	禮物時間表的頻率。
並行權杖	concurrency_token	string	並行權杖。
分期付款	installments	array of Gift2Api.PledgeInstallment	回應中包含的專案集。這可能是集合中項目的子集。

Gift2Api.Pledge付款

表示質押支付對象。

名稱	路徑	類型	Description
分期付款 ID	installment_id	string	正在支付的分期付款的系統記錄 ID。
禮品編號	payment_gift_id	string	付款禮品的系統記錄 ID。
value	amount_applied.value	double	適用於分期付款的金額。

Gift2Api.PledgePaymentCollection

付款

名稱	路徑	類型	Description
pledge_payments	pledge_payments	array of Gift2Api.PledgePayment	回應中包含的專案集。這可能是集合中項目的子集。

GiftBatchApi.ApiCollectionOfGiftBatch

禮品批次

名稱	路徑	類型	Description
Count	count	integer	回應中的禮品批次總數。
value	value	array of GiftBatchApi.GiftBatch	回應中包含的專案集。

GiftBatchApi.CreatedBatch

已建立禮品批次

名稱	路徑	類型	Description
ID	batch_id	string	新建立的禮品批次的系統記錄識別碼。

GiftBatchApi.GiftBatch

代表禮品批次物件

名稱	路徑	類型	Description
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

已建立附註

名稱	路徑	類型	Description
ID	id	string	新建立附註的 ID。

NXTDataIntegrationApi.CreatedGiftTribute

創建禮物致敬

名稱	路徑	類型	Description
ID	id	string	新建立的禮物貢品的 ID。

NXTDataIntegrationApi.CreatedTaxDeclaration

已建立的稅務申報

名稱	路徑	類型	Description
ID	id	string	新建立的稅務申報表的識別碼。

NXTDataIntegrationApi.GiftIdMap

禮品 ID 地圖

名稱	路徑	類型	Description
ID	system_record_id	integer	禮品系統記錄 ID。

NXTDataIntegrationApi.GiftNote

備註

名稱	路徑	類型	Description
禮品 ID	gift_id	integer	與附註相關聯之禮品的系統記錄 ID。
類型	type	string	註記類型。
天	date.d	integer	模糊約會中的一天。
個月	date.m	integer	模糊日期中的月份。
年	date.y	integer	模糊日期中的年份。
總結	summary	string	註釋摘要。
備註	text	string	註釋文字。
作者	author	string	該註釋的作者。

NXTDataIntegrationApi.GiftNoteCollection

禮品筆記

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of NXTDataIntegrationApi.GiftNote	回應中包含的專案集。這可能是集合中項目的子集。

NXTDataIntegrationApi.GiftTribute

禮品致敬

名稱	路徑	類型	Description
ID	id	integer	禮品貢品的系統記錄 ID。
禮品 ID	gift_id	integer	禮品的系統記錄 ID。
致敬 ID	tribute_id	integer	貢品的系統記錄 ID。
貢品類型	tribute_type	integer	貢品類型。
確認狀態	acknowledge	string	禮物致敬確認狀態。
Sequence	sequence	integer	禮物致敬序列。

NXTDataIntegrationApi.GiftTribute確認

禮物致敬，承認 Raiser's Edge 的記錄。

名稱	路徑	類型	Description
ID	id	integer	禮品貢品的系統記錄 ID 確認。
禮品致敬 ID	gift_tribute_id	integer	禮品貢品的系統記錄 ID。
是自我承認嗎？	self_acknowledge	boolean	這是承認的自我承認嗎？
關聯性識別碼	relationships_id	integer	確認關係的系統記錄 ID。
信	letter	integer	寄給確認的信。
信件日期	letter_date	date-time	這封信的寄出日期。

NXTDataIntegrationApi.GiftTributeAcknowledgeeCollection

禮物致敬

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of NXTDataIntegrationApi.GiftTributeAcknowledgee	回應中包含的專案集。這可能是集合中項目的子集。

NXTDataIntegrationApi.GiftTributeCollection

禮品致敬

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of NXTDataIntegrationApi.GiftTribute	回應中包含的專案集。這可能是集合中項目的子集。

NXTDataIntegrationApi.TaxDeclaration

名稱	路徑	類型	Description
ID	declaration_id	integer
宣告開始	declaration_starts	date-time	報稅開始日期。
申報結束	declaration_ends	date-time	納稅申報結束日期。
作出的聲明	declaration_made	date-time	報稅日期。
指標 ID	declaration_indicator_id	integer	宣告指標 ID。
Indicator	declaration_indicator	string	申報指標。
來源 ID	declaration_source_id	integer	宣告來源識別碼。
來源	declaration_source	string	宣告來源。
確認函已發送	confirmation_sent	date-time	確認傳送日期。
確認函傳回	confirmation_returned	date-time	傳回確認的日期。
繳稅	constituent_pays_tax	string	指出成分股是否納稅。
狀態標識碼	tax_payer_status_id	integer	納稅人狀態 ID。
地位	tax_payer_status	string	納稅人身份。
評論	tax_notes	string	稅務申報的註解。
Sequence	sequence	integer	與稅務申報相關聯的數值序列。

NXTDataIntegrationApi.TaxDeclarationCollection

稅務申報

名稱	路徑	類型	Description
Count	count	integer	套用任何要求參數之後，可擷取到集合中的項目數目。 limit和offset參數不會影響計數，但為了方便分頁，它們可能會影響值結果集中的項目數。
value	value	array of NXTDataIntegrationApi.TaxDeclaration	回應中包含的專案集。這可能是集合中項目的子集。

共用方式為

Blackbaud RENXT 禮品

先決條件

如何取得憑證？

已知問題與限制

節流限制

動作

出售股票禮品

參數

列出成分稅申報

參數

傳回

列出承諾分期付款

參數

傳回

列出禮品批次

參數

傳回

列出禮品自訂欄位

參數

傳回

列出禮物

參數

傳回

列出禮物筆記

參數

傳回

列出禮物致敬

參數

傳回

列出禮物貢品

參數

傳回

列出禮物附件

參數

傳回

列出質押付款

參數

傳回

創建禮物致敬

參數

傳回

將禮物添加到批次

參數

傳回

建立成分稅申報表

參數

傳回

建立承諾

參數

傳回

建立禮品批次

參數

傳回

建立禮品自訂欄位

參數

傳回

建立禮物便條

參數

傳回

建立禮物附件

參數

傳回

建立質押付款

參數

傳回

更新成分稅申報表

參數

更新禮品收據詳情

參數

更新禮品附註

參數

更新禮物確認詳情

參數

更新禮物自訂欄位

參數

更新禮物致敬

參數

更新禮物致敬 確認

參數

更新禮物致敬確認