Report Filing Service
| POST | /sync/elma/reports/submit |
|---|
namespace PwC.Elmaas.Core.Domain.Concretes.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<summary>
///Represents a failure encountered during the validation of an ELMA report against its XML schema.
///</summary>
[<Api(Description="Represents a failure encountered during the validation of an ELMA report against its XML schema. ")>]
[<AllowNullLiteral>]
type ValidationError() =
///<summary>
///The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
///</summary>
[<ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")>]
member val Id:String = null with get,set
///<summary>
///The message of the validation failure.
///</summary>
[<ApiMember(Description="The message of the validation failure.", Name="Message")>]
member val Message:String = null with get,set
///<summary>
///The severity of the validation faílure.
///</summary>
[<ApiMember(Description="The severity of the validation faílure.", Name="Severity")>]
member val Severity:XmlSeverityType = new XmlSeverityType() with get,set
///<summary>
///The line number indicating where the error occurred.
///</summary>
[<ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")>]
member val LineNumber:Int32 = new Int32() with get,set
///<summary>
///The line position indicating where the error occurred.
///</summary>
[<ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")>]
member val LinePosition:Int32 = new Int32() with get,set
///<summary>
///Encapsulates the results of submitting a report
///</summary>
[<Api(Description="Encapsulates the results of submitting a report")>]
[<AllowNullLiteral>]
type SubmissionResponse() =
///<summary>
///The unique identifier of the report that was processed.
///</summary>
[<ApiMember(Description="The unique identifier of the report that was processed.", Name="Id")>]
member val Id:String = null with get,set
///<summary>
///The submitted XML-based report content.
///</summary>
[<ApiMember(Description="The submitted XML-based report content.", Name="Xml")>]
member val Xml:String = null with get,set
///<summary>
///The errors encountered during the validation phase of the report submission operation.
///</summary>
[<ApiMember(Description="The errors encountered during the validation phase of the report submission operation.", Name="ValidationErrors")>]
member val ValidationErrors:ResizeArray<ValidationError> = new ResizeArray<ValidationError>() with get,set
///<summary>
///The status of the report submission operation.
///</summary>
[<ApiMember(Description="The status of the report submission operation.", Name="ResponseStatus")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Represents an ELMA report.
///</summary>
[<Api(Description="Represents an ELMA report.")>]
[<AllowNullLiteral>]
type Report() =
///<summary>
///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.
///</summary>
[<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")>]
member val Id:String = null with get,set
///<summary>
///The XML-content of the report.
///</summary>
[<ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")>]
member val Data:String = null with get,set
///<summary>
///Represents a PEM-encoded certificate.
///</summary>
[<Api(Description="Represents a PEM-encoded certificate.")>]
[<AllowNullLiteral>]
type PemCertificate() =
///<summary>
///The unique identifier (e.g. the file name) of the certificate.
///</summary>
[<ApiMember(Description="The unique identifier (e.g. the file name) of the certificate.", IsRequired=true, Name="Id")>]
member val Id:String = null with get,set
///<summary>
///The PEM-encoded content of the certificate.
///</summary>
[<ApiMember(Description="The PEM-encoded content of the certificate.", IsRequired=true, Name="Content")>]
member val Content:String = null with get,set
///<summary>
///The description of the certificate.
///</summary>
[<ApiMember(Description="The description of the certificate.", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Tags to label or identify the certificate.
///</summary>
[<ApiMember(Description="Tags to label or identify the certificate.", Name="Tags")>]
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Represents the credentials of a user to authenticate the access of an ELMA server.
///</summary>
[<Api(Description="Represents the credentials of a user to authenticate the access of an ELMA server.")>]
[<AllowNullLiteral>]
type ElmaCredential() =
///<summary>
///The unique identifier of this instance. This identifer is only relevant in the context of data storage and retrieval.
///</summary>
[<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")>]
member val Id:String = null with get,set
///<summary>
///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)
///</summary>
[<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(Int32.MaxValue)>]
member val Certificate:PemCertificate = null with get,set
///<summary>
///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"
///</summary>
[<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)>]
member val AuthSteuernummer:String = null with get,set
///<summary>
///The account identifier of a BZSt-Online Portal (BOP) user. 10-character text field that may only contain numbers (0-9).
///</summary>
[<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)>]
member val AccountId:String = null with get,set
///<summary>
///The password to protect the certificate from unauthorized access.
///</summary>
[<ApiMember(Description="The password to protect the certificate from unauthorized access.", IsRequired=true, Name="Password")>]
member val Password:String = null with get,set
///<summary>
///Specifies a request to submit a report on the ELMA server.
///</summary>
[<Api(Description="Specifies a request to submit a report on the ELMA server.")>]
[<AllowNullLiteral>]
type SubmitReportBase() =
interface IPost
///<summary>
///The report to submit.
///</summary>
[<ApiMember(Description="The report to submit.", IsRequired=true, Name="Report")>]
member val Report:Report = null with get,set
///<summary>
///The credential to gain access on the ELMA server.
///</summary>
[<ApiMember(Description="The credential to gain access on the ELMA server.", IsRequired=true, Name="Credential")>]
member val Credential:ElmaCredential = null with get,set
///<summary>
///Should the report data be validated before sending it to the ELMA server? true: report data is validated before it is sent to the ELMA server. false: report data sent without validation to the ELMA server.
///</summary>
[<ApiMember(Description="Should the report data be validated before sending it to the ELMA server? true: report data is validated before it is sent to the ELMA server. false: report data sent without validation to the ELMA server.", IsRequired=true, Name="ValidationEnabled")>]
member val ValidationEnabled:Boolean = new Boolean() with get,set
///<summary>
///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.
///</summary>
[<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")>]
member val StagingEnabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Represents a request to submit a report on the ELMA server.
///</summary>
[<Api(Description="Represents a request to submit a report on the ELMA server.")>]
[<AllowNullLiteral>]
type SubmitReport() =
inherit SubmitReportBase()
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/reports/submit HTTP/1.1
Host: reportfiling.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"report":{"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: application/x-msgpack
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"}}}