Create a child split revenue
post
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/ChildSplitRevenue
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ExtnPartyName: string
Title:
Owner
The name of the revenue owner. -
ExtnPartyNameLOVSwitcher: string
The switcher for ist of values for the revenue owner, used in UI scenarios.
-
ForecastTerritoryName: string
Title:
Territory Name
Maximum Length:60
The name of the forecast territory. -
OwnerLockAsgnFlag: boolean
Title:
Lock Credit Owner
Maximum Length:1
Default Value:false
Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system. -
PrTerritoryVersionId: integer
(int64)
Title:
Forecast Territory
Forecast territory version identifier. -
PrTerritoryVersionIdForManual: string
Title:
Manually Assigned Territory Version ID
Indicates the version ID of a territory that is to be manually assigned to the revenue record. -
ResourcePartyId: integer
(int64)
Title:
Owner
The identifier of the resource associated with the child split revenue. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
The revenue amount. -
RevnAmountCurcyCode: string
Title:
Currency
Maximum Length:15
The currency the amount on this revenue line is based on. -
RevnId: integer
(int64)
The unique identifier of the child split revenue.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
The unique number for the revenue line. -
SalesCreditTypeCode: string
Title:
Sales Credit Type
Maximum Length:30
Default Value:QUOTA
Indicates the type of credit. -
SplitPercent: number
Title:
Sales Credit
The percentage of split revenue.
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-ChildSplitRevenue-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. -
ExtnPartyName: string
Title:
Owner
The name of the revenue owner. -
ExtnPartyNameLOVSwitcher: string
The switcher for ist of values for the revenue owner, used in UI scenarios.
-
ForecastTerritoryName: string
Title:
Territory Name
Maximum Length:60
The name of the forecast territory. -
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. -
Name: string
Title:
Organization
Read Only:true
The name of the resource organization associated the with revenue. -
OwnerLockAsgnFlag: boolean
Title:
Lock Credit Owner
Maximum Length:1
Default Value:false
Indicates if the credit recipients of the revenue line should be locked from re-assignment by the system. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number for the owner of child split revenue. -
PrTerritoryUpdatedByPartyName: string
Title:
Updated By
Read Only:true
Maximum Length:360
The name of the user who last updated the forecast territory. -
PrTerritoryVersionId: integer
(int64)
Title:
Forecast Territory
Forecast territory version identifier. -
PrTerritoryVersionIdForManual: string
Title:
Manually Assigned Territory Version ID
Indicates the version ID of a territory that is to be manually assigned to the revenue record. -
ResourcePartyId: integer
(int64)
Title:
Owner
The identifier of the resource associated with the child split revenue. -
RevnAmount: number
Title:
Line Revenue
Default Value:0
The revenue amount. -
RevnAmountCurcyCode: string
Title:
Currency
Maximum Length:15
The currency the amount on this revenue line is based on. -
RevnId: integer
(int64)
The unique identifier of the child split revenue.
-
RevnNumber: string
Title:
Revenue Number
Maximum Length:30
The unique number for the revenue line. -
SalesCreditTypeCode: string
Title:
Sales Credit Type
Maximum Length:30
Default Value:QUOTA
Indicates the type of credit. -
SplitPercent: number
Title:
Sales Credit
The percentage of split revenue. -
TerrOwnerPartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the forecast territory owner.
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.
Links
- OwnerLockAsgnFlagLookupPVO
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
The lookups resource is used to view standard lookup codes. - finder:
- SalesCreditTypeLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_SALES_CREDIT_TYPE
The lookups resource is used to view standard lookup codes. - finder:
- TerritoryListVA
-
An entity that holds the various versions of a sales territory. Each version record contains most of the key attributes of a territory. Most of the sales territory object components are child entities to a sales territory version, for example, territory rules, territory rule boundaries, territory rule boundary values, and territory resources.