Server

<back to all web services

PostNebenkosten

Nebenkosten
Requires Authentication
The following routes are available for this service:
POST/api/v1/nebenkosten
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 PostNebenkostenResponse:
    response_status: Optional[ResponseStatus] = None
    checksum_m_d5: Optional[str] = None


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 RelatedTo:
    guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostNebenkosten(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="body")
    nebenkosten: Optional[Nebenkosten] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    related_to_objekt: Optional[RelatedTo] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    related_to_billing_information: Optional[RelatedTo] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    bearer_token: Optional[str] = None

Python PostNebenkosten DTOs

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

HTTP + JSV

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

POST /api/v1/nebenkosten HTTP/1.1 
Host: korrekt-gera-servdesk.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	nebenkosten: 
	{
		guid: 00000000000000000000000000000000,
		number: 0,
		from: 0001-01-01T00:00:00Z,
		to: 0001-01-01T00:00:00Z,
		targetAllocation: Null,
		targetAllocationIn: Nebenkosten,
		nebenkostenKind: String,
		kostenart: String,
		brutto: 0,
		bruttoLastYear: 0,
		salesTax: 0,
		haushaltsnahediensteLabel: String,
		haushaltsnahediensteBrutto: 0,
		kostenartUnit: String,
		reduzierungsartType: String,
		comment: String,
		isDeleted: False,
		isCreatedByApp: False,
		nebenkostenNutzeinheiten: 
		[
			{
				relativeAmount: 0,
				isDeleted: False,
				isCreatedByApp: False,
				nutzeinheitGuid: 00000000000000000000000000000000
			}
		],
		nebenkostenNutzer: 
		[
			{
				relativeAmount: 0,
				isDeleted: False,
				isCreatedByApp: False,
				nutzerGuid: 00000000000000000000000000000000
			}
		],
		billingInformation: 
		{
			guid: String,
			from: 0001-01-01T00:00:00Z,
			to: 0001-01-01T00:00:00Z,
			isCompleted: False,
			hasNebenkosten: False
		}
	},
	relatedToObjekt: 
	{
		guid: 00000000000000000000000000000000
	},
	relatedToBillingInformation: 
	{
		guid: 00000000000000000000000000000000
	},
	bearerToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	checksumMD5: String
}