Tax Filing Service

GetDefinitionKeys

SyncUmsatzsteuerKeysReturnBuilder

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

The following routes are available for this service:
GET	/GetDefinitionKeys	A synchronous service to retrieve keys for the identification of VAT properties.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests;
using PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Helpers;

namespace PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Helpers
{
    public enum VatType
    {
        UStVA,
        UStDV,
        UStSV,
        USt,
        ZM,
    }

}

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
        : GetDefinitionKeysBase
    {
        ///<summary>
        ///The year of the assessment (Veranlagungsjahr).
        ///</summary>
        [ApiMember(Description="The year of the assessment (Veranlagungsjahr).")]
        public virtual int Year { get; set; }

        ///<summary>
        ///The type of VAT return.
        ///</summary>
        [ApiMember(Description="The type of VAT return.")]
        public virtual VatType VatType { get; set; }
    }

    ///<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.")]
    public partial class GetDefinitionKeysBase
        : IGet
    {
        ///<summary>
        ///The year of the assessment (Veranlagungsjahr).
        ///</summary>
        [ApiMember(Description="The year of the assessment (Veranlagungsjahr).")]
        public virtual int Year { get; set; }

        ///<summary>
        ///The type of VAT return.
        ///</summary>
        [ApiMember(Description="The type of VAT return.")]
        public virtual VatType VatType { get; set; }
    }

}

C# GetDefinitionKeys DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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