Tax Filing Service

CreateLegacyUstXmlFromDefinition

SyncUmsatzsteuerJahressteuererklärungLegacyReturnBuilderDefinition

A synchronous service to create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions.

The following routes are available for this service:
POST	/CreateLegacyUstXmlFromDefinition	A synchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions.

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 an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions. Only applicable to assessment years 2018 - 2020")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateLegacyUstXmlFromDefinitionBase(CreateXmlFromDefinitionBase, IReturn[XmlResponse], IPost):
    """
    Create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions. Only applicable to assessment years 2018 - 2020
    """

    # @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="A synchronous service to create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions. ")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateLegacyUstXmlFromDefinition(CreateLegacyUstXmlFromDefinitionBase):
    """
    A synchronous service to create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) 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 CreateLegacyUstXmlFromDefinition DTOs

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

HTTP + XML

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

POST /CreateLegacyUstXmlFromDefinition HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateLegacyUstXmlFromDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests">
  <Jahr>0</Jahr>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
</CreateLegacyUstXmlFromDefinition>

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

<XmlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Content>String</Content>
  <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>
</XmlResponse>