Update a subscription product
patch
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}
Request
Path Parameters
-
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
-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule
The unique identifier of the accounting rule. -
AccountingRuleName: string
Title:
Accounting Rule
The accounting rule name. -
AlignBillingFrom: string
(date)
Title:
Align Billing From
The from date of the billing alignment. -
AmendCreditMethod: string
Title:
Amendment Credit Method
Maximum Length:30
The amend credit method of the product. -
AmendCreditMethodName: string
The amend credit method name of the product.
-
AmendDescription: string
Title:
Amendment Description
Maximum Length:2000
The amend description of the product. -
AmendEffectiveDate: string
(date)
Title:
Amendment Effective Date
The amend effective date of the product. -
AmendReason: string
Title:
Amendment Reason
Maximum Length:30
The amend reason of the product. -
AmendReasonName: string
The amend reason name of the product.
-
associatedAsset: array
Associated Assets
Title:
Associated Assets
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type. -
AutoExtendFlag: boolean
Indicates if the suspension period should be auto extended.
-
BalanceRegisterId: integer
(int64)
The ID of the balance register associated with the product.
-
BillingDateCode: string
Title:
Billing Date
Maximum Length:30
The billing date code. -
BillingDateName: string
The billing date name.
-
BillingFrequency: string
Title:
Billing Frequency
Maximum Length:30
The billing frequency. -
BillingFrequencyName: string
Title:
Billing Frequency
The billing frequency name. -
BillingOffsetDays: integer
(int64)
Title:
Billing Offset Days
The billing offset days. -
billLines: array
Bill Lines
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details. -
BillOnDay: number
Title:
Bill on Day
The bill on day. -
BillToAccountDescription: string
The bill-to account description.
-
BillToAccountId: integer
(int64)
Title:
Billing Account
The unique identifier of the bill-to account. -
BillToAccountNumber: string
Title:
Billing Account
Maximum Length:30
The bill-to account number. -
BillToAddress: string
Title:
Bill-to Address
The bill-to address. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact
The bill-to contact ID of the subscription product. -
BillToContactName: string
Title:
Bill-to Contact
The bill-to contact name of the subscription product. -
BillToContactNumber: string
The bill-to contact number of the subscription product.
-
BillToPartyId: integer
(int64)
Title:
Bill-to Customer
The bill-to customer ID of the subscription product. -
BillToSiteNumber: string
Title:
Bill-to Site Number
The bill-to site number of the subscription product. -
BillToSiteUseId: integer
(int64)
Title:
Bill-to Site
The unique identifier of the bill-to site use. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the subscription product. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancellation reason description of the subscription product. -
CanceledAmount: number
Title:
Canceled Amount
The canceled amount of the product. -
CanceledDate: string
(date)
Title:
Product Canceled Date
The date on which the product was canceled. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason why the product was canceled. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the charges for a subscription. -
ChurnPredictionTrend: integer
(int32)
The churn prediction trend.
-
ChurnProbability: number
Title:
Churn Probability
The churn probability for the product. -
CloseCreditMethod: string
Title:
Close Credit Method
Maximum Length:30
The close credit method. -
ClosedAmount: number
Title:
Closed Amount
The closed amount of the product. -
ClosedDate: string
(date)
Title:
Product Close Date
The date on which the product was closed. -
CloseDescription: string
Title:
Close Description
Maximum Length:2000
The close reason description of the subscription product. -
CloseReason: string
Title:
Product Close Reason
Maximum Length:30
The reason why the product was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code. -
CoverageName: string
Title:
Template Name
The name of the coverage. -
CoverageScheduleId: integer
(int64)
The coverage schedule.
-
coveredLevels: array
Covered Levels
Title:
Covered Levels
The covered levels resource is used to view, create, update, and delete the subscription covered levels. -
creditCards: array
Credit Cards
Title:
Credit Cards
The credit cards resource is used to view, create, and update the credit card information associated with a subscription. -
CreditedAmount: number
Title:
Credited Amount
The credited amount of the product. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. -
CustomerTrxTypeSequenceId: integer
(int64)
The customer transaction type sequence ID of the subscription product.
-
DefaultRevenueAction: string
Maximum Length:
30
The revenue management rule of the subscription product used during the amendment. -
Description: string
Title:
Product Description
The subscription product description. -
DisplaySequence: number
Title:
Display Sequence
The display sequence of the subscription product. -
DropAllowanceFlag: string
Title:
No Allowance
Maximum Length:1
Indicates whether allowances alone are dropped for a subscription product. -
DropOneTimeChargeFlag: boolean
Title:
Don't copy one-time charges
Maximum Length:1
Indicates whether one time charges should be dropped while making the product change. -
Duration: integer
Title:
Duration
The duration of the product. -
EarlyTerminationPenalty: string
Title:
Early Termination Penalty
Maximum Length:30
The early termination penalty. -
EarlyTerminationPenaltyName: string
The early termination penalty name.
-
EnablePricingTermsFlag: boolean
Title:
Enable pricing term
Maximum Length:1
Indicates whether the pricing terms are enabled or not. -
EnableProrateByDay: boolean
Title:
Prorate by day
Maximum Length:1
Indicates whether proration by day is enabled or not. -
EnableUpfrontBillingFlag: boolean
Title:
Bill immediately
Maximum Length:1
Indicates whether the billing is done upfront or not. -
EndDate: string
(date)
Title:
Product End Date
The end date of the product. -
EntitlementPlanId: integer
(int64)
The ID of the entitlement plan associated with the product.
-
EntitlementPlanNumber: string
Title:
Number
The number of the entitlement plan associated with the product. -
EntitlementType: string
Title:
Entitlement Type
Maximum Length:30
The type of the entitlement associated with the product. -
EstimatedTax: number
Title:
Estimated Tax
The estimated tax of the product. -
ExemptCertificateNumber: string
Title:
Tax Exemption Certificate Number
Maximum Length:80
The exempt certificate number. -
ExemptReason: string
Title:
Exemption Reason
Maximum Length:30
The exempt reason. -
ExternalAssetKey: string
Maximum Length:
120
The external asset key. -
ExternalParentAssetKey: string
Maximum Length:
120
The external parent asset key. -
ExternalPriceListId: string
Maximum Length:
120
The unique identifier of the external price list of the product. -
ExternalRootAssetKey: string
Maximum Length:
120
The external root asset key of the product. -
flexFields: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield. -
GenerateBillFullPeriodFlag: boolean
Title:
Generate billing schedule for full period
Maximum Length:1
Indicates whether the billing schedule must be generated for the full period or not. -
GenerateBillingSchedule: string
Title:
Generate billing schedule for full period
Maximum Length:80
Indicates whether billing schedule is to be generated or not. -
GracePeriod: integer
(int64)
Title:
Grace Period in Days
The grace period associated with the product. -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset Days
The number of offset days set by the interface. -
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
Title:
Invoiced Amount
The invoiced amount of the product. -
InvoiceText: string
Title:
Invoice Text
Maximum Length:2000
The invoice text. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule
The unique identifier of the invoicing rule. -
InvoicingRuleName: string
Title:
Invoicing Rule
The invoice rule name. -
ItemUnitOfMeasure: string
Title:
Pricing UOM Code
Maximum Length:15
The item unit of measure. -
MonthlyRecurringRevenue: number
Title:
MRR
The monthly recurring revenue of the product. -
negotiatedEntitlementPlanCommitments: array
Subscription Entitlement Plan Commitments
Title:
Subscription Entitlement Plan Commitments
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled. -
negotiatedEntitlementPlanDetails: array
Subscription Entitlement Plan Details
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail. -
negotiatedEntitlementPlanEstimates: array
Subscription Entitlement Plan Estimates
Title:
Subscription Entitlement Plan Estimates
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled. -
NextBillStartDate: string
(date)
The next bill start date of the product.
-
NextPricingDate: string
(date)
The next pricing date of the product.
-
OrderFulfillLineId: integer
(int64)
The ID of the sales order fulfillment line associated with the subscription product.
-
OrderFulfillLineNumber: integer
(int32)
The number of the sales order fulfillment line associated with the subscription product.
-
OutputTaxClassification: string
Maximum Length:
50
The output tax classification. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the subscription product. -
PaymentMethod: string
Title:
Payment Method
Maximum Length:30
The unique identifier of the payment method. -
PaymentMethodName: string
Title:
Payment Method Name
The payment method name. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
PaymentTermsName: string
Title:
Payment Terms
The payment terms name. -
PenaltyChargeName: string
The penalty charge name.
-
PenaltyValue: number
Title:
Penalty Value
The penalty value associated with the product. -
PendingActivationFlag: boolean
Title:
Pending activation
Maximum Length:1
Indicates whether the activation of the subscription product is pending or not. -
Period: string
Title:
Period
The subscription product period. -
PONumber: string
Title:
PO Number
Maximum Length:50
The PO number. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number. -
PriceAdjustmentBasis: string
Title:
Price Adjustment Basis
Maximum Length:30
The basis on which the price is adjusted. -
PriceAdjustmentPercent: number
Title:
Price Adjustment Value
The percentage of price adjustment. -
PriceAdjustmentType: string
Title:
Price Adjustment Type
Maximum Length:30
The price adjustment type. -
PriceAsOf: string
(date)
Title:
Price as of Date
The price of the product. -
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceListName: string
Maximum Length:
120
The price list name of the product. -
PriceTransactionOn: string
(date)
The price transaction.
-
PricingError: string
Maximum Length:
2000
The pricing error related to the product. -
PricingTermsAdjustmentPCT: number
Title:
Pricing Term Adjustment Percentage
The pricing terms adjustment of the product. -
PricingTermsDuration: number
Title:
Pricing Term Duration
The pricing terms duration of the product. -
PricingTermsPeriod: string
Title:
Pricing Term
Maximum Length:15
The pricing terms period of the product. -
PricingTermsPricingMethod: string
Title:
Pricing Method
Maximum Length:30
The pricing terms pricing method of the product. -
PricingTermsStartDate: string
(date)
Title:
Starting On
The pricing terms start date of the product. -
ProductChangeReason: string
Title:
Change Reason
Maximum Length:300
The reason for the subscription product change. -
ProductChangeSchedule: string
Title:
Apply Change
Maximum Length:30
The schedule for the subscription product change. -
ProductChangeScheduleFrom: string
(date)
Title:
Product Change Schedule Effective Date
The from of the subscription product change. -
ProductFiscClassification: string
Maximum Length:
30
The product fiscal classification. -
ProductName: string
Title:
Product Name
Maximum Length:300
The name of the product. -
Quantity: number
Title:
Quantity
The quantity of the product. -
RatePlanDocument: string
(byte)
The JSON representing the rate plan.
-
RatePlanDocumentId: integer
(int64)
The identifier of the rate plan document.
-
RatePlanId: integer
(int64)
The identifier of the rate plan.
-
RatePlanName: string
Title:
Rate Plan
The name of the rate plan. -
RatePlanNumber: string
The number of the rate plan.
-
RelatedInventoryItemId: integer
(int64)
Title:
Related Inventory Item ID
The ID of the related inventory item of the subscription product. -
RelatedProductDescription: string
Title:
Description
The related product description. -
RelatedProductName: string
Title:
Product Name
Maximum Length:300
The name of the related inventory item of the subscription product. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships. -
RenewalDuration: integer
(int64)
Title:
Renewal Duration
The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriod: string
Title:
Renewal Period
Maximum Length:30
The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriodName: string
Title:
Renewal Period
The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal. -
RenewalPaymentMethod: string
Title:
Renewal Payment Method
Maximum Length:30
The internal code for the renewal payment method used in the subscription product. -
RenewalPaymentMethodName: string
Title:
Renewal Payment Method Name
The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card. -
RenewalPoNumber: string
Title:
Product Renewal PO Number
Maximum Length:50
The purchase order number of the renewed subscription product. -
RenewalType: string
Title:
Product Renewal Type
Maximum Length:30
The renewal type. -
RenewalWireNumber: string
Title:
Product Renewal Wire Number
Maximum Length:30
The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product. -
RenewedDate: string
(date)
Title:
Renewed On
The date on which the product was renewed. -
RenewPerpetuallyFlag: boolean
Title:
Renew forever
Maximum Length:1
Indicates whether the subscription product should be renewed forever. -
RepriceFlag: boolean
Indicates whether the subscription product should be repriced or not. If passed as 'true', the subscription product and its associated covered levels will be repriced.
-
RequestedAlignBillingDate: string
(date)
Title:
Requested Align Billing From
The requested align billing date for the product. -
RequestedEntitlementPlanId: integer
(int64)
The ID of the requested entitlement plan associated with the product.
-
RequestedEntitlementPlanNumber: string
Title:
Entitlement Plan Number
The number of the requested entitlement plan associated with the product. -
RequestedRatePlanId: integer
(int64)
The unique identifier of the requested rate plan.
-
RequestedRatePlanNumber: string
The alternate unique identifier of the requested rate plan.
-
ResumeDate: string
(date)
The date when the product will be resumed.
-
ResumeDuration: integer
The time duration for which the product will be suspended.
-
ResumePeriod: string
The time period after which the product will be resumed.
-
RevenueOption: string
Maximum Length:
30
Revenue Option -
salesCredits: array
Sales Credits
Title:
Sales Credits
The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products. -
SalesOrderId: integer
(int64)
The ID of the sales order associated with the subscription product.
-
SalesOrderLineNumber: string
Title:
Sales Order Line Number
Maximum Length:100
Sales Order Line Number -
SalesOrderNumber: string
Title:
Sales Order Number
Maximum Length:200
The number of the sales order associated with the subscription product. -
SalesProductType: string
Title:
Type
Maximum Length:30
The sales product type. -
serviceResources: array
Service Resources
Title:
Service Resources
The service resources resource is used to view, create, update, and delete the service identifier for a subscription product. -
ShipToAccountDescription: string
The ship-to account description of the subscription product.
-
ShipToAccountId: integer
(int64)
Title:
Ship-to Account
The ship-to account ID of the subscription product. -
ShipToAccountNumber: string
Title:
Ship-to Account
The ship-to account number of the subscription product. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact
The ship-to contact ID of the subscription product. -
ShipToContactName: string
Title:
Ship-to Contact
The ship-to contact name of the subscription product. -
ShipToContactNumber: string
The ship-to contact number of the subscription product.
-
ShipToPartyId: integer
(int64)
Title:
Ship-to Party
The unique identifier of the ship-to party. -
ShipToPartyName: string
Title:
Ship-to Party
The ship-to party name. -
ShipToPartySiteId: integer
(int64)
Title:
Ship-to Site
The unique identifier of the ship-to party site. -
ShipToPartySiteName: string
Title:
Ship-to Site
The ship-to party site name. -
ShipToPartySiteNumber: string
Title:
Ship-to Site Number
The ship-to party site number of the subscription product. -
SourceKey: string
Maximum Length:
120
The source key. -
SourceLineKey: string
Maximum Length:
120
The source line key. -
SourceLineNumber: string
Maximum Length:
120
The source line number. -
SourceNumber: string
Maximum Length:
120
The source number. -
SourceSystem: string
Maximum Length:
30
The source system. -
StartDate: string
(date)
Title:
Product Start Date
The start date of the product. -
Status: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The subscription product status. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Default Value:Subscriptions.SubscriptionNumber
The subscription number. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SuspendCreditMethod: string
Title:
Suspend Credit Method
Maximum Length:30
The credit method used after suspension. -
SuspendedDate: string
(date)
Title:
Suspend Date
The date when the product was suspended. -
SuspendReason: string
Title:
Suspend Reason
Maximum Length:30
The reason to suspend the product. -
TaxError: string
Maximum Length:
2000
The taxation error for the product, if any. -
TaxExemptionHandling: string
Maximum Length:
30
The tax exemption handling. -
TaxExemptionHandlingName: string
The tax exemption handling name.
-
TotalContractValue: number
Title:
Product Contract Value
The total contract value. -
TransactionTypeName: string
Title:
Transaction Type
Maximum Length:30
The transaction type name. -
UnitPrice: number
The unit price of the product.
-
UsageInvoiceLayoutTemplate: string
Title:
Usage Events Invoice Template
Maximum Length:200
The layout template of the usage invoice. -
WarehouseId: integer
(int64)
Title:
Warehouse
The warehouse ID associated with the subscription product. -
WareHouseName: string
Title:
Warehouse
The warehouse name of the subscription product. -
WireNumber: string
Title:
Wire Number
Maximum Length:30
The wire number.
Nested Schema : Associated Assets
Type:
array
Title:
Associated Assets
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.
Show Source
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 : Covered Levels
Type:
array
Title:
Covered Levels
The covered levels resource is used to view, create, update, and delete the subscription covered levels.
Show Source
Nested Schema : Credit Cards
Type:
array
Title:
Credit Cards
The credit cards resource is used to view, create, and update the credit card information associated with a subscription.
Show Source
Nested Schema : Descriptive Flexfields
Type:
array
Title:
Descriptive Flexfields
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.
Show Source
Nested Schema : Subscription Entitlement Plan Commitments
Type:
array
Title:
Subscription Entitlement Plan Commitments
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled.
Show Source
Nested Schema : Subscription Entitlement Plan Details
Type:
array
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.
Show Source
Nested Schema : Subscription Entitlement Plan Estimates
Type:
array
Title:
Subscription Entitlement Plan Estimates
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.
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 : Sales Credits
Type:
array
Title:
Sales Credits
The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.
Show Source
Nested Schema : Service Resources
Type:
array
Title:
Service Resources
The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.
Show Source
Nested Schema : subscriptions-products-associatedAsset-item-patch-request
Type:
Show Source
object
-
AssetName: string
Title:
Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Asset Serial Number
The serial number of the asset. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code. -
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 such as USD or INR. -
InventoryItemId: integer
The unique identifier of the inventory item.
-
ProductName: string
Title:
Product Name
The name of the product. -
Quantity: number
Title:
Quantity
The quantity of the associated asset. -
SourceKey: string
Maximum Length:
120
The source key of the associated asset. -
SourceLineKey: string
Maximum Length:
120
The source line key of the associated asset. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the associated asset. -
SourceNumber: string
Maximum Length:
120
The source number of the associated asset. -
SourceSystem: string
Maximum Length:
30
The source system of the associated asset. -
UnitOfMeasure: string
Title:
UOM
The unit of measure of the associated asset. -
UnitOfMeasureCode: string
Title:
UOM
The unit of measure code of the associated asset.
Nested Schema : schema
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 : schema
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-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 : schema
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 : schema
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-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. -
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.
Nested Schema : subscriptions-products-creditCards-item-patch-request
Type:
Show Source
object
-
AddToBillingAccountFlag: boolean
Indicates whether the party can be added as a billing account.
-
AuthorizedAmount: number
The amount the transaction was authorized for.
-
AuthRequestId: string
The card authorization request identifier.
-
CardHolderName: string
Title:
Cardholder Name
The name of the credit card holder. -
CreditCardPuid: string
Maximum Length:
120
The credit card PUID. -
ExpirationDate: string
(date)
The credit card expiration date used for processing.
-
FirstName: string
The first name of the credit card holder.
-
InstrAssignmentId: integer
(int64)
Title:
Number
The unique identifier of the assignment. -
IssuerCode: string
The credit card issuing company.
-
LastName: string
The last name of the credit card holder.
-
MaskedNumber: string
The masked credit card number.
-
Notes: string
Title:
Notes
Maximum Length:300
The notes associated with the credit card. -
PaymentSystemOrderNumber: string
The order number for the credit card payment.
-
RenewalCreditCardFlag: boolean
Maximum Length:
1
Indicates whether the credit card is used as Renewal Payment Method. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TokenNumber: string
The credit card token number used for processing.
-
VoiceAuthCode: string
The credit card voice authorization information.
Nested Schema : subscriptions-products-flexFields-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
The structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The display name for structure definition of the user descriptive flexfield. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : subscriptions-products-negotiatedEntitlementPlanCommitments-item-patch-request
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount under subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan commitments.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan commitments. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan commitments.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
Period: string
Title:
Periodicity
The period under subscription entitlement plan commitments. -
Quantity: number
Title:
Quantity
The quantity under subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity under subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance under subscription entitlement plan commitments.
Nested Schema : subscriptions-products-negotiatedEntitlementPlanDetails-item-patch-request
Type:
Show Source
object
-
AllowancePeriodicity: string
Title:
Periodicity
Maximum Length:30
The periodicity factor of allowance under subscription entitlement plan details. -
AllowanceQuantity: number
Title:
Quantity
The allowance quantity under subscription entitlement plan details. -
AllowanceRolloverPeriod: integer
Title:
Rollover Period
The allowance rollover period under subscription entitlement plan details. -
AllowanceRolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The unit of measure of allowance rollover under subscription entitlement plan details. -
AllowanceUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance specified for a negotiated entitlement plan. -
AllowanceValidityPeriod: integer
Title:
Validity Period
The allowance validity period under subscription entitlement plan details. -
AllowanceValidityPeriodUnitOfMeasure: string
Title:
Validity Period UOM
Maximum Length:3
The unit of measure of allowance validity under subscription entitlement plan details. -
Amount: number
Title:
Amount
The amount negotiated for an entitlement plan. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan details. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan details.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan details. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan details.
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the balance code of amount type of a negotiated entitlement plan. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement plan details.
-
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan details.
Nested Schema : subscriptions-products-negotiatedEntitlementPlanEstimates-item-patch-request
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount under subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan estimates.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan estimates. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan estimates.
-
ChargePeriod: string
Title:
Estimate Period
The estimate period of the subscription entitlement plan estimates. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rollover
Maximum Length:1
Default Value:false
Indicates whether rollover is enabled for the subscription entitlement plan estimate. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
Period: string
Title:
Periodicity
The period under subscription entitlement plan estimates. -
Quantity: number
Title:
Quantity
The quantity under subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover Period
The rollover period of the subscription entitlement plan estimate. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The rollover period unit of measure of the subscription entitlement plan estimate. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity under subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overage
Maximum Length:1
Default Value:true
Indicates whether the flag of the subscription entitlement plan estimates is overage shortage. -
TrueupShortageFlag: boolean
Title:
True-up shortage
Maximum Length:1
Default Value:true
Indicates whether the flag of the subscription entitlement plan estimates is trueup shortage. -
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance under subscription entitlement plan estimates.
Nested Schema : subscriptions-products-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.
Nested Schema : schema
Type:
Show Source
object
-
EndDate: string
(date)
The date when the credit card becomes invalid.
-
Percentage: number
The percentage of sales credit.
-
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Maximum Length:
120
The sales credit PUID. -
SalesCreditTypeId: integer
(int64)
The unique identifier of the sales credit type.
-
SalesPerson: string
The sales person.
-
SalesPersonNumber: string
Title:
Salesperson Number
The alternate identifier of a salesperson. -
SalesrepId: integer
(int64)
The unique identifier of the sales representative.
-
StartDate: string
(date)
The date when the sales credit starts.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The subscription product ID.
Nested Schema : schema
Type:
Show Source
object
-
EnabledFlag: boolean
Title:
Enable Service Resource
Maximum Length:1
Default Value:true
Indicates whether the service resource is enabled or not. -
EndDate: string
(date)
Title:
End Date
The end date of the service resource. -
ServiceId: string
Title:
Service Identifier
Maximum Length:120
The unique identifier of the service. -
ServiceResourceId: integer
(int64)
The unique identifier of the service resource.
-
ServiceResourcePuid: string
Maximum Length:
120
The PUID of the service resource. -
StartDate: string
(date)
Title:
Start Date
The start date of the service resource. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptions-products-item-response
Type:
Show Source
object
-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule
The unique identifier of the accounting rule. -
AccountingRuleName: string
Title:
Accounting Rule
The accounting rule name. -
AlignBillingFrom: string
(date)
Title:
Align Billing From
The from date of the billing alignment. -
AmendCreditMethod: string
Title:
Amendment Credit Method
Maximum Length:30
The amend credit method of the product. -
AmendCreditMethodName: string
The amend credit method name of the product.
-
AmendDescription: string
Title:
Amendment Description
Maximum Length:2000
The amend description of the product. -
AmendEffectiveDate: string
(date)
Title:
Amendment Effective Date
The amend effective date of the product. -
AmendReason: string
Title:
Amendment Reason
Maximum Length:30
The amend reason of the product. -
AmendReasonName: string
The amend reason name of the product.
-
associatedAsset: array
Associated Assets
Title:
Associated Assets
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type. -
AutoExtendFlag: boolean
Indicates if the suspension period should be auto extended.
-
BalanceRegisterId: integer
(int64)
The ID of the balance register associated with the product.
-
BalanceRegisterNumber: string
Title:
Register Number
Read Only:true
Maximum Length:255
The number of the balance register associated with the product. -
BillingDateCode: string
Title:
Billing Date
Maximum Length:30
The billing date code. -
BillingDateName: string
The billing date name.
-
BillingFrequency: string
Title:
Billing Frequency
Maximum Length:30
The billing frequency. -
BillingFrequencyName: string
Title:
Billing Frequency
The billing frequency name. -
BillingOffsetDays: integer
(int64)
Title:
Billing Offset Days
The billing offset days. -
billLines: array
Bill Lines
Title:
Bill Lines
The bill lines resource is used to view, create, update, and delete the subscription bill line details. -
BillOnDay: number
Title:
Bill on Day
The bill on day. -
BillToAccountDescription: string
The bill-to account description.
-
BillToAccountId: integer
(int64)
Title:
Billing Account
The unique identifier of the bill-to account. -
BillToAccountNumber: string
Title:
Billing Account
Maximum Length:30
The bill-to account number. -
BillToAddress: string
Title:
Bill-to Address
The bill-to address. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact
The bill-to contact ID of the subscription product. -
BillToContactName: string
Title:
Bill-to Contact
The bill-to contact name of the subscription product. -
BillToContactNumber: string
The bill-to contact number of the subscription product.
-
BillToPartyId: integer
(int64)
Title:
Bill-to Customer
The bill-to customer ID of the subscription product. -
BillToPartyName: string
Title:
Bill-to Customer
Read Only:true
Maximum Length:360
The bill-to customer name of the subscription product. -
BillToPartyNumber: string
Read Only:
true
Maximum Length:30
The bill-to customer number of the subscription product. -
BillToSiteNumber: string
Title:
Bill-to Site Number
The bill-to site number of the subscription product. -
BillToSiteUseId: integer
(int64)
Title:
Bill-to Site
The unique identifier of the bill-to site use. -
CalculatedCreditAmount: number
Title:
Calculated Credit Amount
The calculated credit amount of the subscription product. -
CancelDescription: string
Title:
Cancellation Description
Maximum Length:2000
The cancellation reason description of the subscription product. -
CanceledAmount: number
Title:
Canceled Amount
The canceled amount of the product. -
CanceledDate: string
(date)
Title:
Product Canceled Date
The date on which the product was canceled. -
CancelReason: string
Title:
Cancellation Reason
Maximum Length:30
The reason why the product was canceled. -
charges: array
Charges
Title:
Charges
The charges resource is used to view, create, update, and delete the charges for a subscription. -
ChurnPredictionTrend: integer
(int32)
The churn prediction trend.
-
ChurnProbability: number
Title:
Churn Probability
The churn probability for the product. -
CloseCreditMethod: string
Title:
Close Credit Method
Maximum Length:30
The close credit method. -
ClosedAmount: number
Title:
Closed Amount
The closed amount of the product. -
ClosedDate: string
(date)
Title:
Product Close Date
The date on which the product was closed. -
CloseDescription: string
Title:
Close Description
Maximum Length:2000
The close reason description of the subscription product. -
CloseReason: string
Title:
Product Close Reason
Maximum Length:30
The reason why the product was closed. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code. -
CoverageName: string
Title:
Template Name
The name of the coverage. -
CoverageScheduleId: integer
(int64)
The coverage schedule.
-
coveredLevels: array
Covered Levels
Title:
Covered Levels
The covered levels resource is used to view, create, update, and delete the subscription covered levels. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the product. -
CreationDate: string
(date-time)
Read Only:
true
The date when the product was created. -
creditCards: array
Credit Cards
Title:
Credit Cards
The credit cards resource is used to view, create, and update the credit card information associated with a subscription. -
CreditedAmount: number
Title:
Credited Amount
The credited amount of the product. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. -
Currency: string
Maximum Length:
15
The subscription product currency. -
CustomerTrxTypeSequenceId: integer
(int64)
The customer transaction type sequence ID of the subscription product.
-
DefaultRevenueAction: string
Maximum Length:
30
The revenue management rule of the subscription product used during the amendment. -
DefinitionOrganizationId: integer
(int64)
The item master organization.
-
Description: string
Title:
Product Description
The subscription product description. -
DisplaySequence: number
Title:
Display Sequence
The display sequence of the subscription product. -
DocumentTypeId: integer
(int64)
Title:
Document Type
Default Value:10
The unique identifier of a source document type in Oracle Revenue Management Cloud. -
DropAllowanceFlag: string
Title:
No Allowance
Maximum Length:1
Indicates whether allowances alone are dropped for a subscription product. -
DropOneTimeChargeFlag: boolean
Title:
Don't copy one-time charges
Maximum Length:1
Indicates whether one time charges should be dropped while making the product change. -
Duration: integer
Title:
Duration
The duration of the product. -
EarlyTerminationFee: number
Title:
Early Termination Fee
Read Only:true
The early termination fee. -
EarlyTerminationPenalty: string
Title:
Early Termination Penalty
Maximum Length:30
The early termination penalty. -
EarlyTerminationPenaltyName: string
The early termination penalty name.
-
EnablePricingTermsFlag: boolean
Title:
Enable pricing term
Maximum Length:1
Indicates whether the pricing terms are enabled or not. -
EnableProrateByDay: boolean
Title:
Prorate by day
Maximum Length:1
Indicates whether proration by day is enabled or not. -
EnableUpfrontBillingFlag: boolean
Title:
Bill immediately
Maximum Length:1
Indicates whether the billing is done upfront or not. -
EndDate: string
(date)
Title:
Product End Date
The end date of the product. -
EntitlementPlanId: integer
(int64)
The ID of the entitlement plan associated with the product.
-
EntitlementPlanNumber: string
Title:
Number
The number of the entitlement plan associated with the product. -
EntitlementType: string
Title:
Entitlement Type
Maximum Length:30
The type of the entitlement associated with the product. -
EstimatedTax: number
Title:
Estimated Tax
The estimated tax of the product. -
ExemptCertificateNumber: string
Title:
Tax Exemption Certificate Number
Maximum Length:80
The exempt certificate number. -
ExemptReason: string
Title:
Exemption Reason
Maximum Length:30
The exempt reason. -
ExternalAssetKey: string
Maximum Length:
120
The external asset key. -
ExternalParentAssetKey: string
Maximum Length:
120
The external parent asset key. -
ExternalPriceListId: string
Maximum Length:
120
The unique identifier of the external price list of the product. -
ExternalRootAssetKey: string
Maximum Length:
120
The external root asset key of the product. -
flexFields: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield. -
GenerateBillFullPeriodFlag: boolean
Title:
Generate billing schedule for full period
Maximum Length:1
Indicates whether the billing schedule must be generated for the full period or not. -
GenerateBillingSchedule: string
Title:
Generate billing schedule for full period
Maximum Length:80
Indicates whether billing schedule is to be generated or not. -
GracePeriod: integer
(int64)
Title:
Grace Period in Days
The grace period associated with the product. -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset Days
The number of offset days set by the interface. -
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvoicedAmount: number
Title:
Invoiced Amount
The invoiced amount of the product. -
InvoiceText: string
Title:
Invoice Text
Maximum Length:2000
The invoice text. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule
The unique identifier of the invoicing rule. -
InvoicingRuleName: string
Title:
Invoicing Rule
The invoice rule name. -
ItemUnitOfMeasure: string
Title:
Pricing UOM Code
Maximum Length:15
The item unit of measure. -
LastUpdateDate: string
(date-time)
Title:
Line Last Update Date
Read Only:true
The date when the product was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the product. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the product. -
LineNumber: string
Title:
Product Line Number
Maximum Length:300
The line number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MonthlyRecurringRevenue: number
Title:
MRR
The monthly recurring revenue of the product. -
negotiatedEntitlementPlanCommitments: array
Subscription Entitlement Plan Commitments
Title:
Subscription Entitlement Plan Commitments
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled. -
negotiatedEntitlementPlanDetails: array
Subscription Entitlement Plan Details
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail. -
negotiatedEntitlementPlanEstimates: array
Subscription Entitlement Plan Estimates
Title:
Subscription Entitlement Plan Estimates
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled. -
NextBillStartDate: string
(date)
The next bill start date of the product.
-
NextPricingDate: string
(date)
The next pricing date of the product.
-
OrderFulfillLineId: integer
(int64)
The ID of the sales order fulfillment line associated with the subscription product.
-
OrderFulfillLineNumber: integer
(int32)
The number of the sales order fulfillment line associated with the subscription product.
-
OutputTaxClassification: string
Maximum Length:
50
The output tax classification. -
OverrideCreditAmount: number
Title:
Override Credit Amount
The override credit amount of the subscription product. -
PaymentMethod: string
Title:
Payment Method
Maximum Length:30
The unique identifier of the payment method. -
PaymentMethodName: string
Title:
Payment Method Name
The payment method name. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms
The unique identifier of the payment terms. -
PaymentTermsName: string
Title:
Payment Terms
The payment terms name. -
PenaltyChargeName: string
The penalty charge name.
-
PenaltyValue: number
Title:
Penalty Value
The penalty value associated with the product. -
PendingActivationFlag: boolean
Title:
Pending activation
Maximum Length:1
Indicates whether the activation of the subscription product is pending or not. -
Period: string
Title:
Period
The subscription product period. -
PmProgramId: integer
(int64)
Title:
Preventive Maintenance Program ID
Read Only:true
The identifier of the preventive maintenance program. -
PONumber: string
Title:
PO Number
Maximum Length:50
The PO number. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment Number
The prepayment number. -
PriceAdjustmentBasis: string
Title:
Price Adjustment Basis
Maximum Length:30
The basis on which the price is adjusted. -
PriceAdjustmentPercent: number
Title:
Price Adjustment Value
The percentage of price adjustment. -
PriceAdjustmentType: string
Title:
Price Adjustment Type
Maximum Length:30
The price adjustment type. -
PriceAsOf: string
(date)
Title:
Price as of Date
The price of the product. -
PriceListId: integer
(int64)
The unique identifier of the price list.
-
PriceListName: string
Maximum Length:
120
The price list name of the product. -
PriceTransactionOn: string
(date)
The price transaction.
-
PricingError: string
Maximum Length:
2000
The pricing error related to the product. -
PricingTermsAdjustmentPCT: number
Title:
Pricing Term Adjustment Percentage
The pricing terms adjustment of the product. -
PricingTermsDuration: number
Title:
Pricing Term Duration
The pricing terms duration of the product. -
PricingTermsPeriod: string
Title:
Pricing Term
Maximum Length:15
The pricing terms period of the product. -
PricingTermsPricingMethod: string
Title:
Pricing Method
Maximum Length:30
The pricing terms pricing method of the product. -
PricingTermsStartDate: string
(date)
Title:
Starting On
The pricing terms start date of the product. -
PrimaryPartyId: integer
(int64)
Read Only:
true
The primary party ID of the subscription product. -
ProductChangeReason: string
Title:
Change Reason
Maximum Length:300
The reason for the subscription product change. -
ProductChangeSchedule: string
Title:
Apply Change
Maximum Length:30
The schedule for the subscription product change. -
ProductChangeScheduleFrom: string
(date)
Title:
Product Change Schedule Effective Date
The from of the subscription product change. -
ProductFiscClassification: string
Maximum Length:
30
The product fiscal classification. -
ProductName: string
Title:
Product Name
Maximum Length:300
The name of the product. -
ProgramCode: string
Title:
Program Code
Read Only:true
Maximum Length:30
The code of the preventive maintenance program. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:120
The name of the preventive maintenance program. -
ProgramOrganizationId: integer
Title:
Organization
Read Only:true
The organization identifier of the preventive maintenance program. -
Quantity: number
Title:
Quantity
The quantity of the product. -
RatePlanDocument: string
(byte)
The JSON representing the rate plan.
-
RatePlanDocumentId: integer
(int64)
The identifier of the rate plan document.
-
RatePlanId: integer
(int64)
The identifier of the rate plan.
-
RatePlanName: string
Title:
Rate Plan
The name of the rate plan. -
RatePlanNumber: string
The number of the rate plan.
-
RelatedInventoryItemId: integer
(int64)
Title:
Related Inventory Item ID
The ID of the related inventory item of the subscription product. -
RelatedProductDescription: string
Title:
Description
The related product description. -
RelatedProductName: string
Title:
Product Name
Maximum Length:300
The name of the related inventory item of the subscription product. -
relationships: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, update, and delete the subscription product relationships. -
RenewalDuration: integer
(int64)
Title:
Renewal Duration
The subscription product level renewal duration override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriod: string
Title:
Renewal Period
Maximum Length:30
The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriodName: string
Title:
Renewal Period
The name of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal. -
RenewalPaymentMethod: string
Title:
Renewal Payment Method
Maximum Length:30
The internal code for the renewal payment method used in the subscription product. -
RenewalPaymentMethodName: string
Title:
Renewal Payment Method Name
The method of payment for renewed subscription product. The payment method could be a purchase order, wire, or credit card. -
RenewalPoNumber: string
Title:
Product Renewal PO Number
Maximum Length:50
The purchase order number of the renewed subscription product. -
RenewalType: string
Title:
Product Renewal Type
Maximum Length:30
The renewal type. -
RenewalWireNumber: string
Title:
Product Renewal Wire Number
Maximum Length:30
The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product. -
RenewedDate: string
(date)
Title:
Renewed On
The date on which the product was renewed. -
RenewPerpetuallyFlag: boolean
Title:
Renew forever
Maximum Length:1
Indicates whether the subscription product should be renewed forever. -
RepriceFlag: boolean
Indicates whether the subscription product should be repriced or not. If passed as 'true', the subscription product and its associated covered levels will be repriced.
-
RequestedAlignBillingDate: string
(date)
Title:
Requested Align Billing From
The requested align billing date for the product. -
RequestedEntitlementPlanId: integer
(int64)
The ID of the requested entitlement plan associated with the product.
-
RequestedEntitlementPlanNumber: string
Title:
Entitlement Plan Number
The number of the requested entitlement plan associated with the product. -
RequestedProgramId: integer
(int64)
Title:
Requested Preventive Maintenance Program ID
Read Only:true
The unique identifier of the requested preventive maintenance program. -
RequestedRatePlanId: integer
(int64)
The unique identifier of the requested rate plan.
-
RequestedRatePlanNumber: string
The alternate unique identifier of the requested rate plan.
-
ResumeDate: string
(date)
The date when the product will be resumed.
-
ResumeDuration: integer
The time duration for which the product will be suspended.
-
ResumePeriod: string
The time period after which the product will be resumed.
-
RevenueOption: string
Maximum Length:
30
Revenue Option -
salesCredits: array
Sales Credits
Title:
Sales Credits
The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products. -
SalesOrderId: integer
(int64)
The ID of the sales order associated with the subscription product.
-
SalesOrderLineNumber: string
Title:
Sales Order Line Number
Maximum Length:100
Sales Order Line Number -
SalesOrderNumber: string
Title:
Sales Order Number
Maximum Length:200
The number of the sales order associated with the subscription product. -
SalesProductType: string
Title:
Type
Maximum Length:30
The sales product type. -
serviceResources: array
Service Resources
Title:
Service Resources
The service resources resource is used to view, create, update, and delete the service identifier for a subscription product. -
ShipToAccountDescription: string
The ship-to account description of the subscription product.
-
ShipToAccountId: integer
(int64)
Title:
Ship-to Account
The ship-to account ID of the subscription product. -
ShipToAccountNumber: string
Title:
Ship-to Account
The ship-to account number of the subscription product. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact
The ship-to contact ID of the subscription product. -
ShipToContactName: string
Title:
Ship-to Contact
The ship-to contact name of the subscription product. -
ShipToContactNumber: string
The ship-to contact number of the subscription product.
-
ShipToContactPartyId: integer
Read Only:
true
The ship-to contact party ID of the subscription product. -
ShipToPartyId: integer
(int64)
Title:
Ship-to Party
The unique identifier of the ship-to party. -
ShipToPartyName: string
Title:
Ship-to Party
The ship-to party name. -
ShipToPartyNumber: string
Title:
Ship-to Party Number
Read Only:true
Maximum Length:30
The ship-to party number of the subscription product. -
ShipToPartySiteId: integer
(int64)
Title:
Ship-to Site
The unique identifier of the ship-to party site. -
ShipToPartySiteName: string
Title:
Ship-to Site
The ship-to party site name. -
ShipToPartySiteNumber: string
Title:
Ship-to Site Number
The ship-to party site number of the subscription product. -
SourceKey: string
Maximum Length:
120
The source key. -
SourceLineKey: string
Maximum Length:
120
The source line key. -
SourceLineNumber: string
Maximum Length:
120
The source line number. -
SourceNumber: string
Maximum Length:
120
The source number. -
SourceSystem: string
Maximum Length:
30
The source system. -
StartDate: string
(date)
Title:
Product Start Date
The start date of the product. -
Status: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The subscription product status. -
StatusMeaning: string
Title:
Product Status
Read Only:true
Maximum Length:80
The status meaning of the product. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionNumber: string
Title:
Subscription Number
Maximum Length:120
Default Value:Subscriptions.SubscriptionNumber
The subscription number. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SubscriptionProductPuid: string
Title:
Subscription Product Number
Maximum Length:120
The subscription product PUID. -
SummarizedBillingFlag: boolean
Title:
Summarized billing
Maximum Length:1
Indicates if the product uses summarized billing. -
SuspendCreditMethod: string
Title:
Suspend Credit Method
Maximum Length:30
The credit method used after suspension. -
SuspendedDate: string
(date)
Title:
Suspend Date
The date when the product was suspended. -
SuspendReason: string
Title:
Suspend Reason
Maximum Length:30
The reason to suspend the product. -
TaxClassificationMeaning: string
Read Only:
true
The tax classification meaning. -
TaxError: string
Maximum Length:
2000
The taxation error for the product, if any. -
TaxExemptionHandling: string
Maximum Length:
30
The tax exemption handling. -
TaxExemptionHandlingName: string
The tax exemption handling name.
-
TcvWithTotalUsageCharge: number
Title:
TCV with Total Usage Charge
Read Only:true
Tcv With Total Usage Charge -
TotalContractValue: number
Title:
Product Contract Value
The total contract value. -
TotalUsageCharge: number
Title:
Total Usage Charges
Read Only:true
Total Usage Charge -
TransactionTypeName: string
Title:
Transaction Type
Maximum Length:30
The transaction type name. -
UnitPrice: number
The unit price of the product.
-
UsageInvoiceLayoutTemplate: string
Title:
Usage Events Invoice Template
Maximum Length:200
The layout template of the usage invoice. -
WarehouseId: integer
(int64)
Title:
Warehouse
The warehouse ID associated with the subscription product. -
WareHouseName: string
Title:
Warehouse
The warehouse name of the subscription product. -
WireNumber: string
Title:
Wire Number
Maximum Length:30
The wire number.
Nested Schema : Associated Assets
Type:
array
Title:
Associated Assets
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type.
Show Source
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 : Covered Levels
Type:
array
Title:
Covered Levels
The covered levels resource is used to view, create, update, and delete the subscription covered levels.
Show Source
Nested Schema : Credit Cards
Type:
array
Title:
Credit Cards
The credit cards resource is used to view, create, and update the credit card information associated with a subscription.
Show Source
Nested Schema : Descriptive Flexfields
Type:
array
Title:
Descriptive Flexfields
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Entitlement Plan Commitments
Type:
array
Title:
Subscription Entitlement Plan Commitments
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled.
Show Source
Nested Schema : Subscription Entitlement Plan Details
Type:
array
Title:
Subscription Entitlement Plan Details
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail.
Show Source
Nested Schema : Subscription Entitlement Plan Estimates
Type:
array
Title:
Subscription Entitlement Plan Estimates
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled.
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 : Sales Credits
Type:
array
Title:
Sales Credits
The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products.
Show Source
Nested Schema : Service Resources
Type:
array
Title:
Service Resources
The service resources resource is used to view, create, update, and delete the service identifier for a subscription product.
Show Source
Nested Schema : subscriptions-products-associatedAsset-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Asset Name
The name of the asset. -
AssetSerialNumber: string
Title:
Asset Serial Number
The serial number of the asset. -
AssociatedAssetId: integer
(int64)
The unique identifier of the associated asset.
-
AssociatedAssetPuid: string
Maximum Length:
120
The PUID of the associated asset. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the associated asset. -
CreationDate: string
(date-time)
Read Only:
true
The date when the associated asset was created. -
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 such as USD or INR. -
InventoryItemId: integer
The unique identifier of the inventory item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the associated asset was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the associated asset. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the associated asset. -
LineNumber: integer
(int64)
Title:
Number
The line number of the associated asset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductName: string
Title:
Product Name
The name of the product. -
Quantity: number
Title:
Quantity
The quantity of the associated asset. -
SourceKey: string
Maximum Length:
120
The source key of the associated asset. -
SourceLineKey: string
Maximum Length:
120
The source line key of the associated asset. -
SourceLineNumber: string
Maximum Length:
120
The source line number of the associated asset. -
SourceNumber: string
Maximum Length:
120
The source number of the associated asset. -
SourceSystem: string
Maximum Length:
30
The source system of the associated asset. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscurption product.
-
UnitOfMeasure: string
Title:
UOM
The unit of measure of the associated asset. -
UnitOfMeasureCode: string
Title:
UOM
The unit of measure code of the associated asset.
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-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-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 : subscriptions-products-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-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-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-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-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 : 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
Nested Schema : subscriptions-products-creditCards-item-response
Type:
Show Source
object
-
AddressLine1: string
Read Only:
true
Maximum Length:255
The address line 1 of the billing address. -
AddressLine2: string
Read Only:
true
Maximum Length:255
The address line 2 of the billing address. -
AddToBillingAccountFlag: boolean
Indicates whether the party can be added as a billing account.
-
AuthorizedAmount: number
The amount the transaction was authorized for.
-
AuthRequestId: string
The card authorization request identifier.
-
CardBillingAddressId: number
Read Only:
true
The ID of the card billing address. -
CardHolderName: string
Title:
Cardholder Name
The name of the credit card holder. -
CardIssuerName: string
Read Only:
true
Maximum Length:255
The name of the card issuer. -
City: string
Read Only:
true
Maximum Length:255
The city of the billing address. -
Country: string
Read Only:
true
Maximum Length:255
The country of the billing address. -
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. -
CreditCardId: integer
(int64)
The unique identifier of the credit card.
-
CreditCardPuid: string
Maximum Length:
120
The credit card PUID. -
ExpirationDate: string
(date)
The credit card expiration date used for processing.
-
FirstName: string
The first name of the credit card holder.
-
InstrAssignmentId: integer
(int64)
Title:
Number
The unique identifier of the assignment. -
IssuerCode: string
The credit card issuing company.
-
LastName: string
The last name of the credit card holder.
-
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. -
MaskedNumber: string
The masked credit card number.
-
Notes: string
Title:
Notes
Maximum Length:300
The notes associated with the credit card. -
PaymentSystemOrderNumber: string
The order number for the credit card payment.
-
PostalCode: string
Read Only:
true
Maximum Length:255
The postal code of the billing address. -
RenewalCreditCardFlag: boolean
Maximum Length:
1
Indicates whether the credit card is used as Renewal Payment Method. -
State: string
Read Only:
true
Maximum Length:255
The state of the billing address. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TokenNumber: string
The credit card token number used for processing.
-
VoiceAuthCode: string
The credit card voice authorization information.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-flexFields-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
The structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The display name for structure definition of the user descriptive flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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 : subscriptions-products-negotiatedEntitlementPlanCommitments-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount under subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan commitments.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan commitments. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan commitments.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan commitments. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan commitments. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan commitments. -
EntitlementPlanCommitmentId: integer
(int64)
The unique identifier of subscription entitlement plan commitments.
-
EntitlementPlanCommitmentNumber: string
Maximum Length:
120
The unique number of subscription entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan commitments was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of subscription entitlement plan commitments. -
Period: string
Title:
Periodicity
The period under subscription entitlement plan commitments. -
Quantity: number
Title:
Quantity
The quantity under subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity under subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance under subscription entitlement plan commitments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-negotiatedEntitlementPlanDetails-item-response
Type:
Show Source
object
-
AllowancePeriodicity: string
Title:
Periodicity
Maximum Length:30
The periodicity factor of allowance under subscription entitlement plan details. -
AllowanceQuantity: number
Title:
Quantity
The allowance quantity under subscription entitlement plan details. -
AllowanceRolloverPeriod: integer
Title:
Rollover Period
The allowance rollover period under subscription entitlement plan details. -
AllowanceRolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The unit of measure of allowance rollover under subscription entitlement plan details. -
AllowanceUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance specified for a negotiated entitlement plan. -
AllowanceValidityPeriod: integer
Title:
Validity Period
The allowance validity period under subscription entitlement plan details. -
AllowanceValidityPeriodUnitOfMeasure: string
Title:
Validity Period UOM
Maximum Length:3
The unit of measure of allowance validity under subscription entitlement plan details. -
Amount: number
Title:
Amount
The amount negotiated for an entitlement plan. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan details. -
BalanceCodeDescription: string
Title:
Name
Read Only:true
Maximum Length:120
The description of balance code under subscription entitlement plan details. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan details.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan details. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan details.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan details. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan details. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the balance code of amount type of a negotiated entitlement plan. -
EntitlementPlanDetailId: integer
(int64)
The unique identifier of subscription entitlement plan details.
-
EntitlementPlanDetailNumber: string
Maximum Length:
120
The unique number of subscription entitlement plan details. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan details was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan details. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan details. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement plan details.
-
PrecisionFactor: number
Title:
Rounding Factor
Read Only:true
The precision factor of subscription entitlement plan details. -
PrecisionType: string
Title:
Rounding Type
Read Only:true
Maximum Length:30
The precision type of subscription entitlement plan details. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan details.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-negotiatedEntitlementPlanEstimates-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount under subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code under subscription entitlement plan estimates.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code under subscription entitlement plan estimates. -
ChargeDefinitionId: integer
(int64)
The unique identifier for charge definition under subscription entitlement plan estimates.
-
ChargePeriod: string
Title:
Estimate Period
The estimate period of the subscription entitlement plan estimates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan estimates. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan estimates. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of amount type balance code under subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rollover
Maximum Length:1
Default Value:false
Indicates whether rollover is enabled for the subscription entitlement plan estimate. -
EntitlementPlanEstimateId: integer
(int64)
The unique identifier of subscription entitlement plan estimates.
-
EntitlementPlanEstimateNumber: string
Maximum Length:
120
The alternate unique number of subscription entitlement plan estimates. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan estimates was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement plan estimates. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan estimates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of subscription entitlement plan estimates. -
Period: string
Title:
Periodicity
The period under subscription entitlement plan estimates. -
Quantity: number
Title:
Quantity
The quantity under subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover Period
The rollover period of the subscription entitlement plan estimate. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOM
Maximum Length:3
The rollover period unit of measure of the subscription entitlement plan estimate. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity under subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overage
Maximum Length:1
Default Value:true
Indicates whether the flag of the subscription entitlement plan estimates is overage shortage. -
TrueupShortageFlag: boolean
Title:
True-up shortage
Maximum Length:1
Default Value:true
Indicates whether the flag of the subscription entitlement plan estimates is trueup shortage. -
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of allowance under subscription entitlement plan estimates.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptions-products-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
Nested Schema : subscriptions-products-salesCredits-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. -
EndDate: string
(date)
The date when the credit card becomes invalid.
-
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. -
Percentage: number
The percentage of sales credit.
-
QuotaFlag: boolean
Read Only:
true
Maximum Length:1
Indicates the quota of the sales credit. -
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Maximum Length:
120
The sales credit PUID. -
SalesCreditType: string
The sales credit type.
-
SalesCreditTypeId: integer
(int64)
The unique identifier of the sales credit type.
-
SalesPerson: string
The sales person.
-
SalesPersonNumber: string
Title:
Salesperson Number
The alternate identifier of a salesperson. -
SalesrepId: integer
(int64)
The unique identifier of the sales representative.
-
StartDate: string
(date)
The date when the sales credit starts.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
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-serviceResources-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the service resource. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the service resource was created. -
EnabledFlag: boolean
Title:
Enable Service Resource
Maximum Length:1
Default Value:true
Indicates whether the service resource is enabled or not. -
EndDate: string
(date)
Title:
End Date
The end date of the service resource. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the service resource was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the service resource. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the service resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ServiceId: string
Title:
Service Identifier
Maximum Length:120
The unique identifier of the service. -
ServiceResourceId: integer
(int64)
The unique identifier of the service resource.
-
ServiceResourcePuid: string
Maximum Length:
120
The PUID of the service resource. -
StartDate: string
(date)
Title:
Start Date
The start date of the service resource. -
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
Links
- ProductCloseCreditMethodVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_CREDIT_METHOD
The following properties are defined on the LOV link relation:- Source Attribute: CloseCreditMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductCloseReasonVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_CLOSE_REASONS
The following properties are defined on the LOV link relation:- Source Attribute: CloseReason; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesProductTypeLookupVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: SalesProductType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- associatedAsset
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type. - SubscriptionNumber:
- billLines
-
Parameters:
- 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. - SubscriptionNumber:
- cancel
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you cancel a subscription product. You must provide a Subscription Product Puid to cancel. - SubscriptionNumber:
- charges
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The charges resource is used to view, create, update, and delete the charges for a subscription. - SubscriptionNumber:
- close
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you close a subscription product. - SubscriptionNumber:
- coveredLevels
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The covered levels resource is used to view, create, update, and delete the subscription covered levels. - SubscriptionNumber:
- creditCards
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The credit cards resource is used to view, create, and update the credit card information associated with a subscription. - SubscriptionNumber:
- flexFields
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield. - SubscriptionNumber:
- negotiatedEntitlementPlanCommitments
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The subscription entitlement plan commitments resource is used to create a negotiated entitlement plan based on commitments. These records can be created only for those balance codes which have the commitments flag enabled. - SubscriptionNumber:
- negotiatedEntitlementPlanDetails
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The subscription entitlement plan details resource is used to view, create, update, and delete an entitlement plan detail. - SubscriptionNumber:
- negotiatedEntitlementPlanEstimates
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The subscription entitlement plan estimates resource is used to create a negotiated entitlement plan based on estimates. These records can be created only for those balance codes which have the estimates flag enabled. - SubscriptionNumber:
- putOnHold
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you put a subscription product on hold till you remove the hold. - SubscriptionNumber:
- relationships
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The relationships resource is used to view, create, update, and delete the subscription product relationships. - SubscriptionNumber:
- removeHold
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you remove the hold placed on the subscription product. - SubscriptionNumber:
- resume
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you resume a suspended subscription product. - SubscriptionNumber:
- salesCredits
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The sales credits resource is used to view, create, update, and delete the sales credits defined for subscription or subscription products. - SubscriptionNumber:
- serviceResources
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
The service resources resource is used to view, create, update, and delete the service identifier for a subscription product. - SubscriptionNumber:
- suspend
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you suspend a subscription product. You must specify the Subscription Product Puid in order to suspend it. - SubscriptionNumber:
- undoClose
-
Parameters:
- SubscriptionNumber:
$request.path.SubscriptionNumber
- SubscriptionProductPuid:
$request.path.SubscriptionProductPuid
This method lets you undo close of a subscription product. - SubscriptionNumber:
Examples
The following example shows how to update a subscription product by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/GP-5678/child/products/GP-5678-PRDT-1
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "EndDate": "2019-12-20" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "SubscriptionProductId": 300100177254429, "SubscriptionId": 300100177254423, "LineNumber": "1", "SubscriptionProductPuid": "GP-5678-PRDT-1", "DefinitionOrganizationId": 204, "SubscriptionNumber": "GP-5678", "SalesProductType": "SUBSCRIPTION", "Description": "QP Item for SPT Subscription", "InventoryItemId": 300100012368232, "ItemUnitOfMeasure": "Ea", "ProductName": "QP_Item3", "Quantity": 1, "StartDate": "2019-01-01", "EndDate": "2019-12-20", "CloseReason": null, "CloseCreditMethod": null, "CancelReason": null, "ClosedDate": null, "CanceledDate": null, "RenewedDate": null, "PriceListId": null, "UnitPrice": null, "Status": "ORA_DRAFT", "Currency": "USD", "InvoicingRuleId": -2, "InvoicingRuleName": "Advance Invoice", "BillOnDay": null, "BillingOffsetDays": null, "BillingFrequency": "0zG", "BillingFrequencyName": "MONTH", "AccountingRuleId": 300100033038413, "AccountingRuleName": "3 Months, Deferred", "TransactionTypeName": "ORA_OSS_Invoice", "InvoiceText": "[$Item Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]", "BillToAccountId": 1001, "BillToAccountNumber": "1001", "BillToAccountDescription": "A T & T SOLUTIONS INC", "BillToSiteUseId": 1006, "BillToAddress": "32 Ave of the Americas,NEW YORK, NY 10013", "ShipToPartyId": null, "ShipToPartyName": null, "ShipToPartySiteId": null, "ShipToPartySiteName": null, "PaymentMethod": null, "PaymentMethodName": null, "PONumber": null, "WireNumber": null, "PaymentTermsId": 1064, "PaymentTermsName": "Immediate", "PrePaymentNumber": null, "TaxExemptionHandling": "S", "TaxExemptionHandlingName": "Standard", "ExemptCertificateNumber": null, "ExemptReason": null, "OutputTaxClassification": null, "ProductFiscClassification": null, "TaxError": null, "CoverageScheduleId": null, "RenewalType": "RENEW", "BillingDateCode": "ORA_PERIOD_START", "BillingDateName": "Period start", "TotalContractValue": null, "EstimatedTax": null, "PricingError": null, "PriceAsOf": "2019-06-04", "PriceTransactionOn": "2019-06-04", "InvoicedAmount": null, "CreditedAmount": null, "CanceledAmount": null, "ClosedAmount": null, "SourceSystem": null, "SourceKey": null, "SourceNumber": null, "SourceLineKey": null, "SourceLineNumber": null, "MonthlyRecurringRevenue": null, "Duration": 354, "Period": "DY", "GenerateBillingSchedule": null, "ExternalAssetKey": null, "ExternalParentAssetKey": null, "ExternalPriceListId": null, "ExternalRootAssetKey": null, "PriceListName": null, "NextPricingDate": null, "PricingTermsStartDate": null, "PricingTermsPricingMethod": null, "PricingTermsPeriod": null, "PricingTermsDuration": null, "PricingTermsAdjustmentPCT": null, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "AmendCreditMethod": null, "AmendCreditMethodName": null, "AmendDescription": null, "AmendEffectiveDate": null, "AmendReason": null, "AmendReasonName": null, "StatusMeaning": "Draft", "EnablePricingTermsFlag": null, "TaxClassificationMeaning": null, "CreatedBy": "CONMGR", "CreationDate": "2019-06-04T05:18:01+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2019-06-04T05:18:02.375+00:00", "LastUpdateLogin": "8A5689BEEA6839CBE05322EAF40A0656", "SummarizedBillingFlag": null, "InterfaceOffsetDays": null, "CoverageName": null, ... }