Partial Update Contract
curl --request PATCH \
--url https://api.meetcampfire.com/rr/api/v1/contracts/{id} \
--header 'Content-Type: application/json' \
--data '
{
"tags": "<string>",
"currency": "USD",
"prepaid_commits": [
{
"name": "<string>",
"total_value": 0,
"start_date": "2023-12-25",
"entity": 123,
"product": 123,
"invoice_basis": "fixed_commitment",
"first_invoice_date": "2023-12-25",
"billing_payment_term": 123,
"description": "",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"discount_percentage": 0,
"rate": 0,
"expiration_date": "2023-12-25",
"priority": 1,
"subledger": 123,
"auto_send_overage_invoices": false,
"overage_invoice_start_month": "2023-12-25",
"department": 123,
"tags": [
123
]
}
],
"contract_end_date": "2023-12-25",
"is_evergreen": false,
"auto_send_invoices": false,
"skip_evergreen_invoice_generation": false,
"auto_apply_customer_stripe_config_to_invoices": false,
"usage_tiers": "<string>",
"deal_name": "<string>",
"deal_id": "<string>",
"consultant": "<string>",
"closed_date": "2023-12-25",
"total_contract_value": 0,
"contract_start_date": "2023-12-25",
"exchange_rate": 0,
"exchange_rate_book": 0,
"crm_link": "<string>",
"contract_link": "<string>",
"source_deal_data": null,
"auto_renew": true,
"auto_renew_duration": -1,
"auto_renew_invoice": true,
"tag_ids": [
0
],
"tag_group_ids": [
0
],
"minimum_monthly_commitment_amount": 0,
"minimum_monthly_commitment_quantity": 0,
"purchase_order_number": "<string>",
"entity": 123,
"client": 123,
"default_payment_term": 123,
"department": 123,
"journal_entries": [
123
]
}
'import requests
url = "https://api.meetcampfire.com/rr/api/v1/contracts/{id}"
payload = {
"tags": "<string>",
"currency": "USD",
"prepaid_commits": [
{
"name": "<string>",
"total_value": 0,
"start_date": "2023-12-25",
"entity": 123,
"product": 123,
"invoice_basis": "fixed_commitment",
"first_invoice_date": "2023-12-25",
"billing_payment_term": 123,
"description": "",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"discount_percentage": 0,
"rate": 0,
"expiration_date": "2023-12-25",
"priority": 1,
"subledger": 123,
"auto_send_overage_invoices": False,
"overage_invoice_start_month": "2023-12-25",
"department": 123,
"tags": [123]
}
],
"contract_end_date": "2023-12-25",
"is_evergreen": False,
"auto_send_invoices": False,
"skip_evergreen_invoice_generation": False,
"auto_apply_customer_stripe_config_to_invoices": False,
"usage_tiers": "<string>",
"deal_name": "<string>",
"deal_id": "<string>",
"consultant": "<string>",
"closed_date": "2023-12-25",
"total_contract_value": 0,
"contract_start_date": "2023-12-25",
"exchange_rate": 0,
"exchange_rate_book": 0,
"crm_link": "<string>",
"contract_link": "<string>",
"source_deal_data": None,
"auto_renew": True,
"auto_renew_duration": -1,
"auto_renew_invoice": True,
"tag_ids": [0],
"tag_group_ids": [0],
"minimum_monthly_commitment_amount": 0,
"minimum_monthly_commitment_quantity": 0,
"purchase_order_number": "<string>",
"entity": 123,
"client": 123,
"default_payment_term": 123,
"department": 123,
"journal_entries": [123]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
tags: '<string>',
currency: 'USD',
prepaid_commits: [
{
name: '<string>',
total_value: 0,
start_date: '2023-12-25',
entity: 123,
product: 123,
invoice_basis: 'fixed_commitment',
first_invoice_date: '2023-12-25',
billing_payment_term: 123,
description: '',
currency: '<string>',
exchange_rate: 0,
exchange_rate_book: 0,
discount_percentage: 0,
rate: 0,
expiration_date: '2023-12-25',
priority: 1,
subledger: 123,
auto_send_overage_invoices: false,
overage_invoice_start_month: '2023-12-25',
department: 123,
tags: [123]
}
],
contract_end_date: '2023-12-25',
is_evergreen: false,
auto_send_invoices: false,
skip_evergreen_invoice_generation: false,
auto_apply_customer_stripe_config_to_invoices: false,
usage_tiers: '<string>',
deal_name: '<string>',
deal_id: '<string>',
consultant: '<string>',
closed_date: '2023-12-25',
total_contract_value: 0,
contract_start_date: '2023-12-25',
exchange_rate: 0,
exchange_rate_book: 0,
crm_link: '<string>',
contract_link: '<string>',
source_deal_data: null,
auto_renew: true,
auto_renew_duration: -1,
auto_renew_invoice: true,
tag_ids: [0],
tag_group_ids: [0],
minimum_monthly_commitment_amount: 0,
minimum_monthly_commitment_quantity: 0,
purchase_order_number: '<string>',
entity: 123,
client: 123,
default_payment_term: 123,
department: 123,
journal_entries: [123]
})
};
fetch('https://api.meetcampfire.com/rr/api/v1/contracts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meetcampfire.com/rr/api/v1/contracts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tags' => '<string>',
'currency' => 'USD',
'prepaid_commits' => [
[
'name' => '<string>',
'total_value' => 0,
'start_date' => '2023-12-25',
'entity' => 123,
'product' => 123,
'invoice_basis' => 'fixed_commitment',
'first_invoice_date' => '2023-12-25',
'billing_payment_term' => 123,
'description' => '',
'currency' => '<string>',
'exchange_rate' => 0,
'exchange_rate_book' => 0,
'discount_percentage' => 0,
'rate' => 0,
'expiration_date' => '2023-12-25',
'priority' => 1,
'subledger' => 123,
'auto_send_overage_invoices' => false,
'overage_invoice_start_month' => '2023-12-25',
'department' => 123,
'tags' => [
123
]
]
],
'contract_end_date' => '2023-12-25',
'is_evergreen' => false,
'auto_send_invoices' => false,
'skip_evergreen_invoice_generation' => false,
'auto_apply_customer_stripe_config_to_invoices' => false,
'usage_tiers' => '<string>',
'deal_name' => '<string>',
'deal_id' => '<string>',
'consultant' => '<string>',
'closed_date' => '2023-12-25',
'total_contract_value' => 0,
'contract_start_date' => '2023-12-25',
'exchange_rate' => 0,
'exchange_rate_book' => 0,
'crm_link' => '<string>',
'contract_link' => '<string>',
'source_deal_data' => null,
'auto_renew' => true,
'auto_renew_duration' => -1,
'auto_renew_invoice' => true,
'tag_ids' => [
0
],
'tag_group_ids' => [
0
],
'minimum_monthly_commitment_amount' => 0,
'minimum_monthly_commitment_quantity' => 0,
'purchase_order_number' => '<string>',
'entity' => 123,
'client' => 123,
'default_payment_term' => 123,
'department' => 123,
'journal_entries' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/rr/api/v1/contracts/{id}"
payload := strings.NewReader("{\n \"tags\": \"<string>\",\n \"currency\": \"USD\",\n \"prepaid_commits\": [\n {\n \"name\": \"<string>\",\n \"total_value\": 0,\n \"start_date\": \"2023-12-25\",\n \"entity\": 123,\n \"product\": 123,\n \"invoice_basis\": \"fixed_commitment\",\n \"first_invoice_date\": \"2023-12-25\",\n \"billing_payment_term\": 123,\n \"description\": \"\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"discount_percentage\": 0,\n \"rate\": 0,\n \"expiration_date\": \"2023-12-25\",\n \"priority\": 1,\n \"subledger\": 123,\n \"auto_send_overage_invoices\": false,\n \"overage_invoice_start_month\": \"2023-12-25\",\n \"department\": 123,\n \"tags\": [\n 123\n ]\n }\n ],\n \"contract_end_date\": \"2023-12-25\",\n \"is_evergreen\": false,\n \"auto_send_invoices\": false,\n \"skip_evergreen_invoice_generation\": false,\n \"auto_apply_customer_stripe_config_to_invoices\": false,\n \"usage_tiers\": \"<string>\",\n \"deal_name\": \"<string>\",\n \"deal_id\": \"<string>\",\n \"consultant\": \"<string>\",\n \"closed_date\": \"2023-12-25\",\n \"total_contract_value\": 0,\n \"contract_start_date\": \"2023-12-25\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"crm_link\": \"<string>\",\n \"contract_link\": \"<string>\",\n \"source_deal_data\": null,\n \"auto_renew\": true,\n \"auto_renew_duration\": -1,\n \"auto_renew_invoice\": true,\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"minimum_monthly_commitment_amount\": 0,\n \"minimum_monthly_commitment_quantity\": 0,\n \"purchase_order_number\": \"<string>\",\n \"entity\": 123,\n \"client\": 123,\n \"default_payment_term\": 123,\n \"department\": 123,\n \"journal_entries\": [\n 123\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.meetcampfire.com/rr/api/v1/contracts/{id}")
.header("Content-Type", "application/json")
.body("{\n \"tags\": \"<string>\",\n \"currency\": \"USD\",\n \"prepaid_commits\": [\n {\n \"name\": \"<string>\",\n \"total_value\": 0,\n \"start_date\": \"2023-12-25\",\n \"entity\": 123,\n \"product\": 123,\n \"invoice_basis\": \"fixed_commitment\",\n \"first_invoice_date\": \"2023-12-25\",\n \"billing_payment_term\": 123,\n \"description\": \"\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"discount_percentage\": 0,\n \"rate\": 0,\n \"expiration_date\": \"2023-12-25\",\n \"priority\": 1,\n \"subledger\": 123,\n \"auto_send_overage_invoices\": false,\n \"overage_invoice_start_month\": \"2023-12-25\",\n \"department\": 123,\n \"tags\": [\n 123\n ]\n }\n ],\n \"contract_end_date\": \"2023-12-25\",\n \"is_evergreen\": false,\n \"auto_send_invoices\": false,\n \"skip_evergreen_invoice_generation\": false,\n \"auto_apply_customer_stripe_config_to_invoices\": false,\n \"usage_tiers\": \"<string>\",\n \"deal_name\": \"<string>\",\n \"deal_id\": \"<string>\",\n \"consultant\": \"<string>\",\n \"closed_date\": \"2023-12-25\",\n \"total_contract_value\": 0,\n \"contract_start_date\": \"2023-12-25\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"crm_link\": \"<string>\",\n \"contract_link\": \"<string>\",\n \"source_deal_data\": null,\n \"auto_renew\": true,\n \"auto_renew_duration\": -1,\n \"auto_renew_invoice\": true,\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"minimum_monthly_commitment_amount\": 0,\n \"minimum_monthly_commitment_quantity\": 0,\n \"purchase_order_number\": \"<string>\",\n \"entity\": 123,\n \"client\": 123,\n \"default_payment_term\": 123,\n \"department\": 123,\n \"journal_entries\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/rr/api/v1/contracts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": \"<string>\",\n \"currency\": \"USD\",\n \"prepaid_commits\": [\n {\n \"name\": \"<string>\",\n \"total_value\": 0,\n \"start_date\": \"2023-12-25\",\n \"entity\": 123,\n \"product\": 123,\n \"invoice_basis\": \"fixed_commitment\",\n \"first_invoice_date\": \"2023-12-25\",\n \"billing_payment_term\": 123,\n \"description\": \"\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"discount_percentage\": 0,\n \"rate\": 0,\n \"expiration_date\": \"2023-12-25\",\n \"priority\": 1,\n \"subledger\": 123,\n \"auto_send_overage_invoices\": false,\n \"overage_invoice_start_month\": \"2023-12-25\",\n \"department\": 123,\n \"tags\": [\n 123\n ]\n }\n ],\n \"contract_end_date\": \"2023-12-25\",\n \"is_evergreen\": false,\n \"auto_send_invoices\": false,\n \"skip_evergreen_invoice_generation\": false,\n \"auto_apply_customer_stripe_config_to_invoices\": false,\n \"usage_tiers\": \"<string>\",\n \"deal_name\": \"<string>\",\n \"deal_id\": \"<string>\",\n \"consultant\": \"<string>\",\n \"closed_date\": \"2023-12-25\",\n \"total_contract_value\": 0,\n \"contract_start_date\": \"2023-12-25\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"crm_link\": \"<string>\",\n \"contract_link\": \"<string>\",\n \"source_deal_data\": null,\n \"auto_renew\": true,\n \"auto_renew_duration\": -1,\n \"auto_renew_invoice\": true,\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"minimum_monthly_commitment_amount\": 0,\n \"minimum_monthly_commitment_quantity\": 0,\n \"purchase_order_number\": \"<string>\",\n \"entity\": 123,\n \"client\": 123,\n \"default_payment_term\": 123,\n \"department\": 123,\n \"journal_entries\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"entity_name": "<string>",
"client_name": "<string>",
"client_campfire_id": "<string>",
"client_terms": "<string>",
"default_payment_term_name": "<string>",
"department_name": "<string>",
"parent_department_name": "<string>",
"parent_department": 123,
"total_revenue": 0,
"total_mrr": 0,
"total_deferred_revenue": 0,
"entity_currency": "<string>",
"attachments": [
{
"id": 123,
"customer": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"created_by_name": "<string>",
"created_by_email": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"url": "<string>",
"s3_path": "<string>",
"app": "<string>",
"model": "<string>",
"is_deleted": false,
"deleted_at": "2023-11-07T05:31:56Z",
"s3_content_type": "<string>",
"s3_content_length": 1073741823,
"object_id": 1073741823
}
],
"last_modified_at": "2023-11-07T05:31:56Z",
"is_deleted": "<string>",
"deleted_at": "<string>",
"has_invoices": false,
"has_journal_entries": false,
"has_credit_memos": false,
"effective_end_date": "2023-12-25",
"working_end_date": "2023-12-25",
"evergreen_locked_date": "2023-12-25",
"search_vector": "<string>",
"search_text": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"customer": 123,
"tags": "<string>",
"currency": "USD",
"contract_end_date": "2023-12-25",
"is_evergreen": false,
"auto_send_invoices": false,
"skip_evergreen_invoice_generation": false,
"auto_apply_customer_stripe_config_to_invoices": false,
"usage_tiers": "<string>",
"billing_frequency": "monthly",
"deal_name": "<string>",
"deal_id": "<string>",
"consultant": "<string>",
"closed_date": "2023-12-25",
"total_contract_value": 0,
"contract_start_date": "2023-12-25",
"exchange_rate": 0,
"exchange_rate_book": 0,
"crm_link": "<string>",
"contract_link": "<string>",
"status": "ACTIVE",
"source": "SALESFORCE",
"source_deal_data": null,
"auto_renew": true,
"auto_renew_duration": -1,
"auto_renew_invoice": true,
"evergreen_date_boundary_mode": "CONTRACT_PERIOD",
"tag_ids": [
0
],
"tag_group_ids": [
0
],
"minimum_monthly_commitment_amount": 0,
"minimum_monthly_commitment_quantity": 0,
"purchase_order_number": "<string>",
"entity": 123,
"client": 123,
"default_payment_term": 123,
"department": 123,
"journal_entries": [
123
]
}Revenue Recognition
Partial Update Contract
PATCH
/
rr
/
api
/
v1
/
contracts
/
{id}
Partial Update Contract
curl --request PATCH \
--url https://api.meetcampfire.com/rr/api/v1/contracts/{id} \
--header 'Content-Type: application/json' \
--data '
{
"tags": "<string>",
"currency": "USD",
"prepaid_commits": [
{
"name": "<string>",
"total_value": 0,
"start_date": "2023-12-25",
"entity": 123,
"product": 123,
"invoice_basis": "fixed_commitment",
"first_invoice_date": "2023-12-25",
"billing_payment_term": 123,
"description": "",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"discount_percentage": 0,
"rate": 0,
"expiration_date": "2023-12-25",
"priority": 1,
"subledger": 123,
"auto_send_overage_invoices": false,
"overage_invoice_start_month": "2023-12-25",
"department": 123,
"tags": [
123
]
}
],
"contract_end_date": "2023-12-25",
"is_evergreen": false,
"auto_send_invoices": false,
"skip_evergreen_invoice_generation": false,
"auto_apply_customer_stripe_config_to_invoices": false,
"usage_tiers": "<string>",
"deal_name": "<string>",
"deal_id": "<string>",
"consultant": "<string>",
"closed_date": "2023-12-25",
"total_contract_value": 0,
"contract_start_date": "2023-12-25",
"exchange_rate": 0,
"exchange_rate_book": 0,
"crm_link": "<string>",
"contract_link": "<string>",
"source_deal_data": null,
"auto_renew": true,
"auto_renew_duration": -1,
"auto_renew_invoice": true,
"tag_ids": [
0
],
"tag_group_ids": [
0
],
"minimum_monthly_commitment_amount": 0,
"minimum_monthly_commitment_quantity": 0,
"purchase_order_number": "<string>",
"entity": 123,
"client": 123,
"default_payment_term": 123,
"department": 123,
"journal_entries": [
123
]
}
'import requests
url = "https://api.meetcampfire.com/rr/api/v1/contracts/{id}"
payload = {
"tags": "<string>",
"currency": "USD",
"prepaid_commits": [
{
"name": "<string>",
"total_value": 0,
"start_date": "2023-12-25",
"entity": 123,
"product": 123,
"invoice_basis": "fixed_commitment",
"first_invoice_date": "2023-12-25",
"billing_payment_term": 123,
"description": "",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"discount_percentage": 0,
"rate": 0,
"expiration_date": "2023-12-25",
"priority": 1,
"subledger": 123,
"auto_send_overage_invoices": False,
"overage_invoice_start_month": "2023-12-25",
"department": 123,
"tags": [123]
}
],
"contract_end_date": "2023-12-25",
"is_evergreen": False,
"auto_send_invoices": False,
"skip_evergreen_invoice_generation": False,
"auto_apply_customer_stripe_config_to_invoices": False,
"usage_tiers": "<string>",
"deal_name": "<string>",
"deal_id": "<string>",
"consultant": "<string>",
"closed_date": "2023-12-25",
"total_contract_value": 0,
"contract_start_date": "2023-12-25",
"exchange_rate": 0,
"exchange_rate_book": 0,
"crm_link": "<string>",
"contract_link": "<string>",
"source_deal_data": None,
"auto_renew": True,
"auto_renew_duration": -1,
"auto_renew_invoice": True,
"tag_ids": [0],
"tag_group_ids": [0],
"minimum_monthly_commitment_amount": 0,
"minimum_monthly_commitment_quantity": 0,
"purchase_order_number": "<string>",
"entity": 123,
"client": 123,
"default_payment_term": 123,
"department": 123,
"journal_entries": [123]
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
tags: '<string>',
currency: 'USD',
prepaid_commits: [
{
name: '<string>',
total_value: 0,
start_date: '2023-12-25',
entity: 123,
product: 123,
invoice_basis: 'fixed_commitment',
first_invoice_date: '2023-12-25',
billing_payment_term: 123,
description: '',
currency: '<string>',
exchange_rate: 0,
exchange_rate_book: 0,
discount_percentage: 0,
rate: 0,
expiration_date: '2023-12-25',
priority: 1,
subledger: 123,
auto_send_overage_invoices: false,
overage_invoice_start_month: '2023-12-25',
department: 123,
tags: [123]
}
],
contract_end_date: '2023-12-25',
is_evergreen: false,
auto_send_invoices: false,
skip_evergreen_invoice_generation: false,
auto_apply_customer_stripe_config_to_invoices: false,
usage_tiers: '<string>',
deal_name: '<string>',
deal_id: '<string>',
consultant: '<string>',
closed_date: '2023-12-25',
total_contract_value: 0,
contract_start_date: '2023-12-25',
exchange_rate: 0,
exchange_rate_book: 0,
crm_link: '<string>',
contract_link: '<string>',
source_deal_data: null,
auto_renew: true,
auto_renew_duration: -1,
auto_renew_invoice: true,
tag_ids: [0],
tag_group_ids: [0],
minimum_monthly_commitment_amount: 0,
minimum_monthly_commitment_quantity: 0,
purchase_order_number: '<string>',
entity: 123,
client: 123,
default_payment_term: 123,
department: 123,
journal_entries: [123]
})
};
fetch('https://api.meetcampfire.com/rr/api/v1/contracts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meetcampfire.com/rr/api/v1/contracts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tags' => '<string>',
'currency' => 'USD',
'prepaid_commits' => [
[
'name' => '<string>',
'total_value' => 0,
'start_date' => '2023-12-25',
'entity' => 123,
'product' => 123,
'invoice_basis' => 'fixed_commitment',
'first_invoice_date' => '2023-12-25',
'billing_payment_term' => 123,
'description' => '',
'currency' => '<string>',
'exchange_rate' => 0,
'exchange_rate_book' => 0,
'discount_percentage' => 0,
'rate' => 0,
'expiration_date' => '2023-12-25',
'priority' => 1,
'subledger' => 123,
'auto_send_overage_invoices' => false,
'overage_invoice_start_month' => '2023-12-25',
'department' => 123,
'tags' => [
123
]
]
],
'contract_end_date' => '2023-12-25',
'is_evergreen' => false,
'auto_send_invoices' => false,
'skip_evergreen_invoice_generation' => false,
'auto_apply_customer_stripe_config_to_invoices' => false,
'usage_tiers' => '<string>',
'deal_name' => '<string>',
'deal_id' => '<string>',
'consultant' => '<string>',
'closed_date' => '2023-12-25',
'total_contract_value' => 0,
'contract_start_date' => '2023-12-25',
'exchange_rate' => 0,
'exchange_rate_book' => 0,
'crm_link' => '<string>',
'contract_link' => '<string>',
'source_deal_data' => null,
'auto_renew' => true,
'auto_renew_duration' => -1,
'auto_renew_invoice' => true,
'tag_ids' => [
0
],
'tag_group_ids' => [
0
],
'minimum_monthly_commitment_amount' => 0,
'minimum_monthly_commitment_quantity' => 0,
'purchase_order_number' => '<string>',
'entity' => 123,
'client' => 123,
'default_payment_term' => 123,
'department' => 123,
'journal_entries' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/rr/api/v1/contracts/{id}"
payload := strings.NewReader("{\n \"tags\": \"<string>\",\n \"currency\": \"USD\",\n \"prepaid_commits\": [\n {\n \"name\": \"<string>\",\n \"total_value\": 0,\n \"start_date\": \"2023-12-25\",\n \"entity\": 123,\n \"product\": 123,\n \"invoice_basis\": \"fixed_commitment\",\n \"first_invoice_date\": \"2023-12-25\",\n \"billing_payment_term\": 123,\n \"description\": \"\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"discount_percentage\": 0,\n \"rate\": 0,\n \"expiration_date\": \"2023-12-25\",\n \"priority\": 1,\n \"subledger\": 123,\n \"auto_send_overage_invoices\": false,\n \"overage_invoice_start_month\": \"2023-12-25\",\n \"department\": 123,\n \"tags\": [\n 123\n ]\n }\n ],\n \"contract_end_date\": \"2023-12-25\",\n \"is_evergreen\": false,\n \"auto_send_invoices\": false,\n \"skip_evergreen_invoice_generation\": false,\n \"auto_apply_customer_stripe_config_to_invoices\": false,\n \"usage_tiers\": \"<string>\",\n \"deal_name\": \"<string>\",\n \"deal_id\": \"<string>\",\n \"consultant\": \"<string>\",\n \"closed_date\": \"2023-12-25\",\n \"total_contract_value\": 0,\n \"contract_start_date\": \"2023-12-25\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"crm_link\": \"<string>\",\n \"contract_link\": \"<string>\",\n \"source_deal_data\": null,\n \"auto_renew\": true,\n \"auto_renew_duration\": -1,\n \"auto_renew_invoice\": true,\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"minimum_monthly_commitment_amount\": 0,\n \"minimum_monthly_commitment_quantity\": 0,\n \"purchase_order_number\": \"<string>\",\n \"entity\": 123,\n \"client\": 123,\n \"default_payment_term\": 123,\n \"department\": 123,\n \"journal_entries\": [\n 123\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.meetcampfire.com/rr/api/v1/contracts/{id}")
.header("Content-Type", "application/json")
.body("{\n \"tags\": \"<string>\",\n \"currency\": \"USD\",\n \"prepaid_commits\": [\n {\n \"name\": \"<string>\",\n \"total_value\": 0,\n \"start_date\": \"2023-12-25\",\n \"entity\": 123,\n \"product\": 123,\n \"invoice_basis\": \"fixed_commitment\",\n \"first_invoice_date\": \"2023-12-25\",\n \"billing_payment_term\": 123,\n \"description\": \"\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"discount_percentage\": 0,\n \"rate\": 0,\n \"expiration_date\": \"2023-12-25\",\n \"priority\": 1,\n \"subledger\": 123,\n \"auto_send_overage_invoices\": false,\n \"overage_invoice_start_month\": \"2023-12-25\",\n \"department\": 123,\n \"tags\": [\n 123\n ]\n }\n ],\n \"contract_end_date\": \"2023-12-25\",\n \"is_evergreen\": false,\n \"auto_send_invoices\": false,\n \"skip_evergreen_invoice_generation\": false,\n \"auto_apply_customer_stripe_config_to_invoices\": false,\n \"usage_tiers\": \"<string>\",\n \"deal_name\": \"<string>\",\n \"deal_id\": \"<string>\",\n \"consultant\": \"<string>\",\n \"closed_date\": \"2023-12-25\",\n \"total_contract_value\": 0,\n \"contract_start_date\": \"2023-12-25\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"crm_link\": \"<string>\",\n \"contract_link\": \"<string>\",\n \"source_deal_data\": null,\n \"auto_renew\": true,\n \"auto_renew_duration\": -1,\n \"auto_renew_invoice\": true,\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"minimum_monthly_commitment_amount\": 0,\n \"minimum_monthly_commitment_quantity\": 0,\n \"purchase_order_number\": \"<string>\",\n \"entity\": 123,\n \"client\": 123,\n \"default_payment_term\": 123,\n \"department\": 123,\n \"journal_entries\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/rr/api/v1/contracts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"tags\": \"<string>\",\n \"currency\": \"USD\",\n \"prepaid_commits\": [\n {\n \"name\": \"<string>\",\n \"total_value\": 0,\n \"start_date\": \"2023-12-25\",\n \"entity\": 123,\n \"product\": 123,\n \"invoice_basis\": \"fixed_commitment\",\n \"first_invoice_date\": \"2023-12-25\",\n \"billing_payment_term\": 123,\n \"description\": \"\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"discount_percentage\": 0,\n \"rate\": 0,\n \"expiration_date\": \"2023-12-25\",\n \"priority\": 1,\n \"subledger\": 123,\n \"auto_send_overage_invoices\": false,\n \"overage_invoice_start_month\": \"2023-12-25\",\n \"department\": 123,\n \"tags\": [\n 123\n ]\n }\n ],\n \"contract_end_date\": \"2023-12-25\",\n \"is_evergreen\": false,\n \"auto_send_invoices\": false,\n \"skip_evergreen_invoice_generation\": false,\n \"auto_apply_customer_stripe_config_to_invoices\": false,\n \"usage_tiers\": \"<string>\",\n \"deal_name\": \"<string>\",\n \"deal_id\": \"<string>\",\n \"consultant\": \"<string>\",\n \"closed_date\": \"2023-12-25\",\n \"total_contract_value\": 0,\n \"contract_start_date\": \"2023-12-25\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"crm_link\": \"<string>\",\n \"contract_link\": \"<string>\",\n \"source_deal_data\": null,\n \"auto_renew\": true,\n \"auto_renew_duration\": -1,\n \"auto_renew_invoice\": true,\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"minimum_monthly_commitment_amount\": 0,\n \"minimum_monthly_commitment_quantity\": 0,\n \"purchase_order_number\": \"<string>\",\n \"entity\": 123,\n \"client\": 123,\n \"default_payment_term\": 123,\n \"department\": 123,\n \"journal_entries\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"entity_name": "<string>",
"client_name": "<string>",
"client_campfire_id": "<string>",
"client_terms": "<string>",
"default_payment_term_name": "<string>",
"department_name": "<string>",
"parent_department_name": "<string>",
"parent_department": 123,
"total_revenue": 0,
"total_mrr": 0,
"total_deferred_revenue": 0,
"entity_currency": "<string>",
"attachments": [
{
"id": 123,
"customer": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"created_by_name": "<string>",
"created_by_email": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"url": "<string>",
"s3_path": "<string>",
"app": "<string>",
"model": "<string>",
"is_deleted": false,
"deleted_at": "2023-11-07T05:31:56Z",
"s3_content_type": "<string>",
"s3_content_length": 1073741823,
"object_id": 1073741823
}
],
"last_modified_at": "2023-11-07T05:31:56Z",
"is_deleted": "<string>",
"deleted_at": "<string>",
"has_invoices": false,
"has_journal_entries": false,
"has_credit_memos": false,
"effective_end_date": "2023-12-25",
"working_end_date": "2023-12-25",
"evergreen_locked_date": "2023-12-25",
"search_vector": "<string>",
"search_text": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"customer": 123,
"tags": "<string>",
"currency": "USD",
"contract_end_date": "2023-12-25",
"is_evergreen": false,
"auto_send_invoices": false,
"skip_evergreen_invoice_generation": false,
"auto_apply_customer_stripe_config_to_invoices": false,
"usage_tiers": "<string>",
"billing_frequency": "monthly",
"deal_name": "<string>",
"deal_id": "<string>",
"consultant": "<string>",
"closed_date": "2023-12-25",
"total_contract_value": 0,
"contract_start_date": "2023-12-25",
"exchange_rate": 0,
"exchange_rate_book": 0,
"crm_link": "<string>",
"contract_link": "<string>",
"status": "ACTIVE",
"source": "SALESFORCE",
"source_deal_data": null,
"auto_renew": true,
"auto_renew_duration": -1,
"auto_renew_invoice": true,
"evergreen_date_boundary_mode": "CONTRACT_PERIOD",
"tag_ids": [
0
],
"tag_group_ids": [
0
],
"minimum_monthly_commitment_amount": 0,
"minimum_monthly_commitment_quantity": 0,
"purchase_order_number": "<string>",
"entity": 123,
"client": 123,
"default_payment_term": 123,
"department": 123,
"journal_entries": [
123
]
}Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Show child attributes
Show child attributes
Fixed end date for standard contracts. Leave null for evergreen contracts (is_evergreen=true).
Set true for evergreen contracts (no fixed end date). Evergreen contracts cannot also be auto-renew. Auto-renew is a legacy method to extend contracts.
When true, generated invoices are automatically sent on their invoice date.
For Evergreen contracts only. Set at contract creation; existing contracts cannot change this setting. False means current behavior. True skips only Campfire's auto-generated evergreen invoices; revenue transactions still generate; existing invoices are not cleaned up.
Evergreen contracts only. When true, evergreen-generated invoices inherit stripe_connection and use_stripe_auto_bill from the contract customer.
monthly- Monthlyquarterly- Quarterlybiannual- Bi Annualyannual- Annualone_time- One Timecustom- Custom
Available options:
monthly, quarterly, biannual, annual, one_time, custom Maximum string length:
250Maximum string length:
250Maximum string length:
250Required range:
-1000000000000000000 < x < 1000000000000000000Required range:
-100000000000000 < x < 100000000000000Required range:
-100000000000000 < x < 100000000000000Maximum string length:
500Maximum string length:
500ACTIVE- ActivePENDING- PendingCOMPLETED- CompletedDELETED- Deleted
Available options:
ACTIVE, PENDING, COMPLETED, DELETED SALESFORCE- SalesforceHUBSPOT- HubspotSTRIPE- StripeMANUAL- Manual
Available options:
SALESFORCE, HUBSPOT, STRIPE, MANUAL Required range:
-2147483648 <= x <= 2147483647Controls evergreen subscription date boundaries. CONTRACT_PERIOD preserves contract billing-period alignment; EXACT_DATE uses the subscriptions' exact service dates.
CONTRACT_PERIOD- Contract billing periodEXACT_DATE- Exact service dates
Available options:
CONTRACT_PERIOD, EXACT_DATE Required range:
-9223372036854776000 <= x <= 9223372036854776000Required range:
-9223372036854776000 <= x <= 9223372036854776000Minimum monthly commitment amount (allowance threshold)
Required range:
-1000000000000000000 < x < 1000000000000000000Minimum monthly commitment quantity (allowance threshold in units)
Required range:
-1000000000000000000 < x < 1000000000000000000Maximum string length:
120Contract-level default payment term for generated invoices. Currently applied only to automatically generated Evergreen invoices; other contract invoice flows retain their existing payment-term selection behavior. Support may be extended to additional contract types in the future.
Response
200 - application/json
Required range:
-10000000000000 < x < 10000000000000Required range:
-10000000000000 < x < 10000000000000Required range:
-10000000000000 < x < 10000000000000Show child attributes
Show child attributes
Rolling horizon end date for active evergreen contracts. It will be auto-generated by Campfire backend. Null for standard contracts.
Canonical end date used by the system. Equals contract_end_date for standard or terminated contracts, and effective_end_date for active evergreen contracts.
Inclusive lock date for evergreen contracts based on paid invoices and close books date. Dates on or before this value are immutable. Null for non-evergreen contracts, or when no financial locking events exist.
Fixed end date for standard contracts. Leave null for evergreen contracts (is_evergreen=true).
Set true for evergreen contracts (no fixed end date). Evergreen contracts cannot also be auto-renew. Auto-renew is a legacy method to extend contracts.
When true, generated invoices are automatically sent on their invoice date.
For Evergreen contracts only. Set at contract creation; existing contracts cannot change this setting. False means current behavior. True skips only Campfire's auto-generated evergreen invoices; revenue transactions still generate; existing invoices are not cleaned up.
Evergreen contracts only. When true, evergreen-generated invoices inherit stripe_connection and use_stripe_auto_bill from the contract customer.
monthly- Monthlyquarterly- Quarterlybiannual- Bi Annualyannual- Annualone_time- One Timecustom- Custom
Available options:
monthly, quarterly, biannual, annual, one_time, custom Maximum string length:
250Maximum string length:
250Maximum string length:
250Required range:
-1000000000000000000 < x < 1000000000000000000Required range:
-100000000000000 < x < 100000000000000Required range:
-100000000000000 < x < 100000000000000Maximum string length:
500Maximum string length:
500ACTIVE- ActivePENDING- PendingCOMPLETED- CompletedDELETED- Deleted
Available options:
ACTIVE, PENDING, COMPLETED, DELETED SALESFORCE- SalesforceHUBSPOT- HubspotSTRIPE- StripeMANUAL- Manual
Available options:
SALESFORCE, HUBSPOT, STRIPE, MANUAL Required range:
-2147483648 <= x <= 2147483647Controls evergreen subscription date boundaries. CONTRACT_PERIOD preserves contract billing-period alignment; EXACT_DATE uses the subscriptions' exact service dates.
CONTRACT_PERIOD- Contract billing periodEXACT_DATE- Exact service dates
Available options:
CONTRACT_PERIOD, EXACT_DATE Required range:
-9223372036854776000 <= x <= 9223372036854776000Required range:
-9223372036854776000 <= x <= 9223372036854776000Minimum monthly commitment amount (allowance threshold)
Required range:
-1000000000000000000 < x < 1000000000000000000Minimum monthly commitment quantity (allowance threshold in units)
Required range:
-1000000000000000000 < x < 1000000000000000000Maximum string length:
120Contract-level default payment term for generated invoices. Currently applied only to automatically generated Evergreen invoices; other contract invoice flows retain their existing payment-term selection behavior. Support may be extended to additional contract types in the future.