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
namespace ClubReady.Core.Api.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiDtoBase() = 
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type GetBillingStatusRequestDto() = 
        inherit ApiDtoBase()
        member val MemberId:Int32 = new Int32() with get,set

    type RestrictedResourceType =
        | Store = 0
        | Chain = 1
        | User = 2
        | Undefined = 3

    [<AllowNullLiteral>]
    type GetBillingStatusRequest() = 
        inherit GetBillingStatusRequestDto()
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
        member val ApiKey:String = null with get,set

        ///<summary>
        ///Store ID # member belongs to
        ///</summary>
        [<ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///ID of the member to lookup
        ///</summary>
        [<ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")>]
        member val MemberId:Int32 = new Int32() with get,set

        member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetMemberBillingStatus_Result() = 
        [<DataMember>]
        member val FullName:String = null with get,set

        [<DataMember>]
        member val MemberStatus:String = null with get,set

        [<DataMember>]
        member val HomeClub:String = null with get,set

        [<DataMember>]
        member val BalanceDue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val StoreID:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type MemberBillingStatusInvoice() = 
        member val InvoiceId:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val StatusId:Int16 = new Int16() with get,set
        member val AmountDue:Decimal = new Decimal() with get,set
        member val SalesTaxDue:Decimal = new Decimal() with get,set
        member val PaymentDue:DateTime = new DateTime() with get,set
        member val PaymentMade:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PackageName:String = null with get,set

    [<AllowNullLiteral>]
    type MemberBillingStatus() = 
        inherit GetMemberBillingStatus_Result()
        member val Invoices:ResizeArray<MemberBillingStatusInvoice> = new ResizeArray<MemberBillingStatusInvoice>() with get,set
        member val UserTypeId:Int32 = new Int32() with get,set
        member val UserTypeName:String = null with get,set
        member val NewUserId:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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>