BokaMera.API.Host

CreateRebateCode

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/rebatecodes	Create RebateCode.	Create RebateCode.

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 DaysOfWeekResponse:
    id: int = 0
    day_of_week: Optional[str] = None
    day_of_week_translation: Optional[str] = None
    day_of_week_active: Optional[bool] = None
    day_of_week_sort_order: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeServiceResponse:
    id: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleServiceRelation(BaseModel):
    # @Required()
    company_id: Optional[str] = None

    id: int = 0
    # @Required()
    service_id: int = 0

    # @Required()
    article_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ArticleResponse:
    company_id: Optional[str] = None
    id: int = 0
    name: Optional[str] = None
    article_type_id: int = 0
    description: Optional[str] = None
    image_url: Optional[str] = None
    active: bool = False
    amount: int = 0
    price: float = 0.0
    currency_id: Optional[str] = None
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    services: List[ArticleServiceRelation] = field(default_factory=list)
    service_ids: List[int] = field(default_factory=list)
    price_sign: Optional[str] = None
    vat: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeCustomerResponse:
    id: Optional[str] = None
    firstname: Optional[str] = None
    lastname: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    image_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeTransactionQueryResponse:
    id: int = 0
    company_id: Optional[str] = None
    note: Optional[str] = None
    rebate_code_id: int = 0
    rebate_code_sign: Optional[str] = None
    rebate_code_type_id: Optional[int] = None
    rebate_code_type_name: Optional[str] = None
    amount: float = 0.0
    usage: Optional[str] = None
    booking_id: Optional[int] = None
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    service: Optional[RebateCodeServiceResponse] = None
    customer: Optional[RebateCodeCustomerResponse] = None
    price_sign: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeCompanyResponse:
    site_path: Optional[str] = None
    payment_provider_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeResponse:
    id: int = 0
    company_id: Optional[str] = None
    valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
    valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
    # @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
    from_time: datetime.timedelta = datetime.timedelta()
    """
    If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
    """


    # @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
    to_time: datetime.timedelta = datetime.timedelta()
    """
    If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
    """


    created_by: Optional[str] = None
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    updated_by: Optional[str] = None
    updated: datetime.datetime = datetime.datetime(1, 1, 1)
    personal_note: Optional[str] = None
    rebate_code_sign: Optional[str] = None
    rebate_code_value: int = 0
    rebate_code_type_id: int = 0
    name: Optional[str] = None
    rebate_code_status_id: int = 0
    status_name: Optional[str] = None
    max_number_of_uses: int = 0
    max_number_of_uses_per_customer: int = 0
    number_of_uses_used: int = 0
    days_of_week: List[DaysOfWeekResponse] = field(default_factory=list)
    services: List[RebateCodeServiceResponse] = field(default_factory=list)
    article: Optional[ArticleResponse] = None
    transactions: List[RebateCodeTransactionQueryResponse] = field(default_factory=list)
    remaining_amount: Optional[float] = None
    remaining_usage: Optional[int] = None
    customers: List[RebateCodeCustomerResponse] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None
    payment_received: bool = False
    rebate_code_currency_sign: Optional[str] = None
    active_by_status: bool = False
    price_sign: Optional[str] = None
    rebate_code_type_name: Optional[str] = None
    company: Optional[RebateCodeCompanyResponse] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PromoCodeReceiver:
    customer_id: Optional[str] = None
    firstname: Optional[str] = None
    lastname: Optional[str] = None
    email: Optional[str] = None
    receiver_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceAddressToHandle(IInvoiceAddress):
    corporate_identity_number: Optional[str] = None
    invoice_address1: Optional[str] = None
    invoice_address2: Optional[str] = None
    invoice_city: Optional[str] = None
    invoice_postal_code: Optional[str] = None
    invoice_country_code: Optional[str] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateRebateCode:
    # @ApiMember(Description="")
    company_id: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="The default value is 9999")
    max_number_of_uses: Optional[int] = None
    """
    The default value is 9999
    """


    # @ApiMember(Description="The default value is 1")
    max_number_of_uses_per_customer: Optional[int] = None
    """
    The default value is 1
    """


    # @ApiMember(Description="", IsRequired=true)
    valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    
    """

    # @ApiMember(Description="", IsRequired=true)
    valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    
    """

    # @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
    from_time: Optional[datetime.timedelta] = None
    """
    If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
    """


    # @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
    to_time: Optional[datetime.timedelta] = None
    """
    If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
    """


    # @ApiMember(Description="1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard", IsRequired=true)
    rebate_code_type_id: int = 0
    """
    1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard
    """


    # @ApiMember(Description="If it's connected to an Article, add the Article Id here.")
    article_id: Optional[int] = None
    """
    If it's connected to an Article, add the Article Id here.
    """


    # @ApiMember(Description="", IsRequired=true)
    rebate_code_value: int = 0
    """
    
    """

    # @ApiMember(Description="If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes")
    rebate_code_sign: Optional[str] = None
    """
    If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes
    """


    # @ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")
    auto_generate_rebate_code_sign: bool = False
    """
    AutoGenerateRebateCodeSign=true - random generate code
    """


    # @ApiMember(Description="")
    personal_note: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="")
    days_of_week: List[int] = field(default_factory=list)
    """
    
    """

    # @ApiMember(Description="")
    services: List[int] = field(default_factory=list)
    """
    
    """

    # @ApiMember(Description="")
    customers: List[str] = field(default_factory=list)
    """
    
    """

    # @ApiMember(Description="The price")
    price_vat: Optional[Decimal] = None
    """
    The price
    """


    # @ApiMember(Description="The price currency")
    currency_id: Optional[str] = None
    """
    The price currency
    """


    # @ApiMember(Description="Promo code receiver information")
    promo_code_receiver: Optional[PromoCodeReceiver] = None
    """
    Promo code receiver information
    """


    # @ApiMember(Description="If you wish to save some invoice address information for the rebate code, you can do so here. This is optional.")
    invoice_address: Optional[InvoiceAddressToHandle] = None
    """
    If you wish to save some invoice address information for the rebate code, you can do so here. This is optional.
    """

