Tax Filing Service

<back to all web services

GetDefinitionKeys

SyncUmsatzsteuerKeysReturnBuilder

A synchronous service to retrieve keys for the identification of VAT properties.

Requires Authentication
The following routes are available for this service:
GET/GetDefinitionKeysA synchronous service to retrieve keys for the identification of VAT properties.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * A synchronous service to retrieve keys for the identification of VAT properties.
    */
    @Api(Description="A synchronous service to retrieve keys for the identification of VAT properties.")
    public static class GetDefinitionKeys extends GetDefinitionKeysBase
    {
        /**
        * The year of the assessment (Veranlagungsjahr).
        */
        @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
        public Integer year = null;

        /**
        * The type of VAT return.
        */
        @ApiMember(Description="The type of VAT return.")
        public VatType vatType = null;
        
        public Integer getYear() { return year; }
        public GetDefinitionKeys setYear(Integer value) { this.year = value; return this; }
        public VatType getVatType() { return vatType; }
        public GetDefinitionKeys setVatType(VatType value) { this.vatType = value; return this; }
    }

    /**
    * Create a VAT return from a Return Builder definition. Use the retrieved values as keys for the dictionary of properties that Return Builder provides.
    */
    @Api(Description="Create a VAT return from a Return Builder definition.\n Use the retrieved values as keys for the dictionary of properties that Return Builder provides.")
    public static class GetDefinitionKeysBase implements IGet
    {
        /**
        * The year of the assessment (Veranlagungsjahr).
        */
        @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
        public Integer year = null;

        /**
        * The type of VAT return.
        */
        @ApiMember(Description="The type of VAT return.")
        public VatType vatType = null;
        
        public Integer getYear() { return year; }
        public GetDefinitionKeysBase setYear(Integer value) { this.year = value; return this; }
        public VatType getVatType() { return vatType; }
        public GetDefinitionKeysBase setVatType(VatType value) { this.vatType = value; return this; }
    }

    public static enum VatType
    {
        UStVA,
        UStDV,
        UStSV,
        USt,
        Zm;
    }

}

Java GetDefinitionKeys 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.

GET /GetDefinitionKeys HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDefinitionKey xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Helpers">
  <DefinitionKey>
    <Description>String</Description>
    <Mandatory>String</Mandatory>
    <Name>String</Name>
    <Type>String</Type>
  </DefinitionKey>
</ArrayOfDefinitionKey>