Verträge API (/contracts)
Verwenden Sie die Vertrags-API, um einen Vertrag zu erstellen, zu aktualisieren oder abzufragen, einschließlich der beteiligten Geschäftsgruppen, Stichtage, des Status des Vertrags und der Finanzbedingungen.
Übersicht
Verwenden Sie die Vertrags-API, um einen Vertrag zu erstellen, zu aktualisieren oder abzufragen, einschließlich der beteiligten Geschäftsgruppen, Stichtage, des Status des Vertrags und der Finanzbedingungen.
Die URL für den Zugriff auf Verträge lautet: https://{your_instance_name}/api/
contracts
Weitere Informationen finden Sie unter Integrations-Best Practices.
Untergeordnete Objekte
- Beispielaufrufe für Vertrags-APIs
- Vertragszuordnungs-API
- API der Vertragsklausel
- Referenz-API der Vertragsklausel
- Vertragsdetails - API
- Vertragsstreitigkeit-API
- API der Vertragspartei
- Kontakt-API der Vertragspartei
- Vertragsvorlage-API (/contracts/templates)
- Vertragslaufzeiten-API
- Vertragstypen-API
- API der Länderunterabteilung
- Geistiges Eigentum und Daten-API
- API für Insights zu Gründen
- API für Insight-Ereignisse zu Gründen
Aktionen
Verb | Pfad | Aktion | Beschreibung |
---|---|---|---|
PUT | /api/contracts/:id/add_approver |
add_approver | Manuell eine genehmigende Stelle für einen Vertrag hinzufügen |
PUT | /api/contracts/:id/ccc_signature_created |
ccc_signature_created | Benachrichtigt, dass in CCC eine Signatur hinzugefügt wurde. |
PUT | /api/contracts/:id/complete |
vollständig | Bewegt den Vertrag in den Zustand „Erledigt“. |
BEITRAG | /api/contracts |
erstellen | Vertrag erstellen |
BEITRAG | /api/contracts/:id/create_published |
create_published | /api/contracts/:id/create_published |
ABFRAGEN | /api/contracts |
index | Verträge abfragen |
BEITRAG | /api/contracts/:id/legal_agreement |
legal_agreement | Legal legal_agreement-Datei hinzufügen oder aktualisieren |
PUT | /api/contracts/:id/legal_agreement |
legal_agreement | Legal legal_agreement-Datei hinzufügen oder aktualisieren |
PUT | /api/contracts/:id/remove_approval |
remove_approval | Eine manuell hinzugefügte genehmigende Stelle entfernen |
ABFRAGEN | /api/contracts/:id/retrieve_legal_agreement |
retrieve_legal_agreement | Legal Legal_Agreement-Datei abrufen |
ABFRAGEN | /api/contracts/:id |
anzeigen | Vertrag anzeigen |
PUT | /api/contracts/:id/submit_for_approval |
submit_for_approval | Legt den Vertrag zur Genehmigung vor. |
PUT | /api/contracts/:id |
update | Vertrag aktualisieren |
PUT | /api/contracts/:id/update_published |
update_published | Aktualisiert einen Vertrag, wenn er veröffentlicht wird.* |
PUT | /api/contracts/:id/withdraw_signatures |
withdraw_signatures | Vertrag wird nach CCC withdraw_signatures der entsprechende Status zugewiesen. |
* Die Aktualisierung abgeschlossener oder veröffentlichter Verträge (direkt, ohne Erstellung eines Entwurfs) erfordert, dass Vertragshierarchie aktivieren in den Einstellungen Ihres Unternehmens aktiviert ist (Konfiguration > Unternehmensinformationen). Wenn Sie nicht über den CLM-Standard verfügen, können Sie mit Vertragsrevisionen arbeiten.
Elemente
Element | Beschreibung | Anf. | Eindeutig | Zulässiger Wert | In | Out | Datentyp |
---|---|---|---|---|---|---|---|
geänderter Vertragstyp | Geänderter Vertragstyp | ja | ja | string(255) | |||
automatisches Verlängern-Ende-Datum-für-Verlängerung | Ablaufdatum automatisch aktualisieren | ja | ja | boolean | |||
zustimmung | Einwilligungserklärung | mitteilung, Einwilligung, not_required, not_assignable | ja | ja | string(255) | ||
content-groups | Geschäftsgruppen | ja | ja | Geschäftsgruppe | |||
vertragsinhaber | Vertragsverantwortlicher | ja | ja | Benutzer | |||
vertragsbedingungen | contract_terms | ja | ja | Vertragsdauer | |||
vertragsart | Benutzerdefinierte Beschriftung für die Kategorisierung | nein | nein | alle | ja | ja | |
vertragstyp-custom-field-1 | Vertragstyp - benutzerdefiniertes Feld 1 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-2 | Vertragstyp - benutzerdefiniertes Feld 2 | nein | nein | beliebig | ja | ja | string(255) |
vertragstyp-custom-field-3 | Vertragstyp - benutzerdefiniertes Feld 3 | nein | nein | beliebig | ja | ja | string(255) |
vertragstyp-custom-field-4 | Vertragstyp - benutzerdefiniertes Feld 4 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-5 | Vertragstyp - benutzerdefiniertes Feld 5 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-6 | Vertragstyp - benutzerdefiniertes Feld 6 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-7 | Vertragstyp - benutzerdefiniertes Feld 7 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-8 | Vertragstyp - benutzerdefiniertes Feld 8 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-9 | Vertragstyp - benutzerdefiniertes Feld 9 | nein | nein | alle | ja | ja | string(255) |
vertragstyp-custom-field-10 | Vertragstyp - benutzerdefiniertes Feld 10 | nein | nein | beliebig | ja | ja | string(255) |
created-at | Automatisch von Coupa erstellt im Format JJJJ-MM-TTTHH:MM:SS+HH:MMZ | ja | datum/Uhrzeit | ||||
erstellt von | Benutzer der Erstellung | ja | Benutzer | ||||
währung | Code der Vertragswährung | ja | ja | Währung | |||
aktuelle-Genehmigung | Aktuelle Genehmigung | ja | Genehmigung | ||||
strom-Parallel-Zulassungen | Aktuelle parallele Genehmigungen | ja | Genehmigung | ||||
default-account | default_account | ja | ja | Konto | |||
abteilung | Eigner Abteilung | nein | nein | alle | ja | ja | Abteilung |
beschreibung | Beschreibende Hinweise zum Vertrag | false | false | alle | ja | ja | string(1024) |
diversity-Kategorien | Lieferanten-Diversitätskategorien | ja | zeichenfolge | ||||
enddatum | Ablaufdatum | nein | ja | ja | datum/Uhrzeit | ||
ausführungsdatum | Datum, an dem der Vertrag abgeschlossen und rechtsverbindlich ist | nein | nein | beliebig | ja | ja | datum/Uhrzeit |
iD | Eindeutige Coupa-ID | ja | ganze Zahl | ||||
is-default | Standardkonto für Lieferantenrechnung | ja | ja | boolean | |||
legal-agreement-url | Optionale URL für den rechtsgültigen Vertrag | ja | ja | string(255) | |||
length-of-notice-unit | Einheit der Länge der Mitteilung(Tage/Monate/Jahre) | tage, Monate, Jahre | ja | ja | string(255) | ||
length-of-notice-value | Wert der Länge der Mitteilung | ja | ja | string(255) | |||
locked-by-Other-Party | CLMS-Vertragspartei mit Bearbeitungssperre | nein | nein | ja | zeichenfolge | ||
locked-by-user-id | CLMS-Benutzer mit Bearbeitungssperre | nein | nein | ja | ganze Zahl | ||
rahmenvertrag | Nummer oder Name des Master-Vertrags | ja | ja | Vertrag | |||
max-commit | Maximaler Commit-Betrag | ja | ja | dezimalzahl(32,4) | |||
maximalwert | Maximaler Commit-Betrag | ja | ja | dezimalzahl(32,4) | |||
min-commit | Mindestbetrag der Zusage | ja | ja | dezimalzahl(32,4) | |||
mindestwert | Mindestbindungsbetrag | ja | ja | dezimalzahl(32,4) | |||
name | Name des Vertrags | ja | ja | ja | ja | string(100) | |
no-of-renewals | Anzahl Verlängerungen | ja | Zulässige Werte umfassen jetzt ["1..100"] | ja | ja | ganze Zahl | |
zahl | Vertragsnummer | ja | ja | ja | ja | string(50) | |
order-window-tz | order_window_tz | Eine gültige Zeitzone | ja | ja | string(255) | ||
übergeordnete | Übergeordnet | ja | ja | Vertrag | |||
zahlungsbedingung | Zahlungsbedingungscode im Vertrag | ja | ja | Zahlungsbedingung | |||
po-message | Mitteilung zu Bestellfenstern | ja | ja | string(255) | |||
bevorzugt | Geben Sie den bevorzugten Vertrag für den Lieferanten an | ja | ja | boolean | |||
proxy-supplier-id | Kennung für einen Proxy-Lieferanten | alle | ja | ja | ganze Zahl | ||
veröffentlichungsdatum | Datum, an dem der Vertrag veröffentlicht wurde | nein | nein | alle | ja | ja | datum/Uhrzeit |
quote-response-id | ID der Angebotsantwort | ja | ganze Zahl | ||||
ra-risk-request | RA-Risikoanfrage | ja | RaRiskRequest | ||||
reason-insight-events | Grund-Einsicht-Ereignisse | ja | ja | ja | Event für Insight zu Gründen | ||
renewal-Length-Unit | Einheit der Verlängerungsdauer (Tage/Monate/Jahre) | ja | tage, Monate, Jahre | ja | ja | string(255) | |
renewal-length-value | Wert der Verlängerungsdauer | ja | ja | ja | ganze Zahl | ||
anforderungsnachricht | Anforderungsmitteilung Bestellfenster | ja | ja | string(255) | |||
reviewer-user-ids | CLMS-interne Überprüfer | nein | nein | ja | ganze Zahl | ||
spar-Pkt. | Erzielte Einsparungen durch Vertragspreise | Ein Prozentsatz zwischen 0 und 100 | ja | ja | dezimalzahl(20,2) | ||
zeitplan | zeitplan | ja | ja | Bestellfenster | |||
lieferbedingung | Code der Versandbedingung im Vertrag | ja | ja | Versandbedingung | |||
source-id | Die Quell-ID der Vertragserstellung | ja | ja | stich(255) | |||
quellentyp | Die Quellart der Vertragserstellung | ja | ja | string(255) | |||
startdatum | Startdatum | ja | ja | datum/Uhrzeit | |||
status | Status des Vertrages | ja | ja | ja | entwurf | ||
strenge Abrechnungsregeln | Strikte Rechnungsstellungsregeln | ja | ja | boolean | |||
stop-spend-basiert-auf-max-Wert | Stoppen Sie die Ausgaben basierend auf dem Höchstwert | nein | nein | ja, nein | ja | ja | string(255) |
absender | Benutzer, der den Vertrag zur Genehmigung eingereicht hat | ja | Benutzer | ||||
Lieferant | Name des Lieferanten | ja | ja | ja | Lieferant | ||
supplier-account | Lieferantenkontonummer | ja | ja | string(255) | |||
lieferanten-fakturierbar | Lieferant darf Rechnung direkt stellen | ja | ja | boolean | |||
markierungen | Taggings | nein | nein | ja | ja | Tagging-API | |
tags | Tags | nein | nein | ja | ja | Kennzeichen-API | |
begriffstyp | Bedingungstyp | fixiert, auto_renew, perpetual | ja | ja | string(255) | ||
abgeschlossen | Gekündigt | ja | ja | boolean | |||
kündigungsmitteilung | Kündigungsmitteilung | ja, Nein | ja | ja | string(255) | ||
terminierungsmitteilung-längeneinheit | Einheit der Länge der Kündigung (Tage/Monate/Jahre) | tage, Monate, Jahre | ja | ja | string(255) | ||
terminierungsmitteilung-längenwert | Wert der Länge der Kündigungsmitteilung | ja | ja | ganze Zahl | |||
bedingungen | bedingungen | ja | ja | text | |||
typ | Vertragstyp | MasterContract, AmendmentContract | ja | zeichenfolge | |||
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 | ||||
use-order-windows | Bestellfenster verwenden | ja | ja | boolean | |||
für den Kauf verwendet | Für Kauf verwendet | ja | ja | boolean | |||
version | version | ja | ja | ganze Zahl | |||
stop-spend-basiert-auf-max-Wert | Stoppen Sie die Ausgaben basierend auf dem Höchstwert | nein | nein | ja, Nein | ja | ja | string(255) |
external_contract_id | Identifikator für externe Verträge | nein | nein | ja | ja | string(255) | |
fill-with-counterparty | Mit Gegenpartei ausfüllen | ja | ja | boolean | |||
whose_paper | Wessen Dokument | nein | nein | not_specified, our_paper, counterparty_paper | ja | ja | ganze Zahl |
contract_dispute | nein | nein | ja | ja | |||
intellectual_property_and_data | nein | nein | ja | ja | |||
esign_provider_account | nein | nein | ja | ja | |||
contract_clauses | nein | nein | ja | ja | [] | ||
use_online_signing | Elektronische Signaturen erforderlich | nein | nein | ja | boolean | ||
contract_classification | Vertragszuordnung | nein | nein | ja | ja | ||
contract_detail | Vertragsdetails | nein | nein | ja | ja | ||
contract_parties_field_container | Vertragspartner Feldcontainer | nein | nein | ja | ja | ||
contract_terms_and_renewal | Vertragsbedingungen und -erneuerung | nein | nein | ja | ja | ||
vertrag_Kündigung | Vertragsbeendigung | nein | nein | ja | ja | ||
contract_performance | Vertragserfüllung | nein | nein | ja | ja | ||
contract_price_and_payment | Vertragspreis und -zahlung | nein | nein | ja | ja | ||
contract_relationship_and_reporting | Vertragsbeziehung und -berichte | nein | nein | ja | ja |
- Wenn Sie mit großen Datensätzen von Verträgen zu tun haben, beschränken Sie Ihre GET immer auf einige Kriterien.
- Die Inhaltsgruppen und Kategorien müssen im System bereits vorhanden sein.