YM REST Services

DonationTransactions

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/DonationTransactions	Return all Donation Transactions for a given criteria.

**DonationTransactions** Parameters:
Name	Parameter	Data Type	Required
DateFrom	query	DateTime?	No
PageSize	query	int	No
PageNumber	query	int	No
OffSet	query	int	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**DonationTransactionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
DonationTransactionsList	form	List<DonationTransactionData>	No

**DonationTransactionData** Parameters:
Name	Parameter	Data Type	Required
TransactionID	form	int	No
Status	form	string	No
ClosedBy	form	string	No
PaymentType	form	string	No
DateSubmitted	form	DateTime	No
DateScheduled	form	DateTime	No
Amount	form	double	No
BalanceDue	form	double	No
Fund	form	string	No
FundCode	form	string	No
WebsiteMemberID	form	int	No
ConstituentID	form	string	No
PrimaryGroup	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
Email	form	string	No
HomeAddress1	form	string	No
HomeAddress2	form	string	No
HomeCity	form	string	No
HomeState	form	string	No
HomeProvince	form	string	No
HomePostalCode	form	string	No
HomeCountry	form	string	No
HomeAreaCode	form	string	No
HomePhone	form	string	No
CardName	form	string	No
CardType	form	string	No
CardNumber	form	string	No
CardMonth	form	string	No
CardYear	form	string	No
BillingAddress1	form	string	No
BillingAddress2	form	string	No
BillingCity	form	string	No
BillingState	form	string	No
BillingProvince	form	string	No
BillingPostalCode	form	string	No
BillingCountry	form	string	No
BillingAreaCode	form	string	No
BillingPhone	form	string	No
ReferenceNumber	form	string	No
DonorComments	form	string	No
AdminComments	form	string	No
InvoiceNumber	form	int	No
Terms	form	string	No
BillingOrganization	form	string	No
Organization	form	string	No
MemberAPIGUID	form	string	No
InvoiceDate	form	DateTime	No
DonationFundCode	form	string	No
CustomFormDataSet	form	List<CustomFormDataSetItem>	No
CustomFormDataSetAttachments	form	List<Dictionary<String,String>>	No

**CustomFormDataSetItem** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Values	form	List<string>	No

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}/DonationTransactions HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DonationTransactionsList: 
	[
		{
			TransactionID: 0,
			Status: String,
			ClosedBy: String,
			PaymentType: String,
			DateSubmitted: 0001-01-01,
			DateScheduled: 0001-01-01,
			Amount: 0,
			BalanceDue: 0,
			Fund: String,
			FundCode: String,
			WebsiteMemberID: 0,
			ConstituentID: String,
			PrimaryGroup: String,
			FirstName: String,
			MiddleName: String,
			LastName: String,
			Email: String,
			HomeAddress1: String,
			HomeAddress2: String,
			HomeCity: String,
			HomeState: String,
			HomeProvince: String,
			HomePostalCode: String,
			HomeCountry: String,
			HomeAreaCode: String,
			HomePhone: String,
			CardName: String,
			CardType: String,
			CardNumber: String,
			CardMonth: String,
			CardYear: String,
			BillingAddress1: String,
			BillingAddress2: String,
			BillingCity: String,
			BillingState: String,
			BillingProvince: String,
			BillingPostalCode: String,
			BillingCountry: String,
			BillingAreaCode: String,
			BillingPhone: String,
			ReferenceNumber: String,
			DonorComments: String,
			AdminComments: String,
			InvoiceNumber: 0,
			Terms: String,
			BillingOrganization: String,
			Organization: String,
			MemberAPIGUID: String,
			InvoiceDate: 0001-01-01,
			DonationFundCode: String,
			CustomFormDataSet: 
			[
				{
					Name: String,
					Values: 
					[
						String
					]
				}
			],
			CustomFormDataSetAttachments: 
			[
				{
					String: String
				}
			]
		}
	],
	DateFrom: 0001-01-01,
	PageSize: 0,
	PageNumber: 0,
	OffSet: 0,
	UsingRedis: True,
	AppInitTime: 2025-01-15T07:36:41.2404784-05:00,
	ServerID: WS-5-212-532,
	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:49:43.5140689-05:00,
	Device: Desktop
}