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

export class ApiDtoBase implements IApiDtoBase
{
    public ApiKey?: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class GetBillingStatusRequestDto extends ApiDtoBase
{
    public MemberId: number;

    public constructor(init?: Partial<GetBillingStatusRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class GetBillingStatusRequest extends GetBillingStatusRequestDto implements IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    public XForwardedFor: string;

    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * Store ID # member belongs to
    */
    // @ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * ID of the member to lookup
    */
    // @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
    public MemberId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetBillingStatusRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class GetMemberBillingStatus_Result
{
    // @DataMember
    public FullName: string;

    // @DataMember
    public MemberStatus: string;

    // @DataMember
    public HomeClub: string;

    // @DataMember
    public BalanceDue?: number;

    // @DataMember
    public StoreID?: number;

    public constructor(init?: Partial<GetMemberBillingStatus_Result>) { (Object as any).assign(this, init); }
}

export class MemberBillingStatusInvoice
{
    public InvoiceId: number;
    public Status: string;
    public StatusId: number;
    public AmountDue: number;
    public SalesTaxDue: number;
    public PaymentDue: string;
    public PaymentMade?: string;
    public PackageName: string;

    public constructor(init?: Partial<MemberBillingStatusInvoice>) { (Object as any).assign(this, init); }
}

export class MemberBillingStatus extends GetMemberBillingStatus_Result
{
    public Invoices: MemberBillingStatusInvoice[];
    public UserTypeId: number;
    public UserTypeName: string;
    public NewUserId?: number;

    public constructor(init?: Partial<MemberBillingStatus>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>