Skip to navigation

Delete contract obligation

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
obligationIdstringRequired
Obligation Id

Response

Obligation deleted, 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

404
Not Found Error