Report Filing Service
| POST | /sync/elma/reports/batch/submit |
|---|
/** @description Represents an ELMA report. */
// @Api(Description="Represents an ELMA report.")
export class Report
{
/** @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. */
// @ApiMember(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.", IsRequired=true, Name="Id")
public id: string;
/** @description The XML-content of the report. */
// @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
public data: string;
public constructor(init?: Partial<Report>) { (Object as any).assign(this, init); }
}
/** @description Represents a PEM-encoded certificate. */
// @Api(Description="Represents a PEM-encoded certificate.")
export class PemCertificate
{
/** @description The unique identifier (e.g. the file name) of the certificate. */
// @ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")
public id: string;
/** @description The PEM-encoded content of the certificate. */
// @ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")
public content: string;
/** @description The description of the certificate. */
// @ApiMember(Description="The description of the certificate.", Name="Description")
public description: string;
/** @description Tags to label or identify the certificate. */
// @ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")
public tags: string[];
public constructor(init?: Partial<PemCertificate>) { (Object as any).assign(this, init); }
}
/** @description Represents the credentials of a user to authenticate the access of an ELMA server. */
// @Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")
export class ElmaCredential implements IElmaCredential
{
/** @description The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval. */
// @ApiMember(Description="The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.", IsRequired=true, Name="Id")
public id: string;
/** @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) */
// @ApiMember(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)", IsRequired=true, Name="Certificate")
// @Required()
// @StringLength(2147483647)
public certificate: PemCertificate;
/** @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" */
// @ApiMember(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\"", IsRequired=true, Name="AuthSteuernummer")
// @Required()
// @StringLength(11)
public authSteuernummer: string;
/** @description The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9). */
// @ApiMember(Description="The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).", IsRequired=true, Name="AccountId")
// @Required()
// @StringLength(10)
public accountId: string;
/** @description The password to protect the certificate from unauthorized access. */
// @ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")
public password: string;
public constructor(init?: Partial<ElmaCredential>) { (Object as any).assign(this, init); }
}
/** @description Specifies a request to submit reports to the ELMA server. */
// @Api(Description="Specifies a request to submit reports to the ELMA server.")
export class BatchSubmitReportsBase implements IPost, IAuthenticateRequest, IBatchUploadRequest, IStageableRequest
{
/** @description The reports to submit to the ELMA server. */
// @ApiMember(Description="The reports to submit to the ELMA server.", IsRequired=true, Name="Reports")
public reports: Report[];
/** @description The credential to gain access on the ELMA server. */
// @ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")
public credential: ElmaCredential;
/** @description Should the report data be validated before sending it to the ELMA server? true: report data is validated before submission to the ELMA server. false: report data sent without validation to the ELMA server. */
// @ApiMember(Description="Should the report data be validated before sending it to the ELMA server? true: report data is validated before submission to the ELMA server. false: report data sent without validation to the ELMA server.", Name="ValidationEnabled")
public validationEnabled: 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. */
// @ApiMember(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.", Name="StagingEnabled")
public stagingEnabled?: boolean;
public constructor(init?: Partial<BatchSubmitReportsBase>) { (Object as any).assign(this, init); }
}
/** @description Represents a request to submit reports to the ELMA server. */
// @Api(Description="Represents a request to submit reports to the ELMA server.")
export class BatchSubmitReports extends BatchSubmitReportsBase
{
public constructor(init?: Partial<BatchSubmitReports>) { super(init); (Object as any).assign(this, init); }
}
TypeScript BatchSubmitReports DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/elma/reports/batch/submit HTTP/1.1
Host: reportfiling.pwc.de
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"reports":[{"id":"String","data":"String"}],"credential":{"id":"String_String","certificate":{"id":"String","content":"String","description":"String","tags":["String"]},"authSteuernummer":"String","accountId":"String","password":"String"},"validationEnabled":false,"stagingEnabled":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
[{"id":"String","xml":"String","validationErrors":[{"id":"String","message":"String","severity":"Error","lineNumber":0,"linePosition":0}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]