| Required role: | API |
| All Verbs | /api/Query/Payments |
|---|
// @DataContract
export class QueryBase
{
// @DataMember(Order=1)
public Skip?: number;
// @DataMember(Order=2)
public Take?: number;
// @DataMember(Order=3)
public OrderBy?: string;
// @DataMember(Order=4)
public OrderByDesc?: string;
// @DataMember(Order=5)
public Include?: string;
// @DataMember(Order=6)
public Fields?: string;
// @DataMember(Order=7)
public Meta?: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<T> extends QueryBase
{
public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}
export class LossReasonInstance
{
public LossReasonId?: number;
public Reason?: string;
public Deleted?: boolean;
public Demo?: boolean;
public Selectable?: boolean;
public constructor(init?: Partial<LossReasonInstance>) { (Object as any).assign(this, init); }
}
export class UserInstance
{
public UserId?: number;
public UserName?: string;
public Name?: string;
public Email?: string;
public MobilePhone?: string;
public Enabled?: boolean;
public LastLogin?: string;
public Created?: string;
public Training?: boolean;
public Deleted?: boolean;
public CoursesCompleted?: number;
public DisplayHomeNotification?: boolean;
public TwoFactorEnabled?: boolean;
public EmailConfirmed?: boolean;
public MobilePhoneConfirmed?: boolean;
public Notifications?: boolean;
public ChangePassword?: string;
public Activated?: string;
public constructor(init?: Partial<UserInstance>) { (Object as any).assign(this, init); }
}
export class MemberInstance
{
public MemberId?: number;
public MemberType?: number;
public MembershipNumber?: string;
public CardNumber?: string;
public CompanyName?: string;
public Surname?: string;
public Forenames?: string;
public Title?: string;
public Gender?: number;
public DateOfBirth?: string;
public Address1?: string;
public Address2?: string;
public City?: string;
public County?: string;
public Postcode?: string;
public HomePhone?: string;
public MobilePhone?: string;
public EmailAddress?: string;
public EmailOptOut?: boolean;
public SmsOptOut?: boolean;
public PhoneOptOut?: boolean;
public LetterOptOut?: boolean;
public DirectDebitAccountHolder?: string;
public DirectDebitAccountNumber?: string;
public DirectDebitSortCode?: string;
public JoinedDate?: string;
public DirectDebitBankAddress?: string;
public FullName?: string;
public ExternalReference?: string;
public Photo?: string;
public PhotoModifiedDate?: string;
public Notes?: string;
public Deleted?: boolean;
public Demo?: boolean;
public UseExternalStatus?: boolean;
public ExternalStatus?: number;
public FreeText?: string;
public MemberKey?: string;
public Balance?: number;
public CreditLimit?: number;
public CreatedDate?: string;
public ModifiedDate?: string;
public DeletedDate?: string;
public ExternalSource?: number;
public RetentionMetric?: number;
public MonthlyAttendanceFrequency?: number;
public AssignedToUserId?: number;
public CreatedByUserId?: number;
public DeletedByUserId?: number;
public LossReason?: LossReasonInstance;
// @References("typeof(ClubManager.Api.Services.Query.LossReasonInstance)")
public LossReasonId?: number;
public WonOrLost?: number;
public WonOrLostDate?: string;
public GiftAidPermission?: boolean;
public PhotoPermission?: boolean;
public FirstAidPermission?: boolean;
public EmergencyContact?: string;
public WonOrLostByUser?: UserInstance;
// @References("typeof(ClubManager.Api.Services.Query.UserInstance)")
public WonOrLostByUserId?: number;
public AgreedToTerms?: string;
public OnlineBookingBanned?: boolean;
public Country?: string;
public FingerprintEnrolled?: string;
public LastPaymentAmount?: number;
public Pin?: string;
public ProspectingPoints?: number;
public AchievementPoints?: number;
public ParentForenames?: string;
public ParentSurname?: string;
public constructor(init?: Partial<MemberInstance>) { (Object as any).assign(this, init); }
}
export class PaymentMethodInstance
{
public PaymentMethodId?: number;
public PaymentMethodToken?: string;
public CardType?: string;
public CardNumber?: string;
public Expiry?: string;
public Created?: string;
public Deleted?: string;
public IsDefault?: boolean;
public PaymentMethodUse?: number;
public PaymentGatewayId?: number;
public Member?: MemberInstance;
// @References("typeof(ClubManager.Api.Services.Query.MemberInstance)")
public MemberId?: number;
public Failures?: number;
public Cancelled?: string;
public CancelledBy?: number;
public Identifier?: string;
public Settings?: string;
public UseMemberDetails?: boolean;
public constructor(init?: Partial<PaymentMethodInstance>) { (Object as any).assign(this, init); }
}
export class PaymentsInstance
{
// @References("typeof(ClubManager.Api.Services.Query.PaymentInstance)")
public PaymentId?: number;
public DueDate?: string;
public PaidDate?: string;
public Amount?: number;
// @References("typeof(ClubManager.Api.Services.Query.MembershipInstance)")
public MembershipId?: number;
public TransactionId?: number;
public PaymentMethod?: number;
public PaymentType?: number;
public PaymentTypeName?: string;
public PaymentMethodName?: string;
public Name?: string;
public Deleted?: boolean;
public Demo?: boolean;
public Member?: MemberInstance;
// @References("typeof(ClubManager.Api.Services.Query.MemberInstance)")
public MemberId?: number;
public IsLocked?: boolean;
public IsExternallyCollected?: boolean;
public MembershipNumber?: string;
public FullName?: string;
public HomePhone?: string;
public PaymentStatus?: string;
public EndDate?: string;
public ContractEndDate?: string;
public MembershipName?: string;
public MembershipStartDate?: string;
public MembershipDeleted?: boolean;
public ProviderId?: string;
public PaymentGatewayToken?: string;
public ProviderState?: number;
public PaymentState?: number;
public PaymentMethodReference?: PaymentMethodInstance;
// @References("typeof(ClubManager.Api.Services.Query.PaymentMethodInstance)")
public PaymentMethodId?: number;
public HasLivePaymentMethod?: boolean;
public StatusMessage?: string;
// @References("typeof(ClubManager.Api.Services.Query.PaymentInstance)")
public ParentPaymentId?: number;
// @References("typeof(ClubManager.Api.Services.Query.PaymentRecurrenceInstance)")
public PaymentRecurrenceId?: number;
public PaymentGatewayName?: string;
public StatementName?: string;
public SubmissionDate?: string;
public SubmissionRetries?: number;
public constructor(init?: Partial<PaymentsInstance>) { (Object as any).assign(this, init); }
}
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Payments")
export class ViewPayments extends QueryDb<PaymentsInstance>
{
public constructor(init?: Partial<ViewPayments>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public Offset?: number;
// @DataMember(Order=2)
public Total?: number;
// @DataMember(Order=3)
public Results?: T[];
// @DataMember(Order=4)
public Meta?: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus?: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
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"}}}