Update a covered level
patch
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/coveredLevels/{CoveredLevelPuid}
Request
Path Parameters
-
CoveredLevelPuid(required): string
The covered level PUID
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
SubscriptionProductPuid(required): string
The subscription product PUID.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site associated with child covered level. -
AssetGroupId: integer
(int64)
The unique identifier of the asset group.
-
AssetGroupName: string
Title:
Asset Group Name
The name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group Number
The alternate identifier of an asset group. -
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Covered Level Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial Number
The universal serial number associated with the asset. -
billLines: array
Bill Lines
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the child covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancel description associated with a child covered level. -
CanceledAmount: number
The amount that was cancelled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date of cancellation. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancellation. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the charges for a subscription. -
childCoveredLevels: array
Child Covered Levels
Title:
Child Covered Levels
The child covered levels resource is used to view, create, update, and delete the subscription child covered levels. -
ClosedAmount: number
The amount when the covered level was closed.
-
ClosedDate: string
(date)
Title:
Covered Level Close Date
The date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close Description
Maximum Length:2000
The close description associated with a child covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason when the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. 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. -
CoveredLevelName: string
Title:
Covered Level Name
Maximum Length:300
The name of the covered level. -
CoveredLevelParentPuid: string
The covered parent for the parent.
-
CoveredLevlName: string
Title:
Covered Level Name
The name of the covered level associated with child covered level. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level associated with child covered level. -
CreditedAmount: number
The credited amount for the covered level.
-
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
The unique identifier of the customer account associated with child covered level.
-
CustomerName: string
Title:
Customer Account
The name of the customer associated with child covered level. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer associated with child covered level. -
Description: string
Title:
Covered Level Description
The description of the covered level. -
Duration: integer
The duration for which the covered level is active.
-
EndDate: string
(date)
Title:
Covered Level End Date
The end date for the covered level. -
ExplodeAssetHierarchy: string
The explode hierarchy for the asset.
-
GenerateBillingSchedule: string
The schedule by the bill is generated.
-
HierarchyTotal: number
The total when the covered level was closed.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The invoiced amount.
-
InvoiceText: string
Maximum Length:
2000
The text to be included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used by the item. -
LineNumber: string
Title:
Number
Maximum Length:300
The line number. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the child covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The parent level for the level.
-
PartyId: integer
(int64)
The unique identifier of the party associated with child covered level.
-
PartyName: string
Title:
Party Name
The name of the party associated with child covered level. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party associated with child covered level. -
PartySite: string
Title:
Party Site Number
The name of the party site associated with child covered level. -
PartySiteId: integer
(int64)
The unique identifier of the party site associated with child covered level.
-
Period: string
Maximum Length:
80
The period during which the covered level is used. -
PriceAsOf: string
(date)
The price of the covered level.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used by the item. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The name of the unit of measure. -
PricingError: string
Maximum Length:
1000
Any errors associated with the pricing. -
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductGroupName: string
Title:
Product Group Name
The name of the product group. -
ProductGroupNumber: string
Title:
Product Group Number
The alternate identifier of a product group. -
ProductName: string
Title:
Product Name
The name of the product. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity for which the bill line was charged. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships. -
RemoveHoldFlag: boolean
Indicates if the covered level's hold has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The return method for the credit after the covered level was closed. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The total when the covered level was closed.
-
SourceKey: string
Maximum Length:
120
The source key of the child covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the child covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the child covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the child covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the child covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The start date for the covered level. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The description of the status. -
SubscriptionId: integer
(int64)
The unique identifier of the associated subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The suppressed amount for the credit.
-
SuspendCreditMethod: string
Maximum Length:
30
The suspend method for the credit after the covered level was closed. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend Date
The date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend Reason
Maximum Length:30
The reason when the covered level was suspended. -
TaxAmount: number
The amount of tax to be deducted.
-
TaxError: string
Maximum Length:
4000
The tax error for the covered level. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value -
TypeName: string
Title:
Covered Level Type
The type name associated with the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the covered level associated with child covered level.
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The charges resource is used to view, create, update, and delete the charges for a subscription.
Show Source
Nested Schema : Child Covered Levels
Type:
array
Title:
Child Covered Levels
The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships.
Show Source
Nested Schema : subscriptions-products-coveredLevels-billLines-item-patch-request
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount of the bill. -
billAdjustments: array
Bill Adjustments
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details. -
BillingPeriod: number
Title:
Sequence
The billing period. -
BillLinePuid: string
Maximum Length:
120
The bill line PUID. -
BusinessUnitId: integer
The ID of the business unit associated with the bill line.
-
ChargeDefinition: string
Maximum Length:
30
The definition that indicates the purpose of the charge. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the charge. -
ChargePeriod: number
Title:
Period
The charge period. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
CoveredLevelId: integer
(int64)
The unique identifier of the coverage level.
-
CreditMemoAmount: number
The amount for the credit memo.
-
CreditMemoFlag: string
Indicates if there is a credit memo associated with the bill line.
-
CreditMemoReason: string
The reason to raise the credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
The code of the credit memo reason code. -
CustomerTrxTypeSequenceId: integer
(int64)
The unique identifier of the customer transaction type sequence.
-
DateBilledFrom: string
(date)
Title:
Bill-from Date
The date from which the billing is done. -
DateBilledTo: string
(date)
Title:
Bill-to Date
The date to which the billing is done. -
DateToInterface: string
(date)
Title:
Interface Date
The date to interface. -
InterfacedFlag: boolean
Title:
Interfaced
Maximum Length:1
Default Value:false
Indicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The invoice bill line ID.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice Text
Maximum Length:240
The invoice text of the transaction. -
ListPrice: number
The list price.
-
MilestoneEventId: integer
(int64)
The ID of the milestone event associated with the bill line.
-
MilestoneEventName: string
The name of the milestone event associated with the bill line.
-
NewCreditMemoPUID: string
The unique public identifier of the new credit memo.
-
PricedQuantity: number
The quantity for which the bill line was charged.
-
PricingError: string
Maximum Length:
1000
The pricing error. -
RecurringFlag: boolean
Maximum Length:
1
Indicates whether this line is recurring or not. -
RetrieveInvoiceFlag: boolean
Title:
Retrieve Invoice from Receivables
Maximum Length:1
Retrieve Invoice Flag -
RevenueLineId: integer
(int64)
The unique identifier of the revenue line.
-
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SummarizedBillLineId: integer
Title:
Summarized Bill Line ID
Summarized Bill Line ID -
TransactionAmount: number
Title:
Invoice Amount
The amount of the transaction. -
TransactionClass: string
Title:
Transaction Class
Maximum Length:30
The class of the transaction. -
TransactionClassMeaning: string
Title:
Class
The meaning of transaction class lookup. -
TransactionDate: string
(date)
Title:
Invoice Date
The date of the transaction. -
TransactionNumber: string
Title:
Invoice Number
Maximum Length:30
The alternate identifier of the transaction. -
TransactionTax: number
Title:
Tax
The tax related to the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3
Indicates whether the bill line has a true up period. -
TrxId: integer
(int64)
The transaction identifier associated with the billing.
-
TrxLineId: integer
(int64)
The unique identifier of the transaction line.
-
UsageAcquiredFlag: boolean
Maximum Length:
1
Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
The usage capture date.
-
UsageChargeType: string
Title:
Usage Charge Type
Maximum Length:30
The type of usage charge. -
UsageChargeTypeName: string
The name of the usage charge type.
-
UsageFlag: boolean
Maximum Length:
1
Indicates whether the line is a usage line or not. -
UsagePricedFlag: boolean
Maximum Length:
1
Indicates whether usage line has been priced or not. -
UsageQuantity: number
Title:
Usage Quantity
The usage quantity.
Nested Schema : Bill Adjustments
Type:
array
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.
Show Source
Nested Schema : subscriptions-products-coveredLevels-billLines-billAdjustments-item-patch-request
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The adjustment basis -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The adjustment name -
AdjustmentReasonCode: string
Maximum Length:
30
The code of the adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The adjustment type -
AdjustmentValue: number
Title:
Value
The adjustment value -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Flag indicating whether the adjustment is automatic or not -
BasisEnableFlag: boolean
Indicates if the basis has been enabled for the bill.
-
BillAdjustmentId: integer
(int64)
The bill adjustment ID
-
BillAdjustmentPuid: string
Maximum Length:
120
The bill adjustment PUID -
BillLineId: integer
(int64)
The bill line ID
-
ChargeAdjustmentId: integer
(int64)
The charge adjustment ID
-
CurrencyCode: string
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
-
Effectivity: string
Maximum Length:
30
The adjustment effectivity -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from
-
PeriodUntil: number
The period until
-
Reason: string
Title:
Reason Details
Maximum Length:120
The adjustment reason -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start Date
Revenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End Date
Revenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SequenceNumber: number
Title:
Sequence
The sequence number -
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
Nested Schema : subscriptions-products-coveredLevels-charges-item-patch-request
Type:
Show Source
object
-
adjustments: array
Adjustments
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge. -
AggregationMethod: string
Maximum Length:
30
The aggregation method used for the charges. -
Allowance: number
Title:
Allowance
The allowance -
AssetMeterYn: boolean
Maximum Length:
1
The flag whether it is an asset meter or not. -
BillingFreq: string
Maximum Length:
30
Billing Frequency -
BillingFreqName: string
Title:
Billing Frequency
Maximum Length:255
Billing Frequency Name -
BillLineId: integer
(int64)
The bill line ID
-
BlockSize: number
Title:
Block Size
The block size -
ChargeDefinition: string
Title:
Charge Name
Maximum Length:30
The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
The charge definition name
-
ChargeId: integer
(int64)
The charge ID
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription. -
ChargeName: string
Title:
Charge Name
Maximum Length:120
The charge name -
ChargePeriodCode: string
Maximum Length:
30
The code of the charge period associated with the charge. -
ChargePuid: string
Maximum Length:
120
The charge PUID -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
EnableProration: string
Maximum Length:
1
Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated Amount
The estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation Method
The method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated Quantity
The estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation Method
Maximum Length:30
The method used to estimate the amount. -
ExternalKey: string
Maximum Length:
120
The external key -
ExternalParentKey: string
Maximum Length:
120
The external parent key -
InitialMeterReadingId: integer
(int64)
The initial meter reading identifier value.
-
InvoicingRuleId: integer
(int64)
The ID of the invoice rule.
-
InvoicingRuleName: string
Title:
Invoicing Rule
The name of the invoice rule. -
MeterDefinitionId: integer
(int64)
The unique identifier of the meter definition associated with the charges.
-
MeterId: integer
(int64)
The unique identifier of the meter associated with the charges.
-
MilestoneBillingFlag: boolean
Indicates whether the billing is impacted by milestone events or not.
-
MilestoneRevenueFlag: boolean
Indicates whether the revenue is impacted by milestone events or not.
-
MilestoneTemplateId: integer
(int64)
The ID of the milestone event associated with a charge.
-
MilestoneTemplateName: string
Maximum Length:
120
The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum Amount
The minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum Quantity
The minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Maximum Length:
1
Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue Recognition
Maximum Length:1
Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number -
PricePeriodicity: string
Title:
Periodicity
Maximum Length:30
The price periodicity -
PricePeriodicityName: string
The price periodicity name
-
PriceType(required): string
Maximum Length:
30
The price type -
QuotedTcv: number
The quoted TCV of the charge.
-
RecurringPricePeriodicityCode: string
Maximum Length:
30
The recurring price periodicity code of the charge. -
RollupFlag: boolean
Maximum Length:
1
Indicates if the charges are rolled up. -
SequenceNumber: integer
(int32)
The sequence number
-
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
-
TieredFlag: boolean
Maximum Length:
3
The flag indicating whether the charge has tiers -
TierType: string
Title:
Tier Type
Maximum Length:30
The tier type -
TrueUpPeriod: string
Title:
True Up Period
Maximum Length:30
Default Value:ORA_OSS_USAGE_BILLING_PERIOD
The identifier of the true up period. -
TrueUpPeriodName: string
Title:
True Up Period
The name of the true up period. -
UnitListPrice: number
Title:
List Price
The unit list price -
UsagePriceLockFlag: boolean
Maximum Length:
3
Flag indicating whether the usage price is locked or not -
UsageUnitOfMeasure: string
Maximum Length:
3
The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
array
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
Show Source
Nested Schema : Charge Milestone Events
Type:
array
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
Show Source
Nested Schema : Charge Tiers
Type:
array
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
Show Source
Nested Schema : subscriptions-products-coveredLevels-charges-adjustments-item-patch-request
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The adjustment basis -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The adjustment name -
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 adjustment type -
AdjustmentValue: number
Title:
Value
The adjustment value -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Flag indicating whether the adjustment is automatic or not -
ChargeAdjustmentId: integer
(int64)
The charge adjustment ID
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The charge adjustment PUID -
ChargeId: integer
(int64)
The charge ID
-
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
Object version number
-
PeriodFrom: number
The period from
-
PeriodUntil: number
The period until
-
Reason: string
Title:
Reason Description
Maximum Length:120
The adjustment reason -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number -
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
Nested Schema : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-patch-request
Type:
Show Source
object
-
BillingOffset: number
The billing offset associated with a milestone event.
-
BillLineId: integer
(int64)
The bill line ID associated with the milestone event.
-
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120
Default Value:Charges.ChargePuid
The PUID of the charge to which the milestone event is associated. -
CompletionDate: string
(date)
The completion date of the milestone event.
-
EventSource: string
Maximum Length:
30
The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120
The source reference of the milestone event. -
EventType: string
Maximum Length:
30
The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
MilestoneComment: string
Maximum Length:
300
The milestone event comment. -
MilestoneName: string
Maximum Length:
30
The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120
The milestone event PUID. -
ObjectVersionNumber: integer
(int32)
The object version number of the milestone event.
-
Percentage: number
The percentage associated with a milestone event.
Nested Schema : subscriptions-products-coveredLevels-charges-chargeTiers-item-patch-request
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
The additional number five -
AdditionalNumberFour: number
Title:
Additional Number Four
The additional number four -
AdditionalNumberOne: number
Title:
Additional Number One
The additional number one -
AdditionalNumberSix: number
Title:
Additional Number Six
The additional number six -
AdditionalNumberThree: number
Title:
Additional Number Three
The additional number three -
AdditionalNumberTwo: number
Title:
Additional Number Two
The additional number two -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
The additional text one -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
The additional text two -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
The additional timestamp one -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
The additional timestamp three -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
The additional timestamp two -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
The additional text three -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The charge ID
-
ChargeTierId: integer
(int64)
The charge tier ID
-
ChargeTierPuid: string
Maximum Length:
120
The charge tier PUID -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The price format -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
-
TierFrom: number
Title:
Tier From
The tier from -
TierTo: number
Title:
Tier To
The tier to
Nested Schema : schema
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site associated with child covered level. -
AssetGroupId: integer
(int64)
The unique identifier of the asset group.
-
AssetGroupName: string
Title:
Asset Group Name
The name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group Number
The alternate identifier of an asset group. -
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Covered Level Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial Number
The universal serial number associated with the asset. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the child covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancel description associated with a child covered level. -
CanceledAmount: number
The amount that was cancelled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date of cancellation. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancellation. -
ClosedAmount: number
The amount when the covered level was closed.
-
ClosedDate: string
(date)
Title:
Covered Level Close Date
The date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close Description
Maximum Length:2000
The close description associated with a child covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason when the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. 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. -
CoveredLevelName: string
Title:
Covered Level Name
Maximum Length:300
The name of the covered level. -
CoveredLevelParentPuid: string
The covered parent for the parent.
-
CoveredLevlName: string
Title:
Covered Level Name
The name of the covered level associated with child covered level. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level associated with child covered level. -
CreditedAmount: number
The credited amount for the covered level.
-
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
The unique identifier of the customer account associated with child covered level.
-
CustomerName: string
Title:
Customer Account
The name of the customer associated with child covered level. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer associated with child covered level. -
Description: string
Title:
Covered Level Description
The description of the covered level. -
Duration: integer
The duration for which the covered level is active.
-
EndDate: string
(date)
Title:
Covered Level End Date
The end date for the covered level. -
ExplodeAssetHierarchy: string
The explode hierarchy for the asset.
-
GenerateBillingSchedule: string
The schedule by the bill is generated.
-
HierarchyTotal: number
The total when the covered level was closed.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The invoiced amount.
-
InvoiceText: string
Maximum Length:
2000
The text to be included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used by the item. -
LineNumber: string
Title:
Number
Maximum Length:300
The line number. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the child covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The parent level for the level.
-
PartyId: integer
(int64)
The unique identifier of the party associated with child covered level.
-
PartyName: string
Title:
Party Name
The name of the party associated with child covered level. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party associated with child covered level. -
PartySite: string
Title:
Party Site Number
The name of the party site associated with child covered level. -
PartySiteId: integer
(int64)
The unique identifier of the party site associated with child covered level.
-
Period: string
Maximum Length:
80
The period during which the covered level is used. -
PriceAsOf: string
(date)
The price of the covered level.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used by the item. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The name of the unit of measure. -
PricingError: string
Maximum Length:
1000
Any errors associated with the pricing. -
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductGroupName: string
Title:
Product Group Name
The name of the product group. -
ProductGroupNumber: string
Title:
Product Group Number
The alternate identifier of a product group. -
ProductName: string
Title:
Product Name
The name of the product. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity for which the bill line was charged. -
RemoveHoldFlag: boolean
Indicates if the covered level's hold has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The return method for the credit after the covered level was closed. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The total when the covered level was closed.
-
SourceKey: string
Maximum Length:
120
The source key of the child covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the child covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the child covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the child covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the child covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The start date for the covered level. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The description of the status. -
SubscriptionId: integer
(int64)
The unique identifier of the associated subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The suppressed amount for the credit.
-
SuspendCreditMethod: string
Maximum Length:
30
The suspend method for the credit after the covered level was closed. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend Date
The date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend Reason
Maximum Length:30
The reason when the covered level was suspended. -
TaxAmount: number
The amount of tax to be deducted.
-
TaxError: string
Maximum Length:
4000
The tax error for the covered level. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value -
TypeName: string
Title:
Covered Level Type
The type name associated with the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the covered level associated with child covered level.
Nested Schema : subscriptions-products-coveredLevels-relationships-item-patch-request
Type:
Show Source
object
-
OperationLinksPuid: string
Maximum Length:
120
The operation links PUID. -
SourceAssetKey: string
Maximum Length:
120
The source asset key. -
SourceProdAssociationId: integer
(int64)
The unique identifier of the source product association.
-
SourceProdAssociationPuid: string
Maximum Length:
120
The source product association PUID. -
SourceProductPuid: string
Maximum Length:
120
The source product PUID. -
SourceRootAssetKey: string
Maximum Length:
120
The source root asset key. -
TargetProdAssociationId: integer
(int64)
The unique identifier of the target product association.
-
TargetProdAssociationPuid: string
Maximum Length:
120
The target product association PUID. -
TargetProductPuid: string
Maximum Length:
120
The target product PUID.
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 : subscriptions-products-coveredLevels-item-response
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site associated with child covered level. -
AssetGroupId: integer
(int64)
The unique identifier of the asset group.
-
AssetGroupName: string
Title:
Asset Group Name
The name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group Number
The alternate identifier of an asset group. -
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Covered Level Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial Number
The universal serial number associated with the asset. -
billLines: array
Bill Lines
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the child covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancel description associated with a child covered level. -
CanceledAmount: number
The amount that was cancelled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date of cancellation. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancellation. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the charges for a subscription. -
childCoveredLevels: array
Child Covered Levels
Title:
Child Covered Levels
The child covered levels resource is used to view, create, update, and delete the subscription child covered levels. -
ClosedAmount: number
The amount when the covered level was closed.
-
ClosedDate: string
(date)
Title:
Covered Level Close Date
The date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close Description
Maximum Length:2000
The close description associated with a child covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason when the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. 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. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CoveredLevelName: string
Title:
Covered Level Name
Maximum Length:300
The name of the covered level. -
CoveredLevelParentPuid: string
The covered parent for the parent.
-
CoveredLevelPuid: string
Maximum Length:
120
The public unique identifier of the covered level. -
CoveredLevlName: string
Title:
Covered Level Name
The name of the covered level associated with child covered level. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level associated with child covered level. -
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. -
CreditedAmount: number
The credited amount for the covered level.
-
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
The unique identifier of the customer account associated with child covered level.
-
CustomerName: string
Title:
Customer Account
The name of the customer associated with child covered level. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer associated with child covered level. -
Description: string
Title:
Covered Level Description
The description of the covered level. -
Duration: integer
The duration for which the covered level is active.
-
EndDate: string
(date)
Title:
Covered Level End Date
The end date for the covered level. -
ExplodeAssetHierarchy: string
The explode hierarchy for the asset.
-
GenerateBillingSchedule: string
The schedule by the bill is generated.
-
HierarchyTotal: number
The total when the covered level was closed.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The invoiced amount.
-
InvoiceText: string
Maximum Length:
2000
The text to be included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used by the item. -
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. -
LineNumber: string
Title:
Number
Maximum Length:300
The line number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the child covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The parent level for the level.
-
PartyId: integer
(int64)
The unique identifier of the party associated with child covered level.
-
PartyName: string
Title:
Party Name
The name of the party associated with child covered level. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party associated with child covered level. -
PartySite: string
Title:
Party Site Number
The name of the party site associated with child covered level. -
PartySiteId: integer
(int64)
The unique identifier of the party site associated with child covered level.
-
Period: string
Maximum Length:
80
The period during which the covered level is used. -
PriceAsOf: string
(date)
The price of the covered level.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used by the item. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The name of the unit of measure. -
PricingError: string
Maximum Length:
1000
Any errors associated with the pricing. -
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductGroupName: string
Title:
Product Group Name
The name of the product group. -
ProductGroupNumber: string
Title:
Product Group Number
The alternate identifier of a product group. -
ProductName: string
Title:
Product Name
The name of the product. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity for which the bill line was charged. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships. -
RemoveHoldFlag: boolean
Indicates if the covered level's hold has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The return method for the credit after the covered level was closed. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The total when the covered level was closed.
-
SerialNumber: string
Title:
Covered Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the child covered level. -
SourceKey: string
Maximum Length:
120
The source key of the child covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the child covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the child covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the child covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the child covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The start date for the covered level. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The description of the status. -
SubscriptionId: integer
(int64)
The unique identifier of the associated subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The suppressed amount for the credit.
-
SuspendCreditMethod: string
Maximum Length:
30
The suspend method for the credit after the covered level was closed. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend Date
The date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend Reason
Maximum Length:30
The reason when the covered level was suspended. -
TaxAmount: number
The amount of tax to be deducted.
-
TaxError: string
Maximum Length:
4000
The tax error for the covered level. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value -
Type: string
Title:
Type
Maximum Length:30
The type of the covered level. -
TypeName: string
Title:
Covered Level Type
The type name associated with the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the covered level associated with child covered level.
Nested Schema : Bill Lines
Type:
array
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The charges resource is used to view, create, update, and delete the charges for a subscription.
Show Source
Nested Schema : Child Covered Levels
Type:
array
Title:
Child Covered Levels
The child covered levels resource is used to view, create, update, and delete the subscription child covered levels.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships.
Show Source
Nested Schema : subscriptions-products-coveredLevels-billLines-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount of the bill. -
billAdjustments: array
Bill Adjustments
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details. -
BillingPeriod: number
Title:
Sequence
The billing period. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120
The bill line PUID. -
BusinessUnitId: integer
The ID of the business unit associated with the bill line.
-
ChargeDefinition: string
Maximum Length:
30
The definition that indicates the purpose of the charge. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeName: string
Title:
Charge Name
Maximum Length:120
The name of the charge. -
ChargePeriod: number
Title:
Period
The charge period. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Read Only:
true
The charge PUID. -
CoveredLevelId: integer
(int64)
The unique identifier of the coverage level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bill line. -
CreationDate: string
(date-time)
Read Only:
true
The date when the bill line was created. -
CreditMemoAmount: number
The amount for the credit memo.
-
CreditMemoFlag: string
Indicates if there is a credit memo associated with the bill line.
-
CreditMemoReason: string
The reason to raise the credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
The code of the credit memo reason code. -
CustomerTrxTypeSequenceId: integer
(int64)
The unique identifier of the customer transaction type sequence.
-
DateBilledFrom: string
(date)
Title:
Bill-from Date
The date from which the billing is done. -
DateBilledTo: string
(date)
Title:
Bill-to Date
The date to which the billing is done. -
DateToInterface: string
(date)
Title:
Interface Date
The date to interface. -
InterfacedFlag: boolean
Title:
Interfaced
Maximum Length:1
Default Value:false
Indicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The invoice bill line ID.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice Text
Maximum Length:240
The invoice text of the transaction. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the bill line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bill line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the bill line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
The list price.
-
MilestoneEventId: integer
(int64)
The ID of the milestone event associated with the bill line.
-
MilestoneEventName: string
The name of the milestone event associated with the bill line.
-
NewCreditMemoPUID: string
The unique public identifier of the new credit memo.
-
PricedQuantity: number
The quantity for which the bill line was charged.
-
PricingError: string
Maximum Length:
1000
The pricing error. -
RecurringFlag: boolean
Maximum Length:
1
Indicates whether this line is recurring or not. -
RetrieveInvoiceFlag: boolean
Title:
Retrieve Invoice from Receivables
Maximum Length:1
Retrieve Invoice Flag -
RevenueLineId: integer
(int64)
The unique identifier of the revenue line.
-
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SentDate: string
(date)
Title:
Sent Date
The date invoice information is sent to receivables. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SummarizedBillLineId: integer
Title:
Summarized Bill Line ID
Summarized Bill Line ID -
TransactionAmount: number
Title:
Invoice Amount
The amount of the transaction. -
TransactionClass: string
Title:
Transaction Class
Maximum Length:30
The class of the transaction. -
TransactionClassMeaning: string
Title:
Class
The meaning of transaction class lookup. -
TransactionDate: string
(date)
Title:
Invoice Date
The date of the transaction. -
TransactionNumber: string
Title:
Invoice Number
Maximum Length:30
The alternate identifier of the transaction. -
TransactionTax: number
Title:
Tax
The tax related to the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3
Indicates whether the bill line has a true up period. -
TrxId: integer
(int64)
The transaction identifier associated with the billing.
-
TrxLineId: integer
(int64)
The unique identifier of the transaction line.
-
UsageAcquiredFlag: boolean
Maximum Length:
1
Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
The usage capture date.
-
UsageChargeType: string
Title:
Usage Charge Type
Maximum Length:30
The type of usage charge. -
UsageChargeTypeName: string
The name of the usage charge type.
-
UsageFlag: boolean
Maximum Length:
1
Indicates whether the line is a usage line or not. -
UsagePricedFlag: boolean
Maximum Length:
1
Indicates whether usage line has been priced or not. -
UsageQuantity: number
Title:
Usage Quantity
The usage quantity.
Nested Schema : Bill Adjustments
Type:
array
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-billLines-billAdjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The adjustment basis -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The adjustment name -
AdjustmentReasonCode: string
Maximum Length:
30
The code of the adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The adjustment type -
AdjustmentValue: number
Title:
Value
The adjustment value -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Flag indicating whether the adjustment is automatic or not -
BasisEnableFlag: boolean
Indicates if the basis has been enabled for the bill.
-
BillAdjustmentId: integer
(int64)
The bill adjustment ID
-
BillAdjustmentPuid: string
Maximum Length:
120
The bill adjustment PUID -
BillLineId: integer
(int64)
The bill line ID
-
ChargeAdjustmentId: integer
(int64)
The charge adjustment ID
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
CurrencyCode: string
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
-
Effectivity: string
Maximum Length:
30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The last update date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last updated by -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last update login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from
-
PeriodUntil: number
The period until
-
Reason: string
Title:
Reason Details
Maximum Length:120
The adjustment reason -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start Date
Revenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End Date
Revenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity Periods
Maximum Length:30
Revenue Period -
SequenceNumber: number
Title:
Sequence
The sequence number -
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
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.
Nested Schema : subscriptions-products-coveredLevels-charges-item-response
Type:
Show Source
object
-
adjustments: array
Adjustments
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge. -
AggregationMethod: string
Maximum Length:
30
The aggregation method used for the charges. -
Allowance: number
Title:
Allowance
The allowance -
AssetMeterYn: boolean
Maximum Length:
1
The flag whether it is an asset meter or not. -
BillingFreq: string
Maximum Length:
30
Billing Frequency -
BillingFreqName: string
Title:
Billing Frequency
Maximum Length:255
Billing Frequency Name -
BillLineId: integer
(int64)
The bill line ID
-
BlockSize: number
Title:
Block Size
The block size -
ChargeDefinition: string
Title:
Charge Name
Maximum Length:30
The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
The charge definition name
-
ChargeId: integer
(int64)
The charge ID
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription. -
ChargeName: string
Title:
Charge Name
Maximum Length:120
The charge name -
ChargePeriodCode: string
Maximum Length:
30
The code of the charge period associated with the charge. -
ChargePuid: string
Maximum Length:
120
The charge PUID -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
EnableProration: string
Maximum Length:
1
Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated Amount
The estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation Method
The method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated Quantity
The estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation Method
Maximum Length:30
The method used to estimate the amount. -
ExternalKey: string
Maximum Length:
120
The external key -
ExternalParentKey: string
Maximum Length:
120
The external parent key -
InitialMeterReadingId: integer
(int64)
The initial meter reading identifier value.
-
InvoicingRuleId: integer
(int64)
The ID of the invoice rule.
-
InvoicingRuleName: string
Title:
Invoicing Rule
The name of the invoice rule. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last update date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last updated by -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last update login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterDefinitionId: integer
(int64)
The unique identifier of the meter definition associated with the charges.
-
MeterId: integer
(int64)
The unique identifier of the meter associated with the charges.
-
MilestoneBillingFlag: boolean
Indicates whether the billing is impacted by milestone events or not.
-
MilestoneRevenueFlag: boolean
Indicates whether the revenue is impacted by milestone events or not.
-
MilestoneTemplateId: integer
(int64)
The ID of the milestone event associated with a charge.
-
MilestoneTemplateName: string
Maximum Length:
120
The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum Amount
The minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum Quantity
The minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Maximum Length:
1
Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue Recognition
Maximum Length:1
Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number -
PricePeriodicity: string
Title:
Periodicity
Maximum Length:30
The price periodicity -
PricePeriodicityName: string
The price periodicity name
-
PriceType: string
Maximum Length:
30
The price type -
QuotedTcv: number
The quoted TCV of the charge.
-
RecurringPricePeriodicityCode: string
Maximum Length:
30
The recurring price periodicity code of the charge. -
RollupFlag: boolean
Maximum Length:
1
Indicates if the charges are rolled up. -
SequenceNumber: integer
(int32)
The sequence number
-
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
-
TieredFlag: boolean
Maximum Length:
3
The flag indicating whether the charge has tiers -
TierType: string
Title:
Tier Type
Maximum Length:30
The tier type -
TrueUpPeriod: string
Title:
True Up Period
Maximum Length:30
Default Value:ORA_OSS_USAGE_BILLING_PERIOD
The identifier of the true up period. -
TrueUpPeriodName: string
Title:
True Up Period
The name of the true up period. -
UnitListPrice: number
Title:
List Price
The unit list price -
UsagePriceLockFlag: boolean
Maximum Length:
3
Flag indicating whether the usage price is locked or not -
UsageUnitOfMeasure: string
Maximum Length:
3
The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
array
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete any adjustments to the subscription charge.
Show Source
Nested Schema : Charge Milestone Events
Type:
array
Title:
Charge Milestone Events
The charge milestone events resource is used to view, create, update, and delete the milestone events associated with a charge of a subscription.
Show Source
Nested Schema : Charge Tiers
Type:
array
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details for a subscription.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-charges-adjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The adjustment basis -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The adjustment name -
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 adjustment type -
AdjustmentValue: number
Title:
Value
The adjustment value -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Flag indicating whether the adjustment is automatic or not -
ChargeAdjustmentId: integer
(int64)
The charge adjustment ID
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The charge adjustment PUID -
ChargeId: integer
(int64)
The charge ID
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The last update date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last updated by -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last update login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
Object version number
-
PeriodFrom: number
The period from
-
PeriodUntil: number
The period until
-
Reason: string
Title:
Reason Description
Maximum Length:120
The adjustment reason -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number -
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-charges-chargeMilestoneEvents-item-response
Type:
Show Source
object
-
BillingOffset: number
The billing offset associated with a milestone event.
-
BillLineId: integer
(int64)
The bill line ID associated with the milestone event.
-
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120
Default Value:Charges.ChargePuid
The PUID of the charge to which the milestone event is associated. -
CompletionDate: string
(date)
The completion date of the milestone event.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The login which created the milestone event. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the milestone event was created. -
EventId: integer
(int64)
The ID of the milestone event.
-
EventSource: string
Maximum Length:
30
The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120
The source reference of the milestone event. -
EventType: string
Maximum Length:
30
The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date of which the milestone event was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the milestone event the last. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login which updated the milestone event the last. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MilestoneComment: string
Maximum Length:
300
The milestone event comment. -
MilestoneName: string
Maximum Length:
30
The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120
The milestone event PUID. -
ObjectVersionNumber: integer
(int32)
The object version number of the milestone event.
-
Percentage: number
The percentage associated with a milestone event.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
The additional number five -
AdditionalNumberFour: number
Title:
Additional Number Four
The additional number four -
AdditionalNumberOne: number
Title:
Additional Number One
The additional number one -
AdditionalNumberSix: number
Title:
Additional Number Six
The additional number six -
AdditionalNumberThree: number
Title:
Additional Number Three
The additional number three -
AdditionalNumberTwo: number
Title:
Additional Number Two
The additional number two -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
The additional text one -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
The additional text two -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
The additional timestamp one -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
The additional timestamp three -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
The additional timestamp two -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
The additional text three -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The charge ID
-
ChargeTierId: integer
(int64)
The charge tier ID
-
ChargeTierPuid: string
Maximum Length:
120
The charge tier PUID -
CreatedBy: string
Read Only:
true
Maximum Length:64
The created by -
CreationDate: string
(date-time)
Read Only:
true
The creation date -
LastUpdateDate: string
(date-time)
Read Only:
true
The last update date -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last updated by -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last update login -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The list price -
PriceFormat: string
Title:
Price Format
Maximum Length:30
The price format -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The subscription ID
-
SubscriptionProductId: integer
(int64)
The subscription product ID
-
TierFrom: number
Title:
Tier From
The tier from -
TierTo: number
Title:
Tier To
The tier to
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-childCoveredLevels-item-response
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site associated with child covered level. -
AssetGroupId: integer
(int64)
The unique identifier of the asset group.
-
AssetGroupName: string
Title:
Asset Group Name
The name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group Number
The alternate identifier of an asset group. -
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Covered Level Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial Number
The universal serial number associated with the asset. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the child covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancel description associated with a child covered level. -
CanceledAmount: number
The amount that was cancelled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date of cancellation. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancellation. -
ClosedAmount: number
The amount when the covered level was closed.
-
ClosedDate: string
(date)
Title:
Covered Level Close Date
The date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close Description
Maximum Length:2000
The close description associated with a child covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason when the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the account. 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. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CoveredLevelName: string
Title:
Covered Level Name
Maximum Length:300
The name of the covered level. -
CoveredLevelParentPuid: string
The covered parent for the parent.
-
CoveredLevelPuid: string
Maximum Length:
120
The public unique identifier of the covered level. -
CoveredLevlName: string
Title:
Covered Level Name
The name of the covered level associated with child covered level. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level associated with child covered level. -
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. -
CreditedAmount: number
The credited amount for the covered level.
-
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Maximum Length:
15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
The unique identifier of the customer account associated with child covered level.
-
CustomerName: string
Title:
Customer Account
The name of the customer associated with child covered level. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer associated with child covered level. -
Description: string
Title:
Covered Level Description
The description of the covered level. -
Duration: integer
The duration for which the covered level is active.
-
EndDate: string
(date)
Title:
Covered Level End Date
The end date for the covered level. -
ExplodeAssetHierarchy: string
The explode hierarchy for the asset.
-
GenerateBillingSchedule: string
The schedule by the bill is generated.
-
HierarchyTotal: number
The total when the covered level was closed.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The invoiced amount.
-
InvoiceText: string
Maximum Length:
2000
The text to be included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used by the item. -
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. -
LineNumber: string
Title:
Number
Maximum Length:300
The line number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the child covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The parent level for the level.
-
PartyId: integer
(int64)
The unique identifier of the party associated with child covered level.
-
PartyName: string
Title:
Party Name
The name of the party associated with child covered level. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party associated with child covered level. -
PartySite: string
Title:
Party Site Number
The name of the party site associated with child covered level. -
PartySiteId: integer
(int64)
The unique identifier of the party site associated with child covered level.
-
Period: string
Maximum Length:
80
The period during which the covered level is used. -
PriceAsOf: string
(date)
The price of the covered level.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used by the item. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The name of the unit of measure. -
PricingError: string
Maximum Length:
1000
Any errors associated with the pricing. -
ProductGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductGroupName: string
Title:
Product Group Name
The name of the product group. -
ProductGroupNumber: string
Title:
Product Group Number
The alternate identifier of a product group. -
ProductName: string
Title:
Product Name
The name of the product. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity for which the bill line was charged. -
RemoveHoldFlag: boolean
Indicates if the covered level's hold has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription child covered level should be repriced or not. If passed as 'true', the subscription child covered level will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The return method for the credit after the covered level was closed. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The total when the covered level was closed.
-
SerialNumber: string
Title:
Covered Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the child covered level. -
SourceKey: string
Maximum Length:
120
The source key of the child covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the child covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the child covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the child covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the child covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The start date for the covered level. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The description of the status. -
SubscriptionId: integer
(int64)
The unique identifier of the associated subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The suppressed amount for the credit.
-
SuspendCreditMethod: string
Maximum Length:
30
The suspend method for the credit after the covered level was closed. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend Date
The date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend Reason
Maximum Length:30
The reason when the covered level was suspended. -
TaxAmount: number
The amount of tax to be deducted.
-
TaxError: string
Maximum Length:
4000
The tax error for the covered level. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value -
Type: string
Title:
Type
Maximum Length:30
The type of the covered level. -
TypeName: string
Title:
Covered Level Type
The type name associated with the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the covered level associated with child covered level.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-coveredLevels-relationships-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. -
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. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number. -
OperationLinksPuid: string
Maximum Length:
120
The operation links PUID. -
RelationshipTypeCode: string
Maximum Length:
30
The relationship type code. -
SourceAssetKey: string
Maximum Length:
120
The source asset key. -
SourceProdAssociationId: integer
(int64)
The unique identifier of the source product association.
-
SourceProdAssociationPuid: string
Maximum Length:
120
The source product association PUID. -
SourceProductPuid: string
Maximum Length:
120
The source product PUID. -
SourceRootAssetKey: string
Maximum Length:
120
The source root asset key. -
TargetProdAssociationId: integer
(int64)
The unique identifier of the target product association.
-
TargetProdAssociationPuid: string
Maximum Length:
120
The target product association PUID. -
TargetProductPuid: string
Maximum Length:
120
The target product PUID.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- billLines
-
Parameters:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The bill lines resource is used to view, create, update, and delete the subscription bill line details. - CoveredLevelPuid:
- charges
-
Parameters:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The charges resource is used to view, create, update, and delete the charges for a subscription. - CoveredLevelPuid:
- childCoveredLevels
-
Parameters:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The child covered levels resource is used to view, create, update, and delete the subscription child covered levels. - CoveredLevelPuid:
- relationships
-
Parameters:
- CoveredLevelPuid:
$request.path.CoveredLevelPuid
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The relationships resource is used to view, create, update, and delete the subscription product relationships. - CoveredLevelPuid: