Integration von Rechnungen in Ihr ERP
Schrittweise Anweisungen zur Integration Ihrer Coupa-Rechnungen in Ihr ERP.
Einleitung
Sie können dieses Dokument auch als Microsoft Word-Dokument herunterladen:Coupa Invoices to ERP.docx
Allgemeine Überlegungen zur API-Konfiguration
- Erste Schritte mit der Coupa-API
- API-Schlüsselsicherheit (wird eventuell veraltet sein)
- Open Connect API-Zugriff(ab R29)
- JSON/XML
- GrafikQL (ab R30)
Begrenzte Nutzlast: Felder und API-Filter
Coupas API gibt standardmäßig viele Daten zurück (z. B. vollständige Objekte für zugehörige Objekte). Die API-Rückgabenutzlasten können sehr groß und daher langsam sein. Dies kann ein Problem für Kunden sein, die keine fremden Daten benötigen, ganz zu schweigen vom unnötigen Ressourcenverbrauch.
Um die Dinge zu vereinfachen, hat Coupa das Konzept der "Felder"-Parameter und API-Filter, die eine begrenzte JSON- oder XML-Antwort anstelle des gesamten Schemas und aller Zuordnungen für ein Objekt zurückgeben.
- API-Antwortfilter
- API: Verwenden des neuen API-Abfrageparameters "fields", Alternative zu "return object"
In diesem Artikel beschriebene Anwendungsfälle
Die Rechnungen haben normalerweise eine interne Nummer im ERP. In diesem Dokument gehen wir davon aus, dass diese ERP-Dokumentnummer ein benutzerdefiniertes Feld in der Coupa-Rechnungskopfzeile ist. In unserem Beispiel cf_erp_invoice_number
wurde das benutzerdefinierte Feld mit dem Namen ERP Invoice Number
erstellt. Dieser Artikel beschreibt die 3 verschiedenen Optionen zur Integration von Coupa-Rechnungen in Ihr ERP (für die Erstellung und Aktualisierung).
Diese Optionen ändern die Art und Weise, wie Sie Ihre Integrationen von Coupa aus überwachen können:
- Option 1: Einfache Überwachung basierend auf benutzerdefinierten Feldern, die Sie in der Rechnungskopfzeile definieren
- Option 2: Erweiterte Überwachung mit Integrationsverlaufsdatensätzen
- Option 3: Nutzen Sie die vollständige Überwachung der Coupa-Integrationen
Für die 3 Optionen werden die Coupa-Rechnungen basierend auf dem Export-Kennzeichen in das ERP übertragen. Im Falle eines Fehlers ist bei der Integration einer Rechnung eine manuelle Änderung auf der Rechnung in der Coupa-Benutzeroberfläche erforderlich: Diese Änderung setzt das Export-Kennzeichen zurück und die Rechnung wird daher beim nächsten Durchlauf berücksichtigt.
Coupa schlägt vor, dass Sie sich an den Coupa-Support wenden, damit dieser diese Option aktiviert:Für jede Änderungdie Rechnung für den letzten Export am zurücksetzen. Diese Einstellung gilt nur für die Benutzeroberfläche. Änderungen, die über die API vorgenommen werden, ändern nicht den Status Exportiert.
Dedizierte Integration und Kontakt für API erstellen
Für die Optionen 2 und 3 müssen Sie Folgendes erstellen:
- Eine spezielle Integration für jede API-Orchestrierung, die Sie implementieren
- Ein oder mehrere Integrationskontakte für jede Integration, die bei einer fehlgeschlagenen Integration gewarnt werden
Coupa empfiehlt, dass Sie sich an den Coupa-Support wenden, damit dieser diese Option aktiviert: Link zum Integrationsverlaufnach Dokumenttypaktivieren. Diese Einstellung fügt auf der Konfigurationsseite einen Link hinzu, um den vollständigen Integrationsverlauf pro Dokumenttyp anzuzeigen.
Option 1: Einfache Überwachung basierend auf benutzerdefinierten Feldern
Beschreibung
In diesem Szenario fügen wir für jede Rechnung den aktuellen Integrationsstatus in ein oder mehrere benutzerdefinierte Felder der Rechnungskopfzeile ein. Wir haben das benutzerdefinierte Feld cf-integration-status
mit dem NamenIntegration Status
hinzugefügt. Verwenden Sie die Standardtabelle für Rechnungsdaten, um den Integrationsstatus Ihrer Dokumente unter dieser URL nachzuverfolgen: https://<your instance hostname>/invoices
.
Orchestrierungsdiagramm
Schritte/API-Aufrufdetails
Schritt 1 |
Rufen Sie die Liste und die Details der Coupa-Rechnungen ab, die im ERP erstellt/aktualisiert werden sollen. Zu den Auswahlkriterien gehören das Exportkennzeichen und der Rechnungsstatus. |
---|---|
Methode |
GET |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 2 |
Einzelne Rechnung als exportiert markieren |
---|---|
Methode |
PUT |
API |
https:// |
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 3 |
Benutzerdefinierte Felder für die Berichterstellung und ERP-Dokumentnummer aktualisieren |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
oder
|
Antworttyp |
oder
|
Option 2: Erweiterte Überwachung mit Integrationsverlauf
Beschreibung
In diesem Szenario gilt für jede Rechnung Folgendes:
- Beheben Sie den vorherigen Integrationsverlaufsdatensatz für das Dokument
- Integrationsverlaufsdatensatz erstellen
- Erstellen Sie im Fehlerfall eine Warnung für den Integrationskontakt.
Jedes Dokument enthält Details zum Integrationsverlauf
Verwenden Sie die Datentabelle für den Standardrechnungsintegrationsverlauf, um den Integrationsstatus Ihrer Dokumente nachzuverfolgen. Sie finden es unter: https://<your instance hostname>/integration_history_records/invoices
.
Sie können einen Filter für den Antwortcode verwenden, um zwischen erfolgreich replizierten Dokumenten und fehlgeschlagenen Dokumenten zu unterscheiden.
Orchestrierungsdiagramm
Schritte/API-Aufrufdetails
Schritt 1 |
Rufen Sie die Liste und die Details der Coupa-Rechnungen ab, die im ERP erstellt/aktualisiert werden sollen. |
---|---|
Methode |
GET |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 2 |
Einzelne Rechnung als exportiert markieren |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Hier erfolgt die Erstellung/Aktualisierung der Rechnung im ERP.
Schritt 3a |
Ungelösten Integrationsverlaufsdatensatz erhalten |
---|---|
Methode |
GET |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 3b |
Vorherigen Integrationsverlaufsdatensatz auflösen |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 4a |
Benutzerdefinierte Felder für ERP-Dokumentnummer aktualisieren (erfolgreich) |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 4b |
Integrationsverlauf erstellen (erfolgreich) |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 4c |
Integrationsverlauf erstellen (Fehler) und an Integrationskontakt warnen |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
|
Antworttyp |
|
Option 3: Nutzen Sie die vollständige Überwachung der Coupa-Integrationen
Beschreibung
In diesem Szenario erstellen wir einen Integrationslauf, der
- Der Status der Integration (ausstehend/gestartet/fehlerhaft/erfolgreich/fehlgeschlagen)
- Die Gesamtzahl der verarbeiteten Rechnungen
- Anzahl von Erfolgen und Fehlern
- Die Liste der Integrationsfehler und deren Status (behoben oder nicht)
Für jede Rechnung:
- Beheben Sie den vorherigen Integrationsverlaufsdatensatz für das Dokument
- Integrationsverlaufsdatensatz erstellen
- Erstellen Sie im Fehlerfall einen Integrationsfehler und eine Warnung an den Integrationskontakt.
Sie können alle Integrationsläufe für Ihre Integration mit dieser URL überwachen:https://<your instance hostname>/integrations/<your integration id>/integration_runs
.
Sie verwenden die Standardtabelle für Rechnungsintegrationsfehler, um alle Rechnungen mit Integrationsfehler aufzulisten, deren Lösung aussteht. Sie finden es unter: https://<your instance hostname>/integration_errors
.
Orchestrierungsdiagramm
Schritte/API-Aufrufdetails
Schritt 1 |
Integrationslauf erstellen |
---|---|
Methode |
POST |
API |
|
Abfrageparameter |
k. A. |
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 2 |
Rufen Sie die Liste und die Details der Coupa-Rechnungen ab, die im ERP erstellt/aktualisiert werden sollen. |
---|---|
Methode |
GET |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 3 |
Integrationslauf starten |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
k. A. |
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 4 |
Einzelne Rechnung als exportiert markieren |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Hier erfolgt die Erstellung/Aktualisierung der Rechnung im ERP.
Schritt 5a |
Ungelösten Integrationsverlaufsdatensatz erhalten |
---|---|
Methode |
GET |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 5b |
Vorherigen Integrationsverlaufsdatensatz auflösen |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 6a |
Ungelösten Integrationsfehlerdatensatz abrufen |
---|---|
Methode |
GET |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 6b |
Vorherigen Integrationsverlaufsdatensatz auflösen |
---|---|
Methode |
PUT |
API |
https:// |
Abfrageparameter |
k. A. |
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Schritt 7a |
Benutzerdefinierte Felder für ERP-Dokumentnummer aktualisieren (erfolgreich) |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 7b |
Integrationsverlauf erstellen (erfolgreich) |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
|
Beispiel-URL |
|
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 7c |
Integrationsfehler erstellen und auf Integrationskontakt aufmerksam machen |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
k. A. |
Abfrage Textstichprobe |
|
Antworttyp |
|
Schritt 8 |
Integrationslauf erfolgreich beenden |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
k. A. |
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Wenn während des Integrationslaufs ein allgemeiner Fehler auftritt.
Schritt x |
Fehler für den Integrationslauf auslösen |
---|---|
Methode |
PUT |
API |
|
Abfrageparameter |
k. A. |
Abfrage Textstichprobe |
k. A. |
Antworttyp |
|
Hinweis: Einige Inhalte wurden maschinell übersetzt.