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.",
  "required": [
    "amount",
    "constituent_id",
    "gift_splits",
    "type",
    "payments"
  ],
  "type": "object",
  "properties": {
    "acknowledgements": {
      "description": "The set of acknowledgements associated with the gift.\r\nIf none are provided, an empty acknowledgement with a status of <i>NEEDSACKNOWLEDGEMENT</i> will be created alongside 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: <i>ACKNOWLEDGED</i>, <i>NEEDSACKNOWLEDGEMENT</i>, and <i>DONOTACKNOWLEDGE.</i>\r\nWhen <code>acknowledgement_status</code> is set to <i>DONOTACKNOWLEDGE</i>, <code>acknowledgement_letter</code> and <code>acknowledgement_date</code> should be null.\r\nWhen it is set to <i>NEEDSACKNOWLEDGEMENT</i>, <code>acknowledgement_date</code> should be null.\r\nIf no value is provided, a default value of <i>NEEDSACKNOWLEDGEMENT</i> will be used.",
            "type": "string"
          }
        },
        "x-display-name": "Acknowledgement",
        "x-display-id": "Acknowledgement_01"
      }
    },
    "amount": {
      "description": "The monetary amount of the gift.",
      "type": "object",
      "properties": {
        "value": {
          "format": "double",
          "description": "The monetary value.",
          "type": "number"
        }
      }
    },
    "batch_number": {
      "description": "Gets or sets the batch number. Character limit: 50 (including the batch prefix).",
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "batch_prefix": {
      "description": "Gets or sets the batch prefix. This must include at least one letter. It is required when BatchNumber has a value and defaults to \"API\" if no value is provided.",
      "type": "string"
    },
    "constituency": {
      "description": "The constituency value of the gift. If no value is provided, the default constituency of the donor will be used.",
      "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. Includes an offset from UTC in <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
    },
    "default_fundraiser_credits": {
      "description": "Indicates whether to use default fundraiser credits.\r\nIf no value is provided, defaults will not be used.",
      "type": "boolean"
    },
    "default_soft_credits": {
      "description": "Indicates whether to use default soft credits.\r\nIf no value is provided, defaults will not be used.",
      "type": "boolean"
    },
    "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.",
        "required": [
          "amount",
          "constituent_id"
        ],
        "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-hidden": true,
        "x-display-name": "Create gift fundraiser",
        "x-display-id": "CreateGiftFundraiser"
      }
    },
    "gift_code": {
      "description": "The gift code. Available values are the entries in the Gift Code table.",
      "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.",
        "required": [
          "amount",
          "fund_id"
        ],
        "type": "object",
        "properties": {
          "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"
          },
          "package_id": {
            "description": "The immutable system record ID of the package associated with the gift split.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create gift split",
        "x-display-id": "CreateGiftSplit"
      }
    },
    "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"
    },
    "type": {
      "description": "The gift type. Available values <a href=\"#GiftTypes\">are listed below</a>, but at this time, you can only add gifts with the <i>Donation</i>, <i>Other</i>, <i>GiftInKind</i>, <i>RecurringGift</i>, and <i>RecurringGiftPayment</i> type.",
      "type": "string"
    },
    "is_anonymous": {
      "description": "Indicates whether the gift is anonymous.\r\nIf no value is provided, the default anonymity of the donor will be used.",
      "type": "boolean"
    },
    "is_manual": {
      "description": "Indicates whether the gift is a manual gift.\r\nIf set to true, credit card and direct debit payments with transaction details will not charge. Recurring gifts that are manual will not have automated recurring gift payments generated. \r\nIf no value is provided, the value will default to false.",
      "type": "boolean"
    },
    "linked_gifts": {
      "description": "The recurring gift associated with the payment being added. When adding a recurring gift payment, a <code>linked_gifts</code> field must be included as an array of strings with the ID of the recurring gift to which the payment is linked.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "lookup_id": {
      "description": "The user-defined identifier for the gift. Character limit: 50. Lookup IDs for gifts created from an approved batch are automatically generated based on configuration settings in the database view.",
      "maxLength": 50,
      "minLength": 0,
      "type": "string"
    },
    "origin": {
      "description": "The origin of the gift.\r\nWhen provided, it must parse to a valid JSON object with one string field called \"name\". Additional fields may be added as desired.",
      "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 account token. Must parse to a valid, non-empty GUID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>. When adding a recurring gift, an account token must be provided for each <code>payments</code> object.",
            "type": "string"
          },
          "bbps_configuration_id": {
            "description": "The bbps configuration ID. Must parse to a valid, non-empty GUID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>.",
            "type": "string"
          },
          "bbps_transaction_id": {
            "description": "The bbps transaction ID. Must parse to a valid, non-empty GUID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>. When adding a recurring gift payment, either a <code>bbps_transaction_id</code> or <code>checkout_transaction_id</code> must be provided for each <code>payments</code> object.",
            "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>. Character limit: 20.",
            "maxLength": 20,
            "minLength": 0,
            "type": "string"
          },
          "checkout_transaction_id": {
            "description": "The checkout transaction ID. Must parse to a valid, non-empty GUID. Only applies to payment methods of <i>CreditCard</i> and <i>DirectDebit</i>. When adding a recurring gift payment, either a <code>bbps_transaction_id</code> or <code>checkout_transaction_id</code> must be provided for each <code>payments</code> object.",
            "type": "string"
          },
          "charge_transaction": {
            "description": "Whether or not to charge the checkout transaction. Only applies when a \"CheckoutTransactionId\" is supplied.",
            "type": "boolean"
          },
          "payment_method": {
            "description": "The payment method. Available values <a href=\"#PaymentMethods\">are listed below</a>. For donations, the payment method can be <i>Cash</i>, <i>CreditCard</i>, <i>PersonalCheck</i>, <i>DirectDebit</i>, <i>Other</i>, <i>PayPal</i>, or <i>Venmo</i>. For recurring gifts and recurring gift payments, the payment method must be <i>CreditCard</i> or <i>DirectDebit</i>.",
            "type": "string"
          },
          "reason": {
            "description": "Optional. The Reason Code for this payment. Available values are <i>Approved</i>, <i>HardReject</i>, <i>Held</i>, and <i>SoftReject</i>.",
            "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"
          },
          "rejection_details": {
            "description": "The detail for why a payment was rejected. Generally comes from the gateway. This value will be ignored if reason is not set to <i>HardReject</i>, <i>Held</i>, or <i>SoftReject</i>.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create payment",
        "x-display-id": "CreatePayment",
        "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. Includes an offset from UTC in <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>\r\nWhen <code>post_status</code> is set to <i>DoNotPost</i>, <code>post_date</code> should be null.\r\nWhen it is set to <i>NotPosted</i>, <code>post_date</code> is required but remains editable.\r\nWhen it is set to <i>Posted</i>, <code>post_date</code> is required and is no longer editable.\r\nIf no value is provided, a default value of <i>NotPosted</i> will be used.",
      "type": "string"
    },
    "receipts": {
      "description": "The set of receipts associated with the gift.\r\nIf none are provided, an empty receipt with a status of <i>NEEDSRECEIPT</i> will be added alongside the gift.",
      "type": "array",
      "items": {
        "description": "An object that represents the gift receipt to create.\r\nTo help donors track their giving for tax purposes, your organization should provide gift receipts.",
        "type": "object",
        "properties": {
          "amount": {
            "description": "The monetary amount of the receipt to associate with the gift.",
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "description": "The monetary value.",
                "type": "number"
              }
            }
          },
          "date": {
            "format": "date-time",
            "description": "The date that the gift was receipted. Includes an offset from UTC in <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
          },
          "status": {
            "description": "The receipt status of the gift. Available values are <i>RECEIPTED</i>, <i>NEEDSRECEIPT</i>, and <i>DONOTRECEIPT.</i>\r\nWhen <code>receipt_status</code> is set to <i>DONOTRECEIPT</i> or <i>NEEDSRECEIPT</i>, <code>receipt_date</code> should be null.\r\nWhen it is set to <i>RECEIPTED</i>, <code>receipt_date</code> is required and is no longer editable.\r\nIf no value is provided, a default value of <i>NEEDSRECEIPT</i> will be used.",
            "type": "string"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create gift receipt",
        "x-display-id": "CreateGiftReceipt"
      }
    },
    "recurring_gift_schedule": {
      "description": "The recurring gift schedule. When adding a recurring gift, a schedule is required.",
      "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 add. 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
        }
      },
      "x-hidden": true,
      "x-display-name": "Recurring gift schedule",
      "x-display-id": "RecurringGiftSchedule_01"
    },
    "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. Character limit: 255.",
      "maxLength": 255,
      "minLength": 0,
      "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.",
        "required": [
          "amount",
          "constituent_id"
        ],
        "type": "object",
        "properties": {
          "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"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create soft credit",
        "x-display-id": "CreateSoftCredit"
      }
    },
    "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"
    },
    "custom_fields": {
      "description": "The set of custom fields associated with the gift.",
      "type": "array",
      "items": {
        "description": "While records provide many fields to track information, organizations often require additional details. To track this specialized information, use custom fields.",
        "required": [
          "category"
        ],
        "type": "object",
        "properties": {
          "category": {
            "description": "The custom field category. Available values are the entries in the <b>Custom Field Categories</b> table of the parent object.",
            "type": "string"
          },
          "comment": {
            "description": "The comment on the custom field. Character limit: 50.",
            "maxLength": 50,
            "minLength": 0,
            "type": "string"
          },
          "date": {
            "format": "date-time",
            "description": "The date on the custom field. 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
          },
          "parent_id": {
            "description": "The parent object's immutable system record ID.",
            "type": "string"
          },
          "value": {
            "description": "The value of the custom field. The <code>type</code> property determines the format. Character limit depends on data type.",
            "type": "object"
          }
        },
        "x-hidden": true,
        "x-display-name": "Create custom field",
        "x-display-id": "CreateCustomField",
        "x-additional-info": "<a name=\"CustomFieldTypes\"></a>\r\n<p>&nbsp;</p>\r\n<p>\r\n    Available values for the <b>type</b> of a <b>custom field</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>Boolean</td>\r\n                <td>Defines the custom field as a boolean value.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>CodeTableEntry</td>\r\n                <td>Defines the custom field as a string value that represents a code table entry description.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>ConstituentId</td>\r\n                <td>Defines the custom field as a constituent identifier value.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Currency</td>\r\n                <td>Defines the custom field as a decimal value.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Date</td>\r\n                <td>\r\n                    Defines the custom field as a date value in <a href=\"https://tools.ietf.org/html/rfc3339\">ISO-8601 format:</a> <i>1969-11-21T10:29:43</i>.\r\n                </td>\r\n            </tr>\r\n            <tr>\r\n                <td>FuzzyDate</td>\r\n                <td>\r\n                    Defines the custom field as a fuzzy date value.\r\n                </td>\r\n            </tr>\r\n            <tr>\r\n                <td>Number</td>\r\n                <td>Defines the custom field as an integer value.</td>\r\n            </tr>\r\n            <tr>\r\n                <td>Text</td>\r\n                <td>Defines the custom field as a string value. Character limit: 255.</td>\r\n            </tr>\r\n        </tbody>\r\n    </table>\r\n</div>"
      }
    }
  },
  "x-hidden": true,
  "x-display-name": "Create gift",
  "x-display-id": "CreateGift",
  "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>"
}

{
  "description": "Defines the shape of a post response object.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The newly created ID",
      "type": "string"
    }
  },
  "x-hidden": true
}