7. Inhaltlicher Aufbau der Schnittstellen

Die Schnittstellen der Cloud API bestehen aus Entitäten, die im Json Format abgebildet werden. Für jeden Anwendungsfall ist eine eigene Kombination dieser Entitäten einzusetzen. Die einzige zulässige Zeichenkodierung ist UTF-8.

Diese Datenstrukturen werden im Folgenden beschrieben und den verschiedenen Requesttypen zugeordnet. Alle Entitäten werden als Collections übertragen (siehe Beispiel in Kapitel 6). Es ist prinzipiell möglich, mehrere Entitäten desselben Typs in einem Job zu versenden. Alle Felder werden als Zeichenkette übergeben. Im Bemerkungsfeld der Tabelle werden ggf. besondere Formatierungen der jeweiligen Zeichenkette aufgeführt.


Beschreibung der Feld-Typen

Feld-Typ

Json-Typ

Json Null-Wert*

Json-Beispiel

Kommentar

String

string

null

"Beispiel Text"

Einzeiliger Text

Text

string

null

"Das ist ein\nText mit Zeilenumbruch."

Mehrzeiliger Fließtext. "\n" markiert einen Zeilenumbruch.

StringArray

array

null

[ "Text1", "Text2" ]


DictionaryObject

object

null

{ "key1": "Text1", "key2", "Text2" }


Object

object

null

{ ... }


Date

string

null

"2021-09-01"

ISO-8601 Spezifikation (JJJJ-MM-TT)

Year

string

null

2021

Format JJJJ

Guid

string

null

"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"

GUIDs werden im 8-4-4-4-12 Format angegeben und erwartet (36 Buchstaben (A–F|a-f)/Ziffern (0–9)/Bindestriche)

GuidArray

array

null

[ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ]


Countrycode

string

null

"DE"

Ländercodes werden gemäß ISO 3166-1 Alpha-2 angegeben: XX

Decimal

string

null

"1234"

"1234,56"

"-1234,567"

Dezimalzeichen: Komma

mit beliebig vielen Nachkommastellen (wenn nicht anders definiert)

Ganzzahlen sind erlaubt

ObjectArray

array

null

[{ ... }, { ... }, { ... }]


StringArrayAsString

string

null

"[seniorengerecht, barrierefrei]"

Kommasepariertes String-Array

Boolean

string

null

"true" or "false"

Bitte beachten, dass es sich hierbei um eine Zeichenkette "true" bzw. "false" handelt und nicht den Json Datentyp boolean.

Integer

string

null

"1234"

"-12345"


SquareMeter

string

null

"950"

"950,52"

"950,521"

mit beliebig vielen Nachkommastellen (wenn nicht anders definiert)

Ganzzahlen sind erlaubt

Meter

string

null

"1234"

"1234,45"

"12345,678"

mit beliebig vielen Nachkommastellen (wenn nicht anders definiert)

Ganzzahlen sind erlaubt

StringEnumeration

string

null

"Bedarfsausweis"

Wert aus einer festgelegten Enumeration z.B.

nicht vorhanden,

Verbrauchsausweis

Bedarfsausweis

Money

string

null

"1234"

"1234,21"

"-1234,21"

Geldbetrag in Euro

Ganzzahlen sind erlaubt

*Sind Json-Properties im Json-Dokument nicht vorhanden, ist das gleichbedeutend als ob die Properties mit einem Null-Wert im Dokument vorhanden sind.



WowiResponses

Im Folgenden sind zudem WowiRespones, welche für alle Requesttypen verwendet werden, aufgelistet:

Fehlercode

Fehlermeldung

Ursache/Behebung

WowiResponseErrorCodes

20000

"Verarbeitung erfolgreich"

Import und Verarbeitung der übermittelten Daten waren erfolgreich.

20001

"Keine Änderung enthalten."

Die übermittelten Daten entsprechen dem aktuellen Datenstand. Es wurden keine Änderungen vorgenommen.

40001

"Die Daten sind nicht konsistent"

Die übermittelten Daten konnten zwar gelesen werden, sind aber inkonsistent, so dass sie nicht importiert werden können.

40002

"Validierungsfehler"

Siehe Fehlercodes unter "Validierungsmeldungen Rechnungseingang (RechnungStaticProperty.cls)"

50000

"Die Daten konnten nicht gelesen werden"

Die übermittelten Daten konnten nicht gelesen werden, weil sie falsch aufgebaut sind. Mögliche Gründe können z. B. beim Rechnungsdatenrequest mehrere oder fehlende Rechnungsköpfe zu einer Rechnung sein; beim Kontaktdaten-Request mehrere oder fehlende Adressen ...

Allgemeine Validierungsmeldungen zu fehlenden Stammdaten

50001

"Das Unternehmen ist nicht vorhanden."

Zum UniqueEntityIdentifierUnternehmen konnten weder Mandant noch Unternehmen ermittelt werden.

50021

"Die Bankverbindung des Mandanten ist nicht vorhanden.

Zum UniqueEntityIdentifierBankKontoMandant konnte keine Bankverbindung ermittelt werden.

50202

"Der Kreditor ist nicht vorhanden."

Zum UniqueEntityIdentifierKreditor konnte kein Kreditor ermittelt werden.

50222

"Die Bankverbindung des Kreditors ist nicht vorhanden."

Zum UniqueEntityIdentifierBankKontoKreditor konnte keine Bankverbindung zum Kreditor ermittelt werden.

