POST | /datenabholungen/protokolle/17/verarbeitungsprotokoll/batch |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Bescheide | body | List<Abholung17> | Yes | The tax assessements, whose processing records shall be obtained. |
Zertifikat | body | PortalCertificate | Yes | The authentification certificate. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Bescheide | form | List<Abholung17> | Yes | The tax assessements, whose processing records shall be obtained. |
Zertifikat | form | PortalCertificate | Yes | The authentification certificate. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Zertifikat | form | PortalCertificate | Yes | The authentification certificate. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | The unique identifier of the certificate. |
Index | form | int | No | The position of the certificate element in an indexed collection of certificates. |
Pin | form | string | No | The password to protect the certificate from unauthorized access. |
Description | form | string | No | The description of the certificate. |
Tags | form | List<string> | Yes | Tags that can be used to label or identify the certificate. |
Name | form | string | No | Gets or sets the file name of the certificate. |
Content | form | byte[] | No | The raw data content of the file. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Content | form | byte[] | No | The raw data content of the file. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Steuerart | form | Steuerart? | No | The tax type (e.g. ESB) of the data record. |
MetaInformationen | form | MetaInformationen17 | No | The meta information of the identifier. |
Bereitstellungsticket | form | string | No | Die Transfertickets der Datensaetze. Es duerfen max. 100 Bereitstellungstickets in einem Request angegeben werden. |
Anhaenge | form | Anhaenge17 | No | The attachments of the data records. |
Id | form | string | No | The identifier of the data record. |
Idnr | form | string | No | The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Veranlagungsjahr | form | int? | No | The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Uebertragungsweg | form | Uebertragungsweg? | No | The transmission path used. |
Encoding | form | string | No | The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING. |
Mandantennummer | form | string | No | The client number; only applicable to the tax type 'ElsterDIVADaten'. |
Steuernummer | form | string | No | The tax number; only applicable to the tax type 'ElsterDIVADaten'. |
Bescheiddatum | form | DateTime? | No | The asessment date; only applicable to the tax type 'ElsterDIVADaten'. |
Datenpaket | form | Datenpaket | No | Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet. |
Download | form | Download | No | Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | The identifier of the data record. |
Idnr | form | string | No | The ID number of the receipt owner. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Veranlagungsjahr | form | int? | No | The assessment year (YYYY) of the receipt. This attribute is only required for the tax type 'ElsterVaStDaten'. |
Uebertragungsweg | form | Uebertragungsweg? | No | The transmission path used. |
Encoding | form | string | No | The character encoding of the data record (e.g. ISO-8859-15). The exception is the data type ElsterVaStDaten, here we submit KEIN ENCODING. |
Mandantennummer | form | string | No | The client number; only applicable to the tax type 'ElsterDIVADaten'. |
Steuernummer | form | string | No | The tax number; only applicable to the tax type 'ElsterDIVADaten'. |
Bescheiddatum | form | DateTime? | No | The asessment date; only applicable to the tax type 'ElsterDIVADaten'. |
Datenpaket | form | Datenpaket | No | Das Datenpaket angeforderter Datensaetze. Nur bei der Direktsendung ueber das ERiClet. |
Download | form | Download | No | Download requested data records. Ensure the second payload data block is empty for bulk retrieval operations. |
direkt | Retrieve the data directly via an ERiClet. |
link | Retrieve the data via a link to the available data on the web server. |
sammellink | Retrieve the bulk data via a link to the available data on the web server. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Value | form | string | No | Encoded (compressed and encrypted) requested data record |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Url | form | string | No | The link to the data on the web server. |
Benutzer | form | string | No | The user name for the web server. |
Passwort | form | string | No | Password for the web server. |
ESB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
GSB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
USB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
EPBescheid | Maps to tax type 'ElsterEPBescheidDaten'. |
EPMitteilung | Maps to tax type 'ElsterEPMitteilungDaten'. |
Gewerbesteuerbescheid | Maps to tax type the 'EPStBescheidAbholung'. |
Gewerbesteuermitteilung | Maps to tax type 'EPStMitteilungAbholung'. |
GEWMB | Maps to tax type 'ElsterErklaerungDaten' oder 'MitteilungAbholung'. |
DIVAAnzeigeEinerLotterie | Maps to tax type 'ElsterDIVADaten'. |
DIVABescheid | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidESt | Maps to tax type 'ElsterDIVADaten'. |
DIVABuchmachersteuer | Maps to tax type 'ElsterDIVADaten'. |
DIVALotteriesteuerEinmal | Maps to tax type 'ElsterDIVADaten'. |
DIVALotteriesteuerMehr | Maps to tax type 'ElsterDIVADaten'. |
DIVASportwettensteuer | Maps to tax type 'ElsterDIVADaten'. |
DIVATotalisator | Maps to tax type 'ElsterDIVADaten'. |
OZGBescheid | Maps to tax type 'ElsterDIVADaten'. |
VerbindlicheAuskunft | Maps to tax type 'ElsterDIVADaten'. |
VerbindlicheZusage | Maps to tax type 'ElsterDIVADaten'. |
DivaSonstigerVA | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidErbSt | |
DivaBescheidFEIN | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidGewSt | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidKSt | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidUSt | Maps to tax type 'ElsterDIVADaten'. |
DivaBescheidSchenkSt | |
DIVATroncabgabe | Maps to tax type 'ElsterDIVADaten'. |
DIVAVirtuelleAutomatenStB | Maps to tax type 'ElsterDIVADaten'. |
DIVAOnlinePokerStB | Maps to tax type 'ElsterDIVADaten'. |
LStHVVMRM | Maps to tax type 'ElsterVollmachtDaten'. |
EinlagenrueckgewaehrVA | Maps to tax type 'DIVADatenBZSt'. |
FTTMeldungVA | Maps to tax type 'DIVADatenBZSt'. |
StatusInvStGVA | Maps to tax type 'DIVADatenBZSt'. |
UStVEUVA | Maps to tax type 'DIVADatenBZSt'. |
VERSVA | Maps to tax type 'DIVADatenBZSt'. |
AltZertVA | Maps to tax type 'DIVADatenBZSt'. |
KapEStEntlastungVA | Maps to tax type 'DIVADatenBZSt'. |
PostUDLVA | Maps to tax type 'DIVADatenBZSt'. |
StAb50aVA | Maps to tax type 'DIVADatenBZSt'. |
StAbEntlastungVA | Maps to tax type 'DIVADatenBZSt'. |
KassenangelegenheitenVA | Maps to tax type 'DIVADatenBZSt'. |
KStOptVA | Maps to tax type 'DIVADatenBZSt'. |
SteueroasenabwehrVA | Maps to tax type 'DIVADatenBZSt'. |
KDBVollmachtRM | Maps to tax type 'ElsterDIVADaten'. |
STBKE | Maps to tax type 'ElsterDIVADaten'. |
VDBKDBRueckmeldungLief | Maps to tax type 'ElsterDIVADaten'. |
AnhangRueckmeldung | Maps to tax type 'MitteilungAbholung'. |
DivaEinwilligungRM | Maps to tax type 'MitteilungAbholung'. |
GlueckspielF | Maps to tax type 'MitteilungAbholung'. |
OZGMitteilung | Maps to tax type 'MitteilungAbholung'. |
VerbindlicheAuskunftInfoF | Maps to tax type 'MitteilungAbholung'. |
ELOProtokoll | ELOProtokoll |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Meta | form | List<Meta17> | Yes | List of metadata. |
MetaInfoMaps | form | MetaInfoMaps17 | No | List of meta infomation maps. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | The type of metadata, e.g. datei [file] |
Coding | form | Coding? | No | The encoding of the metadata (text or base64) |
Value | form | string | No | The content of the metadata |
text | Plain text. |
base64 | Base-64 encoded content. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /datenabholungen/protokolle/17/verarbeitungsprotokoll/batch HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchProtokollRequest17 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Datenabholungen.Requests.Protokolle">
<Zertifikat xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
<Content xmlns="http://schemas.datacontract.org/2004/07/PwC.DigitalHub.Utilities.IO.Core.Contracts.Models">AA==</Content>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Index>0</d2p1:Index>
<d2p1:Name>String</d2p1:Name>
<d2p1:Pin>String</d2p1:Pin>
<d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</d2p1:Tags>
</Zertifikat>
<Bescheide xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Datenabholungen.Models">
<d2p1:Abholung17 id="String" idnr="String" veranlagungsjahr="0" uebertragungsweg="direkt" encoding="String" bereitstellungsticket="String">
<MetaInformationen>
<Meta art="String" coding="text">String</Meta>
<MetaInfoMaps>
<MetaInfoMap typ="String">
<Meta art="String" coding="text">String</Meta>
</MetaInfoMap>
</MetaInfoMaps>
</MetaInformationen>
<Datenpaket>String</Datenpaket>
<Download>
<Url>String</Url>
<Benutzer>String</Benutzer>
<Passwort>String</Passwort>
</Download>
<Anhaenge version="0">
<Anhang>
<Dateibezeichnung>String</Dateibezeichnung>
<Dateityp>String</Dateityp>
<Dateiinhalt>String</Dateiinhalt>
<MetadatumAnhang>
<SchluesselAnhang DateibezeichnungID="String" DateibezeichnungKurz="String">String</SchluesselAnhang>
<WertAnhang DateibezeichnungID="String" DateibezeichnungKurz="String">String</WertAnhang>
</MetadatumAnhang>
</Anhang>
</Anhaenge>
</d2p1:Abholung17>
</Bescheide>
</BatchProtokollRequest17>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfProtokollResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Datenabholungen.Responses"> <ProtokollResponse> <Id xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">String</Id> <Index xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">0</Index> <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses"> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:Message>String</d3p1:Message> <d3p1:StackTrace>String</d3p1:StackTrace> <d3p1:Errors> <d3p1:ResponseError> <d3p1:ErrorCode>String</d3p1:ErrorCode> <d3p1:FieldName>String</d3p1:FieldName> <d3p1:Message>String</d3p1:Message> <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:KeyValueOfstringstring> <d6p1:Key>String</d6p1:Key> <d6p1:Value>String</d6p1:Value> </d6p1:KeyValueOfstringstring> </d3p1:Meta> </d3p1:ResponseError> </d3p1:Errors> <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:KeyValueOfstringstring> <d4p1:Key>String</d4p1:Key> <d4p1:Value>String</d4p1:Value> </d4p1:KeyValueOfstringstring> </d3p1:Meta> </ResponseStatus> <Protokoll version="0" xmlns="http://www.elsterfachmethodik.de/protokollverfahren/version6/XMLSchema"> <ZeitStempel>00010101000000</ZeitStempel> <DatenTeil transferTicket="String" code="0" text="String"> <Nutzdatenblock nutzdatenTicket="String" code="0" text="String" verarbeiteteNdS="0" nichtverarbeiteteNdS="0"> <NdSFehler lfdNr="String" kmId="String" ordnungsMerkmal="String" fehlerNummer="0" fehlerText="String" /> </Nutzdatenblock> </DatenTeil> </Protokoll> </ProtokollResponse> </ArrayOfProtokollResponse>