Gift Entity Reference (Beta)

Updated: May 09, 2017

This topic describes the entity and type representations for common items that the Gift API uses. To learn about how to set up your developer account and work with the SKY API, see the Getting Started guide.

 

Gift

The gift entity has the following properties:

Property Type Description
id string The gift identifier.
date dateTime The gift date. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.
date_added dateTime The date when the gift was added. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.
date_modified dateTime The date when the gift was last modified. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.
amount currency The monetary amount of the gift.
type string The gift type. Available values are listed below.
constituent_id string The constituent identifier.
is_anonymous boolean Indicates whether the gift is anonymous.
gift_splits array of gift split The set of gift splits associated with the gift.
subtype string The subtype of the gift. Available values are the entries in the Gift Subtypes table.
lookup_id string The user-defined identifier for the gift.
soft_credits array of soft credit The set of soft credits associated with the gift.
fundraisers array of fundraiser The set of fundraisers who receive credit for the gift.
post_status string The general ledger post status of the gift. Available values are posted, notposted, and donotpost. When post_status is set to donotpost, then post_date should be null. When it is set to notposted, then post_date is editable. When it is set to posted, then post_date must be set and is no longer editable.
post_date dateTime The date that the gift was posted to general ledger. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.
gift_status string The status of the gift. Available values are active, held, terminated, completed, and cancelled.
gift_aid_amount currency The amount of tax reclaimed from Gift Aid for this gift. For UK only.
gift_aid_qualification_status string The Gift Aid qualification status of the gift. Available values are: qualified, notqualified, and partlyqualified. For UK only.
reference string Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.

 

Available values for the type of a gift:

Type Description
amendment An amendment.
donation A donation.
giftinkind A gift-in-kind.
generalledgerreversal A general ledger reversal.
matchinggiftpledge A matching gift pledge.
matchinggiftpayment A matching gift payment.
matchinggiftwriteoff A matching gift write-off.
plannedgift A planned gift.
pledge A pledge.
pledgepayment A pledge payment.
pledgewriteoff A pledge write-off.
recurringgift A recurring gift.
recurringgiftpayment A recurring gift payment.
stock A stock.
soldstock A sold stock.
other Another type of gift.

 

Gift attachment

The gift attachment entity has the following properties:

Property Type Description
id string The gift attachment identifier.
parent_id string The parent object's identifier.
tags array of string The tags associated with the attachment. Tags supplement the attachment’s name and description and identify it based on how an organization categorizes attachments. Available values are the entries in the Document Tags table.
name string The name of the attachment.
type string The attachment type. Available values are physical and link. Physical attachments are uploaded files such as images, PDFs, or Word documents that are saved locally or on the network. They are stored and managed in the system. Link attachments are links to files such as images, blog posts, or YouTube videos that are online or in a cloud storage account. They are stored and managed externally. At this time, only link attachments can be created through the API.
url string The URL for the attachment. The URL for a physical gift attachment contains a time-bound signature that limits access to 60 minutes.
content_type string The content type. Only applies to physical attachments.
file_name string The file name. Only applies to physical attachments.
file_size long The file size in bytes. Only applies to physical attachments.
thumbnail_url string The URL for a thumbnail. Only applies to physical attachments that are images. Contains a time-bound signature that limits access to 60 minutes.

 

Gift fundraiser

The gift fundraiser entity has the following properties:

Property Type Description
amount currency The amount credited to the fundraiser for the gift.
constituent_id string The constituent identifier.

 

Gift split

A gift split is the distribution of the total amount of a gift among multiple campaigns, funds, or appeals.

The gift split entity has the following properties:

Property Type Description
fund_id string The identifier of the fund associated with the gift split.
amount currency The amount of the gift split.
campaign_id string The identifier of the campaign associated with the gift split.
appeal_id string The identifier of the appeal associated with the gift split.

 

Soft credit

A soft credit is a way to share the credit for a gift with other individuals such as friends or spouses.

The soft credit entity has the following properties:

Property Type Description
amount currency The amount of the soft credit.
constituent_id string The constituent identifier.
id string The soft credit identifier.
gift_id string The gift identifier.