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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * 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.")
    public static class CreateZmXmlFromDefinition extends CreateZmXmlFromDefinitionBase
    {
        /**
        * The 4-digit year of the tax assessment.
        */
        @ApiMember(Description="The 4-digit year of the tax assessment.")
        public Integer jahr = 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.")
        public HashMap<String,String> properties = null;
        
        public Integer getJahr() { return jahr; }
        public CreateZmXmlFromDefinition setJahr(Integer value) { this.jahr = value; return this; }
        public HashMap<String,String> getProperties() { return properties; }
        public CreateZmXmlFromDefinition setProperties(HashMap<String,String> value) { this.properties = value; return this; }
    }

    /**
    * 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.")
    public static class CreateZmXmlFromDefinitionBase extends CreateXmlFromDefinitionBase implements IPost
    {
        /**
        * The 4-digit year of the tax assessment.
        */
        @ApiMember(Description="The 4-digit year of the tax assessment.")
        public Integer jahr = 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.")
        public HashMap<String,String> properties = null;
        
        public Integer getJahr() { return jahr; }
        public CreateZmXmlFromDefinitionBase setJahr(Integer value) { this.jahr = value; return this; }
        public HashMap<String,String> getProperties() { return properties; }
        public CreateZmXmlFromDefinitionBase setProperties(HashMap<String,String> value) { this.properties = value; return this; }
    }

    /**
    * 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.")
    public static class CreateXmlFromDefinitionBase
    {
        /**
        * The 4-digit year of the tax assessment.
        */
        @ApiMember(Description="The 4-digit year of the tax assessment.")
        public Integer jahr = 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.")
        public HashMap<String,String> properties = null;
        
        public Integer getJahr() { return jahr; }
        public CreateXmlFromDefinitionBase setJahr(Integer value) { this.jahr = value; return this; }
        public HashMap<String,String> getProperties() { return properties; }
        public CreateXmlFromDefinitionBase setProperties(HashMap<String,String> value) { this.properties = value; return this; }
    }

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

        /**
        * Metadata that contains structured error information on the XML response.
        */
        @ApiMember(Description="Metadata that contains structured error information on the XML response.")
        public ResponseStatus responseStatus = null;
        
        public String getContent() { return content; }
        public XmlResponse setContent(String value) { this.content = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public XmlResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java 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"}}}