Report Filing Service

<back to all web services

BatchValidateReportsAsync

ValidateReportsBatchAsync

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

Requires Authentication
The following routes are available for this service:
POST/async/elma/reports/batch/validate
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Represents a request to validate reports in an asynchronous batch operation.
    */
    @Api(Description="Represents a request to validate reports in an asynchronous batch operation.")
    public static class BatchValidateReportsAsync extends BatchValidateReportsBase
    {
        
    }

    /**
    * Specifies a request to validate reports in a batch operation.
    */
    @Api(Description="Specifies a request to validate reports in a batch operation.")
    public static class BatchValidateReportsBase implements IPost
    {
        /**
        * The reports to validate.
        */
        @ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")
        public ArrayList<Report> reports = null;
        
        public ArrayList<Report> getReports() { return reports; }
        public BatchValidateReportsBase setReports(ArrayList<Report> value) { this.reports = value; return this; }
    }

    /**
    * Represents an ELMA report.
    */
    @Api(Description="Represents an ELMA report.")
    public static class Report
    {
        /**
        * 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")
        public String id = null;

        /**
        * The XML-content of the report.
        */
        @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
        public String data = null;
        
        public String getId() { return id; }
        public Report setId(String value) { this.id = value; return this; }
        public String getData() { return data; }
        public Report setData(String value) { this.data = value; return this; }
    }

}

Java 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
			}
		}
	}
]