Tax Filing Service
| POST | /BatchValidiereAuthentifiziereSendeUndDruckeAsync |
|---|
namespace PwC.DigitalHub.Utilities.IO.Core.Contracts.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<summary>
///Represents a structure that encapsulates a tax declaration.
///</summary>
[<Api(Description="Represents a structure that encapsulates a tax declaration.")>]
[<AllowNullLiteral>]
type TaxData() =
///<summary>
///The unique identifier of the tax data.
///</summary>
[<ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)>]
member val Id:String = null with get,set
///<summary>
///The XML-based tax declaration.
///</summary>
[<ApiMember(Description="The XML-based tax declaration.", IsRequired=true)>]
member val Content:String = null with get,set
///<summary>
///A base service to process a batch of tax data.
///</summary>
[<Api(Description="A base service to process a batch of tax data.")>]
[<AllowNullLiteral>]
type BatchBearbeiteVorgangBase() =
interface IPost
///<summary>
///The batch of tax data to process.
///</summary>
[<ApiMember(Description="The batch of tax data to process.", Name="Data")>]
member val Data:ResizeArray<TaxData> = new ResizeArray<TaxData>() with get,set
///<summary>
///Represents a base class for a file with raw data.
///</summary>
[<Api(Description="Represents a base class for a file with raw data.")>]
[<AllowNullLiteral>]
type FileBase() =
///<summary>
///The raw data content of the file.
///</summary>
[<ApiMember(Description="The raw data content of the file.", Name="Content")>]
member val Content:Byte[] = [||] with get,set
///<summary>
///Represents a portal certificate that is protected by a password.
///</summary>
[<Api(Description="Represents a portal certificate that is protected by a password.")>]
[<AllowNullLiteral>]
type PortalCertificate() =
inherit FileBase()
///<summary>
///The unique identifier of the certificate.
///</summary>
[<ApiMember(Description="The unique identifier of the certificate.")>]
member val Id:Guid = new Guid() with get,set
///<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.")>]
member val Index:Int32 = new Int32() with get,set
///<summary>
///The password to protect the certificate from unauthorized access.
///</summary>
[<StringLength(255)>]
[<ApiMember(Description="The password to protect the certificate from unauthorized access.")>]
member val Pin:String = null with get,set
///<summary>
///The description of the certificate.
///</summary>
[<StringLength(Int32.MaxValue)>]
[<ApiMember(Description="The description of the certificate.")>]
member val Description:String = null with get,set
///<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.")>]
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Gets or sets the file name of the certificate.
///</summary>
[<ApiMember(Description="Gets or sets the file name of the certificate.")>]
member val Name:String = null with get,set
///<summary>
///The raw data content of the file.
///</summary>
[<ApiMember(Description="The raw data content of the file.", Name="Content")>]
member val Content:Byte[] = [||] with get,set
///<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.")>]
[<AllowNullLiteral>]
type BatchValidiereAuthentifiziereSendeUndDruckeBase() =
inherit BatchBearbeiteVorgangBase()
///<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.")>]
member val DuplexDruck:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<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.")>]
member val ProtocolPrefix:String = null with get,set
///<summary>
///Footer text to be used on the printout (optional).
///</summary>
[<ApiMember(Description="Footer text to be used on the printout (optional).")>]
member val FussText:String = null with get,set
///<summary>
///The authentification certificate.
///</summary>
[<ApiMember(Description="The authentification certificate.")>]
member val Zertifikat:PortalCertificate = null with get,set
///<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")>]
member val AbrufCode:String = null with get,set
///<summary>
///The details of the provider that submits tax data.
///</summary>
[<ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")>]
member val DatenLieferant:String = null with get,set
///<summary>
///The batch of tax data to process.
///</summary>
[<ApiMember(Description="The batch of tax data to process.", Name="Data")>]
member val Data:ResizeArray<TaxData> = new ResizeArray<TaxData>() with get,set
///<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.")>]
[<AllowNullLiteral>]
type BatchValidiereAuthentifiziereSendeUndDruckeAsync() =
inherit BatchValidiereAuthentifiziereSendeUndDruckeBase()
///<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.")>]
member val DuplexDruck:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<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.")>]
member val ProtocolPrefix:String = null with get,set
///<summary>
///Footer text to be used on the printout (optional).
///</summary>
[<ApiMember(Description="Footer text to be used on the printout (optional).")>]
member val FussText:String = null with get,set
///<summary>
///The authentification certificate.
///</summary>
[<ApiMember(Description="The authentification certificate.")>]
member val Zertifikat:PortalCertificate = null with get,set
///<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")>]
member val AbrufCode:String = null with get,set
///<summary>
///The details of the provider that submits tax data.
///</summary>
[<ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")>]
member val DatenLieferant:String = null with get,set
///<summary>
///The batch of tax data to process.
///</summary>
[<ApiMember(Description="The batch of tax data to process.", Name="Data")>]
member val Data:ResizeArray<TaxData> = new ResizeArray<TaxData>() with get,set
F# BatchValidiereAuthentifiziereSendeUndDruckeAsync 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 /BatchValidiereAuthentifiziereSendeUndDruckeAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
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/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: BW
},
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
}
}
}
]