curl --request GET \
--url https://api.meetcampfire.com/rev/api/v1/contracts/{id}import requests
url = "https://api.meetcampfire.com/rev/api/v1/contracts/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.meetcampfire.com/rev/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/rev/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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/rev/api/v1/contracts/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.meetcampfire.com/rev/api/v1/contracts/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/rev/api/v1/contracts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": 123,
"contract_number": "<string>",
"name": "<string>",
"entity_name": "<string>",
"client_name": "<string>",
"department_name": "<string>",
"payment_term_name": "",
"stripe_connection_name": "",
"deferred_revenue_account_name": "",
"unbilled_ar_account_name": "",
"revenue_recognition_account_name": "",
"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
}
],
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"status": "PENDING_REVIEW",
"entity": 123,
"client": 123,
"source": "SALESFORCE",
"consultant": "<string>",
"crm_opportunity_id": "<string>",
"crm_link": "<string>",
"contract_link": "<string>",
"purchase_order_number": "<string>",
"billing_address": "<string>",
"billing_addressee": "<string>",
"shipping_address": "<string>",
"shipping_addressee": "<string>",
"invoice_message": "<string>",
"invoice_email": "jsmith@example.com",
"invoice_cc_emails": "<string>",
"department": 123,
"tags": [
123
],
"execution_date": "2023-12-25",
"service_start": "2023-12-25",
"service_end": "2023-12-25",
"terminated_date": "2023-12-25",
"currency": "<string>",
"termination_notice_days": 1073741823,
"payment_term": 123,
"creation_policy": "CREATE_ALL_NOW",
"sending_policy": "SEND_AUTOMATICALLY",
"stripe_connection": 123,
"use_stripe_auto_bill": true,
"renewal_behavior": "NONE",
"header_discount": 0,
"deferred_revenue_account": 123,
"unbilled_ar_account": 123,
"revenue_recognition_account": 123,
"renewed_into": 123,
"custom_schedule": [
{
"invoice_date": "2023-12-25",
"amount": 5000000000000,
"id": 123,
"ordinal": 1073741823
}
]
}Retrieve Revenue Contract
curl --request GET \
--url https://api.meetcampfire.com/rev/api/v1/contracts/{id}import requests
url = "https://api.meetcampfire.com/rev/api/v1/contracts/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.meetcampfire.com/rev/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/rev/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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/rev/api/v1/contracts/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.meetcampfire.com/rev/api/v1/contracts/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/rev/api/v1/contracts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": 123,
"contract_number": "<string>",
"name": "<string>",
"entity_name": "<string>",
"client_name": "<string>",
"department_name": "<string>",
"payment_term_name": "",
"stripe_connection_name": "",
"deferred_revenue_account_name": "",
"unbilled_ar_account_name": "",
"revenue_recognition_account_name": "",
"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
}
],
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"status": "PENDING_REVIEW",
"entity": 123,
"client": 123,
"source": "SALESFORCE",
"consultant": "<string>",
"crm_opportunity_id": "<string>",
"crm_link": "<string>",
"contract_link": "<string>",
"purchase_order_number": "<string>",
"billing_address": "<string>",
"billing_addressee": "<string>",
"shipping_address": "<string>",
"shipping_addressee": "<string>",
"invoice_message": "<string>",
"invoice_email": "jsmith@example.com",
"invoice_cc_emails": "<string>",
"department": 123,
"tags": [
123
],
"execution_date": "2023-12-25",
"service_start": "2023-12-25",
"service_end": "2023-12-25",
"terminated_date": "2023-12-25",
"currency": "<string>",
"termination_notice_days": 1073741823,
"payment_term": 123,
"creation_policy": "CREATE_ALL_NOW",
"sending_policy": "SEND_AUTOMATICALLY",
"stripe_connection": 123,
"use_stripe_auto_bill": true,
"renewal_behavior": "NONE",
"header_discount": 0,
"deferred_revenue_account": 123,
"unbilled_ar_account": 123,
"revenue_recognition_account": 123,
"renewed_into": 123,
"custom_schedule": [
{
"invoice_date": "2023-12-25",
"amount": 5000000000000,
"id": 123,
"ordinal": 1073741823
}
]
}Path Parameters
Response
Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.
Sequential per-customer contract number (e.g. CTR-0000001), assigned at creation.
255Show child attributes
Show child attributes
PENDING_REVIEW- Pending reviewACTIVE- ActiveCOMPLETED- Fully recognizedEARLY_RENEWED- Early-renewedTERMINATED- Terminated
PENDING_REVIEW, ACTIVE, COMPLETED, EARLY_RENEWED, TERMINATED SALESFORCE- SalesforceHUBSPOT- HubspotSTRIPE- StripeMANUAL- Manual
SALESFORCE, HUBSPOT, STRIPE, MANUAL 250255500500120Bill-to address for invoices from this contract. Defaults from the client; editable per contract.
Bill-to addressee for invoices from this contract. Defaults from the client; editable per contract.
255Ship-to address for invoices from this contract. Defaults from the client; editable per contract.
Ship-to addressee for invoices from this contract. Defaults from the client; editable per contract.
255Message printed on invoices from this contract. Defaults from the client; editable per contract.
254Comma-separated addresses copied on invoices from this contract.
30 <= x <= 2147483647Payment terms for generated invoices; lines snapshot its days. None means due on receipt.
When this contract is Active, whether AR invoices and GL journals are created from the schedule all at once or on each invoice/posting date.
CREATE_ALL_NOW- Create on ApprovalCREATE_ON_DATE- Create On Invoice Date/Posting Date
CREATE_ALL_NOW, CREATE_ON_DATE When AR invoices are created from this contract, whether they send automatically or stay unsent.
SEND_AUTOMATICALLY- Send AutomaticallySEND_MANUALLY- Send Manually
SEND_AUTOMATICALLY, SEND_MANUALLY Stripe connection copied onto AR invoices issued from this contract.
When true, issued AR invoices auto-charge the client's default Stripe payment method.
NONE- NoneAUTO_RENEW- Auto-renewMANUAL- Manual renewal
NONE, AUTO_RENEW, MANUAL -10000000000000 < x < 10000000000000Deferred revenue account for this contract's schedule entries whose obligation carries none.
Unbilled accounts receivable account for this contract's schedule entries.
Fallback revenue account for obligations whose product carries no revenue account.
Show child attributes
Show child attributes