Bildintegrations-API für EXPENSE

REST Expense Image API

Die unten aufgeführte SOAP Expense Image API wird letztendlich durch die REST Expense Image REST API ersetzt.

Zu den Vorteilen der REST-Version der API gehören eine verbesserte Leistung und standardisierte Zugriffskontrollen. Darüber hinaus stimmt das Format der über die API verfügbaren PDF-Dokumente nun mit dem Layout der in Chrome River EXPENSE verfügbaren PDF-Dokumente überein.

Administratoren können den Zugriff auf die REST Expense Image API über den Admin-Bildschirm API-Schlüsselverwaltung aktivieren. Weitere Einzelheiten finden Sie im Implementierungs-Toolkit.

Klicken Sie hier, um auf die neue REST Expense Image API zuzugreifen.

Alte SOAP Expense Image API

Chrome River bietet Ihnen eine API, über die Sie Bilder herunterladen können, nachdem Sie Ausgaben exportiert haben. 

  • 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>environment_url (je nachdem, ob es sich um eine Abfrage auf dem PROD- oder QS/UAT-Server handelt)
  • Verwenden Sie die QS/UAT- oder Produktions-URL, die vom Chrome River-Administrator Ihres Unternehmens bereitgestellt wird.

Erforderliche POST-Argumente 

Erforderliche POST-Argumente (für jeden der unten genannten Methodenaufrufe erforderlich)
un Benutzername (FTP-Benutzer)
pw Passwort (FTP-Passwort)
Methode Auszuführende Methode

method=getVoucherInvoices

Basierend auf den Exportdaten in Chrome River wird Ihnen bei dieser Methode eine Liste aller in einem bestimmten Zeitraum exportierten Reisekostenabrechnungen ausgegeben, bei denen Bilder an die Abrechnung oder an einzelne Belegpositionen angehängt wurden. Die meisten Benutzer greifen auf diesen Dienst nach Mitternacht für den vorangegangen Tag zu. Ihr Unternehmen entwickelt ein Programm, mit dem eine Liste von RKA-Nummern durchlaufen wird und die getReceipts-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

fromDate Format MM/TT/JJJJ
toDate Format MM/TT/JJJJ
  • 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 Ausgabenpositionen mehr als 90 Tage zurückliegt, werden ihre XML-Daten nicht ausgegeben.

XML bei Erfolg:

<list><com.chromeriver.servlet.VoucherInvoiceTO><reportID>1.234.567.891.234</reportID><voucherInvoice>3.698.602.242.029</voucherInvoice><invoiceDate>1.236.293.857.500</invoiceDate><invoiceDateString>2016-03-05 22:57:37</invoiceDateString><vendorNumber>1.234</vendorNumber><isReceiptUpdatedAfterExport>false</isReceiptUpdatedAfterExport></com.chromeriver.servlet.VoucherInvoiceTO><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

  • voucherInvoice: Quittungs-Rechnungsnummer, die im Finanzsystem erstellt wird
  • invoiceDate: Format in Sekunden seit 1970
  • invoiceDateString: Für Menschen lesbares formatiertes Datum
  • vendorNumber: Wert Lieferant1 oder Lieferant2 in Chrome River

method=getReceipts

Bei dieser Methode wird eine PDF-Datei mit allen Bildern ausgegeben, die einer Reisekostenabrechnung oder einer Belegposition innerhalb der Abrechnung zugeordnet sind. Jedes Mal, wenn Sie diese Methode aufrufen, wird eine einzelne PDF-Datei erstellt, die nach der RKA-Nummer benannt ist. Sie können auch den zu einer Reisekostenabrechnung gehörenden PDF Report ausgeben lassen. Dieser wird dann an das Beleg-PDF angehängt.

Erforderliche POST-Argumente

Sie können entweder die Quittungs-Rechnungsnummer ODER die RKA-ID eingeben.
voucherInvoice Die Quittungs-Rechnungsnummer, die bei der getVoucherInvoices-Methode ausgegeben wurde.
Report-ID
Die RKA-ID ist eine zwölfstellige Nummer, die von Chrome River erzeugt wird und mit 0100 beginnt. Geben Sie die Nummer ohne Bindestriche ein!
Beispiel: 010012345678

Optionale POST-Argumente

