Tax Filing Service
| POST | /BatchValidiereAuthentifiziereUndSendeAsync |
|---|
/** @description Represents a structure that encapsulates a tax declaration. */
// @Api(Description="Represents a structure that encapsulates a tax declaration.")
export class TaxData
{
/** @description The unique identifier of the tax data. */
// @ApiMember(Description="The unique identifier of the tax data.", IsRequired=true)
public id: string;
/** @description The XML-based tax declaration. */
// @ApiMember(Description="The XML-based tax declaration.", IsRequired=true)
public content: string;
public constructor(init?: Partial<TaxData>) { (Object as any).assign(this, init); }
}
/** @description A base service to process a batch of tax data. */
// @Api(Description="A base service to process a batch of tax data.")
export class BatchBearbeiteVorgangBase implements IPost
{
/** @description The batch of tax data to process. */
// @ApiMember(Description="The batch of tax data to process.", Name="Data")
public data: TaxData[];
public constructor(init?: Partial<BatchBearbeiteVorgangBase>) { (Object as any).assign(this, init); }
}
/** @description Represents a base class for a file with raw data. */
// @Api(Description="Represents a base class for a file with raw data.")
export class FileBase
{
/** @description The raw data content of the file. */
// @ApiMember(Description="The raw data content of the file.", Name="Content")
public content: string;
public constructor(init?: Partial<FileBase>) { (Object as any).assign(this, init); }
}
/** @description Represents a portal certificate that is protected by a password. */
// @Api(Description="Represents a portal certificate that is protected by a password.")
export class PortalCertificate extends FileBase implements ISecuredCertificate, IHasIndex
{
/** @description The unique identifier of the certificate. */
// @ApiMember(Description="The unique identifier of the certificate.")
public id: string;
/** @description The position of the certificate element in an indexed collection of certificates. */
// @ApiMember(Description="The position of the certificate element in an indexed collection of certificates.")
public index: number;
/** @description The password to protect the certificate from unauthorized access. */
// @StringLength(255)
// @ApiMember(Description="The password to protect the certificate from unauthorized access.")
public pin?: string;
/** @description The description of the certificate. */
// @StringLength(2147483647)
// @ApiMember(Description="The description of the certificate.")
public description?: string;
/** @description Tags that can be used to label or identify the certificate. */
// @ApiMember(Description="Tags that can be used to label or identify the certificate.")
public tags: string[];
/** @description Gets or sets the file name of the certificate. */
// @ApiMember(Description="Gets or sets the file name of the certificate.")
public name?: string;
/** @description The raw data content of the file. */
// @ApiMember(Description="The raw data content of the file.", Name="Content")
public content: string;
public constructor(init?: Partial<PortalCertificate>) { super(init); (Object as any).assign(this, init); }
}
/** @description A base service to validate, authenticate and send tax data to the fiscal authorities. */
// @Api(Description="A base service to validate, authenticate and send tax data to the fiscal authorities.")
export class BatchValidiereAuthentifiziereUndSendeBase extends BatchBearbeiteVorgangBase implements IVeschlueselungsRequest, ISendeRequest
{
/** @description The authentification certificate. */
// @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
public zertifikat?: PortalCertificate;
/** @description Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'. */
// @ApiMember(Description="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public abrufCode?: string;
/** @description The details of the provider that submits tax data. */
// @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
public datenLieferant?: string;
/** @description Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers. */
// @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
public stagingEnabled?: boolean;
/** @description The batch of tax data to process. */
// @ApiMember(Description="The batch of tax data to process.", Name="Data")
public data: TaxData[];
public constructor(init?: Partial<BatchValidiereAuthentifiziereUndSendeBase>) { super(init); (Object as any).assign(this, init); }
}
/** @description An asynchronous service to validate, authenticate and send tax data to the fiscal authorities. */
// @Api(Description="An asynchronous service to validate, authenticate and send tax data to the fiscal authorities.")
export class BatchValidiereAuthentifiziereUndSendeAsync extends BatchValidiereAuthentifiziereUndSendeBase
{
/** @description The authentification certificate. */
// @ApiMember(Description="The authentification certificate.", Name="Zertifikat")
public zertifikat?: PortalCertificate;
/** @description Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'. */
// @ApiMember(Description="Gets or sets the retrieval code. This value MUST be given for the tax operation ElsterDatenabholung and tax data type ElsterVaStDaten, for which a SoftPSE certificate is used to sign.In other cases a null value should be given. It consists of 2 x 5 characters, which are joined by '-'. Example: 'K6FG5 - RS32P'.", Name="AbrufCode")
public abrufCode?: string;
/** @description The details of the provider that submits tax data. */
// @ApiMember(Description="The details of the provider that submits tax data.", Name="DatenLieferant")
public datenLieferant?: string;
/** @description Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers. */
// @ApiMember(Description="Should the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.", Name="StagingEnabled")
public stagingEnabled?: boolean;
/** @description The batch of tax data to process. */
// @ApiMember(Description="The batch of tax data to process.", Name="Data")
public data: TaxData[];
public constructor(init?: Partial<BatchValidiereAuthentifiziereUndSendeAsync>) { super(init); (Object as any).assign(this, init); }
}
TypeScript BatchValidiereAuthentifiziereUndSendeAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /BatchValidiereAuthentifiziereUndSendeAsync HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
zertifikat:
{
id: 00000000000000000000000000000000,
index: 0,
pin: String,
description: String,
tags:
[
String
],
name: String,
content: AA==
},
abrufCode: String,
datenLieferant: String,
stagingEnabled: False,
data:
[
{
id: String,
content: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
rueckgabe:
{
erfolg:
{
telenummer:
[
String
],
ordnungsbegriffe:
[
String
]
},
transfers:
{
transferList:
[
{
transferTicket: String
}
]
},
fehlerRegelpruefungen:
[
{
nutzdatenticket: String,
feldidentifikator: String,
mehrfachzeilenindex: String,
lfdNrVordruck: String,
vordruckZeilennummer: String,
semantischeIndexes:
[
{
name: String,
value: String
}
],
untersachbereich: String,
privateKennnummer: String,
regelName: String,
fachlicheFehlerId: String,
text: String
}
],
hinweise:
[
{
nutzdatenticket: String,
feldidentifikator: String,
mehrfachzeilenindex: String,
lfdNrVordruck: String,
vordruckZeilennummer: String,
semantischeIndexes:
[
{
name: String,
value: String
}
],
untersachbereich: String,
privateKennnummer: String,
regelName: String,
fachlicheHinweisId: String,
text: String
}
]
},
serverantwort:
{
transferHeader:
{
version: String,
verfahren: ElsterAnmeldung,
datenArt: 34a,
vorgang: send-Auth,
transferTicket: String,
testmerker: 0,
sigUser:
{
inhalt: {}
},
empfaenger:
{
id: String,
ziel: BW
},
herstellerID: String,
datenLieferant: String,
eingangsDatum: 0001-01-01,
datei:
{
verschluesselung: PKCS#7v1.5,
kompression: GZIP,
transportSchluessel: String,
erstellung:
{
eric:
{
inhalt: {}
}
}
},
rc:
{
rueckgabe:
{
code: String,
text: String
},
stack:
{
code: String,
text: String
}
},
versionClient: String,
zusatz:
{
infos:
[
String
],
elsterInfos:
[
String
]
}
},
datenTeil:
{
nutzdatenbloecke:
[
{
nutzdatenHeader:
{
version: String,
nutzdatenTicket: String,
empfaenger:
{
id: L,
value: String
},
hersteller:
{
produktName: String,
produktVersion: String
},
datenLieferant: String,
rc:
{
rueckgabe:
{
code: String,
text: String
},
stack:
{
code: String,
text: String
}
},
zusatz:
{
infos:
[
String
],
elsterInfos:
[
String
]
}
},
nutzdaten:
{
inhalt: {}
}
}
]
}
},
transferProtocols:
[
{
metadata:
{
name: String,
fullName: String,
lastAccessTime: 0001-01-01,
lastAccessTimeUtc: 0001-01-01,
lastWriteTime: 0001-01-01,
lastWriteTimeUtc: 0001-01-01,
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==
}
],
statusCode: ERIC_OK,
statusText: String,
id: String,
index: 0,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}
]