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.
Nr | Feld | Typ | Max.Länge | Bemerkung
|
---|
1 | Satzart | C | | Festwert INVOICE_GET
| 2 | Rechnungsnummer | I | 8 | Optional. Falls angegeben wird nur die angegebene Rechnung zurückgegeben.
| 3 | Firma Nr | I | 8 | Interne Nummer der Firma, wie unter Verwaltung → Firma anzeigen und ändern
| 4 | Kunde Nr | I | 8 | Optional.
| 5 | Rechnungsdatum Von | D | 8 | Optional.
| 6 | Rechnungsdatum Bis | D | 8 | Optional.
| 7 | Nur ausgegebene | I | 8 | 1 = Es werden nur Rechnungen zurück gegeben, welche nach dem Anlegen oder Ändern schon gedruckt oder gesendet wurden.
| 8 | Rückgabe-Format | C | 20 | 0 oder nicht angegeben = CSV-Datei, 1 = ZIP-Datei mit den Rechnungen im PDF-Format und einer CSV-Datei result.csv.
| 9 | Nur geänderte | I | 8 | 1 = 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.
| 10 | Systemname | C | 20 | Name des externen Systems. Unter diesem Namen wird Datum und Uhrzeit der letzten Abfrage in Collmex gespeichert.
| 11 | Nur vom System angelegte | I | 8 | 1 = 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.
| 12 | Briefpapier nicht verwenden | I | 8 | 1 = Bei der Erzeugung der PDF-Dateien wird kein Briefpapier eingebunden.
| 13 | Ausgabe erforderlich | I | 8 | 1 = Es werden nur Rechnungen zurück gegeben, die noch nicht ausgegeben wurden oder nach der letzten Ausgabe geändert wurden.
| 14 | Kundenauftrag Nr | I | 8 | Optional. Nummer des Kundenauftrags, auf den sich die Rechnung bezieht.
| 15 | Produktnummer | C | 20 | Optional. Es werden nur Rechnungen zurück gegeben, für die die angegebene Produktnummer in mindestens einer Position vorkommt.
|
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
|