Tax Filing Service

BatchValidiereAuthentifiziereUndSende

SyncBearbeiteVorgangValidiereAuthentifiziereSendeBatch

A synchronous service to validate, authenticate and send tax data to the fiscal authorities.

The following routes are available for this service:
POST	/BatchValidiereAuthentifiziereUndSende

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 process a batch of tax data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchBearbeiteVorgangBase(IReturn[List[BearbeiteVorgangResponse]], IPost):
    """
    A base service to process a batch of tax data.
    """

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


# @Api(Description="Represents a base class for a file with raw data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FileBase:
    """
    Represents a base class for a file with raw data.
    """

    # @ApiMember(Description="The raw data content of the file.", Name="Content")
    content: Optional[bytes] = None
    """
    The raw data content of the file.
    """


# @Api(Description="Represents a portal certificate that is protected by a password.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalCertificate(FileBase, ISecuredCertificate, IHasIndex):
    """
    Represents a portal certificate that is protected by a password.
    """

    # @ApiMember(Description="The unique identifier of the certificate.")
    id: Optional[str] = None
    """
    The unique identifier of the certificate.
    """


    # @ApiMember(Description="The position of the certificate element in an indexed collection of certificates.")
    index: int = 0
    """
    The position of the certificate element in an indexed collection of certificates.
    """


    # @StringLength(255)
    # @ApiMember(Description="The password to protect the certificate from unauthorized access.")
    pin: Optional[str] = None
    """
    The password to protect the certificate from unauthorized access.
    """


    # @StringLength(2147483647)
    # @ApiMember(Description="The description of the certificate.")
    description: Optional[str] = None
    """
    The description of the certificate.
    """


    # @ApiMember(Description="Tags that can be used to label or identify the certificate.")
    tags: Optional[List[str]] = None
    """
    Tags that can be used to label or identify the certificate.
    """


    # @ApiMember(Description="Gets or sets the file name of the certificate.")
    name: Optional[str] = None
    """
    Gets or sets the file name of the certificate.
    """


    # @ApiMember(Description="The raw data content of the file.", Name="Content")
    content: Optional[bytes] = None
    """
    The raw data content of the file.
    """


# @Api(Description="A base service to validate, authenticate and send tax data to the fiscal authorities.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchValidiereAuthentifiziereUndSendeBase(BatchBearbeiteVorgangBase, IVeschlueselungsRequest, ISendeRequest):
    """
    A base service to validate, authenticate and send tax data to the fiscal authorities.
    """

    # @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
    zertifikat: Optional[PortalCertificate] = None
    """
    The authentification certificate.
    """


    # @ApiMember(Description="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
    abruf_code: Optional[str] = None
    """
    Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.
    """


    # @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
    daten_lieferant: Optional[str] = None
    """
    The details of the provider that submits tax data.
    """


    # @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
    staging_enabled: Optional[bool] = None
    """
    Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
    """


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


# @Api(Description="A synchronous service to validate, authenticate and send tax data to the fiscal authorities.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchValidiereAuthentifiziereUndSende(BatchValidiereAuthentifiziereUndSendeBase):
    """
    A synchronous service to validate, authenticate and send tax data to the fiscal authorities.
    """

    # @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
    zertifikat: Optional[PortalCertificate] = None
    """
    The authentification certificate.
    """


    # @ApiMember(Description="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
    abruf_code: Optional[str] = None
    """
    Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by  '-'. Example: 'K6FG5 - RS32P'.
    """


    # @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
    daten_lieferant: Optional[str] = None
    """
    The details of the provider that submits tax data.
    """


    # @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
    staging_enabled: Optional[bool] = None
    """
    Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
    """


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

Python BatchValidiereAuthentifiziereUndSende DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /BatchValidiereAuthentifiziereUndSende HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"zertifikat":{"id":"00000000000000000000000000000000","index":0,"pin":"String","description":"String","tags":["String"],"name":"String","content":"AA=="},"abrufCode":"String","datenLieferant":"String","stagingEnabled":false,"data":[{"id":"String","content":"String"}]}

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

[{"rueckgabe":{"erfolg":{"telenummer":["String"],"ordnungsbegriffe":["String"]},"transfers":{"transferList":[{"transferTicket":"String"}]},"fehlerRegelpruefungen":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheFehlerId":"String","text":"String"}],"hinweise":[{"nutzdatenticket":"String","feldidentifikator":"String","mehrfachzeilenindex":"String","lfdNrVordruck":"String","vordruckZeilennummer":"String","semantischeIndexes":[{"name":"String","value":"String"}],"untersachbereich":"String","privateKennnummer":"String","regelName":"String","fachlicheHinweisId":"String","text":"String"}]},"serverantwort":{"transferHeader":{"version":"String","verfahren":"ElsterAnmeldung","datenArt":"34a","vorgang":"send-Auth","transferTicket":"String","testmerker":"0","sigUser":{"inhalt":{}},"empfaenger":{"id":"String","ziel":"BW"},"herstellerID":"String","datenLieferant":"String","eingangsDatum":"\/Date(-62135596800000-0000)\/","datei":{"verschluesselung":"PKCS#7v1.5","kompression":"GZIP","transportSchluessel":"String","erstellung":{"eric":{"inhalt":{}}}},"rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"versionClient":"String","zusatz":{"infos":["String"],"elsterInfos":["String"]}},"datenTeil":{"nutzdatenbloecke":[{"nutzdatenHeader":{"version":"String","nutzdatenTicket":"String","empfaenger":{"id":"L","value":"String"},"hersteller":{"produktName":"String","produktVersion":"String"},"datenLieferant":"String","rc":{"rueckgabe":{"code":"String","text":"String"},"stack":{"code":"String","text":"String"}},"zusatz":{"infos":["String"],"elsterInfos":["String"]}},"nutzdaten":{"inhalt":{}}}]}},"transferProtocols":[{"metadata":{"name":"String","fullName":"String","lastAccessTime":"\/Date(-62135596800000-0000)\/","lastAccessTimeUtc":"\/Date(-62135596800000-0000)\/","lastWriteTime":"\/Date(-62135596800000-0000)\/","lastWriteTimeUtc":"\/Date(-62135596800000-0000)\/","length":0,"userId":0,"groupId":0,"othersCanRead":false,"groupCanExecute":false,"groupCanWrite":false,"groupCanRead":false,"ownerCanExecute":false,"ownerCanWrite":false,"ownerCanRead":false,"othersCanExecute":false,"othersCanWrite":false,"extensions":{"String":"String"}},"name":"String","content":"AA=="}],"statusCode":"ERIC_OK","statusText":"String","id":"String","index":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]