Update a forecast item
patch
/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/ForecastItemDetail/{ForecastItemDetailUniqID}
Request
Path Parameters
-
ForecastItemDetailUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Forecast Items resource and used to uniquely identify an instance of Forecast Items. The client should not generate the hash key value. Instead, the client should query on the Forecast Items collection resource in order to navigate to a specific instance of Forecast Items to get the hash key.
-
ForecastParticipantId(required): integer(int64)
The unique identifier of the participant associated with the territory forecast.
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
AdjustedForecast: number
Title:
Adjusted Forecast
The value of the revenue item after adjustments. -
AdjustedQuantity: number
Title:
Adjusted Quantity
The value of the adjusted quantity. -
AdjustPeriodId: integer
(int64)
Title:
Adjustment Period ID
The unique identifier of the forecast period. -
BestCaseAdjustedForecast: number
Title:
Adjusted Best Case
The best case value of the revenue item after adjustments. -
BUOrgId: integer
(int64)
The unique identifier of the business unit organization.
-
CorporateUnadjustedDownsideAmount: number
Title:
Unadjusted Worst Case
The worst case revenue item amount in corporate currency. -
CorporateUnadjustedRevenueAmount: number
Title:
Unadjusted Forecast
The revenue item amount in corporate currency. -
CorporateUnadjustedUpsideAmount: number
Title:
Unadjusted Best Case
The best case revenue item amount in corporate currency. -
CurrentStageId: integer
(int64)
Title:
Sales Stage
The unique identifier of the current sales stage associated with the opportunity. -
CustomerPartyId: integer
(int64)
Title:
Customer
The unique identifier of the customer associated with the revenue item. -
EffectiveDate: string
(date)
Title:
Close Date
The date when the revenue item becomes effective. -
ForecastHeaderId: integer
(int64)
Title:
Forecast Header ID
The unique identifier of the forecast. -
ForecastItemId: integer
(int64)
Title:
ForecastItem
The unique identifier of the forecast item. -
ForecastOverrideCode: string
Title:
Include in Forecast
Maximum Length:30
Forecast Override code for criteria. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization that is generated during product creation. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity associated with the revenue item. -
OpportunityName: string
Title:
Opportunity
Maximum Length:275
The name of the opportunity. -
OpportunityStatusCode: string
Title:
Opportunity Status
Maximum Length:30
The status of the opportunity. -
OwnerResourceId: integer
(int64)
Title:
Credit Receiver ID
The unique identifier of the revenue owner. -
OwnerResourceOrgId: integer
(int64)
Title:
Resource Organization ID
The unique identifier of the revenue owner's organization. -
PartnerPartOrgPartyId: integer
(int64)
Title:
Partner Organization ID
The unique identifier of the partner party organization. -
PartnerSourceNumber: string
Title:
Primary Source Number
Maximum Length:30
The source number of the partner. -
PrimaryTerritoryId: integer
(int64)
Title:
Primary Territory ID
The unique identifier of the primary territory associated with the revenue item. -
PrimaryTerritoryVersionId: integer
(int64)
Title:
Primary Territory Version ID
The unique identifier of the primary territory version associated with the revenue item. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductName: string
Title:
Product Name
The product name. -
Quantity: number
Title:
Quantity
The quantity of the revenue item. -
RecurTypeCode: string
Title:
Recurrence Type Code
Maximum Length:30
The code indicating if the opportunity is recurring. -
RevenueAmount: number
Title:
Revenue
The revenue amount associated with the revenue item. -
RevenueId: integer
(int64)
Title:
Revenue ID
The unique identifier of the revenue item associated with the forecast item. -
RevenueStatusCode: string
Title:
Status
Maximum Length:30
The status of the revenue item. -
RevenueTerritoryId: integer
(int64)
The unique identifier of the revenue territory. This attribute is populated only when a revenue item is pulled into a subordinate forecast by the manager.
-
UnadjustedQuantity: number
Title:
Unadjusted Quantity
Default Value:0
The value of the unadjusted quantity. -
UnitPrice: number
Title:
Estimated Price
The unit price of the revenue item. -
WinProbability: integer
(int32)
Title:
Win Probability
The win probability value of the revenue item. -
WorstCaseAdjustedForecast: number
Title:
Adjusted Worst Case
The worst case value of the revenue item after adjustments.
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 : territoryForecasts-ForecastItemDetail-item-response
Type:
Show Source
object
-
AdjustedForecast: number
Title:
Adjusted Forecast
The value of the revenue item after adjustments. -
AdjustedQuantity: number
Title:
Adjusted Quantity
The value of the adjusted quantity. -
AdjustmentType: string
Title:
Adjustment Type
Read Only:true
Maximum Length:30
The type of forecast adjustment that was created. A forecast can be adjusted either at the forecast item level or at the forecast summary level. -
AdjustPeriodId: integer
(int64)
Title:
Adjustment Period ID
The unique identifier of the forecast period. -
BestCaseAdjustedForecast: number
Title:
Adjusted Best Case
The best case value of the revenue item after adjustments. -
BUOrgId: integer
(int64)
The unique identifier of the business unit organization.
-
Category: string
Title:
Category
Read Only:true
Forecast item category denotes whether the forecast item is of type renewal or new. -
CorporateCurrencyCode: string
Title:
Currency
Maximum Length:30
The corporate currency code associated with the forecast. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CorporateUnadjustedDownsideAmount: number
Title:
Unadjusted Worst Case
The worst case revenue item amount in corporate currency. -
CorporateUnadjustedRevenueAmount: number
Title:
Unadjusted Forecast
The revenue item amount in corporate currency. -
CorporateUnadjustedUpsideAmount: number
Title:
Unadjusted Best Case
The best case revenue item amount in corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrentStageId: integer
(int64)
Title:
Sales Stage
The unique identifier of the current sales stage associated with the opportunity. -
CustomerPartyId: integer
(int64)
Title:
Customer
The unique identifier of the customer associated with the revenue item. -
EffectiveDate: string
(date)
Title:
Close Date
The date when the revenue item becomes effective. -
ForecastHeaderId: integer
(int64)
Title:
Forecast Header ID
The unique identifier of the forecast. -
ForecastItemId: integer
(int64)
Title:
ForecastItem
The unique identifier of the forecast item. -
ForecastOverrideCode: string
Title:
Include in Forecast
Maximum Length:30
Forecast Override code for criteria. -
InventoryItemId: integer
(int64)
Title:
Product ID
Read Only:true
The unique identifier of the inventory item that is generated during product creation. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization that is generated during product creation. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
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. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity associated with the revenue item. -
OpportunityName: string
Title:
Opportunity
Maximum Length:275
The name of the opportunity. -
OpportunityStatusCode: string
Title:
Opportunity Status
Maximum Length:30
The status of the opportunity. -
OwnerName: string
Read Only:
true
Maximum Length:360
The name of the revenue item owner. -
OwnerResourceId: integer
(int64)
Title:
Credit Receiver ID
The unique identifier of the revenue owner. -
OwnerResourceOrgId: integer
(int64)
Title:
Resource Organization ID
The unique identifier of the revenue owner's organization. -
PartnerPartOrgPartyId: integer
(int64)
Title:
Partner Organization ID
The unique identifier of the partner party organization. -
PartnerSourceNumber: string
Title:
Primary Source Number
Maximum Length:30
The source number of the partner. -
PartyUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The name of the sales account associated with the opportunity. -
PrimaryTerritoryId: integer
(int64)
Title:
Primary Territory ID
The unique identifier of the primary territory associated with the revenue item. -
PrimaryTerritoryVersionId: integer
(int64)
Title:
Primary Territory Version ID
The unique identifier of the primary territory version associated with the revenue item. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductName: string
Title:
Product Name
The product name. -
Quantity: number
Title:
Quantity
The quantity of the revenue item. -
RecurTypeCode: string
Title:
Recurrence Type Code
Maximum Length:30
The code indicating if the opportunity is recurring. -
RevenueAmount: number
Title:
Revenue
The revenue amount associated with the revenue item. -
RevenueId: integer
(int64)
Title:
Revenue ID
The unique identifier of the revenue item associated with the forecast item. -
RevenueStatusCode: string
Title:
Status
Maximum Length:30
The status of the revenue item. -
RevenueTerritoryId: integer
(int64)
The unique identifier of the revenue territory. This attribute is populated only when a revenue item is pulled into a subordinate forecast by the manager.
-
UnadjustedQuantity: number
Title:
Unadjusted Quantity
Default Value:0
The value of the unadjusted quantity. -
UnitPrice: number
Title:
Estimated Price
The unit price of the revenue item. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
UserLastUpdateDate: string
(date-time)
Read Only:
true
The date when the user last updated the record. -
WinProbability: integer
(int32)
Title:
Win Probability
The win probability value of the revenue item. -
WorstCaseAdjustedForecast: number
Title:
Adjusted Worst Case
The worst case value of the revenue item after adjustments.
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.
Examples
The following example shows how to update a forecast item by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/7414679/child/ForecastItemDetail/300100093651349
Example of Request Body
The following shows an example of the request body in JSON format.
{ "AdjustedQuantity": 100 }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "ForecastItemId": 300100093651349 "ForecastHeaderId": 300100093651293 "OpportunityId": 300100090774946 "RevenueId": 300100090774951 "CustomerPartyId": 999997550776400 "OpportunityName": "ZSF_Auto_FUSE_fd591182741" "RevenueAmount": 250000 "WinProbability": 90 "RevenueStatusCode": "OPEN" "EffectiveDate": "2016-04-16" "OpportunityStatusCode": "OPEN" "BUOrgId": 5186 "PrimaryTerritoryId": 300100012891886 "PrimaryTerritoryVersionId": 300100026843435 "ProductGroupId": 999997826070652 "OwnerResourceId": 300100027483620 "RecurTypeCode": "NONRECUR" "AdjustPeriodId": 300100093651311 "CorporateUnadjustedRevenueAmount": 250000 "CorporateUnadjustedDownsideAmount": 0 "CorporateUnadjustedUpsideAmount": 250000 "PartyUniqueName": "CUSTOMER_101791834 (Redwood City, US)" "CorporateCurrencyCode": "USD" "CurrentStageId": 100000012430007 "AdjustedForecast": 250000 "ProductName": "Agile Applications" "BestCaseAdjustedForecast": 250000 "WorstCaseAdjustedForecast": 0 "OwnerName": "ZSF Sales_Rep3" "UnadjustedQuantity": 0 "AdjustedQuantity": 100 ... }