POST | /BatchValidiereUndSendeAsync | An asynchronous service to validate and send batch of tax data. |
---|
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;
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 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 and send batch of tax data.
///</summary>
[Api(Description="An asynchronous service to validate and send batch of tax data.")]
public partial class BatchValidiereUndSendeAsync
: BatchValidiereUndSendeBase
{
public BatchValidiereUndSendeAsync()
{
Data = new List<TaxData>{};
}
///<summary>
///Name prefix of the generated transfer protocol file.
///</summary>
[ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")]
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).", Name="FussText")]
public virtual string FussText { get; set; }
///<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 virtual bool? DuplexDruck { get; set; }
///<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 virtual string DatenLieferant { get; set; }
///<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 virtual bool? StagingEnabled { 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 and send batch of tax data.
///</summary>
[Api(Description="A base service to validate and send batch of tax data.")]
public partial class BatchValidiereUndSendeBase
: BatchBearbeiteVorgangBase, ISendeRequest, IDruckRequest
{
public BatchValidiereUndSendeBase()
{
Data = new List<TaxData>{};
}
///<summary>
///Name prefix of the generated transfer protocol file.
///</summary>
[ApiMember(Description="Name prefix of the generated transfer protocol file.", Name="ProtocolPrefix")]
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).", Name="FussText")]
public virtual string FussText { get; set; }
///<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 virtual bool? DuplexDruck { get; set; }
///<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 virtual string DatenLieferant { get; set; }
///<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 virtual bool? StagingEnabled { 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# BatchValidiereUndSendeAsync 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 /BatchValidiereUndSendeAsync HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: text/jsv
Content-Type: text/jsv
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/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 } } } ]