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
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetBillingStatusRequest : GetBillingStatusRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * Store ID # member belongs to
    */
    @ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ID of the member to lookup
    */
    @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
    var MemberId:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class GetBillingStatusRequestDto : ApiDtoBase()
{
    var MemberId:Int? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open class MemberBillingStatus : GetMemberBillingStatus_Result()
{
    var Invoices:ArrayList<MemberBillingStatusInvoice> = ArrayList<MemberBillingStatusInvoice>()
    var UserTypeId:Int? = null
    var UserTypeName:String? = null
    var NewUserId:Int? = null
}

@DataContract
open class GetMemberBillingStatus_Result
{
    @DataMember
    var FullName:String? = null

    @DataMember
    var MemberStatus:String? = null

    @DataMember
    var HomeClub:String? = null

    @DataMember
    var BalanceDue:BigDecimal? = null

    @DataMember
    var StoreID:Int? = null
}

open class MemberBillingStatusInvoice
{
    var InvoiceId:Int? = null
    var Status:String? = null
    var StatusId:Short? = null
    var AmountDue:BigDecimal? = null
    var SalesTaxDue:BigDecimal? = null
    var PaymentDue:Date? = null
    var PaymentMade:Date? = null
    var PackageName:String? = null
}

Kotlin GetBillingStatusRequest DTOs

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

HTTP + XML

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: clubready.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberBillingStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Sales.Models">
  <BalanceDue xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Data.ClubReady">0</BalanceDue>
  <FullName xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Data.ClubReady">String</FullName>
  <HomeClub xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Data.ClubReady">String</HomeClub>
  <MemberStatus xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Data.ClubReady">String</MemberStatus>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Data.ClubReady">0</StoreID>
  <Invoices>
    <MemberBillingStatusInvoice>
      <AmountDue>0</AmountDue>
      <InvoiceId>0</InvoiceId>
      <PackageName>String</PackageName>
      <PaymentDue>0001-01-01T00:00:00</PaymentDue>
      <PaymentMade>0001-01-01T00:00:00</PaymentMade>
      <SalesTaxDue>0</SalesTaxDue>
      <Status>String</Status>
      <StatusId>0</StatusId>
    </MemberBillingStatusInvoice>
  </Invoices>
  <NewUserId>0</NewUserId>
  <UserTypeId>0</UserTypeId>
  <UserTypeName>String</UserTypeName>
</MemberBillingStatus>