Skip to main content
POST
/
rr
/
api
/
v1
/
product
Create Contract Product
curl --request POST \
  --url https://api.meetcampfire.com/rr/api/v1/product \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "<string>",
  "product_name": "<string>",
  "product_description": "<string>",
  "tag_ids": [
    0
  ],
  "tag_group_ids": [
    0
  ],
  "currency": "<string>",
  "price": 0,
  "cost": 0,
  "exclude_from_mrr": true,
  "is_taxable": true,
  "is_renewable": true,
  "stripe_product_id": "<string>",
  "avalara_item_id": 0,
  "avalara_item_data": null,
  "avalara_tax_code": "<string>",
  "anrok_item_id": "<string>",
  "sphere_item_id": "<string>",
  "apply_dept_tag_to_invoice_journals": true,
  "department": 123,
  "invoice_account": 123,
  "revenue_account": 123,
  "ar_account": 123,
  "bad_debt_account": 123,
  "invoice_unbilled_account": 123
}
'
{
  "id": 123,
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "department_name": "<string>",
  "invoice_account_name": "<string>",
  "revenue_account_name": "<string>",
  "ar_account_name": "<string>",
  "bad_debt_account_name": "<string>",
  "invoice_unbilled_account_name": "<string>",
  "tax_account_name": "<string>",
  "tags": [
    {
      "id": 123,
      "group_name": "<string>",
      "parent_name": "<string>",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "parent": 123,
      "is_active": true,
      "group": 123
    }
  ],
  "last_modified_at": "2023-11-07T05:31:56Z",
  "product_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "usage_group_count": 0,
  "usage_groups": [
    {
      "id": 123,
      "tier_count": 0,
      "tiers": [
        {
          "id": 123,
          "name": "<string>",
          "pricing_type": "<string>",
          "from_quantity": 0,
          "to_quantity": 0,
          "price": 0,
          "percentage": 0
        }
      ],
      "name": "<string>",
      "unit_of_measure": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "product_id": "<string>",
  "product_name": "<string>",
  "product_description": "<string>",
  "tag_ids": [
    0
  ],
  "tag_group_ids": [
    0
  ],
  "currency": "<string>",
  "price": 0,
  "cost": 0,
  "exclude_from_mrr": true,
  "is_taxable": true,
  "is_renewable": true,
  "stripe_product_id": "<string>",
  "avalara_item_id": 0,
  "avalara_item_data": null,
  "avalara_tax_code": "<string>",
  "anrok_item_id": "<string>",
  "sphere_item_id": "<string>",
  "apply_dept_tag_to_invoice_journals": true,
  "department": 123,
  "invoice_account": 123,
  "revenue_account": 123,
  "ar_account": 123,
  "bad_debt_account": 123,
  "invoice_unbilled_account": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.campfire.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

​
product_id
string | null
Maximum string length: 250
​
product_name
string | null
Maximum string length: 250
​
product_description
string | null
Maximum string length: 250
​
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
currency
string | null
Maximum string length: 3
​
price
number<double> | null
Required range: -100000000000000 < x < 100000000000000
​
cost
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
​
exclude_from_mrr
boolean
​
is_taxable
boolean
​
is_renewable
boolean
​
stripe_product_id
string | null
Maximum string length: 250
​
avalara_item_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
avalara_item_data
unknown
​
avalara_tax_code
string | null

Avalara tax code (e.g., SW052000 for SAAS)

Maximum string length: 50
​
anrok_item_id
string | null
Maximum string length: 250
​
sphere_item_id
string | null
Maximum string length: 250
​
apply_dept_tag_to_invoice_journals
boolean | null

Apply Department and Tag categorization to all lines on Invoice Journals

​
department
integer | null
​
invoice_account
integer | null
​
revenue_account
integer | null
​
ar_account
integer | null
​
bad_debt_account
integer | null
​
invoice_unbilled_account
integer | null

Response

201 - application/json
​
id
integer
required
read-only
​
is_deleted
boolean
default:false
required
read-only
​
deleted_at
string<date-time> | null
required
read-only
​
department_name
string
required
read-only
​
invoice_account_name
string | null
required
read-only
​
revenue_account_name
string | null
required
read-only
​
ar_account_name
string | null
required
read-only
​
bad_debt_account_name
string | null
required
read-only
​
invoice_unbilled_account_name
string | null
required
read-only
​
tax_account_name
string
required
read-only
​
tags
object[]
required
read-only
​
last_modified_at
string<date-time>
required
read-only
​
product_uuid
string<uuid>
required
read-only
​
display_name
string
required
read-only
​
usage_group_count
integer
default:0
required
read-only
​
usage_groups
object[]
required
read-only
​
created_at
string<date-time>
required
read-only
​
customer
integer
required
read-only
​
product_id
string | null
Maximum string length: 250
​
product_name
string | null
Maximum string length: 250
​
product_description
string | null
Maximum string length: 250
​
tag_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
tag_group_ids
integer<int64>[]
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
currency
string | null
Maximum string length: 3
​
price
number<double> | null
Required range: -100000000000000 < x < 100000000000000
​
cost
number<double> | null
Required range: -1000000000000000000 < x < 1000000000000000000
​
exclude_from_mrr
boolean
​
is_taxable
boolean
​
is_renewable
boolean
​
stripe_product_id
string | null
Maximum string length: 250
​
avalara_item_id
integer<int64> | null
Required range: -9223372036854776000 <= x <= 9223372036854776000
​
avalara_item_data
unknown
​
avalara_tax_code
string | null

Avalara tax code (e.g., SW052000 for SAAS)

Maximum string length: 50
​
anrok_item_id
string | null
Maximum string length: 250
​
sphere_item_id
string | null
Maximum string length: 250
​
apply_dept_tag_to_invoice_journals
boolean | null

Apply Department and Tag categorization to all lines on Invoice Journals

​
department
integer | null
​
invoice_account
integer | null
​
revenue_account
integer | null
​
ar_account
integer | null
​
bad_debt_account
integer | null
​
invoice_unbilled_account
integer | null