Update a bill adjustment
patch
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}/child/billLines/{BillLinePuid2}/child/billAdjustments/{BillAdjustmentPuid}
Request
Path Parameters
-
BillAdjustmentPuid(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=
-
BillLinePuid(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: string
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: string
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-
AdjustmentBasis: string
Title:
BasisMaximum Length:30The basis on which the bill is adjusted. -
AdjustmentCategoryCode: string
Title:
Adjustment CategoryMaximum Length:30The code of the adjustment category. -
AdjustmentName: string
Title:
AdjustmentMaximum Length:120The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30The code of the adjustment reason. -
AdjustmentStepSequenceNumber: number
Title:
Step Sequence NumberThe alternate unique identifier of the adjustment step sequence. -
AdjustmentType: string
Title:
TypeMaximum Length:30The type of the bill adjustment. -
AdjustmentValue: number
Title:
ValueThe value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30The effectivity of the bill adjustment. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
PERPeriodFlag: boolean
Title:
Per periodMaximum Length:1Indicates whether the adjustment is per charge period. -
PERQuantityFlag: boolean
Title:
Per quantityMaximum Length:1Indicates whether the adjustment is per sub quantity. -
Reason: string
Title:
Reason DetailsMaximum Length:120The reason why the bill is adjusted. -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start DateRevenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End DateRevenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity PeriodsMaximum Length:30Revenue Period -
SequenceNumber: number
Title:
SequenceThe sequence number of the bill 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-billLines-billAdjustments-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Title:
BasisMaximum Length:30The basis on which the bill is adjusted. -
AdjustmentCategoryCode: string
Title:
Adjustment CategoryMaximum Length:30The code of the adjustment category. -
AdjustmentName: string
Title:
AdjustmentMaximum Length:120The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30The code of the adjustment reason. -
AdjustmentStepSequenceNumber: number
Title:
Step Sequence NumberThe alternate unique identifier of the adjustment step sequence. -
AdjustmentType: string
Title:
TypeMaximum Length:30The type of the bill adjustment. -
AdjustmentValue: number
Title:
ValueThe value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Title:
Charge Adjustment PUIDMaximum Length:120Charge Adjustment Puid -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
PERPeriodFlag: boolean
Title:
Per periodMaximum Length:1Indicates whether the adjustment is per charge period. -
PERQuantityFlag: boolean
Title:
Per quantityMaximum Length:1Indicates whether the adjustment is per sub quantity. -
Reason: string
Title:
Reason DetailsMaximum Length:120The reason why the bill is adjusted. -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start DateRevenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End DateRevenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity PeriodsMaximum Length:30Revenue Period -
SequenceNumber: number
Title:
SequenceThe sequence number of the bill adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- AdjustmentBasisVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_PRICE_ADJUSTMENT_BASIS
The list of values indicating requested adjustment basis identifiers.
The following properties are defined on the LOV link relation:- Source Attribute: AdjustmentBasis; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AdjustmentReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BILL_ADJ_REASON
The list of values indicating the adjustment reason code.
The following properties are defined on the LOV link relation:- Source Attribute: AdjustmentReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AdjustmentTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_PRICE_ADJUSTMENT_TYPE
The list of values indicating requested adjustment type identifiers.
The following properties are defined on the LOV link relation:- Source Attribute: AdjustmentType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevenueEffectivityPeriodVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_ADJ_PRD_EFFY
The list of values indicating revenue effectivity period identifiers.
The following properties are defined on the LOV link relation:- Source Attribute: RevenuePeriod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RevenueOptionVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_REV_OPTIONS
The list of values indicating requested revenue option identifiers.
The following properties are defined on the LOV link relation:- Source Attribute: RevenueOption; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: