ClubReady Api

<back to all web services

GetBillingStatusRequest

The following routes are available for this service:
GET/sales/members/{MemberId}/statusGet customer's billing status
GetBillingStatusRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerYesStore ID # member belongs to
MemberIdpathintegerYesID of the member to lookup
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
GetBillingStatusRequestDto Parameters:
NameParameterData TypeRequiredDescription
MemberIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
MemberBillingStatus Parameters:
NameParameterData TypeRequiredDescription
InvoicesformList<MemberBillingStatusInvoice>No
UserTypeIdformintNo
UserTypeNameformstringNo
NewUserIdformint?No
GetMemberBillingStatus_Result Parameters:
NameParameterData TypeRequiredDescription
FullNameformstringNo
MemberStatusformstringNo
HomeClubformstringNo
BalanceDueformdecimal?No
StoreIDformint?No
MemberBillingStatusInvoice Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdformintNo
StatusformstringNo
StatusIdformshortNo
AmountDueformdecimalNo
SalesTaxDueformdecimalNo
PaymentDueformDateTimeNo
PaymentMadeformDateTime?No
PackageNameformstringNo

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 /sales/members/{MemberId}/status HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Invoices: 
	[
		{
			InvoiceId: 0,
			Status: String,
			StatusId: 0,
			AmountDue: 0,
			SalesTaxDue: 0,
			PaymentDue: 0001-01-01,
			PaymentMade: 0001-01-01,
			PackageName: String
		}
	],
	UserTypeId: 0,
	UserTypeName: String,
	NewUserId: 0,
	FullName: String,
	MemberStatus: String,
	HomeClub: String,
	BalanceDue: 0,
	StoreID: 0
}