Tax Filing Service

<back to all web services

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.

Requires Authentication
The following routes are available for this service:
POST/CreateLegacyUstXmlFromDefinitionA 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 java.math.*
import java.util.*
import net.servicestack.client.*


/**
* 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. 
*/
@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. ")
open class CreateLegacyUstXmlFromDefinition : CreateLegacyUstXmlFromDefinitionBase()
{
    /**
    * The 4-digit year of the tax assessment.
    */
    @ApiMember(Description="The 4-digit year of the tax assessment.")
    var jahr:Int? = null

    /**
    * 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.
    */
    @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.")
    var properties:HashMap<String,String> = HashMap<String,String>()
}

/**
* 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
*/
@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")
open class CreateLegacyUstXmlFromDefinitionBase : CreateXmlFromDefinitionBase(), IPost
{
    /**
    * The 4-digit year of the tax assessment.
    */
    @ApiMember(Description="The 4-digit year of the tax assessment.")
    var jahr:Int? = null

    /**
    * 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.
    */
    @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.")
    var properties:HashMap<String,String> = HashMap<String,String>()
}

/**
* Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.
*/
@Api(Description="Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.")
open class CreateXmlFromDefinitionBase
{
    /**
    * The 4-digit year of the tax assessment.
    */
    @ApiMember(Description="The 4-digit year of the tax assessment.")
    var jahr:Int? = null

    /**
    * 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.
    */
    @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.")
    var properties:HashMap<String,String> = HashMap<String,String>()
}

/**
* Represents the response from a service that generates XML content.
*/
@Api(Description="Represents the response from a service that generates XML content.")
open class XmlResponse
{
    /**
    * The XML-based content of the response.
    */
    @ApiMember(Description="The XML-based content of the response.")
    var content:String? = null

    /**
    * Metadata that contains structured error information on the XML response.
    */
    @ApiMember(Description="Metadata that contains structured error information on the XML response.")
    var responseStatus:ResponseStatus? = null
}

Kotlin CreateLegacyUstXmlFromDefinition DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"jahr":0,"properties":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}