Skip to navigation
Contracts

Change event type for selected billing terms and POBs in a group

View as Markdown

Returns 202 once the change is saved. Invoices are regenerated asynchronously: poll statusEndpoint until the job completes. jobId is null when the change named no billing terms, so no regeneration was queued; statusEndpoint then points at the customer’s invoice-generation status.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

idstringRequired
Contract Id
groupIdstringRequired
Billing Term Group Id

Request

This endpoint expects an object.
billingTermIdslist of stringsRequired

IDs of the billing terms (within the group) whose event type should be set to toEventTypeId. Pick exactly the rows to change — in a many-to-many group the others are left untouched. May be empty when only performance obligations are being changed.

performanceObligationIdslist of stringsRequired

IDs of the performance obligations (within the group) whose event type should be set to toEventTypeId. May be empty when only billing terms are being changed.

toEventTypeIdstringRequiredformat: "uuid"
The event type to assign to the selected billing terms and performance obligations. Must belong to the merchant.

Response

Event type changed for the selected billing terms and performance obligations within the group, and the invoice regeneration job
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error