Get all covered levels
get
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/coveredLevels
Request
Path Parameters
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- CoveredLevelPuidAltKey: Finds a covered level with the specified alternate key.
Finder Variables:- CoveredLevelPuid; string; The public unique identifier of the covered level.
- PrimaryKey: Finds a covered level with the specified covered level ID.
Finder Variables:- CoveredLevelId; integer; The unique identifier of the covered level.
- CoveredLevelPuidAltKey: Finds a covered level with the specified alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AssetGroupId; integer; The unique identifier of the asset group.
- AssetId; integer; The unique identifier of the asset.
- AssetSerialNumber; string; The serial number of the asset.
- CalculatedCreditAmount; number; The calculated credit amount of the covered level.
- CancelDescription; string; The cancellation description associated with a covered level.
- CanceledAmount; number; The amount that was canceled.
- CloseDescription; string; The close description associated with a covered level.
- ClosedAmount; number; The amount at which the covered level was closed.
- CorpCurrencyCode; string; The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
- CoveredLevelId; integer; The unique identifier of the covered level.
- CoveredLevelPuid; string; The public unique identifier of the covered level.
- CreatedBy; string; The user who created the covered level.
- CreationDate; string; The date when the covered level was created.
- CreditedAmount; number; The amount that was credited.
- CurcyConvRateType; string; The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE.
- CurrencyCode; string; The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. 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; The unique identifier of the customer account.
- EndDate; string; The date when the covered level ends.
- HierarchyTotal; number; The total covered level of the hierarchy.
- InventoryItemId; integer; The unique identifier of the inventory item.
- InvoiceText; string; The text included in the invoice.
- InvoicedAmount; number; The amount for which the invoice was created.
- ItemUnitOfMeasure; string; The unit of measure used to measure the items in the covered level.
- LastUpdateDate; string; The date when the covered level was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the covered level.
- LastUpdatedBy; string; The user who last updated the covered level.
- OverrideCreditAmount; number; The override credit amount of the covered level.
- ParentCoveredAssetId; integer; The unique identifier of the parent covered asset.
- ParentCoveredLevelId; integer; The unique identifier of the parent covered level.
- PartyId; integer; The unique identifier of the party.
- PartySiteId; integer; The unique identifier of the party site.
- PriceAsOf; string; The price as of a certain date.
- PriceListId; integer; The unique identifier of the price list.
- PriceUnitOfMeasure; string; The unit of measure used to indicate the price.
- PriceUnitOfMeasureName; string; The display name of the unit of measure.
- PricingError; string; The error in the pricing, if any.
- ProductGroupId; integer; The unique identifier of the product group.
- Quantity; number; The quantity of the covered level.
- RenewalType; string; The type of the covered level renewal.
- RenewedDate; string; The date when the covered level was renewed.
- RevenueOption; string; Revenue Option
- RollupTotal; number; The rollup total of covered level.
- SerialNumber; string; The serial number of the covered level.
- StartDate; string; The date when the covered level starts.
- Status; string; The status of the covered level.
- StatusName; string; The meaning of the status of the covered level.
- SubscriptionId; integer; The unique identifier of the subscription.
- SubscriptionProductId; integer; The unique identifier of the subscription product.
- SuppressedCreditAmount; number; The credit amount that was suppressed.
- SuspendCreditMethod; string; Indicates if the credit method has to be suspended.
- TaxAmount; number; The tax amount levied on the transaction.
- TaxError; string; The tax error, if any, in the calculated amount.
- TotalContractValue; number; The total contract value associated with the covered level.
- Type; string; The type of the covered level.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-item-response
Type:
Show Source
object
-
Address: string
Title:
Address
The address of the party site. -
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 serial number of 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, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the covered level. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancellation description associated with a covered level. -
CanceledAmount: number
The amount that was canceled.
-
CanceledDate: string
(date)
Title:
Canceled Date
The date when the covered level was canceled. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason for cancelling the covered level. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag. -
ClosedAmount: number
The amount at which 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 covered level. -
CloseReason: string
Title:
Covered Level Close Reason
Maximum Length:30
The reason why the covered level was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
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 alternate unique identifier of the covered level 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. -
CoveredLevlNumber: string
Title:
Covered Level Number
The alternate identifier of the covered level. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the covered level. -
CreationDate: string
(date-time)
Read Only:
true
The date when the covered level was created. -
CreditedAmount: number
The amount that was credited.
-
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. -
CurrencyCode: string
Maximum Length:
15
The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. 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.
-
CustomerName: string
Title:
Customer Account
The name of the customer. -
CustomerNumber: string
Title:
Customer Account Number
The alternate unique identifier of the customer. -
Description: string
Title:
Covered Level Description
A brief description of the covered level. -
Duration: integer
The duration of the covered level.
-
EndDate: string
(date)
Title:
Covered Level End Date
The date when the covered level ends. -
ExplodeAssetHierarchy: string
Indicates if the assest hierarchy should be copied to other hierarchies.
-
GenerateBillingSchedule: string
Indicates whether the billing schedule is to be generated.
-
HierarchyTotal: number
The total covered level of the hierarchy.
-
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
The amount for which the invoice was created.
-
InvoiceText: string
Maximum Length:
2000
The text included in the invoice. -
ItemUnitOfMeasure: string
Maximum Length:
15
The unit of measure used to measure the items in the covered level. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the covered level was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the covered level. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the covered level. -
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 covered level. -
ParentCoveredAssetId: integer
(int64)
The unique identifier of the parent covered asset.
-
ParentCoveredLevelId: integer
(int64)
The unique identifier of the parent covered level.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyName: string
Title:
Party Name
The name of the party. -
PartyNumber: string
Title:
Party Number
The alternate identifier of the party. -
PartySite: string
Title:
Party Site Number
The name of the party site. -
PartySiteId: integer
(int64)
The unique identifier of the party site.
-
Period: string
Maximum Length:
80
The period of the covered level. -
PriceAsOf: string
(date)
The price as of a certain date.
-
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceUnitOfMeasure: string
Maximum Length:
30
The unit of measure used to indicate the price. -
PriceUnitOfMeasureName: string
Title:
Pricing UOM
The display name of the unit of measure. -
PricingError: string
Maximum Length:
1000
The error in the pricing, if any. -
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 associated with the covered level. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
Quantity
Default Value:1
The quantity of the covered level. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID. -
RemoveHoldFlag: boolean
Indicates if the hold on the covered level has to be removed.
-
RenewalType: string
Title:
Renewal Type
Maximum Length:30
The type of the covered level renewal. -
RenewedDate: string
(date)
The date when the covered level was renewed.
-
RepriceFlag: boolean
Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.
-
ReturnCreditMethod: string
Title:
Close Credit Method
Maximum Length:230
The method used to return the credit. -
RevenueOption: string
Title:
Revenue Accounting Option
Maximum Length:30
Revenue Option -
RollupTotal: number
The rollup total of covered level.
-
SerialNumber: string
Title:
Covered Asset Serial Number
Read Only:true
Maximum Length:80
The serial number of the covered level. -
SourceKey: string
Maximum Length:
120
The source key of the covered level. -
SourceLineKey: string
Maximum Length:
120
The source line key of the covered level. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the covered level. -
SourceNumber: string
Maximum Length:
120
The source number of the covered level. -
SourceSystem: string
Maximum Length:
30
The source system of the covered level. -
StartDate: string
(date)
Title:
Covered Level Start Date
The date when the covered level starts. -
Status: string
Title:
Covered Level Status
Maximum Length:30
The status of the covered level. -
StatusName: string
Title:
Status
The meaning of the status of the covered level. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuppressedCreditAmount: number
The credit amount that was suppressed.
-
SuspendCreditMethod: string
Maximum Length:
30
Indicates if the credit method has to be suspended. -
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 for suspending the credit method for the covered level. -
TaxAmount: number
The tax amount levied on the transaction.
-
TaxError: string
Maximum Length:
4000
The tax error, if any, in the calculated amount. -
TotalContractValue: number
Title:
Covered Level Contract Value
The total contract value associated with the covered level. -
Type: string
Title:
Type
Maximum Length:30
The type of the covered level. -
TypeName: string
Title:
Covered Level Type
The name of the type of the covered level. -
UnitPrice: number
Title:
Unit Price
The unit price of the 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, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
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 details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount for which the bill is generated. -
billAdjustments: array
Bill Adjustments
Title:
Bill Adjustments
The bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity. -
BillingPeriod: number
Title:
Sequence
The period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120
The public unique identifier of the bill line. -
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 associated with the bill line. -
ChargePeriod: number
Title:
Period
The usage period that was charged. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Read Only:
true
The public unique identifier of the charge. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the billing line. -
CreationDate: string
(date-time)
Read Only:
true
The date when the billing 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)
Customer Transaction Type Sequence Id
-
DateBilledFrom: string
(date)
Title:
Bill-from Date
The date from which the bill was generated. -
DateBilledTo: string
(date)
Title:
Bill-to Date
The date up to which the bill is generated. -
DateToInterface: string
(date)
Title:
Interface Date
The date to interface for the bill line. -
InterfacedFlag: boolean
Title:
Interfaced
Maximum Length:1
Default Value:false
Indicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice Text
Maximum Length:240
The text in the bill line invoice. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the billing line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the billing line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the billing line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
The list price of the product associated with the bill line.
-
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 error in pricing, if any. -
RecurringFlag: boolean
Maximum Length:
1
Indicates whether the 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 for which the transaction occurred. -
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 when the transaction occurred. -
TransactionNumber: string
Title:
Invoice Number
Maximum Length:30
The number of the transaction. -
TransactionTax: number
Title:
Tax
The tax levied on the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3
Indicates if the bill line has a trueup period. -
TrxId: integer
(int64)
The AR transaction ID.
-
TrxLineId: integer
(int64)
The AR transaction line ID.
-
UsageAcquiredFlag: boolean
Maximum Length:
1
Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
The date when the usage was captured.
-
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 the usage line has been priced or not. -
UsageQuantity: number
Title:
Usage Quantity
The quantity of the usage.
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, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis on which the bill is adjusted. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30
The code of the adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the bill adjustment. -
AdjustmentValue: number
Title:
Value
The value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates 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:
120
The 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.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30
The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
Links
The 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.
-
Reason: string
Title:
Reason Details
Maximum Length:120
The reason why the bill is adjusted. -
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 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:
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 : subscriptionProducts-coveredLevels-charges-item-response
Type:
Show Source
object
-
adjustments: array
Adjustments
Title:
Adjustments
The adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity. -
AggregationMethod: string
Maximum Length:
30
The aggregation method used for the charges. -
Allowance: number
Title:
Allowance
The allowance part of the charge. -
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 unique identifier of the bill line.
-
BlockSize: number
Title:
Block Size
The block size of the charge. -
ChargeDefinition: string
Title:
Charge Name
Maximum Length:30
The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
The name of the charge definition.
-
ChargeId: integer
(int64)
The unique identifier of the charge.
-
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 name of the charge. -
ChargePeriodCode: string
Maximum Length:
30
The code of the charge period associated with the charge. -
ChargePuid: string
Maximum Length:
120
The public unique identifier of the charge. -
chargeTiers: array
Charge Tiers
Title:
Charge Tiers
The charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge was created. -
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 used to measure the charge. -
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 date when the charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge. -
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 for the charge. -
PricePeriodicity: string
Title:
Periodicity
Maximum Length:30
The price periodicity for the charge. Indicates the frequency when the charge has to be applied. -
PricePeriodicityName: string
The name of the price periodicity.
-
PriceType: string
Maximum Length:
30
The price type associated with the charge. -
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 charge needs to be rolled up. -
SequenceNumber: integer
(int32)
The sequence number for the charge.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TieredFlag: boolean
Maximum Length:
3
Indicates whether the charge has tiers. -
TierType: string
Title:
Tier Type
Maximum Length:30
The type of the charge tier. -
TrueUpPeriod: string
Title:
True Up Period
Maximum Length:30
Default Value:ORA_OSS_USAGE_BILLING_PERIOD
The identifier of the trueup period. -
TrueUpPeriodName: string
Title:
True Up Period
The name of the trueup period. -
UnitListPrice: number
Title:
List Price
The price of the unit list. -
UsagePriceLockFlag: boolean
Maximum Length:
3
Indicates 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 the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
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, such as tier from, tier to, and list price.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-adjustments-item-response
Type:
Show Source
object
-
AdjustmentBasis: string
Title:
Basis
Maximum Length:30
The basis of the adjustment. -
AdjustmentName: string
Title:
Adjustment
Maximum Length:120
The name of the adjustment. -
AdjustmentReasonCode: string
Title:
Reason
Maximum Length:30
The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
Reason
The translated adjustment reason. -
AdjustmentType: string
Title:
Type
Maximum Length:30
The type of the adjustment. -
AdjustmentValue: number
Title:
Value
The value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3
Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120
The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the adjustment was created. -
Effectivity: string
Title:
Effectivity
Maximum Length:30
The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the adjustment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason Description
Maximum Length:120
The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
Sequence
The sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-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 of the user who 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 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 : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
Type:
Show Source
object
-
AdditionalNumberFive: number
Title:
Additional Number Five
Additional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number Four
Additional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number One
Additional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number Six
Additional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number Three
Additional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number Two
Additional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text One
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text Two
Maximum Length:4000
Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp One
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp Three
Additional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp Two
Additional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text Three
Maximum Length:4000
Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block Size
The block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120
The public unique identifier of the charge tier. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the charge tier. -
CreationDate: string
(date-time)
Read Only:
true
The date when the charge tier was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the charge tier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the charge tier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the charge tier. -
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 display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
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 : subscriptionProducts-coveredLevels-relationships-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the relationship. -
CreationDate: string
(date-time)
Read Only:
true
The date when the relationship was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the relationship was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
OperationLinksPuid: string
Maximum Length:
120
The public unique identifier of the operation links. -
RelationshipTypeCode: string
Maximum Length:
30
The code indicating the type of the relationship. -
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 public unique identifier of the source product association. -
SourceProductPuid: string
Maximum Length:
120
The public unique identifier of the source product. -
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 public unique identifier of the target product association. -
TargetProductPuid: string
Maximum Length:
120
The public unique identifier of the target product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all covered levels by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/CDRM_4016-PRDT-2013/child/coveredLevels
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "CoveredLevelId": 300100192686410, "CoveredLevelPuid": "GP-5678-PRDT-7-PASS-1", "SubscriptionProductId": 300100181994505, "SubscriptionId": 300100181994494, "LineNumber": "1", "InventoryItemId": 300100118490672, "AssetId": 300100118585763, "AssetName": "zOKC_Auto_Asset1", "AssetSerialNumber": null, "ProductName": "ZOKC_Item_001", "Description": "Item", "Type": "ORA_ASSET", "TypeName": "Asset", "Quantity": 1, "ItemUnitOfMeasure": "Ea", "TotalContractValue": 12361.29, "GenerateBillingSchedule": null, "EndDate": "2020-05-29", "StartDate": "2020-01-01", "Duration": 150, "Period": "DY", "Status": "ORA_DRAFT", "StatusName": "Draft", "PriceAsOf": "2020-01-01", "PriceUnitOfMeasure": "0zE", "PriceUnitOfMeasureName": "YEAR", "PriceListId": null, "PricingError": null, "TaxAmount": null, "InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]", "CancelReason": null, "CanceledDate": null, "CanceledAmount": null, "ClosedDate": null, "CloseReason": null, "ClosedAmount": null, "ReturnCreditMethod": null, "SuppressedCreditAmount": null, "InvoicedAmount": null, "CreditedAmount": null, "RenewedDate": null, "RenewalType": null, "TaxError": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2019-08-20T06:55:15+00:00", "LastUpdatedBy": "SALES_ADMIN", "LastUpdateDate": "2019-08-20T06:55:15.130+00:00", "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696", "CurrencyCode": null, "CorpCurrencyCode": null, "CurcyConvRateType": null, "PutOnHoldFlag": null, "RemoveHoldFlag": null, "links": ... }