Create a Gift not recommended
POST {{baseUrl}}/api/Gift
This endpoint creates a gift directly onto a contact record. Using this endpoint assumes
you know the precise contact the gift is matched to. Virtuous does not support cleaning up data
that is caused by creating the gifts incorrectly through this endpoint.
Please use the Gift Transaction endpoint as a better alternative.
RecurringGiftPayment and PledgePayment accepted State values:
- Add
- Update
- Delete
- Ignore
Request Body
{"contactId"=>"<integer>", "giftType"=>"Cash", "giftDate"=>"<dateTime>", "amount"=>"<double>", "transactionSource"=>"<string>", "transactionId"=>"<string>", "batch"=>"<string>", "segmentId"=>"<integer>", "receiptSegmentId"=>"<integer>", "mediaOutletId"=>"<integer>", "notes"=>"<string>", "isPrivate"=>"<boolean>", "receiptDate"=>"<dateTime>", "contactIndividualId"=>"<integer>", "contactPassthroughId"=>"<integer>", "cashAccountingCode"=>"<string>", "state"=>"<string>", "isTaxDeductible"=>"<boolean>", "giftAskId"=>"<integer>", "passthroughGiftAskId"=>"<integer>", "grantId"=>"<integer>", "contactMembershipId"=>"<integer>", "currencyCode"=>"<string>", "exchangeRate"=>"<decimal>", "checkNumber"=>"<string>", "creditCardType"=>"<string>", "cryptocoinType"=>"<string>", "transactionHash"=>"<string>", "coinSoldForCash"=>"<boolean>", "coinAmount"=>"<double>", "dateCoinWasSold"=>"<dateTime>", "coinSaleAmount"=>"<double>", "tickerSymbol"=>"<string>", "numberOfShares"=>"<double>", "iraCustodian"=>"<string>", "stockSoldForCash"=>"<boolean>", "dateStockWasSold"=>"<dateTime>", "stockSaleAmount"=>"<double>", "nonCashGiftTypeId"=>"<integer>", "nonCashGiftType"=>"<string>", "description"=>"<string>", "nonCashSoldForCash"=>"<boolean>", "dateNonCashWasSold"=>"<dateTime>", "nonCashOriginalAmount"=>"<double>", "nonCashSaleAmount"=>"<double>", "giftDesignations"=>[{"projectId"=>"<integer>", "amount"=>"<double>", "state"=>"<string>"}, {"projectId"=>"<integer>", "amount"=>"<double>", "state"=>"<string>"}], "giftPremiums"=>[{"premiumId"=>"<integer>", "quantity"=>"<integer>", "state"=>"<string>"}, {"premiumId"=>"<integer>", "quantity"=>"<integer>", "state"=>"<string>"}], "pledgePayments"=>[{"id"=>"<integer>", "amount"=>"<double>", "state"=>"<string>"}, {"id"=>"<integer>", "amount"=>"<double>", "state"=>"<string>"}], "recurringGiftPayments"=>[{"id"=>"<integer>", "amount"=>"<double>", "state"=>"<string>"}, {"id"=>"<integer>", "amount"=>"<double>", "state"=>"<string>"}], "tributeType"=>"<string>", "tributeId"=>"<integer>", "tributeDescription"=>"<string>", "acknowledgeeId"=>"<integer>", "reversedGiftId"=>"<integer>", "customFields"=>[{"name"=>"<string>", "value"=>"<string>", "displayName"=>"<string>"}, {"name"=>"<string>", "value"=>"<string>", "displayName"=>"<string>"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":"\u003cinteger\u003e","transactionSource":"\u003cstring\u003e","transactionId":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactName":"\u003cstring\u003e","contactUrl":"\u003cstring\u003e","giftType":"\u003cstring\u003e","giftTypeFormatted":"\u003cstring\u003e","giftDate":"\u003cdateTime\u003e","giftDateFormatted":"\u003cstring\u003e","amount":"\u003cdouble\u003e","amountFormatted":"\u003cstring\u003e","currencyCode":"\u003cstring\u003e","exchangeRate":"\u003cdecimal\u003e","baseCurrencyCode":"\u003cstring\u003e","batch":"\u003cstring\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","segmentCode":"\u003cstring\u003e","segmentUrl":"\u003cstring\u003e","mediaOutletId":"\u003cinteger\u003e","mediaOutlet":"\u003cstring\u003e","grantId":"\u003cinteger\u003e","grant":"\u003cstring\u003e","grantUrl":"\u003cstring\u003e","notes":"\u003cstring\u003e","tribute":"\u003cstring\u003e","tributeId":"\u003cinteger\u003e","tributeType":"\u003cstring\u003e","acknowledgeeIndividualId":"\u003cinteger\u003e","receiptDate":"\u003cdateTime\u003e","receiptDateFormatted":"\u003cstring\u003e","contactPassthroughId":"\u003cinteger\u003e","contactPassthroughUrl":"\u003cstring\u003e","contactIndividualId":"\u003cinteger\u003e","cashAccountingCode":"\u003cstring\u003e","giftAskId":"\u003cinteger\u003e","contactMembershipId":"\u003cinteger\u003e","giftDesignations":[{"id":"\u003cinteger\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectCode":"\u003cstring\u003e","externalAccountingCode":"\u003cstring\u003e","projectType":"\u003cstring\u003e","projectLocation":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","display":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectCode":"\u003cstring\u003e","externalAccountingCode":"\u003cstring\u003e","projectType":"\u003cstring\u003e","projectLocation":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","display":"\u003cstring\u003e"}],"giftPremiums":[{"id":"\u003cinteger\u003e","premiumId":"\u003cinteger\u003e","premium":"\u003cstring\u003e","premiumUrl":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","display":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","premiumId":"\u003cinteger\u003e","premium":"\u003cstring\u003e","premiumUrl":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","display":"\u003cstring\u003e"}],"pledgePayments":[{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"},{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"}],"recurringGiftPayments":[{"id":"\u003cinteger\u003e","gift":{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","giftDate":"\u003cdateTime\u003e","amount":"\u003cdouble\u003e"},"expectedAmount":"\u003cdouble\u003e","expectedPaymentDate":"\u003cdateTime\u003e","dismissPaymentDate":"\u003cdateTime\u003e","fulfillPaymentDate":"\u003cdateTime\u003e"},{"id":"\u003cinteger\u003e","gift":{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","giftDate":"\u003cdateTime\u003e","amount":"\u003cdouble\u003e"},"expectedAmount":"\u003cdouble\u003e","expectedPaymentDate":"\u003cdateTime\u003e","dismissPaymentDate":"\u003cdateTime\u003e","fulfillPaymentDate":"\u003cdateTime\u003e"}],"giftUrl":"\u003cstring\u003e","isPrivate":"\u003cboolean\u003e","isTaxDeductible":"\u003cboolean\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}