Partially Update Revenue Contract Line

curl --request PATCH \
  --url https://api.meetcampfire.com/rev/api/v1/contract-lines/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contract": 123,
  "ordinal": 1073741823,
  "product": 123,
  "product_bundle": 123,
  "product_name": "<string>",
  "product_sku": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "quantity": 0,
  "unit_price": 0,
  "discount": 0,
  "transaction_price": 0,
  "service_start": "2023-12-25",
  "service_end": "2023-12-25",
  "exclude_from_allocation": true,
  "is_mrr": true,
  "net_terms": 1073741823
}
'

import requests

url = "https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}"

payload = {
    "contract": 123,
    "ordinal": 1073741823,
    "product": 123,
    "product_bundle": 123,
    "product_name": "<string>",
    "product_sku": "<string>",
    "description": "<string>",
    "currency": "<string>",
    "quantity": 0,
    "unit_price": 0,
    "discount": 0,
    "transaction_price": 0,
    "service_start": "2023-12-25",
    "service_end": "2023-12-25",
    "exclude_from_allocation": True,
    "is_mrr": True,
    "net_terms": 1073741823
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contract: 123,
    ordinal: 1073741823,
    product: 123,
    product_bundle: 123,
    product_name: '<string>',
    product_sku: '<string>',
    description: '<string>',
    currency: '<string>',
    quantity: 0,
    unit_price: 0,
    discount: 0,
    transaction_price: 0,
    service_start: '2023-12-25',
    service_end: '2023-12-25',
    exclude_from_allocation: true,
    is_mrr: true,
    net_terms: 1073741823
  })
};

fetch('https://api.meetcampfire.com/rev/api/v1/contract-lines/{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/contract-lines/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'contract' => 123,
    'ordinal' => 1073741823,
    'product' => 123,
    'product_bundle' => 123,
    'product_name' => '<string>',
    'product_sku' => '<string>',
    'description' => '<string>',
    'currency' => '<string>',
    'quantity' => 0,
    'unit_price' => 0,
    'discount' => 0,
    'transaction_price' => 0,
    'service_start' => '2023-12-25',
    'service_end' => '2023-12-25',
    'exclude_from_allocation' => true,
    'is_mrr' => true,
    'net_terms' => 1073741823
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}"

	payload := strings.NewReader("{\n  \"contract\": 123,\n  \"ordinal\": 1073741823,\n  \"product\": 123,\n  \"product_bundle\": 123,\n  \"product_name\": \"<string>\",\n  \"product_sku\": \"<string>\",\n  \"description\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"quantity\": 0,\n  \"unit_price\": 0,\n  \"discount\": 0,\n  \"transaction_price\": 0,\n  \"service_start\": \"2023-12-25\",\n  \"service_end\": \"2023-12-25\",\n  \"exclude_from_allocation\": true,\n  \"is_mrr\": true,\n  \"net_terms\": 1073741823\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contract\": 123,\n  \"ordinal\": 1073741823,\n  \"product\": 123,\n  \"product_bundle\": 123,\n  \"product_name\": \"<string>\",\n  \"product_sku\": \"<string>\",\n  \"description\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"quantity\": 0,\n  \"unit_price\": 0,\n  \"discount\": 0,\n  \"transaction_price\": 0,\n  \"service_start\": \"2023-12-25\",\n  \"service_end\": \"2023-12-25\",\n  \"exclude_from_allocation\": true,\n  \"is_mrr\": true,\n  \"net_terms\": 1073741823\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contract\": 123,\n  \"ordinal\": 1073741823,\n  \"product\": 123,\n  \"product_bundle\": 123,\n  \"product_name\": \"<string>\",\n  \"product_sku\": \"<string>\",\n  \"description\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"quantity\": 0,\n  \"unit_price\": 0,\n  \"discount\": 0,\n  \"transaction_price\": 0,\n  \"service_start\": \"2023-12-25\",\n  \"service_end\": \"2023-12-25\",\n  \"exclude_from_allocation\": true,\n  \"is_mrr\": true,\n  \"net_terms\": 1073741823\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "contract": 123,
  "contract_name": "<string>",
  "product_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "ordinal": 1073741823,
  "product": 123,
  "product_bundle": 123,
  "product_sku": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "quantity": 0,
  "unit_price": 0,
  "discount": 0,
  "transaction_price": 0,
  "service_start": "2023-12-25",
  "service_end": "2023-12-25",
  "exclude_from_allocation": true,
  "is_mrr": true,
  "net_terms": 1073741823
}

