Skip to main content
PATCH
Partially Update Revenue Contract

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

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
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.

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
bill_to_snapshot
any
shipping_snapshot
any
dimensions
any
revenue_hold_from
string<date> | null
revenue_hold_reason
string
Maximum string length: 500
carry_in
any
carry_out
any
renewed_into
integer | null
lines
object[]
write-only
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
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
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
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.

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
bill_to_snapshot
any
shipping_snapshot
any
dimensions
any
revenue_hold_from
string<date> | null
revenue_hold_reason
string
Maximum string length: 500
carry_in
any
carry_out
any
renewed_into
integer | null