Vertragsvorlage-API (/contracts/templates)
Ihr System kann die Vertragsvorlagen-API verwenden, um einen Index zu erhalten oder individuelle Vertragsvorlagendefinitionen zu erhalten.
Zur Unterstützung der Vertragsvorlagenverwaltung können Sie nun den Zugriff auf Vertragsvorlagen einschränken, indem Sie eine Vertragsvorlage einer Inhaltsgruppe zuweisen. Mit der Vertragsvorlagen-API kann Ihr System sie abrufen.
Die URL für den Zugriff auf Vertragsvorlagen lautet: https://<instance>/api/contracts/templates
Weitere Informationen finden Sie unter Integrations-Best Practices.
Aktionen
Mit der Vertragsvorlagen-API können Sie:
| Verb | Pfad | Aktion | Beschreibung |
|---|---|---|---|
| ABFRAGEN | /api/contracts/templates |
index | Vertragsvorlagen abfragen |
| ABFRAGEN | /api/contracts/templates/:id |
anzeigen | Vertragsvorlage anzeigen |
Elemente
Die folgenden Elemente sind für die Vertragsvorlagen-API verfügbar:
| Element | Beschreibung | Pflichtfeld? | Eindeutig? | Zulässiger Wert | Api_In Field? | Api_Out-Feld? | Datentyp |
|---|---|---|---|---|---|---|---|
| aktiv | Ist Vorlage aktiv | nein | nein | alle | ja | ja | boolean |
| authoring-method | Autorisierungsmethode | msword, msword_and_online |
ja | ja | string(255) | ||
| content-groups | Geschäftsgruppen | ja | ja | Inhaltsgruppen | |||
| vertragsklassifizierung | Vertragszuordnung | ja | |||||
| 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 | ||||
| beschreibung | Beschreibung | ja | ja | string(255) | |||
| fill-with-counterparty | Mit Gegenpartei ausfüllen | ja | ja | boolean | |||
| hierarchietyp | Hierarchietyp | ja | string(255) | ||||
| iD | Eindeutige Coupa-ID | ja | ganze Zahl | ||||
| name | Name | ja | ja | ja | string(255) | ||
| template-generator-id | Vorlage-Generator-ID | ja | ja | string(1024) | |||
| 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 | ||||
| vorlage_generator_typ | Vorlagen-GeneratortypVorlagen-Generatortyp | ja | ganze Zahl | ||||
| supporting_document | Unterstützende Dokumenteunterstützende_Dokumente | ja | boolean | ||||
| quelle | Bezeichner für Vertragsvorlagenquelle | ja | string(255) | ||||
| contract_types | Vertragstypen | ja | ja | ContractType | |||
| contract_hierarchy_types | Vertragshierarchietypen | ja | ja | ContractHierarchyType | |||