Skip to main content
GET
/
rr
/
api
/
v1
/
contracts
/
{contract_id}
/
bundles
/
{id}
Retrieve Contract Bundle
curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/contracts/{contract_id}/bundles/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 123,
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "id": 123,
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "product_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "amount": 0,
      "product": 123
    }
  ],
  "bundle_name": "<string>",
  "start_date": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "contract": 123,
  "end_date": "2023-12-25",
  "rebalance_journal_entries_indefinitely": false,
  "bundle_description": "<string>",
  "use_daily_accounting": true,
  "use_catchup": true,
  "catchup_date": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
contract_id
integer
required
​
id
integer
required

Response

200 - application/json
​
id
integer
required
read-only
​
is_deleted
boolean
default:false
required
read-only
​
deleted_at
string<date-time> | null
required
read-only
​
lines
object[]
required
​
bundle_name
string
required
Maximum string length: 250
​
start_date
string<date>
required
​
created_at
string<date-time>
required
read-only
​
last_modified_at
string<date-time>
required
read-only
​
customer
integer
required
read-only
​
contract
integer
required
​
end_date
string<date> | null

Bundle end date. Required for standard contracts. For evergreen contracts this may be null to follow the contract timeline, or set to a billing-period end date.

​
rebalance_journal_entries_indefinitely
boolean
default:false

Should only be used for Evergreen contracts. When true, linked invoice journal entries are rebalanced on each evergreen contract extension.

​
bundle_description
string | null
Maximum string length: 250
​
use_daily_accounting
boolean
​
proration_method
enum<string>
  • standard - Standard (actual month length)
  • thirty_day - Fixed 30-day month
  • daily - Daily
Available options:
standard,
thirty_day,
daily
​
use_catchup
boolean
​
catchup_date
string<date> | null