Rechnungen können aus Verträgen (entweder alle oder ein bestimmter) über die REST-API (auch über die Weboberfläche) generiert werden. Es ist ein einfacher Aufruf über PUT
oder POST
:
| Generiert Rechnungen für alle Verträge |
| Erzeugt Rechnungen für Vertrag mit ID 1 |
Beim Aufruf über die REST-API lautet die Antwort (im XML-Format) wie folgt:
<?xml version="1.0"?> <winstrom version="1.0"> <operation>Rechnungserstellung</operation> <success>ok</success> <messages> <message>Anzahl der erfolgreich erzeugten Rechnungen: 1</message> </messages> <errors> <error>...</error> </errors> </winstrom>
Das Erfolgselement
kann die Werte ok
, partial
, failed
und unknown
annehmen:
| Rechnungen wurden OK generiert (es können aber auch keine Rechnungen generiert worden sein, wenn sie nicht benötigt werden) |
| Rechnungen wurden für einige Verträge problemlos erstellt, aber bei anderen Verträgen trat ein Fehler auf |
| Es wurden keine Rechnungen erstellt, aber bei einigen Verträgen trat ein Fehler auf |
| Sollte nie auftreten |
Die Message-Elemente
enthalten Erfolgsmeldungen (maximal eine), die Error-Elemente
enthalten Fehlermeldungen (eine für jeden Vertrag, der einen Fehler aufweist).