ClubManager.Api

<back to all web services

ViewPayments

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Payments
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PaymentsInstance Parameters:
NameParameterData TypeRequiredDescription
PaymentIdformintNo
DueDateformDateTimeNo
PaidDateformDateTime?No
AmountformdecimalNo
MembershipIdformint?No
TransactionIdformint?No
PaymentMethodformintNo
PaymentTypeformintNo
PaymentTypeNameformstringNo
PaymentMethodNameformstringNo
NameformstringNo
DeletedformboolNo
DemoformboolNo
MemberformMemberInstanceNo
MemberIdformintNo
IsLockedformboolNo
IsExternallyCollectedformboolNo
MembershipNumberformstringNo
FullNameformstringNo
HomePhoneformstringNo
PaymentStatusformstringNo
EndDateformDateTime?No
ContractEndDateformDateTime?No
MembershipNameformstringNo
MembershipStartDateformDateTime?No
MembershipDeletedformbool?No
ProviderIdformstringNo
PaymentGatewayTokenformstringNo
ProviderStateformintNo
PaymentStateformintNo
PaymentMethodReferenceformPaymentMethodInstanceNo
PaymentMethodIdformint?No
HasLivePaymentMethodformbool?No
StatusMessageformstringNo
ParentPaymentIdformint?No
PaymentRecurrenceIdformint?No
PaymentGatewayNameformstringNo
StatementNameformstringNo
SubmissionDateformDateTime?No
SubmissionRetriesformint?No
MemberInstance Parameters:
NameParameterData TypeRequiredDescription
MemberIdformintNo
MemberTypeformintNo
MembershipNumberformstringNo
CardNumberformstringNo
CompanyNameformstringNo
SurnameformstringNo
ForenamesformstringNo
TitleformstringNo
GenderformintNo
DateOfBirthformDateTime?No
Address1formstringNo
Address2formstringNo
CityformstringNo
CountyformstringNo
PostcodeformstringNo
HomePhoneformstringNo
MobilePhoneformstringNo
EmailAddressformstringNo
EmailOptOutformboolNo
SmsOptOutformboolNo
PhoneOptOutformboolNo
LetterOptOutformboolNo
DirectDebitAccountHolderformstringNo
DirectDebitAccountNumberformstringNo
DirectDebitSortCodeformstringNo
JoinedDateformDateTime?No
DirectDebitBankAddressformstringNo
FullNameformstringNo
ExternalReferenceformstringNo
Photoformbyte[]No
PhotoModifiedDateformDateTime?No
NotesformstringNo
DeletedformboolNo
DemoformboolNo
UseExternalStatusformboolNo
ExternalStatusformintNo
FreeTextformstringNo
MemberKeyformGuid?No
BalanceformdecimalNo
CreditLimitformdecimalNo
CreatedDateformDateTimeNo
ModifiedDateformDateTime?No
DeletedDateformDateTime?No
ExternalSourceformintNo
RetentionMetricformdecimal?No
MonthlyAttendanceFrequencyformdecimal?No
AssignedToUserIdformint?No
CreatedByUserIdformint?No
DeletedByUserIdformint?No
LossReasonformLossReasonInstanceNo
LossReasonIdformint?No
WonOrLostformint?No
WonOrLostDateformDateTime?No
GiftAidPermissionformboolNo
PhotoPermissionformbool?No
FirstAidPermissionformbool?No
EmergencyContactformstringNo
WonOrLostByUserformUserInstanceNo
WonOrLostByUserIdformint?No
AgreedToTermsformDateTime?No
OnlineBookingBannedformboolNo
CountryformstringNo
FingerprintEnrolledformDateTime?No
LastPaymentAmountformdecimal?No
PinformstringNo
ProspectingPointsformintNo
AchievementPointsformintNo
ParentForenamesformstringNo
ParentSurnameformstringNo
LossReasonInstance Parameters:
NameParameterData TypeRequiredDescription
LossReasonIdformintNo
ReasonformstringNo
DeletedformboolNo
DemoformboolNo
SelectableformboolNo
UserInstance Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
NameformstringNo
EmailformstringNo
MobilePhoneformstringNo
EnabledformboolNo
LastLoginformDateTime?No
CreatedformDateTimeNo
TrainingformboolNo
DeletedformboolNo
CoursesCompletedformintNo
DisplayHomeNotificationformbool?No
TwoFactorEnabledformboolNo
EmailConfirmedformboolNo
MobilePhoneConfirmedformboolNo
NotificationsformboolNo
ChangePasswordformDateTime?No
ActivatedformDateTime?No
PaymentMethodInstance Parameters:
NameParameterData TypeRequiredDescription
PaymentMethodIdformintNo
PaymentMethodTokenformstringNo
CardTypeformstringNo
CardNumberformstringNo
ExpiryformDateTimeNo
CreatedformDateTimeNo
DeletedformDateTime?No
IsDefaultformboolNo
PaymentMethodUseformintNo
PaymentGatewayIdformintNo
MemberformMemberInstanceNo
MemberIdformintNo
FailuresformintNo
CancelledformDateTime?No
CancelledByformint?No
IdentifierformstringNo
SettingsformstringNo
UseMemberDetailsformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

