<back to all web services

CheckElsterAsync

An asynchronous service to perform basic checks on a batch of tax data.

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

/**
* Represents a structure that encapsulates a tax declaration.
*/
// @Api(Description="Represents a structure that encapsulates a tax declaration.")
class TaxData implements IConvertible
{
    /**
    * The unique identifier of the tax data.
    */
    // @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
    String? id;

    /**
    * The XML-based tax declaration.
    */
    // @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
    String? content;

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

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        content = json['content'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'content': content
    };

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

/**
* A base service to perform basic checks on a batch of tax data.
*/
// @Api(Description="A base service to perform basic checks on a batch of tax data.")
abstract class CheckElsterBase implements IPost
{
    /**
    * The ELSTER tax data to check.
    */
    // @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
    TaxData? data;

    CheckElsterBase({this.data});
    CheckElsterBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'data': JsonConverters.toJson(data,'TaxData',context!)
    };

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

/**
* Specifies a service response from an ERiC service operation.
*/
// @Api(Description="Specifies a service response from an ERiC service operation.")
abstract class ServiceReponseBase implements IHasIndex
{
    /**
    * The unique identifier of the response.
    */
    // @ApiMember(Description="The unique identifier of the response.")
    String? id;

    /**
    * The position of the response element in an indexed collection.
    */
    // @ApiMember(Description="The position of the response element in an indexed collection.")
    int? index;

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

    ServiceReponseBase({this.id,this.index,this.responseStatus});
    ServiceReponseBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* Represents a type that encapulates the state of a provided ELSTER tax data.
*/
// @Api(Description="Represents a type that encapulates the state of a provided ELSTER tax data.")
class ElsterCheckResponse extends ServiceReponseBase implements IConvertible
{
    /**
    * Checks whether a portal certificate is required to sign the tax data.
    */
    // @ApiMember(Description="Checks whether a portal certificate is required to sign the tax data.")
    bool? zertifikatErforderlich;

    /**
    * Checks whether a Manufacturer ID has been provided for the tax data.
    */
    // @ApiMember(Description="Checks whether a Manufacturer ID has been provided for the tax data.")
    bool? hatHerstellerId;

    /**
    * Checks whether a data provider has been provided for the tax data.
    */
    // @ApiMember(Description="Checks whether a data provider has been provided for the tax data.")
    bool? hatDatenlieferant;

    /**
    * Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.
    */
    // @ApiMember(Description="Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.")
    bool? transferProtokollDruckbar;

    ElsterCheckResponse({this.zertifikatErforderlich,this.hatHerstellerId,this.hatDatenlieferant,this.transferProtokollDruckbar});
    ElsterCheckResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        zertifikatErforderlich = json['zertifikatErforderlich'];
        hatHerstellerId = json['hatHerstellerId'];
        hatDatenlieferant = json['hatDatenlieferant'];
        transferProtokollDruckbar = json['transferProtokollDruckbar'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'zertifikatErforderlich': zertifikatErforderlich,
        'hatHerstellerId': hatHerstellerId,
        'hatDatenlieferant': hatDatenlieferant,
        'transferProtokollDruckbar': transferProtokollDruckbar
    });

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

/**
* An asynchronous service to perform basic checks on a batch of tax data.
*/
// @Api(Description="An asynchronous service to perform basic checks on a batch of tax data.")
class CheckElsterAsync extends CheckElsterBase implements IConvertible
{
    CheckElsterAsync();
    CheckElsterAsync.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "CheckElsterAsync";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'taxfiling.staging.pwc.de', types: <String, TypeInfo> {
    'TaxData': TypeInfo(TypeOf.Class, create:() => TaxData()),
    'CheckElsterBase': TypeInfo(TypeOf.AbstractClass),
    'ServiceReponseBase': TypeInfo(TypeOf.AbstractClass),
    'ElsterCheckResponse': TypeInfo(TypeOf.Class, create:() => ElsterCheckResponse()),
    'CheckElsterAsync': TypeInfo(TypeOf.Class, create:() => CheckElsterAsync()),
});

Dart CheckElsterAsync DTOs

POST /CheckElsterAsync HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		id: String,
		content: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	zertifikatErforderlich: False,
	hatHerstellerId: False,
	hatDatenlieferant: False,
	transferProtokollDruckbar: False,
	id: String,
	index: 0,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}