<back to all web services

GetDefinitionKeysAsync

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

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

enum VatType
{
    UStVA,
    UStDV,
    UStSV,
    USt,
    ZM,
}

/**
* 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.")
abstract class GetDefinitionKeysBase implements IGet
{
    /**
    * The year of the assessment (Veranlagungsjahr).
    */
    // @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
    int? year;

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

    GetDefinitionKeysBase({this.year,this.vatType});
    GetDefinitionKeysBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        year = json['year'];
        vatType = JsonConverters.fromJson(json['vatType'],'VatType',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'year': year,
        'vatType': JsonConverters.toJson(vatType,'VatType',context!)
    };

    getTypeName() => "GetDefinitionKeysBase";
    TypeContext? context = _ctx;
}

/**
* An asynchronous service to retrieve keys for the identification of VAT properties.
*/
// @Api(Description="An asynchronous service to retrieve keys for the identification of VAT properties.")
class GetDefinitionKeysAsync extends GetDefinitionKeysBase implements IConvertible
{
    /**
    * The year of the assessment (Veranlagungsjahr).
    */
    // @ApiMember(Description="The year of the assessment (Veranlagungsjahr).")
    int? year;

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

    GetDefinitionKeysAsync({this.year,this.vatType});
    GetDefinitionKeysAsync.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        year = json['year'];
        vatType = JsonConverters.fromJson(json['vatType'],'VatType',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'year': year,
        'vatType': JsonConverters.toJson(vatType,'VatType',context!)
    });

    getTypeName() => "GetDefinitionKeysAsync";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'VatType': TypeInfo(TypeOf.Enum, enumValues:VatType.values),
    'GetDefinitionKeysBase': TypeInfo(TypeOf.AbstractClass),
    'GetDefinitionKeysAsync': TypeInfo(TypeOf.Class, create:() => GetDefinitionKeysAsync()),
});

Dart GetDefinitionKeysAsync DTOs

GET /GetDefinitionKeysAsync 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
	}
]