Campfire Revenue Recognition API

Operations related to revenue recognition, contract management, and contract data aggregation.

Documentation Provider Profile APIs.io OpenAPI GitHub

Campfire Revenue Recognition API is one of 12 APIs that Campfire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Revenue Recognition. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 86 operations across 38 paths, and defines 73 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.meetcampfire.com.

86 operations 38 paths 73 schemas 11 DELETE30 GET13 PATCH18 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.3

API Version

1.0.0

Base URL

https://api.meetcampfire.com

Authentication

API Key

Resource Areas

Authentication & Security 1

Campfire Revenue Recognition API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (knoxApiToken).

knoxApiToken — Token-based authentication with required prefix "Token"

Paths & Operations 86

Across 38 paths, the API surfaces 86 operations — 11 DELETE, 30 GET, 13 PATCH, 18 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

Revenue Recognition 86

Operations related to revenue recognition, contract management, and contract data aggregation.

GET

/rr/api/v1/contracts

List Contracts

list_contracts 5 params → 200

POST

/rr/api/v1/contracts

Create Contract

create_contract body → 201

GET

/rr/api/v1/contracts/{contract_id}/bundles

List Contract Bundles

list_contract_bundles 4 params → 200

POST

/rr/api/v1/contracts/{contract_id}/bundles

Create Contract Bundle

create_contract_bundle 1 param body → 201

GET

/rr/api/v1/contracts/{contract_id}/bundles/{id}

Retrieve Contract Bundle

rr_api_v1_contracts_bundles_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/bundles/{id}

Update Contract Bundle

rr_api_v1_contracts_bundles_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/bundles/{id}

Partial Update Contract Bundle

rr_api_v1_contracts_bundles_partial_update 2 params body → 200

DELETE

/rr/api/v1/contracts/{contract_id}/bundles/{id}

Delete Contract Bundle

rr_api_v1_contracts_bundles_destroy 2 params → 204

GET

/rr/api/v1/contracts/{contract_id}/milestones

List Contract Milestones

list_contract_milestones 6 params → 200

POST

/rr/api/v1/contracts/{contract_id}/milestones

Create Contract Milestone

create_contract_milestone 1 param body → 201

GET

/rr/api/v1/contracts/{contract_id}/milestones/{milestone_id}/allocations

Get Bundle Allocations

rr_api_v1_contracts_milestones_allocations_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/milestones/{milestone_id}/allocations

Update Bundle Allocations

rr_api_v1_contracts_milestones_allocations_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/milestones/{milestone_id}/allocations

Partial Update Bundle Allocations

rr_api_v1_contracts_milestones_allocations_partial_update 2 params body → 200

GET

/rr/api/v1/contracts/{contract_id}/milestones/{id}

Retrieve Contract Milestone

rr_api_v1_contracts_milestones_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/milestones/{id}

Update Contract Milestone

rr_api_v1_contracts_milestones_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/milestones/{id}

Partial Update Contract Milestone

rr_api_v1_contracts_milestones_partial_update 2 params body → 200

DELETE

/rr/api/v1/contracts/{contract_id}/milestones/{id}

Delete Contract Milestone

rr_api_v1_contracts_milestones_destroy 2 params → 204

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commit-summary

Get Prepaid Commit Summary

get_prepaid_commit_summary 1 param → 200

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commits

List Prepaid Commits

list_prepaid_commits 3 params → 200

POST

/rr/api/v1/contracts/{contract_id}/prepaid-commits

Create Prepaid Commit

create_prepaid_commit 1 param body → 201

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/consumption

List Prepaid Commit Consumption

list_prepaid_commit_consumption 4 params → 200

POST

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/consumption

Create Prepaid Commit Consumption

create_prepaid_commit_consumption 2 params body → 201

PUT

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/consumption/{id}

Update Prepaid Commit Consumption

update_prepaid_commit_consumption 3 params → 200

DELETE

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/consumption/{id}

