| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /billing/company/ | Add new billing information. | Add new billing information. |
|---|
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 BaseModel:
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingMethodCountriesRelation(BaseModel):
# @Required()
billing_method_id: int = 0
# @Required()
country_id: Optional[str] = None
modified_date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingMethod(BaseModel):
billing_method_countries_relation: Optional[List[BillingMethodCountriesRelation]] = None
# @Required()
name: Optional[str] = None
# @Required()
description: Optional[str] = None
modified_date: Optional[datetime.datetime] = None
id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingInformationResponse:
# @ApiMember(Description="The company id.")
company_id: Optional[str] = None
"""
The company id.
"""
# @ApiMember(Description="The prefered billing method.", IsRequired=true)
billing_method_id: int = 0
"""
The prefered billing method.
"""
# @ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")
name: Optional[str] = None
"""
The name that should be printed on the billing information, normally this would be your company name.
"""
# @ApiMember(Description="If you want to add the attention to the billing address.")
attention: Optional[str] = None
"""
If you want to add the attention to the billing address.
"""
# @ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")
street1: Optional[str] = None
"""
The street for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The street for the billing adress.")
street2: Optional[str] = None
"""
The street for the billing adress.
"""
# @ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")
zip_code: Optional[str] = None
"""
The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")
city: Optional[str] = None
"""
The city for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")
country_id: Optional[str] = None
"""
The country for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The billing email. This is required when having email invoice as billing method.")
email: Optional[str] = None
"""
The billing email. This is required when having email invoice as billing method.
"""
# @ApiMember(Description="The company global location number.")
gln: Optional[str] = None
"""
The company global location number.
"""
# @ApiMember(Description="You're internal rereference.")
reference_line1: Optional[str] = None
"""
You're internal rereference.
"""
# @ApiMember(Description="You're internal rereference.")
reference_line2: Optional[str] = None
"""
You're internal rereference.
"""
# @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
payment_terms_days: int = 0
"""
The billing payment terms in days. This is default 15 days.
"""
# @ApiMember(Description="The company vat registration number.")
vat_registration_number: Optional[str] = None
"""
The company vat registration number.
"""
# @ApiMember(Description="The billing method options to choose from")
billing_method_options: Optional[List[BillingMethod]] = None
"""
The billing method options to choose from
"""
# @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 AddBillingInformation(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The prefered billing method.", IsRequired=true)
billing_method_id: int = 0
"""
The prefered billing method.
"""
# @ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")
name: Optional[str] = None
"""
The name that should be printed on the billing information, normally this would be your company name.
"""
# @ApiMember(Description="If you want to add the attention to the billing address.")
attention: Optional[str] = None
"""
If you want to add the attention to the billing address.
"""
# @ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")
street1: Optional[str] = None
"""
The street for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The street for the billing adress.")
street2: Optional[str] = None
"""
The street for the billing adress.
"""
# @ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")
zip_code: Optional[str] = None
"""
The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")
city: Optional[str] = None
"""
The city for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")
country_id: Optional[str] = None
"""
The country for the billing adress. This is required when having postal invoice as billing method.
"""
# @ApiMember(Description="The billing email. This is required when having email invoice as billing method.")
email: Optional[str] = None
"""
The billing email. This is required when having email invoice as billing method.
"""
# @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
payment_terms_days: Optional[int] = None
"""
The billing payment terms in days. This is default 15 days.
"""
# @ApiMember(Description="The company vat registration number.")
vat_registration_number: Optional[str] = None
"""
The company vat registration number.
"""
# @ApiMember(Description="The company global location number.")
gln: Optional[str] = None
"""
The company global location number.
"""
# @ApiMember(Description="You're internal rereference.")
reference_line1: Optional[str] = None
"""
You're internal rereference.
"""
# @ApiMember(Description="You're internal rereference.")
reference_line2: Optional[str] = None
"""
You're internal rereference.
"""
Python AddBillingInformation 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.
POST /billing/company/ HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddBillingInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Attention>String</Attention>
<BillingMethodId>0</BillingMethodId>
<City>String</City>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CountryId>String</CountryId>
<Email>String</Email>
<GLN>String</GLN>
<Name>String</Name>
<PaymentTermsDays>0</PaymentTermsDays>
<ReferenceLine1>String</ReferenceLine1>
<ReferenceLine2>String</ReferenceLine2>
<Street1>String</Street1>
<Street2>String</Street2>
<VatRegistrationNumber>String</VatRegistrationNumber>
<ZipCode>String</ZipCode>
</AddBillingInformation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BillingInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Attention>String</Attention>
<BillingMethodId>0</BillingMethodId>
<BillingMethodOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d2p1:BillingMethod>
<d2p1:BillingMethodCountriesRelation>
<d2p1:BillingMethodCountriesRelation>
<d2p1:BillingMethodId>0</d2p1:BillingMethodId>
<d2p1:CountryId>String</d2p1:CountryId>
<d2p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</d2p1:ModifiedDate>
</d2p1:BillingMethodCountriesRelation>
</d2p1:BillingMethodCountriesRelation>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</d2p1:ModifiedDate>
<d2p1:Name>String</d2p1:Name>
</d2p1:BillingMethod>
</BillingMethodOptions>
<City>String</City>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CountryId>String</CountryId>
<Email>String</Email>
<GLN>String</GLN>
<Name>String</Name>
<PaymentTermsDays>0</PaymentTermsDays>
<ReferenceLine1>String</ReferenceLine1>
<ReferenceLine2>String</ReferenceLine2>
<Street1>String</Street1>
<Street2>String</Street2>
<VatRegistrationNumber>String</VatRegistrationNumber>
<ZipCode>String</ZipCode>
</BillingInformationResponse>