Gift

{
  "description": "Gifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The immutable system record ID of the gift.",
      "type": "string"
    },
    "acknowledgements": {
      "description": "The set of acknowledgements associated with the gift.",
      "type": "array",
      "items": {
        "description": "Acknowledgement letters foster relationships with donors and show appreciation for their contributions. It is important to keep track of the acknowledgement status of gifts to ensure that each one gets a well-deserved thank you.",
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "description": "The date associated with the acknowledgement. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "letter": {
            "description": "The letter associated with the acknowledgement.",
            "type": "string"
          },
          "status": {
            "description": "The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE. When using the GET Gift List endpoint, the type string for NEEDSACKNOWLEDGEMENT returns as NotAcknowledged.",
            "type": "string"
          }
        },
        "x-display-name": "Acknowledgement",
        "x-display-id": "Acknowledgement"
      }
    },
    "amount": {
      "description": "The monetary amount of the gift.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "balance": {
      "description": "The balance remaining on the gift.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "batch_number": {
      "description": "The batch number associated with this gift.",
      "type": "string"
    },
    "constituent_id": {
      "description": "The immutable system record ID of the constituent associated with the gift.",
      "type": "string"
    },
    "date": {
      "format": "date-time",
      "description": "The gift date. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
      "type": "string",
      "x-supports-datetime-offset": false
    },
    "date_added": {
      "format": "date-time",
      "description": "The date when the gift was created. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
      "type": "string",
      "x-supports-datetime-offset": true
    },
    "date_modified": {
      "format": "date-time",
      "description": "The date when the gift was last modified. Includes an offset from UTC in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>.",
      "type": "string",
      "x-supports-datetime-offset": true
    },
    "fundraisers": {
      "description": "The set of fundraisers who receive credit for the gift.",
      "type": "array",
      "items": {
        "description": "Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and request donations. When a constituent makes a donation, the fundraiser can receive credit to track performance and foster fundraising accomplishments.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount credited to the fundraiser for the gift.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The immutable constituent system record ID for the fundraiser associated with the gift.",
            "type": "string"
          }
        },
        "x-display-name": "Gift fundraiser",
        "x-display-id": "GiftFundraiser"
      }
    },
    "gift_aid_amount": {
      "description": "This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all <code>gift_splits</code> for this gift. For the UK only.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "gift_aid_qualification_status": {
      "description": "This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: <i>Qualified</i>, <i>NotQualified</i>, and <i>PartlyQualified</i>. For the UK only.",
      "type": "string"
    },
    "gift_code": {
      "description": "The gift code value associated with the gift.",
      "type": "string"
    },
    "gift_splits": {
      "description": "The set of gift splits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Not all gifts serve a single purpose. Gift splits track donor wishes and allow you to divide gifts among multiple campaigns, funds, and appeals.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the gift split.",
            "type": "string"
          },
          "amount": {
            "description": "The amount of the gift split.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "appeal_id": {
            "description": "The immutable system record ID of the appeal associated with the gift split.",
            "type": "string"
          },
          "campaign_id": {
            "description": "The immutable system record ID of the campaign associated with the gift split.",
            "type": "string"
          },
          "fund_id": {
            "description": "The immutable system record ID of the fund associated with the gift split.",
            "type": "string"
          },
          "gift_aid_amount": {
            "description": "The amount of tax reclaimed from gift aid for this gift split. For the UK only.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "gift_aid_qualification_status": {
            "description": "The gift aid qualification status of the gift split. Available values are: <i>Qualified</i>, and <i>NotQualified</i>. For the UK only.",
            "type": "string"
          },
          "package_id": {
            "description": "The immutable system record ID of the package associated with the gift split.",
            "type": "string"
          }
        },
        "x-display-name": "Gift split",
        "x-display-id": "GiftSplit"
      }
    },
    "gift_status": {
      "description": "The status of the gift. Available values are <i>Active</i>, <i>Held</i>, <i>Terminated</i>, <i>Completed</i>, and <i>Cancelled.</i>",
      "type": "string"
    },
    "is_anonymous": {
      "description": "Indicates whether the gift is anonymous.",
      "type": "boolean"
    },
    "linked_gifts": {
      "description": "The identifiers of other gifts that are linked to this gift.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "constituency": {
      "description": "The constituency of the gift.",
      "type": "string"
    },
    "lookup_id": {
      "description": "The user-defined identifier for the gift.",
      "type": "string"
    },
    "origin": {
      "description": "The origin of the gift.",
      "type": "string"
    },
    "payments": {
      "description": "The payments on the gift.",
      "type": "array",
      "items": {
        "description": "Donors can use a variety of methods — such as Cash, Personal check, Credit card, and Direct debit — to pay for gifts.",
        "type": "object",
        "properties": {
          "account_token": {
            "description": "The tokenized account information (e.g. credit card) from the external payment provider. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
            "type": "string"
          },
          "bbps_configuration_id": {
            "description": "The bbps configuration ID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
            "type": "string"
          },
          "bbps_transaction_id": {
            "description": "The bbps transaction ID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
            "type": "string"
          },
          "check_date": {
            "description": "The check date. Only applies to payment method of <i>PersonalCheck</i>.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          },
          "check_number": {
            "description": "The check number. Only applies to payment method of <i>PersonalCheck</i>.",
            "type": "string"
          },
          "checkout_transaction_id": {
            "description": "The checkout transaction ID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
            "type": "string"
          },
          "payment_method": {
            "description": "The payment method. Available values are listed below.",
            "type": "string"
          },
          "reference": {
            "description": "The reference. Only applies to payment method of <i>Other</i>.",
            "type": "string"
          },
          "reference_date": {
            "description": "The reference date. Only applies to payment method of <i>Other</i>.",
            "type": "object",
            "properties": {
              "d": {
                "format": "int32",
                "description": "The day in the fuzzy date.",
                "type": "integer"
              },
              "m": {
                "format": "int32",
                "description": "The month in the fuzzy date.",
                "type": "integer"
              },
              "y": {
                "format": "int32",
                "description": "The year in the fuzzy date.",
                "type": "integer"
              }
            },
            "x-display-name": "Fuzzy date",
            "x-display-id": "FuzzyDate"
          }
        },
        "x-display-name": "Payment",
        "x-display-id": "Payment",
        "x-additional-info": "<a name=\"PaymentMethods\"></a>\r\n<p>&nbsp;</p>\r\n<p>\r\n    Available values for the <b>payment_method</b> of a <b>payment</b>:\r\n</p>\r\n\r\n<div class=\"table-responsive\">\r\n    <table class=\"table table-striped table-hover\">\r\n        <thead>\r\n            <tr>\r\n                <th class=\"col-xs-3\"><strong>Type</strong></th>\r\n                <th class=\"col-xs-9\"><strong>Description</strong></th>\r\n            </tr>\r\n        </thead>\r\n        <tbody>\r\n            <tr>\r\n                <td>Cash</td>\r\n                <td>Cash.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>PersonalCheck</td>\r\n                <td>A personal check.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>CreditCard</td>\r\n                <td>A credit card.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>StandingOrder</td>\r\n                <td>A standing order.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>DirectDebit</td>\r\n                <td>Direct debit.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Voucher</td>\r\n                <td>A voucher.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Other</td>\r\n                <td>Another method of payment.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>PayPal</td>\r\n                <td>PayPal</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Venmo</td>\r\n                <td>Venmo</td>\r\n            </tr>\r\n        </tbody>\r\n    </table>\r\n</div>\r\n\r\n<div class=\"footnotes\">\r\n    <p class=\"footnote\"><b>Note:</b> For the <i>ListGifts</i> endpoint, only <code>payment_method</code> is returned.</p>\r\n</div>"
      }
    },
    "post_date": {
      "format": "date-time",
      "description": "The date that the gift was posted to general ledger. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
      "type": "string",
      "x-supports-datetime-offset": false
    },
    "post_status": {
      "description": "The general ledger post status of the gift. Available values are <i>Posted</i>, <i>NotPosted</i>, and <i>DoNotPost.</i> When <code>post_status</code> is set to <i>DoNotPost</i>, <code>post_date</code> should be null. When it is set to <i>NotPosted</i>, <code>post_date</code> is required but remains editable. When it is set to <i>Posted</i>, <code>post_date</code> is required and is no longer editable.",
      "type": "string"
    },
    "receipts": {
      "description": "The set of receipts associated with the gift.",
      "type": "array",
      "items": {
        "description": "To help donors track their giving for tax purposes, your organization should provide gift receipts.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The amount of the receipt.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "date": {
            "format": "date-time",
            "description": "The date on the receipt. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
            "type": "string",
            "x-supports-datetime-offset": false
          },
          "number": {
            "format": "int32",
            "description": "The number of the receipt.",
            "type": "integer"
          },
          "status": {
            "description": "The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT.",
            "type": "string"
          }
        },
        "x-display-name": "Receipt",
        "x-display-id": "Receipt"
      }
    },
    "recurring_gift_schedule": {
      "description": "The recurring gift schedule. Only returned for automated recurring gifts.",
      "required": [
        "frequency",
        "start_date"
      ],
      "type": "object",
      "properties": {
        "end_date": {
          "format": "date-time",
          "description": "Date the recurring gift should end. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
          "type": "string",
          "x-supports-datetime-offset": false
        },
        "frequency": {
          "description": "Installment frequency of the recurring gift to view. Available values are WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.",
          "type": "string"
        },
        "start_date": {
          "format": "date-time",
          "description": "Date the recurring gift should start. Uses <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format: </a><i>1969-11-21T10:29:43</i>.",
          "type": "string",
          "x-supports-datetime-offset": false
        },
        "next_transaction_date": {
          "format": "date-time",
          "description": "The date of the next scheduled transaction. Only applies to Recurring Gifts and Pledges.",
          "type": "string",
          "x-supports-datetime-offset": false
        }
      },
      "x-hidden": true,
      "x-display-name": "Recurring gift schedule",
      "x-display-id": "RecurringGiftSchedule"
    },
    "recurring_gift_status_date": {
      "description": "The date that the gift status was last modified.",
      "type": "object",
      "properties": {
        "d": {
          "format": "int32",
          "description": "The day in the fuzzy date.",
          "type": "integer"
        },
        "m": {
          "format": "int32",
          "description": "The month in the fuzzy date.",
          "type": "integer"
        },
        "y": {
          "format": "int32",
          "description": "The year in the fuzzy date.",
          "type": "integer"
        }
      },
      "x-display-name": "Fuzzy date",
      "x-display-id": "FuzzyDate"
    },
    "reference": {
      "description": "Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.",
      "type": "string"
    },
    "soft_credits": {
      "description": "The set of soft credits associated with the gift.",
      "type": "array",
      "items": {
        "description": "Soft credits allow you to recognize and track the indirect contributions of constituents such as spouses who influence the gifts of other constituents.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The immutable system record ID of the soft credit.",
            "type": "string"
          },
          "amount": {
            "description": "The amount of the soft credit.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "constituent_id": {
            "description": "The immutable system record ID of the constituent associated with the soft credit.",
            "type": "string"
          },
          "gift_id": {
            "description": "The immutable system record ID of the gift associated with the soft credit.",
            "type": "string"
          }
        },
        "x-display-name": "Soft credit",
        "x-display-id": "SoftCredit"
      }
    },
    "subtype": {
      "description": "The subtype of the gift. Available values are the entries in the <a href=\"https://developer.sky.blackbaud.com/docs/services/58bdd5edd7dcde06046081d6/operations/ListGiftSubtypes\"><b>Gift Subtypes</b></a> table.",
      "type": "string"
    },
    "type": {
      "description": "The gift type. Available values are listed below.",
      "type": "string"
    }
  },
  "x-display-name": "Gift",
  "x-display-id": "Gift",
  "x-additional-info": "<a name=\"GiftTypes\"></a>\r\n<p>&nbsp;</p>\r\n<p>\r\n    Available values for the <b>type</b> of a <b>gift</b>:\r\n</p>\r\n\r\n<div class=\"table-responsive\">\r\n    <table class=\"table table-striped table-hover\">\r\n        <thead>\r\n            <tr>\r\n                <th class=\"col-xs-3\"><strong>Type</strong></th>\r\n                <th class=\"col-xs-9\"><strong>Description</strong></th>\r\n            </tr>\r\n        </thead>\r\n        <tbody>\r\n            <tr>\r\n                <td>Amendment</td>\r\n                <td>An amendment.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Donation</td>\r\n                <td>A donation.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>GiftInKind</td>\r\n                <td>A gift-in-kind.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>GeneralLedgerReversal</td>\r\n                <td>A general ledger reversal.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>MatchingGiftPledge</td>\r\n                <td>A matching gift pledge.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>MatchingGiftPayment</td>\r\n                <td>A matching gift payment.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>MatchingGiftWriteOff</td>\r\n                <td>A matching gift write-off.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>PlannedGift</td>\r\n                <td>A planned gift.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Pledge</td>\r\n                <td>A pledge.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>PledgePayment</td>\r\n                <td>A pledge payment.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>PledgeWriteOff</td>\r\n                <td>A pledge write off.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>RecurringGift</td>\r\n                <td>A recurring gift.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>RecurringGiftPayment</td>\r\n                <td>A recurring gift payment.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Stock</td>\r\n                <td>A stock.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>SoldStock</td>\r\n                <td>A sold stock.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Other</td>\r\n                <td>Another type of gift.</td>\r\n            </tr>\r\n        </tbody>\r\n    </table>\r\n</div>"
}