Tax Filing Service
| POST | /async/datenabholungen/protokolle/17/verarbeitungsprotokoll/batch |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.xEric.Core.Services.Contracts.Datenabholungen.Requests.Protokolle
Imports PwC.xEric.Core.Domain.Concretes.Models
Imports PwC.DigitalHub.Utilities.IO.Core.Contracts.Models
Imports PwC.xEric.Core.Domain.Concretes.Datenabholungen.Models
Namespace Global
Namespace PwC.DigitalHub.Utilities.IO.Core.Contracts.Models
'''<Summary>
'''Represents a base class for a file with raw data.
'''</Summary>
<Api(Description:="Represents a base class for a file with raw data.")>
Public Partial Class FileBase
Public Sub New()
Content = New Byte(){}
End Sub
'''<Summary>
'''The raw data content of the file.
'''</Summary>
<ApiMember(Description:="The raw data content of the file.", Name:="Content")>
Public Overridable Property Content As Byte()
End Class
End Namespace
Namespace PwC.xEric.Core.Domain.Concretes.Datenabholungen.Models
'''<Summary>
'''Represents the request to retrieve tax assessments by means of a specfied ID.
'''</Summary>
<Api(Description:="Represents the request to retrieve tax assessments by means of a specfied ID.")>
Public Partial Class Abholung
'''<Summary>
'''The identifier of the data record.
'''</Summary>
<ApiMember(Description:="The identifier of the data record.")>
Public Overridable Property Id As String
'''<Summary>
'''The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.
'''</Summary>
<ApiMember(Description:="The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.")>
Public Overridable Property Idnr As String
'''<Summary>
'''The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.
'''</Summary>
<ApiMember(Description:="The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.")>
Public Overridable Property Veranlagungsjahr As Nullable(Of Integer)
'''<Summary>
'''The transmission path used.
'''</Summary>
<ApiMember(Description:="The transmission path used.")>
Public Overridable Property Uebertragungsweg As Nullable(Of Uebertragungsweg)
'''<Summary>
'''The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.
'''</Summary>
<ApiMember(Description:="The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.")>
Public Overridable Property Encoding As String
'''<Summary>
'''The client number; only applicable to the tax type 'ElsterDIVADaten'.
'''</Summary>
<ApiMember(Description:="The client number; only applicable to the tax type 'ElsterDIVADaten'.")>
Public Overridable Property Mandantennummer As String
'''<Summary>
'''The tax number; only applicable to the tax type 'ElsterDIVADaten'.
'''</Summary>
<ApiMember(Description:="The tax number; only applicable to the tax type 'ElsterDIVADaten'.")>
Public Overridable Property Steuernummer As String
'''<Summary>
'''The asessment date; only applicable to the tax type 'ElsterDIVADaten'.
'''</Summary>
<ApiMember(Description:="The asessment date; only applicable to the tax type 'ElsterDIVADaten'.")>
Public Overridable Property Bescheiddatum As Nullable(Of Date)
'''<Summary>
'''Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.
'''</Summary>
<ApiMember(Description:="Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.")>
Public Overridable Property Datenpaket As Datenpaket
'''<Summary>
'''Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.
'''</Summary>
<ApiMember(Description:="Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.")>
Public Overridable Property Download As Download
End Class
'''<Summary>
'''Represents a request to retrieve data records by means of one or more IDs.
'''</Summary>
<Api(Description:="Represents a request to retrieve data records by means of one or more IDs.")>
Public Partial Class Abholung17
Inherits Abholung
'''<Summary>
'''The tax type (e.g. ESB) of the data record.
'''</Summary>
<ApiMember(Description:="The tax type (e.g. ESB) of the data record.")>
Public Overridable Property Steuerart As Nullable(Of Steuerart)
'''<Summary>
'''The meta information of the identifier.
'''</Summary>
<ApiMember(Description:="The meta information of the identifier.")>
Public Overridable Property MetaInformationen As MetaInformationen17
'''<Summary>
'''Die Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden.
'''</Summary>
<ApiMember(Description:="Die Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden.")>
Public Overridable Property Bereitstellungsticket As String
'''<Summary>
'''The attachments of the data records.
'''</Summary>
<ApiMember(Description:="The attachments of the data records.")>
Public Overridable Property Anhaenge As Anhaenge17
'''<Summary>
'''The identifier of the data record.
'''</Summary>
<ApiMember(Description:="The identifier of the data record.")>
Public Overridable Property Id As String
'''<Summary>
'''The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.
'''</Summary>
<ApiMember(Description:="The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'.")>
Public Overridable Property Idnr As String
'''<Summary>
'''The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.
'''</Summary>
<ApiMember(Description:="The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'.")>
Public Overridable Property Veranlagungsjahr As Nullable(Of Integer)
'''<Summary>
'''The transmission path used.
'''</Summary>
<ApiMember(Description:="The transmission path used.")>
Public Overridable Property Uebertragungsweg As Nullable(Of Uebertragungsweg)
'''<Summary>
'''The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.
'''</Summary>
<ApiMember(Description:="The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING.")>
Public Overridable Property Encoding As String
'''<Summary>
'''The client number; only applicable to the tax type 'ElsterDIVADaten'.
'''</Summary>
<ApiMember(Description:="The client number; only applicable to the tax type 'ElsterDIVADaten'.")>
Public Overridable Property Mandantennummer As String
'''<Summary>
'''The tax number; only applicable to the tax type 'ElsterDIVADaten'.
'''</Summary>
<ApiMember(Description:="The tax number; only applicable to the tax type 'ElsterDIVADaten'.")>
Public Overridable Property Steuernummer As String
'''<Summary>
'''The asessment date; only applicable to the tax type 'ElsterDIVADaten'.
'''</Summary>
<ApiMember(Description:="The asessment date; only applicable to the tax type 'ElsterDIVADaten'.")>
Public Overridable Property Bescheiddatum As Nullable(Of Date)
'''<Summary>
'''Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.
'''</Summary>
<ApiMember(Description:="Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet.")>
Public Overridable Property Datenpaket As Datenpaket
'''<Summary>
'''Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.
'''</Summary>
<ApiMember(Description:="Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations.")>
Public Overridable Property Download As Download
End Class
'''<Summary>
'''Represents a list of attachments.
'''</Summary>
Public Partial Class Anhaenge17
End Class
'''<Summary>
'''Specifies the encoding of the metadata.
'''</Summary>
Public Enum Coding
text
base64
End Enum
'''<Summary>
'''The data packet from the retrieval operation.
'''</Summary>
<Api(Description:="The data packet from the retrieval operation.")>
Public Partial Class Datenpaket
'''<Summary>
'''Encoded (compressed and encrypted) requested data record
'''</Summary>
<ApiMember(Description:="Encoded (compressed and encrypted) requested data record")>
Public Overridable Property Value As String
End Class
'''<Summary>
'''Represents the download of requested records. The downloaded content from the web server takes place: a) with https b) on port 443 c) on datenabholung1.elster.de or datenabholung2.elster.de. The HTTP Basic Authentication mechanism according to RFC 2617 is used for authentication.
'''</Summary>
<Api(Description:="Represents the download of requested records. The downloaded content from the web server takes place: a) with https b) on port 443 c) on datenabholung1.elster.de or datenabholung2.elster.de. The HTTP Basic Authentication mechanism according to RFC 2617 is used for authentication.")>
Public Partial Class Download
'''<Summary>
'''The link to the data on the web server.
'''</Summary>
<ApiMember(Description:="The link to the data on the web server.")>
Public Overridable Property Url As String
'''<Summary>
'''The user name for the web server.
'''</Summary>
<ApiMember(Description:="The user name for the web server.")>
Public Overridable Property Benutzer As String
'''<Summary>
'''Password for the web server.
'''</Summary>
<ApiMember(Description:="Password for the web server.")>
Public Overridable Property Passwort As String
End Class
'''<Summary>
'''Represents the metadata of a data record.
'''</Summary>
<Api(Description:="Represents the metadata of a data record.")>
Public Partial Class Meta17
'''<Summary>
'''The type of metadata, e.g. datei [file]
'''</Summary>
<ApiMember(Description:="The type of metadata, e.g. datei [file]")>
Public Overridable Property Name As String
'''<Summary>
'''The encoding of the metadata (text or base64)
'''</Summary>
<ApiMember(Description:="The encoding of the metadata (text or base64)")>
Public Overridable Property Coding As Nullable(Of Coding)
'''<Summary>
'''The content of the metadata
'''</Summary>
<ApiMember(Description:="The content of the metadata")>
Public Overridable Property Value As String
End Class
'''<Summary>
'''Represents a list of meta information maps.
'''</Summary>
Public Partial Class MetaInfoMaps17
End Class
'''<Summary>
'''Represents meta information.
'''</Summary>
<Api(Description:="Represents meta information.")>
Public Partial Class MetaInformationen17
Public Sub New()
Meta = New List(Of Meta17)
End Sub
'''<Summary>
'''List of metadata.
'''</Summary>
<ApiMember(Description:="List of metadata.")>
Public Overridable Property Meta As List(Of Meta17)
'''<Summary>
'''List of meta infomation maps.
'''</Summary>
<ApiMember(Description:="List of meta infomation maps.")>
Public Overridable Property MetaInfoMaps As MetaInfoMaps17
End Class
'''<Summary>
'''Represents the various tax types for the retrieval of data.
'''</Summary>
Public Enum Steuerart
ESB
GSB
USB
EPBescheid
EPMitteilung
Gewerbesteuerbescheid
Gewerbesteuermitteilung
GEWMB
DIVAAnzeigeEinerLotterie
DIVABescheid
DivaBescheidESt
DIVABuchmachersteuer
DIVALotteriesteuerEinmal
DIVALotteriesteuerMehr
DIVASportwettensteuer
DIVATotalisator
OZGBescheid
VerbindlicheAuskunft
VerbindlicheZusage
DivaSonstigerVA
DivaBescheidErbSt
DivaBescheidFEIN
DivaBescheidGewSt
DivaBescheidKSt
DivaBescheidUSt
DivaBescheidSchenkSt
DIVATroncabgabe
DIVAVirtuelleAutomatenStB
DIVAOnlinePokerStB
LStHVVMRM
EinlagenrueckgewaehrVA
FTTMeldungVA
StatusInvStGVA
UStVEUVA
VERSVA
AltZertVA
KapEStEntlastungVA
PostUDLVA
StAb50aVA
StAbEntlastungVA
KassenangelegenheitenVA
KStOptVA
SteueroasenabwehrVA
KDBVollmachtRM
STBKE
VDBKDBRueckmeldungLief
AnhangRueckmeldung
DivaEinwilligungRM
GlueckspielF
OZGMitteilung
VerbindlicheAuskunftInfoF
ELOProtokoll
End Enum
'''<Summary>
'''Represents the transmission path.
'''</Summary>
Public Enum Uebertragungsweg
direkt
link
sammellink
End Enum
End Namespace
Namespace PwC.xEric.Core.Domain.Concretes.Models
'''<Summary>
'''Represents a portal certificate that is protected by a password.
'''</Summary>
<Api(Description:="Represents a portal certificate that is protected by a password.")>
Public Partial Class PortalCertificate
Inherits FileBase
Implements ISecuredCertificate
Implements IHasIndex
Public Sub New()
Tags = New List(Of String)
Content = New Byte(){}
End Sub
'''<Summary>
'''The unique identifier of the certificate.
'''</Summary>
<ApiMember(Description:="The unique identifier of the certificate.")>
Public Overridable Property Id As Guid
'''<Summary>
'''The position of the certificate element in an indexed collection of certificates.
'''</Summary>
<ApiMember(Description:="The position of the certificate element in an indexed collection of certificates.")>
Public Overridable Property Index As Integer
'''<Summary>
'''The password to protect the certificate from unauthorized access.
'''</Summary>
<StringLength(255)>
<ApiMember(Description:="The password to protect the certificate from unauthorized access.")>
Public Overridable Property Pin As String
'''<Summary>
'''The description of the certificate.
'''</Summary>
<StringLength(Integer.MaxValue)>
<ApiMember(Description:="The description of the certificate.")>
Public Overridable Property Description As String
'''<Summary>
'''Tags that can be used to label or identify the certificate.
'''</Summary>
<ApiMember(Description:="Tags that can be used to label or identify the certificate.")>
Public Overridable Property Tags As List(Of String)
'''<Summary>
'''Gets or sets the file name of the certificate.
'''</Summary>
<ApiMember(Description:="Gets or sets the file name of the certificate.")>
Public Overridable Property Name As String
'''<Summary>
'''The raw data content of the file.
'''</Summary>
<ApiMember(Description:="The raw data content of the file.", Name:="Content")>
Public Overridable Property Content As Byte()
End Class
End Namespace
Namespace PwC.xEric.Core.Services.Contracts.Datenabholungen.Requests.Protokolle
'''<Summary>
'''Represents the service request to retrieve logs about tax statements.
'''</Summary>
<Api(Description:="Represents the service request to retrieve logs about tax statements.")>
Public Partial Class BatchProtokollRequest17Async
Inherits BatchProtokollRequestBase17
Public Sub New()
Bescheide = New List(Of Abholung17)
End Sub
'''<Summary>
'''The tax assessements, whose processing records shall be obtained.
'''</Summary>
<ApiMember(Description:="The tax assessements, whose processing records shall be obtained.", Name:="Bescheide")>
Public Overridable Property Bescheide As List(Of Abholung17)
'''<Summary>
'''The authentification certificate.
'''</Summary>
<ApiMember(Description:="The authentification certificate.", IsRequired:=true, Name:="Zertifikat")>
Public Overridable Property Zertifikat As PortalCertificate
End Class
'''<Summary>
'''Represents a base service request to retrieve processing records from specified tax statements.
'''</Summary>
<Api(Description:="Represents a base service request to retrieve processing records from specified tax statements.")>
Public Partial Class BatchProtokollRequestBase
Implements IPost
'''<Summary>
'''The authentification certificate.
'''</Summary>
<ApiMember(Description:="The authentification certificate.", IsRequired:=true, Name:="Zertifikat")>
Public Overridable Property Zertifikat As PortalCertificate
End Class
'''<Summary>
'''Represents a base service request to retrieve processing records from specified tax statements. Applicable to version 17..
'''</Summary>
<Api(Description:="Represents a base service request to retrieve processing records from specified tax statements. Applicable to version 17..")>
Public Partial Class BatchProtokollRequestBase17
Inherits BatchProtokollRequestBase
Public Sub New()
Bescheide = New List(Of Abholung17)
End Sub
'''<Summary>
'''The tax assessements, whose processing records shall be obtained.
'''</Summary>
<ApiMember(Description:="The tax assessements, whose processing records shall be obtained.", Name:="Bescheide")>
Public Overridable Property Bescheide As List(Of Abholung17)
'''<Summary>
'''The authentification certificate.
'''</Summary>
<ApiMember(Description:="The authentification certificate.", IsRequired:=true, Name:="Zertifikat")>
Public Overridable Property Zertifikat As PortalCertificate
End Class
End Namespace
End Namespace
VB.NET BatchProtokollRequest17Async DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /async/datenabholungen/protokolle/17/verarbeitungsprotokoll/batch HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchProtokollRequest17Async xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Datenabholungen.Requests.Protokolle">
<Zertifikat xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
<Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Index>0</d2p1:Index>
<d2p1:Name>String</d2p1:Name>
<d2p1:Pin>String</d2p1:Pin>
<d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</d2p1:Tags>
</Zertifikat>
<Bescheide xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Datenabholungen.Models">
<d2p1:Abholung17 id="String" idnr="String" veranlagungsjahr="0" uebertragungsweg="direkt" encoding="String" bereitstellungsticket="String">
<MetaInformationen>
<Meta art="String" coding="text">String</Meta>
<MetaInfoMaps>
<MetaInfoMap typ="String">
<Meta art="String" coding="text">String</Meta>
</MetaInfoMap>
</MetaInfoMaps>
</MetaInformationen>
<Datenpaket>String</Datenpaket>
<Download>
<Url>String</Url>
<Benutzer>String</Benutzer>
<Passwort>String</Passwort>
</Download>
<Anhaenge version="0">
<Anhang>
<Dateibezeichnung>String</Dateibezeichnung>
<Dateityp>String</Dateityp>
<Dateiinhalt>String</Dateiinhalt>
<MetadatumAnhang>
<SchluesselAnhang DateibezeichnungID="String" DateibezeichnungKurz="String">String</SchluesselAnhang>
<WertAnhang DateibezeichnungID="String" DateibezeichnungKurz="String">String</WertAnhang>
</MetadatumAnhang>
</Anhang>
</Anhaenge>
</d2p1:Abholung17>
</Bescheide>
</BatchProtokollRequest17Async>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfProtokollResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Datenabholungen.Responses">
<ProtokollResponse>
<Id xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">String</Id>
<Index xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">0</Index>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
<Protokoll version="0" xmlns="http://www.elsterfachmethodik.de/protokollverfahren/version6/XMLSchema">
<ZeitStempel>00010101000000</ZeitStempel>
<DatenTeil transferTicket="String" code="0" text="String">
<Nutzdatenblock nutzdatenTicket="String" code="0" text="String" verarbeiteteNdS="0" nichtverarbeiteteNdS="0">
<NdSFehler lfdNr="String" kmId="String" ordnungsMerkmal="String" fehlerNummer="0" fehlerText="String" />
</Nutzdatenblock>
</DatenTeil>
</Protokoll>
</ProtokollResponse>
</ArrayOfProtokollResponse>