Anforderungs-API (/requisitions)
Verwenden Sie die Anforderungs-API, um Anforderungen zu erstellen, zu aktualisieren und abzufragen.
Die URL für den Zugriff auf Anforderungen lautet: https://{your_instance_name}/api/requisitions
Weitere Informationen finden Sie unter Integrations-Best Practices.
API-Objekte Anforderungen
Dies ist die vollständige Liste der über die Benutzeroberfläche verfügbaren Ausgabenobjekte. Allerdings haben nicht alle hier aufgeführten Objekte Endpunkte - einige werden nur von Objekten referenziert und können nicht direkt aktualisiert werden.
Hinweis
- Wenn Sie diese API mit einem statischen Kontenplan einreichen, müssen alle enthaltenen Segmentwerte von einem vorhandenen Konto stammen.
- Wenn Sie diese API mit einem dynamischen Kontenplan einreichen, müssen alle enthaltenen Segmentwerte mit vorhandenen Kontensegmenten oder Nachschlagewerten übereinstimmen. Wenn ein Konto für einen bestimmten Segmentwert nicht vorhanden ist, wird es von der API automatisch erstellt.
Aktionen
Anforderungs-API ermöglicht Ihnen:
| Verb | Pfad | Aktion | Beschreibung |
|---|---|---|---|
| PUT | /api/requisitions/:id/add_approver |
add_approver | Manuell eine genehmigende Stelle für eine Anforderung hinzufügen |
| BEITRAG |
|
add_to_cart | In den Einkaufswagen |
| BEITRAG | /api/requisitions |
erstellen | Eine Anforderung im Entwurfsstatus erstellen, die dann manuell übermittelt werden muss |
| ABFRAGEN | /api/requisitions/current_cart |
current_cart | Aktuellen Warenkorb für Benutzer senden, wenn es keinen aktuellen Warenkorb gibt, dann erstellen und senden |
| ABFRAGEN | /api/requisitions |
index | Anforderungen abfragen |
| ABFRAGEN | /api/requisitions/mine |
meine | /api/requisitions/mine |
| PUT | /api/requisitions/:id/remove_approval |
remove_approval | Eine manuell hinzugefügte genehmigende Stelle entfernen |
| PUT | /api/requisitions/:id/save_for_later |
save_for_later | Für spätere API-Anforderungen speichern |
| ABFRAGEN | /api/requisitions/:id |
anzeigen | Anforderung anzeigen |
| BEITRAG | /api/requisitions/submit_for_approval |
submit_for_approval | Eine Anforderung erstellen und versuchen, sie zur Genehmigung / Käuferaktion einzureichen |
| PUT | /api/requisitions/:id |
aktualisieren | Anforderung aktualisieren |
| PUT | /api/requisitions/:id/update_and_submit_for_approval |
update_and_submit_for_approval | Anforderung aktualisieren und zur Genehmigung übermitteln |
Elemente
| Element | Beschreibung | Anf. | Eindeutig | Zulässiger Wert | In | Out | Datentyp |
|---|---|---|---|---|---|---|---|
| genehmigungen | genehmigungen | ja | Genehmigung | ||||
| strom-Parallel-Zulassungen | Aktuelle parallele Genehmigungen | ja | Genehmigung | ||||
| genehmiger | genehmigende Stelle | ja | Benutzer | ||||
| anhänge | anhänge | ja | Anhang | ||||
| käufer-Hinweis | Alle Kommentare oder Notizen des Einkäufers | ja | ja | text | |||
| created-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| erstellt von | Benutzer der Erstellung | ja | ja | ja | Benutzer | ||
| währung | Währungscode | ja | USD | ||||
| aktuelle-Genehmigung | Aktuell/Genehmigung ausstehend | ja | Genehmigung | ||||
| abteilung | Anforderungsabteilung | ja | ja | Abteilung | |||
| exported | Gibt an, ob die Transaktion exportiert wurde | ja | boolean | ||||
| external-po-reference | Externe Bestellreferenz, mit der Kunden Bestellnummern angeben können, durch die automatisch generierte Bestellnummern überschrieben werden | nein | ja | beliebig | ja | string(255) | |
| hide-price | Preis für Lieferant ausblenden. Richtig oder falsch | nein | nein | ja | RequisitionHeader | ||
| iD | Eindeutige Coupa-ID | ja | ganze Zahl | ||||
| begründung | Kommentare zur Rechtfertigung der Anforderung | ja | ja | text | |||
| zeilenzählung | Anforderungsüberschrift Zeilenzahl | nein | nein | alle | ja | ganze Zahl | |
| meilensteine | Meilensteine | ja | ja | Beschaffung::Meilenstein | |||
| mobile-währung | Standardwährung verwendet | ja | USD | ||||
| handy-Gesamt | gesamt | ja | dezimalzahl | ||||
| bedarf nach Datum | Wunschtermin des Artikels | ja | ja | datum/Uhrzeit | |||
| p-Card | Name von PCard | ja | ja | P-Card | |||
| preis versteckt | Preis für Lieferant ausblenden. Richtig oder falsch | ja | boolean | ||||
| receiving-warehouse-id | ID des empfangenden Lagerorts | nein | nein | alle | ja | ja | ganze Zahl |
| wiederkehrende-Regeln | Wiederkehrende Regeln | ja | |||||
| ablehnungsgrund-Kommentar | letzter Ablehnungsgrund Kommentar | ja | zeichenfolge | ||||
| req_title | Optionaler Name der Anforderung | ja | ja | string(50) | |||
| angefordert von | angefragt_von | ja | ja | Benutzer | |||
| anforderer | angefragt_von | ja | ja | Benutzer | |||
| anforderungszeilen | requisition_lines | ja | ja | ja | RequisitionLine | ||
| ship-to-Address | Name der Adresse | ja | ja | ja | Adresse | ||
| ship-to-Attention | Lieferadresse Achtung | ja | ja | string(255) | |||
| status | Transaktionsstatus. Weitere Informationen zu Anforderungsstatus finden Sie unter Anforderungsstatusdefinitionen. | ja |
draft, cart, pending_buyer_action, pending_approval,
genehmigt, teilweise_empfangen, empfangen,
aufgegeben, hintergründig, zurückgezogen
|
ja | string(50) | ||
| submitted-at | submitted_at | ja | datum/Uhrzeit | ||||
| kennzeichen | ja | ja | [] | ||||
| markierungen | ja | ja | [] | ||||
| gesamt | Gesamtsumme in eigener Währung | ja | dezimalzahl | ||||
| updated-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
| aktualisiert von | Benutzer der Aktualisierung | ja | Benutzer | ||||
| user_members | Benutzermitglieder | ja | Benutzer | ||||
| user_group_members | Benutzergruppenmitglieder | ja | Benutzer |
Hinweis
Das created_by -Element wird standardmäßig vom API-Benutzerschlüssel verwendet, kann jedoch von der Anforderungs-API überschrieben werden. Wenden Sie sich an den Coupa-Support, damit die Anforderungs-API den API-Benutzer-Schlüsselwert überschreiben kann.
Hinweis
- In einer Banfzeile können Sie entweder eine Beschreibung (Freiform) oder einen Artikel (Katalogartikel) verwenden. Wenn eine Artikel-ID verwendet wird, muss der Artikel vorhanden sein. Der <source-type></source-type> wird nicht verwendet und ignoriert.
- Währungen, Benutzer im angeforderten Bereich und Lieferanten müssen sich im System mit dem Status aktiv befinden.
- Artikel: Wenn ein bevorzugter Lieferant und Preis für einen Artikel verfügbar ist, wird er verwendet, es sei denn, der Stückpreis ist angegeben. Wenn ein Stückpreis angegeben wird, wird der für den Artikel verfügbare Standardpreis überschrieben. Es ist zwar kein Fehler, eine Beschreibung und ein Element anzugeben, aber mit einem Element wird die Beschreibung auf die Artikelbeschreibung gesetzt, wobei das im Beschreibungsfeld übergebene ignoriert wird.
- Voreinstellung: Sofern in der XML nicht anders angegeben, beachtet das System die entsprechenden Standardwerte innerhalb des Systems. Wie z.B. säumige Zahlungs- und Versandbedingungen aus dem Lieferantendatensatz.
- Positionsnummerierung: Die API erwartet, dass die Zeilennummer für jede neue Zeilennummer um eins erhöht wird. Wenn Sie die gleiche Zeilennummer verwenden, ignoriert das System alle anderen Zeilen mit der gleichen Nummer.
- Im Rahmen des Release-Updates der Version 30.2.2 haben wir ein Problem behoben, das Sie daran hinderte, eine Anforderung für Benutzer außerhalb der Inhaltsgruppe des Anforderers zu erstellen. Die Anforderungs-API spiegelt nun die Funktionalität der Benutzeroberfläche wider.
- Im Rahmen des Release-Updates der Version 34.4.0 kann die Anforderungs-API zum Erstellen einer neuen Anforderung verwendet werden, indem eine Zeile aus einer anderen Anforderung eingefügt wird - nur, wenn der Status der Quellanforderung Entwurf ist. Wenn der Status der Anforderung nicht Entwurf ist, kann keine Zeile aus der Anforderung referenziert werden, um eine weitere neue Anforderung zu erstellen.
Wenn der Benutzer „erstellt von“ über die API eingestellt wird, wird der Zugriff auf die Inhaltsgruppe dieses Benutzers für die Erstellung der Anforderung validiert. Siehe die folgende Tabelle als Referenz:
| allow_created_by_override_via_api | Der/die Kreative hat Zugriff über die Inhaltsgruppe | Anforderer hat Zugriff über Inhaltsgruppe | Erstellung mittels API zulassen |
|---|---|---|---|
| TRUE | J | Nicht zutreffend | J |
| TRUE | N | Nicht zutreffend | N |
| FALSE | Nicht zutreffend | Nicht zutreffend | J |
Standard-Lieferantenartikelverhalten
Wenn eine Anforderung mit mengenbasierten Zeilen über API erstellt wird, verwendet die Lieferantenposition standardmäßig die Anforderungszeile gemäß den folgenden Regeln:
| API-Nutzlast | Erwartetes Ergebnis |
|---|---|
| Artikel-ID | Bevorzugter oder günstiger Lieferantenartikel |
| Artikel-ID, Lieferant | Bevorzugter oder günstiger Lieferantenartikel, der mit der angegebenen Lieferanten-ID übereinstimmt |
| Artikel-ID, Lieferant, Quell-Artikelnummer | Bevorzugter oder günstiger Lieferantenartikel, der mit der angegebenen Lieferanten-ID und der Quell-Artikelnummer übereinstimmt |
| Artikel-ID, Lieferant, Quell-Teilenummer, Lieferanten-Aux-Teilenummer | Bevorzugter oder günstiger Lieferantenartikel, der mit der angegebenen Lieferanten-ID und der Quell-Teilenummer und der Lieferanten-Hilfs-Teilenummer übereinstimmt |
| Artikel-ID, Lieferant, Vertrag | Bevorzugter oder günstiger Lieferantenartikel, der mit der angegebenen Lieferanten-ID und Vertrags-ID übereinstimmt |
| Artikel-ID, Lieferant, Vertrag, Preis | Bevorzugter oder preisgünstigster Lieferantenartikel, der mit der angegebenen Lieferanten-ID und Vertrags-ID übereinstimmt (Preis wird nicht in Übereinstimmung verwendet) |
| Artikel-ID, Lieferant, Vertrag, Quell-Artikelnummer | Bevorzugter oder günstiger Lieferantenartikel, der mit der angegebenen Lieferanten-ID und der Vertrags-ID und der Quell-Artikelnummer übereinstimmt |
| Artikel-ID, Lieferant, Vertrag, Quell-Teilenummer, Lieferanten-Aux-Teilenummer | Bevorzugter oder günstiger Lieferantenartikel, der mit der angegebenen Lieferanten-ID und Vertrags-ID und Quell-Teilenummer und Lieferanten-Aux-Teilenummer übereinstimmt |
Hinweis
- Wenn der Lieferantenartikel einem Katalog zugeordnet ist, muss sich der Katalog im Status "akzeptiert" befinden und das aktuelle Datum liegt innerhalb des Start- und Enddatums des Katalogs.
- Wenn die Lieferantenposition einem Vertrag zugeordnet ist, muss sich der Vertrag im Status "veröffentlicht" befinden und das aktuelle Datum liegt innerhalb des Start- und Enddatums des Katalogs.