Skip to main content
POST
/
rr
/
api
/
v1
/
contracts
/
{id}
/
terminate
Terminate Contract
curl --request POST \
  --url https://api.meetcampfire.com/rr/api/v1/contracts/{id}/terminate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "termination_date": "2023-12-25",
  "void_invoice_ids": [
    123
  ],
  "void_date": "2023-12-25"
}
'
{
  "contract_terminated": true,
  "contract_draft_id": 123,
  "voided_invoice_ids": [
    123
  ],
  "drafted_invoice_ids": [
    123
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

Body

​
termination_date
string<date>
required
​
void_invoice_ids
integer[]

List of invoice IDs to void atomically when terminating the contract.

​
void_date
string<date>

Date to use when voiding invoices. Required when void_invoice_ids is provided.

Response

200 - application/json

Response serializer for contract termination with hints about drafted operations.

​
contract_terminated
boolean
required

Whether the contract was terminated directly (True) or drafted (False).

​
contract_draft_id
integer | null

Draft queue ID if contract termination was drafted instead of executed.

​
voided_invoice_ids
integer[]

List of invoice IDs that were voided directly.

​
drafted_invoice_ids
integer[]

List of invoice IDs that were drafted for voiding (user lacks void permission).