Skip to main content
GET
/
rr
/
api
/
v1
/
contracts
/
{id}
Retrieve Contract
curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/contracts/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "entity_name": "<string>",
  "client_name": "<string>",
  "client_terms": "<string>",
  "department_name": "<string>",
  "parent_department_name": "<string>",
  "parent_department": 123,
  "tags": "<string>",
  "total_revenue": 0,
  "total_mrr": 0,
  "total_billed": 0,
  "total_unbilled": 0,
  "total_paid": 0,
  "total_outstanding": 0,
  "total_deferred_revenue": 0,
  "currency": "USD",
  "entity_currency": "USD",
  "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_content_type": "<string>",
      "s3_content_length": 1073741823,
      "s3_path": "<string>",
      "object_id": 1073741823,
      "app": "<string>",
      "model": "<string>",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ],
  "contract_end_date": "2023-12-25",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "is_deleted": "<string>",
  "deleted_at": "<string>",
  "search_vector": "<string>",
  "search_text": "<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",
  "created_at": "2023-11-07T05:31:56Z",
  "auto_renew": true,
  "auto_renew_duration": -1,
  "auto_renew_invoice": true,
  "customer": 123,
  "entity": 123,
  "client": 123,
  "department": 123,
  "journal_entries": [
    123
  ]
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Response

200 - application/json
id
integer
required
entity_name
string
required
client_name
string
required
client_terms
string
required
department_name
string
required
parent_department_name
string
required
parent_department
integer
required
total_revenue
number
required
Required range: -10000000000000 < x < 10000000000000
total_mrr
number
required
Required range: -10000000000000 < x < 10000000000000
total_billed
number
required
Required range: -10000000000000 < x < 10000000000000
total_unbilled
number
required
Required range: -10000000000000 < x < 10000000000000
total_paid
number
required
Required range: -10000000000000 < x < 10000000000000
total_outstanding
number
required
Required range: -10000000000000 < x < 10000000000000
total_deferred_revenue
number
required
Required range: -10000000000000 < x < 10000000000000
attachments
object[]
required
last_modified_at
string<date-time>
required
is_deleted
string
required
deleted_at
string
required
search_vector
string | null
required
search_text
string | null
required
created_at
string<date-time>
required
customer
integer
required
tags
string
currency
string
default:USD
entity_currency
string
default:USD
contract_end_date
string<date> | null
billing_frequency
enum<string>
  • monthly - Monthly
  • quarterly - Quarterly
  • biannual - Bi Annualy
  • annual - Annual
Available options:
monthly,
quarterly,
biannual,
annual
deal_name
string | null
Maximum length: 250
deal_id
string | null
Maximum length: 250
consultant
string | null
Maximum length: 250
closed_date
string<date> | null
total_contract_value
number | null
Required range: -1000000000000000000 < x < 1000000000000000000
contract_start_date
string<date> | null
exchange_rate
number | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number | null
Required range: -100000000000000 < x < 100000000000000
Maximum length: 500
Maximum length: 500
status
enum<string>
  • ACTIVE - Active
  • PENDING - Pending
  • COMPLETED - Completed
  • DELETED - Deleted
Available options:
ACTIVE,
PENDING,
COMPLETED,
DELETED
source
enum<string>
  • SALESFORCE - Salesforce
  • HUBSPOT - Hubspot
  • MANUAL - Manual
Available options:
SALESFORCE,
HUBSPOT,
MANUAL
auto_renew
boolean
auto_renew_duration
integer | null
Required range: -2147483648 <= x <= 2147483647
auto_renew_invoice
boolean
entity
integer | null
client
integer | null
department
integer | null
journal_entries
integer[]
I