Tax Filing Service

<back to all web services

CreateZmXmlFromDefinitionAsync

AsyncUmsatzsteuerZusammenfassende MeldungReturnBuilderDefinition

An asynchronous service to create xml content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.

Requires Authentication
The following routes are available for this service:
POST/CreateZmXmlFromDefinitionAsync
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


# @Api(Description="Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateXmlFromDefinitionBase:
    """
    Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.
    """

    # @ApiMember(Description="The 4-digit year of the tax assessment.")
    jahr: int = 0
    """
    The 4-digit year of the tax assessment.
    """


    # @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    properties: Optional[Dict[str, str]] = None
    """
    Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    """


# @Api(Description="Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateZmXmlFromDefinitionBase(CreateXmlFromDefinitionBase, IReturn[XmlResponse], IPost):
    """
    Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.
    """

    # @ApiMember(Description="The 4-digit year of the tax assessment.")
    jahr: int = 0
    """
    The 4-digit year of the tax assessment.
    """


    # @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    properties: Optional[Dict[str, str]] = None
    """
    Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    """
    @staticmethod
    def response_type(): return XmlResponse


# @Api(Description="Represents the response from a service that generates XML content.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class XmlResponse:
    """
    Represents the response from a service that generates XML content.
    """

    # @ApiMember(Description="The XML-based content of the response.")
    content: Optional[str] = None
    """
    The XML-based content of the response.
    """


    # @ApiMember(Description="Metadata that contains structured error information on the XML response.")
    response_status: Optional[ResponseStatus] = None
    """
    Metadata that contains structured error information on the XML response.
    """


# @Api(Description="An asynchronous service to create xml content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateZmXmlFromDefinitionAsync(CreateZmXmlFromDefinitionBase):
    """
    An asynchronous service to create xml content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.
    """

    # @ApiMember(Description="The 4-digit year of the tax assessment.")
    jahr: int = 0
    """
    The 4-digit year of the tax assessment.
    """


    # @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    properties: Optional[Dict[str, str]] = None
    """
    Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    """

Python CreateZmXmlFromDefinitionAsync DTOs

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

HTTP + X-MSGPACK

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

POST /CreateZmXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"jahr":0,"properties":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

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