Tax Filing Service

<back to all web services

CreateZmXmlFromDefinition

SyncUmsatzsteuerZusammenfassende MeldungReturnBuilderDefinition

A synchronous service to create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.

Requires Authentication
The following routes are available for this service:
POST/CreateZmXmlFromDefinition
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties. */
// @Api(Description="Create a VAT return from a dictionary (hash map) of key/value definitions with a dictionary (hash map) of properties.")
class CreateXmlFromDefinitionBase implements JsonSerializable
{
    public function __construct(
        /** @description The 4-digit year of the tax assessment. */
        // @ApiMember(Description="The 4-digit year of the tax assessment.")
        /** @var int */
        public int $jahr=0,

        /** @description Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value. */
        // @ApiMember(Description="Dictionary of key-value pairs that represent the intrinsic properties of the VAT return. Each key represents a name of the VAT property.Each value of the pair represents the VAT property value.")
        /** @var array<string,string>|null */
        public ?array $properties=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['jahr'])) $this->jahr = $o['jahr'];
        if (isset($o['properties'])) $this->properties = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['properties']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->jahr)) $o['jahr'] = $this->jahr;
        if (isset($this->properties)) $o['properties'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->properties);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions. */
// @Api(Description="Create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
class CreateZmXmlFromDefinitionBase extends CreateXmlFromDefinitionBase implements IPost, JsonSerializable
{
    /**
     * @param int $jahr
     * @param array<string,string>|null $properties
     */
    public function __construct(
        int $jahr=0,
        ?array $properties=null
    ) {
        parent::__construct($jahr,$properties);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['jahr'])) $this->jahr = $o['jahr'];
        if (isset($o['properties'])) $this->properties = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['properties']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->jahr)) $o['jahr'] = $this->jahr;
        if (isset($this->properties)) $o['properties'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->properties);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Represents the response from a service that generates XML content. */
// @Api(Description="Represents the response from a service that generates XML content.")
class XmlResponse implements JsonSerializable
{
    public function __construct(
        /** @description The XML-based content of the response. */
        // @ApiMember(Description="The XML-based content of the response.")
        /** @var string|null */
        public ?string $content=null,

        /** @description Metadata that contains structured error information on the XML response. */
        // @ApiMember(Description="Metadata that contains structured error information on the XML response.")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['content'])) $this->content = $o['content'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->content)) $o['content'] = $this->content;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description A synchronous service to create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions. */
// @Api(Description="A synchronous service to create XML content that represents a recapitulative tax return (Zusammenfassende Meldung) from the specified dictionary (hash map) of key/value definitions.")
class CreateZmXmlFromDefinition extends CreateZmXmlFromDefinitionBase implements JsonSerializable
{
    /**
     * @param int $jahr
     * @param array<string,string>|null $properties
     * @param int $jahr
     * @param array<string,string>|null $properties
     */
    public function __construct(
        int $jahr=0,
        ?array $properties=null,
        int $jahr=0,
        ?array $properties=null
    ) {
        parent::__construct($jahr,$properties,$jahr,$properties);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['jahr'])) $this->jahr = $o['jahr'];
        if (isset($o['properties'])) $this->properties = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['properties']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->jahr)) $o['jahr'] = $this->jahr;
        if (isset($this->properties)) $o['properties'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->properties);
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateZmXmlFromDefinition DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

<CreateZmXmlFromDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Umsatzsteuer.ReturnBuilder.Requests">
  <Jahr>0</Jahr>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Properties>
</CreateZmXmlFromDefinition>

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

<XmlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.xEric.Core.Services.Contracts.Responses">
  <Content>String</Content>
  <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>
</XmlResponse>
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.