Create a Gift Transaction
curl --request POST \
--url https://api.virtuoussoftware.com/api/v2/Gift/Transaction \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"transactionSource": "<string>",
"transactionId": "<string>",
"contact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": [
"<string>",
"<string>"
]
},
"giftDate": "<string>",
"cancelDate": "<string>",
"giftType": "<string>",
"amount": "<string>",
"currencyCode": "<string>",
"exchangeRate": "<decimal>",
"frequency": "<string>",
"recurringGiftTransactionId": "<string>",
"recurringGiftTransactionUpdate": "<boolean>",
"pledgeFrequency": "<string>",
"pledgeTransactionId": "<string>",
"pledgeExpectedFullfillmentDate": "<string>",
"batch": "<string>",
"notes": "<string>",
"segment": "<string>",
"mediaOutlet": "<string>",
"receiptDate": "<string>",
"receiptSegment": "<string>",
"cashAccountingCode": "<string>",
"tribute": "<string>",
"tributeDedication": {
"tributeId": "<integer>",
"tributeType": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"acknowledgeeIndividualId": "<integer>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"acknowledgeeAddress": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeePostal": "<string>",
"acknowledgeeEmail": "<string>",
"acknowledgeePhone": "<string>"
},
"isPrivate": "<boolean>",
"isTaxDeductible": "<boolean>",
"checkNumber": "<string>",
"creditCardType": "<string>",
"nonCashGiftTypeId": "<integer>",
"nonCashGiftType": "<string>",
"nonCashGiftDescription": "<string>",
"stockTickerSymbol": "<string>",
"stockNumberOfShares": "<integer>",
"iraCustodian": "<string>",
"submissionUrl": "<string>",
"designations": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
}
],
"premiums": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
}
],
"customFields": {
"fieldName": "fieldValue",
"fieldName2": "fieldValue2"
},
"customObjects": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"contactIndividualId": "<integer>",
"passthroughContact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": [
"<string>",
"<string>"
]
},
"eventAttendee": {
"eventId": "<integer>",
"eventName": "<string>",
"invited": "<boolean>",
"rsvp": "<boolean>",
"rsvpResponse": "<boolean>",
"attended": "<boolean>"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactionSource: '<string>',
transactionId: '<string>',
contact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
giftDate: '<string>',
cancelDate: '<string>',
giftType: '<string>',
amount: '<string>',
currencyCode: '<string>',
exchangeRate: '<decimal>',
frequency: '<string>',
recurringGiftTransactionId: '<string>',
recurringGiftTransactionUpdate: '<boolean>',
pledgeFrequency: '<string>',
pledgeTransactionId: '<string>',
pledgeExpectedFullfillmentDate: '<string>',
batch: '<string>',
notes: '<string>',
segment: '<string>',
mediaOutlet: '<string>',
receiptDate: '<string>',
receiptSegment: '<string>',
cashAccountingCode: '<string>',
tribute: '<string>',
tributeDedication: {
tributeId: '<integer>',
tributeType: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
acknowledgeeIndividualId: '<integer>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
acknowledgeeAddress: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeePostal: '<string>',
acknowledgeeEmail: '<string>',
acknowledgeePhone: '<string>'
},
isPrivate: '<boolean>',
isTaxDeductible: '<boolean>',
checkNumber: '<string>',
creditCardType: '<string>',
nonCashGiftTypeId: '<integer>',
nonCashGiftType: '<string>',
nonCashGiftDescription: '<string>',
stockTickerSymbol: '<string>',
stockNumberOfShares: '<integer>',
iraCustodian: '<string>',
submissionUrl: '<string>',
designations: [
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
},
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
}
],
premiums: [
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'},
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'}
],
customFields: {fieldName: 'fieldValue', fieldName2: 'fieldValue2'},
customObjects: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
],
contactIndividualId: '<integer>',
passthroughContact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
eventAttendee: {
eventId: '<integer>',
eventName: '<string>',
invited: '<boolean>',
rsvp: '<boolean>',
rsvpResponse: '<boolean>',
attended: '<boolean>'
}
})
};
fetch('https://api.virtuoussoftware.com/api/v2/Gift/Transaction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/v2/Gift/Transaction"
payload = {
"transactionSource": "<string>",
"transactionId": "<string>",
"contact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": ["<string>", "<string>"]
},
"giftDate": "<string>",
"cancelDate": "<string>",
"giftType": "<string>",
"amount": "<string>",
"currencyCode": "<string>",
"exchangeRate": "<decimal>",
"frequency": "<string>",
"recurringGiftTransactionId": "<string>",
"recurringGiftTransactionUpdate": "<boolean>",
"pledgeFrequency": "<string>",
"pledgeTransactionId": "<string>",
"pledgeExpectedFullfillmentDate": "<string>",
"batch": "<string>",
"notes": "<string>",
"segment": "<string>",
"mediaOutlet": "<string>",
"receiptDate": "<string>",
"receiptSegment": "<string>",
"cashAccountingCode": "<string>",
"tribute": "<string>",
"tributeDedication": {
"tributeId": "<integer>",
"tributeType": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"acknowledgeeIndividualId": "<integer>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"acknowledgeeAddress": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeePostal": "<string>",
"acknowledgeeEmail": "<string>",
"acknowledgeePhone": "<string>"
},
"isPrivate": "<boolean>",
"isTaxDeductible": "<boolean>",
"checkNumber": "<string>",
"creditCardType": "<string>",
"nonCashGiftTypeId": "<integer>",
"nonCashGiftType": "<string>",
"nonCashGiftDescription": "<string>",
"stockTickerSymbol": "<string>",
"stockNumberOfShares": "<integer>",
"iraCustodian": "<string>",
"submissionUrl": "<string>",
"designations": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
}
],
"premiums": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
}
],
"customFields": {
"fieldName": "fieldValue",
"fieldName2": "fieldValue2"
},
"customObjects": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"contactIndividualId": "<integer>",
"passthroughContact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": ["<string>", "<string>"]
},
"eventAttendee": {
"eventId": "<integer>",
"eventName": "<string>",
"invited": "<boolean>",
"rsvp": "<boolean>",
"rsvpResponse": "<boolean>",
"attended": "<boolean>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/v2/Gift/Transaction");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"transactionSource\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"contact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"giftDate\": \"<string>\",\n \"cancelDate\": \"<string>\",\n \"giftType\": \"<string>\",\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"exchangeRate\": \"<decimal>\",\n \"frequency\": \"<string>\",\n \"recurringGiftTransactionId\": \"<string>\",\n \"recurringGiftTransactionUpdate\": \"<boolean>\",\n \"pledgeFrequency\": \"<string>\",\n \"pledgeTransactionId\": \"<string>\",\n \"pledgeExpectedFullfillmentDate\": \"<string>\",\n \"batch\": \"<string>\",\n \"notes\": \"<string>\",\n \"segment\": \"<string>\",\n \"mediaOutlet\": \"<string>\",\n \"receiptDate\": \"<string>\",\n \"receiptSegment\": \"<string>\",\n \"cashAccountingCode\": \"<string>\",\n \"tribute\": \"<string>\",\n \"tributeDedication\": {\n \"tributeId\": \"<integer>\",\n \"tributeType\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"acknowledgeeIndividualId\": \"<integer>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"acknowledgeeAddress\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"acknowledgeeEmail\": \"<string>\",\n \"acknowledgeePhone\": \"<string>\"\n },\n \"isPrivate\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"checkNumber\": \"<string>\",\n \"creditCardType\": \"<string>\",\n \"nonCashGiftTypeId\": \"<integer>\",\n \"nonCashGiftType\": \"<string>\",\n \"nonCashGiftDescription\": \"<string>\",\n \"stockTickerSymbol\": \"<string>\",\n \"stockNumberOfShares\": \"<integer>\",\n \"iraCustodian\": \"<string>\",\n \"submissionUrl\": \"<string>\",\n \"designations\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n }\n ],\n \"premiums\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"customFields\": {\n \"fieldName\": \"fieldValue\",\n \"fieldName2\": \"fieldValue2\"\n },\n \"customObjects\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"contactIndividualId\": \"<integer>\",\n \"passthroughContact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"eventAttendee\": {\n \"eventId\": \"<integer>\",\n \"eventName\": \"<string>\",\n \"invited\": \"<boolean>\",\n \"rsvp\": \"<boolean>\",\n \"rsvpResponse\": \"<boolean>\",\n \"attended\": \"<boolean>\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/v2/Gift/Transaction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'transactionSource' => '<string>',
'transactionId' => '<string>',
'contact' => [
'referenceId' => '<string>',
'id' => '<integer>',
'name' => '<string>',
'type' => '<string>',
'title' => '<string>',
'firstname' => '<string>',
'middlename' => '<string>',
'lastname' => '<string>',
'suffix' => '<string>',
'birthMonth' => '<string>',
'birthDay' => '<string>',
'birthYear' => '<string>',
'gender' => '<string>',
'emailType' => '<string>',
'email' => '<string>',
'phoneType' => '<string>',
'phone' => '<string>',
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'country' => '<string>'
],
'tags' => '<string>',
'emailLists' => [
'<string>',
'<string>'
]
],
'giftDate' => '<string>',
'cancelDate' => '<string>',
'giftType' => '<string>',
'amount' => '<string>',
'currencyCode' => '<string>',
'exchangeRate' => '<decimal>',
'frequency' => '<string>',
'recurringGiftTransactionId' => '<string>',
'recurringGiftTransactionUpdate' => '<boolean>',
'pledgeFrequency' => '<string>',
'pledgeTransactionId' => '<string>',
'pledgeExpectedFullfillmentDate' => '<string>',
'batch' => '<string>',
'notes' => '<string>',
'segment' => '<string>',
'mediaOutlet' => '<string>',
'receiptDate' => '<string>',
'receiptSegment' => '<string>',
'cashAccountingCode' => '<string>',
'tribute' => '<string>',
'tributeDedication' => [
'tributeId' => '<integer>',
'tributeType' => '<string>',
'tributeFirstName' => '<string>',
'tributeLastName' => '<string>',
'tributeCity' => '<string>',
'tributeState' => '<string>',
'acknowledgeeIndividualId' => '<integer>',
'acknowledgeeFirstName' => '<string>',
'acknowledgeeLastName' => '<string>',
'acknowledgeeAddress' => '<string>',
'acknowledgeeCity' => '<string>',
'acknowledgeeState' => '<string>',
'acknowledgeePostal' => '<string>',
'acknowledgeeEmail' => '<string>',
'acknowledgeePhone' => '<string>'
],
'isPrivate' => '<boolean>',
'isTaxDeductible' => '<boolean>',
'checkNumber' => '<string>',
'creditCardType' => '<string>',
'nonCashGiftTypeId' => '<integer>',
'nonCashGiftType' => '<string>',
'nonCashGiftDescription' => '<string>',
'stockTickerSymbol' => '<string>',
'stockNumberOfShares' => '<integer>',
'iraCustodian' => '<string>',
'submissionUrl' => '<string>',
'designations' => [
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'amountDesignated' => '<string>'
],
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'amountDesignated' => '<string>'
]
],
'premiums' => [
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'quantity' => '<string>'
],
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'quantity' => '<string>'
]
],
'customFields' => [
'fieldName' => 'fieldValue',
'fieldName2' => 'fieldValue2'
],
'customObjects' => [
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
],
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
]
],
'contactIndividualId' => '<integer>',
'passthroughContact' => [
'referenceId' => '<string>',
'id' => '<integer>',
'name' => '<string>',
'type' => '<string>',
'title' => '<string>',
'firstname' => '<string>',
'middlename' => '<string>',
'lastname' => '<string>',
'suffix' => '<string>',
'birthMonth' => '<string>',
'birthDay' => '<string>',
'birthYear' => '<string>',
'gender' => '<string>',
'emailType' => '<string>',
'email' => '<string>',
'phoneType' => '<string>',
'phone' => '<string>',
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'country' => '<string>'
],
'tags' => '<string>',
'emailLists' => [
'<string>',
'<string>'
]
],
'eventAttendee' => [
'eventId' => '<integer>',
'eventName' => '<string>',
'invited' => '<boolean>',
'rsvp' => '<boolean>',
'rsvpResponse' => '<boolean>',
'attended' => '<boolean>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/v2/Gift/Transaction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transactionSource\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"contact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"giftDate\": \"<string>\",\n \"cancelDate\": \"<string>\",\n \"giftType\": \"<string>\",\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"exchangeRate\": \"<decimal>\",\n \"frequency\": \"<string>\",\n \"recurringGiftTransactionId\": \"<string>\",\n \"recurringGiftTransactionUpdate\": \"<boolean>\",\n \"pledgeFrequency\": \"<string>\",\n \"pledgeTransactionId\": \"<string>\",\n \"pledgeExpectedFullfillmentDate\": \"<string>\",\n \"batch\": \"<string>\",\n \"notes\": \"<string>\",\n \"segment\": \"<string>\",\n \"mediaOutlet\": \"<string>\",\n \"receiptDate\": \"<string>\",\n \"receiptSegment\": \"<string>\",\n \"cashAccountingCode\": \"<string>\",\n \"tribute\": \"<string>\",\n \"tributeDedication\": {\n \"tributeId\": \"<integer>\",\n \"tributeType\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"acknowledgeeIndividualId\": \"<integer>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"acknowledgeeAddress\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"acknowledgeeEmail\": \"<string>\",\n \"acknowledgeePhone\": \"<string>\"\n },\n \"isPrivate\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"checkNumber\": \"<string>\",\n \"creditCardType\": \"<string>\",\n \"nonCashGiftTypeId\": \"<integer>\",\n \"nonCashGiftType\": \"<string>\",\n \"nonCashGiftDescription\": \"<string>\",\n \"stockTickerSymbol\": \"<string>\",\n \"stockNumberOfShares\": \"<integer>\",\n \"iraCustodian\": \"<string>\",\n \"submissionUrl\": \"<string>\",\n \"designations\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n }\n ],\n \"premiums\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"customFields\": {\n \"fieldName\": \"fieldValue\",\n \"fieldName2\": \"fieldValue2\"\n },\n \"customObjects\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"contactIndividualId\": \"<integer>\",\n \"passthroughContact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"eventAttendee\": {\n \"eventId\": \"<integer>\",\n \"eventName\": \"<string>\",\n \"invited\": \"<boolean>\",\n \"rsvp\": \"<boolean>\",\n \"rsvpResponse\": \"<boolean>\",\n \"attended\": \"<boolean>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/v2/Gift/Transaction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transactionSource\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"contact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"giftDate\": \"<string>\",\n \"cancelDate\": \"<string>\",\n \"giftType\": \"<string>\",\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"exchangeRate\": \"<decimal>\",\n \"frequency\": \"<string>\",\n \"recurringGiftTransactionId\": \"<string>\",\n \"recurringGiftTransactionUpdate\": \"<boolean>\",\n \"pledgeFrequency\": \"<string>\",\n \"pledgeTransactionId\": \"<string>\",\n \"pledgeExpectedFullfillmentDate\": \"<string>\",\n \"batch\": \"<string>\",\n \"notes\": \"<string>\",\n \"segment\": \"<string>\",\n \"mediaOutlet\": \"<string>\",\n \"receiptDate\": \"<string>\",\n \"receiptSegment\": \"<string>\",\n \"cashAccountingCode\": \"<string>\",\n \"tribute\": \"<string>\",\n \"tributeDedication\": {\n \"tributeId\": \"<integer>\",\n \"tributeType\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"acknowledgeeIndividualId\": \"<integer>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"acknowledgeeAddress\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"acknowledgeeEmail\": \"<string>\",\n \"acknowledgeePhone\": \"<string>\"\n },\n \"isPrivate\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"checkNumber\": \"<string>\",\n \"creditCardType\": \"<string>\",\n \"nonCashGiftTypeId\": \"<integer>\",\n \"nonCashGiftType\": \"<string>\",\n \"nonCashGiftDescription\": \"<string>\",\n \"stockTickerSymbol\": \"<string>\",\n \"stockNumberOfShares\": \"<integer>\",\n \"iraCustodian\": \"<string>\",\n \"submissionUrl\": \"<string>\",\n \"designations\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n }\n ],\n \"premiums\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"customFields\": {\n \"fieldName\": \"fieldValue\",\n \"fieldName2\": \"fieldValue2\"\n },\n \"customObjects\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"contactIndividualId\": \"<integer>\",\n \"passthroughContact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"eventAttendee\": {\n \"eventId\": \"<integer>\",\n \"eventName\": \"<string>\",\n \"invited\": \"<boolean>\",\n \"rsvp\": \"<boolean>\",\n \"rsvpResponse\": \"<boolean>\",\n \"attended\": \"<boolean>\"\n }\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/v2/Gift/Transaction';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactionSource: '<string>',
transactionId: '<string>',
contact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
giftDate: '<string>',
cancelDate: '<string>',
giftType: '<string>',
amount: '<string>',
currencyCode: '<string>',
exchangeRate: '<decimal>',
frequency: '<string>',
recurringGiftTransactionId: '<string>',
recurringGiftTransactionUpdate: '<boolean>',
pledgeFrequency: '<string>',
pledgeTransactionId: '<string>',
pledgeExpectedFullfillmentDate: '<string>',
batch: '<string>',
notes: '<string>',
segment: '<string>',
mediaOutlet: '<string>',
receiptDate: '<string>',
receiptSegment: '<string>',
cashAccountingCode: '<string>',
tribute: '<string>',
tributeDedication: {
tributeId: '<integer>',
tributeType: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
acknowledgeeIndividualId: '<integer>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
acknowledgeeAddress: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeePostal: '<string>',
acknowledgeeEmail: '<string>',
acknowledgeePhone: '<string>'
},
isPrivate: '<boolean>',
isTaxDeductible: '<boolean>',
checkNumber: '<string>',
creditCardType: '<string>',
nonCashGiftTypeId: '<integer>',
nonCashGiftType: '<string>',
nonCashGiftDescription: '<string>',
stockTickerSymbol: '<string>',
stockNumberOfShares: '<integer>',
iraCustodian: '<string>',
submissionUrl: '<string>',
designations: [
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
},
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
}
],
premiums: [
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'},
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'}
],
customFields: {fieldName: 'fieldValue', fieldName2: 'fieldValue2'},
customObjects: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
],
contactIndividualId: '<integer>',
passthroughContact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
eventAttendee: {
eventId: '<integer>',
eventName: '<string>',
invited: '<boolean>',
rsvp: '<boolean>',
rsvpResponse: '<boolean>',
attended: '<boolean>'
}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Giving
Create a Gift Transaction
HMAC or OAuth Auth valid. This is the recommended way to create a gift. This ensures the gift is matched using the Virtuous matching algorithms for Contacts, Recurring gifts, Designations, etc.
POST
/
api
/
v2
/
Gift
/
Transaction
Create a Gift Transaction
curl --request POST \
--url https://api.virtuoussoftware.com/api/v2/Gift/Transaction \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"transactionSource": "<string>",
"transactionId": "<string>",
"contact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": [
"<string>",
"<string>"
]
},
"giftDate": "<string>",
"cancelDate": "<string>",
"giftType": "<string>",
"amount": "<string>",
"currencyCode": "<string>",
"exchangeRate": "<decimal>",
"frequency": "<string>",
"recurringGiftTransactionId": "<string>",
"recurringGiftTransactionUpdate": "<boolean>",
"pledgeFrequency": "<string>",
"pledgeTransactionId": "<string>",
"pledgeExpectedFullfillmentDate": "<string>",
"batch": "<string>",
"notes": "<string>",
"segment": "<string>",
"mediaOutlet": "<string>",
"receiptDate": "<string>",
"receiptSegment": "<string>",
"cashAccountingCode": "<string>",
"tribute": "<string>",
"tributeDedication": {
"tributeId": "<integer>",
"tributeType": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"acknowledgeeIndividualId": "<integer>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"acknowledgeeAddress": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeePostal": "<string>",
"acknowledgeeEmail": "<string>",
"acknowledgeePhone": "<string>"
},
"isPrivate": "<boolean>",
"isTaxDeductible": "<boolean>",
"checkNumber": "<string>",
"creditCardType": "<string>",
"nonCashGiftTypeId": "<integer>",
"nonCashGiftType": "<string>",
"nonCashGiftDescription": "<string>",
"stockTickerSymbol": "<string>",
"stockNumberOfShares": "<integer>",
"iraCustodian": "<string>",
"submissionUrl": "<string>",
"designations": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
}
],
"premiums": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
}
],
"customFields": {
"fieldName": "fieldValue",
"fieldName2": "fieldValue2"
},
"customObjects": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"contactIndividualId": "<integer>",
"passthroughContact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": [
"<string>",
"<string>"
]
},
"eventAttendee": {
"eventId": "<integer>",
"eventName": "<string>",
"invited": "<boolean>",
"rsvp": "<boolean>",
"rsvpResponse": "<boolean>",
"attended": "<boolean>"
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactionSource: '<string>',
transactionId: '<string>',
contact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
giftDate: '<string>',
cancelDate: '<string>',
giftType: '<string>',
amount: '<string>',
currencyCode: '<string>',
exchangeRate: '<decimal>',
frequency: '<string>',
recurringGiftTransactionId: '<string>',
recurringGiftTransactionUpdate: '<boolean>',
pledgeFrequency: '<string>',
pledgeTransactionId: '<string>',
pledgeExpectedFullfillmentDate: '<string>',
batch: '<string>',
notes: '<string>',
segment: '<string>',
mediaOutlet: '<string>',
receiptDate: '<string>',
receiptSegment: '<string>',
cashAccountingCode: '<string>',
tribute: '<string>',
tributeDedication: {
tributeId: '<integer>',
tributeType: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
acknowledgeeIndividualId: '<integer>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
acknowledgeeAddress: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeePostal: '<string>',
acknowledgeeEmail: '<string>',
acknowledgeePhone: '<string>'
},
isPrivate: '<boolean>',
isTaxDeductible: '<boolean>',
checkNumber: '<string>',
creditCardType: '<string>',
nonCashGiftTypeId: '<integer>',
nonCashGiftType: '<string>',
nonCashGiftDescription: '<string>',
stockTickerSymbol: '<string>',
stockNumberOfShares: '<integer>',
iraCustodian: '<string>',
submissionUrl: '<string>',
designations: [
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
},
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
}
],
premiums: [
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'},
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'}
],
customFields: {fieldName: 'fieldValue', fieldName2: 'fieldValue2'},
customObjects: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
],
contactIndividualId: '<integer>',
passthroughContact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
eventAttendee: {
eventId: '<integer>',
eventName: '<string>',
invited: '<boolean>',
rsvp: '<boolean>',
rsvpResponse: '<boolean>',
attended: '<boolean>'
}
})
};
fetch('https://api.virtuoussoftware.com/api/v2/Gift/Transaction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/v2/Gift/Transaction"
payload = {
"transactionSource": "<string>",
"transactionId": "<string>",
"contact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": ["<string>", "<string>"]
},
"giftDate": "<string>",
"cancelDate": "<string>",
"giftType": "<string>",
"amount": "<string>",
"currencyCode": "<string>",
"exchangeRate": "<decimal>",
"frequency": "<string>",
"recurringGiftTransactionId": "<string>",
"recurringGiftTransactionUpdate": "<boolean>",
"pledgeFrequency": "<string>",
"pledgeTransactionId": "<string>",
"pledgeExpectedFullfillmentDate": "<string>",
"batch": "<string>",
"notes": "<string>",
"segment": "<string>",
"mediaOutlet": "<string>",
"receiptDate": "<string>",
"receiptSegment": "<string>",
"cashAccountingCode": "<string>",
"tribute": "<string>",
"tributeDedication": {
"tributeId": "<integer>",
"tributeType": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"acknowledgeeIndividualId": "<integer>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"acknowledgeeAddress": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeePostal": "<string>",
"acknowledgeeEmail": "<string>",
"acknowledgeePhone": "<string>"
},
"isPrivate": "<boolean>",
"isTaxDeductible": "<boolean>",
"checkNumber": "<string>",
"creditCardType": "<string>",
"nonCashGiftTypeId": "<integer>",
"nonCashGiftType": "<string>",
"nonCashGiftDescription": "<string>",
"stockTickerSymbol": "<string>",
"stockNumberOfShares": "<integer>",
"iraCustodian": "<string>",
"submissionUrl": "<string>",
"designations": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"amountDesignated": "<string>"
}
],
"premiums": [
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
},
{
"id": "<integer>",
"name": "<string>",
"code": "<string>",
"quantity": "<string>"
}
],
"customFields": {
"fieldName": "fieldValue",
"fieldName2": "fieldValue2"
},
"customObjects": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"contactIndividualId": "<integer>",
"passthroughContact": {
"referenceId": "<string>",
"id": "<integer>",
"name": "<string>",
"type": "<string>",
"title": "<string>",
"firstname": "<string>",
"middlename": "<string>",
"lastname": "<string>",
"suffix": "<string>",
"birthMonth": "<string>",
"birthDay": "<string>",
"birthYear": "<string>",
"gender": "<string>",
"emailType": "<string>",
"email": "<string>",
"phoneType": "<string>",
"phone": "<string>",
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"country": "<string>"
},
"tags": "<string>",
"emailLists": ["<string>", "<string>"]
},
"eventAttendee": {
"eventId": "<integer>",
"eventName": "<string>",
"invited": "<boolean>",
"rsvp": "<boolean>",
"rsvpResponse": "<boolean>",
"attended": "<boolean>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/v2/Gift/Transaction");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"transactionSource\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"contact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"giftDate\": \"<string>\",\n \"cancelDate\": \"<string>\",\n \"giftType\": \"<string>\",\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"exchangeRate\": \"<decimal>\",\n \"frequency\": \"<string>\",\n \"recurringGiftTransactionId\": \"<string>\",\n \"recurringGiftTransactionUpdate\": \"<boolean>\",\n \"pledgeFrequency\": \"<string>\",\n \"pledgeTransactionId\": \"<string>\",\n \"pledgeExpectedFullfillmentDate\": \"<string>\",\n \"batch\": \"<string>\",\n \"notes\": \"<string>\",\n \"segment\": \"<string>\",\n \"mediaOutlet\": \"<string>\",\n \"receiptDate\": \"<string>\",\n \"receiptSegment\": \"<string>\",\n \"cashAccountingCode\": \"<string>\",\n \"tribute\": \"<string>\",\n \"tributeDedication\": {\n \"tributeId\": \"<integer>\",\n \"tributeType\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"acknowledgeeIndividualId\": \"<integer>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"acknowledgeeAddress\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"acknowledgeeEmail\": \"<string>\",\n \"acknowledgeePhone\": \"<string>\"\n },\n \"isPrivate\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"checkNumber\": \"<string>\",\n \"creditCardType\": \"<string>\",\n \"nonCashGiftTypeId\": \"<integer>\",\n \"nonCashGiftType\": \"<string>\",\n \"nonCashGiftDescription\": \"<string>\",\n \"stockTickerSymbol\": \"<string>\",\n \"stockNumberOfShares\": \"<integer>\",\n \"iraCustodian\": \"<string>\",\n \"submissionUrl\": \"<string>\",\n \"designations\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n }\n ],\n \"premiums\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"customFields\": {\n \"fieldName\": \"fieldValue\",\n \"fieldName2\": \"fieldValue2\"\n },\n \"customObjects\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"contactIndividualId\": \"<integer>\",\n \"passthroughContact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"eventAttendee\": {\n \"eventId\": \"<integer>\",\n \"eventName\": \"<string>\",\n \"invited\": \"<boolean>\",\n \"rsvp\": \"<boolean>\",\n \"rsvpResponse\": \"<boolean>\",\n \"attended\": \"<boolean>\"\n }\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/v2/Gift/Transaction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'transactionSource' => '<string>',
'transactionId' => '<string>',
'contact' => [
'referenceId' => '<string>',
'id' => '<integer>',
'name' => '<string>',
'type' => '<string>',
'title' => '<string>',
'firstname' => '<string>',
'middlename' => '<string>',
'lastname' => '<string>',
'suffix' => '<string>',
'birthMonth' => '<string>',
'birthDay' => '<string>',
'birthYear' => '<string>',
'gender' => '<string>',
'emailType' => '<string>',
'email' => '<string>',
'phoneType' => '<string>',
'phone' => '<string>',
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'country' => '<string>'
],
'tags' => '<string>',
'emailLists' => [
'<string>',
'<string>'
]
],
'giftDate' => '<string>',
'cancelDate' => '<string>',
'giftType' => '<string>',
'amount' => '<string>',
'currencyCode' => '<string>',
'exchangeRate' => '<decimal>',
'frequency' => '<string>',
'recurringGiftTransactionId' => '<string>',
'recurringGiftTransactionUpdate' => '<boolean>',
'pledgeFrequency' => '<string>',
'pledgeTransactionId' => '<string>',
'pledgeExpectedFullfillmentDate' => '<string>',
'batch' => '<string>',
'notes' => '<string>',
'segment' => '<string>',
'mediaOutlet' => '<string>',
'receiptDate' => '<string>',
'receiptSegment' => '<string>',
'cashAccountingCode' => '<string>',
'tribute' => '<string>',
'tributeDedication' => [
'tributeId' => '<integer>',
'tributeType' => '<string>',
'tributeFirstName' => '<string>',
'tributeLastName' => '<string>',
'tributeCity' => '<string>',
'tributeState' => '<string>',
'acknowledgeeIndividualId' => '<integer>',
'acknowledgeeFirstName' => '<string>',
'acknowledgeeLastName' => '<string>',
'acknowledgeeAddress' => '<string>',
'acknowledgeeCity' => '<string>',
'acknowledgeeState' => '<string>',
'acknowledgeePostal' => '<string>',
'acknowledgeeEmail' => '<string>',
'acknowledgeePhone' => '<string>'
],
'isPrivate' => '<boolean>',
'isTaxDeductible' => '<boolean>',
'checkNumber' => '<string>',
'creditCardType' => '<string>',
'nonCashGiftTypeId' => '<integer>',
'nonCashGiftType' => '<string>',
'nonCashGiftDescription' => '<string>',
'stockTickerSymbol' => '<string>',
'stockNumberOfShares' => '<integer>',
'iraCustodian' => '<string>',
'submissionUrl' => '<string>',
'designations' => [
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'amountDesignated' => '<string>'
],
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'amountDesignated' => '<string>'
]
],
'premiums' => [
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'quantity' => '<string>'
],
[
'id' => '<integer>',
'name' => '<string>',
'code' => '<string>',
'quantity' => '<string>'
]
],
'customFields' => [
'fieldName' => 'fieldValue',
'fieldName2' => 'fieldValue2'
],
'customObjects' => [
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
],
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
]
],
'contactIndividualId' => '<integer>',
'passthroughContact' => [
'referenceId' => '<string>',
'id' => '<integer>',
'name' => '<string>',
'type' => '<string>',
'title' => '<string>',
'firstname' => '<string>',
'middlename' => '<string>',
'lastname' => '<string>',
'suffix' => '<string>',
'birthMonth' => '<string>',
'birthDay' => '<string>',
'birthYear' => '<string>',
'gender' => '<string>',
'emailType' => '<string>',
'email' => '<string>',
'phoneType' => '<string>',
'phone' => '<string>',
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'country' => '<string>'
],
'tags' => '<string>',
'emailLists' => [
'<string>',
'<string>'
]
],
'eventAttendee' => [
'eventId' => '<integer>',
'eventName' => '<string>',
'invited' => '<boolean>',
'rsvp' => '<boolean>',
'rsvpResponse' => '<boolean>',
'attended' => '<boolean>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/v2/Gift/Transaction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"transactionSource\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"contact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"giftDate\": \"<string>\",\n \"cancelDate\": \"<string>\",\n \"giftType\": \"<string>\",\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"exchangeRate\": \"<decimal>\",\n \"frequency\": \"<string>\",\n \"recurringGiftTransactionId\": \"<string>\",\n \"recurringGiftTransactionUpdate\": \"<boolean>\",\n \"pledgeFrequency\": \"<string>\",\n \"pledgeTransactionId\": \"<string>\",\n \"pledgeExpectedFullfillmentDate\": \"<string>\",\n \"batch\": \"<string>\",\n \"notes\": \"<string>\",\n \"segment\": \"<string>\",\n \"mediaOutlet\": \"<string>\",\n \"receiptDate\": \"<string>\",\n \"receiptSegment\": \"<string>\",\n \"cashAccountingCode\": \"<string>\",\n \"tribute\": \"<string>\",\n \"tributeDedication\": {\n \"tributeId\": \"<integer>\",\n \"tributeType\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"acknowledgeeIndividualId\": \"<integer>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"acknowledgeeAddress\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"acknowledgeeEmail\": \"<string>\",\n \"acknowledgeePhone\": \"<string>\"\n },\n \"isPrivate\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"checkNumber\": \"<string>\",\n \"creditCardType\": \"<string>\",\n \"nonCashGiftTypeId\": \"<integer>\",\n \"nonCashGiftType\": \"<string>\",\n \"nonCashGiftDescription\": \"<string>\",\n \"stockTickerSymbol\": \"<string>\",\n \"stockNumberOfShares\": \"<integer>\",\n \"iraCustodian\": \"<string>\",\n \"submissionUrl\": \"<string>\",\n \"designations\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n }\n ],\n \"premiums\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"customFields\": {\n \"fieldName\": \"fieldValue\",\n \"fieldName2\": \"fieldValue2\"\n },\n \"customObjects\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"contactIndividualId\": \"<integer>\",\n \"passthroughContact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"eventAttendee\": {\n \"eventId\": \"<integer>\",\n \"eventName\": \"<string>\",\n \"invited\": \"<boolean>\",\n \"rsvp\": \"<boolean>\",\n \"rsvpResponse\": \"<boolean>\",\n \"attended\": \"<boolean>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/v2/Gift/Transaction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transactionSource\": \"<string>\",\n \"transactionId\": \"<string>\",\n \"contact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"giftDate\": \"<string>\",\n \"cancelDate\": \"<string>\",\n \"giftType\": \"<string>\",\n \"amount\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"exchangeRate\": \"<decimal>\",\n \"frequency\": \"<string>\",\n \"recurringGiftTransactionId\": \"<string>\",\n \"recurringGiftTransactionUpdate\": \"<boolean>\",\n \"pledgeFrequency\": \"<string>\",\n \"pledgeTransactionId\": \"<string>\",\n \"pledgeExpectedFullfillmentDate\": \"<string>\",\n \"batch\": \"<string>\",\n \"notes\": \"<string>\",\n \"segment\": \"<string>\",\n \"mediaOutlet\": \"<string>\",\n \"receiptDate\": \"<string>\",\n \"receiptSegment\": \"<string>\",\n \"cashAccountingCode\": \"<string>\",\n \"tribute\": \"<string>\",\n \"tributeDedication\": {\n \"tributeId\": \"<integer>\",\n \"tributeType\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"acknowledgeeIndividualId\": \"<integer>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"acknowledgeeAddress\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"acknowledgeeEmail\": \"<string>\",\n \"acknowledgeePhone\": \"<string>\"\n },\n \"isPrivate\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"checkNumber\": \"<string>\",\n \"creditCardType\": \"<string>\",\n \"nonCashGiftTypeId\": \"<integer>\",\n \"nonCashGiftType\": \"<string>\",\n \"nonCashGiftDescription\": \"<string>\",\n \"stockTickerSymbol\": \"<string>\",\n \"stockNumberOfShares\": \"<integer>\",\n \"iraCustodian\": \"<string>\",\n \"submissionUrl\": \"<string>\",\n \"designations\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"amountDesignated\": \"<string>\"\n }\n ],\n \"premiums\": [\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"code\": \"<string>\",\n \"quantity\": \"<string>\"\n }\n ],\n \"customFields\": {\n \"fieldName\": \"fieldValue\",\n \"fieldName2\": \"fieldValue2\"\n },\n \"customObjects\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"contactIndividualId\": \"<integer>\",\n \"passthroughContact\": {\n \"referenceId\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"firstname\": \"<string>\",\n \"middlename\": \"<string>\",\n \"lastname\": \"<string>\",\n \"suffix\": \"<string>\",\n \"birthMonth\": \"<string>\",\n \"birthDay\": \"<string>\",\n \"birthYear\": \"<string>\",\n \"gender\": \"<string>\",\n \"emailType\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneType\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"tags\": \"<string>\",\n \"emailLists\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"eventAttendee\": {\n \"eventId\": \"<integer>\",\n \"eventName\": \"<string>\",\n \"invited\": \"<boolean>\",\n \"rsvp\": \"<boolean>\",\n \"rsvpResponse\": \"<boolean>\",\n \"attended\": \"<boolean>\"\n }\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/v2/Gift/Transaction';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactionSource: '<string>',
transactionId: '<string>',
contact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
giftDate: '<string>',
cancelDate: '<string>',
giftType: '<string>',
amount: '<string>',
currencyCode: '<string>',
exchangeRate: '<decimal>',
frequency: '<string>',
recurringGiftTransactionId: '<string>',
recurringGiftTransactionUpdate: '<boolean>',
pledgeFrequency: '<string>',
pledgeTransactionId: '<string>',
pledgeExpectedFullfillmentDate: '<string>',
batch: '<string>',
notes: '<string>',
segment: '<string>',
mediaOutlet: '<string>',
receiptDate: '<string>',
receiptSegment: '<string>',
cashAccountingCode: '<string>',
tribute: '<string>',
tributeDedication: {
tributeId: '<integer>',
tributeType: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
acknowledgeeIndividualId: '<integer>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
acknowledgeeAddress: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeePostal: '<string>',
acknowledgeeEmail: '<string>',
acknowledgeePhone: '<string>'
},
isPrivate: '<boolean>',
isTaxDeductible: '<boolean>',
checkNumber: '<string>',
creditCardType: '<string>',
nonCashGiftTypeId: '<integer>',
nonCashGiftType: '<string>',
nonCashGiftDescription: '<string>',
stockTickerSymbol: '<string>',
stockNumberOfShares: '<integer>',
iraCustodian: '<string>',
submissionUrl: '<string>',
designations: [
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
},
{
id: '<integer>',
name: '<string>',
code: '<string>',
amountDesignated: '<string>'
}
],
premiums: [
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'},
{id: '<integer>', name: '<string>', code: '<string>', quantity: '<string>'}
],
customFields: {fieldName: 'fieldValue', fieldName2: 'fieldValue2'},
customObjects: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
],
contactIndividualId: '<integer>',
passthroughContact: {
referenceId: '<string>',
id: '<integer>',
name: '<string>',
type: '<string>',
title: '<string>',
firstname: '<string>',
middlename: '<string>',
lastname: '<string>',
suffix: '<string>',
birthMonth: '<string>',
birthDay: '<string>',
birthYear: '<string>',
gender: '<string>',
emailType: '<string>',
email: '<string>',
phoneType: '<string>',
phone: '<string>',
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
country: '<string>'
},
tags: '<string>',
emailLists: ['<string>', '<string>']
},
eventAttendee: {
eventId: '<integer>',
eventName: '<string>',
invited: '<boolean>',
rsvp: '<boolean>',
rsvpResponse: '<boolean>',
attended: '<boolean>'
}
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The name of the external system the record came from, for example Stripe or Classy. Paired with transactionId to keep imports idempotent.
The identifier of this transaction in the source system. A repeated transactionSource and transactionId pair is treated as the same transaction and is not imported twice.
The donor for the transaction. An existing contact is matched, or a new one is created.
Show child attributes
Show child attributes
The date the gift was received.
The type of gift, for example Cash, Credit, Check, Stock, or Other. Must match a gift type configured for the organization.
The monetary amount of the gift.
The ISO 4217 code of the currency the gift was given in, for example USD.
The rate used to convert the gift amount into the organization base currency.
How often the payment recurs, for example Monthly, Quarterly, or Annually.
The batch name used to group this gift with others for reconciliation.
Free-text notes stored on the record.
The date the gift was receipted. Leave empty for gifts that have not been receipted.
The accounting code the gift revenue is posted to.
Show child attributes
Show child attributes
When true, the record is only visible to users with permission to view private records.
When true, the gift is treated as tax deductible.
The check number, for gifts given by check.
The card brand, for gifts given by credit card.
How the amount is split across projects. The designated amounts must add up to the total amount.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Custom field values to set on the record. Field names must match custom fields configured for the organization.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The identifier of the contact individual this record belongs to.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
Last modified on August 11, 2026
Was this page helpful?
⌘I