ClubReady Api

<back to all web services

CalculatePaymentPlanRequest

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 CalculatePaymentPlanRequestDto(ApiDtoBase):
    installment_plan_id: int = 0
    package_id: int = 0
    start_date: Optional[datetime.datetime] = None
    promo_code: Optional[str] = None


class RestrictedResourceType(str, Enum):
    STORE = 'Store'
    CHAIN = 'Chain'
    USER = 'User'
    UNDEFINED = 'Undefined'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CalculatePaymentPlanRequest(CalculatePaymentPlanRequestDto, 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="ID # of store to calculate plan for", IsRequired=true, Name="StoreId", ParameterType="query")
    store_id: Optional[int] = None
    """
    ID # of store to calculate plan for
    """


    # @ApiMember(DataType="integer", Description="Installment Plan to calculate a scheduel for", IsRequired=true, Name="InstallmentPlanId", ParameterType="path")
    installment_plan_id: int = 0
    """
    Installment Plan to calculate a scheduel for
    """


    # @ApiMember(DataType="integer", Description="The package to calculate for", IsRequired=true, Name="PackageId", ParameterType="path")
    package_id: int = 0
    """
    The package to calculate for
    """


    # @ApiMember(DataType="datetime", Description="Date to calculate schedule from. If not provided, will use today.", Name="StartDate", ParameterType="query")
    start_date: Optional[datetime.datetime] = None
    """
    Date to calculate schedule from. If not provided, will use today.
    """


    # @ApiMember(DataType="string", Description="Promo code to apply a discount.", Name="PromoCode", ParameterType="query")
    promo_code: Optional[str] = None
    """
    Promo code to apply a discount.
    """


    restricted_id: Optional[int] = None
    restricted_resource_type: Optional[RestrictedResourceType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentPlanInstallment:
    pay_today: bool = False
    amount: Decimal = decimal.Decimal(0)
    taxed: bool = False
    tax_rate: Optional[float] = None
    tax_amount: Optional[Decimal] = None
    fee_name: Optional[str] = None
    due_date: datetime.datetime = datetime.datetime(1, 1, 1)
    total: Optional[str] = None
    setup_fee_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CalculatePaymentPlanResultDto:
    plan_total: Optional[str] = None
    sub_total: Optional[str] = None
    tax_rate: Optional[float] = None
    enhancement_fee: Optional[str] = None
    enhancement_fee_tax_amount: Optional[str] = None
    tax_enh_fee: bool = False
    tax: Optional[str] = None
    total_due_today: Optional[str] = None
    payments: Optional[List[PaymentPlanInstallment]] = None
    fees: Optional[List[PaymentPlanInstallment]] = None
    is_evergreen: bool = False
    require_payment_profile: bool = False

Python CalculatePaymentPlanRequest DTOs

GET /sales/packages/{PackageId}/installments/calculate/{InstallmentPlanId} HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CalculatePaymentPlanResultDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <EnhancementFee>String</EnhancementFee>
  <Fees>
    <PaymentPlanInstallment>
      <Amount>0</Amount>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <FeeName>String</FeeName>
      <PayToday>false</PayToday>
      <SetupFeeId>0</SetupFeeId>
      <TaxRate>0</TaxRate>
      <Taxed>false</Taxed>
    </PaymentPlanInstallment>
  </Fees>
  <IsEvergreen>false</IsEvergreen>
  <Payments>
    <PaymentPlanInstallment>
      <Amount>0</Amount>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <FeeName>String</FeeName>
      <PayToday>false</PayToday>
      <SetupFeeId>0</SetupFeeId>
      <TaxRate>0</TaxRate>
      <Taxed>false</Taxed>
    </PaymentPlanInstallment>
  </Payments>
  <TaxEnhFee>false</TaxEnhFee>
  <TaxRate>0</TaxRate>
</CalculatePaymentPlanResultDto>