Invoice

Funktion

Zur Übermittlung einer Einzelrechnung oder auch Sammelrechnung. Siehe hierzu Sammelrechnung.

Beispiele

NachrichtentypFormatVersionLink
Invoice (Einfach)CSV5Invoice_969_38.csv
Invoice (Einfach)XML4Invoice_1375_791.xml
Invoice (Sammelrechnung)CSV4Invoice_1012_324.csv
Invoice (Sammelrechnung)XML4Sammelrechnung_Invoice_1254_656.xml

Beschreibung

 Nachrichtenkopf - Häufigkeit: 1

Nachrichtenkopf

Der Kopf einer Nachricht setzt sich immer aus folgenden Feldern zusammen:

#

Feld

XML-Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

1

Nachrichtentyp

Type

M

alph

30

Kennung/Bezeichnung des Typs der Nachricht. Die einzelnen Typen werden im Folgenden vorgestellt.

2

Version des Typs

Version

M

int

 

Kennung der Version des Nachrichtentyps bzw. des Formats
Aktuelle Version: 3

3

Datum & Uhrzeit

Date

M

dt

 

Datum und Uhrzeit der Erstellung der Nachricht

4

Sender

SenderId

M

alph

50

Kennung des Senders

5

Empfänger

ReceiverId

M

alph

50

Kennung des Empfängers

6

Kennung der Transaktion

TransactionId

K

alph

32

siehe folgender Abschnitt „Transaktionen".
Leer bei nicht Verwendung des Transaktionsprotokolls.

7

Kennung der Nachricht

MessageId

M

alph

32

Fortlaufende Nummer um die Nachricht eindeutig zu identizieren.
siehe folgender Abschnitt „Transaktionen"

8

Sequenznummer des Senders der Nachricht

SequenceNrSender

K

int

 

Fortlaufende Zahl, die sicherstellt, dass ankommende Nachrichten in der richtigen Reihenfolge abgearbeitet werden

9

Sequenznummer des Empfängers der Nachricht

SequenceNrReceiver

K

int

 

Fortlaufende Zahl, die sicherstellt, dass ankommende Nachrichten in der richtigen Reihenfolge abgearbeitet werden

10

Timeout

Timeout

K

int

 

Zeit in Minuten, in der der Sender eine Antwort erwartet. Kein Timeout (unendliches Warten) wird durch den Wert 0 (null) ausgedrückt.

11

Nachrichtenlänge

NumberOfLines

M

int

10

Anzahl der Zeilen der Nachricht , inkl. Der ersten Zeile. Dieser Wert dient zur Überprüfung, ob die Nachricht komplett übertragen wurde.


Mit der Version 2.2 der Schnittstelle wird das Feld „Version" genutzt. Alle bisherigen Schnittstellenversionen hatten hier den Wert „1". Ab der aktuellen Version wird der Wert mit jeder Version hochgezählt. Alle Satzarten und Felder die aktuell keine Versionsangabe besitzen, müssen unterstützt werden. Alle Felder und Satzarten die eine Angabe besitzen, müssen erst ab der angegebenen Version unterstützt werden.
Die Werte für die Felder „Kennung des Senders" und „Kennung des Empfängers" müssen im Vorfeld festgelegt werden. Durch sie werden konkrete Instanzen eines ordermanager und einer Warenwirtschaft eindeutig identifizert.
Die „Kennung der Nachricht" sollte, wenn möglich, mit einer fortlaufenden Nummern gefüllt werden. Wird auf das Transaktionsprotokoll verzichtet, so müssen die Felder „Kennung der Transaktion" sowie beide Sequenznrn Felder leer bleiben. Ab der Version 2.4 wird der Einsatz des Transaktionsprotokolls nicht mehr empfohlen.

 Bestellung – Identifikation - Häufigkeit: 1

Diese Satzart enthält Informationen, um die Bestellung, zu der die Nachricht gehört, eindeutig zu identifizieren.
#

Feld

XML Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

1

Id

Id

M/K*1

alph

30

ordermanager–interne Id der Bestellung

2

Auftragsnr.

VendorOrderCode

M/K

alph

30

Wawi-interne Auftragsnummer

Die Wawi-interne Auftragsnummer muss in der ersten Rückmeldung der Warenwirtschaft an ordermanager nach der Meldung „PurchaseOrderSubmit" übermittelt werden und ist ab dann zusammen mit der ordermanager-internen Id in jeder Nachricht enthalten.
*1 Angabe ist nicht erforderlich bei Nachrichten vom Typ „PurchaseOrderCreate".

 

 Rechnung - Kopf - Häufigkeit: 1

#

Feld

XML Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

Version
1

