ClubManager.Api

FindPayment

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Payment

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**PaymentInstance** Parameters:
Name	Parameter	Data Type	Required
PaymentId	form	int	No
DueDate	form	DateTime	No
Amount	form	decimal	No
MembershipId	form	int?	No
TransactionId	form	int?	No
PaymentType	form	int	No
PaymentMethod	form	int	No
Name	form	string	No
Deleted	form	bool	No
Demo	form	bool	No
DirectDebitPeriod	form	int?	No
Member	form	MemberInstance	No
MemberId	form	int	No
PaymentRecurrenceId	form	int?	No
IsLocked	form	bool	No
IsExternallyCollected	form	bool	No
PaidDate	form	DateTime?	No
ProviderState	form	int	No
ProviderCollected	form	bool	No
ProviderAmount	form	decimal?	No
ProviderId	form	string	No
PaymentMethodReference	form	PaymentMethodInstance	No
PaymentMethodId	form	int?	No
StatusMessage	form	string	No
ParentPaymentId	form	int?	No
DueDays	form	int?	No
SubmissionDate	form	DateTime?	No
SubmissionRetries	form	int?	No
PaymentStatus	form	string	No

**MemberInstance** Parameters:
Name	Parameter	Data Type	Required
MemberId	form	int	No
MemberType	form	int	No
MembershipNumber	form	string	No
CardNumber	form	string	No
CompanyName	form	string	No
Surname	form	string	No
Forenames	form	string	No
Title	form	string	No
Gender	form	int	No
DateOfBirth	form	DateTime?	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
County	form	string	No
Postcode	form	string	No
HomePhone	form	string	No
MobilePhone	form	string	No
EmailAddress	form	string	No
EmailOptOut	form	bool	No
SmsOptOut	form	bool	No
PhoneOptOut	form	bool	No
LetterOptOut	form	bool	No
DirectDebitAccountHolder	form	string	No
DirectDebitAccountNumber	form	string	No
DirectDebitSortCode	form	string	No
JoinedDate	form	DateTime?	No
DirectDebitBankAddress	form	string	No
FullName	form	string	No
ExternalReference	form	string	No
Photo	form	byte[]	No
PhotoModifiedDate	form	DateTime?	No
Notes	form	string	No
Deleted	form	bool	No
Demo	form	bool	No
UseExternalStatus	form	bool	No
ExternalStatus	form	int	No
FreeText	form	string	No
MemberKey	form	Guid?	No
Balance	form	decimal	No
CreditLimit	form	decimal	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime?	No
DeletedDate	form	DateTime?	No
ExternalSource	form	int	No
RetentionMetric	form	decimal?	No
MonthlyAttendanceFrequency	form	decimal?	No
AssignedToUserId	form	int?	No
CreatedByUserId	form	int?	No
DeletedByUserId	form	int?	No
LossReason	form	LossReasonInstance	No
LossReasonId	form	int?	No
WonOrLost	form	int?	No
WonOrLostDate	form	DateTime?	No
GiftAidPermission	form	bool	No
PhotoPermission	form	bool?	No
FirstAidPermission	form	bool?	No
EmergencyContact	form	string	No
WonOrLostByUser	form	UserInstance	No
WonOrLostByUserId	form	int?	No
AgreedToTerms	form	DateTime?	No
OnlineBookingBanned	form	bool	No
Country	form	string	No
FingerprintEnrolled	form	DateTime?	No
LastPaymentAmount	form	decimal?	No
Pin	form	string	No
ProspectingPoints	form	int	No
AchievementPoints	form	int	No
ParentForenames	form	string	No
ParentSurname	form	string	No

**LossReasonInstance** Parameters:
Name	Parameter	Data Type	Required
LossReasonId	form	int	No
Reason	form	string	No
Deleted	form	bool	No
Demo	form	bool	No
Selectable	form	bool	No

**UserInstance** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
UserName	form	string	No
Name	form	string	No
Email	form	string	No
MobilePhone	form	string	No
Enabled	form	bool	No
LastLogin	form	DateTime?	No
Created	form	DateTime	No
Training	form	bool	No
Deleted	form	bool	No
CoursesCompleted	form	int	No
DisplayHomeNotification	form	bool?	No
TwoFactorEnabled	form	bool	No
EmailConfirmed	form	bool	No
MobilePhoneConfirmed	form	bool	No
Notifications	form	bool	No
ChangePassword	form	DateTime?	No
Activated	form	DateTime?	No

**PaymentMethodInstance** Parameters:
Name	Parameter	Data Type	Required
PaymentMethodId	form	int	No
PaymentMethodToken	form	string	No
CardType	form	string	No
CardNumber	form	string	No
Expiry	form	DateTime	No
Created	form	DateTime	No
Deleted	form	DateTime?	No
IsDefault	form	bool	No
PaymentMethodUse	form	int	No
PaymentGatewayId	form	int	No
Member	form	MemberInstance	No
MemberId	form	int	No
Failures	form	int	No
Cancelled	form	DateTime?	No
CancelledBy	form	int?	No
Identifier	form	string	No
Settings	form	string	No
UseMemberDetails	form	bool	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	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.

