Report Filing Service
| POST | /async/elma/reports/batch/recall |
|---|
"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 BatchRecallReportsBase {
/** @param {{searchCriteria?:SearchCriteria,credential?:ElmaCredential,stagingEnabled?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {SearchCriteria}
* @description The parameters to search or filter on reports. */
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;
}
export class Report {
/** @param {{id?:string,data?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The conventional ELMA file name of the report. The format of the ELMA formula is as follows: m5_<pb>_<BZSt-Nr>_<AccountID>_<DateiId>.xml where: m5 is a constant for all reporting types. pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc. BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789 AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890 DateiId is the 1 - 12 character internal short name for the data file. */
id;
/**
* @type {string}
* @description The XML-content of the report. */
data;
}
export class RecallResponse {
/** @param {{reports?:Report[],responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Report[]}
* @description The recalled reports. */
reports;
/**
* @type {ResponseStatus}
* @description The status of the recall operation. */
responseStatus;
}
export class BatchRecallReportsAsync extends BatchRecallReportsBase {
/** @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 or filter on reports. */
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 BatchRecallReportsAsync DTOs
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 /async/elma/reports/batch/recall HTTP/1.1
Host: reportfiling.staging.pwc.de
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchRecallReportsAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Requests">
<Credential xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Concretes.Models">
<d2p1:AccountId>String</d2p1:AccountId>
<d2p1:AuthSteuernummer>String</d2p1:AuthSteuernummer>
<d2p1:Certificate xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
<d3p1:Content>String</d3p1:Content>
<d3p1:Description>String</d3p1:Description>
<d3p1:Id>String</d3p1:Id>
<d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d3p1:Tags>
</d2p1:Certificate>
<d2p1:Password>String</d2p1:Password>
</Credential>
<SearchCriteria>
<Designation>CC</Designation>
<Name>String</Name>
</SearchCriteria>
<StagingEnabled>false</StagingEnabled>
</BatchRecallReportsAsync>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<RecallResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Services.Contracts.Responses">
<Reports xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Elmaas.Core.Domain.Contracts.Models">
<d2p1:Report>
<d2p1:Data>String</d2p1:Data>
<d2p1:Id>String</d2p1:Id>
</d2p1:Report>
</Reports>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</RecallResponse>