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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Sales.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api
Imports ClubReady.Core.Sales.Models
Imports ClubReady.Core.Data.ClubReady

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class GetBillingStatusRequestDto
            Inherits ApiDtoBase
            Public Overridable Property MemberId As Integer
        End Class
    End Namespace

    Namespace ClubReady.Core.Data.ClubReady

        <DataContract>
        Public Partial Class GetMemberBillingStatus_Result
            <DataMember>
            Public Overridable Property FullName As String

            <DataMember>
            Public Overridable Property MemberStatus As String

            <DataMember>
            Public Overridable Property HomeClub As String

            <DataMember>
            Public Overridable Property BalanceDue As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property StoreID As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace ClubReady.Core.Sales.Models

        Public Partial Class MemberBillingStatus
            Inherits GetMemberBillingStatus_Result
            Public Sub New()
                Invoices = New List(Of MemberBillingStatusInvoice)
            End Sub

            Public Overridable Property Invoices As List(Of MemberBillingStatusInvoice)
            Public Overridable Property UserTypeId As Integer
            Public Overridable Property UserTypeName As String
            Public Overridable Property NewUserId As Nullable(Of Integer)
        End Class

        Public Partial Class MemberBillingStatusInvoice
            Public Overridable Property InvoiceId As Integer
            Public Overridable Property Status As String
            Public Overridable Property StatusId As Short
            Public Overridable Property AmountDue As Decimal
            Public Overridable Property SalesTaxDue As Decimal
            Public Overridable Property PaymentDue As Date
            Public Overridable Property PaymentMade As Nullable(Of Date)
            Public Overridable Property PackageName As String
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Sales.Model

        Public Partial Class GetBillingStatusRequest
            Inherits GetBillingStatusRequestDto
            Implements IRestrictedApiRequest
            '''<Summary>
            '''Api Key - grants access to resources
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Api Key - grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Store ID # member belongs to
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Store ID # member belongs to", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''ID of the member to lookup
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ID of the member to lookup", IsRequired:=true, Name:="MemberId", ParameterType:="path")>
            Public Overridable Property MemberId As Integer

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class
    End Namespace
End Namespace

VB.NET GetBillingStatusRequest DTOs

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

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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