50241

"Das Bankkonto ist nicht vorhanden."

Zum UniqueEntityIdentifierSachkonto konnte kein Sachkonto ermittelt werden.

50302

"Der Benutzer ist nicht vorhanden."

Zum UniqueEntityIdentifierBenutzer konnte kein Benutzer in wowinex ermittelt werden.

55062

"Der Gewerkeschlüssel ist nicht vorhanden."

Zum UniqueEntityIdentifierGewerk konnte kein Gewerkeschlüssel ermittelt werden.

55129

"Die Wirtschaftseinheit ist nicht vorhanden."

Zum UniqueEntityIdentifierWirtschaftseinheit konnte keine Wirtschaftseinheit in wowinex ermittelt werden.

55130

"Das Haus ist nicht vorhanden."

Zum UniqueEntityIdentifierHaus konnte kein Haus in wowinex ermittelt werden.

55131

"Die Nutzungseinheit ist nicht vorhanden."

Zum UniqueEntityIdentifierNutzungseinheit konnte keine Nutzungseinheit in wowinex ermittelt werden.

55132

"Der Nutzer ist nicht vorhanden."

Zum UniqueEntityIdentifierNutzer konnte kein Nutzer in wowinex ermittelt werden.

55202

"Die Abschreibungsart ist nicht vorhanden."

Zum UniqueEntityIdentifierAbschreibungsart konnte keine Abschreibungsart in wowinex ermittelt werden.

55222

"Die Kostenstelle ist nicht vorhanden."

Zum UniqueEntityIdentifierKostenstelle konnte keine Kostenstelle in wowinex ermittelt werden.

55261

"Das Anlagegut Mobilien ist nicht vorhanden."

Zum UniqueEntityIdentifierAnlagegut konnte kein Anlagegut in den Mobilien in wowinex ermittelt werden.

55289

"Der Bewegungsschlüssel für das Anlagevermögen ist nicht vorhanden."

Zum UniqueEntityIdentifierBewegungsschluessel konnte kein Bewegungsschlüssel für die Anlagenbuchhaltung in wowinex ermittelt werden.

Allgemeine Validierungsmeldungen

59001

"Die Entität ist in wowinex nicht vorhanden."

Zum UniqueEntityIdentifier konnte keine entsprechende Entität ermittelt werden.

59002

"Datentyp nicht kompatibel."

Der übertragene String entspricht nicht dem in wowinex erwarteten Datentyp und kann nicht umgewandelt werden.

59020

"Ungültiges Format des Feldes <Feldname>."


59021

"Ungültiges Format der Email."

erwarteter Aufbau: Benutzername@-SymbolDomain

  1. Das @-Symbol muss enthalten sein. Es trennt den Benutzernamen von der Domain.

  2. Benutzername vor dem @-Symbol. Kann aus Buchstaben (a-z, A-Z), Zahlen (0-9) und bestimmten Sonderzeichen wie Punkt (.), Unterstrich (_) und Bindestrich (-) bestehen. Darf nicht mit einem Sonderzeichen beginnen oder enden und darf keine aufeinanderfolgende Sonderzeichen enthalten.

  3. Domain nach dem @-Symbol. Besteht aus dem Domainnamen und der Top-Level-Domain (TLD). Domainname: Kann aus Buchstaben, Zahlen und Bindestrichen bestehen. Darf nicht mit einem Bindestrich beginnen oder enden und darf keine aufeinanderfolgenden Bindestriche enthalten. Die TDL kann aus Buchstaben bestehen und ist mindestens 2 Zeichen lang und beginnt mit einem Punkt, z.B. .com, .org, .net

59022

"Ungültiges Format der Website."

erwarteter Aufbau einer Domain, wie z.B. www.haufe.com:

  • Top-Level-Domain: Die TDL kann aus Buchstaben bestehen und ist mindestens 2 Zeichen lang und beginnt mit einem Punkt, z.B. .com, .org, .net

  • Second-Level-Domain: Kann aus Buchstaben, Zahlen und Bindestrichen bestehen. Darf nicht mit einem Bindestrich beginnen oder enden und darf keine aufeinanderfolgenden Bindestriche an 3. und 4. Stelle enthalten. Darf maximal 63 Zeichen lang sein.

  • Third-Level-Domain: Kann, aber muss nicht zwingend angegeben werden. Kann aus Buchstaben, Zahlen und Bindestrichen bestehen. Darf nicht mit einem Bindestrich beginnen oder enden und darf keine aufeinanderfolgenden Bindestriche an 3. und 4. Stelle enthalten. Darf maximal 63 Zeichen lang sein.

59023

"Ungültiges Format der Ländervorwahl."

Eine Ländervorwahl muss mit "+" oder "00" beginnen, ansonsten nur aus Zahlen und insgesamt höchstens 5 Zeichen bestehen.

59024

"Ungültiges Format der Vorwahl."

Eine Vorwahl darf nur numerische Zeichen enthalten.

59025

"Ungültiges Format der Rufnummer."

Eine Telefon-/Faxnummer darf nur numerische Zeichen enthalten.

59998

"Verarbeitung abgelehnt."

Die Übernahme der Daten wurde manuell abgelehnt.

59999

"Es ist ein undefinierter Validierungsfehler aufgetreten."

Zu diesem Fehler konnte kein bekannter Fehlercode ermittelt werden.