Server

<back to all web services

GetNebenkostenList

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 NebenkostenTargetAllocation(str, Enum):
    NULL = 'Null'
    ALLE_NUTZER = 'AlleNutzer'
    ZUGEORDNETE_NUTZER = 'ZugeordneteNutzer'
    ZUGEORDNETE_NUTZEINHEITEN = 'ZugeordneteNutzeinheiten'
    ZUGEORDNETE_NUTZER_DIFF = 'ZugeordneteNutzerDiff'
    ZUGEORDNETE_NUTZEINHEITEN_DIFF = 'ZugeordneteNutzeinheitenDiff'


class NebenkostenTargetAllocationIn(str, Enum):
    NEBENKOSTEN = 'Nebenkosten'
    HEIZKOSTEN = 'Heizkosten'
    WARMWASSERKOSTEN = 'Warmwasserkosten'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NebenkostenNutzeinheit:
    relative_amount: Optional[Decimal] = None
    is_deleted: bool = False
    is_created_by_app: bool = False
    nutzeinheit_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NebenkostenNutzer:
    relative_amount: Optional[Decimal] = None
    is_deleted: bool = False
    is_created_by_app: bool = False
    nutzer_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingInformation:
    guid: Optional[str] = None
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    is_completed: bool = False
    has_nebenkosten: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Nebenkosten:
    guid: Optional[str] = None
    number: int = 0
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    target_allocation: Optional[NebenkostenTargetAllocation] = None
    target_allocation_in: Optional[NebenkostenTargetAllocationIn] = None
    nebenkosten_kind: Optional[str] = None
    # @ApiMember(Description="Freitext")
    kostenart: Optional[str] = None
    """
    Freitext
    """


    brutto: Optional[Decimal] = None
    brutto_last_year: Optional[Decimal] = None
    sales_tax: Optional[Decimal] = None
    haushaltsnahedienste_label: Optional[str] = None
    haushaltsnahedienste_brutto: Optional[Decimal] = None
    # @ApiMember(Description="Freitext")
    kostenart_unit: Optional[str] = None
    """
    Freitext
    """


    reduzierungsart_type: Optional[str] = None
    comment: Optional[str] = None
    is_deleted: bool = False
    is_created_by_app: bool = False
    nebenkosten_nutzeinheiten: Optional[List[NebenkostenNutzeinheit]] = None
    nebenkosten_nutzer: Optional[List[NebenkostenNutzer]] = None
    billing_information: Optional[BillingInformation] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetNebenkostenListResponse:
    nebenkosten_list: Optional[List[Nebenkosten]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetNebenkostenList(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="query")
    bearer_token: Optional[str] = None

    # @ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*", ParameterType="query")
    filter_by_objekt_guid: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*
    """


    # @ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*", ParameterType="query")
    filter_by_billing_information_guid: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*
    """

Python GetNebenkostenList DTOs

GET /api/v1/nebenkosten HTTP/1.1 
Host: bdl-servdesk.eras-online.de 
Accept: application/xml

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

<GetNebenkostenListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <NebenkostenList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <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>
</GetNebenkostenListResponse>