Tax Filing Service

<back to all web services

CreateUstVaXmlFromDefinitionAsync

AsyncUmsatzsteuerVoranmeldungReturnBuilderDefinition

An asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions.

Requires Authentication
The following routes are available for this service:
POST/CreateUstVaXmlFromDefinitionAsyncAn asynchronous service to create xml content that represents a preliminary VAT return (Umsatzsteuervoranmeldung) from the specified dictionary (hash map) of key/value definitions
CreateUstaXmlFromDefinitionBase Parameters:
NameParameterData TypeRequiredDescription
BundesfinanzamtsnummerformstringYesThe four-digit federal tax office number of the receiving tax office.
DatenLieferantformDatenLieferantYesNatural person who operates the software or on whose behalf the software is operated in order to transfer the tax data.
ErstellungsdatumformDateTime?YesDate of creation.
BeraterformBeraterNoThe tax adviser who processes and submits the tax case.
MandantformMandantNoThe client for which the tax case is being processed.
UnternehmerformUnternehmerNoThe natural or legal person who processes and submits the tax case.
EOPformEOP2022NoThe association to the ELSTER Online Portal (EOP). This is only applicable for years of assessment starting from 2022.
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.
DatenLieferant Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesDer Name des Datenlieferants.
StrasseformstringYesDer Straßenname des Datenlieferants.
PLZformstringYesDie Postleitzahl des Datenlieferants.
OrtformstringYesDer Ort des Datenlieferants.
TelefonformstringNoDie Telefonnummer (optional) des Datenlieferants.
EmailformstringNoDie Email-Adresse (optional) des Datenlieferant.
Berater Parameters:
NameParameterData TypeRequiredDescription
BezeichnungformstringNoDer Bezeichnung (optional) des Beraters (normalerweise der Name des Beraters Unternehmen).
NameformstringNoDer Name (optional) des Beraters.
VornameformstringNoDer Vorname (optional) des Beraters.
NamensvorsatzformstringNoDer Namenvorsatz (optional) des Beraters.
NamenszusatzformstringNoDer Namenzusatz (optional) des Beraters.
StrformstringNoDer Straßenname (optional) des Beraters.
HausnummerformstringNoDie Hausnummer (optional) des Beraters.
HNrZusatzformstringNoDer Hausnummernzusatz (optional) des Beraters.
AnschriftenZusatzformstringNoDer Anschriftenzusatz (optional) des Beraters.
OrtformstringNoDer Ort (optional) des Beraters.
PLZformstringNoDie Postleitzahl (optional) des Beraters.
AuslandsPLZformstringNoDie Auslandspostleitzahl (optional) des Beraters.
LandformstringNoDer Ländername (falls Anschrift im Ausland) des Beraters - optional. Der Ländername des Beraters kann mit 1-20 alphanumerischen Zeichen geliefert werden.
PostfachOrtformstringNoDer Ort des Postfaches (optional) des Beraters.
PostfachformstringNoDas Postfach (optional) des Beraters.
PostfachPLZformstringNoDie Postleitzahl (optional) des Beraters.
GKPLZformstringNoDie Großkundenpostleitzahl (optional) des Beraters.
TelefonformstringNoDie Telefonnummer (optional) des Beraters.
EmailformstringNoDie Emailadresse (optional) des Beraters.
Mandant Parameters:
NameParameterData TypeRequiredDescription
NameformstringNoDer Name (optional) des Mandanten.
VornameformstringNoDer Vorname (optional) des Mandanten.
MandantenNrformstringNoDie Mandantennummer (optional) des Mandanten.
BearbeiterkennzeichenformstringNoDas Bearbeiterkennzeichen (optional) des Mandanten.
Unternehmer Parameters:
NameParameterData TypeRequiredDescription
BezeichnungformstringNoDer Bezeichnung (optional) des Unternehmers (normalerweise der Name des Unternehmers Unternehmen).
NameformstringNoDer Name (optional) des Unternehmers.
VornameformstringNoDer Vorname (optional) des Unternehmers.
NamensvorsatzformstringNoDer Namenvorsatz (optional) des Unternehmers.
NamenszusatzformstringNoDer Namenzusatz (optional) des Unternehmers.
StrformstringNoDer Straßenname (optional) des Unternehmers.
HausnummerformstringNoDie Hausnummer (optional) des Unternehmers.
HNrZusatzformstringNoDer Hausnummernzusatz (optional) des Unternehmers.
AnschriftenZusatzformstringNoDer Anschriftenzusatz (optional) des Unternehmers.
OrtformstringNoDer Ort (optional) des Unternehmers.
PLZformstringNoDie Postleitzahl (optional) des Unternehmers.
AuslandsPLZformstringNoDie Auslandspostleitzahl (optional) des Unternehmers.
LandformstringNoDer Ländername (falls Anschrift im Ausland) des Unternehmers - optional. Der Ländername des Unternehmers kann mit 1-20 alphanumerischen Zeichen geliefert werden.
PostfachOrtformstringNoDer Ort des Postfaches (optional) des Unternehmers.
PostfachformstringNoDas Postfach (optional) des Unternehmers.
PostfachPLZformstringNoDie Postleitzahl (optional) des Unternehmers.
GKPLZformstringNoDie Großkundenpostleitzahl (optional) des Unternehmers.
TelefonformstringNoDie Telefonnummer (optional) des Unternehmers.
EmailformstringNoDie Emailadresse (optional) des Unternehmers.
EOP2022 Parameters:
NameParameterData TypeRequiredDescription
TransferausgabeformstringNo
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 .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 /CreateUstVaXmlFromDefinitionAsync HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateUstVaXmlFromDefinitionAsync 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>
  <StagingEnabled>false</StagingEnabled>
  <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>
  <Berater>
    <Bezeichnung>String</Bezeichnung>
    <Name>String</Name>
    <Namensvorsatz>String</Namensvorsatz>
    <Namenszusatz>String</Namenszusatz>
    <Str>String</Str>
    <Hausnummer>String</Hausnummer>
    <HNrZusatz>String</HNrZusatz>
    <AnschriftenZusatz>String</AnschriftenZusatz>
    <Ort>String</Ort>
    <PLZ>String</PLZ>
    <AuslandsPLZ>String</AuslandsPLZ>
    <Land>String</Land>
    <PostfachOrt>String</PostfachOrt>
    <Postfach>String</Postfach>
    <PostfachPLZ>String</PostfachPLZ>
    <GKPLZ>String</GKPLZ>
    <Telefon>String</Telefon>
    <Email>String</Email>
  </Berater>
  <Bundesfinanzamtsnummer>String</Bundesfinanzamtsnummer>
  <DatenLieferant>
    <Name>String</Name>
    <Strasse>String</Strasse>
    <PLZ>String</PLZ>
    <Ort>String</Ort>
    <Telefon>String</Telefon>
    <Email>String</Email>
  </DatenLieferant>
  <EOP>
    <Transferausgabe>String</Transferausgabe>
  </EOP>
  <Erstellungsdatum>0001-01-01T00:00:00</Erstellungsdatum>
  <Mandant>
    <Name>String</Name>
    <Vorname>String</Vorname>
    <MandantenNr>String</MandantenNr>
    <Bearbeiterkennzeichen>String</Bearbeiterkennzeichen>
  </Mandant>
  <Unternehmer>
    <Bezeichnung>String</Bezeichnung>
    <Name>String</Name>
    <Namensvorsatz>String</Namensvorsatz>
    <Namenszusatz>String</Namenszusatz>
    <Str>String</Str>
    <Hausnummer>String</Hausnummer>
    <HNrZusatz>String</HNrZusatz>
    <AnschriftenZusatz>String</AnschriftenZusatz>
    <Ort>String</Ort>
    <PLZ>String</PLZ>
    <AuslandsPLZ>String</AuslandsPLZ>
    <Land>String</Land>
    <PostfachOrt>String</PostfachOrt>
    <Postfach>String</Postfach>
    <PostfachPLZ>String</PostfachPLZ>
    <GKPLZ>String</GKPLZ>
    <Telefon>String</Telefon>
    <Email>String</Email>
  </Unternehmer>
</CreateUstVaXmlFromDefinitionAsync>
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.Umsatzsteuer.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>