Report Filing Service
| POST | /sync/elma/protocols/retrieve |
|---|
"use strict";
/** @typedef {'CC'|'CS'|'DC'|'FC'|'FS'|'FA'|'KM'} */
export var Verfahren;
(function (Verfahren) {
Verfahren["CC"] = "CC"
Verfahren["CS"] = "CS"
Verfahren["DC"] = "DC"
Verfahren["FC"] = "FC"
Verfahren["FS"] = "FS"
Verfahren["FA"] = "FA"
Verfahren["KM"] = "KM"
})(Verfahren || (Verfahren = {}));
export class SearchCriteria {
/** @param {{name?:string,designation?:Verfahren}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Full or partial name of the item (report or protocol) to search. */
name;
/**
* @type {?Verfahren}
* @description TThe ELMA product designation. */
designation;
}
export class PemCertificate {
/** @param {{id?:string,content?:string,description?:string,tags?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique identifier (e.g. the file name) of the certificate. */
id;
/**
* @type {string}
* @description The PEM-encoded content of the certificate. */
content;
/**
* @type {string}
* @description The description of the certificate. */
description;
/**
* @type {string[]}
* @description Tags to label or identify the certificate. */
tags;
}
export class ElmaCredential {
/** @param {{id?:string,certificate?:PemCertificate,authSteuernummer?:string,accountId?:string,password?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. */
id;
/**
* @type {PemCertificate}
* @description The security certificate to authenticate the user and grant access to the ELMA server. This certificate is generated from the BZSt-issued *.pfx BOP certificate. More details on BOP (BZSt-Online Portal - https://www.elster.de/bportal/start) */
certificate;
/**
* @type {string}
* @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
authSteuernummer;
/**
* @type {string}
* @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
accountId;
/**
* @type {string}
* @description The password to protect the certificate from unauthorized access. */
password;
}
export class RetrieveProtocolsBase {
/** @param {{searchCriteria?:SearchCriteria,credential?:ElmaCredential,stagingEnabled?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {SearchCriteria}
* @description The parameters to search for protocols. */
searchCriteria;
/**
* @type {ElmaCredential}
* @description The credential to gain access on the ELMA server. */
credential;
/**
* @type {?boolean}
* @description Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server. */
stagingEnabled;
}
/** @typedef {'ELMA_CC'|'ELMA_CCRM'|'ELMA_CRS'|'ELMA_CRSRM'|'ELMA_DC'|'ELMA_DCRM'|'ELMA_FC'|'ELMA_FCRM'} */
export var DatenArt;
(function (DatenArt) {
DatenArt["ELMA_CC"] = "ELMA_CC"
DatenArt["ELMA_CCRM"] = "ELMA_CCRM"
DatenArt["ELMA_CRS"] = "ELMA_CRS"
DatenArt["ELMA_CRSRM"] = "ELMA_CRSRM"
DatenArt["ELMA_DC"] = "ELMA_DC"
DatenArt["ELMA_DCRM"] = "ELMA_DCRM"
DatenArt["ELMA_FC"] = "ELMA_FC"
DatenArt["ELMA_FCRM"] = "ELMA_FCRM"
})(DatenArt || (DatenArt = {}));
/** @typedef {'PRODUKTIONSLAUF'|'TESTLAUF'} */
export var Verarbeitungslauf;
(function (Verarbeitungslauf) {
Verarbeitungslauf["PRODUKTIONSLAUF"] = "PRODUKTIONSLAUF"
Verarbeitungslauf["TESTLAUF"] = "TESTLAUF"
})(Verarbeitungslauf || (Verarbeitungslauf = {}));
export class ElmaHeader {
/** @param {{datenArt?:DatenArt,authSteuernummer?:string,accountId?:string,erstellungsDatum?:string,kundeneigeneId?:string,uuid?:string,verarbeitungslauf?:Verarbeitungslauf}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {DatenArt}
* @description The process-specific report type of an ELMA document.It distinguishes by the type of input. */
datenArt;
/**
* @type {string}
* @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
authSteuernummer;
/**
* @type {string}
* @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
accountId;
/**
* @type {?string}
* @description The time of creation.Corresponds to the time, at which the user created a file. */
erstellungsDatum;
/**
* @type {string}
* @description User custom ID.This field can be filled with internal reference information of the user. */
kundeneigeneId;
/**
* @type {?string}
* @description Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */
uuid;
/**
* @type {Verarbeitungslauf}
* @description Distinguishes between test and live data transfer. */
verarbeitungslauf;
}
export class ElmaVerfahren {
/** @param {{inhalt?:Object}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Object}
* @description The content of process-specific definition. */
inhalt;
}
export class ElmaKom {
/** @param {{elmakomVersion?:string,elmaHeader?:ElmaHeader,elmaVerfahren?:ElmaVerfahren}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The version number of the ELMAKOM definition. */
elmakomVersion;
/**
* @type {ElmaHeader}
* @description The header part of the ELMAKOM definition. */
elmaHeader;
/**
* @type {ElmaVerfahren}
* @description The process part of the ELMAKOM definition. */
elmaVerfahren;
}
/** @typedef {number} */
export var Status;
(function (Status) {
Status[Status["ELMA_GLOBAL_UNBEKANNT"] = 0] = "ELMA_GLOBAL_UNBEKANNT"
Status[Status["ELMA_OK"] = 8000] = "ELMA_OK"
Status[Status["ELMA_PARSER_FEHLER"] = 8001] = "ELMA_PARSER_FEHLER"
Status[Status["ELMA_UNGUELTIGE_KODIERUNG"] = 8002] = "ELMA_UNGUELTIGE_KODIERUNG"
Status[Status["ELMA_UNGUELTIGE_DATEINAME"] = 8003] = "ELMA_UNGUELTIGE_DATEINAME"
Status[Status["ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID"] = 8004] = "ELMA_FALSCHE_BZSTNR_ODER_ACCOUNTID"
Status[Status["ELMA_SIGNATUR_DATEI_FEHLT"] = 8005] = "ELMA_SIGNATUR_DATEI_FEHLT"
Status[Status["ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT"] = 8006] = "ELMA_SIGNATUR_PRUEFUNG_FEHLERHAFT"
Status[Status["ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN"] = 8007] = "ELMA_NOTWENDIGE_FACHLICHE_BERECHTIGUNGEN_FEHLEN"
Status[Status["ELMA_FREISCHALTUNG_FEHLT"] = 8008] = "ELMA_FREISCHALTUNG_FEHLT"
Status[Status["ELMA_SPERRE_VORHANDEN"] = 8009] = "ELMA_SPERRE_VORHANDEN"
Status[Status["ELMA_DATEINAME_BEREITS_VERWENDET"] = 8010] = "ELMA_DATEINAME_BEREITS_VERWENDET"
Status[Status["ELMA_DATEIINHALT_IDENTISCH"] = 8011] = "ELMA_DATEIINHALT_IDENTISCH"
Status[Status["ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN"] = 8012] = "ELMA_BZSTNR_ODER_ACCOUNTID_STIMMT_NICHT_UBEREIN"
Status[Status["ELMA_TESTDATEN"] = 8013] = "ELMA_TESTDATEN"
})(Status || (Status = {}));
export class ElmaProtokoll {
/** @param {{dateiname?:string,authSteuernummer?:string,accountId?:string,verarbeitungsDatum?:string,verarbeitungsZeit?:string,status?:Status,statusText?:string,statusDetail?:string,kundeneigeneId?:string,uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description File name of the processed input ELMA report. */
dateiname;
/**
* @type {string}
* @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
authSteuernummer;
/**
* @type {string}
* @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
accountId;
/**
* @type {?string}
* @description Date on which the request was processed by ELAN (ELMA receiving server at BZSt). */
verarbeitungsDatum;
/**
* @type {?string}
* @description Time of processing by ELAN (ELMA receiving server at BZSt). */
verarbeitungsZeit;
/**
* @type {Status}
* @description The status code of the ELMA process. */
status;
/**
* @type {string}
* @description A brief description of the status. */
statusText;
/**
* @type {string}
* @description A detailed information on the status. */
statusDetail;
/**
* @type {string}
* @description User custom ID.This field can be filled with internal reference information of the user. */
kundeneigeneId;
/**
* @type {?string}
* @description Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */
uuid;
}
export class ElmaFehler {
/** @param {{dateiname?:string,authSteuernummer?:string,accountId?:string,verarbeitungsDatum?:string,verarbeitungsZeit?:string,fehlerID?:Status,fehlerText?:string,fehlerProzess?:string,kundeneigeneId?:string,uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description File name of the processed input ELMA report. */
dateiname;
/**
* @type {string}
* @description The BZSt (Bundeszentralamt für Steuern) - tax number of the user. 11-character text field that may only consist of two capital letters and 9 digits (0-9). The fiscal authority BZSt provides this number during registration at the BOP (BZSt-Online Portal - https://www.elster.de/bportal/start). The number is available in the private area of the BOP user account under "My BOP" under the "Registration Information" */
authSteuernummer;
/**
* @type {string}
* @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
accountId;
/**
* @type {?string}
* @description Date on which the request was processed by ELAN (ELMA receiving server at BZSt). */
verarbeitungsDatum;
/**
* @type {?string}
* @description Time of processing by ELAN (ELMA receiving server at BZSt). */
verarbeitungsZeit;
/**
* @type {Status}
* @description The status code of the ELMA process. */
fehlerID;
/**
* @type {string}
* @description A brief description of the error status. */
fehlerText;
/**
* @type {string}
* @description A detailed information on the status. */
fehlerProzess;
/**
* @type {string}
* @description User custom ID.This field can be filled with internal reference information of the user. */
kundeneigeneId;
/**
* @type {?string}
* @description Data transfer identifier.Hexadecimal formatted number. Example: 550e8400-e29b-11d4-a716-446655440000 */
uuid;
}
export class Elma {
/** @param {{id?:string,schemaLocation?:string,verfahren?:Verfahren,elmaKom?:ElmaKom,elmaProtokoll?:ElmaProtokoll,elmaFehler?:ElmaFehler}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. */
id;
/**
* @type {string}
* @description The location of the XML Schema to use for the root namespace. */
schemaLocation;
/**
* @type {Verfahren}
* @description The type of reporting process. */
verfahren;
/**
* @type {ElmaKom}
* @description The communication section of the ELMA report document. */
elmaKom;
/**
* @type {ElmaProtokoll}
* @description The communication section of the ELMA report document. */
elmaProtokoll;
/**
* @type {ElmaFehler}
* @description The communication section of the ELMA report document. */
elmaFehler;
}
export class FileBase {
/** @param {{content?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The raw data content of the file in bytes. */
content;
}
export class FileMetadata {
/** @param {{name?:string,fullName?:string,lastAccessTime?:string,lastAccessTimeUtc?:string,lastWriteTime?:string,lastWriteTimeUtc?:string,length?:number,userId?:number,groupId?:number,othersCanRead?:boolean,groupCanExecute?:boolean,groupCanWrite?:boolean,groupCanRead?:boolean,ownerCanExecute?:boolean,ownerCanWrite?:boolean,ownerCanRead?:boolean,othersCanExecute?:boolean,othersCanWrite?:boolean,extensions?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The name of the file.
For files, gets the name of the file.
For directories, gets the name of the last directory in the hierarchy if a hierarchy exists; otherwise, the name of the directory. */
name;
/**
* @type {?string}
* @description The full path of the directory or file. */
fullName;
/**
* @type {string}
* @description The time the current file or directory was last accessed. */
lastAccessTime;
/**
* @type {string}
* @description The name of the file. */
lastAccessTimeUtc;
/**
* @type {string}
* @description The time when the current file or directory was last written to. */
lastWriteTime;
/**
* @type {string}
* @description The time, in coordinated universal time (UTC), when the current file or directory was last written to. */
lastWriteTimeUtc;
/**
* @type {number}
* @description The size, in bytes, of the current file. */
length;
/**
* @type {number}
* @description The size, in bytes, of the current file. */
userId;
/**
* @type {number}
* @description The file group id. */
groupId;
/**
* @type {boolean}
* @description A value that indicates whether the others can read from this file. */
othersCanRead;
/**
* @type {boolean}
* @description A value that indicates whether the group members can execute this file. */
groupCanExecute;
/**
* @type {boolean}
* @description A value that indicates whether the group members can write into this file. */
groupCanWrite;
/**
* @type {boolean}
* @description A value that indicates whether the group members can read from this file. */
groupCanRead;
/**
* @type {boolean}
* @description A value that indicates whether the owner can execute this file. */
ownerCanExecute;
/**
* @type {boolean}
* @description A value that indicates whether the owner can write into this file. */
ownerCanWrite;
/**
* @type {boolean}
* @description A value that indicates whether the owner can read from this file. */
ownerCanRead;
/**
* @type {boolean}
* @description A value that indicates whether others can read from this file. */
othersCanExecute;
/**
* @type {boolean}
* @description A value that indicates whether others can write into this file. */
othersCanWrite;
/**
* @type {{ [index: string]: string; }}
* @description Extensions to the file attributes. */
extensions;
}
export class BinaryFile extends FileBase {
/** @param {{metadata?:FileMetadata,name?:string,content?:string,content?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?FileMetadata}
* @description The attributes of the file. */
metadata;
/**
* @type {?string}
* @description The name of the file without information on its directory path. */
name;
/**
* @type {string}
* @description The raw data content of the file in bytes. */
content;
}
export class RetrievalResponse {
/** @param {{protocols?:Elma[],files?:BinaryFile[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Elma[]}
* @description Processing logs that indicate the status of submitted reports. */
protocols;
/**
* @type {BinaryFile[]}
* @description Other artefacts including the auxillary files from the BZSt. */
files;
/**
* @type {ResponseStatus}
* @description The status of the response. */
responseStatus;
}
export class RetrieveProtocols extends RetrieveProtocolsBase {
/** @param {{searchCriteria?:SearchCriteria,credential?:ElmaCredential,stagingEnabled?:boolean,searchCriteria?:SearchCriteria,credential?:ElmaCredential,stagingEnabled?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {SearchCriteria}
* @description The parameters to search for protocols. */
searchCriteria;
/**
* @type {ElmaCredential}
* @description The credential to gain access on the ELMA server. */
credential;
/**
* @type {?boolean}
* @description Should operations be staged on the ELMA server? true: operations are executed on the Test ELMA server. false: operations are executed on the Live (Production) ELMA server. */
stagingEnabled;
}
JavaScript RetrieveProtocols DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/elma/protocols/retrieve HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"searchCriteria":{"name":"String","designation":"CC"},"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"stagingEnabled":false}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length
{"protocols":[{"id":"String","schemaLocation":"String","verfahren":"CC","elmaKom":{"elmakomVersion":"String","elmaHeader":{"datenArt":"ELMA_CC","authSteuernummer":"String","accountId":"String","erstellungsDatum":"\/Date(-62135596800000-0000)\/","kundeneigeneId":"String","uuid":"00000000000000000000000000000000","verarbeitungslauf":"PRODUKTIONSLAUF"},"elmaVerfahren":{"inhalt":{}}},"elmaProtokoll":{"dateiname":"String","authSteuernummer":"String","accountId":"String","verarbeitungsDatum":"\/Date(-62135596800000-0000)\/","verarbeitungsZeit":"\/Date(-62135596800000-0000)\/","status":"ELMA_GLOBAL_UNBEKANNT","statusText":"String","statusDetail":"String","kundeneigeneId":"String","uuid":"00000000000000000000000000000000"},"elmaFehler":{"dateiname":"String","authSteuernummer":"String","accountId":"String","verarbeitungsDatum":"\/Date(-62135596800000-0000)\/","verarbeitungsZeit":"\/Date(-62135596800000-0000)\/","fehlerID":"ELMA_GLOBAL_UNBEKANNT","fehlerText":"String","fehlerProzess":"String","kundeneigeneId":"String","uuid":"00000000000000000000000000000000"}}],"files":[{"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=="}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}