Argument Aktion Mögliche Werte Standardwert
getImage Gibt das Bild der Ausgabe aus wahr/falsch wahr
getMileageDetails Gibt das Deckblatt der Fahrkostendetails aus wahr/falsch falsch
getPDFReport Gibt den vollständigen PDF Report aus wahr/falsch falsch
getPDFReportWithNotes Gibt den vollständigen PDF Report mit Vermerken aus wahr/falsch falsch
imageFirst Gibt das Bild vor dem vollständigen PDF Report aus wahr/falsch wahr

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: „voucherInvoice ungültig“
  • Wenn sowohl die PDF- als auch die JPG-Bilddateien verfügbar sind, werden zunächst die JPGs abgerufen. Wenn keine JPG-Dateien vorliegen, wird das PDF abgerufen.
  • Wenn Sie „getPDFReport“ auswählen, wird zuerst das Original-PDF abgerufen, sofern es vorliegt.
  • Wenn weder eine JPG- noch eine PDF-Datei für diese Rechnung vorhanden ist, lautet die Nachricht: „Belege konnten nicht abgerufen werden. Bitte Belege für diese Quittung erneut einreichen“.
  • Wenn sich keine Bilder im Anhang der Reisekostenabrechnung befinden, lautet die Nachricht: „Es liegen keine mit dieser Reisekostenabrechnung verknüpften Belege vor“.

method=getReceiptsWithCoverPage()

Bei dieser Methode wird eine PDF-Datei des Deckblatts und aller Bilder ausgegeben, die einer Reisekostenabrechnung oder einer Belegposition innerhalb der Abrechnung zugeordnet sind. Jedes Mal, wenn Sie diese Methode aufrufen, wird eine einzelne PDF-Datei erstellt, die nach der Quittungs-Rechnungsnummer benannt ist. Sie können auch den zu einer Reisekostenabrechnung gehörenden PDF Report ausgeben lassen. Dieser wird dann an das Beleg-PDF angehängt.

Erforderliches POST-Argument

voucherInvoiceFor Pdf Die Quittungs-Rechnungsnummer, die bei der getVoucherInvoices-Methode ausgegeben wurde.
reportIDForPdf
Die RKA-ID ist eine zwölfstellige Nummer, die von Chrome River erzeugt wird und mit 0100 beginnt. Geben Sie die Nummer ohne Bindestriche ein!
Beispiel: 010012345678

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: „voucherInvoice ungültig“
  • Wenn sowohl die PDF- als auch die JPG-Bilddateien verfügbar sind, werden zunächst die JPGs abgerufen. Wenn keine JPG-Dateien vorliegen, wird das PDF abgerufen.
  • Wenn weder eine JPG- noch eine PDF-Datei für diese Rechnung vorhanden ist, lautet die Nachricht: „Belege konnten nicht abgerufen werden. Bitte Belege für diese Quittung erneut einreichen“.
  • Wenn sich keine Bilder im Anhang der Reisekostenabrechnung befinden, lautet die Nachricht: „Es liegen keine mit dieser Reisekostenabrechnung verknüpften Belege vor“.

method=getLineItemVoucherInvoices

Bei dieser Methode wird auf der Grundlage einer Quittungs-Rechnung eine Auflistung der Quittungs-Rechnungen von Belegpositionen ausgegeben.
  • WENN eine bestimmte Belegposition mit einem Bild verknüpft ist, DANN führen Sie die Quittungs-Rechnung der Belegposition in der ausgegebenen Liste auf – ANDERNFALLS nicht.
  • WENN Bilder im Header nicht mit einer Belegposition verknüpft sind und nur im Header aufgeführt werden, DANN geben Sie in der ausgegebenen Auflistung (die alle nicht-verlinkten Bilder einbeziehen sollte) 00000000 ein.

Format der Quittungs-Rechnungen von Belegpositionen: 

<VoucherInvoice> + "_" + <LineNumber> + <HotelNumber>

Erforderliches POST-Argument

lineItemVoucherInvoice Die Quittungs-Rechnungsnummer, die bei der getVoucherInvoices-Methode ausgegeben wurde.

XML bei Erfolg:

<list><lineItemVoucherInvoice>0860631509020301_00020000</lineItemVoucherInvoice><lineItemVoucherInvoice>0860631509020301_00010000</lineItemVoucherInvoice><lineItemVoucherInvoice>0860631509020301_00000000</lineItemVoucherInvoice></list>

method=getLineItemReceipts

Bei dieser Methode wird ausgehend von der Quittungs-Rechnung einer bestimmten Belegposition eine PDF-Datei mit Belegpositionsbelegen ausgegeben. So können auch alle verbleibenden Bilder ausgegeben werden, die mit keiner Belegposition verknüpft sind (00000000).

Format der Quittungs-Rechnungen von Belegpositionen: 

<VoucherInvoice> + "_" + <LineNumber> + <HotelNumber>

Erforderliches POST-Argument

