Tax Filing Service

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.

The following routes are available for this service:
POST	/CreateZmXmlFromDefinition

namespace PwC.xEric.Core.Services.Contracts.Responses

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Represents the response from a service that generates XML content.
    ///</summary>
    [<Api(Description="Represents the response from a service that generates XML content.")>]
    [<AllowNullLiteral>]
    type XmlResponse() = 
        ///<summary>
        ///The XML-based content of the response.
        ///</summary>
        [<ApiMember(Description="The XML-based content of the response.")>]
        member val Content:String = null with get,set

        ///<summary>
        ///Metadata that contains structured error information on the XML response.
        ///</summary>
        [<ApiMember(Description="Metadata that contains structured error information on the XML response.")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type CreateXmlFromDefinitionBase() = 
        ///<summary>
        ///The 4-digit year of the tax assessment.
        ///</summary>
        [<ApiMember(Description="The 4-digit year of the tax assessment.")>]
        member val Jahr:Int32 = new Int32() with get,set

        ///<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.")>]
        member val Properties:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type CreateZmXmlFromDefinitionBase() = 
        inherit CreateXmlFromDefinitionBase()
        interface IPost
        ///<summary>
        ///The 4-digit year of the tax assessment.
        ///</summary>
        [<ApiMember(Description="The 4-digit year of the tax assessment.")>]
        member val Jahr:Int32 = new Int32() with get,set

        ///<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.")>]
        member val Properties:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type CreateZmXmlFromDefinition() = 
        inherit CreateZmXmlFromDefinitionBase()
        ///<summary>
        ///The 4-digit year of the tax assessment.
        ///</summary>
        [<ApiMember(Description="The 4-digit year of the tax assessment.")>]
        member val Jahr:Int32 = new Int32() with get,set

        ///<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.")>]
        member val Properties:Dictionary<String, String> = new Dictionary<String, String>() with get,set

F# CreateZmXmlFromDefinition DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"jahr":0,"properties":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}