Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Revenue Recognition

Partial Update Prepaid Commit

patch/rr/api/v1/contracts/{contract_id}/prepaid-commits/{id}

Path parameters

contract_idinteger required
idinteger required

Request body

idinteger
contractinteger
entityinteger nullable
entity_namestring nullable
productinteger nullable
product_namestring nullable
namestring
descriptionstring nullable
currencystring
exchange_ratenumber double nullable
exchange_rate_booknumber double nullable
total_valuenumber double
remaining_valuenumber double
discount_percentagenumber double

Discount applied to gross usage (e.g. 20.00 for 20%)

ratenumber double nullable

List price per unit. Prepaid usage = rate * (1 - discount%). Overage = rate (no discount).

start_datestring date
expiration_datestring date nullable
status'ACTIVE' | 'EXHAUSTED' | 'EXPIRED'
  • ACTIVE - Active
  • EXHAUSTED - Exhausted
  • EXPIRED - Expired
priorityinteger

Drawdown order when multiple commits exist (lower = higher priority)

is_invoicedboolean
invoiceinteger nullable
subledgerinteger nullable
overage_invoice_cadence'monthly' | 'quarterly' | 'biannual' | 'annual' | 'one_time' | 'custom'
  • monthly - Monthly
  • quarterly - Quarterly
  • biannual - Bi Annualy
  • annual - Annual
  • one_time - One Time
  • custom - Custom
auto_send_overage_invoicesboolean

Automatically send overage invoices when generated

overage_invoice_start_monthstring date nullable

Anchor date for overage billing cycles. Defaults to start_date.

departmentinteger nullable
department_namestring nullable
tagsstring nullable
created_atstring date-time nullable
last_modified_atstring date-time nullable

Response

idinteger required
contractinteger required
entityinteger nullable
entity_namestring nullable required
productinteger nullable
product_namestring nullable required
namestring required
descriptionstring nullable
currencystring
exchange_ratenumber double nullable
exchange_rate_booknumber double nullable
total_valuenumber double required
remaining_valuenumber double required
discount_percentagenumber double

Discount applied to gross usage (e.g. 20.00 for 20%)

ratenumber double nullable

List price per unit. Prepaid usage = rate * (1 - discount%). Overage = rate (no discount).

start_datestring date required
expiration_datestring date nullable
status'ACTIVE' | 'EXHAUSTED' | 'EXPIRED' required
  • ACTIVE - Active
  • EXHAUSTED - Exhausted
  • EXPIRED - Expired
priorityinteger

Drawdown order when multiple commits exist (lower = higher priority)

is_invoicedboolean required
invoiceinteger nullable required
subledgerinteger nullable
overage_invoice_cadence'monthly' | 'quarterly' | 'biannual' | 'annual' | 'one_time' | 'custom'
  • monthly - Monthly
  • quarterly - Quarterly
  • biannual - Bi Annualy
  • annual - Annual
  • one_time - One Time
  • custom - Custom
auto_send_overage_invoicesboolean

Automatically send overage invoices when generated

overage_invoice_start_monthstring date nullable

Anchor date for overage billing cycles. Defaults to start_date.

departmentinteger nullable
department_namestring nullable required
tagsstring nullable
created_atstring date-time nullable required
last_modified_atstring date-time nullable required