Tax Filing Service

<back to all web services

BatchCheckElster

SyncÜberprüfung

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

Requires Authentication
The following routes are available for this service:
POST/BatchCheckElsterA synchronous service to perform basic checks on a batch of tax data.
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Represents a structure that encapsulates a tax declaration.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TaxData:
    """
    Represents a structure that encapsulates a tax declaration.
    """

    # @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
    id: Optional[str] = None
    """
    The unique identifier of the tax data.
    """


    # @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
    content: Optional[str] = None
    """
    The XML-based tax declaration.
    """


# @Api(Description="A base service to perform basic checks on a batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchCheckElsterBase(IReturn[List[ElsterCheckResponse]], IPost):
    """
    A base service to perform basic checks on a batch of tax data.
    """

    # @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
    data: Optional[List[TaxData]] = None
    """
    The batch of ELSTER tax data to check.
    """
    @staticmethod
    def response_type(): return List[ElsterCheckResponse]


# @Api(Description="A synchronous service to perform basic checks on a batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchCheckElster(BatchCheckElsterBase):
    """
    A synchronous service to perform basic checks on a batch of tax data.
    """

    # @ApiMember(Description="The batch of ELSTER tax data to check.", Name="Data")
    data: Optional[List[TaxData]] = None
    """
    The batch of ELSTER tax data to check.
    """

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