Update a recurring revenue
patch
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue/{RevnId}
Request
Path Parameters
-
ChildRevenueUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Revenue Items resource and used to uniquely identify an instance of Revenue Items. The client should not generate the hash key value. Instead, the client should query on the Revenue Items collection resource in order to navigate to a specific instance of Revenue Items to get the hash key.
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
-
RevnId(required): integer(int64)
Revenue identifier.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EffectiveDate: string
(date)
Title:
Line Close Date
Estimated close date for this revenue - defaulted from opportunity's close date. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring revenue amount on the revenue line. -
Quantity: number
Title:
Quantity
Product quantity. -
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue amount on the revenue line. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
Revenue amount. -
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue amount on the revenue line.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : opportunities-ChildRevenue-RecurringRevenue-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
EffectiveDate: string
(date)
Title:
Line Close Date
Estimated close date for this revenue - defaulted from opportunity's close date. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonRecurringRevenue: number
Title:
Nonrecurring Revenue
The non recurring revenue amount on the revenue line. -
Quantity: number
Title:
Quantity
Product quantity. -
RecurParentRevnId: integer
(int64)
Indicates the parent revenue id for the recurrence.
-
RecurRevenue: number
Title:
Recurring Revenue
The recurring revenue amount on the revenue line. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
Revenue amount. -
RevnAmtCurcyCode: string
Read Only:
true
The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
RevnId: integer
(int64)
Revenue identifier.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL. -
UsageRevenue: number
Title:
Usage Revenue
The usage revenue amount on the revenue line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.