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
"use strict";
export class CreateXmlFromDefinitionBase {
    /** @param {{jahr?:number,properties?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The 4-digit year of the tax assessment. */
    jahr;
    /**
     * @type {{ [index: string]: string; }}
     * @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. */
    properties;
}
export class CreateZmXmlFromDefinitionBase extends CreateXmlFromDefinitionBase {
    /** @param {{jahr?:number,properties?:{ [index: string]: string; },jahr?:number,properties?:{ [index: string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description The 4-digit year of the tax assessment. */
    jahr;
    /**
     * @type {{ [index: string]: string; }}
     * @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. */
    properties;
}
export class XmlResponse {
    /** @param {{content?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The XML-based content of the response. */
    content;
    /**
     * @type {?ResponseStatus}
     * @description Metadata that contains structured error information on the XML response. */
    responseStatus;
}
export class CreateZmXmlFromDefinition extends CreateZmXmlFromDefinitionBase {
    /** @param {{jahr?:number,properties?:{ [index: string]: string; },jahr?:number,properties?:{ [index: string]: string; },jahr?:number,properties?:{ [index: string]: string; }}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description The 4-digit year of the tax assessment. */
    jahr;
    /**
     * @type {{ [index: string]: string; }}
     * @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. */
    properties;
}

JavaScript CreateZmXmlFromDefinition DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	jahr: 0,
	properties: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	content: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}