voucherInvoiceForReceipt Eine belegpositionsspezifische Quittungs-Rechnungsnummer, die bei der getLineItemVoucherInvoices-Methode ausgegeben wurde.

Ausgaben

  • Ist der Vorgang erfolgreich, gibt die API die konsolidierte Bild- und/oder PDF-Datei aus. Diese enthält entweder die Bilder, die der Belegposition verbunden sind, oder die verbleibenden Bilder aus der Reisekostenabrechnung, die mit keiner Belegposition verknüpft sind (00000000).
  • Sollten Fehler auftreten, gibt die API eine XML-Datei mit Fehlerangaben aus.
Hinweis: Es gibt keine Datumsgrenze für diesen Methodenaufruf.

method=getLineItemReceiptsWithMileageDetails

Wenn ein Google Maps-Bild an eine Belegposition angehängt ist, für die Bilder angefordert wurden, können Sie ein Deckblatt ausgeben lassen, auf dem alle Details aufgeführt sind, die zu dieser Ausgabe gehören – einschließlich RKA-ID, RKA-Name, Reisender, Zuordnung, Satz, Entfernung und abzuziehende Beträge. Nur die Methode weicht von getLineItemReceipts ab – alle anderen Parameter sind identisch wie im Abschnitt method=getLineItemReceipts.
Hinweis: Wenn keine Belegbilder mit der angeforderten Belegposition verknüpft sind, wird eine Fehlermeldung ausgegeben – selbst wenn Fahrtkostendetails mit der Belegposition verknüpft sind.

method=getVoucherInvoicesForXML()

Bei dieser Methode wird auf der Grundlage der Exportdaten in Chrome River eine Liste aller in einem bestimmten Zeitraum exportierten Reisekostenabrechnungen ausgegeben, bei denen XML-Dateien an Belegpositionen angehängt wurden. Die meisten Benutzer greifen auf diesen Dienst nach Mitternacht für den vorangegangen Tag zu. Ihr Unternehmen entwickelt ein Programm, mit dem eine Liste von RKA-Nummern durchlaufen wird und die getReceiptsForXML-Methode für jede einzelne aufgerufen wird.

Erforderliche POST-Argumente

fromDateforXml Format MM/TT/JJJJ
toDateforXml Format MM/TT/JJJJ
  • 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 Ausgabenpositionen mehr als 90 Tage zurückliegt, werden ihre XML-Daten nicht ausgegeben.

XML bei Erfolg:

<list><com.chromeriver.servlet.VoucherInvoiceTO><reportID>1.234.567.891.234</reportID><voucherInvoice>3.698.602.242.029</voucherInvoice><invoiceDate>1.236.293.857.500</invoiceDate><invoiceDateString>2016-03-05 22:57:37</invoiceDateString><vendorNumber>1.234</vendorNumber><isReceiptUpdatedAfterExport>false</isReceiptUpdatedAfterExport></com.chromeriver.servlet.VoucherInvoiceTO><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

  • voucherInvoice: Quittungs-Rechnungsnummer, die im Finanzsystem erstellt wird
  • invoiceDate: Format in Sekunden seit 1970
  • invoiceDateString: Für Menschen lesbares formatiertes Datum
  • vendorNumber: Wert Lieferant1 oder Lieferant2 in Chrome River

method=getReceiptsForXML()

Bei dieser Methode wird Ihnen eine ZIP-Datei mit allen XML-Dateien ausgegeben, die einer Reisekostenabrechnung oder einer Belegposition innerhalb der Abrechnung zugeordnet sind. Jedes Mal, wenn Sie diese Methode aufrufen, wird eine einzelne ZIP-Datei erstellt, die nach der RKA-Nummer benannt ist.
Alle XML-Dateien in der ZIP-Datei sind nach folgender Logik benannt: 
<ReportID>_<UUID>.xml

Erforderliches POST-Argument

voucherInvoiceForXml Die Quittungs-Rechnungsnummer, die bei der getVoucherInvoicesForXML-Methode ausgegeben wurde

Ausgaben

  • Ist der Vorgang erfolgreich, gibt die API die ZIP-Datei mit allen XML-Dateien 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 Quittungs-Rechnung eingegeben wird: „VoucherInvoice erforderlich“.
  • Wenn keine Rechnung für die angegebene Rechnungs-ID vorliegt, lautet die Nachricht: „voucherInvoice ungültig“
  • Wenn sich keine Bilder im Anhang der Reisekostenabrechnung befinden, lautet die Nachricht: „Es liegen keine mit dieser Reisekostenabrechnung verknüpften XML-Dateien vor“.

War dieser Beitrag hilfreich?