Tax Filing Service

<back to all web services

CreateUstVaXmlFromDefinitionAsync

AsyncUmsatzsteuerVoranmeldungReturnBuilderDefinition

An asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions.

Requires Authentication
The following routes are available for this service:
POST/CreateUstVaXmlFromDefinitionAsync
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 a preliminary VAT (Umsatzsteuervoranmeldung) return from the specified dictionary (hash map) of key/value definitions.
*/
// @Api(Description="Create XML content that  represents a preliminary VAT (Umsatzsteuervoranmeldung) return from the specified dictionary (hash map) of key/value definitions.")
abstract class CreateUstVaXmlFromDefinitionBase 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;

    CreateUstVaXmlFromDefinitionBase({this.jahr,this.properties});
    CreateUstVaXmlFromDefinitionBase.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() => "CreateUstVaXmlFromDefinitionBase";
    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 a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions.
*/
// @Api(Description="An asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions.")
class CreateUstVaXmlFromDefinitionAsync extends CreateUstVaXmlFromDefinitionBase 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;

    CreateUstVaXmlFromDefinitionAsync({this.jahr,this.properties});
    CreateUstVaXmlFromDefinitionAsync.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() => "CreateUstVaXmlFromDefinitionAsync";
    TypeContext? context = _ctx;
}

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

Dart CreateUstVaXmlFromDefinitionAsync 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.

POST /CreateUstVaXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUstVaXmlFromDefinitionAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests">
  <Jahr>0</Jahr>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
</CreateUstVaXmlFromDefinitionAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<XmlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Content>String</Content>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</XmlResponse>