POST /api/Query/Payment HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			PaymentId: 0,
			DueDate: 0001-01-01,
			Amount: 0,
			MembershipId: 0,
			TransactionId: 0,
			PaymentType: 0,
			PaymentMethod: 0,
			Name: String,
			Deleted: False,
			Demo: False,
			DirectDebitPeriod: 0,
			Member: 
			{
				MemberId: 0,
				MemberType: 0,
				MembershipNumber: String,
				CardNumber: String,
				CompanyName: String,
				Surname: String,
				Forenames: String,
				Title: String,
				Gender: 0,
				DateOfBirth: 0001-01-01,
				Address1: String,
				Address2: String,
				City: String,
				County: String,
				Postcode: String,
				HomePhone: String,
				MobilePhone: String,
				EmailAddress: String,
				EmailOptOut: False,
				SmsOptOut: False,
				PhoneOptOut: False,
				LetterOptOut: False,
				DirectDebitAccountHolder: String,
				DirectDebitAccountNumber: String,
				DirectDebitSortCode: String,
				JoinedDate: 0001-01-01,
				DirectDebitBankAddress: String,
				FullName: String,
				ExternalReference: String,
				Photo: AA==,
				PhotoModifiedDate: 0001-01-01,
				Notes: String,
				Deleted: False,
				Demo: False,
				UseExternalStatus: False,
				ExternalStatus: 0,
				FreeText: String,
				MemberKey: 00000000000000000000000000000000,
				Balance: 0,
				CreditLimit: 0,
				CreatedDate: 0001-01-01,
				ModifiedDate: 0001-01-01,
				DeletedDate: 0001-01-01,
				ExternalSource: 0,
				RetentionMetric: 0,
				MonthlyAttendanceFrequency: 0,
				AssignedToUserId: 0,
				CreatedByUserId: 0,
				DeletedByUserId: 0,
				LossReason: 
				{
					LossReasonId: 0,
					Reason: String,
					Deleted: False,
					Demo: False,
					Selectable: False
				},
				LossReasonId: 0,
				WonOrLost: 0,
				WonOrLostDate: 0001-01-01,
				GiftAidPermission: False,
				PhotoPermission: False,
				FirstAidPermission: False,
				EmergencyContact: String,
				WonOrLostByUser: 
				{
					UserId: 0,
					UserName: String,
					Name: String,
					Email: String,
					MobilePhone: String,
					Enabled: False,
					LastLogin: 0001-01-01,
					Created: 0001-01-01,
					Training: False,
					Deleted: False,
					CoursesCompleted: 0,
					DisplayHomeNotification: False,
					TwoFactorEnabled: False,
					EmailConfirmed: False,
					MobilePhoneConfirmed: False,
					Notifications: False,
					ChangePassword: 0001-01-01,
					Activated: 0001-01-01
				},
				WonOrLostByUserId: 0,
				AgreedToTerms: 0001-01-01,
				OnlineBookingBanned: False,
				Country: String,
				FingerprintEnrolled: 0001-01-01,
				LastPaymentAmount: 0,
				Pin: String,
				ProspectingPoints: 0,
				AchievementPoints: 0,
				ParentForenames: String,
				ParentSurname: String
			},
			MemberId: 0,
			PaymentRecurrenceId: 0,
			IsLocked: False,
			IsExternallyCollected: False,
			PaidDate: 0001-01-01,
			ProviderState: 0,
			ProviderCollected: False,
			ProviderAmount: 0,
			ProviderId: String,
			PaymentMethodReference: 
			{
				PaymentMethodId: 0,
				PaymentMethodToken: String,
				CardType: String,
				CardNumber: String,
				Expiry: 0001-01-01,
				Created: 0001-01-01,
				Deleted: 0001-01-01,
				IsDefault: False,
				PaymentMethodUse: 0,
				PaymentGatewayId: 0,
				Member: 
				{
					MemberId: 0,
					MemberType: 0,
					MembershipNumber: String,
					CardNumber: String,
					CompanyName: String,
					Surname: String,
					Forenames: String,
					Title: String,
					Gender: 0,
					DateOfBirth: 0001-01-01,
					Address1: String,
					Address2: String,
					City: String,
					County: String,
					Postcode: String,
					HomePhone: String,
					MobilePhone: String,
					EmailAddress: String,
					EmailOptOut: False,
					SmsOptOut: False,
					PhoneOptOut: False,
					LetterOptOut: False,
					DirectDebitAccountHolder: String,
					DirectDebitAccountNumber: String,
					DirectDebitSortCode: String,
					JoinedDate: 0001-01-01,
					DirectDebitBankAddress: String,
					FullName: String,
					ExternalReference: String,
					Photo: AA==,
					PhotoModifiedDate: 0001-01-01,
					Notes: String,
					Deleted: False,
					Demo: False,
					UseExternalStatus: False,
					ExternalStatus: 0,
					FreeText: String,
					MemberKey: 00000000000000000000000000000000,
					Balance: 0,
					CreditLimit: 0,
					CreatedDate: 0001-01-01,
					ModifiedDate: 0001-01-01,
					DeletedDate: 0001-01-01,
					ExternalSource: 0,
					RetentionMetric: 0,
					MonthlyAttendanceFrequency: 0,
					AssignedToUserId: 0,
					CreatedByUserId: 0,
					DeletedByUserId: 0,
					LossReason: 
					{
						LossReasonId: 0,
						Reason: String,
						Deleted: False,
						Demo: False,
						Selectable: False
					},
					LossReasonId: 0,
					WonOrLost: 0,
					WonOrLostDate: 0001-01-01,
					GiftAidPermission: False,
					PhotoPermission: False,
					FirstAidPermission: False,
					EmergencyContact: String,
					WonOrLostByUser: 
					{
						UserId: 0,
						UserName: String,
						Name: String,
						Email: String,
						MobilePhone: String,
						Enabled: False,
						LastLogin: 0001-01-01,
						Created: 0001-01-01,
						Training: False,
						Deleted: False,
						CoursesCompleted: 0,
						DisplayHomeNotification: False,
						TwoFactorEnabled: False,
						EmailConfirmed: False,
						MobilePhoneConfirmed: False,
						Notifications: False,
						ChangePassword: 0001-01-01,
						Activated: 0001-01-01
					},
					WonOrLostByUserId: 0,
					AgreedToTerms: 0001-01-01,
					OnlineBookingBanned: False,
					Country: String,
					FingerprintEnrolled: 0001-01-01,
					LastPaymentAmount: 0,
					Pin: String,
					ProspectingPoints: 0,
					AchievementPoints: 0,
					ParentForenames: String,
					ParentSurname: String
				},
				MemberId: 0,
				Failures: 0,
				Cancelled: 0001-01-01,
				CancelledBy: 0,
				Identifier: String,
				Settings: String,
				UseMemberDetails: False
			},
			PaymentMethodId: 0,
			StatusMessage: String,
			ParentPaymentId: 0,
			DueDays: 0,
			SubmissionDate: 0001-01-01,
			SubmissionRetries: 0,
			PaymentStatus: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}