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.*


/**
* 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.")
open class GetDefinitionKeys : GetDefinitionKeysBase()
{
    /**
    * The year of the assessment (Veranlagungsjahr).
    */
    @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
    var year:Int? = null

    /**
    * The type of VAT return.
    */
    @ApiMember(Description="The type of VAT return.")
    var vatType:VatType? = null
}

/**
* 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.")
open class GetDefinitionKeysBase : IGet
{
    /**
    * The year of the assessment (Veranlagungsjahr).
    */
    @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
    var year:Int? = null

    /**
    * The type of VAT return.
    */
    @ApiMember(Description="The type of VAT return.")
    var vatType:VatType? = null
}

enum class VatType
{
    UStVA,
    UStDV,
    UStSV,
    USt,
    Zm,
}

Kotlin GetDefinitionKeys DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"name":"String","description":"String","type":"String","mandatory":"String"}]