Tax Filing Service
| POST | /BatchValidiereAuthentifiziereSendeUndDruckeAsync |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.xEric.Core.Services.Contracts.Requests;
using PwC.xEric.Core.Domain.Concretes.Models;
using PwC.DigitalHub.Utilities.IO.Core.Contracts.Models;
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 FileBase()
{
Content = new byte[]{};
}
///<summary>
///The raw data content of the file.
///</summary>
[ApiMember(Description="The raw data content of the file.", Name="Content")]
public virtual byte[] Content { get; set; }
}
}
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
: FileBase, ISecuredCertificate, IHasIndex
{
public PortalCertificate()
{
Tags = new List<string>{};
Content = new byte[]{};
}
///<summary>
///The unique identifier of the certificate.
///</summary>
[ApiMember(Description="The unique identifier of the certificate.")]
public virtual Guid Id { 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.")]
public virtual int Index { 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.")]
public virtual string Pin { get; set; }
///<summary>
///The description of the certificate.
///</summary>
[StringLength(int.MaxValue)]
[ApiMember(Description="The description of the certificate.")]
public virtual string Description { 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.")]
public virtual List<string> Tags { get; set; }
///<summary>
///Gets or sets the file name of the certificate.
///</summary>
[ApiMember(Description="Gets or sets the file name of the certificate.")]
public virtual string Name { get; set; }
///<summary>
///The raw data content of the file.
///</summary>
[ApiMember(Description="The raw data content of the file.", Name="Content")]
public virtual byte[] Content { get; set; }
}
///<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 virtual string Id { get; set; }
///<summary>
///The XML-based tax declaration.
///</summary>
[ApiMember(Description="The XML-based tax declaration.", IsRequired=true)]
public virtual string Content { get; set; }
}
}
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
: IPost
{
public BatchBearbeiteVorgangBase()
{
Data = new List<TaxData>{};
}
///<summary>
///The batch of tax data to process.
///</summary>
[ApiMember(Description="The batch of tax data to process.", Name="Data")]
public virtual List<TaxData> Data { 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.")]
public partial class BatchValidiereAuthentifiziereSendeUndDruckeAsync
: BatchValidiereAuthentifiziereSendeUndDruckeBase
{
public BatchValidiereAuthentifiziereSendeUndDruckeAsync()
{
Data = new List<TaxData>{};
}
///<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 virtual bool? DuplexDruck { 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.")]
public virtual string ProtocolPrefix { get; set; }
///<summary>
///Footer text to be used on the printout (optional).
///</summary>
[ApiMember(Description="Footer text to be used on the printout (optional).")]
public virtual string FussText { get; set; }
///<summary>
///The authentification certificate.
///</summary>
[ApiMember(Description="The authentification certificate.")]
public virtual PortalCertificate Zertifikat { 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")]
public virtual string AbrufCode { 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")]
public virtual string DatenLieferant { get; set; }
///<summary>
///The batch of tax data to process.
///</summary>
[ApiMember(Description="The batch of tax data to process.", Name="Data")]
public virtual List<TaxData> Data { 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.")]
public partial class BatchValidiereAuthentifiziereSendeUndDruckeBase
: BatchBearbeiteVorgangBase, IDruckRequest, IVeschlueselungsRequest, ISendeRequest
{
public BatchValidiereAuthentifiziereSendeUndDruckeBase()
{
Data = new List<TaxData>{};
}
///<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 virtual bool? DuplexDruck { 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.")]
public virtual string ProtocolPrefix { get; set; }
///<summary>
///Footer text to be used on the printout (optional).
///</summary>
[ApiMember(Description="Footer text to be used on the printout (optional).")]
public virtual string FussText { get; set; }
///<summary>
///The authentification certificate.
///</summary>
[ApiMember(Description="The authentification certificate.")]
public virtual PortalCertificate Zertifikat { 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")]
public virtual string AbrufCode { 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")]
public virtual string DatenLieferant { get; set; }
///<summary>
///The batch of tax data to process.
///</summary>
[ApiMember(Description="The batch of tax data to process.", Name="Data")]
public virtual List<TaxData> Data { get; set; }
}
}
C# BatchValidiereAuthentifiziereSendeUndDruckeAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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.staging.pwc.de
Accept: application/json
Content-Type: application/json
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: application/json
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"}}}]