Delete Prepaid Commit Consumption

delete_prepaid_commit_consumption 3 params → 204

POST

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/process-adjustments

Process Prepaid Commit Adjustments

process_prepaid_commit_adjustments 2 params → 200

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/usage-events

List Prepaid Commit Usage Events

list_prepaid_commit_usage_events 4 params → 200

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/usage-events/distinct-values

Get Prepaid Commit Usage Event Distinct Values

get_prepaid_commit_usage_event_distinct_values 2 params → 200

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/usage-events/template

Get Prepaid Commit Usage Events Template

get_prepaid_commit_usage_events_template 2 params → 200

POST

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{commit_id}/usage-events/upload

Upload Prepaid Commit Usage Events

upload_prepaid_commit_usage_events 2 params → 200

GET

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{id}

Retrieve Prepaid Commit

get_prepaid_commit 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{id}

Update Prepaid Commit

update_prepaid_commit 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{id}

Partial Update Prepaid Commit

partial_update_prepaid_commit 2 params body → 200

DELETE

/rr/api/v1/contracts/{contract_id}/prepaid-commits/{id}

Delete Prepaid Commit

delete_prepaid_commit 2 params → 204

GET

/rr/api/v1/contracts/{contract_id}/subscriptions

List Contract Subscriptions

list_contract_subscriptions 4 params → 200

POST

/rr/api/v1/contracts/{contract_id}/subscriptions

Create Contract Subscription

create_contract_subscription 1 param body → 201

GET

/rr/api/v1/contracts/{contract_id}/subscriptions/{id}

Retrieve Contract Subscription

rr_api_v1_contracts_subscriptions_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/subscriptions/{id}

Update Contract Subscription

rr_api_v1_contracts_subscriptions_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/subscriptions/{id}

Partial Update Contract Subscription

rr_api_v1_contracts_subscriptions_partial_update 2 params body → 200

DELETE

/rr/api/v1/contracts/{contract_id}/subscriptions/{id}

Delete Contract Subscription

rr_api_v1_contracts_subscriptions_destroy 2 params → 204

GET

/rr/api/v1/contracts/{contract_id}/subscriptions/{subscription_id}/allocations

Get Bundle Allocations

rr_api_v1_contracts_subscriptions_allocations_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/subscriptions/{subscription_id}/allocations

Update Bundle Allocations

rr_api_v1_contracts_subscriptions_allocations_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/subscriptions/{subscription_id}/allocations

Partial Update Bundle Allocations

rr_api_v1_contracts_subscriptions_allocations_partial_update 2 params body → 200

GET

/rr/api/v1/contracts/{contract_id}/tier-price-overrides

List Contract Tier Price Overrides

rr_api_v1_contracts_tier_price_overrides_list 3 params → 200

POST

/rr/api/v1/contracts/{contract_id}/tier-price-overrides

Create Contract Tier Price Override

rr_api_v1_contracts_tier_price_overrides_create 1 param body → 201

GET

/rr/api/v1/contracts/{contract_id}/usage

List Contract Usage Revenue

rr_api_v1_contracts_usage_list 3 params → 200

POST

/rr/api/v1/contracts/{contract_id}/usage

Create Contract Usage Revenue

rr_api_v1_contracts_usage_create 1 param body → 201

GET

/rr/api/v1/contracts/{contract_id}/usage/{id}

Retrieve Contract Usage Revenue

rr_api_v1_contracts_usage_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/usage/{id}

Update Contract Usage Revenue

rr_api_v1_contracts_usage_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/usage/{id}

Partially Update Contract Usage Revenue

rr_api_v1_contracts_usage_partial_update 2 params body → 200

DELETE

/rr/api/v1/contracts/{contract_id}/usage/{id}

Delete Contract Usage Revenue

rr_api_v1_contracts_usage_destroy 2 params → 204

GET

/rr/api/v1/contracts/{contract_id}/usage/{usage_id}/allocations

