Tax Filing Service
| POST | /BatchValidiereAuthentifiziereSendeUndDruckeAsync |
|---|
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
Imports PwC.DigitalHub.Utilities.IO.Core.Contracts.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.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
'''<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 base service to process a batch of tax data.
'''</Summary>
<Api(Description:="A base service to process a batch of tax data.")>
Public Partial Class BatchBearbeiteVorgangBase
Implements IPost
Public Sub New()
Data = New List(Of TaxData)
End Sub
'''<Summary>
'''The batch of tax data to process.
'''</Summary>
<ApiMember(Description:="The batch of tax data to process.", Name:="Data")>
Public Overridable Property Data As List(Of TaxData)
End Class
'''<Summary>
'''An asynchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols.
'''</Summary>
<Api(Description:="An asynchronous service to validate, authenticate, send a batch of tax data and print their transfer protocols.")>
Public Partial Class BatchValidiereAuthentifiziereSendeUndDruckeAsync
Inherits BatchValidiereAuthentifiziereSendeUndDruckeBase
Public Sub New()
Data = New List(Of TaxData)
End Sub
'''<Summary>
'''Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.
'''</Summary>
<ApiMember(Description:="Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.")>
Public Overridable Property DuplexDruck As Nullable(Of Boolean)
'''<Summary>
'''Base name of the generated PDF file. Each tax data file name shall be appended to this base name.
'''</Summary>
<ApiMember(Description:="Base name of the generated PDF file. Each tax data file name shall be appended to this base name.")>
Public Overridable Property ProtocolPrefix As String
'''<Summary>
'''Footer text to be used on the printout (optional).
'''</Summary>
<ApiMember(Description:="Footer text to be used on the printout (optional).")>
Public Overridable Property FussText As String
'''<Summary>
'''The authentification certificate.
'''</Summary>
<ApiMember(Description:="The authentification certificate.")>
Public Overridable Property Zertifikat As PortalCertificate
'''<Summary>
'''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'.
'''</Summary>
<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")>
Public Overridable Property AbrufCode As String
'''<Summary>
'''The details of the provider that submits tax data.
'''</Summary>
<ApiMember(Description:="The details of the provider that submits tax data.", Name:="DatenLieferant")>
Public Overridable Property DatenLieferant As String
'''<Summary>
'''The batch of tax data to process.
'''</Summary>
<ApiMember(Description:="The batch of tax data to process.", Name:="Data")>
Public Overridable Property Data As List(Of TaxData)
End Class
'''<Summary>
'''A base service to validate, authenticate, send and print a batch of tax data.
'''</Summary>
<Api(Description:="A base service to validate, authenticate, send and print a batch of tax data.")>
Public Partial Class BatchValidiereAuthentifiziereSendeUndDruckeBase
Inherits BatchBearbeiteVorgangBase
Implements IDruckRequest
Implements IVeschlueselungsRequest
Implements ISendeRequest
Public Sub New()
Data = New List(Of TaxData)
End Sub
'''<Summary>
'''Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.
'''</Summary>
<ApiMember(Description:="Should the PDF file be prepared for a double-sided printout with a margin for punching?. True: The straight sides are indented to the left for a stitching margin for punching. False: There is no indentation of the straight sides. The created PDF is only intended for printing pages page by page.")>
Public Overridable Property DuplexDruck As Nullable(Of Boolean)
'''<Summary>
'''Base name of the generated PDF file. Each tax data file name shall be appended to this base name.
'''</Summary>
<ApiMember(Description:="Base name of the generated PDF file. Each tax data file name shall be appended to this base name.")>
Public Overridable Property ProtocolPrefix As String
'''<Summary>
'''Footer text to be used on the printout (optional).
'''</Summary>
<ApiMember(Description:="Footer text to be used on the printout (optional).")>
Public Overridable Property FussText As String
'''<Summary>
'''The authentification certificate.
'''</Summary>
<ApiMember(Description:="The authentification certificate.")>
Public Overridable Property Zertifikat As PortalCertificate
'''<Summary>
'''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'.
'''</Summary>
<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")>
Public Overridable Property AbrufCode As String
'''<Summary>
'''The details of the provider that submits tax data.
'''</Summary>
<ApiMember(Description:="The details of the provider that submits tax data.", Name:="DatenLieferant")>
Public Overridable Property DatenLieferant As String
'''<Summary>
'''The batch of tax data to process.
'''</Summary>
<ApiMember(Description:="The batch of tax data to process.", Name:="Data")>
Public Overridable Property Data As List(Of TaxData)
End Class
End Namespace
End Namespace
VB.NET BatchValidiereAuthentifiziereSendeUndDruckeAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BatchValidiereAuthentifiziereSendeUndDruckeAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"duplexDruck":false,"protocolPrefix":"String","fussText":"String","zertifikat":{"id":"00000000000000000000000000000000","index":0,"pin":"String","description":"String","tags":["String"],"name":"String","content":"AA=="},"abrufCode":"String","datenLieferant":"String","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"}}}]