GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.orgRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/fundraisingcampaigns/{fundraisingcampaignid}/base
fundraisingcampaignid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"Actions": "string",
"EventDetailAuditId": "string",
"HashedId": "string"
}
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/fundraisingdonation
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"FundraisingDonationScheduleId": "integer",
"AuditId": "integer",
"FundraisingCampaignId": "integer",
"Name": "string",
"Date": "string",
"CheckNumber": "string",
"ContactId": "integer",
"EmailAddress": "string",
"Address": "string",
"PledgeAmount": "number",
"Message": "string",
"TributeContactId": "string",
"TributeContact": "string",
"RecognitionName": "string",
"PledgeItems": "string"
}
200 OK
OK
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/fundraisingdonations
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"PurchaseId": "string",
"SaleableItemId": "string",
"ContactId": "string",
"ContactName": "string",
"Amount": "string",
"PurchaseDate": "string",
"PledgedDonations": "boolean",
"NonPledgedDonations": "boolean",
"OneTimeDonations": "boolean",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/fundraisingdonations/exporttoexcel
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"PurchaseId": "string",
"SaleableItemId": "string",
"ContactId": "string",
"ContactName": "string",
"Amount": "string",
"PurchaseDate": "string",
"PledgedDonations": "boolean",
"NonPledgedDonations": "boolean",
"OneTimeDonations": "boolean",
"Criteria": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/fundraisingdonors
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "string",
"ContactName": "string",
"TotalGiftAmount": "string",
"ViaPledge": "boolean",
"NonPledgedDonations": "boolean",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/fundraisingcampaigns/{fundraisingcampaignid}/fundraisingdonorsquery
fundraisingcampaignid:
integer
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/fundraisingpledges
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "string",
"ContactName": "string",
"PledgeAmount": "string",
"SaleableItems": "string",
"StartDate": "string",
"EndDate": "string",
"Status": "string",
"HasRemainingCommitment": "boolean",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/fundraisingcampaigns/{fundraisingcampaignid}/general
fundraisingcampaignid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"FundraisingCampaignId": "integer",
"CampaignBasicDetails": "string",
"PledgesStats": "string"
}
GET /api/fundraisingcampaigns/{fundraisingcampaignid}/item/{fundraisingcampaignsaleableitemid}
fundraisingcampaignid:
integer
in path
(no description)
fundraisingcampaignsaleableitemid:
string
in path
(no description)
OK
Response Example (200 OK)
{
"FundraisingCampaignSaleableItemId": "integer",
"FundraisingCampaignId": "integer",
"SaleableItemId": "string",
"AccountingClassId": "string",
"Description": "string",
"MinimumPrice": "string",
"SuggestedPrice": "string",
"DefaultToSuggestedAmount": "boolean",
"ShowMinimumPrice": "boolean",
"IsPledge": "boolean",
"AllowCustomPrice": "boolean",
"AllowStartDateUpdate": "boolean",
"SuggestedPriceChoices": "string",
"SuggestedPriceOptions": "string"
}
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/item/{fundraisingcampaignsaleableitemid}
undefined
fundraisingcampaignid:
integer
in path
(no description)
fundraisingcampaignsaleableitemid:
string
in path
(no description)
Request Example
{
"FundraisingCampaignSaleableItemId": "integer",
"FundraisingCampaignId": "integer",
"SaleableItemId": "string",
"AccountingClassId": "string",
"Description": "string",
"MinimumPrice": "string",
"SuggestedPrice": "string",
"DefaultToSuggestedAmount": "boolean",
"ShowMinimumPrice": "boolean",
"IsPledge": "boolean",
"AllowCustomPrice": "boolean",
"AllowStartDateUpdate": "boolean",
"SuggestedPriceChoices": "string",
"SuggestedPriceOptions": "string"
}
OK
Response Example (200 OK)
{
"FundraisingCampaignSaleableItemId": "integer",
"FundraisingCampaignId": "integer",
"SaleableItemId": "integer",
"SaleableItemName": "string",
"Description": "string",
"MinimumPrice": "string",
"SuggestedPrice": "string",
"IsPledge": "boolean",
"ShowMinimumPrice": "boolean",
"AllowCustomPrice": "boolean",
"AllowStartDateUpdate": "boolean",
"SuggestedPriceChoices": "string",
"DefaultToSuggestedAmount": "boolean",
"isDeleted": "boolean",
"Actions": "string"
}
DELETE /api/fundraisingcampaigns/{fundraisingcampaignid}/item/{fundraisingcampaignsaleableitemid}
fundraisingcampaignid:
integer
in path
(no description)
fundraisingcampaignsaleableitemid:
integer
in path
(no description)
200 OK
OK
GET /api/fundraisingcampaigns/{fundraisingcampaignid}/setup
fundraisingcampaignid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"EnableOrganizationDonationOption": "boolean",
"ForceInfoHubLogin": "boolean",
"PaymentGatewayId": "string",
"PublicDonationLink": "string",
"Terms": "string",
"GlobalFlags": "string",
"ConfirmationMessage": "string",
"Items": "string"
}
POST /api/fundraisingcampaigns/{fundraisingcampaignid}/setup
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"EnableOrganizationDonationOption": "boolean",
"ForceInfoHubLogin": "boolean",
"PaymentGatewayId": "string",
"PublicDonationLink": "string",
"Terms": "string",
"GlobalFlags": "string",
"ConfirmationMessage": "string",
"Items": "string"
}
OK
Response Example (200 OK)
{
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"EnableOrganizationDonationOption": "boolean",
"ForceInfoHubLogin": "boolean",
"PaymentGatewayId": "string",
"PublicDonationLink": "string",
"Terms": "string",
"GlobalFlags": "string",
"ConfirmationMessage": "string",
"Items": "string"
}
GET /api/fundraisingcampaigns/active/lookup
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/fundraisingcampaigns/all
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/fundraisingcampaigns/all
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"ContactId": "string",
"ContactName": "string",
"CampaignStatus": "string",
"FutureCampaigns": "boolean",
"CurrentCampaigns": "boolean",
"IsMetGoal": "boolean",
"ActiveDateBetween": "string",
"StartDateBetween": "string",
"EndDateBetween": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/fundraisingcampaigns/all/{fundraisingcampaignid}
fundraisingcampaignid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"ReCaptchaResponse": "string",
"DisableReCaptchaCheck": "boolean",
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"Description": "string",
"GoalAmount": "string",
"GoalHours": "string",
"ContactId": "string",
"PrimaryContact": "string",
"ReceiptTemplateId": "string",
"FundraisingStatusId": "string",
"AllowPledges": "boolean",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"AllowAccountCreation": "boolean",
"AttachInvoice": "boolean",
"Terms": "string",
"PaymentGatewayId": "string",
"DonationPageSettingsJson": "string"
}
POST /api/fundraisingcampaigns/all/{fundraisingcampaignid}
undefined
fundraisingcampaignid:
integer
in path
(no description)
Request Example
{
"ReCaptchaResponse": "string",
"DisableReCaptchaCheck": "boolean",
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"Description": "string",
"GoalAmount": "string",
"GoalHours": "string",
"ContactId": "string",
"PrimaryContact": "string",
"ReceiptTemplateId": "string",
"FundraisingStatusId": "string",
"AllowPledges": "boolean",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"AllowAccountCreation": "boolean",
"AttachInvoice": "boolean",
"Terms": "string",
"PaymentGatewayId": "string",
"DonationPageSettingsJson": "string"
}
Response Example (200 OK)
{
"FundraisingCampaignId": "integer",
"HashedId": "string",
"Name": "string",
"StartDate": "string",
"GoalAmount": "string",
"Status": "string",
"ContactName": "string",
"NumberOfPledges": "integer",
"DollarsPledged": "string",
"CurrentAmountPaid": "string",
"TotalDonationsMade": "string",
"OneTimePledges": "string",
"OneTimeDonationsCount": "integer",
"RecurringDonationsCount": "integer",
"DonationsCount": "integer"
}
DELETE /api/fundraisingcampaigns/all/{fundraisingcampaignid}/{auditid}
fundraisingcampaignid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
GET /api/fundraisingcampaigns/all/lookup
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
POST /api/fundraisingcampaigns/donationdetails/{fundraisingcampaignid}/{contactid}/{purchaseid}/{saleableitemid}
undefined
fundraisingcampaignid:
integer
in path
(no description)
contactid:
integer
in path
(no description)
purchaseid:
integer
in path
(no description)
saleableitemid:
integer
in path
(no description)
Request Example
{
"FundraisingCampaignPurchaseId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "integer",
"IsOrganizationDonation": "boolean",
"DonorEmailAddressId": "integer",
"PurchaseId": "integer",
"SaleableItemId": "integer",
"DonorName": "string",
"Description": "string",
"Total": "number",
"Type": "string",
"PurchaseDate": "string",
"FrequencyType": "string",
"StartDate": "string",
"EndDate": "string",
"DonatedIndividual": "string",
"Message": "string",
"TributeContactId": "string",
"TributeContact": "string",
"RecognitionName": "string",
"IsRecurringOrPledge": "boolean",
"IsPaid": "boolean",
"Subject": "string",
"CommunicationCategoryId": "string",
"Notes": "string"
}
OK
Response Example (200 OK)
{
"FundraisingCampaignPurchaseId": "integer",
"FundraisingCampaignId": "integer",
"PurchaseDate": "string",
"Description": "string",
"Type": "string",
"Total": "number",
"Actions": "string"
}
GET /api/fundraisingcampaigns/donationdetails/{fundraisingcampaignpurchaseid}
fundraisingcampaignpurchaseid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"FundraisingCampaignPurchaseId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "integer",
"IsOrganizationDonation": "boolean",
"DonorEmailAddressId": "integer",
"PurchaseId": "integer",
"SaleableItemId": "integer",
"DonorName": "string",
"Description": "string",
"Total": "number",
"Type": "string",
"PurchaseDate": "string",
"FrequencyType": "string",
"StartDate": "string",
"EndDate": "string",
"DonatedIndividual": "string",
"Message": "string",
"TributeContactId": "string",
"TributeContact": "string",
"RecognitionName": "string",
"IsRecurringOrPledge": "boolean",
"IsPaid": "boolean",
"Subject": "string",
"CommunicationCategoryId": "string",
"Notes": "string"
}
DELETE /api/fundraisingcampaigns/donationdetails/{fundraisingcampaignpurchaseid}
fundraisingcampaignpurchaseid:
integer
in path
(no description)
200 OK
OK
GET /api/fundraisingcampaigns/fundraising/donations
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/fundraisingcampaigns/fundraising/donations
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"FundraisingCampaignId": "string",
"PurchaseDateBetween": "string",
"ContactId": "string",
"ContactName": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/fundraisingcampaigns/fundraising/donations/email/load
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"FundraisingCampaignId": "string",
"PurchaseDateBetween": "string",
"ContactId": "string",
"ContactName": "string"
}
200 OK
OK
Response Example (200 OK)
{
"DateRange": "string",
"Period": "string",
"TemplateId": "integer",
"Items": "string"
}
POST /api/fundraisingcampaigns/fundraising/donations/email/save
undefined
Request Example
{
"DateRange": "string",
"Period": "string",
"TemplateId": "integer",
"Items": "string"
}
200 OK
OK
POST /api/fundraisingcampaigns/fundraising/donations/export
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"FundraisingCampaignId": "string",
"PurchaseDateBetween": "string",
"ContactId": "string",
"ContactName": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/fundraisingcampaigns/fundraisingitems/{fundraisingcampaignid}
fundraisingcampaignid:
integer
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/fundraisingcampaigns/fundraisingitems/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/fundraisingcampaigns/fundraisingpledges/edit
undefined
Request Example
{
"FundraisingDonationScheduleId": "integer",
"AuditId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "integer",
"PrimaryContactId": "string",
"ContactName": "string",
"EmailAddress": "string",
"EmailAddressField": "string",
"EmailAddressType": "string",
"BillFrequencyTypeId": "string",
"StartDate": "string",
"EndDate": "string",
"TotalAmount": "number",
"DonationScheduleStatusId": "string",
"RecurringAmount": "string",
"ScheduledBillingId": "string",
"TributeContactId": "string",
"TributeName": "string",
"RecognitionName": "string",
"PledgeItems": "string",
"PurchasesPlaced": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"FundraisingCampaignId": "integer",
"FundraisingDonationScheduleId": "integer",
"ContactId": "integer",
"ContactName": "string",
"PrimaryContactName": "string",
"FrequencyType": "string",
"PledgeAmount": "number",
"RecurringAmount": "number",
"PaidAmount": "number",
"RemainingAmount": "string",
"StartDate": "string",
"EndDate": "string",
"Status": "string",
"InvoicesCount": "string",
"Actions": "string"
}
GET /api/fundraisingcampaigns/fundraisingpledges/edit/{fundraisingdonationscheduleid}
fundraisingdonationscheduleid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"FundraisingDonationScheduleId": "integer",
"AuditId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "integer",
"PrimaryContactId": "string",
"ContactName": "string",
"EmailAddress": "string",
"EmailAddressField": "string",
"EmailAddressType": "string",
"BillFrequencyTypeId": "string",
"StartDate": "string",
"EndDate": "string",
"TotalAmount": "number",
"DonationScheduleStatusId": "string",
"RecurringAmount": "string",
"ScheduledBillingId": "string",
"TributeContactId": "string",
"TributeName": "string",
"RecognitionName": "string",
"PledgeItems": "string",
"PurchasesPlaced": "boolean"
}
GET /api/fundraisingcampaigns/fundraisingstats
200 OK
OK
type
Response Example (200 OK)
[
{
"Name": "string",
"Value": "string",
"Hint": "string"
}
]
Returns list of saleable items of type: Donation
Returns list of saleable items of type: Donation
saleableitemid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}
]
GET /api/fundraisingcampaigns/lookup/fundraising/donations/email/templates
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/fundraisingcampaigns/lookup/status/{defaultstatus}
defaultstatus:
string
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
Schema Definitions
ScoreboardDatapoint: object
- Name: string
- Value: string
- Hint: string
Example
{
"Name": "string",
"Value": "string",
"Hint": "string"
}
ListViewReturnModel<FundraisingCampaignsCollectionItemViewModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FundraisingCampaignAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- Criteria: string
- ContactId: string
- ContactName: string
- CampaignStatus: string
- FutureCampaigns: boolean
- CurrentCampaigns: boolean
- IsMetGoal: boolean
- ActiveDateBetween: string
- StartDateBetween: string
- EndDateBetween: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"ContactId": "string",
"ContactName": "string",
"CampaignStatus": "string",
"FutureCampaigns": "boolean",
"CurrentCampaigns": "boolean",
"IsMetGoal": "boolean",
"ActiveDateBetween": "string",
"StartDateBetween": "string",
"EndDateBetween": "string"
}
IQueryable: object
- Expression: string
- ElementType: string
- Provider: string
Example
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
FundraisingCampaignsAddEditViewModel: object
- ReCaptchaResponse: string
- DisableReCaptchaCheck: boolean
- FundraisingCampaignId: integer
- AuditId: integer
- Name: string
- StartDate: string
- EndDate: string
- Description: string
- GoalAmount: string
- GoalHours: string
- ContactId: string
- PrimaryContact: string
- ReceiptTemplateId: string
- FundraisingStatusId: string
- AllowPledges: boolean
- CollectDonorName: boolean
- AllowInvoicing: boolean
- CollectDonorMessage: boolean
- AllowOnBehalfDonations: boolean
- AllowAccountCreation: boolean
- AttachInvoice: boolean
- Terms: string
- PaymentGatewayId: string
- DonationPageSettingsJson: string
Example
{
"ReCaptchaResponse": "string",
"DisableReCaptchaCheck": "boolean",
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"Description": "string",
"GoalAmount": "string",
"GoalHours": "string",
"ContactId": "string",
"PrimaryContact": "string",
"ReceiptTemplateId": "string",
"FundraisingStatusId": "string",
"AllowPledges": "boolean",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"AllowAccountCreation": "boolean",
"AttachInvoice": "boolean",
"Terms": "string",
"PaymentGatewayId": "string",
"DonationPageSettingsJson": "string"
}
FundraisingCampaignsCollectionItemViewModel: object
- FundraisingCampaignId: integer
- HashedId: string
- Name: string
- StartDate: string
- GoalAmount: string
- Status: string
- ContactName: string
- NumberOfPledges: integer
- DollarsPledged: string
- CurrentAmountPaid: string
- TotalDonationsMade: string
- OneTimePledges: string
- OneTimeDonationsCount: integer
- RecurringDonationsCount: integer
- DonationsCount: integer
Example
{
"FundraisingCampaignId": "integer",
"HashedId": "string",
"Name": "string",
"StartDate": "string",
"GoalAmount": "string",
"Status": "string",
"ContactName": "string",
"NumberOfPledges": "integer",
"DollarsPledged": "string",
"CurrentAmountPaid": "string",
"TotalDonationsMade": "string",
"OneTimePledges": "string",
"OneTimeDonationsCount": "integer",
"RecurringDonationsCount": "integer",
"DonationsCount": "integer"
}
ListViewReturnModel<FundraisingPledgesItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FundraisingPledgesAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- FundraisingCampaignId: integer
- ContactId: string
- ContactName: string
- PledgeAmount: string
- SaleableItems: string
- StartDate: string
- EndDate: string
- Status: string
- HasRemainingCommitment: boolean
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "string",
"ContactName": "string",
"PledgeAmount": "string",
"SaleableItems": "string",
"StartDate": "string",
"EndDate": "string",
"Status": "string",
"HasRemainingCommitment": "boolean",
"Criteria": "string"
}
FundraisingDonationAddViewModel: object
- FundraisingDonationScheduleId: integer
- AuditId: integer
- FundraisingCampaignId: integer
- Name: string
- Date: string
- CheckNumber: string
- ContactId: integer
- EmailAddress: string
- Address: string
- PledgeAmount: number
- Message: string
- TributeContactId: string
- TributeContact: string
- RecognitionName: string
- PledgeItems: string
Example
{
"FundraisingDonationScheduleId": "integer",
"AuditId": "integer",
"FundraisingCampaignId": "integer",
"Name": "string",
"Date": "string",
"CheckNumber": "string",
"ContactId": "integer",
"EmailAddress": "string",
"Address": "string",
"PledgeAmount": "number",
"Message": "string",
"TributeContactId": "string",
"TributeContact": "string",
"RecognitionName": "string",
"PledgeItems": "string"
}
FundraisingPledgesAddEditViewModel: object
- FundraisingDonationScheduleId: integer
- AuditId: integer
- FundraisingCampaignId: integer
- ContactId: integer
- PrimaryContactId: string
- ContactName: string
- EmailAddress: string
- EmailAddressField: string
- EmailAddressType: string
- BillFrequencyTypeId: string
- StartDate: string
- EndDate: string
- TotalAmount: number
- DonationScheduleStatusId: string
- RecurringAmount: string
- ScheduledBillingId: string
- TributeContactId: string
- TributeName: string
- RecognitionName: string
- PledgeItems: string
- PurchasesPlaced: boolean
Example
{
"FundraisingDonationScheduleId": "integer",
"AuditId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "integer",
"PrimaryContactId": "string",
"ContactName": "string",
"EmailAddress": "string",
"EmailAddressField": "string",
"EmailAddressType": "string",
"BillFrequencyTypeId": "string",
"StartDate": "string",
"EndDate": "string",
"TotalAmount": "number",
"DonationScheduleStatusId": "string",
"RecurringAmount": "string",
"ScheduledBillingId": "string",
"TributeContactId": "string",
"TributeName": "string",
"RecognitionName": "string",
"PledgeItems": "string",
"PurchasesPlaced": "boolean"
}
FundraisingPledgesItemModel: object
- FundraisingCampaignId: integer
- FundraisingDonationScheduleId: integer
- ContactId: integer
- ContactName: string
- PrimaryContactName: string
- FrequencyType: string
- PledgeAmount: number
- RecurringAmount: number
- PaidAmount: number
- RemainingAmount: string
- StartDate: string
- EndDate: string
- Status: string
- InvoicesCount: string
- Actions: string
Example
{
"FundraisingCampaignId": "integer",
"FundraisingDonationScheduleId": "integer",
"ContactId": "integer",
"ContactName": "string",
"PrimaryContactName": "string",
"FrequencyType": "string",
"PledgeAmount": "number",
"RecurringAmount": "number",
"PaidAmount": "number",
"RemainingAmount": "string",
"StartDate": "string",
"EndDate": "string",
"Status": "string",
"InvoicesCount": "string",
"Actions": "string"
}
FundraisingCampaignGeneralInfoModel: object
- FundraisingCampaignId: integer
- CampaignBasicDetails: string
- PledgesStats: string
Example
{
"FundraisingCampaignId": "integer",
"CampaignBasicDetails": "string",
"PledgesStats": "string"
}
FundraisingCampaignBaseInfoModel: object
- FundraisingCampaignId: integer
- AuditId: integer
- Name: string
- StartDate: string
- EndDate: string
- Actions: string
- EventDetailAuditId: string
- HashedId: string
Example
{
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"Actions": "string",
"EventDetailAuditId": "string",
"HashedId": "string"
}
FundraisingCampaignEditPricingViewModel: object
- FundraisingCampaignSaleableItemId: integer
- FundraisingCampaignId: integer
- SaleableItemId: string
- AccountingClassId: string
- Description: string
- MinimumPrice: string
- SuggestedPrice: string
- DefaultToSuggestedAmount: boolean
- ShowMinimumPrice: boolean
- IsPledge: boolean
- AllowCustomPrice: boolean
- AllowStartDateUpdate: boolean
- SuggestedPriceChoices: string
- SuggestedPriceOptions: string
Example
{
"FundraisingCampaignSaleableItemId": "integer",
"FundraisingCampaignId": "integer",
"SaleableItemId": "string",
"AccountingClassId": "string",
"Description": "string",
"MinimumPrice": "string",
"SuggestedPrice": "string",
"DefaultToSuggestedAmount": "boolean",
"ShowMinimumPrice": "boolean",
"IsPledge": "boolean",
"AllowCustomPrice": "boolean",
"AllowStartDateUpdate": "boolean",
"SuggestedPriceChoices": "string",
"SuggestedPriceOptions": "string"
}
FundraisingCampaignSaleableItemViewModel: object
- FundraisingCampaignSaleableItemId: integer
- FundraisingCampaignId: integer
- SaleableItemId: integer
- SaleableItemName: string
- Description: string
- MinimumPrice: string
- SuggestedPrice: string
- IsPledge: boolean
- ShowMinimumPrice: boolean
- AllowCustomPrice: boolean
- AllowStartDateUpdate: boolean
- SuggestedPriceChoices: string
- DefaultToSuggestedAmount: boolean
- isDeleted: boolean
- Actions: string
Example
{
"FundraisingCampaignSaleableItemId": "integer",
"FundraisingCampaignId": "integer",
"SaleableItemId": "integer",
"SaleableItemName": "string",
"Description": "string",
"MinimumPrice": "string",
"SuggestedPrice": "string",
"IsPledge": "boolean",
"ShowMinimumPrice": "boolean",
"AllowCustomPrice": "boolean",
"AllowStartDateUpdate": "boolean",
"SuggestedPriceChoices": "string",
"DefaultToSuggestedAmount": "boolean",
"isDeleted": "boolean",
"Actions": "string"
}
FundraisingCampaignSetupViewModel: object
- FundraisingCampaignId: integer
- AuditId: integer
- CollectDonorName: boolean
- AllowInvoicing: boolean
- CollectDonorMessage: boolean
- AllowOnBehalfDonations: boolean
- EnableOrganizationDonationOption: boolean
- ForceInfoHubLogin: boolean
- PaymentGatewayId: string
- PublicDonationLink: string
- Terms: string
- GlobalFlags: string
- ConfirmationMessage: string
- Items: string
Example
{
"FundraisingCampaignId": "integer",
"AuditId": "integer",
"CollectDonorName": "boolean",
"AllowInvoicing": "boolean",
"CollectDonorMessage": "boolean",
"AllowOnBehalfDonations": "boolean",
"EnableOrganizationDonationOption": "boolean",
"ForceInfoHubLogin": "boolean",
"PaymentGatewayId": "string",
"PublicDonationLink": "string",
"Terms": "string",
"GlobalFlags": "string",
"ConfirmationMessage": "string",
"Items": "string"
}
GenericLookUpChoice<Int32>: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
ListViewReturnModel<FundraisingDonorsModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FundraisingDonorsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- FundraisingCampaignId: integer
- ContactId: string
- ContactName: string
- TotalGiftAmount: string
- ViaPledge: boolean
- NonPledgedDonations: boolean
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "string",
"ContactName": "string",
"TotalGiftAmount": "string",
"ViaPledge": "boolean",
"NonPledgedDonations": "boolean",
"Criteria": "string"
}
ListViewReturnModel<FundraisingDonationItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FundraisingDonationDetailsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- FundraisingCampaignId: integer
- PurchaseId: string
- SaleableItemId: string
- ContactId: string
- ContactName: string
- Amount: string
- PurchaseDate: string
- PledgedDonations: boolean
- NonPledgedDonations: boolean
- OneTimeDonations: boolean
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"FundraisingCampaignId": "integer",
"PurchaseId": "string",
"SaleableItemId": "string",
"ContactId": "string",
"ContactName": "string",
"Amount": "string",
"PurchaseDate": "string",
"PledgedDonations": "boolean",
"NonPledgedDonations": "boolean",
"OneTimeDonations": "boolean",
"Criteria": "string"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
FundraisingDonationDetails: object
- FundraisingCampaignPurchaseId: integer
- FundraisingCampaignId: integer
- ContactId: integer
- IsOrganizationDonation: boolean
- DonorEmailAddressId: integer
- PurchaseId: integer
- SaleableItemId: integer
- DonorName: string
- Description: string
- Total: number
- Type: string
- PurchaseDate: string
- FrequencyType: string
- StartDate: string
- EndDate: string
- DonatedIndividual: string
- Message: string
- TributeContactId: string
- TributeContact: string
- RecognitionName: string
- IsRecurringOrPledge: boolean
- IsPaid: boolean
- Subject: string
- CommunicationCategoryId: string
- Notes: string
Example
{
"FundraisingCampaignPurchaseId": "integer",
"FundraisingCampaignId": "integer",
"ContactId": "integer",
"IsOrganizationDonation": "boolean",
"DonorEmailAddressId": "integer",
"PurchaseId": "integer",
"SaleableItemId": "integer",
"DonorName": "string",
"Description": "string",
"Total": "number",
"Type": "string",
"PurchaseDate": "string",
"FrequencyType": "string",
"StartDate": "string",
"EndDate": "string",
"DonatedIndividual": "string",
"Message": "string",
"TributeContactId": "string",
"TributeContact": "string",
"RecognitionName": "string",
"IsRecurringOrPledge": "boolean",
"IsPaid": "boolean",
"Subject": "string",
"CommunicationCategoryId": "string",
"Notes": "string"
}
FundraisingActivitySummaryModel: object
- FundraisingCampaignPurchaseId: integer
- FundraisingCampaignId: integer
- PurchaseDate: string
- Description: string
- Type: string
- Total: number
- Actions: string
Example
{
"FundraisingCampaignPurchaseId": "integer",
"FundraisingCampaignId": "integer",
"PurchaseDate": "string",
"Description": "string",
"Type": "string",
"Total": "number",
"Actions": "string"
}
ListViewReturnModel<FundraisingDonationReceiptItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
FundraisingDonationsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- Criteria: string
- FundraisingCampaignId: string
- PurchaseDateBetween: string
- ContactId: string
- ContactName: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"FundraisingCampaignId": "string",
"PurchaseDateBetween": "string",
"ContactId": "string",
"ContactName": "string"
}
FundraisingEmailDonations: object
- DateRange: string
- Period: string
- TemplateId: integer
- Items: string
Example
{
"DateRange": "string",
"Period": "string",
"TemplateId": "integer",
"Items": "string"
}
ItemChoiceModel: object
- IsSelected: boolean
- PreviouslySelected: boolean
- Id: integer
- Name: string
- Order: integer
Example
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
FeeItemChoiceItemModel: object
- Id: string
- TenantId: integer
- PriceFormulaEnabled: boolean
- Name: string
- Description: string
- Quantity: number
- AmountFrequencyDisplayTypeId: string
- Price: string
- PerBillingAmount: string
- CustomPerBillAmount: string
- Amount: string
- BillFrequencyTypeId: string
- HideOnInvoice: boolean
- IsVoluntary: boolean
- SaleableItemTypeId: string
- ValidStartDate: string
Example
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}