Report Filing Service

BatchValidateReportsAsync

ValidateReportsBatchAsync

Represents a request to validate reports in an asynchronous batch operation.

The following routes are available for this service:
POST	/async/elma/reports/batch/validate

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

/**
* Represents an ELMA report.
*/
// @Api(Description="Represents an ELMA report.")
class Report implements IConvertible
{
    /**
    * The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.
    */
    // @ApiMember(Description="The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
    String? id;

    /**
    * The XML-content of the report.
    */
    // @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
    String? data;

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

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

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

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

/**
* Specifies a request to validate reports in a batch operation.
*/
// @Api(Description="Specifies a request to validate reports in a batch operation.")
abstract class BatchValidateReportsBase implements IPost
{
    /**
    * The reports to validate.
    */
    // @ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")
    List<Report>? reports;

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

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

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

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

/**
* Represents a request to validate reports in an asynchronous batch operation.
*/
// @Api(Description="Represents a request to validate reports in an asynchronous batch operation.")
class BatchValidateReportsAsync extends BatchValidateReportsBase implements IConvertible
{
    BatchValidateReportsAsync();
    BatchValidateReportsAsync.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() => "BatchValidateReportsAsync";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'reportfiling.staging.pwc.de', types: <String, TypeInfo> {
    'Report': TypeInfo(TypeOf.Class, create:() => Report()),
    'BatchValidateReportsBase': TypeInfo(TypeOf.AbstractClass),
    'List<Report>': TypeInfo(TypeOf.Class, create:() => <Report>[]),
    'BatchValidateReportsAsync': TypeInfo(TypeOf.Class, create:() => BatchValidateReportsAsync()),
});

Dart BatchValidateReportsAsync DTOs

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

HTTP + JSV

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

POST /async/elma/reports/batch/validate HTTP/1.1 
Host: reportfiling.staging.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reports: 
	[
		{
			id: String,
			data: String
		}
	]
}

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

[
	{
		id: String,
		validationErrors: 
		[
			{
				id: String,
				message: String,
				severity: Error,
				lineNumber: 0,
				linePosition: 0
			}
		],
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	}
]