Collmex API: Rechnungen abfragen

Die Abfrage von Rechnungen erfolgt über die Satzart INVOICE_GET. Die Abfrage ist insbesondere dafür gedacht, die Rechnungen den Kunden über einen externen Kundenbereich zugänglich zu machen oder die Rechnungen in einem eigenen Format an den Kunden zu übermitteln. Dazu werden die neu angelegten oder geänderten Rechnungen periodisch (z.B. einmal am Tag) abgefragt und extern weiter verarbeitet.

NrFeldTypMax.LängeBemerkung
1SatzartC Festwert INVOICE_GET
2RechnungsnummerI8Optional. Falls angegeben wird nur die angegebene Rechnung zurückgegeben.
3Firma NrI8Interne Nummer der Firma, wie unter Verwaltung → Firma anzeigen und ändern
4Kunde NrI8Optional.
5Rechnungsdatum VonD8Optional.
6Rechnungsdatum BisD8Optional.
7Nur ausgegebeneI81 = Es werden nur Rechnungen zurück gegeben, welche nach dem Anlegen oder Ändern schon gedruckt oder gesendet wurden.
8Rückgabe-FormatC200 oder nicht angegeben = CSV-Datei, 1 = ZIP-Datei mit den Rechnungen im PDF-Format und einer CSV-Datei result.csv.
9Nur geänderteI81 = Es werden nur Rechnungen zurückgegeben, die sich seit der letzten INVOICE_GET-Abfrage des im nächsten Feld angegebenen Systems geändert haben oder neu angelegt wurden.
10SystemnameC20Name des externen Systems. Unter diesem Namen wird Datum und Uhrzeit der letzten Abfrage in Collmex gespeichert.
11Nur vom System angelegteI81 = Es werden nur Rechnungen zurückgegeben, die vom im Feld 10 angegebenen System angelegt wurden. Beim Anlegen der Rechnung muss der Systemname im Feld 45 der Satzart CMXINV angegeben worden sein.
12Briefpapier nicht verwendenI81 = Bei der Erzeugung der PDF-Dateien wird kein Briefpapier eingebunden.
13Ausgabe erforderlichI81 = Es werden nur Rechnungen zurück gegeben, die noch nicht ausgegeben wurden oder nach der letzten Ausgabe geändert wurden.

Das Ergebnis der Abfrage ist für jede Rechnung ein Satz der Satzart CMXINV. Falls als Rückgabe-Format '1' gewählt wurde, gibt Collmex eine ZIP-Datei zurück. In dieser ZIP-Datei ist jede Rechnung im PDF-Format enthalten. Der Dateiname ist 'InvoiceXXXX.pdf', wobei XXXX die Rechnungsnummer ist. In der ZIP-Datei sind zusätzlich die Rechnungen in der CSV-Datei result.csv im Format CMXINV enthalten.

Siehe auch: Collmex API Inhalt