Tax Filing Service

BatchCheckElster

SyncÜberprüfung

A synchronous service to perform basic checks on a batch of tax data.

The following routes are available for this service:
POST	/BatchCheckElster	A synchronous service to perform basic checks on a batch of tax data.

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

Namespace Global

    Namespace PwC.xEric.Core.Domain.Concretes.Models

        '''<Summary>
        '''Represents a structure that encapsulates a tax declaration.
        '''</Summary>
        <Api(Description:="Represents a structure that encapsulates a tax declaration.")>
        Public Partial Class TaxData
            '''<Summary>
            '''The unique identifier of the tax data.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the tax data.", IsRequired:=true)>
            Public Overridable Property Id As String

            '''<Summary>
            '''The XML-based tax declaration.
            '''</Summary>
            <ApiMember(Description:="The XML-based tax declaration.", IsRequired:=true)>
            Public Overridable Property Content As String
        End Class
    End Namespace

    Namespace PwC.xEric.Core.Services.Contracts.Requests

        '''<Summary>
        '''A synchronous service to perform basic checks on a batch of tax data.
        '''</Summary>
        <Api(Description:="A synchronous service to perform basic checks on a batch of tax data.")>
        Public Partial Class BatchCheckElster
            Inherits BatchCheckElsterBase
            Public Sub New()
                Data = New List(Of TaxData)
            End Sub

            '''<Summary>
            '''The batch of ELSTER tax data to check.
            '''</Summary>
            <ApiMember(Description:="The batch of ELSTER tax data to check.", Name:="Data")>
            Public Overridable Property Data As List(Of TaxData)
        End Class

        '''<Summary>
        '''A base service to perform basic checks on a batch of tax data.
        '''</Summary>
        <Api(Description:="A base service to perform basic checks on a batch of tax data.")>
        Public Partial Class BatchCheckElsterBase
            Implements IPost
            Public Sub New()
                Data = New List(Of TaxData)
            End Sub

            '''<Summary>
            '''The batch of ELSTER tax data to check.
            '''</Summary>
            <ApiMember(Description:="The batch of ELSTER tax data to check.", Name:="Data")>
            Public Overridable Property Data As List(Of TaxData)
        End Class
    End Namespace
End Namespace

VB.NET BatchCheckElster 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 /BatchCheckElster HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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

[
	{
		zertifikatErforderlich: False,
		hatHerstellerId: False,
		hatDatenlieferant: False,
		stagingEnabled: False,
		transferProtokollDruckbar: False,
		id: String,
		index: 0,
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		}
	}
]