Tax Filing Service
| POST | /BatchValidiereUndSendeAsync | An asynchronous service to validate and send 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 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 and send batch of tax data.
'''</Summary>
<Api(Description:="An asynchronous service to validate and send batch of tax data.")>
Public Partial Class BatchValidiereUndSendeAsync
Inherits BatchValidiereUndSendeBase
Public Sub New()
Data = New List(Of TaxData)
End Sub
'''<Summary>
'''Name prefix of the generated transfer protocol file.
'''</Summary>
<ApiMember(Description:="Name prefix of the generated transfer protocol file.", Name:="ProtocolPrefix")>
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).", Name:="FussText")>
Public Overridable Property FussText As String
'''<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.", Name:="DuplexDruck")>
Public Overridable Property DuplexDruck As Nullable(Of Boolean)
'''<Summary>
'''The details of the provider that submits batch of tax data.
'''</Summary>
<ApiMember(Description:="The details of the provider that submits batch of tax data.", Name:="DatenLieferant")>
Public Overridable Property DatenLieferant As String
'''<Summary>
'''Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.
'''</Summary>
<ApiMember(Description:="Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.", Name:="StagingEnabled")>
Public Overridable Property StagingEnabled As Nullable(Of Boolean)
'''<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 and send batch of tax data.
'''</Summary>
<Api(Description:="A base service to validate and send batch of tax data.")>
Public Partial Class BatchValidiereUndSendeBase
Inherits BatchBearbeiteVorgangBase
Implements ISendeRequest
Implements IDruckRequest
Public Sub New()
Data = New List(Of TaxData)
End Sub
'''<Summary>
'''Name prefix of the generated transfer protocol file.
'''</Summary>
<ApiMember(Description:="Name prefix of the generated transfer protocol file.", Name:="ProtocolPrefix")>
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).", Name:="FussText")>
Public Overridable Property FussText As String
'''<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.", Name:="DuplexDruck")>
Public Overridable Property DuplexDruck As Nullable(Of Boolean)
'''<Summary>
'''The details of the provider that submits batch of tax data.
'''</Summary>
<ApiMember(Description:="The details of the provider that submits batch of tax data.", Name:="DatenLieferant")>
Public Overridable Property DatenLieferant As String
'''<Summary>
'''Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.
'''</Summary>
<ApiMember(Description:="Should the processing of the batch of tax data be staged? If true, batch of tax data is not sent to the production ELSTER servers.", Name:="StagingEnabled")>
Public Overridable Property StagingEnabled As Nullable(Of Boolean)
'''<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 BatchValidiereUndSendeAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BatchValidiereUndSendeAsync HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"protocolPrefix":"String","fussText":"String","duplexDruck":false,"datenLieferant":"String","stagingEnabled":false,"data":[{"id":"String","content":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}]