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

namespace PwC.Elmaas.Core.Domain.Contracts.Models

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Represents an ELMA report.
    ///</summary>
    [<Api(Description="Represents an ELMA report.")>]
    [<AllowNullLiteral>]
    type Report() = 
        ///<summary>
        ///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.
        ///</summary>
        [<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")>]
        member val Id:String = null with get,set

        ///<summary>
        ///The XML-content of the report.
        ///</summary>
        [<ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")>]
        member val Data:String = null with get,set

    ///<summary>
    ///Specifies a request to validate reports in a batch operation.
    ///</summary>
    [<Api(Description="Specifies a request to validate reports in a batch operation.")>]
    [<AllowNullLiteral>]
    type BatchValidateReportsBase() = 
        interface IPost
        ///<summary>
        ///The reports to validate.
        ///</summary>
        [<ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")>]
        member val Reports:ResizeArray<Report> = new ResizeArray<Report>() with get,set

    ///<summary>
    ///Represents a request to validate reports in an asynchronous batch operation.
    ///</summary>
    [<Api(Description="Represents a request to validate reports in an asynchronous batch operation.")>]
    [<AllowNullLiteral>]
    type BatchValidateReportsAsync() = 
        inherit BatchValidateReportsBase()

F# 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.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
			}
		}
	}
]