PATCH

rev

api

contract-lines

{id}

Partially Update Revenue Contract Line

curl --request PATCH \
  --url https://api.meetcampfire.com/rev/api/v1/contract-lines/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contract": 123,
  "ordinal": 1073741823,
  "product": 123,
  "product_bundle": 123,
  "product_name": "<string>",
  "product_sku": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "quantity": 0,
  "unit_price": 0,
  "discount": 0,
  "transaction_price": 0,
  "service_start": "2023-12-25",
  "service_end": "2023-12-25",
  "exclude_from_allocation": true,
  "is_mrr": true,
  "net_terms": 1073741823
}
'

import requests

url = "https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}"

payload = {
    "contract": 123,
    "ordinal": 1073741823,
    "product": 123,
    "product_bundle": 123,
    "product_name": "<string>",
    "product_sku": "<string>",
    "description": "<string>",
    "currency": "<string>",
    "quantity": 0,
    "unit_price": 0,
    "discount": 0,
    "transaction_price": 0,
    "service_start": "2023-12-25",
    "service_end": "2023-12-25",
    "exclude_from_allocation": True,
    "is_mrr": True,
    "net_terms": 1073741823
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contract: 123,
    ordinal: 1073741823,
    product: 123,
    product_bundle: 123,
    product_name: '<string>',
    product_sku: '<string>',
    description: '<string>',
    currency: '<string>',
    quantity: 0,
    unit_price: 0,
    discount: 0,
    transaction_price: 0,
    service_start: '2023-12-25',
    service_end: '2023-12-25',
    exclude_from_allocation: true,
    is_mrr: true,
    net_terms: 1073741823
  })
};

fetch('https://api.meetcampfire.com/rev/api/v1/contract-lines/{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/contract-lines/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'contract' => 123,
    'ordinal' => 1073741823,
    'product' => 123,
    'product_bundle' => 123,
    'product_name' => '<string>',
    'product_sku' => '<string>',
    'description' => '<string>',
    'currency' => '<string>',
    'quantity' => 0,
    'unit_price' => 0,
    'discount' => 0,
    'transaction_price' => 0,
    'service_start' => '2023-12-25',
    'service_end' => '2023-12-25',
    'exclude_from_allocation' => true,
    'is_mrr' => true,
    'net_terms' => 1073741823
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}"

	payload := strings.NewReader("{\n  \"contract\": 123,\n  \"ordinal\": 1073741823,\n  \"product\": 123,\n  \"product_bundle\": 123,\n  \"product_name\": \"<string>\",\n  \"product_sku\": \"<string>\",\n  \"description\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"quantity\": 0,\n  \"unit_price\": 0,\n  \"discount\": 0,\n  \"transaction_price\": 0,\n  \"service_start\": \"2023-12-25\",\n  \"service_end\": \"2023-12-25\",\n  \"exclude_from_allocation\": true,\n  \"is_mrr\": true,\n  \"net_terms\": 1073741823\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contract\": 123,\n  \"ordinal\": 1073741823,\n  \"product\": 123,\n  \"product_bundle\": 123,\n  \"product_name\": \"<string>\",\n  \"product_sku\": \"<string>\",\n  \"description\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"quantity\": 0,\n  \"unit_price\": 0,\n  \"discount\": 0,\n  \"transaction_price\": 0,\n  \"service_start\": \"2023-12-25\",\n  \"service_end\": \"2023-12-25\",\n  \"exclude_from_allocation\": true,\n  \"is_mrr\": true,\n  \"net_terms\": 1073741823\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.meetcampfire.com/rev/api/v1/contract-lines/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contract\": 123,\n  \"ordinal\": 1073741823,\n  \"product\": 123,\n  \"product_bundle\": 123,\n  \"product_name\": \"<string>\",\n  \"product_sku\": \"<string>\",\n  \"description\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"quantity\": 0,\n  \"unit_price\": 0,\n  \"discount\": 0,\n  \"transaction_price\": 0,\n  \"service_start\": \"2023-12-25\",\n  \"service_end\": \"2023-12-25\",\n  \"exclude_from_allocation\": true,\n  \"is_mrr\": true,\n  \"net_terms\": 1073741823\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "contract": 123,
  "contract_name": "<string>",
  "product_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "ordinal": 1073741823,
  "product": 123,
  "product_bundle": 123,
  "product_sku": "<string>",
  "description": "<string>",
  "currency": "<string>",
  "quantity": 0,
  "unit_price": 0,
  "discount": 0,
  "transaction_price": 0,
  "service_start": "2023-12-25",
  "service_end": "2023-12-25",
  "exclude_from_allocation": true,
  "is_mrr": true,
  "net_terms": 1073741823
}

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