Python CreateRebateCode 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.

POST /rebatecodes HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateRebateCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleId>0</ArticleId>
  <AutoGenerateRebateCodeSign>false</AutoGenerateRebateCodeSign>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CurrencyId>String</CurrencyId>
  <Customers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Customers>
  <DaysOfWeek xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DaysOfWeek>
  <FromTime>PT0S</FromTime>
  <InvoiceAddress>
    <CorporateIdentityNumber>String</CorporateIdentityNumber>
    <InvoiceAddress1>String</InvoiceAddress1>
    <InvoiceAddress2>String</InvoiceAddress2>
    <InvoiceCity>String</InvoiceCity>
    <InvoiceCountryCode>String</InvoiceCountryCode>
    <InvoicePostalCode>String</InvoicePostalCode>
  </InvoiceAddress>
  <MaxNumberOfUses>0</MaxNumberOfUses>
  <MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer>
  <PersonalNote>String</PersonalNote>
  <PriceVat>0</PriceVat>
  <PromoCodeReceiver>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <ReceiverMessage>String</ReceiverMessage>
  </PromoCodeReceiver>
  <RebateCodeSign>String</RebateCodeSign>
  <RebateCodeTypeId>0</RebateCodeTypeId>
  <RebateCodeValue>0</RebateCodeValue>
  <Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Services>
  <ToTime>PT0S</ToTime>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</CreateRebateCode>

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

<RebateCodeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ActiveByStatus>false</ActiveByStatus>
  <Article>
    <Active>false</Active>
    <Amount>0</Amount>
    <ArticleTypeId>0</ArticleTypeId>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CurrencyId>String</CurrencyId>
    <Description>String</Description>
    <Id>0</Id>
    <ImageUrl>String</ImageUrl>
    <Name>String</Name>
    <Price>0</Price>
    <PriceSign>String</PriceSign>
    <ServiceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </ServiceIds>
    <Services xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
      <d3p1:ArticleServiceRelation>
        <d3p1:ArticleId>0</d3p1:ArticleId>
        <d3p1:CompanyId>00000000-0000-0000-0000-000000000000</d3p1:CompanyId>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:ServiceId>0</d3p1:ServiceId>
      </d3p1:ArticleServiceRelation>
    </Services>
    <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
    <VAT>0</VAT>
  </Article>
  <Company>
    <PaymentProviderId>0</PaymentProviderId>
    <SitePath>String</SitePath>
  </Company>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <CreatedBy>String</CreatedBy>
  <Customers>
    <RebateCodeCustomerResponse>
      <Email>String</Email>
      <Firstname>String</Firstname>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ImageUrl>String</ImageUrl>
      <Lastname>String</Lastname>
      <Phone>String</Phone>
    </RebateCodeCustomerResponse>
  </Customers>
  <DaysOfWeek>
    <DaysOfWeekResponse>
      <DayOfWeek>String</DayOfWeek>
      <DayOfWeekActive>false</DayOfWeekActive>
      <DayOfWeekSortOrder>0</DayOfWeekSortOrder>
      <DayOfWeekTranslation>String</DayOfWeekTranslation>
      <Id>0</Id>
    </DaysOfWeekResponse>
  </DaysOfWeek>
  <FromTime>PT0S</FromTime>
  <Id>0</Id>
  <MaxNumberOfUses>0</MaxNumberOfUses>
  <MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer>
  <Name>String</Name>
  <NumberOfUsesUsed>0</NumberOfUsesUsed>
  <PaymentReceived>false</PaymentReceived>
  <PersonalNote>String</PersonalNote>
  <PriceSign>String</PriceSign>
  <RebateCodeCurrencySign>String</RebateCodeCurrencySign>
  <RebateCodeSign>String</RebateCodeSign>
  <RebateCodeStatusId>0</RebateCodeStatusId>
  <RebateCodeTypeId>0</RebateCodeTypeId>
  <RebateCodeTypeName>String</RebateCodeTypeName>
  <RebateCodeValue>0</RebateCodeValue>
  <RemainingAmount>0</RemainingAmount>
  <RemainingUsage>0</RemainingUsage>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Services>
    <RebateCodeServiceResponse>
      <Active>false</Active>
      <Description>String</Description>
      <Id>0</Id>
      <Name>String</Name>
    </RebateCodeServiceResponse>
  </Services>
  <StatusName>String</StatusName>
  <ToTime>PT0S</ToTime>
  <Transactions>
    <RebateCodeTransactionQueryResponse>
      <Amount>0</Amount>
      <BookingId>0</BookingId>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Customer>
        <Email>String</Email>
        <Firstname>String</Firstname>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <ImageUrl>String</ImageUrl>
        <Lastname>String</Lastname>
        <Phone>String</Phone>
      </Customer>
      <Id>0</Id>
      <Note>String</Note>
      <PriceSign>String</PriceSign>
      <RebateCodeId>0</RebateCodeId>
      <RebateCodeSign>String</RebateCodeSign>
      <RebateCodeTypeId>0</RebateCodeTypeId>
      <RebateCodeTypeName>String</RebateCodeTypeName>
      <Service>
        <Active>false</Active>
        <Description>String</Description>
        <Id>0</Id>
        <Name>String</Name>
      </Service>
      <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
      <Usage>String</Usage>
    </RebateCodeTransactionQueryResponse>
  </Transactions>
  <Updated>0001-01-01T00:00:00</Updated>
  <UpdatedBy>String</UpdatedBy>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</RebateCodeResponse>