Create an entitlement plan estimate
post
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/estimates
Request
Path Parameters
-
EntitlementPlanNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
Amount: number
Title:
Amount
The amount of the subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of the subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code of the subscription entitlement plan estimates.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription entitlement plan estimates. -
ChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the subscription entitlement plan estimates.
-
ChargePeriod: string
Title:
Estimate Period
The estimate period of the subscription entitlement plan estimates. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rollover
Maximum Length:1
Default Value:false
Indicates whether the rollover is enabled for the subscription entitlement plan estimates. -
EntitlementPlanEstimateId: integer
(int64)
The unique identifier of the subscription entitlement plan estimates.
-
EntitlementPlanEstimateNumber: string
Maximum Length:
120
The unique number of entitlement plan estimates. -
EntitlementPlanId: integer
(int64)
The unique identifier of entitlement plan of the subscription entitlement plan estimates.
-
Period: string
Title:
Periodicity
The period of the subscription entitlement plan estimates. -
Quantity: number
Title:
Quantity
The quantity of the subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover Period
The rollover period of the subscription entitlement plan estimates. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The rollover period unit of measure of the subscription entitlement plan estimates. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity of the subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The unique identifier of subscription product of the subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overage
Maximum Length:1
Default Value:true
Indicates whether a overage is enabled for a given usage charge. -
TrueupShortageFlag: boolean
Title:
True-up shortage
Maximum Length:1
Default Value:true
Indicates whether a shortage is enabled for a given usage charge. -
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of the subscription entitlement plan estimates.
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 : subscriptionEntitlementPlans-estimates-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount of the subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of the subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code of the subscription entitlement plan estimates.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription entitlement plan estimates. -
ChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the subscription entitlement plan estimates.
-
ChargePeriod: string
Title:
Estimate Period
The estimate period of the subscription entitlement plan estimates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan estimates. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan estimates was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rollover
Maximum Length:1
Default Value:false
Indicates whether the rollover is enabled for the subscription entitlement plan estimates. -
EntitlementPlanEstimateId: integer
(int64)
The unique identifier of the subscription entitlement plan estimates.
-
EntitlementPlanEstimateNumber: string
Maximum Length:
120
The unique number of entitlement plan estimates. -
EntitlementPlanId: integer
(int64)
The unique identifier of entitlement plan of the subscription entitlement plan estimates.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan estimates was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan estimates. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan estimates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of the subscription entitlement plan estimates. -
Period: string
Title:
Periodicity
The period of the subscription entitlement plan estimates. -
Quantity: number
Title:
Quantity
The quantity of the subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover Period
The rollover period of the subscription entitlement plan estimates. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The rollover period unit of measure of the subscription entitlement plan estimates. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity of the subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The unique identifier of subscription product of the subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overage
Maximum Length:1
Default Value:true
Indicates whether a overage is enabled for a given usage charge. -
TrueupShortageFlag: boolean
Title:
True-up shortage
Maximum Length:1
Default Value:true
Indicates whether a shortage is enabled for a given usage charge. -
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of the subscription entitlement plan estimates.
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.