Tax Filing Service

GetDefinitionKeysAsync

AsyncUmsatzsteuerKeysReturnBuilder

An asynchronous service to retrieve keys for the identification of VAT properties.

The following routes are available for this service:
GET	/GetDefinitionKeysAsync	An asynchronous service to retrieve keys for the identification of VAT properties.

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

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type VatType =
        | UStVA = 0
        | UStDV = 1
        | UStSV = 2
        | USt = 3
        | ZM = 4

    ///<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.\n Use the retrieved values as keys for the dictionary of properties that Return Builder provides.")>]
    [<AllowNullLiteral>]
    type GetDefinitionKeysBase() = 
        interface IGet
        ///<summary>
        ///The year of the assessment (Veranlagungsjahr).
        ///</summary>
        [<ApiMember(Description="The year of the assessment (Veranlagungsjahr).")>]
        member val Year:Int32 = new Int32() with get,set

        ///<summary>
        ///The type of VAT return.
        ///</summary>
        [<ApiMember(Description="The type of VAT return.")>]
        member val VatType:VatType = new VatType() with get,set

    ///<summary>
    ///An asynchronous service to retrieve keys for the identification of VAT properties.
    ///</summary>
    [<Api(Description="An asynchronous service to retrieve keys for the identification of VAT properties.")>]
    [<AllowNullLiteral>]
    type GetDefinitionKeysAsync() = 
        inherit GetDefinitionKeysBase()
        ///<summary>
        ///The year of the assessment (Veranlagungsjahr).
        ///</summary>
        [<ApiMember(Description="The year of the assessment (Veranlagungsjahr).")>]
        member val Year:Int32 = new Int32() with get,set

        ///<summary>
        ///The type of VAT return.
        ///</summary>
        [<ApiMember(Description="The type of VAT return.")>]
        member val VatType:VatType = new VatType() with get,set

F# GetDefinitionKeysAsync 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 /GetDefinitionKeysAsync 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>