Tax Filing Service

<back to all web services

CreateLegacyUstXmlFromDefinitionAsync

AsyncUmsatzsteuerJahressteuererklärungLegacyReturnBuilderDefinition

An asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung).

Requires Authentication
The following routes are available for this service:
POST/CreateLegacyUstXmlFromDefinitionAsyncAn asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions.
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.
*/
// @Api(Description="Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.")
abstract class CreateXmlFromDefinitionBase
{
    /**
    * The 4-digit year of the tax assessment.
    */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    int? jahr;

    /**
    * Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    */
    // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    Map<String,String?>? properties;

    CreateXmlFromDefinitionBase({this.jahr,this.properties});
    CreateXmlFromDefinitionBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        jahr = json['jahr'];
        properties = JsonConverters.toStringMap(json['properties']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'jahr': jahr,
        'properties': properties
    };

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

/**
* Create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions. Only applicable to assessment years 2018 - 2020
*/
// @Api(Description="Create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions. Only applicable to assessment years 2018 - 2020")
abstract class CreateLegacyUstXmlFromDefinitionBase extends CreateXmlFromDefinitionBase implements IPost
{
    /**
    * The 4-digit year of the tax assessment.
    */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    int? jahr;

    /**
    * Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    */
    // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    Map<String,String?>? properties;

    CreateLegacyUstXmlFromDefinitionBase({this.jahr,this.properties});
    CreateLegacyUstXmlFromDefinitionBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        jahr = json['jahr'];
        properties = JsonConverters.toStringMap(json['properties']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'jahr': jahr,
        'properties': properties
    });

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

/**
* Represents the response from a service that generates XML content.
*/
// @Api(Description="Represents the response from a service that generates XML content.")
class XmlResponse implements IConvertible
{
    /**
    * The XML-based content of the response.
    */
    // @ApiMember(Description="The XML-based content of the response.")
    String? content;

    /**
    * Metadata that contains structured error information on the XML response.
    */
    // @ApiMember(Description="Metadata that contains structured error information on the XML response.")
    ResponseStatus? responseStatus;

    XmlResponse({this.content,this.responseStatus});
    XmlResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'content': content,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

/**
* An asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung).
*/
// @Api(Description="An asynchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung).")
class CreateLegacyUstXmlFromDefinitionAsync extends CreateLegacyUstXmlFromDefinitionBase implements IConvertible
{
    /**
    * The 4-digit year of the tax assessment.
    */
    // @ApiMember(Description="The 4-digit year of the tax assessment.")
    int? jahr;

    /**
    * Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.
    */
    // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
    Map<String,String?>? properties;

    CreateLegacyUstXmlFromDefinitionAsync({this.jahr,this.properties});
    CreateLegacyUstXmlFromDefinitionAsync.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        jahr = json['jahr'];
        properties = JsonConverters.toStringMap(json['properties']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'jahr': jahr,
        'properties': properties
    });

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

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'CreateXmlFromDefinitionBase': TypeInfo(TypeOf.AbstractClass),
    'CreateLegacyUstXmlFromDefinitionBase': TypeInfo(TypeOf.AbstractClass),
    'XmlResponse': TypeInfo(TypeOf.Class, create:() => XmlResponse()),
    'CreateLegacyUstXmlFromDefinitionAsync': TypeInfo(TypeOf.Class, create:() => CreateLegacyUstXmlFromDefinitionAsync()),
});

Dart CreateLegacyUstXmlFromDefinitionAsync DTOs

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

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /CreateLegacyUstXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length

{"jahr":0,"properties":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{"content":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}