BokaMera.API.Host

<back to all web services

UpdateBillingInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/billing/company/Update billing information.Update 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 UpdateBillingInformation(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: Optional[int] = None
    """
    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 UpdateBillingInformation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /billing/company/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","BillingMethodId":0,"Name":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Email":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BillingMethodId":0,"Name":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Email":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","BillingMethodOptions":[{"BillingMethodCountriesRelation":[{"BillingMethodId":0,"CountryId":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}],"Name":"String","Description":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":0}]}