Get Bundle Allocations

rr_api_v1_contracts_usage_allocations_retrieve 2 params → 200

PUT

/rr/api/v1/contracts/{contract_id}/usage/{usage_id}/allocations

Update Bundle Allocations

rr_api_v1_contracts_usage_allocations_update 2 params body → 200

PATCH

/rr/api/v1/contracts/{contract_id}/usage/{usage_id}/allocations

Partial Update Bundle Allocations

rr_api_v1_contracts_usage_allocations_partial_update 2 params body → 200

GET

/rr/api/v1/contracts/{id}

Retrieve Contract

rr_api_v1_contracts_retrieve 1 param → 200

PUT

/rr/api/v1/contracts/{id}

Update Contract

rr_api_v1_contracts_update 1 param body → 200

PATCH

/rr/api/v1/contracts/{id}

Partial Update Contract

rr_api_v1_contracts_partial_update 1 param body → 200

DELETE

/rr/api/v1/contracts/{id}

Delete Contract

rr_api_v1_contracts_destroy 1 param → 204

POST

/rr/api/v1/contracts/{id}/duplicate

Duplicate Contract

rr_api_v1_contracts_duplicate_create 1 param → 200

GET

/rr/api/v1/contracts/{id}/minimum-commit-preview

Projected monthly minimum commitment true-up for a contract. Read-only. Returns the shortfall the month-end batch would post if it ran right now. Lets the contract detail screen show a live floor pre…

rr_api_v1_contracts_minimum_commit_preview_retrieve 1 param → 200

POST

/rr/api/v1/contracts/{id}/terminate

Terminate Contract

rr_api_v1_contracts_terminate_create 1 param body → 200

POST

/rr/api/v1/contracts/bulk-search

Bulk Search Contracts

rr_api_v1_contracts_bulk_search_create body → 200

POST

/rr/api/v1/contracts/parse

Parse Contract

parse_contract → 200

GET

/rr/api/v1/customers

List Contract Customers

rr_api_v1_customers_list 5 params → 200

GET

/rr/api/v1/customers/{id}

Retrieve Contract Customer

rr_api_v1_customers_retrieve 1 param → 200

PUT

/rr/api/v1/customers/{id}

Update Contract Customer

rr_api_v1_customers_update 1 param body → 200

PATCH

/rr/api/v1/customers/{id}

Partial Update Contract Customer

rr_api_v1_customers_partial_update 1 param body → 200

DELETE

/rr/api/v1/customers/{id}

Delete Contract Customer

rr_api_v1_customers_destroy 1 param → 204

POST

/rr/api/v1/modify-subscription-schedule

Modify Subscription Schedule

modify_subscription_schedule body → 200

GET

/rr/api/v1/product

List Contract Products

list_products 5 params → 200

POST

/rr/api/v1/product

Create Contract Product

create_product body → 201

GET

/rr/api/v1/product-bundles

List Product Bundles

list_product_bundles 5 params → 200

POST

/rr/api/v1/product-bundles

Create Product Bundle

create_product_bundle body → 201

GET

/rr/api/v1/product-bundles/{id}

Retrieve Product Bundle

rr_api_v1_product_bundles_retrieve 1 param → 200

PUT

/rr/api/v1/product-bundles/{id}

Update Product Bundle

rr_api_v1_product_bundles_update 1 param body → 200

PATCH

/rr/api/v1/product-bundles/{id}

Partial Update Product Bundle

rr_api_v1_product_bundles_partial_update 1 param body → 200

DELETE

/rr/api/v1/product-bundles/{id}

Delete Product Bundle

rr_api_v1_product_bundles_destroy 1 param → 204

GET

/rr/api/v1/product/{id}

Retrieve Product

rr_api_v1_product_retrieve 1 param → 200

PUT

/rr/api/v1/product/{id}

Update Product

rr_api_v1_product_update 1 param body → 200

