Create an adjustment
post
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/charges/{ChargePuid}/child/adjustments
Request
Path Parameters
-
ChargePuid(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=
-
CoveredLevelPuid(required): string
The public unique identifier of the covered level.
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
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
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis of the adjustment. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the adjustment. -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the adjustment. -
AdjustmentValue: number
Title:
Value
The value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason Description
Maximum Length:120
The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
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 : subscriptionProducts-coveredLevels-charges-adjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis of the adjustment. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the adjustment. -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the adjustment. -
AdjustmentValue: number
Title:
Value
The value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the adjustment was created. -
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason Description
Maximum Length:120
The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
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.