Tax Filing Service

CreateLegacyUstXmlFromDefinitionAsync

AsyncUmsatzsteuerJahressteuererklärungLegacyReturnBuilderDefinition

An asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung).

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

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 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")>]
    [<AllowNullLiteral>]
    type CreateLegacyUstXmlFromDefinitionBase() = 
        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>
    ///An asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung).
    ///</summary>
    [<Api(Description="An asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung).")>]
    [<AllowNullLiteral>]
    type CreateLegacyUstXmlFromDefinitionAsync() = 
        inherit CreateLegacyUstXmlFromDefinitionBase()
        ///<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# CreateLegacyUstXmlFromDefinitionAsync 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 /CreateLegacyUstXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateLegacyUstXmlFromDefinitionAsync 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>
</CreateLegacyUstXmlFromDefinitionAsync>

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>