Bildintegrations-API für INVOICE

Chrome River bietet Ihnen eine API, über die Sie Bilder in Ihr internes System herunterladen können, nachdem Rechnungen exportiert wurden. Wenn Sie die Bildintegrations-API nutzen möchten, wenden Sie sich bitte an den Support von Chrome River, um den Zugang freischalten zu lassen.

Hier können Sie die Bildintegrations-API als Word-Datei herunterladen.

• HINWEIS: Damit sich die Chrome River-Image-API verbinden kann, muss die Kundenanwendung über ein Sicherheitsprotokoll von TLS 1.2 oder höher verfügen.

Wie kann ich auf den Dienst zugreifen?

environment_url (je nachdem, ob es sich um eine Abfrage auf dem PROD- oder QS-Server handelt)

• Verwenden Sie die QS- oder Produktions-URL, die vom Chrome River-Administrator Ihres Unternehmens bereitgestellt wird.

Erforderliche POST-Argumente (für jeden der unten genannten Methodenaufrufe erforderlich)

method=getInvoices

Bei dieser Methode wird eine Liste aller in einem bestimmten Zeitraum exportierten Rechnungen ausgegeben. Die Daten basieren auf den Exportdaten in Chrome River. Die meisten Benutzer greifen auf diesen Dienst nach Mitternacht für den vorangegangen Tag zu. Ihr Unternehmen entwickelt ein Programm, mit dem die Liste von Rechnungen durchlaufen wird und die getInvoiceImages-Methode für jede einzelne aufgerufen wird. Bitte beachten Sie, dass ASCII-fremde Zeichen wie Währungssymbole und weiche Trennzeichen zum aktuellen Zeitpunkt nicht vollständig unterstützt werden und bei dieser Methode Probleme verursachen können.

Erforderliche POST-Argumente

• HINWEIS: Zur Optimierung der Abfrage ist der Zeitraum auf 32 Tage begrenzt.
• HINWEIS: Es werden nur Datensätze mit einem Exportdatum innerhalb der letzten 90 Kalendertage ausgegeben. Wenn der Export der Rechnung mehr als 90 Tage zurückliegt, werden die zugehörigen XML-Daten nicht ausgegeben.

XML bei Erfolg:

<?xml version="1.0" encoding="utf-8" ?><list><com.chromeriver.servlet.InvoiceTO><invoiceID>10.000.008.475</invoiceID><invoiceNumber>3.698.602.242.029</invoiceNumber><invoiceDate>1.236.293.857.500</invoiceDate><invoiceDateString>2009-03-05 22:57:37</invoiceDateString><vendorUniqueID>12.345</vendorUniqueID><addressUniqueID>3</addressUniqueID></com.chromeriver.servlet.InvoiceTO><com.chromeriver.servlet.InvoiceTO><invoiceID>10.000.008.490</invoiceID><invoiceNumber>3.698.602.987.777</invoiceNumber><invoiceDate>1.236.293.857.500</invoiceDate><invoiceDateString>2009-03-05 22:57:37</invoiceDateString><vendorUniqueID>12.345</vendorUniqueID><addressUniqueID>3</addressUniqueID></com.chromeriver.servlet.VoucherInvoiceTO>...</list>aber<list/>

XML bei Fehler:

<?xml version="1.0" encoding="utf-8"?><com.chromeriver.ws.CrRestHeaderOutput><errorMessage> </errorMessage></com.chromeriver.ws.CrRestHeaderOutput>

Hinweise zu den Datenelementen

• invoiceID Rechnungs-ID
• invoiceNumber: Rechnungsnummer
• invoiceDate: Rechnungsdatum im Format Sekunden ab 1970
• invoiceDateString: Rechnungsdatum
• vendorUniqueID: Unique ID Lieferant
• addressUniqueID: Unique ID Lieferantenadresse

method=getInvoiceImages

Bei dieser Methode wird eine PDF-Datei mit allen Bildern und/oder PDF Reports der Rechnungen zurückgesandt, die mit einer Rechnung verknüpft sind. Jedes Mal, wenn Sie diese Methode anwenden, wird eine einzelne PDF-Datei erstellt, die nach der Rechnungs-ID benannt ist. PDF Reports werden an die Bilddatei angehängt.

Erforderliche POST-Argumente

Optionale POST-Argumente

Ausgaben

• Ist der Vorgang erfolgreich, gibt die API die konsolidierte Bild- und/oder PDF-Datei aus.
• Sollten Fehler auftreten, gibt die API eine XML-Datei mit Fehlerangaben aus.

HINWEIS: Es gibt keine Datumsgrenze für diesen Methodenaufruf.

Weitere Hinweise zur Entscheidungsfindung und zu ausgegebenen Nachrichten

• Wenn keine Rechnung für die angegebene Rechnungs-ID vorliegt, lautet die Nachricht: „Für diese Anfrage liegt kein Rechnungsdatensatz vor“.
• Wenn sowohl die PDF- als auch die JPG-Bilddateien vorliegen, werden die JPGs abgerufen. Wenn keine JPG-Dateien vorliegen, wird die PDF-Datei abgerufen.
• Wenn Sie „getPDFReport“ auswählen, wird zuerst das Original-PDF abgerufen, sofern es vorliegt.
• Wenn sich keine Bilder im Anhang der Rechnung befinden, lautet die Nachricht: „Es sind keine Bilder mit dieser Rechnung verknüpft“.

• INVOICE Image Integration APIs.pdf200 kB