Tax Filing Service

<back to all web services

CreateZmXmlFromDefinition

SyncUmsatzsteuerZusammenfassende MeldungReturnBuilderDefinition

A synchronous 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/CreateZmXmlFromDefinition
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>
        '''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

        '''<Summary>
        '''A synchronous service to create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.
        '''</Summary>
        <Api(Description:="A synchronous service to create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")>
        Public Partial Class CreateZmXmlFromDefinition
            Inherits CreateZmXmlFromDefinitionBase
            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 a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.
        '''</Summary>
        <Api(Description:="Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")>
        Public Partial Class CreateZmXmlFromDefinitionBase
            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
    End Namespace
End Namespace

VB.NET CreateZmXmlFromDefinition 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 /CreateZmXmlFromDefinition HTTP/1.1 
Host: taxfiling.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"}}}