YM REST Services

<back to all web services

DonationHistory

Requires Authentication
Requires any of the roles:admin, oauthadmin, member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/DonationHistoryReturn a list of all donation.
DonationHistory Parameters:
NameParameterData TypeRequiredDescription
PageSizequeryintNo
PageNumberqueryintNo
OrderByquerystringNo
OrderByDirectionquerystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
DonationHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
DonationsformList<DonationData>No
DonationData Parameters:
NameParameterData TypeRequiredDescription
intDonationIdformintNo
DatDonationformDateTimeNo
dblDonationformdoubleNo
intStatusformintNo
strStatusformstringNo
strInvoiceGUIDformstringNo
dblOutstandingBalanceformdoubleNo
strFundNameformstringNo
datTransactionformDateTimeNo
intMultiplePaymentsformintNo
intNumberOfPaymentsformintNo
datInvoiceDateformDateTimeNo
dblOutstandingDonationformdoubleNo
MultipleInvoiceDeleteButtonformboolNo
SingleInvoiceDeleteButtonformboolNo
IsAwaitingAutoBillformboolNo
IsInvoicePaymentOptionAvailableformboolNo
AbstractTimeformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/Member/{MemberID}/DonationHistory HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TotalCount: 0,
	Donations: 
	[
		{
			intDonationId: 0,
			DatDonation: 0001-01-01,
			dblDonation: 0,
			intStatus: 0,
			strStatus: String,
			strInvoiceGUID: String,
			dblOutstandingBalance: 0,
			strFundName: String,
			datTransaction: 0001-01-01,
			intMultiplePayments: 0,
			intNumberOfPayments: 0,
			datInvoiceDate: 0001-01-01,
			dblOutstandingDonation: 0,
			MultipleInvoiceDeleteButton: False,
			SingleInvoiceDeleteButton: False,
			IsAwaitingAutoBill: False,
			IsInvoicePaymentOptionAvailable: False,
			AbstractTime: 0
		}
	],
	PageSize: 0,
	PageNumber: 0,
	OrderBy: String,
	OrderByDirection: String,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2025-01-15T08:55:42.7718025-05:00,
	Device: Desktop
}