Announcement
Diese Seite ist auch in English, Español, Français, Italiano, 日本語 und Português verfügbar.
Neu bei Contract Templates: Eine Vorlage per API auf mehrere Kunden anwenden
Erstellen Sie Vertragsentwürfe für bis zu 100 Kunden mit einem einzigen API-Aufruf.
By Sam Clark
·Shipped by
In der Console ist das Anwenden einer Vertragsvorlage auf Ihre Kunden ein einziger Schritt: Vorlage auswählen, Kunden auswählen – und schon liegt für jeden Kunden ein Vertragsentwurf vor. Über die API lief das bisher in einer Schleife: Vorlage auslesen, deren Billing Rules, Price Books und Custom Line Items in einen Create-Contract-Body kopieren – und das Ganze für jeden Kunden wiederholen.
Die Contract Templates API kann jetzt, was die Console kann. Ein einziger POST /billing/v1/contract-templates/{templateID}/contracts erstellt für jeden Kunden im Batch einen Vertragsentwurf. Die Billing Rules, Price Books und Custom Line Items der Vorlage sind dabei bereits enthalten.
- Anwendung im Batch: Senden Sie bis zu 100 Kunden pro Request. Jeder Kunde erhält ein eigenes Ergebnis – ein nicht berechtigter Kunde blockiert also nicht die übrigen.
- Dry Run: Fügen Sie
dryRun=truehinzu, um den gesamten Batch zu validieren, ohne etwas zu erstellen. Nutzen Sie das zuerst. Jeder echte Aufruf erstellt neue Entwürfe – auch für Kunden, die aus derselben Vorlage bereits einen haben. - Erstellung für einzelne Kunden: Übergeben Sie beim Erstellen eines Vertrags über die Contracts API eine
templateId, um eine Vorlage mit einem einzigen Aufruf anzuwenden. Vorlagenkomponenten gelten nach dem Alles-oder-nichts-Prinzip: Ein Request, der zusätzlich eigene Billing Rules, Price Books oder Custom Line Items enthält, wird abgelehnt.
Jeder Vertrag wird als Entwurf angelegt. Die Entwürfe prüfen und aktivieren Sie genauso wie bisher.
Den Endpoint und Request-Beispiele finden Sie in der API-Referenz, und wie Vorlagen funktionieren, erfahren Sie im Leitfaden zu Vertragsvorlagen. Für den API-Aufruf benötigen Sie Zugriff auf die External API sowie die Berechtigung "Contract Templates Admin".
Verfügbar für Distributoren und Reseller, die PartnerOps Revenue Management nutzen.
Related documentation
