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.

export enum VatType
{
    UStVA = 'UStVA',
    UStDV = 'UStDV',
    UStSV = 'UStSV',
    USt = 'USt',
    ZM = 'ZM',
}

/** @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. */
// @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.")
export class GetDefinitionKeysBase implements IGet
{
    /** @description The year of the assessment (Veranlagungsjahr). */
    // @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
    public year: number;

    /** @description The type of VAT return. */
    // @ApiMember(Description="The type of VAT return.")
    public vatType: VatType;

    public constructor(init?: Partial<GetDefinitionKeysBase>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class GetDefinitionKeys extends GetDefinitionKeysBase
{
    /** @description The year of the assessment (Veranlagungsjahr). */
    // @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
    public year: number;

    /** @description The type of VAT return. */
    // @ApiMember(Description="The type of VAT return.")
    public vatType: VatType;

    public constructor(init?: Partial<GetDefinitionKeys>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}]