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.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests
Imports PwC.xEric.Core.Services.Contracts.Responses

Namespace Global

    Namespace PwC.xEric.Core.Services.Contracts.Responses

        '''<Summary>
        '''Represents the response from a service that generates XML content.
        '''</Summary>
        <Api(Description:="Represents the response from a service that generates XML content.")>
        Public Partial Class XmlResponse
            '''<Summary>
            '''The XML-based content of the response.
            '''</Summary>
            <ApiMember(Description:="The XML-based content of the response.")>
            Public Overridable Property Content As String

            '''<Summary>
            '''Metadata that contains structured error information on the XML response.
            '''</Summary>
            <ApiMember(Description:="Metadata that contains structured error information on the XML response.")>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests

        '''<Summary>
        '''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. 
        '''</Summary>
        <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. ")>
        Public Partial Class CreateLegacyUstXmlFromDefinition
            Inherits CreateLegacyUstXmlFromDefinitionBase
            Public Sub New()
                Properties = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''The 4-digit year of the tax assessment.
            '''</Summary>
            <ApiMember(Description:="The 4-digit year of the tax assessment.")>
            Public Overridable Property Jahr As Integer

            '''<Summary>
            '''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.
            '''</Summary>
            <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.")>
            Public Overridable Property Properties As Dictionary(Of String, String)
        End Class

        '''<Summary>
        '''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
        '''</Summary>
        <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")>
        Public Partial Class CreateLegacyUstXmlFromDefinitionBase
            Inherits CreateXmlFromDefinitionBase
            Implements IPost
            Public Sub New()
                Properties = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''The 4-digit year of the tax assessment.
            '''</Summary>
            <ApiMember(Description:="The 4-digit year of the tax assessment.")>
            Public Overridable Property Jahr As Integer

            '''<Summary>
            '''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.
            '''</Summary>
            <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.")>
            Public Overridable Property Properties As Dictionary(Of String, String)
        End Class

        '''<Summary>
        '''Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.
        '''</Summary>
        <Api(Description:="Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.")>
        Public Partial Class CreateXmlFromDefinitionBase
            Public Sub New()
                Properties = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''The 4-digit year of the tax assessment.
            '''</Summary>
            <ApiMember(Description:="The 4-digit year of the tax assessment.")>
            Public Overridable Property Jahr As Integer

            '''<Summary>
            '''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.
            '''</Summary>
            <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.")>
            Public Overridable Property Properties As Dictionary(Of String, String)
        End Class
    End Namespace
End Namespace

VB.NET 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>