| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /voss/usage | Add product to company invoicing | Add new product to company invoicing. Sends that product to VOSS System. |
|---|
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
class ProductGroupTypeEnum(str, Enum):
OPTIONAL = 'Optional'
INCLUDED = 'Included'
class StatusEnum(str, Enum):
ACTIVE = 'Active'
TERMINATED = 'Terminated'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionProductGroupProductResultDto:
id: Optional[str] = None
name: Optional[str] = None
external_id: Optional[str] = None
article_number: Optional[str] = None
class TypeEnum(str, Enum):
AT_SUBSCRIPTION_BILLING_PERIOD_END = 'AtSubscriptionBillingPeriodEnd'
AT_BINDING_PERIOD_END = 'AtBindingPeriodEnd'
IMMEDIATELY = 'Immediately'
class SourceEnum(str, Enum):
DIRECT = 'Direct'
PLAN = 'Plan'
CUSTOMER_EXPIRATION = 'CustomerExpiration'
UPDATE = 'Update'
UNPAID = 'Unpaid'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionItemTerminationReasonDto:
reason_id: Optional[str] = None
reason_name: Optional[str] = None
reason_external_id: Optional[str] = None
sub_reason_id: Optional[str] = None
sub_reason_name: Optional[str] = None
sub_reason_external_id: Optional[str] = None
comment: Optional[str] = None
class SubscriptionBehaviourEnum(str, Enum):
PRORATE = 'Prorate'
FULL = 'Full'
NONE = 'None'
class CreditKindEnum(str, Enum):
NORMAL = 'Normal'
INTERNAL = 'Internal'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditOptionsDto:
subscription_behaviour: Optional[SubscriptionBehaviourEnum] = None
credit_kind: Optional[CreditKindEnum] = None
prorate_time_anchor: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionItemTerminationDto:
type: Optional[TypeEnum] = None
source: Optional[SourceEnum] = None
scheduled_date: datetime.datetime = datetime.datetime(1, 1, 1)
reason: Optional[SubscriptionItemTerminationReasonDto] = None
credit_options: Optional[CreditOptionsDto] = None
class ProductTypeEnum(str, Enum):
MAIN = 'Main'
ADDON = 'Addon'
LICENSE = 'License'
USAGE = 'Usage'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerBalanceChangeItemDto:
product_type: Optional[ProductTypeEnum] = None
id: Optional[str] = None
name: Optional[str] = None
product_group_id: Optional[str] = None
product_group_name: Optional[str] = None
quantity: float = 0.0
amount: float = 0.0
discount_amount: float = 0.0
total_amount: float = 0.0
invoice_recipient_customer_id: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerBalanceChangeDto:
items: List[CustomerBalanceChangeItemDto] = field(default_factory=list)
total_amount: float = 0.0
total_discount_amount: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateSubscriptionProductGroupResult:
product_group_type: Optional[ProductGroupTypeEnum] = None
status: Optional[StatusEnum] = None
id: Optional[str] = None
name: Optional[str] = None
products: List[SubscriptionProductGroupProductResultDto] = field(default_factory=list)
termination: Optional[SubscriptionItemTerminationDto] = None
created: datetime.datetime = datetime.datetime(1, 1, 1)
customer_balance_change: Optional[CustomerBalanceChangeDto] = 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 CreateVossUsage:
# @ApiMember(Description="The company id", IsRequired=true)
company_id: Optional[str] = None
"""
The company id
"""
# @ApiMember(Description="Article number. Can be fetched from products", IsRequired=true)
article_number: Optional[str] = None
"""
Article number. Can be fetched from products
"""
# @ApiMember(Description="Example: developer worked 6 hours", IsRequired=true)
quantity: int = 0
"""
Example: developer worked 6 hours
"""
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.
POST /voss/usage HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateVossUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ArticleNumber>String</ArticleNumber>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Quantity>0</Quantity>
</CreateVossUsage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CreateSubscriptionProductGroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
<created>0001-01-01T00:00:00</created>
<customerBalanceChange i:nil="true" />
<id>00000000-0000-0000-0000-000000000000</id>
<name>String</name>
<productGroupType>Optional</productGroupType>
<products>
<SubscriptionProductGroupProductResultDto i:nil="true" />
</products>
<status>Active</status>
<termination i:nil="true" />
</CreateSubscriptionProductGroupResult>