Report Filing Service

BatchValidateReports

ValidateReportsBatchSync

Represents a request to validate reports in a batch operation.

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Elmaas.Core.Services.Contracts.Requests
Imports PwC.Elmaas.Core.Domain.Contracts.Models

Namespace Global

    Namespace PwC.Elmaas.Core.Domain.Contracts.Models

        '''<Summary>
        '''Represents an ELMA report.
        '''</Summary>
        <Api(Description:="Represents an ELMA report.")>
        Public Partial Class 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")>
            Public Overridable Property Id As String

            '''<Summary>
            '''The XML-content of the report.
            '''</Summary>
            <ApiMember(Description:="The XML-content of the report.", IsRequired:=true, Name:="Data")>
            Public Overridable Property Data As String
        End Class
    End Namespace

    Namespace PwC.Elmaas.Core.Services.Contracts.Requests

        '''<Summary>
        '''Represents a request to validate reports in a batch operation.
        '''</Summary>
        <Api(Description:="Represents a request to validate reports in a batch operation.")>
        Public Partial Class BatchValidateReports
            Inherits BatchValidateReportsBase
        End Class

        '''<Summary>
        '''Specifies a request to validate reports in a batch operation.
        '''</Summary>
        <Api(Description:="Specifies a request to validate reports in a batch operation.")>
        Public Partial Class BatchValidateReportsBase
            Implements IPost
            Public Sub New()
                Reports = New List(Of Report)
            End Sub

            '''<Summary>
            '''The reports to validate.
            '''</Summary>
            <ApiMember(Description:="The reports to validate.", IsRequired:=true, Name:="Reports")>
            Public Overridable Property Reports As List(Of Report)
        End Class
    End Namespace
End Namespace

VB.NET BatchValidateReports 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 /sync/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
			}
		}
	}
]