List Gifts by Reference ID
curl --request GET \
--url https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"list": [
{
"giftDesignations": [
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
},
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
}
],
"id": "<integer>",
"contactId": "<integer>",
"contactIndividualId": "<integer>",
"giftType": "<string>",
"giftDate": "<string>",
"amount": "<string>",
"segment": "<string>",
"batch": "<string>",
"giftUrl": "<string>",
"culture": "<string>",
"exchangeRate": "<double>"
},
{
"giftDesignations": [
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
},
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
}
],
"id": "<integer>",
"contactId": "<integer>",
"contactIndividualId": "<integer>",
"giftType": "<string>",
"giftDate": "<string>",
"amount": "<string>",
"segment": "<string>",
"batch": "<string>",
"giftUrl": "<string>",
"culture": "<string>",
"exchangeRate": "<double>"
}
],
"total": "<integer>"
}{
"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
List Gifts by Reference ID
Returns the gifts recorded against the given reference id from an external system, so you can reconcile what has already been imported. HMAC Auth only. Use skip and take to page through the results.
GET
/
api
/
Gift
/
ByReference
/
{referenceId}
List Gifts by Reference ID
curl --request GET \
--url https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.get("https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Gift/ByReference/{referenceId}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"list": [
{
"giftDesignations": [
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
},
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
}
],
"id": "<integer>",
"contactId": "<integer>",
"contactIndividualId": "<integer>",
"giftType": "<string>",
"giftDate": "<string>",
"amount": "<string>",
"segment": "<string>",
"batch": "<string>",
"giftUrl": "<string>",
"culture": "<string>",
"exchangeRate": "<double>"
},
{
"giftDesignations": [
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
},
{
"id": "<integer>",
"projectId": "<integer>",
"project": "<string>",
"projectCode": "<string>",
"externalAccountingCode": "<string>",
"projectType": "<string>",
"projectLocation": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"display": "<string>"
}
],
"id": "<integer>",
"contactId": "<integer>",
"contactIndividualId": "<integer>",
"giftType": "<string>",
"giftDate": "<string>",
"amount": "<string>",
"segment": "<string>",
"batch": "<string>",
"giftUrl": "<string>",
"culture": "<string>",
"exchangeRate": "<double>"
}
],
"total": "<integer>"
}{
"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
Query Parameters
Was this page helpful?