| GET | /sales/members/{MemberId}/status | Get customer's billing status |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiDtoBase:
api_key: Optional[str] = None
store_id: Optional[int] = None
chain_id: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBillingStatusRequestDto(ApiDtoBase):
member_id: int = 0
class RestrictedResourceType(str, Enum):
STORE = 'Store'
CHAIN = 'Chain'
USER = 'User'
UNDEFINED = 'Undefined'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBillingStatusRequest(GetBillingStatusRequestDto, IRestrictedApiRequest):
# @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
api_key: Optional[str] = None
"""
Api Key - grants access to resources
"""
# @ApiMember(DataType="integer", Description="Store ID # member belongs to", IsRequired=true, Name="StoreId", ParameterType="query")
store_id: Optional[int] = None
"""
Store ID # member belongs to
"""
# @ApiMember(DataType="integer", Description="ID of the member to lookup", IsRequired=true, Name="MemberId", ParameterType="path")
member_id: int = 0
"""
ID of the member to lookup
"""
restricted_id: Optional[int] = None
restricted_resource_type: Optional[RestrictedResourceType] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetMemberBillingStatus_Result:
full_name: Optional[str] = None
member_status: Optional[str] = None
home_club: Optional[str] = None
balance_due: Optional[Decimal] = None
store_i_d: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberBillingStatusInvoice:
invoice_id: int = 0
status: Optional[str] = None
status_id: int = 0
amount_due: Decimal = decimal.Decimal(0)
sales_tax_due: Decimal = decimal.Decimal(0)
payment_due: datetime.datetime = datetime.datetime(1, 1, 1)
payment_made: Optional[datetime.datetime] = None
package_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MemberBillingStatus(GetMemberBillingStatus_Result):
invoices: Optional[List[MemberBillingStatusInvoice]] = None
user_type_id: int = 0
user_type_name: Optional[str] = None
new_user_id: Optional[int] = None
Python GetBillingStatusRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>