Skip to main content
PATCH
Partially Update Performance Obligation

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.

contract
integer
contract_line
integer | null
product
integer | null
obligation_template
integer | null
period_source
enum<string>
  • LINE - Contract line dates
  • LINKED_OBLIGATION - Follows another obligation
  • CONTRACT_TERM - Full contract term
Available options:
LINE,
LINKED_OBLIGATION,
CONTRACT_TERM
status
enum<string>
  • ACTIVE - Active
  • COMPLETED - Completed
  • TERMINATED - Terminated
Available options:
ACTIVE,
COMPLETED,
TERMINATED
recognition_method
enum<string>
  • STRAIGHT_LINE - Ratable (straight-line)
  • POINT_IN_TIME - Point-in-time
  • USAGE_COMMIT - As-consumed — commit drawdown
  • USAGE_PAYGO - As-consumed — pay-as-you-go
  • USAGE_MIRROR - As-consumed — mirrors linked commit
Available options:
STRAIGHT_LINE,
POINT_IN_TIME,
USAGE_COMMIT,
USAGE_PAYGO,
USAGE_MIRROR
recognition_proration
enum<string>
  • MONTHLY - Monthly
  • THIRTY_DAY - 30-day month
  • DAILY - Daily
Available options:
MONTHLY,
THIRTY_DAY,
DAILY
currency
string
Maximum string length: 3
invoiced_amount
number<double>
Required range: -10000000000000 < x < 10000000000000
allocated_amount
number<double>
Required range: -10000000000000 < x < 10000000000000
start_date
string<date> | null
end_date
string<date> | null
revenue_account
integer | null
deferred_revenue_account
integer | null

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
integer
required
contract_name
string
required
read-only
product_name
string
default:""
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
contract_line
integer | null
product
integer | null
obligation_template
integer | null
period_source
enum<string>
  • LINE - Contract line dates
  • LINKED_OBLIGATION - Follows another obligation
  • CONTRACT_TERM - Full contract term
Available options:
LINE,
LINKED_OBLIGATION,
CONTRACT_TERM
status
enum<string>
  • ACTIVE - Active
  • COMPLETED - Completed
  • TERMINATED - Terminated
Available options:
ACTIVE,
COMPLETED,
TERMINATED
recognition_method
enum<string>
  • STRAIGHT_LINE - Ratable (straight-line)
  • POINT_IN_TIME - Point-in-time
  • USAGE_COMMIT - As-consumed — commit drawdown
  • USAGE_PAYGO - As-consumed — pay-as-you-go
  • USAGE_MIRROR - As-consumed — mirrors linked commit
Available options:
STRAIGHT_LINE,
POINT_IN_TIME,
USAGE_COMMIT,
USAGE_PAYGO,
USAGE_MIRROR
recognition_proration
enum<string>
  • MONTHLY - Monthly
  • THIRTY_DAY - 30-day month
  • DAILY - Daily
Available options:
MONTHLY,
THIRTY_DAY,
DAILY
currency
string
Maximum string length: 3
invoiced_amount
number<double>
Required range: -10000000000000 < x < 10000000000000
allocated_amount
number<double>
Required range: -10000000000000 < x < 10000000000000
start_date
string<date> | null
end_date
string<date> | null
revenue_account
integer | null
deferred_revenue_account
integer | null