PATCH

/rr/api/v1/product/{id}

Partial Update Product

rr_api_v1_product_partial_update 1 param body → 200

DELETE

/rr/api/v1/product/{id}

Delete Product

rr_api_v1_product_destroy 1 param → 204

GET

/rr/api/v1/transactions

List Revenue Transactions

list_revenue_transactions 5 params → 200

POST

/rr/api/v1/transactions

Create Revenue Transaction

create_revenue_transaction body → 201

GET

/rr/api/v1/transactions/{id}

Retrieve Revenue Transaction

rr_api_v1_transactions_retrieve 1 param → 200

PUT

/rr/api/v1/transactions/{id}

Update Revenue Transaction

rr_api_v1_transactions_update 1 param body → 200

PATCH

/rr/api/v1/transactions/{id}

Partial Update Revenue Transaction

rr_api_v1_transactions_partial_update 1 param body → 200

DELETE

/rr/api/v1/transactions/{id}

Delete Revenue Transaction

rr_api_v1_transactions_destroy 1 param → 204

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are RevenueTransaction (84 properties), PatchedRevenueTransaction (84 properties), PatchedContractCustomer (82 properties), ContractCustomer (82 properties). Each schema is shown below with its type and property counts.

InvoiceCalculationEnum

string

FIXEDRATE - Fixed Rate FIXEDQUANTITY - Fixed Quantity

ContractUsage

object

17 properties 10 required

PaginatedContractList

object

4 properties 2 required

ContractBundle

object

17 properties 10 required

BillingFrequencyEnum

string

monthly - Monthly quarterly - Quarterly biannual - Bi Annualy annual - Annual onetime - One Time custom - Custom

SourceFc1Enum

string

SALESFORCE - Salesforce HUBSPOT - Hubspot STRIPE - Stripe MANUAL - Manual

ComponentTypeEnum

string

SUBSCRIPTION - Subscription MILESTONE - Milestone USAGE - Usage

TierPriceOverride

object

15 properties 9 required

PatchedContract

object

60 properties

TerminateContractResponse

object

Response serializer for contract termination with hints about drafted operations.

4 properties 1 required

GenerageSubscriptionSchedule

object

11 properties 2 required

PaginatedContractPrepaidCommitList

object

4 properties 2 required

ContractBundleLine

object

10 properties 7 required

PaginatedContractCustomerList

object

4 properties 2 required

BulkContractSearch

object

1 property 1 required

ContractMilestone

object

22 properties 17 required

RevenueTransaction

object

84 properties 36 required

PricingModelEnum

string

unitbased - Unit based pricing fixedfee - Fixed fee pricing percentagebased - Percentage based pricing graduatedtiered - Graduated tiered pricing volumebased -…

ProductUsageTierSummary

object

7 properties 7 required

ContractStatusEnum

string

ACTIVE - Active PENDING - Pending COMPLETED - Completed DELETED - Deleted

PaginatedContractPrepaidCommitConsumptionList

object

4 properties 2 required

Source3b3Enum

string

BILL - Bill BREX - Brex HUBSPOT - Hubspot MANUAL - Manual PAYROLL - Payroll SALESFORCE - Salesforce

PatchedRevenueTransaction

object

84 properties

BlankEnum

PatchedContractPrepaidCommit

object

30 properties

ProductBundleLine

object

6 properties 5 required

PaginatedContractMilestoneList

object

4 properties 2 required

PaginatedRevenueTransactionList

object

4 properties 2 required

PatchedProduct

object

44 properties

PaginatedTierPriceOverrideList

object

4 properties 2 required

PatchedContractUsage

object

17 properties

OverageInvoiceCadenceEnum

string

monthly - Monthly quarterly - Quarterly biannual - Bi Annualy annual - Annual onetime - One Time custom - Custom

ContractProductBundleLineUpdate

object

Serializer for updating individual line amounts.

2 properties 2 required

ContractProductBundle

