Rechnung anlegen
POST- /api/salesorder/create
Aufruf
Beim Anlegen von Einträgen werden Felder die nicht übergeben werden mit Standard Werten belegt.
Beim Editieren von Einträgen werden nicht übergebene Felder auch nicht verändert. Ein Feld gilt als nicht übergeben wenn diese nicht innerhalb des Objekts übertragen wurde.
{
"api_version": 1,
"systemno": 4711, // Kassennummer oder ähnliches bei Fremdsystemen
"operatorno": 789, // Kassierer/Verkäufer/Bediener
"systemtype": "POSMAN",
"processno": 125, // Belegnummer oder ähnliches
"datetime": "2017-04-12T23:20:50+0100", // Format nach ISO 8601
"data": {
"kunden": {%KundenObjekt%},
"rechnung": {%RechnungsObjekt%},
"rechnung_position": [{%RechnungPosition%},{%RechnungPosition%}],
"zahlung": [{%Zahlung%},{%Zahlung%}]
}
}
Antwort
In der Antwort werden alle übergebenen Objekte mit den gespeicherten Daten zurückgegeben.
Diese Objekte enthalten dann auch die vom System gesetzten Informationen. (z.B. Rechnungsnummer, Kundennummer etc.)
{
"api_version": 1,
"success": true,
"msg": "Erfolg: Die Rechnung konnte erfolgreich gespeichert werden",
"warning": "",
"data": {
"kunden": {%KundenObjekt%},
"rechnung": {%RechnungsObjekt%},
"rechnung_position": [{%RechnungPosition%},{%RechnungPosition%}],
"zahlung": [{%Zahlung%},{%Zahlung%}]
}
}
Allgemeine Struktur des Objekts Kunden
Mithilfe der Übergabe des KundenObjekts, kann der Rechnung(SalesInvoice) ein Kunde zugeordnet werden der noch nicht im System existieren muss. Falls der Kunde schon in der Datenbank existiert, reicht es die Kundennummer innerhalb des Objekts der Rechnung mit zu übergeben. In diesem Fall kann das Kunden Objekt leer bleiben.
Dieser Kunde wird dann mit den übergebenen Informationen angelegt. Felder die nicht mit übergeben werden, werden mit Default Werten gefüllt. Wenn keine Kundennummer(kdnr) mit übergeben wird, wird diese automatisch vom System gesetzt.
Bei jeder Speicherung wird geprüft ob die angegebene Kundennummer(kdnr) oder externe Kundennummer (kdnr3) schon im System vorhanden ist.
Wenn dies der Fall ist, wird der Kunde nicht neu angelegt sondern der bereits im System vorhandene Kunde wird erweitert bzw. editiert. Felder die in solch einen Fall nicht mit übergeben werden, bleiben unverändert.
Allgemeine Struktur des Objekts Rechnung
Mit dem Objekt der Rechnung kann eine neue Rechnung angelegt werden. Hierbei ist zu beachten, dass wenn die Rechnungsnummer(nr) nicht mit übergeben wird, diese vom System generiert wird.
Falls eine externe Alphanumerische Nummer gespeichert werden soll, kann dies mithilfe der alphanr geschehen.
Wenn die Alphanumerische Nummer(alphanr) oder die Rechnungsnummer(nr) bereits im System vorhanden sind, wird die Rechnung nicht gespeichert und eine Fehlermeldung ausgegeben.
Mit der Spalte Typ kann angegeben werden ob es sich um eine Rechnung(0) oder eine Storno-Rechnung(1) handelt
Je nach Flag des Aufrufs und Status der Rechnung werden noch weitere Operationen durchgeführt.
- offen = 0
- Keine weitere Operation. Die Rechnung kann im System weiter bearbeitet werden
- verbucht = 1
- Erstellung von Umsatz Einträgen
- teilbezahlt = 2
- Erstellung von Umsatz Einträgen
- bezahlt = 3
- Erstellung von Umsatz Einträgen
Falls die Rechnung nicht mehr an die Fibu geschickt werden muss/darf, muss das Feld fibuexport auf 1 gesetzt werden.
{
"nr": 0,
"kasse": 0,
"kdnr": "10002",
"kommentar": "",
"datum": "20160222151429",
"betrag": 14495,
"obetrag": 14495,
"alphanr": "RE20170005",
"status": 0,
"typ": 0,
"vknr": 4,
"origbetrag": 14495,
"bereich": 0,
"aunr": 9000008,
"faellig": "00000000000000",
"filiale": 5,
"rundung": 0,
"refrenr": 0,
"lieferweg": 0,
"fakturierung": "00000000000000",
"zziel": 0,
"zahlungfaellig": "00000000000000",
"mwstberechnung": 0,
"fibuexport": 0
}
Allgemeine Struktur des Objekts RechnungPosition
Das Objekt RechnungPosition kann mehrmals übergeben werden. Dabei ist zu beachten das die Rechnungsnummer(renr) entweder leer sein muss oder mit der der Rechnung übereinstimmen muss.
Je nach Status werden hier weitere Operationen durchgeführt.
- offen = 0
- Keine weitere Operation. Die Rechnung kann im System weiter bearbeitet werden
- verbucht = 1
- Erstellung von Bestands Buchungen + Beweg
Bei nicht plausiblen Status oder Rechnungsnummern (z.B. Rechnungsstatus = 0 und RechnungPosition = 1) wird die RechnungsPosition nicht gespeichert und ein Fehler zurückgegeben.
Wenn kein Status mit übergeben wird, wird der Status aus dem Objekt der Rechnung übernommen.
- (Die RechnungStatus teilbezahlt und bezahlt werden in diesem Fall innerhalb der Position zum Status verbucht)
Felder die nicht übergeben werden, werden ggf. mit den Daten aus dem Artikel abgeglichen.
- Dieses Verhalten gilt nicht für PreisFelder(preis, opreis, nettopreis, opreisnetto) oder RabattFelder(rabattnetto, rabatt, rabattproz)
Allgemeine Struktur des Objekts Zahlung
Das Objekt Zahlung kann mehrmals übergeben werden. Dabei ist zu beachten das die Rechnungsnummer(renr) entweder leer sein muss oder mit der der Rechnung übereinstimmen muss. Außerdem muss hier auch die Kundennummer(kdnr) entweder leer sein oder mit dem Kunden übereinstimmen.
Bei abweichender Rechnungsnummer oder abweichender Kundennummer wird die Zahlung nicht gespeichert und ein Fehler zurückgegeben.
Bei der Übergabe der Zahlung sollte außerdem eine externe Zahlungsreferenz(zahlungsref) mit übergeben werden, da ansonsten doppelte Verbuchungen von Zahlungen nicht verhindert werden kann.
Bei der Speicherung wird geprüft ob die externe Zahlungsreferenz bereits vorhanden ist. Falls dies der Fall ist wird eine entsprechende Fehlermeldung zurück gegeben und die Zahlung nicht gespeichert.
Falls die Zahlung nicht mehr an die Fibu geschickt werden muss/darf, muss das Feld fibuexport auf 1 gesetzt werden.