Rechnungsdatum

Date

M

date

 

Datum der Rechnung

 
2

Rechnungsnummer

InvoiceNumber

M

alph

30

Wawi-interne Nummer der Rechnung

 
3

Wawi-interne Auftragsnummer

VendorOrderCode

K

alph

30

Nummer des Auftrags in der Wawi, auf den sich diese Rechnung bezieht

 
4

Währung

Currency

M

alph

3

Kurzzeichen für Währung der Rechnung nach ISO-4217:1995; zunächst immer „EUR"

 
5

Netto-Betrag

TotalNet

M

dez

 

Netto-Betrag der Rechnung

 
6

MwSt-Betrag

TotalVatAmount

M

dez

 

Betrag der Mehrwertsteuer

 
7

letzte Rechnung

LastInvoice

M

bool

 

Ja, wenn die Bestellung/der Auftrag mit dieser Rechnung vollständig berechnet worden ist

 
8

Kundennr.

CustomerId

M

alph

30

Wawi-interne Nummer des Kunden

2

 Rechnung - Rechnungsadresse - Häufigkeit: 1

Das Format der Rechnungsadresse entspricht dem Format der Rechnungsadresse der Bestellung.
Hinweis: Das es sich aber trotzdem um eine andere Satzart handelt, wird die Rechnungsadresse in einer Nachricht vom Typ „Invoice" auch durch ein eigenes Kürzel für die Satzart gekennzeichnet (siehe Tabelle im letzten Abschnitt).

 Rechnung - Position - Häufigkeit: 1..*

#

Feld

XML Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

Version
1

Positionsnr.

LineNumber

M

int

 

laufende Nummer der Rechungsposition beginnend bei 1

 
2

Positionskennung

LineIdentifier

M

int

 

eindeutige Kennung der Position im ordermanager, auf die sich diese Rechungsposition bezieht. Ist keine Zuordnung zur Bestellposition möglich, so muss „0" eingetragen werden.

 
3

Artikelnummer

ArticleId

K

alph

30

Wawi-interne Artikelnummer

 
4

EAN

EAN

K

EAN

14

EAN des Artikels

 
5

Artikelbezeichnung

ArticleName

K

alph

200

Bezeichnung des Artikels in der Wawi oder im ordermanager 

 
6

Text

Text

K

alph

200

Kommentar zu Position oder Textposition

 
7

Menge

Quantity

M

dez

 

Menge

 
8

Einheit

Unit

M

alph

100

Mengeneinheit, auf die sich die Mengenangabe bezieht (z.B. Stück)

 
9

Netto-Preis

PriceNetPerUnit

M

dez

 

Netto-Einzelpreis einer Mengeneinheit

 
10

Netto-Zeilensumme

LineTotalNet

M

dez

 

Gesamtbetrag der Zeile netto inkl. Rabatte und Zuschläge

 
11

Mwst.-Satz

VatPercent

M

dez

 

Mehrwertsteuersatz in Prozent

 
12

MwSt-Betrag

VatAmount

M

dez

 

Betrag der Mehrwertsteuer

 
13

Unece Einheit

UneceUnit

K

alph

3

Einheit, auf die sich die Mengenangabe bezieht, als Unece-Code

2
14

Unece Einheit Menge

UneceUnitQuantity

K

dez

 

Anzahl der Unece Einheiten, auf die sich die Mengenangabe bezieht

2

Alle Beträge werden mit positivem Vorzeichen angegeben (wie bei der Bestellung).

 Rechnung - Fußzeile - Häufigkeit: 0..*

Die Satzart Fußzeile enthält Angaben zu Zu- und Abschlägen, die sich auf den Netto-Gesamtbetrag der Rechnung / Gutschrift beziehen.
#

Feld

XML Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

Version
1

Typ

Type

M

alph

30

Gibt an, um welche Art von Zu-/Abschlag es sich in dieser Zeile handelt:
„adr" Gefahrgut,
„transport" Transportkosten,
„packing" Verpackung,
„rebate" Rabatt,
„fee" sonstiger Zuschlag
„smallOrderSurcharge" Mindermengenzuschlag
"addTransport" Frachtkostenzuschlag
"transport-article" Versandkostenartikel

 
2

Beschreibung

Text

K

alph

1000

Beschreibender Text zur Zeile. Kann ggf. die Berechnungsgrundlage für den Zu-/Abschlag enthalten

 
3

Prozent

Percent

K

dez

 

Auf-/Abschlag in Prozent relativ zur Netto-Summe der Positionswerte

 
4

Netto-Betrag

AmountNet

K

dez

 

Auf-/Abschlag auf die Summe der Positionswerte

 
5