object

Serializer for ContractProductBundle with nested lines. Used for retrieving and updating contract-specific bundle allocations. When updating, validates that li…

9 properties 8 required

ContractProductBundleUpdate

object

Serializer for the allocation update request body.

1 property 1 required

ContractProductBundleRead

object

Read-only serializer for ContractProductBundle in milestone responses.

6 properties 4 required

PaginatedProductBundleList

object

4 properties 2 required

TierPriceOverrideSourceEnum

string

manual - Manual entry integration - Integration-driven

Contract

object

60 properties 24 required

PaginatedPrepaidUsageEventList

object

4 properties 2 required

PrepaidUsageEvent

object

13 properties 5 required

BulkContract

object

1 property

ContractProductBundleLineRead

object

Read-only serializer for ContractProductBundleLine in milestone responses.

6 properties 5 required

ProductUsageGroupSummary

object

6 properties 3 required

ProrationMethodEnum

string

standard - Standard (actual month length) thirtyday - Fixed 30-day month daily - Daily

TermsEnum

string

custom - Custom net5 - Net 5 net7 - Net 7 net10 - Net 10 net15 - Net 15 net20 - Net 20 net30 - Net 30 net40 - Net 40 net45 - Net 45 net60 - Net 60 net90 - Net…

RecordConsumptionInput

object

4 properties 2 required

ContractDuplicateResponse

object

1 property 1 required

File

object

17 properties 14 required

ProductBundle

object

10 properties 8 required

PatchedContractMilestone

object

22 properties

ContractCustomer

object

82 properties 33 required

PaginatedProductList

object

4 properties 2 required

PaginatedContractUsageList

object

4 properties 2 required

VendorType391Enum

string

vendor - Vendor customer - Customer employee - Employee

VendorContact

object

10 properties 4 required

Status372Enum

string

ACTIVE - Active INACTIVE - Inactive

NullEnum

PatchedContractBundle

object

17 properties

NestedContractPrepaidCommit

object

19 properties 3 required

ContractPrepaidCommitConsumption

object

19 properties 17 required

ContractPrepaidCommit

object

30 properties 14 required

ContractPrepaidCommitStatusEnum

string

ACTIVE - Active EXHAUSTED - Exhausted EXPIRED - Expired

Product

object

44 properties 18 required

TerminateContract

object

3 properties 1 required

RenewalBehaviorEnum

string

FOLLOWCONTRACT - Follow Contract FIXEDEND - Fixed End Date

ContractSubscriptionLine

object

13 properties 3 required

PatchedProductBundle

object

10 properties

PatchedContractCustomer

object

82 properties

PatchedContractSubscription

object

36 properties

PatchedContractProductBundleUpdate

object

Serializer for the allocation update request body.

1 property

ContractProductBundleLine

object

Serializer for individual product allocation lines within a ContractProductBundle.

8 properties 8 required

ContractSubscription

object

36 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Campfire publishes across the network.

Campfire Accounts Payable API

AE Profile APIs.io

Campfire Accounts Receivable API

AE Profile APIs.io

Campfire Bank Reconciliation API

AE Profile APIs.io

Campfire Cash Management API

AE Profile APIs.io

Campfire coa API

AE Profile APIs.io

Campfire Company Objects API

AE Profile APIs.io

Campfire Core Accounting API

AE Profile APIs.io

Campfire Custom Fields API

AE Profile APIs.io

Campfire Financial Statements API

AE Profile APIs.io

Campfire Integrations API

AE Profile APIs.io

Campfire Settings API

AE Profile APIs.io

#Revenue Recognition

← Back to C APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Campfire Revenue Recognition API

Metadata

Authentication & Security 1

Paths & Operations 86

Schemas 73

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Campfire Revenue Recognition API

Metadata

Authentication & Security 1

Paths & Operations 86

Schemas 73

Specification

Source

More from Campfire 11

API Details

Provider

Explore more