POST /api/Query/Payments HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"PaymentId":0,"DueDate":"0001-01-01T00:00:00.0000000","PaidDate":"0001-01-01T00:00:00.0000000","Amount":0,"MembershipId":0,"TransactionId":0,"PaymentMethod":0,"PaymentType":0,"PaymentTypeName":"String","PaymentMethodName":"String","Name":"String","Deleted":false,"Demo":false,"Member":{"MemberId":0,"MemberType":0,"MembershipNumber":"String","CardNumber":"String","CompanyName":"String","Surname":"String","Forenames":"String","Title":"String","Gender":0,"DateOfBirth":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","DirectDebitBankAddress":"String","FullName":"String","ExternalReference":"String","Photo":"AA==","PhotoModifiedDate":"0001-01-01T00:00:00.0000000","Notes":"String","Deleted":false,"Demo":false,"UseExternalStatus":false,"ExternalStatus":0,"FreeText":"String","MemberKey":"00000000000000000000000000000000","Balance":0,"CreditLimit":0,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","DeletedDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","GiftAidPermission":false,"PhotoPermission":false,"FirstAidPermission":false,"EmergencyContact":"String","WonOrLostByUser":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"WonOrLostByUserId":0,"AgreedToTerms":"0001-01-01T00:00:00.0000000","OnlineBookingBanned":false,"Country":"String","FingerprintEnrolled":"0001-01-01T00:00:00.0000000","LastPaymentAmount":0,"Pin":"String","ProspectingPoints":0,"AchievementPoints":0,"ParentForenames":"String","ParentSurname":"String"},"MemberId":0,"IsLocked":false,"IsExternallyCollected":false,"MembershipNumber":"String","FullName":"String","HomePhone":"String","PaymentStatus":"String","EndDate":"0001-01-01T00:00:00.0000000","ContractEndDate":"0001-01-01T00:00:00.0000000","MembershipName":"String","MembershipStartDate":"0001-01-01T00:00:00.0000000","MembershipDeleted":false,"ProviderId":"String","PaymentGatewayToken":"String","ProviderState":0,"PaymentState":0,"PaymentMethodReference":{"PaymentMethodId":0,"PaymentMethodToken":"String","CardType":"String","CardNumber":"String","Expiry":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Deleted":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","DirectDebitBankAddress":"String","FullName":"String","ExternalReference":"String","Photo":"AA==","PhotoModifiedDate":"0001-01-01T00:00:00.0000000","Notes":"String","Deleted":false,"Demo":false,"UseExternalStatus":false,"ExternalStatus":0,"FreeText":"String","MemberKey":"00000000000000000000000000000000","Balance":0,"CreditLimit":0,"CreatedDate":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000","DeletedDate":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","GiftAidPermission":false,"PhotoPermission":false,"FirstAidPermission":false,"EmergencyContact":"String","WonOrLostByUser":{"UserId":0,"UserName":"String","Name":"String","Email":"String","MobilePhone":"String","Enabled":false,"LastLogin":"0001-01-01T00:00:00.0000000","Created":"0001-01-01T00:00:00.0000000","Training":false,"Deleted":false,"CoursesCompleted":0,"DisplayHomeNotification":false,"TwoFactorEnabled":false,"EmailConfirmed":false,"MobilePhoneConfirmed":false,"Notifications":false,"ChangePassword":"0001-01-01T00:00:00.0000000","Activated":"0001-01-01T00:00:00.0000000"},"WonOrLostByUserId":0,"AgreedToTerms":"0001-01-01T00:00:00.0000000","OnlineBookingBanned":false,"Country":"String","FingerprintEnrolled":"0001-01-01T00:00:00.0000000","LastPaymentAmount":0,"Pin":"String","ProspectingPoints":0,"AchievementPoints":0,"ParentForenames":"String","ParentSurname":"String"},"MemberId":0,"Failures":0,"Cancelled":"0001-01-01T00:00:00.0000000","CancelledBy":0,"Identifier":"String","Settings":"String","UseMemberDetails":false},"PaymentMethodId":0,"HasLivePaymentMethod":false,"StatusMessage":"String","ParentPaymentId":0,"PaymentRecurrenceId":0,"PaymentGatewayName":"String","StatementName":"String","SubmissionDate":"0001-01-01T00:00:00.0000000","SubmissionRetries":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}