Tax Filing Service

<back to all web services

CreateLegacyUstXmlFromDefinition

SyncUmsatzsteuerJahressteuererklärungLegacyReturnBuilderDefinition

A synchronous service to create XML content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions.

Requires Authentication
The following routes are available for this service:
POST/CreateLegacyUstXmlFromDefinitionA synchronous service to create xml content that represents an annual VAT return (Umsatzsteuerjahreserklärung) from the specified dictionary (hash map) of key/value definitions.
CreateLegacyUstXmlFromDefinitionBase Parameters:
NameParameterData TypeRequiredDescription
VorsatzformVorsatzYesDer Vorsatz der Jahressteuererklaerung.
BundesfinanzamtsnummerformstringNoThe four-digit federal tax office number of the receiving tax office.
DatenLieferantformstringYesThe details of the provider that submits the tax data.
CreateXmlFromDefinitionBase Parameters:
NameParameterData TypeRequiredDescription
PropertiesformDictionary<string, string>NoDictionary of key-value pairs that represent the intrinsic properties of the VAT declaration. Each key represents a name of the VAT property. Each value of the pair represents the VAT property value.
CreateXmlFromDefinitionAbstract Parameters:
NameParameterData TypeRequiredDescription
JahrformintYesThe year of the assessment
StagingEnabledformboolNoShould the processing of the tax data be staged? If true, tax data is not sent to the production ELSTER servers.
Vorsatz Parameters:
NameParameterData TypeRequiredDescription
UnterfallartformUnterfallartYesUnterfalllarten für die verschiedenen Verfahren.
OrdNrArtformOrdNrArtYesDie Art des ermittelten Ordnungsbegriffs zu füllen.
VorgangformVeranlagungVorgangYesDer Vorgang bei einer Veranlagung.
StNrformstringNo
IDformstringNo
IDEhefrauformstringNo
ZeitraumformintYesDas Jahr, für das die Erklärung gilt, im Format JJJJ.
ErstelldatumformDateTime?NoDas Erstellungsdatum des Steuerfalls, im Format JJJJMMDD.
ErstellzeitformDateTime?NoDie Erstellungszeit des Steuerfalls, im Format hhmmss.
AbsNameformstringYesName, alphanumerisch, max. 45-stellig.
AbsStrformstringYesStraße und Hausnummer, alphanumerisch, max. 30-stellig.
AbsPlzformstringNoPostleitzahl, numerisch, 5-stellig.
AbsOrtformstringYesOrt, alphanumerisch, max. 29-stellig.
CopyrightformstringNoCopyrightmeldung des SW-Herstellers, alphanumerisch, max.50-stellig
RueckuebermittlungformRueckuebermittlungNoDie zur Abholung notwendigen Informationen werden hier angegeben.
Unterfallart Enum:
NameValue
UFA1010Gilt nur für die Datenart 'ESt'.
UFA1212Gilt nur für die Datenart 'EStbeschraenkt'.
UFA1313Gilt nur für die Datenart 'Anlage34a'.
UFA2020Gilt nur für die Datenart 'GewSt'.
UFA2121Gilt nur für die Datenart 'GewStZ'.
UFA3030Gilt nur für die Datenart 'KSt'.
UFA3131Gilt nur für die Datenart 'KSt'.
UFA3232Gilt nur für die Datenart 'KSt'.
UFA3333Gilt nur für die Datenart 'KSt'.
UFA3939Gilt nur für die Datenart 'KStZ'.
UFA5050Gilt nur für die Datenart 'USt'.
UFA5757Gilt nur für die Datenart 'USt'.
UFA5858Gilt nur für die Datenart 'USt'.
UFA6464Gilt nur für die Datenart 'USt'.
UFA7676Gilt nur für die Datenart 'EUER'.
UFA7777Gilt nur für die Datenart 'EUER'.
UFA8888Gilt nur für die Datenart 'EUER'.
UFA9090Gilt nur für die Datenart 'FEIN'.
UFA9595Gilt nur für die Datenart 'FEIN'.
UFA9797Gilt nur für die Datenart 'InvStG56Abs5'.
Keine98Keine Unterfallart
OrdNrArt Enum:
SSteuernummer.
OMaschinell.
VeranlagungVorgang Enum:
NameValue
NurVeranlagung1'01': Bei Nur-Veranlagung.
VeranlagungMitVorauszahlung4'04': Bei Veranlagung mit Vorauszahlung zu füllen
Rueckuebermittlung Parameters:
NameParameterData TypeRequiredDescription
BescheidformboolNoDieses Attribut beschreibt, ob eine Datenabholung gewünscht ist.
ArtRueckuebermittlungformstringNoArt der Adresse der Bescheidbereitstellung: INTERNET bei Rückübermittlung über Internet.
SchluesselRueckuebermittlungformstringNoÖffentlicher Schlüssel mit variabler Länge.
AdresseRueckuebermittlungformstringNoErforderliche Adresselemente bei Benachrichtigung für Bescheidbereitstellung: E-Mail-Adresse.
XmlResponse Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNoThe XML-based content of the response.
ResponseStatusformResponseStatusNoMetadata that contains structured error information on the XML response.

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 /CreateLegacyUstXmlFromDefinition HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	vorsatz: 
	{
		unterfallart: UFA10,
		ordNrArt: S,
		vorgang: NurVeranlagung,
		stNr: String,
		id: String,
		idEhefrau: String,
		zeitraum: 0,
		erstelldatum: 0001-01-01,
		erstellzeit: 0001-01-01,
		absName: String,
		absStr: String,
		absPlz: String,
		absOrt: String,
		copyright: String,
		rueckuebermittlung: 
		{
			bescheid: False,
			artRueckuebermittlung: String,
			schluesselRueckuebermittlung: String,
			adresseRueckuebermittlung: String
		}
	},
	bundesfinanzamtsnummer: String,
	datenLieferant: String,
	properties: 
	{
		String: String
	},
	jahr: 0,
	stagingEnabled: False
}
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
		}
	}
}