Create a Project
curl --request POST \
--url https://api.virtuoussoftware.com/api/Project \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"revenueAccountingCode": "<string>",
"inventoryStatus": "<string>",
"type": "<string>",
"location": "<string>",
"onlineDisplayName": "<string>",
"description": "<string>",
"externalAccountingCode": "<string>",
"durationType": "<string>",
"startDate": "<dateTime>",
"endDate": "<dateTime>",
"financialNeedAmount": "<double>",
"financialNeedType": "<string>",
"financialNeedFrequency": "<string>",
"isPublic": "<boolean>",
"isActive": "<boolean>",
"isAvailableOnline": "<boolean>",
"isLimitedToFinancialNeed": "<boolean>",
"isTaxDeductible": "<boolean>",
"treatAsAccountsPayable": "<boolean>",
"isRestrictedToGiftSpecifications": "<boolean>",
"parentId": "<integer>",
"beginningBalance": "<double>",
"currentBalance": "<double>",
"enableSync": "<boolean>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
revenueAccountingCode: '<string>',
inventoryStatus: '<string>',
type: '<string>',
location: '<string>',
onlineDisplayName: '<string>',
description: '<string>',
externalAccountingCode: '<string>',
durationType: '<string>',
startDate: '<dateTime>',
endDate: '<dateTime>',
financialNeedAmount: '<double>',
financialNeedType: '<string>',
financialNeedFrequency: '<string>',
isPublic: '<boolean>',
isActive: '<boolean>',
isAvailableOnline: '<boolean>',
isLimitedToFinancialNeed: '<boolean>',
isTaxDeductible: '<boolean>',
treatAsAccountsPayable: '<boolean>',
isRestrictedToGiftSpecifications: '<boolean>',
parentId: '<integer>',
beginningBalance: '<double>',
currentBalance: '<double>',
enableSync: '<boolean>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/Project', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Project"
payload = {
"name": "<string>",
"revenueAccountingCode": "<string>",
"inventoryStatus": "<string>",
"type": "<string>",
"location": "<string>",
"onlineDisplayName": "<string>",
"description": "<string>",
"externalAccountingCode": "<string>",
"durationType": "<string>",
"startDate": "<dateTime>",
"endDate": "<dateTime>",
"financialNeedAmount": "<double>",
"financialNeedType": "<string>",
"financialNeedFrequency": "<string>",
"isPublic": "<boolean>",
"isActive": "<boolean>",
"isAvailableOnline": "<boolean>",
"isLimitedToFinancialNeed": "<boolean>",
"isTaxDeductible": "<boolean>",
"treatAsAccountsPayable": "<boolean>",
"isRestrictedToGiftSpecifications": "<boolean>",
"parentId": "<integer>",
"beginningBalance": "<double>",
"currentBalance": "<double>",
"enableSync": "<boolean>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
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/Project");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"revenueAccountingCode\": \"<string>\",\n \"inventoryStatus\": \"<string>\",\n \"type\": \"<string>\",\n \"location\": \"<string>\",\n \"onlineDisplayName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalAccountingCode\": \"<string>\",\n \"durationType\": \"<string>\",\n \"startDate\": \"<dateTime>\",\n \"endDate\": \"<dateTime>\",\n \"financialNeedAmount\": \"<double>\",\n \"financialNeedType\": \"<string>\",\n \"financialNeedFrequency\": \"<string>\",\n \"isPublic\": \"<boolean>\",\n \"isActive\": \"<boolean>\",\n \"isAvailableOnline\": \"<boolean>\",\n \"isLimitedToFinancialNeed\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"treatAsAccountsPayable\": \"<boolean>\",\n \"isRestrictedToGiftSpecifications\": \"<boolean>\",\n \"parentId\": \"<integer>\",\n \"beginningBalance\": \"<double>\",\n \"currentBalance\": \"<double>\",\n \"enableSync\": \"<boolean>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\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/Project",
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([
'name' => '<string>',
'revenueAccountingCode' => '<string>',
'inventoryStatus' => '<string>',
'type' => '<string>',
'location' => '<string>',
'onlineDisplayName' => '<string>',
'description' => '<string>',
'externalAccountingCode' => '<string>',
'durationType' => '<string>',
'startDate' => '<dateTime>',
'endDate' => '<dateTime>',
'financialNeedAmount' => '<double>',
'financialNeedType' => '<string>',
'financialNeedFrequency' => '<string>',
'isPublic' => '<boolean>',
'isActive' => '<boolean>',
'isAvailableOnline' => '<boolean>',
'isLimitedToFinancialNeed' => '<boolean>',
'isTaxDeductible' => '<boolean>',
'treatAsAccountsPayable' => '<boolean>',
'isRestrictedToGiftSpecifications' => '<boolean>',
'parentId' => '<integer>',
'beginningBalance' => '<double>',
'currentBalance' => '<double>',
'enableSync' => '<boolean>',
'customFields' => [
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
]
]
]),
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/Project")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"revenueAccountingCode\": \"<string>\",\n \"inventoryStatus\": \"<string>\",\n \"type\": \"<string>\",\n \"location\": \"<string>\",\n \"onlineDisplayName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalAccountingCode\": \"<string>\",\n \"durationType\": \"<string>\",\n \"startDate\": \"<dateTime>\",\n \"endDate\": \"<dateTime>\",\n \"financialNeedAmount\": \"<double>\",\n \"financialNeedType\": \"<string>\",\n \"financialNeedFrequency\": \"<string>\",\n \"isPublic\": \"<boolean>\",\n \"isActive\": \"<boolean>\",\n \"isAvailableOnline\": \"<boolean>\",\n \"isLimitedToFinancialNeed\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"treatAsAccountsPayable\": \"<boolean>\",\n \"isRestrictedToGiftSpecifications\": \"<boolean>\",\n \"parentId\": \"<integer>\",\n \"beginningBalance\": \"<double>\",\n \"currentBalance\": \"<double>\",\n \"enableSync\": \"<boolean>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Project")
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 \"name\": \"<string>\",\n \"revenueAccountingCode\": \"<string>\",\n \"inventoryStatus\": \"<string>\",\n \"type\": \"<string>\",\n \"location\": \"<string>\",\n \"onlineDisplayName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalAccountingCode\": \"<string>\",\n \"durationType\": \"<string>\",\n \"startDate\": \"<dateTime>\",\n \"endDate\": \"<dateTime>\",\n \"financialNeedAmount\": \"<double>\",\n \"financialNeedType\": \"<string>\",\n \"financialNeedFrequency\": \"<string>\",\n \"isPublic\": \"<boolean>\",\n \"isActive\": \"<boolean>\",\n \"isAvailableOnline\": \"<boolean>\",\n \"isLimitedToFinancialNeed\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"treatAsAccountsPayable\": \"<boolean>\",\n \"isRestrictedToGiftSpecifications\": \"<boolean>\",\n \"parentId\": \"<integer>\",\n \"beginningBalance\": \"<double>\",\n \"currentBalance\": \"<double>\",\n \"enableSync\": \"<boolean>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Project';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
revenueAccountingCode: '<string>',
inventoryStatus: '<string>',
type: '<string>',
location: '<string>',
onlineDisplayName: '<string>',
description: '<string>',
externalAccountingCode: '<string>',
durationType: '<string>',
startDate: '<dateTime>',
endDate: '<dateTime>',
financialNeedAmount: '<double>',
financialNeedType: '<string>',
financialNeedFrequency: '<string>',
isPublic: '<boolean>',
isActive: '<boolean>',
isAvailableOnline: '<boolean>',
isLimitedToFinancialNeed: '<boolean>',
isTaxDeductible: '<boolean>',
treatAsAccountsPayable: '<boolean>',
isRestrictedToGiftSpecifications: '<boolean>',
parentId: '<integer>',
beginningBalance: '<double>',
currentBalance: '<double>',
enableSync: '<boolean>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 1501,
"name": "Holiday Meals 2025",
"projectCode": "HM-2025",
"externalAccountingCode": "4100",
"onlineDisplayName": "Holiday Meals 2025",
"description": "Holiday food distribution to 500 families across the metro region.",
"photoUrl": "https://cdn.virtuoussoftware.com/projects/1501-cover.jpg",
"parentId": null,
"parentName": null,
"isSubProject": false,
"inventoryStatus": "None",
"type": "Program",
"location": "Springfield, OR",
"isRestrictedToGiftSpecifications": false,
"isLimitedToFinancialNeed": false,
"isPublic": true,
"isActive": true,
"isAvailableOnline": true,
"isTaxDeductible": true,
"treatAsAccountsPayable": false,
"beginningBalance": 0,
"currentBalance": 18420,
"financialNeedType": "Fixed",
"financialNeedFrequency": "OneTime",
"financialNeedAmount": 50000,
"startDate": "2025-09-01T00:00:00Z",
"endDate": "2025-12-31T00:00:00Z",
"durationType": "Fixed",
"lifeToDateGiving": 18420,
"lifeToDateGiftCount": 142,
"lifeToDateGiversCount": 128,
"lifeToDateExpenseTotal": 6200,
"calendarYearToDateGiving": 18420,
"calendarYearToDateGiftCount": 142,
"calendarYearToDateGiversCount": 128,
"calendarYearToDateExpenseTotal": 6200,
"createDateTimeUtc": "2025-09-01T08:00:00Z",
"createdByUser": "Development Team",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"giftSpecifications": [
{
"amount": 50,
"frequency": "OneTime"
},
{
"amount": 100,
"frequency": "OneTime"
}
],
"customFields": {}
}{
"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."
}How to Create and Update Projects
Create a Project
POST
/
api
/
Project
Create a Project
curl --request POST \
--url https://api.virtuoussoftware.com/api/Project \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"revenueAccountingCode": "<string>",
"inventoryStatus": "<string>",
"type": "<string>",
"location": "<string>",
"onlineDisplayName": "<string>",
"description": "<string>",
"externalAccountingCode": "<string>",
"durationType": "<string>",
"startDate": "<dateTime>",
"endDate": "<dateTime>",
"financialNeedAmount": "<double>",
"financialNeedType": "<string>",
"financialNeedFrequency": "<string>",
"isPublic": "<boolean>",
"isActive": "<boolean>",
"isAvailableOnline": "<boolean>",
"isLimitedToFinancialNeed": "<boolean>",
"isTaxDeductible": "<boolean>",
"treatAsAccountsPayable": "<boolean>",
"isRestrictedToGiftSpecifications": "<boolean>",
"parentId": "<integer>",
"beginningBalance": "<double>",
"currentBalance": "<double>",
"enableSync": "<boolean>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
revenueAccountingCode: '<string>',
inventoryStatus: '<string>',
type: '<string>',
location: '<string>',
onlineDisplayName: '<string>',
description: '<string>',
externalAccountingCode: '<string>',
durationType: '<string>',
startDate: '<dateTime>',
endDate: '<dateTime>',
financialNeedAmount: '<double>',
financialNeedType: '<string>',
financialNeedFrequency: '<string>',
isPublic: '<boolean>',
isActive: '<boolean>',
isAvailableOnline: '<boolean>',
isLimitedToFinancialNeed: '<boolean>',
isTaxDeductible: '<boolean>',
treatAsAccountsPayable: '<boolean>',
isRestrictedToGiftSpecifications: '<boolean>',
parentId: '<integer>',
beginningBalance: '<double>',
currentBalance: '<double>',
enableSync: '<boolean>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch('https://api.virtuoussoftware.com/api/Project', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Project"
payload = {
"name": "<string>",
"revenueAccountingCode": "<string>",
"inventoryStatus": "<string>",
"type": "<string>",
"location": "<string>",
"onlineDisplayName": "<string>",
"description": "<string>",
"externalAccountingCode": "<string>",
"durationType": "<string>",
"startDate": "<dateTime>",
"endDate": "<dateTime>",
"financialNeedAmount": "<double>",
"financialNeedType": "<string>",
"financialNeedFrequency": "<string>",
"isPublic": "<boolean>",
"isActive": "<boolean>",
"isAvailableOnline": "<boolean>",
"isLimitedToFinancialNeed": "<boolean>",
"isTaxDeductible": "<boolean>",
"treatAsAccountsPayable": "<boolean>",
"isRestrictedToGiftSpecifications": "<boolean>",
"parentId": "<integer>",
"beginningBalance": "<double>",
"currentBalance": "<double>",
"enableSync": "<boolean>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
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/Project");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"name\": \"<string>\",\n \"revenueAccountingCode\": \"<string>\",\n \"inventoryStatus\": \"<string>\",\n \"type\": \"<string>\",\n \"location\": \"<string>\",\n \"onlineDisplayName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalAccountingCode\": \"<string>\",\n \"durationType\": \"<string>\",\n \"startDate\": \"<dateTime>\",\n \"endDate\": \"<dateTime>\",\n \"financialNeedAmount\": \"<double>\",\n \"financialNeedType\": \"<string>\",\n \"financialNeedFrequency\": \"<string>\",\n \"isPublic\": \"<boolean>\",\n \"isActive\": \"<boolean>\",\n \"isAvailableOnline\": \"<boolean>\",\n \"isLimitedToFinancialNeed\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"treatAsAccountsPayable\": \"<boolean>\",\n \"isRestrictedToGiftSpecifications\": \"<boolean>\",\n \"parentId\": \"<integer>\",\n \"beginningBalance\": \"<double>\",\n \"currentBalance\": \"<double>\",\n \"enableSync\": \"<boolean>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\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/Project",
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([
'name' => '<string>',
'revenueAccountingCode' => '<string>',
'inventoryStatus' => '<string>',
'type' => '<string>',
'location' => '<string>',
'onlineDisplayName' => '<string>',
'description' => '<string>',
'externalAccountingCode' => '<string>',
'durationType' => '<string>',
'startDate' => '<dateTime>',
'endDate' => '<dateTime>',
'financialNeedAmount' => '<double>',
'financialNeedType' => '<string>',
'financialNeedFrequency' => '<string>',
'isPublic' => '<boolean>',
'isActive' => '<boolean>',
'isAvailableOnline' => '<boolean>',
'isLimitedToFinancialNeed' => '<boolean>',
'isTaxDeductible' => '<boolean>',
'treatAsAccountsPayable' => '<boolean>',
'isRestrictedToGiftSpecifications' => '<boolean>',
'parentId' => '<integer>',
'beginningBalance' => '<double>',
'currentBalance' => '<double>',
'enableSync' => '<boolean>',
'customFields' => [
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
]
]
]),
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/Project")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"revenueAccountingCode\": \"<string>\",\n \"inventoryStatus\": \"<string>\",\n \"type\": \"<string>\",\n \"location\": \"<string>\",\n \"onlineDisplayName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalAccountingCode\": \"<string>\",\n \"durationType\": \"<string>\",\n \"startDate\": \"<dateTime>\",\n \"endDate\": \"<dateTime>\",\n \"financialNeedAmount\": \"<double>\",\n \"financialNeedType\": \"<string>\",\n \"financialNeedFrequency\": \"<string>\",\n \"isPublic\": \"<boolean>\",\n \"isActive\": \"<boolean>\",\n \"isAvailableOnline\": \"<boolean>\",\n \"isLimitedToFinancialNeed\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"treatAsAccountsPayable\": \"<boolean>\",\n \"isRestrictedToGiftSpecifications\": \"<boolean>\",\n \"parentId\": \"<integer>\",\n \"beginningBalance\": \"<double>\",\n \"currentBalance\": \"<double>\",\n \"enableSync\": \"<boolean>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Project")
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 \"name\": \"<string>\",\n \"revenueAccountingCode\": \"<string>\",\n \"inventoryStatus\": \"<string>\",\n \"type\": \"<string>\",\n \"location\": \"<string>\",\n \"onlineDisplayName\": \"<string>\",\n \"description\": \"<string>\",\n \"externalAccountingCode\": \"<string>\",\n \"durationType\": \"<string>\",\n \"startDate\": \"<dateTime>\",\n \"endDate\": \"<dateTime>\",\n \"financialNeedAmount\": \"<double>\",\n \"financialNeedType\": \"<string>\",\n \"financialNeedFrequency\": \"<string>\",\n \"isPublic\": \"<boolean>\",\n \"isActive\": \"<boolean>\",\n \"isAvailableOnline\": \"<boolean>\",\n \"isLimitedToFinancialNeed\": \"<boolean>\",\n \"isTaxDeductible\": \"<boolean>\",\n \"treatAsAccountsPayable\": \"<boolean>\",\n \"isRestrictedToGiftSpecifications\": \"<boolean>\",\n \"parentId\": \"<integer>\",\n \"beginningBalance\": \"<double>\",\n \"currentBalance\": \"<double>\",\n \"enableSync\": \"<boolean>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Project';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
revenueAccountingCode: '<string>',
inventoryStatus: '<string>',
type: '<string>',
location: '<string>',
onlineDisplayName: '<string>',
description: '<string>',
externalAccountingCode: '<string>',
durationType: '<string>',
startDate: '<dateTime>',
endDate: '<dateTime>',
financialNeedAmount: '<double>',
financialNeedType: '<string>',
financialNeedFrequency: '<string>',
isPublic: '<boolean>',
isActive: '<boolean>',
isAvailableOnline: '<boolean>',
isLimitedToFinancialNeed: '<boolean>',
isTaxDeductible: '<boolean>',
treatAsAccountsPayable: '<boolean>',
isRestrictedToGiftSpecifications: '<boolean>',
parentId: '<integer>',
beginningBalance: '<double>',
currentBalance: '<double>',
enableSync: '<boolean>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 1501,
"name": "Holiday Meals 2025",
"projectCode": "HM-2025",
"externalAccountingCode": "4100",
"onlineDisplayName": "Holiday Meals 2025",
"description": "Holiday food distribution to 500 families across the metro region.",
"photoUrl": "https://cdn.virtuoussoftware.com/projects/1501-cover.jpg",
"parentId": null,
"parentName": null,
"isSubProject": false,
"inventoryStatus": "None",
"type": "Program",
"location": "Springfield, OR",
"isRestrictedToGiftSpecifications": false,
"isLimitedToFinancialNeed": false,
"isPublic": true,
"isActive": true,
"isAvailableOnline": true,
"isTaxDeductible": true,
"treatAsAccountsPayable": false,
"beginningBalance": 0,
"currentBalance": 18420,
"financialNeedType": "Fixed",
"financialNeedFrequency": "OneTime",
"financialNeedAmount": 50000,
"startDate": "2025-09-01T00:00:00Z",
"endDate": "2025-12-31T00:00:00Z",
"durationType": "Fixed",
"lifeToDateGiving": 18420,
"lifeToDateGiftCount": 142,
"lifeToDateGiversCount": 128,
"lifeToDateExpenseTotal": 6200,
"calendarYearToDateGiving": 18420,
"calendarYearToDateGiftCount": 142,
"calendarYearToDateGiversCount": 128,
"calendarYearToDateExpenseTotal": 6200,
"createDateTimeUtc": "2025-09-01T08:00:00Z",
"createdByUser": "Development Team",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"giftSpecifications": [
{
"amount": 50,
"frequency": "OneTime"
},
{
"amount": 100,
"frequency": "OneTime"
}
],
"customFields": {}
}{
"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.
Query Parameters
Optional webhook owner type to exclude when updating object
Body
application/json
The internal name of the project.
The accounting code project revenue is posted to.
The inventory status of the project.
The project type. Must match a project type configured for the organization.
The location associated with the project.
The project name shown to donors online.
A free-text description of the record.
The code that identifies this project in the accounting system.
Whether the project runs for a fixed period or is ongoing.
The date the project starts.
The date the project ends.
The funding goal for the project.
How the funding goal is measured.
How often the funding goal resets.
When true, the project is visible outside the organization.
When true, the record is active and available for use.
When true, the project can be selected on online giving forms.
When true, the project stops accepting gifts once the funding goal is met.
When true, the gift is treated as tax deductible.
When true, amounts designated to the project are treated as a liability rather than revenue.
When true, gifts to the project must match a configured gift specification.
The identifier of the parent project, for a sub project.
The project balance at the start of the reporting period.
The current project balance.
When true, the project is synced with the accounting system.
Custom field values to set on the record. Field names must match custom fields configured for the organization.
Show child attributes
Show child attributes
Response
OK
The unique identifier of the record in Virtuous.
The display name of the record.
The free-text description stored on the record.
The total amount the contact has given since the first gift.
The UTC date and time the record was created.
The name of the user who created the record.
The UTC date and time the record was last modified.
The name of the user who last modified the record.
Show child attributes
Show child attributes
The custom field values stored on the record.
Last modified on April 23, 2026
Was this page helpful?
⌘I