Tax Filing Service

<back to all web services

BatchCheckElsterAsync

AsyncBearbeiteVorgangÜberprüfung

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

Requires Authentication
The following routes are available for this service:
POST/BatchCheckElsterAsyncAn 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 BatchCheckElsterBase implements IPost
{
    /**
    * The batch of ELSTER tax data to check.
    */
    // @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
    List<TaxData>? data;

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

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

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

    getTypeName() => "BatchCheckElsterBase";
    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 BatchCheckElsterAsync extends BatchCheckElsterBase implements IConvertible
{
    /**
    * The batch of ELSTER tax data to check.
    */
    // @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
    List<TaxData>? data;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'TaxData': TypeInfo(TypeOf.Class, create:() => TaxData()),
    'BatchCheckElsterBase': TypeInfo(TypeOf.AbstractClass),
    'List<TaxData>': TypeInfo(TypeOf.Class, create:() => <TaxData>[]),
    'BatchCheckElsterAsync': TypeInfo(TypeOf.Class, create:() => BatchCheckElsterAsync()),
});

Dart BatchCheckElsterAsync 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 /BatchCheckElsterAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchCheckElsterAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
    <d2p1:TaxData>
      <d2p1:Content>String</d2p1:Content>
      <d2p1:Id>String</d2p1:Id>
    </d2p1:TaxData>
  </Data>
</BatchCheckElsterAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfElsterCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <ElsterCheckResponse>
    <Id>String</Id>
    <Index>0</Index>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <HatDatenlieferant>false</HatDatenlieferant>
    <HatHerstellerId>false</HatHerstellerId>
    <StagingEnabled>false</StagingEnabled>
    <TransferProtokollDruckbar>false</TransferProtokollDruckbar>
    <ZertifikatErforderlich>false</ZertifikatErforderlich>
  </ElsterCheckResponse>
</ArrayOfElsterCheckResponse>