Returns detailed information for the specified membership(s).
Important: The Membership Id is stored in the client discounts table and can be obtained using the GetClientDiscounts() or GetMembershipListing() method.
XML String
XmlIds = XML String containing the Membership Ids of the records to return. You must format this string using the XML IdList Structure Definition.
XML String has the following structure:
|
Field |
Type |
Length |
Description |
|
iId |
Integer |
4 |
Primary Key - Unique Identifier. |
|
iLocationId |
Integer |
4 |
Not used. |
|
cMemberName |
String |
40 |
Name of the membership. |
|
nMemberPrice |
Decimal |
8 |
Enrollment fee for the membership. |
|
nBillFrequency |
Decimal |
3,0 |
Billing frequency for the membership dues. |
|
nPreBill |
Decimal |
3,0 |
You can set how many weeks before the bill date to send the bill. |
|
nStopMembership |
Decimal |
3,0 |
You can set when to stop the membership if payment is past due. |
|
nServiceDiscount |
Decimal |
3,0 |
Percentage saving for the member on service purchases. |
|
nRetailDiscount |
Decimal |
3,0 |
Percentage saving for the member on retail purchases. |
|
nTanDiscount |
Decimal |
3,0 |
Percentage saving for the member on tanning purchases. |
|
nPKGDiscount |
Decimal |
3,0 |
Percentage saving for the member on package/series purchases. |
|
dDateDel |
DateTime |
8 |
Date deleted. |
|
lOnSale |
Boolean |
1 |
Indicates whether the membership is on sale. |
|
nSalePrice |
Decimal |
8 |
Associated sale cost for the membership. |
|
dSaleStart |
DateTime |
8 |
Sale start date. |
|
dSaleEnd |
DateTime |
8 |
Sale end date. |
|
iGId |
Integer |
4 |
Membership Global Id. |
|
tChanged |
DateTime |
8 |
Date/time last updated. |
|
iChgBy |
Integer |
4 |
Id of the employee who last changed the membership record. |
|
dCreated |
DateTime |
8 |
Date created. |
|
lNonTaxable |
Boolean |
1 |
Indicates whether the membership is taxable. |
|
lCommOverride |
Boolean |
1 |
Indicates whether the membership uses a commission override. |
|
cOverrideType |
String |
1 |
Indicates the type of commission override used. $ = Fixed dollar amount % = Percentage of the sales price |
|
yOverrideAmt |
Decimal |
8 |
Commission override amount (dollar amount or percentage). |
|
cAbbrev |
String |
5 |
Membership abbreviation. |
|
lAllowFreeze |
Boolean |
1 |
Indicates whether you can freeze the membership. |
|
iFreezeMin |
Decimal |
4 |
Minimum number of days you can freeze the membership. |
|
iFreezeMax |
Decimal |
4 |
Maximum number of days you can freeze the membership. |
|
lAutoRenew |
Boolean |
1 |
Indicates whether the membership uses automatic renewal. |
|
nAutoRenewType |
Decimal |
1 |
Indicates the type of automatic renewal used. 1 = Full Renew 2 = Monthly |
|
iMemMonths |
Decimal |
3 |
Membership length in months. |
|
nBillType |
Decimal |
1 |
Billing option for the membership. 1 = Manual Billing 2 = Paid In Full (PIF) 3 = Periodic/Recurring |
|
nBillFreq |
Decimal |
1 |
Payment frequency for the Periodic/Recurring billing option. 1 = Monthly 2 = Quarterly 3 = 6-Months 4 = Yearly |
|
lEnrollFeeCanChg |
Boolean |
1 |
Indicates whether you can change the enrollment fee. |
|
yRecurfee |
Decimal |
8 |
Recurring fee for the membership. |
|
lRecurFeeCanChg |
Boolean |
1 |
Indicates whether you can change the recurring fee. |
|
iFirstBillDays |
Decimal |
4 |
Number of days after enrollment that the first recurring payment is due. |
|
lAllowAddOn |
Boolean |
1 |
Indicates whether you can sell add-on memberships. |
|
iMaxAddOns |
Decimal |
4 |
Maximum number of add-on members permitted. |
|
yAddOnEnroll |
Decimal |
8 |
Enrollment fee for add-on members. |
|
lAddOnEnrollCanChg |
Boolean |
1 |
Indicates whether you can change the add-on enrollment fee. |
|
yAddOnRecurFee |
Decimal |
8 |
Recurring fee for the add-on member. |
|
lAddOnRecurFeeCanChg |
Boolean |
1 |
Indicates whether you can change the add-on recurring fee. |
|
iAddOnFirstBillDays |
Decimal |
4 |
Number of days after enrollment that the first recurring payment for the add-on member is due. |
|
nAddOnServiceDiscount |
Decimal |
3,0 |
Percentage saving for the add-on member on service purchases. |
|
nAddOnRetailDiscount |
Decimal |
3,0 |
Percentage saving for the add-on member on retail purchases. |
|
nAddOnPkgDiscount |
Decimal |
3,0 |
Percentage saving for the add-on member on package/series purchases. |
|
nAddOnTanDiscount |
Decimal |
3,0 |
Percentage saving for the add-on member on tanning purchases. |
|
lInactive |
Boolean |
1 |
Indicates whether the membership is inactive. |
|
iMinAddOns |
Decimal |
4 |
Minimum number of add-on members permitted. |
|
lRound |
Boolean |
1 |
Indicates whether discounts round to the nearest dollar. |
|
lRoundAddOn |
Boolean |
1 |
Indicates whether discounts round to the nearest dollar for the add-on member. |
|
nPkgShare |
Decimal |
1 |
Indicates whether clients can share the membership privileges. 1 = Share Only within Membership 2 = Share with Anyone |
|
lCounts |
Boolean |
1 |
Indicates whether the membership is a "no fee" membership that only offers discounts. |
|
lCommissionEachMember |
Boolean |
1 |
Indicates whether employees receive commissions for selling add-on memberships. |
|
iApptCatId |
Integer |
4 |
Appointment Category Id. |
|
yEmpSpiff |
Decimal |
8 |
|