<back to all web services

CheckElsterAsync

An asynchronous service to perform basic checks on a batch of tax data.

/** @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 perform basic checks on a batch of tax data. */
// @Api(Description="A base service to perform basic checks on a batch of tax data.")
export class CheckElsterBase implements IPost
{
    /** @description The ELSTER tax data to check. */
    // @ApiMember(Description="The ELSTER tax data to check.", Name="Data")
    public data: TaxData;

    public constructor(init?: Partial<CheckElsterBase>) { (Object as any).assign(this, init); }
}

/** @description Specifies a service response from an ERiC service operation. */
// @Api(Description="Specifies a service response from an ERiC service operation.")
export class ServiceReponseBase implements IHasIndex
{
    /** @description The unique identifier of the response. */
    // @ApiMember(Description="The unique identifier of the response.")
    public id: string;

    /** @description The position of the response element in an indexed collection. */
    // @ApiMember(Description="The position of the response element in an indexed collection.")
    public index: number;

    /** @description Metadata that contains structured error information on the service response. */
    // @ApiMember(Description="Metadata that contains structured error information on the service response.")
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<ServiceReponseBase>) { (Object as any).assign(this, init); }
}

/** @description Represents a type that encapulates the state of a provided ELSTER tax data. */
// @Api(Description="Represents a type that encapulates the state of a provided ELSTER tax data.")
export class ElsterCheckResponse extends ServiceReponseBase
{
    /** @description Checks whether a portal certificate is required to sign the tax data. */
    // @ApiMember(Description="Checks whether a portal certificate is required to sign the tax data.")
    public zertifikatErforderlich: boolean;

    /** @description Checks whether a Manufacturer ID has been provided for the tax data. */
    // @ApiMember(Description="Checks whether a Manufacturer ID has been provided for the tax data.")
    public hatHerstellerId: boolean;

    /** @description Checks whether a data provider has been provided for the tax data. */
    // @ApiMember(Description="Checks whether a data provider has been provided for the tax data.")
    public hatDatenlieferant: boolean;

    /** @description Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data. */
    // @ApiMember(Description="Checks whether the PDF-based transfer protocol for the tax data can be printed out for the type of tax data.")
    public transferProtokollDruckbar: boolean;

    public constructor(init?: Partial<ElsterCheckResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description An asynchronous service to perform basic checks on a batch of tax data. */
// @Api(Description="An asynchronous service to perform basic checks on a batch of tax data.")
export class CheckElsterAsync extends CheckElsterBase
{

    public constructor(init?: Partial<CheckElsterAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CheckElsterAsync DTOs

POST /CheckElsterAsync HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CheckElsterAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Domain.Concretes.Models">
    <d2p1:Content>String</d2p1:Content>
    <d2p1:Id>String</d2p1:Id>
  </Data>
</CheckElsterAsync>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ElsterCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Id>String</Id>
  <Index>0</Index>
  <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>
  <HatDatenlieferant>false</HatDatenlieferant>
  <HatHerstellerId>false</HatHerstellerId>
  <TransferProtokollDruckbar>false</TransferProtokollDruckbar>
  <ZertifikatErforderlich>false</ZertifikatErforderlich>
</ElsterCheckResponse>