<back to all web services

CreateZmXmlFromDefinition

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.

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* 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.
*/
@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.")
open class CreateZmXmlFromDefinition : CreateZmXmlFromDefinitionBase()
{
    /**
    * 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 a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.
*/
@Api(Description="Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
open class CreateZmXmlFromDefinitionBase : 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 CreateZmXmlFromDefinition DTOs

POST /CreateZmXmlFromDefinition HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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>