integer

required

Body

Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.

contract

integer

ordinal

integer

Required range: 0 <= x <= 2147483647

product

integer | null

product_bundle

integer | null

product_name

string

Maximum string length: 255

product_sku

string

Maximum string length: 255

description

string

currency

string

Maximum string length: 3

quantity

number<double>

Required range: -100000000000 < x < 100000000000

unit_price

number<double>

Required range: -1000000000 < x < 1000000000

discount

number<double>

Required range: -10000000000000 < x < 10000000000000

transaction_price

number<double>

Required range: -10000000000000 < x < 10000000000000

service_start

string<date> | null

service_end

string<date> | null

exclude_from_allocation

boolean

is_mrr

boolean

billing_cadence

enum<string>

MONTHLY - Monthly
QUARTERLY - Quarterly
SEMI_ANNUAL - Semi-annual
ANNUAL - Annual
CUSTOM - Custom

Available options:

MONTHLY,

QUARTERLY,

SEMI_ANNUAL,

ANNUAL,

CUSTOM

billing_timing

enum<string>

ADVANCE - In advance (start of period)
ARREARS - In arrears (end of period)

Available options:

ADVANCE,

ARREARS

net_terms

integer | null

Required range: 0 <= x <= 2147483647

Response

200 - application/json

Base serializer that injects the request user's customer on create and restricts related-object querysets to the same customer.

integer

required

read-only

contract

integer

required

contract_name

string

required

read-only

product_name

string

required

Maximum string length: 255

created_at

string<date-time>

required

read-only

last_modified_at

string<date-time>

required

read-only

ordinal

integer

Required range: 0 <= x <= 2147483647

product

integer | null

product_bundle

integer | null

product_sku

string

Maximum string length: 255

description

string

currency

string

Maximum string length: 3

quantity

number<double>

Required range: -100000000000 < x < 100000000000

unit_price

number<double>

Required range: -1000000000 < x < 1000000000

discount

number<double>

Required range: -10000000000000 < x < 10000000000000

transaction_price

number<double>

Required range: -10000000000000 < x < 10000000000000

service_start

string<date> | null

service_end

string<date> | null

exclude_from_allocation

boolean

is_mrr

boolean

billing_cadence

enum<string>

MONTHLY - Monthly
QUARTERLY - Quarterly
SEMI_ANNUAL - Semi-annual
ANNUAL - Annual
CUSTOM - Custom

Available options:

MONTHLY,

QUARTERLY,

SEMI_ANNUAL,

ANNUAL,

CUSTOM

billing_timing

enum<string>

ADVANCE - In advance (start of period)
ARREARS - In arrears (end of period)

Available options:

ADVANCE,

ARREARS

net_terms

integer | null

Required range: 0 <= x <= 2147483647

⌘I

Cash Management

Financial Statements

Settings

Company Objects

Custom Fields

Core Accounting

coa

Accounts Payable

Accounts Receivable

Bank Reconciliation

Integrations

Revenue

Revenue Recognition

Partially Update Revenue Contract Line

Authorizations

Path Parameters

Body

Response