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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests
Imports PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Helpers

Namespace Global

    Namespace PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Helpers

        Public Enum VatType
            UStVA
            UStDV
            UStSV
            USt
            ZM
        End Enum
    End Namespace

    Namespace PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests

        '''<Summary>
        '''A synchronous service to retrieve keys for the identification of VAT properties.
        '''</Summary>
        <Api(Description:="A synchronous service to retrieve keys for the identification of VAT properties.")>
        Public Partial Class GetDefinitionKeys
            Inherits GetDefinitionKeysBase
            '''<Summary>
            '''The year of the assessment (Veranlagungsjahr).
            '''</Summary>
            <ApiMember(Description:="The year of the assessment (Veranlagungsjahr).")>
            Public Overridable Property Year As Integer

            '''<Summary>
            '''The type of VAT return.
            '''</Summary>
            <ApiMember(Description:="The type of VAT return.")>
            Public Overridable Property VatType As VatType
        End Class

        '''<Summary>
        '''Create a VAT return from a Return Builder definition. Use the retrieved values as keys for the dictionary of properties that Return Builder provides.
        '''</Summary>
        <Api(Description:="Create a VAT return from a Return Builder definition.
 Use the retrieved values as keys for the dictionary of properties that Return Builder provides.")>
        Public Partial Class GetDefinitionKeysBase
            Implements IGet
            '''<Summary>
            '''The year of the assessment (Veranlagungsjahr).
            '''</Summary>
            <ApiMember(Description:="The year of the assessment (Veranlagungsjahr).")>
            Public Overridable Property Year As Integer

            '''<Summary>
            '''The type of VAT return.
            '''</Summary>
            <ApiMember(Description:="The type of VAT return.")>
            Public Overridable Property VatType As VatType
        End Class
    End Namespace
End Namespace

VB.NET GetDefinitionKeys DTOs

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

HTTP + JSV

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

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