Netto-Zeilensumme

LineTotalNet

M

dez

 

Netto-Gesamt-Betrag der Zeile. Bei Wert im Feld Netto-Betrag gleich diesem Wert, sonst der berechnte Wert der Prozentangabe.
Handelt es sich um einen Abschlag wie z.b. Rabatt, so muss der Betrag mit negativem Vorzeichen angegeben werden.

 
6

MwSt-Satz

VatPercent

M

dez

 

in Prozent (z.B. „19.00")

 
7

MwSt-Betrag

VatAmount

M

dez

 

berechneter Betrag der Mehrwertsteuer.
Handelt es sich um einen Abschlag wie z.b. Rabatt, so muss der Betrag mit negativem Vorzeichen angegeben werden.

 
8

Brutto-Zeilensumme

LineTotalGross

K

Dez

 

Brutto-Zeilensumme der Bestellposition, Preis inklusive Mwst
Handelt es sich um einen Abschlag wie z.b. Rabatt, so muss der Betrag mit negativem Vorzeichen angegeben werden.

3

Hinweis: Das es sich aber trotzdem um eine andere Satzart handelt, wird die Fußzeile in einer Nachricht vom Typ „Invoice" / "CreditNotice" auch durch ein eigenes Kürzel für die Satzart gekennzeichnet (siehe Tabelle im letzten Abschnitt). 

Die Zu-/Abschläge können entweder als Prozentwert vom Netto-Gesamtbetrag oder als fixer Netto-Betrag angegeben werden. Damit darf nur entweder das Feld Prozent oder das Feld Netto-Betrag ausgefüllt werden, aber nicht beide gleichzeitig.
Die Betragsangaben bei Abschlägen, wie z.B. Rabatt, sollten mit negativem Vorzeichen angegeben werden, da sie von dem Gesamtbetrag der Rechnung / Gutschrift abgezogen werden müssen.

 Kommentar - Häufigkeit: 0..1

#

Feld

XML Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

1

Bearbeiter

Editor

M

alph

100

Der Bearbeiter, der den Kommentar erfasst hat

2

Datum/Uhrzeit

Date

M

dt

 

Der Zeitpunkt, an dem der Kommentar erfasst worden ist

3

Kommentar

Text

M

alph

200

Kommentar

In Kommentaren, die von der Warenwirtschaft an den ordermanager übertragen werden, kann als Bearbeiter auch die Benutzerkennung oder –nummer eingetragen werden, die der Sachbearbeiter beim Händler zur Anmeldung an der Warenwirtschaft verwendet. Dazu müssen aber in der Benutzerverwaltung des ordermanager  die dazugehörigen Benutzer angelegt sein und diese Kennungen oder Nummern in dem dafür vorgesehenen Feld hinterlegt

 Unterposition - Häufigkeit: 0..*

Das Format der Unterposition entspricht dem Format der Unterposition aus der Bestellung, siehe Bestellung - Unterposition.

 Belegreferenz - Häufigkeit: 0..*

Hiermit können Referenzen auf andere Belege wie Lieferschein und Bestellung übermittelt werden. Dies ist sinnvoll bei Rechnungen, die hiermit die abgerechneten Lieferscheine oder Bestellungen übermitteln können.

#

Feld

XML Attribut

Muß/
Kann

Format

max. Länge

Beschreibung

1

Zeilennummer

LineNumber

M

int

 

Zeilennummer des jeweiligen Artikels aus der Artikelposition

2

Beleg-Typ

Type

M

Alph

10

Typ „ORDR" für Referenzen zu Bestellung, „ODLN" für Lieferscheine,
"OQUT" für Angebot.

3

Beleg-Nummer

Number

K

Alph

100

Nummer des referenzierten Beleges.

4

Beleg-Datum

Date

M

date

 

Datum des referenzierten Beleges.


 Anhangreferenz - Häufigkeit: 0..*

Referenz auf einen Anhang zu einem Beleg.

Der Anhang selbst wird über einen Http-Endpoint (/api/v1/attachments) in den ordermanager hochgeladen. Die dabei erzeugte "upload_id" wird hier als Referenz übermittelt. siehe dazu Dokumentation attachments Endpoint

Die Satzart wird innerhalb der Belegnachrichten verwendet, um die Verknüpfung zwischen dem bereits hochgeladenen Anhang und dem Beleg herzustellen.

#FeldXML AttributMuß /
Kann
Formatmax.
Länge 
Beschreibung
1Upload-IDUploadIdMalph50upload_id aus Rückgabewert von Http-Endpoint /api/v1/attachments
2DateinameFilenameMalph255Dateiname des Anhanges.