Skip to main content
PATCH
Partially Update Revenue Contract

Path Parameters

id
integer
required

Body

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

name
string
Maximum string length: 255
status
enum<string>
  • PENDING_REVIEW - Pending review
  • ACTIVE - Active
  • COMPLETED - Fully recognized
  • EARLY_RENEWED - Early-renewed
  • TERMINATED - Terminated
Available options:
PENDING_REVIEW,
ACTIVE,
COMPLETED,
EARLY_RENEWED,
TERMINATED
entity
integer | null
client
integer | null
source
enum<string>
  • SALESFORCE - Salesforce
  • HUBSPOT - Hubspot
  • STRIPE - Stripe
  • MANUAL - Manual
Available options:
SALESFORCE,
HUBSPOT,
STRIPE,
MANUAL
consultant
string
Maximum string length: 250
crm_opportunity_id
string
Maximum string length: 255
Maximum string length: 500
Maximum string length: 500
purchase_order_number
string
Maximum string length: 120
billing_address
string | null

Bill-to address for invoices from this contract. Defaults from the client; editable per contract.

billing_addressee
string | null

Bill-to addressee for invoices from this contract. Defaults from the client; editable per contract.

Maximum string length: 255
shipping_address
string | null

Ship-to address for invoices from this contract. Defaults from the client; editable per contract.

shipping_addressee
string | null

Ship-to addressee for invoices from this contract. Defaults from the client; editable per contract.

Maximum string length: 255
invoice_message
string | null

Message printed on invoices from this contract. Defaults from the client; editable per contract.

invoice_email
string<email> | null
Maximum string length: 254
invoice_cc_emails
string | null

Comma-separated addresses copied on invoices from this contract.

department
integer | null
tags
integer[]
execution_date
string<date> | null
service_start
string<date> | null
service_end
string<date> | null
terminated_date
string<date> | null
currency
string
Maximum string length: 3
termination_notice_days
integer | null
Required range: 0 <= x <= 2147483647
payment_term
integer | null

Payment terms for generated invoices; lines snapshot its days. None means due on receipt.

creation_policy
enum<string>

When this contract is Active, whether AR invoices and GL journals are created from the schedule all at once or on each invoice/posting date.

  • CREATE_ALL_NOW - Create on Approval
  • CREATE_ON_DATE - Create On Invoice Date/Posting Date
Available options:
CREATE_ALL_NOW,
CREATE_ON_DATE
sending_policy
enum<string>

When AR invoices are created from this contract, whether they send automatically or stay unsent.

  • SEND_AUTOMATICALLY - Send Automatically
  • SEND_MANUALLY - Send Manually
Available options:
SEND_AUTOMATICALLY,
SEND_MANUALLY
stripe_connection
integer | null

Stripe connection copied onto AR invoices issued from this contract.

use_stripe_auto_bill
boolean

When true, issued AR invoices auto-charge the client's default Stripe payment method.

renewal_behavior
enum<string>
  • NONE - None
  • AUTO_RENEW - Auto-renew
  • MANUAL - Manual renewal
Available options:
NONE,
AUTO_RENEW,
MANUAL
header_discount
number<double>
Required range: -10000000000000 < x < 10000000000000
deferred_revenue_account
integer | null

Deferred revenue account for this contract's schedule entries whose obligation carries none.

unbilled_ar_account
integer | null

Unbilled accounts receivable account for this contract's schedule entries.

revenue_recognition_account
integer | null

Fallback revenue account for obligations whose product carries no revenue account.

renewed_into
integer | null
lines
object[]
write-only
custom_schedule
object[]
obligations
object[]
write-only

Response

200 - application/json

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

id
integer
required
read-only
contract_number
string
required
read-only

Sequential per-customer contract number (e.g. CTR-0000001), assigned at creation.

name
string
required
Maximum string length: 255
entity_name
string
required
read-only
client_name
string
required
read-only
department_name
string
required
read-only
payment_term_name
string
default:""
required
read-only
stripe_connection_name
string
default:""
required
read-only
deferred_revenue_account_name
string
default:""
required
read-only
unbilled_ar_account_name
string
default:""
required
read-only
revenue_recognition_account_name
string
default:""
required
read-only
attachments
object[]
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
status
enum<string>
  • PENDING_REVIEW - Pending review
  • ACTIVE - Active
  • COMPLETED - Fully recognized
  • EARLY_RENEWED - Early-renewed
  • TERMINATED - Terminated
Available options:
PENDING_REVIEW,
ACTIVE,
COMPLETED,
EARLY_RENEWED,
TERMINATED
entity
integer | null
client
integer | null
source
enum<string>
  • SALESFORCE - Salesforce
  • HUBSPOT - Hubspot
  • STRIPE - Stripe
  • MANUAL - Manual
Available options:
SALESFORCE,
HUBSPOT,
STRIPE,
MANUAL
consultant
string
Maximum string length: 250
crm_opportunity_id
string
Maximum string length: 255
Maximum string length: 500
Maximum string length: 500
purchase_order_number
string
Maximum string length: 120
billing_address
string | null

Bill-to address for invoices from this contract. Defaults from the client; editable per contract.

billing_addressee
string | null

Bill-to addressee for invoices from this contract. Defaults from the client; editable per contract.

Maximum string length: 255
shipping_address
string | null

Ship-to address for invoices from this contract. Defaults from the client; editable per contract.

shipping_addressee
string | null

Ship-to addressee for invoices from this contract. Defaults from the client; editable per contract.

Maximum string length: 255
invoice_message
string | null

Message printed on invoices from this contract. Defaults from the client; editable per contract.

invoice_email
string<email> | null
Maximum string length: 254
invoice_cc_emails
string | null

Comma-separated addresses copied on invoices from this contract.

department
integer | null
tags
integer[]
execution_date
string<date> | null
service_start
string<date> | null
service_end
string<date> | null
terminated_date
string<date> | null
currency
string
Maximum string length: 3
termination_notice_days
integer | null
Required range: 0 <= x <= 2147483647
payment_term
integer | null

Payment terms for generated invoices; lines snapshot its days. None means due on receipt.

creation_policy
enum<string>

When this contract is Active, whether AR invoices and GL journals are created from the schedule all at once or on each invoice/posting date.

  • CREATE_ALL_NOW - Create on Approval
  • CREATE_ON_DATE - Create On Invoice Date/Posting Date
Available options:
CREATE_ALL_NOW,
CREATE_ON_DATE
sending_policy
enum<string>

When AR invoices are created from this contract, whether they send automatically or stay unsent.

  • SEND_AUTOMATICALLY - Send Automatically
  • SEND_MANUALLY - Send Manually
Available options:
SEND_AUTOMATICALLY,
SEND_MANUALLY
stripe_connection
integer | null

Stripe connection copied onto AR invoices issued from this contract.

use_stripe_auto_bill
boolean

When true, issued AR invoices auto-charge the client's default Stripe payment method.

renewal_behavior
enum<string>
  • NONE - None
  • AUTO_RENEW - Auto-renew
  • MANUAL - Manual renewal
Available options:
NONE,
AUTO_RENEW,
MANUAL
header_discount
number<double>
Required range: -10000000000000 < x < 10000000000000
deferred_revenue_account
integer | null

Deferred revenue account for this contract's schedule entries whose obligation carries none.

unbilled_ar_account
integer | null

Unbilled accounts receivable account for this contract's schedule entries.

revenue_recognition_account
integer | null

Fallback revenue account for obligations whose product carries no revenue account.

renewed_into
integer | null
custom_schedule
object[]