Tax Filing Service
| POST | /BatchValidiereAuthentifiziereUndSende |
|---|
Imports System
Imports System.IO
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.xEric.Core.Domain.Concretes.Certificates
Imports PwC.DigitalHub.Utilities.Domain.IO.Contracts
Namespace Global
Namespace PwC.DigitalHub.Utilities.Domain.IO.Contracts
'''<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
'''<Summary>
'''The raw data content of the file in bytes.
'''</Summary>
<ApiMember(Description:="The raw data content of the file in bytes.", Name:="Content")>
Public Overridable Property Content As Byte()
End Class
End Namespace
Namespace PwC.xEric.Core.Domain.Concretes.Certificates
'''<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
'''<Summary>
'''The file name of the certificate.
'''</Summary>
<ApiMember(Description:="The file name of the certificate.")>
<StringLength(128)>
Public Overridable Property Name As String
'''<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 Implements ISecuredCertificate.Pin
'''<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) = New List(Of String)
End Class
End Namespace
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
'''<Summary>
'''The batch of tax data to process.
'''</Summary>
<ApiMember(Description:="The batch of tax data to process.")>
Public Overridable Property Data As List(Of TaxData) = New List(Of TaxData)
End Class
'''<Summary>
'''A synchronous service to validate, authenticate and send tax data to the fiscal authorities.
'''</Summary>
<Api(Description:="A synchronous service to validate, authenticate and send tax data to the fiscal authorities.")>
Public Partial Class BatchValidiereAuthentifiziereUndSende
Inherits BatchValidiereAuthentifiziereUndSendeBase
End Class
'''<Summary>
'''A base service to validate, authenticate and send tax data to the fiscal authorities.
'''</Summary>
<Api(Description:="A base service to validate, authenticate and send tax data to the fiscal authorities.")>
Public Partial Class BatchValidiereAuthentifiziereUndSendeBase
Inherits BatchBearbeiteVorgangBase
Implements IVeschlueselungsRequest
Implements ISendeRequest
'''<Summary>
'''The authentification certificate.
'''</Summary>
<ApiMember(Description:="The authentification certificate.")>
Public Overridable Property Zertifikat As PortalCertificate Implements IVeschlueselungsRequest.Zertifikat
'''<Summary>
'''The details of the provider that submits tax data.
'''</Summary>
<ApiMember(Description:="The details of the provider that submits tax data.")>
Public Overridable Property DatenLieferant As String Implements ISendeRequest.DatenLieferant
End Class
End Namespace
End Namespace
VB.NET BatchValidiereAuthentifiziereUndSende DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
zertifikat:
{
name: String,
pin: String,
description: String,
tags:
[
String
],
content: AA==
},
datenLieferant: String,
data:
[
{
id: String,
content: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: String
},
herstellerID: String,
datenLieferant: String,
eingangsDatum: 0001-01-01,
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: 0001-01-01,
lastAccessTimeUtc: 0001-01-01,
lastWriteTime: 0001-01-01,
lastWriteTimeUtc: 0001-01-01,
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
}
}
}
]