Get all subscription products
get
/crmRestApi/resources/11.13.18.05/subscriptionProducts
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a subscription product with the specified Subscription Product ID.
Finder Variables:- SubscriptionProductId; integer; The unique identifier of the subscription product.
- ProductPuid: Finds a subscription product with the specified Subscription Product PUID.
Finder Variables:- SubscriptionProductPuid; string; The public unique identifier of the subscription product.
- PrimaryKey: Finds a subscription product with the specified Subscription Product ID.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AccountingRuleId; integer; The unique identifier of the accounting rule.
- AllowanceGrantFlag; string; Indicates whether allowance type of plan is associated with the product.
- AmendEffectiveDate; string; The date when the amended credit becomes effective.
- AmendSourceProductPuid; string; Amend Source Product Puid
- BalanceManagementError; string; The balance management error.
- BalanceProfileName; string; The name of the balance profile associated with the product.
- BalanceRegisterId; integer; The ID of the balance register associated with the product.
- BalanceRegisterNumber; string; The number of the balance register associated with the product.
- BatchTag; string; Batch Tag
- BillToAccountId; integer; The unique identifier of the bill-to account.
- BillToAccountNumber; string; The account number of the bill-to account.
- BillToContactId; integer; The bill-to contact ID of the subscription product.
- BillToPartyId; integer; The bill-to customer ID of the subscription product.
- BillToPartyNumber; string; The bill-to customer number of the subscription product.
- BillToSiteName; string; The bill-to site name of the subscription product.
- BillToSiteUseId; integer; The unique identifier of the bill-to site use.
- CalculatedCreditAmount; number; The calculated credit amount of the subscription product.
- CancelDescription; string; The cancellation reason description of the subscription product.
- ChargeRulesFlag; string; Indicates whether volume pricing rule is associated with the product.
- ChurnPredictionTrend; integer; The churn prediction trend.
- ChurnProbability; number; The probability of churn associated with the product.
- CloseDescription; string; The close reason description of the subscription product.
- ClosedDate; string; The date when the product was closed.
- CommitmentFlag; string; Indicates whether commitment type of plan is associated with the product.
- CoverageName; string; The name of the coverage associated with the product.
- CoverageScheduleId; integer; Coverage Scheduled
- CustomerPONumber; string; The customer PO number reference of a subscription product.
- CustomerTrxTypeSequenceId; integer; The customer transaction type sequence ID of the subscription product.
- DefinitionOrganizationId; integer; The unique identifier of the item master organization.
- DocumentTypeId; integer; TheuUnique identifier of a source document type in Oracle Revenue Management Cloud.
- DropAllowanceFlag; string; Indicates whether allowances alone are dropped for a subscription product.
- EarlyTerminationPenaltyName; string; The name of the early termination penalty.
- EnableAdvBipTemplateFlag; boolean; Indicates whether advanced BIP configuration for usage invoice templates is enabled.
- EnablePricingTermsFlag; boolean; Indicates whether the pricing terms are enabled or not.
- EndDate; string; The date when the subscriptions ends.
- EntitlementPlanDescription; string; The description of the entitlement plan associated with the product.
- EntitlementPlanId; integer; The ID of the entitlement plan associated with the product.
- EntitlementPlanNumber; string; The number of the entitlement plan associated with the product.
- EntitlementType; string; The type of the entitlement associated with the product.
- EstimateFlag; string; Indicates whether estimate type of plan is associated with the product.
- ExternalAssetKey; string; The external asset key
- ExternalParentAssetKey; string; The external parent asset key
- ExternalPriceListId; string; The unique identifier of the external price list.
- ExternalRootAssetKey; string; The external root asset key
- GenBillSchReqdFlag; boolean; Generate Bill Schedule Required Flag
- GroupingRuleNumberUsed; string; Grouping Rule Number Used
- InflightFlag; boolean; Indicates whether the subscription product is inflight or not.
- InterfaceOffsetDays; integer; The number of days that the interface needs to be offset for.
- InventoryItemId; integer; The unique identifier of the inventory item.
- InvoiceBipReportCode; string; The code of the type of template to pick for the invoice report.
- InvoicingRuleId; integer; The unique identifier of the invoicing rule.
- IsProductCreatedFromAmendFlag; boolean; Indicates whether subscription product is created from amend action.
- LastLifecycleUpdateDate; string; Last Lifecycle Update Date
- LastUpdateDate; string; The date when the subscription was last updated.
- LegacyRetrospectiveFlag; string; Indicates whether the product had legacy retrospective accounting.
- LineNumber; string; The line number of the product.
- MilestoneBasedChargeFlag; boolean; Indicates whether the charge for the product is milestone based.
- OrderFulfillLineId; integer; The ID of the sales order fulfillment line associated with the subscription product.
- OrderFulfillLineNumber; integer; The number of the sales order fulfillment line associated with the subscription product.
- OriginalSubscriptionProductPuid; string; The PUID of the original subscription product.
- OverrideCreditAmount; number; The override credit amount of the subscription product.
- PaymentTermsId; integer; The unique identifier of the payment terms.
- PenaltyChargeName; string; The penalty charge name.
- PmProgramId; integer; The identifier of the preventive maintenance program.
- PriceListId; integer; The unique identifier of the price list.
- PricingTermsPricingMethod; string; The method used to set the terms of the product pricing.
- PrimaryPartyId; integer; The primary party ID of the subscription product.
- PrimaryPartyName; string; The primary party name of the subscription product.
- ProductChangeSequenceNumber; integer; The sequence number of the subscription product change.
- ProductName; string; The name of the product.
- QuoteId; integer; The quote ID associated with the subscription product.
- QuoteLineId; integer; The quote line ID associated with the subscription product.
- RatePlanDocumentId; integer; The identifier of the rate plan document.
- RatePlanId; integer; The unique identifier of the rate plan.
- RelationShipExistFlag; string; Indicates whether relationship exists for the product.
- RenewPerpetuallyFlag; boolean; Indicates whether the subscription product should be renewed forever.
- RenewSourceProductPuid; string; Renew Source Product Puid
- RenewalDurationPeriod; string; The code of the subscription product level renewal duration period override that will be used while renewing through automatic or manual renewal.
- RenewalPriceListName; string; The name of the renewal price list.
- RenewalSequenceNumber; integer; The renewal sequence number.
- RenewedDate; string; The date when the product was renewed.
- RequestedAlignBillingDate; string; The requested align billing date for the product.
- RequestedEntitlementPlanId; integer; The ID of the requested entitlement plan associated with the product.
- RequestedProgramId; integer; The unique identifier of the requested preventive maintenance program.
- RetainSubsOnRenewFlag; boolean; Indicates whether the renewal should happen in the source subscription.
- RevenueOption; string; Revenue Option
- RevenueOptionClose; string; The revenue option selected for the last close operation.
- SalesOrderId; integer; The ID of the sales order associated with the subscription product.
- SalesOrderLineId; integer; The sales order line ID associated with the subscription product.
- SalesOrderLineNumber; string; Sales Order Line Number
- SalesOrderNumber; string; The number of the sales order associated with the subscription product.
- SalesProductType; string; The type of the sales product.
- ShipToAccountId; integer; The ship-to account ID of the subscription product.
- ShipToContactId; integer; The ship-to contact ID of the subscription product.
- ShipToPartyId; integer; The unique identifier of the ship-to party.
- ShipToPartyNumber; string; The ship-to party number of the subscription product.
- ShipToPartySiteId; integer; The unique identifier of the ship-to party site.
- SourceSystem; string; The reference of the product in the source system.
- StartDate; string; The date when the subscriptions starts.
- Status; string; The status of the subscription product.
- StatusMeaning; string; The meaning of the product status.
- SubscriptionId; integer; The unique identifier of the subscription.
- SubscriptionNumber; string; The subscription number of the product.
- SubscriptionProductId; integer; The unique identifier of the subscription product.
- SubscriptionProductPuid; string; The public unique identifier of the subscription product.
- SummarizedBillingFlag; boolean; Indicates whether the billing is to be summarized.
- SummarizedRatingFlag; boolean; Indicates whether the entitlement plan is associated with the product is eligibile for summarized rating.
- TcvWithTotalUsageCharge; number; Tcv With Total Usage Charge
- TotalContractValue; number; The value of the total contract.
- TotalUsageCharge; number; Total Usage Charge
- UpdateFlag; boolean; Indicates whether the subscription product is updated.
- UsageEventAllowanceInvTemplate; string; The template to show the invoice data for allowance type of balance management.
- UsageEventCommitmentInvTemplate; string; The template to show the invoice data for commitment type of balance management.
- UsageEventEstimateInvTemplate; string; The template to show the invoice data for estimate type of balance management.
- UsageEventRegularInvTemplate; string; The common template to show the invoice data.
- ValidationStatus; string; The validation status of the subscription product.
- VolumeRatingFlag; boolean; Indicates whether the entitlement plan is associated with the product is eligibile for volume pricing.
- WarehouseId; integer; The warehouse ID associated with the subscription product.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionProducts
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-item-response
Type:
Show Source
object-
AccountingRuleId: integer
(int64)
Title:
Accounting Rule IDThe unique identifier of the accounting rule. -
AccountingRuleName: string
Title:
Accounting RuleThe name of the accounting rule. -
AlignBillingDay: number
Title:
Align Billing DayThe day part of the align billing from the date of a subscription product. -
AlignBillingFrom: string
(date)
Title:
Align Billing FromThe from date of the billing alignment. -
AllowanceGrantFlag: string
Indicates whether allowance type of plan is associated with the product.
-
AmendCreditMethod: string
Title:
Amendment Credit MethodMaximum Length:30The method used to amend the credit. -
AmendCreditMethodName: string
The name of the method used to amend the credit .
-
AmendDescription: string
Title:
Amendment DescriptionMaximum Length:2000A brief description of the amended credit. -
AmendEffectiveDate: string
(date)
Title:
Amendment Effective DateThe date when the amended credit becomes effective. -
AmendReason: string
Title:
Amendment ReasonMaximum Length:30The reason why the credit was amended. -
AmendReasonName: string
The name of the amend reason.
-
AmendSourceProductPuid: string
Title:
Amended Subscription Product PUIDMaximum Length:255Amend Source Product Puid -
associatedAsset: array
Associated Assets
Title:
Associated AssetsThe associated assets resource is used to view, create, update, and delete the assets linked to a subscription product of subscription type. -
AsyncFlag: boolean
Read Only:
trueIndicates whether the subscription product will undergo asynchronous process for operations such as duplicate, generate billing schedule etc. -
AutoExtendFlag: boolean
Indicates if the product should be auto extended.
-
BalanceFirstPartialPeriodOption: string
Title:
Balance First Partial Period OptionMaximum Length:30Option to follow for balance management for First Partial Period. -
BalanceLastPartialPeriodOption: string
Title:
Balance Last Partial Period OptionMaximum Length:30Option to follow for balance management for Last Partial Period. -
BalanceManagementError: string
Title:
Balance Management ErrorMaximum Length:2000The balance management error. -
BalanceProfileName: string
Title:
Profile NameThe name of the balance profile associated with the product. -
BalanceRegisterId: integer
(int64)
Title:
Balance Register IDThe ID of the balance register associated with the product. -
BalanceRegisterNumber: string
Title:
Register NumberRead Only:trueMaximum Length:255The number of the balance register associated with the product. -
BalanceTerminatedPartialPeriodOption: string
Title:
Balance Terminated Partial Period OptionMaximum Length:30Option to follow for balance management for Terminated Partial Period. -
BatchTag: string
Title:
Batch TagMaximum Length:30Batch Tag -
BillingDateCode: string
Title:
Billing DateMaximum Length:30The code indicating the billing date. -
BillingDateName: string
The name of the billing date.
-
BillingFrequency: string
Title:
Billing FrequencyMaximum Length:30The billing frequency. -
BillingFrequencyName: string
Title:
Billing FrequencyThe name of the billing frequency. -
BillingOffsetDays: integer
(int64)
Title:
Billing Offset DaysThe billing offset days. -
billLines: array
Bill Lines
Title:
Bill LinesThe bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags. -
BillOnDay: number
Title:
Bill on DayThe day on which the product should be billed. -
BillToAccountDescription: string
A brief description of the bill-to account.
-
BillToAccountId: integer
(int64)
Title:
Account IdThe unique identifier of the bill-to account. -
BillToAccountNumber: string
Title:
Billing AccountMaximum Length:30The account number of the bill-to account. -
BillToAddress: string
Title:
Bill-to AddressThe bill-to address. -
BillToContactId: integer
(int64)
Title:
Bill-to Contact IDThe bill-to contact ID of the subscription product. -
BillToContactName: string
Title:
Bill-to ContactThe bill-to contact name of the subscription product. -
BillToContactNumber: string
Title:
Bill-to Contact NumberThe bill-to contact number of the subscription product. -
BillToPartyId: integer
(int64)
Title:
Bill-to Party IDThe bill-to customer ID of the subscription product. -
BillToPartyName: string
Title:
Bill-to CustomerRead Only:trueMaximum Length:360The bill-to customer name of the subscription product. -
BillToPartyNumber: string
Title:
Bill-to Party NumberRead Only:trueMaximum Length:30The bill-to customer number of the subscription product. -
BillToSite: string
Title:
Bill-to SiteBill To Site -
BillToSiteName: string
Title:
Bill-to SiteMaximum Length:255The bill-to site name of the subscription product. -
BillToSiteNumber: string
Title:
Bill-to Site NumberThe bill-to site number of the subscription product. -
BillToSiteUseId: integer
(int64)
Title:
Site Use IdThe unique identifier of the bill-to site use. -
CalculatedCreditAmount: number
Title:
Calculated Credit AmountThe calculated credit amount of the subscription product. -
CalculateEstimatedTaxFlag: boolean
Indicates whether estimated tax will be calculated for the subscription product.
-
CancelDescription: string
Title:
Cancellation DescriptionMaximum Length:2000The cancellation reason description of the subscription product. -
CanceledAmount: number
Title:
Canceled AmountThe transaction amount that was canceled. -
CanceledDate: string
(date)
Title:
Product Canceled DateThe date when the product was canceled. -
CancelReason: string
Title:
Cancellation ReasonMaximum Length:30The reason why the product was canceled. -
ChargeRulesFlag: string
Title:
Charge RulesIndicates whether volume pricing rule is associated with the product. -
charges: array
Charges
Title:
ChargesThe charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag. -
CheckActiveExpiredAssetsExists: string
Indicates whether any underlying assets are active or expired for the subscription product.
-
CheckHoldAssetsExists: string
Indicates whether any underlying assets are on hold for the subscription product.
-
ChurnPredictionTrend: integer
(int32)
Title:
Churn Prediction TrendThe churn prediction trend. -
ChurnProbability: number
Title:
Churn ProbabilityThe probability of churn associated with the product. -
CloseCreditMethod: string
Title:
Close Credit MethodMaximum Length:30The method used to close the credit. -
ClosedAmount: number
Title:
Closed AmountThe amount at which the transaction was closed. -
ClosedDate: string
(date)
Title:
Product Close DateThe date when the product was closed. -
CloseDescription: string
Title:
Close DescriptionMaximum Length:2000The close reason description of the subscription product. -
CloseReason: string
Title:
Product Close ReasonMaximum Length:30The reason why the product was closed. -
CommitmentFlag: string
Indicates whether commitment type of plan is associated with the product.
-
CorpCurrencyCode: string
Title:
Currency CodeMaximum Length:15The corporate currency code associated with the product. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
coverage: array
Standard Coverages
Title:
Standard CoveragesThe standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information. -
CoverageName: string
Title:
Template NameThe name of the coverage associated with the product. -
CoverageScheduleId: integer
(int64)
Title:
Coverage Schedule IDCoverage Scheduled -
coveredLevels: array
Covered Levels
Title:
Covered LevelsThe covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the subscription product. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the subscription was created. -
creditCards: array
Credit Cards
Title:
Credit CardsThe credit cards resource is used to view, create, and update the credit cards associated with a subscription. -
CreditedAmount: number
Title:
Credited AmountThe amount credited to a account. -
CreditType: string
Title:
Credit TypeMaximum Length:30Indicates the type of credit to be issued to the customer on close and amend. -
CurcyConvRateType: string
Title:
Conversion Rate TypeMaximum Length:30The currency conversion rate type associated with the product. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. -
Currency: string
Maximum Length:
15The currency associated with the subscription product. -
CustomerPONumber: string
Title:
Customer PO NumberMaximum Length:50The customer PO number reference of a subscription product. -
CustomerTrxTypeSequenceId: integer
(int64)
Title:
SequenceThe customer transaction type sequence ID of the subscription product. -
DefaultRevenueAction: string
Maximum Length:
30The revenue management rule of the subscription product used during the amendment. -
DefinitionOrganizationId: integer
(int64)
Title:
Inventory OrganizationThe unique identifier of the item master organization. -
Description: string
Title:
Product DescriptionA brief description of the subscription product. -
DisplaySequence: number
Title:
Display SequenceThe display sequence of the subscription product. -
DocumentTypeId: integer
(int64)
Title:
Document TypeDefault Value:10TheuUnique identifier of a source document type in Oracle Revenue Management Cloud. -
DropAllowanceFlag: string
Title:
No AllowanceMaximum Length:1Indicates whether allowances alone are dropped for a subscription product. -
DropOneTimeChargeFlag: boolean
Title:
Don't copy one-time chargesMaximum Length:1Indicates whether one time charges have to be removed when the product is changed. -
Duration: integer
Title:
DurationProduct Duration -
EarlyTerminationFee: number
Title:
Early Termination FeeThe early termination fee. -
EarlyTerminationPenalty: string
Title:
Early Termination PenaltyMaximum Length:30The early termination penalty. -
EarlyTerminationPenaltyName: string
The name of the early termination penalty.
-
EnableAdvBipTemplateFlag: boolean
Title:
Enable Advanced ConfigurationMaximum Length:1Default Value:falseIndicates whether advanced BIP configuration for usage invoice templates is enabled. -
EnablePricingTermsFlag: boolean
Title:
Enable pricing termMaximum Length:1Indicates whether the pricing terms are enabled or not. -
EnableProrateByDay: boolean
Title:
Prorate by dayMaximum Length:1Indicates whether proration by day is enabled or not. -
EnableUpfrontBillingFlag: boolean
Title:
Bill immediatelyMaximum Length:1Indicates whether billing is done upfront or not. -
EndDate: string
(date)
Title:
Product End DateThe date when the subscriptions ends. -
EntitlementPlanDescription: string
Title:
DescriptionThe description of the entitlement plan associated with the product. -
EntitlementPlanId: integer
(int64)
Title:
Entitlement Plan IDThe ID of the entitlement plan associated with the product. -
EntitlementPlanName: string
Title:
NameThe name of the entitlement plan associated with the product. -
EntitlementPlanNumber: string
Title:
NumberThe number of the entitlement plan associated with the product. -
EntitlementType: string
Title:
Entitlement TypeMaximum Length:30The type of the entitlement associated with the product. -
EstimatedTax: number
Title:
Estimated TaxThe estimated tax on the product. -
EstimateFlag: string
Indicates whether estimate type of plan is associated with the product.
-
ExemptCertificateNumber: string
Title:
Tax Exemption Certificate NumberMaximum Length:80The number of the exempt certificate. -
ExemptReason: string
Title:
Exemption ReasonMaximum Length:30The reason for the tax exemption. -
ExternalAssetKey: string
Title:
External Asset KeyMaximum Length:120The external asset key -
ExternalParentAssetKey: string
Title:
External Parent Asset KeyMaximum Length:120The external parent asset key -
ExternalPriceListId: string
Title:
External Price List IDMaximum Length:120The unique identifier of the external price list. -
ExternalRootAssetKey: string
Title:
External Root Asset KeyMaximum Length:120The external root asset key -
flexFields: array
Descriptive Flexfields
Title:
Descriptive FlexfieldsThe descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield. -
GenBillSchReqdFlag: boolean
Title:
Billing schedule update requiredMaximum Length:1Generate Bill Schedule Required Flag -
GenerateBillFullPeriodFlag: boolean
Title:
Generate billing schedule for full periodMaximum Length:1Generate Bill Full Period Flag -
GenerateBillingSchedule: string
Title:
Generate billing schedule for full periodMaximum Length:80Indicates whether the billing schedule is to be generated or not. -
GracePeriod: integer
(int64)
Title:
Grace Period in DaysThe grace period. -
GroupingRuleNumberUsed: string
Title:
Grouping Rule NumberMaximum Length:120Grouping Rule Number Used -
InflightFlag: boolean
Title:
Subscription In-ProcessMaximum Length:1Indicates whether the subscription product is inflight or not. -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset DaysThe number of days that the interface needs to be offset for. -
InventoryItemId: integer
(int64)
Title:
Item IDThe unique identifier of the inventory item. -
InvoiceBipReportCode: string
Title:
BIP Data SourceMaximum Length:30The code of the type of template to pick for the invoice report. -
InvoicedAmount: number
Title:
Invoiced AmountThe amount specified in the invoice. -
InvoiceText: string
Title:
Invoice TextMaximum Length:4000The text in the billing invoice. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule IdThe unique identifier of the invoicing rule. -
InvoicingRuleName: string
Title:
Invoicing RuleThe name of the invoicing rule. -
IsProductCreatedFromAmendFlag: boolean
Indicates whether subscription product is created from amend action.
-
ItemUnitOfMeasure: string
Title:
Pricing UOM CodeMaximum Length:15The unit of measure used to measure the items. -
ItemUnitOfMeasureMeaning: string
Title:
Pricing UOMThe display name of item unit of measure. -
LastLifecycleUpdateDate: string
(date-time)
Title:
Last Lifecycle Update DateLast Lifecycle Update Date -
LastUpdateDate: string
(date-time)
Title:
Line Last Update DateRead Only:trueThe date when the subscription was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the subscription product. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login details of the user who last updated the subscription product. -
LegacyRetrospectiveFlag: string
Maximum Length:
1Indicates whether the product had legacy retrospective accounting. -
LineNumber: string
Title:
Product Line NumberMaximum Length:300The line number of the product. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MilestoneBasedChargeFlag: boolean
Indicates whether the charge for the product is milestone based.
-
MonthlyRecurringRevenue: number
Title:
MRRThe monthly recurring revenue associated with the product. -
negotiatedEntitlementPlanCommitments: array
Subscription Entitlement Plan Commitments
Title:
Subscription Entitlement Plan CommitmentsThe 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 DetailsThe 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 EstimatesThe 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. -
negotiatedVolumePricingRules: array
Subscription Entitlement Pricing Rules
Title:
Subscription Entitlement Pricing RulesThe subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product. -
NextBillStartDate: string
(date)
Title:
Next Bill Start DateNext Bill Start Date -
NextPricingDate: string
(date)
Title:
Next Pricing DateThe date when the next pricing will occur. -
OrderFulfillLineId: integer
(int64)
Title:
Order Fulfillment Line IDThe ID of the sales order fulfillment line associated with the subscription product. -
OrderFulfillLineNumber: integer
(int32)
Title:
Order Fulfillment Line NumberThe number of the sales order fulfillment line associated with the subscription product. -
OriginalSubscriptionProductPuid: string
Read Only:
trueMaximum Length:240The PUID of the original subscription product. -
OutputTaxClassification: string
Title:
Output Tax ClassMaximum Length:50The tax classification to use when calculating the output tax. -
OverrideCreditAmount: number
Title:
Override Credit AmountThe override credit amount of the subscription product. -
PaymentMethod: string
Title:
Payment MethodMaximum Length:30The unique identifier of the payment method. -
PaymentMethodName: string
Title:
Payment Method NameThe name of the payment method. -
PaymentTermsId: integer
(int64)
Title:
Payment Terms IDThe unique identifier of the payment terms. -
PaymentTermsName: string
Title:
Payment TermsThe name of the payment terms. -
PenaltyChargeName: string
The penalty charge name.
-
PenaltyValue: number
Title:
Penalty ValueThe penalty value. -
PendingActivationFlag: boolean
Title:
Pending activationMaximum Length:1Indicates whether the activation of the subscription product is pending or not. -
Period: string
Title:
PeriodThe period for which the product has been subscribed. -
PmProgramId: integer
(int64)
Title:
Preventive Maintenance Program IDRead Only:trueThe identifier of the preventive maintenance program. -
PONumber: string
Title:
PO NumberMaximum Length:50The number of the purchase order. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment NumberThe prepayment number. -
PriceAdjustmentBasis: string
Title:
Price Adjustment BasisMaximum Length:30The basis on the which the price is adjusted. -
PriceAdjustmentPercent: number
Title:
Price Adjustment ValueThe price adjustment percent. -
PriceAdjustmentType: string
Title:
Price Adjustment TypeMaximum Length:30The type of the price adjustment. -
PriceAsOf: string
(date)
Title:
Price as of DateThe price of the product as of a certain date. -
PriceListId: integer
(int64)
Title:
Price ListThe unique identifier of the price list. -
PriceListName: string
Title:
Price List NameMaximum Length:120The name of the price list. -
PriceTransactionOn: string
(date)
Title:
Price Transaction on DateThe date when the price transaction occurred. -
PricingError: string
Maximum Length:
2000The pricing error associated with the product. -
PricingSystem: string
The pricing system of the product.
-
PricingTermsAdjustmentPCT: number
Title:
Pricing Term Adjustment PercentageThe adjustment in the pricing terms. -
PricingTermsDuration: number
Title:
Pricing Term DurationThe duration for which the pricing terms last. -
PricingTermsPeriod: string
Title:
Pricing TermMaximum Length:15The period for which the pricing terms last. -
PricingTermsPricingMethod: string
Title:
Pricing MethodMaximum Length:30The method used to set the terms of the product pricing. -
PricingTermsStartDate: string
(date)
Title:
Starting OnThe date when the pricing terms starts. -
PrimaryPartyId: integer
(int64)
Read Only:
trueThe primary party ID of the subscription product. -
PrimaryPartyName: string
Title:
CustomerRead Only:trueMaximum Length:255The primary party name of the subscription product. -
ProductChangeReason: string
Title:
Change ReasonMaximum Length:300The reason for the product change. -
ProductChangeSchedule: string
Title:
Apply ChangeMaximum Length:30The product change schedule is applicable on RENEWAL, ANNIVERSARY or SPECIFIC_DATE. -
ProductChangeScheduleFrom: string
(date)
Title:
Product Change Schedule Effective DateThe date from which the product change schedule is applicable. -
ProductChangeSequenceNumber: integer
Read Only:
trueThe sequence number of the subscription product change. -
ProductFiscClassification: string
Title:
Product Fiscal ClassificationMaximum Length:30The product fiscal classification. -
ProductName: string
Title:
Product NameMaximum Length:300The name of the product. -
productRelationships: array
Product Relationships
Title:
Product RelationshipsThe product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships. -
ProgramCode: string
Title:
Program CodeRead Only:trueMaximum Length:30The code of the preventive maintenance program. -
ProgramName: string
Title:
Program NameRead Only:trueMaximum Length:120The name of the preventive maintenance program. -
ProgramOrganizationId: integer
Title:
OrganizationRead Only:trueThe organization identifier of the preventive maintenance program. -
Quantity: number
Title:
QuantityThe quantity of the product. -
QuoteId: integer
(int64)
Title:
Quote IdThe quote ID associated with the subscription product. -
QuoteLineId: integer
(int64)
Title:
Quote Line IDThe quote line ID associated with the subscription product. -
RatePlanDocument: string
(byte)
The JSON representing the rate plan.
-
RatePlanDocumentId: integer
(int64)
The identifier of the rate plan document.
-
RatePlanId: integer
(int64)
Title:
Rate Plan IDThe unique identifier of the rate plan. -
RatePlanName: string
Title:
Rate PlanThe name of the rate plan. -
RatePlanNumber: string
Title:
Rate Plan NumberThe number of the rate plan. -
RatePlanYn: string
Indicates whether pricing for the subscription product is based on rate plan.
-
RelatedInventoryItemId: integer
(int64)
Title:
Related Inventory Item IDThe unique identifier of the item associated to the replacement subscription product. -
RelatedProductDescription: string
Title:
DescriptionThe description of the replacement subscription product. -
RelatedProductName: string
Title:
Product NameMaximum Length:300The name of the replacement subscription product. -
RelationShipExistFlag: string
Indicates whether relationship exists for the product.
-
relationships: array
Relationships
Title:
RelationshipsThe relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID. -
RenewalDuration: integer
(int64)
Title:
Renewal DurationThe subscription product level renewal duration override that will be used while renewing through automatic or manual renewal. -
RenewalDurationPeriod: string
Title:
Renewal PeriodMaximum Length:30The 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 PeriodThe 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 MethodMaximum Length:30The internal code for the renewal payment method used in the subscription product. -
RenewalPaymentMethodName: string
Title:
Renewal Payment Method NameThe 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 NumberMaximum Length:50The purchase order number of the renewed subscription product. -
RenewalPriceListId: integer
(int64)
The identifier of the renewal price list.
-
RenewalPriceListName: string
Title:
Renewal Price ListMaximum Length:255The name of the renewal price list. -
RenewalRatePlanId: integer
(int64)
The identifier of the renewal rate plan.
-
RenewalRatePlanNumber: string
The renewal rate plan number.
-
RenewalSequenceNumber: integer
Read Only:
trueThe renewal sequence number. -
RenewalType: string
Title:
Product Renewal TypeMaximum Length:30The type of subscription renewal. -
RenewalWireNumber: string
Title:
Product Renewal Wire NumberMaximum Length:30The wire number that identifies the electronic funds transfer used to pay for a renewed subscription product. -
RenewedDate: string
(date)
Title:
Renewed OnThe date when the product was renewed. -
RenewPerpetuallyFlag: boolean
Title:
Renew foreverMaximum Length:1Indicates whether the subscription product should be renewed forever. -
RenewSourceProductPuid: string
Title:
Renewed Subscription Product PUIDMaximum Length:255Renew Source Product Puid -
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 FromThe requested align billing date for the product. -
RequestedEntitlementPlanId: integer
(int64)
Title:
Requested Entitlement Plan IDThe ID of the requested entitlement plan associated with the product. -
RequestedEntitlementPlanNumber: string
Title:
Entitlement Plan NumberThe number of the requested entitlement plan associated with the product. -
RequestedPriceListId: integer
(int64)
Title:
Override Price ListThe identifier of the requested price list. -
RequestedProgramId: integer
(int64)
Title:
Requested Preventive Maintenance Program IDRead Only:trueThe unique identifier of the requested preventive maintenance program. -
RequestedRatePlanId: integer
(int64)
Title:
Requested Rate Plan IDThe 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 should be resumed.
-
ResumeDuration: integer
The duration after which the the product should be resumed.
-
ResumePeriod: string
The period of time after which the product will resume.
-
RetainSubsOnRenewFlag: boolean
Title:
Don't create new renewal subscriptionMaximum Length:1Indicates whether the renewal should happen in the source subscription. -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenueOptionClose: string
Read Only:
trueMaximum Length:30The revenue option selected for the last close operation. -
salesCredits: array
Sales Credits
Title:
Sales CreditsThe sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product. -
SalesOrderId: integer
(int64)
Title:
Sales Order IDThe ID of the sales order associated with the subscription product. -
SalesOrderLineId: integer
(int64)
Title:
Sales Order Line IDThe sales order line ID associated with the subscription product. -
SalesOrderLineNumber: string
Title:
Sales Order Line NumberMaximum Length:100Sales Order Line Number -
SalesOrderNumber: string
Title:
Sales Order NumberMaximum Length:200The number of the sales order associated with the subscription product. -
SalesProductType: string
Title:
TypeMaximum Length:30The type of the sales product. -
serviceResources: array
Service Resources
Title:
Service ResourcesThe service resources resouce 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 IDThe ship-to account ID of the subscription product. -
ShipToAccountNumber: string
Title:
Ship-to AccountThe ship-to account number of the subscription product. -
ShipToContactId: integer
(int64)
Title:
Ship-to Contact IDThe ship-to contact ID of the subscription product. -
ShipToContactName: string
Title:
Ship-to ContactThe ship-to contact name of the subscription product. -
ShipToContactNumber: string
Title:
Ship-to Contact NumberThe ship-to contact number of the subscription product. -
ShipToContactPartyId: integer
Read Only:
trueThe ship-to contact party ID of the subscription product. -
ShipToPartyId: integer
(int64)
Title:
Ship-to Party IDThe unique identifier of the ship-to party. -
ShipToPartyName: string
Title:
Ship-to PartyThe name of the ship-to party. -
ShipToPartyNumber: string
Title:
Ship-to Party NumberRead Only:trueMaximum Length:30The ship-to party number of the subscription product. -
ShipToPartySiteId: integer
(int64)
Title:
Ship-to Party Site IDThe unique identifier of the ship-to party site. -
ShipToPartySiteName: string
Title:
Ship-to SiteThe name of the ship-to party site. -
ShipToPartySiteNumber: string
Title:
Ship-to Site NumberThe ship-to party site number of the subscription product. -
smartActions: array
Subscription Product User Actions
Title:
Subscription Product User ActionsThe smart actions resource stores the endpoint and security details for every user action. -
SourceKey: string
Title:
Source KeyMaximum Length:120The identifier of the product in the source system. -
SourceLineKey: string
Title:
Source Line KeyMaximum Length:120The source line key -
SourceLineNumber: string
Title:
External Source Line NumberMaximum Length:120The source line number -
SourceNumber: string
Title:
External Source NumberMaximum Length:120The alternate identifier of the product in the source system. -
SourceSystem: string
Title:
Source SystemMaximum Length:30The reference of the product in the source system. -
StartDate: string
(date)
Title:
Product Start DateThe date when the subscriptions starts. -
Status: string
Title:
StatusMaximum Length:30Default Value:DRAFTThe status of the subscription product. -
StatusMeaning: string
Title:
Product StatusRead Only:trueMaximum Length:80The meaning of the product status. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionNumber: string
Title:
Subscription NumberMaximum Length:120Default Value:Subscriptions.SubscriptionNumberThe subscription number of the product. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
SubscriptionProductPuid: string
Title:
Subscription Product NumberMaximum Length:120The public unique identifier of the subscription product. -
SummarizedBillingFlag: boolean
Title:
Summarized billingMaximum Length:1Indicates whether the billing is to be summarized. -
SummarizedRatingFlag: boolean
Title:
Enable summarize ratingIndicates whether the entitlement plan is associated with the product is eligibile for summarized rating. -
SuspendCreditMethod: string
Title:
Suspend Credit MethodMaximum Length:30Indicates if the credit method has to be suspended. -
SuspendedDate: string
(date)
Title:
Suspend DateThe date when the product was suspended. -
SuspendReason: string
Title:
Suspend ReasonMaximum Length:30The reason to suspend the product. -
TaxClassificationMeaning: string
Read Only:
trueThe meaning of the tax classification. -
TaxError: string
Title:
Tax ErrorMaximum Length:2000The tax error, if any, in the calculated amount. -
TaxExemptionHandling: string
Title:
Tax Exemption HandlingMaximum Length:30The tax exemption handling. -
TaxExemptionHandlingName: string
The tax exemption handling name.
-
TcvWithTotalUsageCharge: number
Title:
TCV with Total Usage ChargeRead Only:trueTcv With Total Usage Charge -
TotalContractValue: number
Title:
Product Contract ValueThe value of the total contract. -
TotalUsageCharge: number
Title:
Total Usage ChargesRead Only:trueTotal Usage Charge -
TransactionTypeName: string
Title:
Transaction TypeMaximum Length:30The name of the transaction type. -
UnitPrice: number
The price of the unit.
-
UpdateFlag: boolean
Indicates whether the subscription product is updated.
-
UsageEventAllowanceInvTemplate: string
Title:
AllowanceMaximum Length:200The template to show the invoice data for allowance type of balance management. -
UsageEventCommitmentInvTemplate: string
Title:
CommitmentMaximum Length:200The template to show the invoice data for commitment type of balance management. -
UsageEventEstimateInvTemplate: string
Title:
EstimateMaximum Length:200The template to show the invoice data for estimate type of balance management. -
UsageEventRegularInvTemplate: string
Title:
BasicMaximum Length:200The common template to show the invoice data. -
UsageInvoiceLayoutTemplate: string
Title:
BIP TemplateMaximum Length:200The layout template of the usage invoice. -
ValidationStatus: string
Title:
Validation StatusRead Only:trueMaximum Length:1The validation status of the subscription product. -
VolumeRatingFlag: boolean
Title:
Enable volume pricingIndicates whether the entitlement plan is associated with the product is eligibile for volume pricing. -
WarehouseId: integer
(int64)
Title:
WarehouseThe warehouse ID associated with the subscription product. -
WareHouseName: string
Title:
WarehouseThe warehouse name of the subscription product. -
WireNumber: string
Title:
Wire NumberMaximum Length:30The wire number.
Nested Schema : Associated Assets
Type:
arrayTitle:
Associated AssetsThe 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:
arrayTitle:
Bill LinesThe bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Show Source
Nested Schema : Charges
Type:
arrayTitle:
ChargesThe charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
Show Source
Nested Schema : Standard Coverages
Type:
arrayTitle:
Standard CoveragesThe standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.
Show Source
Nested Schema : Covered Levels
Type:
arrayTitle:
Covered LevelsThe covered levels resource is used to create, view, update, or delete the subscription covered levels details, such as subscription ID, subscription product ID, covered asset and its associated details.
Show Source
Nested Schema : Credit Cards
Type:
arrayTitle:
Credit CardsThe credit cards resource is used to view, create, and update the credit cards associated with a subscription.
Show Source
Nested Schema : Descriptive Flexfields
Type:
arrayTitle:
Descriptive FlexfieldsThe descriptive flexfields resource is used to view, create, update, and delete a descriptive flexfield.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Entitlement Plan Commitments
Type:
arrayTitle:
Subscription Entitlement Plan CommitmentsThe 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:
arrayTitle:
Subscription Entitlement Plan DetailsThe 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:
arrayTitle:
Subscription Entitlement Plan EstimatesThe 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 : Subscription Entitlement Pricing Rules
Type:
arrayTitle:
Subscription Entitlement Pricing RulesThe subscription entitlement plan charge rules resource is used to view, create, update, and delete a negotiated entitlement plan charge rule which is used for the rating of a subscription product.
Show Source
Nested Schema : Product Relationships
Type:
arrayTitle:
Product RelationshipsThe product relationships resource is used to view the relationship between a source and a target product. These relationships include amendment, renewal, suspension relationships.
Show Source
Nested Schema : Relationships
Type:
arrayTitle:
RelationshipsThe relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Show Source
Nested Schema : Sales Credits
Type:
arrayTitle:
Sales CreditsThe sales credits resource to view, create, update, and delete the sales credits defined for a subscription or a subscription product.
Show Source
Nested Schema : Service Resources
Type:
arrayTitle:
Service ResourcesThe service resources resouce is used to view, create, update, and delete the service identifier for a subscription product.
Show Source
Nested Schema : Subscription Product User Actions
Type:
arrayTitle:
Subscription Product User ActionsThe smart actions resource stores the endpoint and security details for every user action.
Show Source
Nested Schema : subscriptionProducts-associatedAsset-item-response
Type:
Show Source
object-
AssetId: integer
(int64)
The unique identifier of the asset.
-
AssetName: string
Title:
Asset NameThe name of the asset. -
AssetSerialNumber: string
Title:
Asset Serial NumberThe serial number of the asset. -
AssociatedAssetId: integer
(int64)
The unique identifier of the associated asset.
-
AssociatedAssetPuid: string
Maximum Length:
120The PUID of the associated asset. -
CorpCurrencyCode: string
Maximum Length:
15The corporate currency code. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the associated asset. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the associated asset was created. -
CurcyConvRateType: string
Maximum Length:
30The 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:
15The currency code such as USD or INR. -
InventoryItemId: integer
The unique identifier of the inventory item.
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the associated asset was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the associated asset. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the associated asset. -
LineNumber: integer
(int64)
Title:
NumberThe line number of the associated asset. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProductName: string
Title:
Product NameThe name of the product. -
Quantity: number
Title:
QuantityThe quantity of the associated asset. -
SourceKey: string
Maximum Length:
120The source key of the associated asset. -
SourceLineKey: string
Maximum Length:
120The source line key of the associated asset. -
SourceLineNumber: string
Maximum Length:
120The source line number of the associated asset. -
SourceNumber: string
Maximum Length:
120The source number of the associated asset. -
SourceSystem: string
Maximum Length:
30The 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:
UOMThe unit of measure of the associated asset. -
UnitOfMeasureCode: string
Title:
UOMThe unit of measure code of the associated asset.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionProducts-billLines-item-response
Type:
Show Source
object-
AdhocBillLineFlag: boolean
Default Value:
falseAdhoc BillLine Flag -
Amount: number
Title:
AmountThe amount for which the bill is generated. -
BatchTag: string
Title:
Batch TagMaximum Length:30Batch Tag -
billAdjustments: array
Bill Adjustments
Title:
Bill AdjustmentsThe bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity. -
BillingPeriod: number
Title:
SequenceThe period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120The public unique identifier of the bill line. -
BusinessUnitId: integer
The ID of the business unit associated with the bill line.
-
ChargeDefinition: string
Maximum Length:
30The definition that indicates the purpose of the charge. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeName: string
Title:
Charge NameMaximum Length:120The name of the charge associated with the bill line. -
ChargePeriod: number
Title:
PeriodThe usage period that was charged. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Title:
Charge PUIDThe public unique identifier of the charge. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the billing line. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the billing line was created. -
CreditMemoAmount: number
The amount for the credit memo.
-
CreditMemoFlag: string
Indicates if there is a credit memo associated with the bill line.
-
CreditMemoReason: string
The reason to raise the credit memo.
-
CreditMemoReasonCode: string
Title:
Credit Memo Reason CodeMaximum Length:30The code of the credit memo reason code. -
CustomerTrxTypeSequenceId: integer
(int64)
Customer Transaction Type Sequence Id
-
DateBilledFrom: string
(date)
Title:
Bill-from DateThe date from which the bill was generated. -
DateBilledTo: string
(date)
Title:
Bill-to DateThe date up to which the bill is generated. -
DateToInterface: string
(date)
Title:
Interface DateThe date to interface for the bill line. -
EstimatedQuantityYn: string
Estimated Quantity Yn
-
InterfacedFlag: boolean
Title:
InterfacedMaximum Length:1Default Value:falseIndicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice TextMaximum Length:240The text in the bill line invoice. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the billing line was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the billing line. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the billing line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ListPrice: number
The list price of the product associated with the bill line.
-
MilestoneEventId: integer
(int64)
The ID of the milestone event associated with the bill line.
-
MilestoneEventName: string
Title:
Milestone NameThe name of the milestone event associated with the bill line. -
MilestoneEventPuid: string
Title:
Milestone Event PUIDMilestone Event Puid -
NewCreditMemoPUID: string
The unique public identifier of the new credit memo.
-
PricedQuantity: number
Title:
Priced QuantityThe quantity for which the bill line was charged. -
PricingError: string
Maximum Length:
1000The error in pricing, if any. -
RecurringFlag: boolean
Maximum Length:
1Indicates whether the line is recurring or not. -
RetrieveInvoiceFlag: boolean
Title:
Retrieve Invoice from ReceivablesMaximum Length:1Retrieve Invoice Flag -
RevenueLineId: integer
(int64)
The unique identifier of the revenue line.
-
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity PeriodsMaximum Length:30Revenue Period -
SentDate: string
(date)
Title:
Sent DateThe 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 IDSummarized Bill Line ID -
TransactionAmount: number
Title:
Invoice AmountThe amount for which the transaction occurred. -
TransactionClass: string
Title:
Transaction ClassMaximum Length:30The class of the transaction. -
TransactionClassMeaning: string
Title:
ClassThe meaning of transaction class lookup. -
TransactionDate: string
(date)
Title:
Invoice DateThe date when the transaction occurred. -
TransactionNumber: string
Title:
Invoice NumberMaximum Length:30The number of the transaction. -
TransactionTax: number
Title:
TaxThe tax levied on the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3Indicates if the bill line has a trueup period. -
TrxId: integer
(int64)
The AR transaction ID.
-
TrxLineId: integer
(int64)
The AR transaction line ID.
-
UsageAcquiredFlag: boolean
Maximum Length:
1Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
Title:
Usage Capture DateThe date when the usage was captured. -
UsageChargeType: string
Title:
Usage Charge TypeMaximum Length:30The type of usage charge. -
UsageChargeTypeName: string
Title:
Usage Charge TypeThe name of the usage charge type. -
UsageFlag: boolean
Maximum Length:
1Indicates whether the line is a usage line or not. -
UsageInvoiceAttachmentYn: string
Maximum Length:
1Indicates whether usage events invoice attachment is associated with the bill line. -
UsagePricedFlag: boolean
Maximum Length:
1Indicates whether the usage line has been priced or not. -
UsageQuantity: number
Title:
Usage QuantityThe quantity of the usage. -
UsageRatingProcess: string
Title:
Usage Rating ProcessMaximum Length:30Usage Rating Process
Nested Schema : Bill Adjustments
Type:
arrayTitle:
Bill AdjustmentsThe bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-billLines-billAdjustments-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Title:
BasisMaximum Length:30The basis on which the bill is adjusted. -
AdjustmentCategoryCode: string
Title:
Adjustment CategoryMaximum Length:30The code of the adjustment category. -
AdjustmentName: string
Title:
AdjustmentMaximum Length:120The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30The code of the adjustment reason. -
AdjustmentStepSequenceNumber: number
Title:
Step Sequence NumberThe alternate unique identifier of the adjustment step sequence. -
AdjustmentType: string
Title:
TypeMaximum Length:30The type of the bill adjustment. -
AdjustmentValue: number
Title:
ValueThe value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Title:
Charge Adjustment PUIDMaximum Length:120Charge Adjustment Puid -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
PERPeriodFlag: boolean
Title:
Per periodMaximum Length:1Indicates whether the adjustment is per charge period. -
PERQuantityFlag: boolean
Title:
Per quantityMaximum Length:1Indicates whether the adjustment is per sub quantity. -
Reason: string
Title:
Reason DetailsMaximum Length:120The reason why the bill is adjusted. -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start DateRevenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End DateRevenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity PeriodsMaximum Length:30Revenue Period -
SequenceNumber: number
Title:
SequenceThe sequence number of the bill adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-item-response
Type:
Show Source
object-
adjustments: array
Adjustments
Title:
AdjustmentsThe adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity. -
AggregationMethod: string
Title:
Aggregation MethodMaximum Length:30The aggregation method used for the charges. -
Allowance: number
Title:
AllowanceThe allowance part of the charge. -
AssetMeterYn: boolean
Title:
Asset Meter FlagMaximum Length:1The flag whether it is an asset meter or not. -
BatchTag: string
Title:
Batch TagMaximum Length:30Batch Tag -
BillingFreq: string
Title:
Billing FrequencyMaximum Length:30Billing Frequency -
BillingFreqName: string
Title:
Billing FrequencyMaximum Length:255Billing Frequency Name -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BlockSize: number
Title:
Block SizeThe block size of the charge. -
chargeComponents: array
Subcription Product Charge Components Records
Title:
Subcription Product Charge Components RecordsThe subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products. -
ChargeDefinition: string
Title:
Charge NameMaximum Length:30The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
Title:
Charge DefinitionThe name of the charge definition. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone EventsThe 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 NameMaximum Length:120The name of the charge. -
ChargePeriodCode: string
Title:
Charge Period CodeMaximum Length:30The code of the charge period associated with the charge. -
ChargePuid: string
Title:
Charge PUIDMaximum Length:120The public unique identifier of the charge. -
chargeTiers: array
Charge Tiers
Title:
Charge TiersThe charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price. -
CoveredLevelId: integer
(int64)
Title:
Covered Level IDThe unique identifier of the covered level. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the charge. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the charge was created. -
EnableProration: string
Title:
Enable ProrationMaximum Length:1Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated AmountThe estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation MethodThe method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated QuantityThe estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation MethodMaximum Length:30The method used to estimate the amount. -
ExternalKey: string
Title:
External KeyMaximum Length:120The external key used to measure the charge. -
ExternalParentKey: string
Title:
External Parent KeyMaximum Length:120The external parent key. -
InitialMeterReadingId: integer
(int64)
Title:
Initial Meter Reading IDThe initial meter reading identifier value. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule IdThe ID of the invoice rule. -
InvoicingRuleName: string
Title:
Invoicing RuleThe name of the invoice rule. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the charge was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the charge. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the charge. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition IDThe unique identifier of the meter definition associated with the charges. -
MeterId: integer
(int64)
Title:
Meter IDThe unique identifier of the meter associated with the charges. -
MilestoneBillingFlag: boolean
Title:
Enable Milestone Based BillingIndicates whether the billing is impacted by milestone events or not. -
MilestoneRevenueFlag: boolean
Title:
Enable Milestone Based Revenue RecognitionIndicates whether the revenue is impacted by milestone events or not. -
MilestoneTemplateId: integer
(int64)
Title:
TemplateThe ID of the milestone event associated with a charge. -
MilestoneTemplateName: string
Maximum Length:
120The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum AmountThe minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum QuantityThe minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Title:
Enable Periodic BillingMaximum Length:1Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue RecognitionMaximum Length:1Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment NumberThe prepayment number for the charge. -
PricePeriodicity: string
Title:
PeriodicityMaximum Length:30The price periodicity for the charge. Indicates the frequency when the charge has to be applied. -
PricePeriodicityName: string
Title:
PeriodicityThe name of the price periodicity. -
PriceType: string
Title:
Price TypeMaximum Length:30The price type associated with the charge. -
QuotedTcv: number
Title:
Total Charge AmountThe quoted TCV of the charge. -
RecurringPricePeriodicityCode: string
Title:
Recurring Price Periodicity CodeMaximum Length:30The recurring price periodicity code of the charge. -
RollupFlag: boolean
Title:
Rollup FlagMaximum Length:1Indicates if the charge needs to be rolled up. -
SequenceNumber: integer
(int32)
Title:
Sequence NumberThe sequence number for the charge. -
SubscriptionId: integer
(int64)
Title:
Subscription IDThe unique identifier of the subscription. -
SubscriptionProductId: integer
(int64)
Title:
Subscription Product IDThe unique identifier of the subscription product. -
TieredFlag: boolean
Title:
TieredMaximum Length:3Indicates whether the charge has tiers. -
TieredPricingHeaderId: integer
Title:
Tiered Pricing Header IDTiered Pricing Header Id -
TierType: string
Title:
Tier TypeMaximum Length:30The type of the charge tier. -
TrueUpPeriod: string
Title:
True Up PeriodMaximum Length:30Default Value:ORA_OSS_USAGE_BILLING_PERIODThe identifier of the trueup period. -
TrueUpPeriodName: string
Title:
True Up PeriodThe name of the trueup period. -
UnitListPrice: number
Title:
List PriceThe price of the unit list. -
UsagePriceLockFlag: boolean
Title:
Usage Price LockMaximum Length:3Indicates whether the usage price is locked or not. -
UsageUnitOfMeasure: string
Title:
Usage UOMMaximum Length:3The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
arrayTitle:
AdjustmentsThe adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Show Source
Nested Schema : Subcription Product Charge Components Records
Type:
arrayTitle:
Subcription Product Charge Components RecordsThe subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
Show Source
Nested Schema : Charge Milestone Events
Type:
arrayTitle:
Charge Milestone EventsThe 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:
arrayTitle:
Charge TiersThe charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-adjustments-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Title:
BasisMaximum Length:30The basis of the adjustment. -
AdjustmentCategoryCode: string
Title:
Category CodeMaximum Length:30The code of the adjustment category. -
AdjustmentName: string
Title:
AdjustmentMaximum Length:120The name of the adjustment. -
AdjustmentReasonCode: string
Title:
ReasonMaximum Length:30The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
ReasonThe translated adjustment reason. -
AdjustmentStepSequenceNumber: number
Title:
Step Sequence NumberThe alternate unique identifier of the adjustment step sequence. -
AdjustmentType: string
Title:
TypeMaximum Length:30The type of the adjustment. -
AdjustmentValue: number
Title:
ValueThe value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the adjustment was created. -
Effectivity: string
Title:
EffectivityMaximum Length:30The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason DescriptionMaximum Length:120The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
SequenceThe sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
ValidFrom: string
(date-time)
Valid From
-
ValidUntil: string
(date-time)
Valid Until
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-chargeComponents-item-response
Type:
Show Source
object-
ChargeComponentId: integer
(int64)
The identifier of the charge component.
-
ChargeComponentPuid: string
Maximum Length:
120The PUID of the charge component. -
ChargeCurrency: string
Title:
CurrencyMaximum Length:15The charge currency of the charge component. -
ChargeCurrencyExtAmount: number
Title:
Extended AmountThe extended amount of the charge component in charge currency. -
ChargeCurrencyName: string
Title:
CurrencyRead Only:trueMaximum Length:80The name of the charge currency. -
ChargeCurrencyUnitPrice: number
Title:
Currency Unit PriceThe unit price of the charge component in charge currency. -
ChargeId: integer
(int64)
Title:
Charge IDThe identifier of the charge. -
CoverageExtendedAmount: number
Title:
Coverage Extended AmountThe extended coverage amount of the charge component. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
Explanation: string
Title:
ExplanationMaximum Length:1000The explanation for the charge component. -
ExplanationMessageName: string
Title:
Explanation MessageMaximum Length:30The explanation message name of the charge component. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the subscription. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number of the charge component.
-
Price: number
Title:
AmountThe price of the charge component. -
PriceElement: string
Title:
Price ElementMaximum Length:30The price element of the charge component. -
PriceElementName: string
Title:
Price ElementRead Only:trueMaximum Length:80The name of the price element associated with the charge component. -
PriceElementUsage: string
Title:
Price Element UsageMaximum Length:30The price element usage of the charge component. -
PriceElementUsageName: string
Title:
Price Element UsageRead Only:trueMaximum Length:80The name of the price element usage associated with the charge component. -
PriceforQuantity: number
Title:
PriceThe price for quantity of the charge component. -
PricingSourceId: integer
(int64)
The identifier of the pricing source of the charge component.
-
PricingSourceType: string
Title:
Pricing Source TypeMaximum Length:30The type of pricing source of the charge component. -
PricingSourceTypeName: string
Title:
Pricing Source TypeRead Only:trueMaximum Length:80The name of the pricing source type. -
RollupFlag: boolean
Title:
Rollup FlagMaximum Length:1The indicator of whether charge component should be rolled up or not. -
SequenceNumber: integer
(int32)
Title:
Sequence NumberThe sequence number of the charge component. -
SubscriptionCurrency: string
Title:
Subscription CurrencyMaximum Length:15The subscription currency of the charge component. -
SubscriptionCurrencyName: string
Title:
Subscription CurrencyRead Only:trueMaximum Length:80The name of the subscription currency. -
SubscriptionId: integer
(int64)
Title:
Subscription IDThe identifier of the subscription. -
TaxIncludedFlag: boolean
Title:
Tax Included FlagMaximum Length:1The indicator of whether tax is included for the charge component or not. -
UnitPrice: number
Title:
Unit PriceThe unit price of the charge component.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-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.
-
BillLinePuid: string
Title:
Bill Line PUIDMaximum Length:120Bill Line Puid -
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120Default Value:Charges.ChargePuidThe 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:
trueMaximum Length:64The login of the user who created the milestone event. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which the milestone event was created. -
EventId: integer
(int64)
The ID of the milestone event.
-
EventSource: string
Maximum Length:
30The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120The source reference of the milestone event. -
EventType: string
Maximum Length:
30The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
InterfacedFlag: boolean
Title:
InterfacedMaximum Length:1Default Value:falseIndicates whether the milestone event is interfaced or not. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date of which the milestone event was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who updated the milestone event the last. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login which updated the milestone event the last. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MilestoneComment: string
Maximum Length:
300The milestone event comment. -
MilestoneName: string
Maximum Length:
30The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120The 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-charges-chargeTiers-item-response
Type:
Show Source
object-
AdditionalNumberFive: number
Title:
Additional Number FiveAdditional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number FourAdditional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number OneAdditional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number SixAdditional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number ThreeAdditional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number TwoAdditional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text OneMaximum Length:4000Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text TwoMaximum Length:4000Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp OneAdditional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp ThreeAdditional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp TwoAdditional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text ThreeMaximum Length:4000Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block SizeThe block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120The public unique identifier of the charge tier. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the charge tier. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the charge tier was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the charge tier was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the charge tier. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the charge tier. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ListPrice: number
Title:
List PriceThe list price -
PriceFormat: string
Title:
Price FormatMaximum Length:30The display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TierFrom: number
Title:
Tier FromThe tier from -
TierTo: number
Title:
Tier ToThe tier to
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coverage-item-response
Type:
Show Source
object-
CoverageChargeDiscounts: array
Adjustments
Title:
AdjustmentsThe adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information. -
CoverageDescription: string
Title:
Template DescriptionMaximum Length:1000The value that uniquely identifies the standard coverage description. -
CoverageHeaderId: integer
(int64)
The unique identifier of the internal standard coverage.
-
CoverageHeaderPuid: string
Maximum Length:
120The value that uniquely identifies the standard coverage. -
CoverageName: string
Title:
Template NameMaximum Length:150The name of the standard coverage. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the standard coverage record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the standard coverage was created. -
DynamicMatrixClassId: integer
(int64)
Title:
Entitlement TypeThe unique identifier of the dynamic matrix class. -
DynamicMatrixClassName: string
Title:
Entitlement TypeThe alternate value that uniquely identifies the dynamic matrix class. -
EndDate: string
(date)
Title:
End DateThe date when the standard coverage ends. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the standard coverage was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the standard coverage. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The name of the user who has last updated the standard coverage. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatrixId: integer
(int64)
The unique identifier of the dynamic matrix.
-
MatrixName: string
The name of the matrix.
-
PreventiveMaintenanceWorkRequirements: array
Preventive Maintenance Work Requirements
Title:
Preventive Maintenance Work RequirementsThe preventive maintenance work requirements resource is used to get the work requirements of a preventive maintenance program associated with a subscription coverage. -
ProgramCode: string
Title:
Program CodeMaximum Length:30The code of the associated maintenance program. -
ProgramDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the associated maintenance program. -
ProgramEndDate: string
(date)
Title:
End DateRead Only:trueThe end date of the associated maintenance program. -
ProgramId: integer
(int64)
The identifier of the associated maintenance program.
-
ProgramName: string
Title:
Program NameMaximum Length:120The name of the associated maintenance program. -
ProgramOrganizationId: integer
(int64)
Title:
OrganizationThe organization identifier of the associated maintenance program. -
ProgramStartDate: string
(date)
Title:
Start DateRead Only:trueThe start date of the associated maintenance program. -
StandardCoverageYn: string
Maximum Length:
1Indicates whether coverage is standard coverage. The default value is False. -
StartDate: string
(date)
Title:
Start DateThe date when the adjustments was created. -
SubscriptionProductPuid: string
The value that uniquely identifies the subscription product.
Nested Schema : Adjustments
Type:
arrayTitle:
AdjustmentsThe adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Preventive Maintenance Work Requirements
Type:
arrayTitle:
Preventive Maintenance Work RequirementsThe preventive maintenance work requirements resource is used to get the work requirements of a preventive maintenance program associated with a subscription coverage.
Show Source
Nested Schema : subscriptionProducts-coverage-CoverageChargeDiscounts-item-response
Type:
Show Source
object-
AdjustmentAmount: number
Title:
ValueThe amount entered for an adjustment type. -
AdjustmentTypeCode: string
Maximum Length:
30The unique code for adjustment type lookup. Valid values include discount percent or markup percent. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES. -
AdjustmentTypeMeaning: string
Title:
Adjustment TypeThe display value for the adjustment type lookup. The alternate valid values include discount percent or markup percent. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES. -
AllowCustomAdjustmentsFlag: boolean
Title:
Allow custom adjustmentsMaximum Length:1Indicates whether custom adjustments are allowed. The Default value is True. -
AllowPricingDiscountsFlag: boolean
Title:
Allow pricing discountsMaximum Length:1Indicates whether pricing discounts are allowed. The default value is False. -
BillingTypeCode: string
Maximum Length:
30The unique code for billing type lookup. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE for billing type code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task. -
BillingTypeMeaning: string
Title:
Billing TypeThe display value for the billing type lookup code. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE for billing type meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task. -
BusinessProcessCode: string
Maximum Length:
30The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task. -
BusinessProcessMeaning: string
Title:
Business ProcessThe display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task. -
ChargeDefinitionCode: string
Maximum Length:
30The charge definition code. -
ChargeDefinitionId: integer
(int64)
Title:
Charge DefinitionThe charge definition identifier. -
ChargeDefinitionName: string
Title:
Charge DefinitionMaximum Length:255The charge definition name. -
ChargeDiscountId: integer
(int64)
The unique identifier of the adjustment.
-
ChargeSubtypeCode: string
Maximum Length:
30The charge subtype code. -
ChargeTypeCode: string
Maximum Length:
30The charge type code. -
CoverageDiscountPuid: string
Maximum Length:
120The value that uniquely identifies the adjustments. -
CoverageHeaderId: integer
(int64)
The unique identifier of the parent coverage header against an adjustment.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the adjustment was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code. -
EndDate: string
(date)
Title:
End DateThe date when the coverage adjustment ends. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The name of the user who has last updated the adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: integer
(int64)
The organization ID.
-
PriceUOM: string
Title:
Price UOMMaximum Length:255The price UOM. -
PriceUOMCode: string
Title:
Price UOMMaximum Length:3The price UOM code. -
PricingBasisId: integer
Title:
Adjustment BasisThe unique identifier of the pricing basis. A list of accepted values is defined in the view qp_pricing_basis_vl for pricing basis ID. -
PricingBasisName: string
Title:
Adjustment BasisThe name of the pricing basis. A list of accepted values is defined in the view qp_pricing_basis_vl for pricing basis name. -
PricingTermId: integer
The unique identifier of the pricing term.
-
ServiceActivityId: integer
(int64)
The unique identifier of the service activity. A list of accepted values is defined in the view RCL_SERVICE_ACTIVITIES_VL for service activity ID.
-
ServiceActivityName: string
Title:
Service ActivityMaximum Length:80The name of the service activity. A list of accepted values is defined in the view RCL_SERVICE_ACTIVITIES_VL for service activity name. -
ServiceItemId: integer
(int64)
Title:
Service ItemThe service item ID. -
ServiceItemNumber: string
Title:
Service ItemMaximum Length:255The service item number. -
StartDate: string
(date)
Title:
Start DateThe date when the adjustment starts.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coverage-PreventiveMaintenanceWorkRequirements-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date)
Title:
End DateRead Only:trueStart Date -
ActiveStartDate: string
(date)
Title:
Start DateRead Only:trueEnd Date -
AssetInclusionTypeCode: string
Read Only:
trueMaximum Length:30The asset inclusion type code associated with a work requirement. -
ItemId: integer
(int64)
Title:
Related Inventory Item IDRead Only:trueRelated Inventory Item ID -
ItemName: string
Title:
ItemRead Only:trueMaximum Length:240Item -
ItemNumber: string
Read Only:
trueMaximum Length:300The number of the item associated with a work requirement. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Title:
OrganizationRead Only:trueOrganization -
ProgramId: integer
(int64)
Read Only:
trueThe identifier of the program associated with the work requirement. -
RequirementId: integer
Read Only:
trueThe unique identifier of the work requirement. -
RequirementName: string
Title:
NameRead Only:trueMaximum Length:120Name -
RequirementType: string
Read Only:
trueMaximum Length:80The type of the work requirement. -
RequirementTypeCode: string
Read Only:
trueMaximum Length:30The type code of the work requirement. -
Status: string
Title:
Line StatusRead Only:trueMaximum Length:80Line Status -
StatusCode: string
Title:
Line StatusRead Only:trueMaximum Length:30Line Status
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-item-response
Type:
Show Source
object-
Address: string
Title:
AddressThe address of the party site. -
AssetGroupId: integer
(int64)
Title:
Asset Group IDThe unique identifier of the asset group. -
AssetGroupName: string
Title:
Asset Group NameThe name of the asset group. -
AssetGroupNumber: string
Title:
Asset Group NumberThe alternate identifier of an asset group. -
AssetId: integer
(int64)
Title:
Asset IDThe unique identifier of the asset. -
AssetName: string
Title:
Covered Level Asset NameThe name of the asset. -
AssetSerialNumber: string
Title:
Covered Asset Serial NumberThe serial number of the asset. -
BatchTag: string
Title:
Batch TagMaximum Length:30Batch Tag -
billLines: array
Bill Lines
Title:
Bill LinesThe bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags. -
CalculatedCreditAmount: number
Title:
Calculated Credit AmountThe calculated credit amount of the covered level. -
CalculateEstimatedTaxFlag: boolean
Indicates whether estimated tax will be calculated for the subscription covered level.
-
CancelDescription: string
Title:
Cancellation DescriptionMaximum Length:2000The cancellation description associated with a covered level. -
CanceledAmount: number
Title:
Canceled AmountThe amount that was canceled. -
CanceledDate: string
(date)
Title:
Canceled DateThe date when the covered level was canceled. -
CancelReason: string
Title:
Cancellation ReasonMaximum Length:30The reason for cancelling the covered level. -
charges: array
Charges
Title:
ChargesThe charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag. -
ClosedAmount: number
Title:
Closed AmountThe amount at which the covered level was closed. -
ClosedDate: string
(date)
Title:
Covered Level Close DateThe date when the covered level was closed. -
CloseDescription: string
Title:
Covered Level Close DescriptionMaximum Length:2000The close description associated with a covered level. -
CloseReason: string
Title:
Covered Level Close ReasonMaximum Length:30The reason why the covered level was closed. -
CorpCurrencyCode: string
Title:
Currency CodeMaximum Length:15The corporate currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. -
CoveredLevelId: integer
(int64)
Title:
Covered Level IDThe unique identifier of the covered level. -
CoveredLevelName: string
Title:
Covered Level NameMaximum Length:300The name of the covered level. -
CoveredLevelParentPuid: string
The alternate unique identifier of the covered level parent.
-
CoveredLevelPuid: string
Title:
Covered Level PUIDMaximum Length:120The public unique identifier of the covered level. -
CoveredLevlName: string
Title:
Covered Level NameThe name of the covered level. -
CoveredLevlNumber: string
Title:
Covered Level NumberThe alternate identifier of the covered level. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the covered level. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the covered level was created. -
CreditedAmount: number
Title:
Credited AmountThe amount that was credited. -
CreditType: string
Title:
Credit TypeMaximum Length:30Indicates the type of credit to be issued to the customer on close and amend. -
CurcyConvRateType: string
Title:
Conversion Rate TypeMaximum Length:30The currency conversion rate type associated with the covered level. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. -
CurrencyCode: string
Title:
Currency CodeMaximum Length:15The currency code associated with the covered level. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CustomerAccountId: integer
(int64)
Title:
Customer Account IDThe unique identifier of the customer account. -
CustomerName: string
Title:
Customer AccountThe name of the customer. -
CustomerNumber: string
Title:
Customer Account NumberThe alternate unique identifier of the customer. -
Description: string
Title:
Covered Level DescriptionA brief description of the covered level. -
Duration: integer
The duration of the covered level.
-
EndDate: string
(date)
Title:
Covered Level End DateThe date when the covered level ends. -
ExplodeAssetHierarchy: string
Indicates if the assest hierarchy should be copied to other hierarchies.
-
GenBillSchReqdFlag: boolean
Title:
Billing schedule update requiredMaximum Length:1Generate Bill Schedule Required Flag -
GenerateBillingSchedule: string
Indicates whether the billing schedule is to be generated.
-
HierarchyTotal: number
The total covered level of the hierarchy.
-
InventoryItemId: integer
(int64)
Title:
Item IDThe unique identifier of the inventory item. -
InvoicedAmount: number
Title:
Invoiced AmountThe amount for which the invoice was created. -
InvoiceText: string
Maximum Length:
2000The text included in the invoice. -
ItemUnitOfMeasure: string
Title:
UOMMaximum Length:15The unit of measure used to measure the items in the covered level. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the covered level was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the covered level. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the covered level. -
LineNumber: string
Title:
NumberMaximum Length:300The line number -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OverrideCreditAmount: number
Title:
Override Credit AmountThe override credit amount of the covered level. -
ParentCoveredAssetId: integer
(int64)
Title:
Parent Covered Asset IDThe unique identifier of the parent covered asset. -
ParentCoveredLevelId: integer
(int64)
Title:
Parent Covered Level IDThe unique identifier of the parent covered level. -
PartyId: integer
(int64)
Title:
Party IDThe unique identifier of the party. -
PartyName: string
Title:
Party NameThe name of the party. -
PartyNumber: string
Title:
Party NumberThe alternate identifier of the party. -
PartySite: string
Title:
Party Site NumberThe name of the party site. -
PartySiteId: integer
(int64)
Title:
Party Site IDThe unique identifier of the party site. -
Period: string
Maximum Length:
80The period of the covered level. -
PriceAsOf: string
(date)
Title:
Price as of DateThe price as of a certain date. -
PriceListId: integer
(int64)
Title:
Price ListThe unique identifier of the price list. -
PriceUnitOfMeasure: string
Title:
Pricing UOMMaximum Length:30The unit of measure used to indicate the price. -
PriceUnitOfMeasureName: string
Title:
Pricing UOMThe display name of the unit of measure. -
PricingError: string
Title:
Pricing ErrorMaximum Length:1000The error in the pricing, if any. -
productAssetRelationships: array
Covered Level Relationships
Title:
Covered Level RelationshipsThe covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships. -
ProductGroupId: integer
(int64)
Title:
Product Group IDThe unique identifier of the product group. -
ProductGroupName: string
Title:
Product Group NameThe name of the product group. -
ProductGroupNumber: string
Title:
Product Group NumberThe alternate identifier of a product group. -
ProductName: string
Title:
Product NameThe name of the product associated with the covered level. -
PutOnHoldFlag: boolean
Indicates if the covered level has been put on hold.
-
Quantity: number
Title:
QuantityDefault Value:1The quantity of the covered level. -
relationships: array
Relationships
Title:
RelationshipsThe relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID. -
RemoveHoldFlag: boolean
Indicates if the hold on the covered level has to be removed.
-
RenewalType: string
Title:
Renewal TypeMaximum Length:30The type of the covered level renewal. -
RenewedDate: string
(date)
Title:
Renewed OnThe date when the covered level was renewed. -
RepriceFlag: boolean
Indicates whether the subscription covered level should be repriced or not. If passed as 'true', the subscription covered level and its child covered levels will be repriced.
-
RequestedPriceListId: integer
(int64)
Title:
Override Price ListThe identifier of the requested price list. -
ReturnCreditMethod: string
Title:
Close Credit MethodMaximum Length:230The method used to return the credit. -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RollupTotal: number
Title:
Configured Asset AmountThe rollup total of covered level. -
SerialNumber: string
Title:
Covered Asset Serial NumberRead Only:trueMaximum Length:80The serial number of the covered level. -
SourceKey: string
Title:
Source KeyMaximum Length:120The source key of the covered level. -
SourceLineKey: string
Title:
Source Line KeyMaximum Length:120The source line key of the covered level. -
SourceLineNumber: string
Title:
External Source Line NumberMaximum Length:120The source line number of the covered level. -
SourceNumber: string
Title:
External Source NumberMaximum Length:120The source number of the covered level. -
SourceSystem: string
Title:
External Source SystemMaximum Length:30The source system of the covered level. -
StartDate: string
(date)
Title:
Covered Level Start DateThe date when the covered level starts. -
Status: string
Title:
Covered Level StatusMaximum Length:30The status of the covered level. -
StatusName: string
Title:
StatusThe meaning of the status of the covered level. -
SubscriptionId: integer
(int64)
Title:
Subscription IDThe unique identifier of the subscription. -
SubscriptionProductId: integer
(int64)
Title:
Subscription Product IDThe unique identifier of the subscription product. -
SuppressedCreditAmount: number
Title:
Suppressed Credit AmountThe credit amount that was suppressed. -
SuspendCreditMethod: string
Title:
Suspend Credit MethodMaximum Length:30Indicates if the credit method has to be suspended. -
SuspendedDate: string
(date)
Title:
Covered Level Suspend DateThe date when the covered level was suspended. -
SuspendReason: string
Title:
Covered Level Suspend ReasonMaximum Length:30The reason for suspending the credit method for the covered level. -
TaxAmount: number
Title:
Tax AmountThe tax amount levied on the transaction. -
TaxError: string
Maximum Length:
4000The tax error, if any, in the calculated amount. -
TotalContractValue: number
Title:
Covered Level Contract ValueThe total contract value associated with the covered level. -
Type: string
Title:
TypeMaximum Length:30The type of the covered level. -
TypeName: string
Title:
Covered Level TypeThe name of the type of the covered level. -
UnitPrice: number
Title:
Unit PriceThe unit price of the covered level. -
ValidationStatus: string
Title:
Validation StatusRead Only:trueMaximum Length:1Validation Status
Nested Schema : Bill Lines
Type:
arrayTitle:
Bill LinesThe bill lines resource is used to view, create, update, and delete the subscription bill line details, such as charge period, date bill from, date billed to, amount, recurring flag, invoice text, usage quantity, and usage flags.
Show Source
Nested Schema : Charges
Type:
arrayTitle:
ChargesThe charges resource is used to view, create, update, and delete the subscription charge details, such as charge name, charge definition, price type, price periodicity, and tiered flag.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Covered Level Relationships
Type:
arrayTitle:
Covered Level RelationshipsThe covered level relationships resource is used to view the relationship between a source and a target covered level. These relationships include amendment, renewal, suspension relationships.
Show Source
Nested Schema : Relationships
Type:
arrayTitle:
RelationshipsThe relationships resource is used to view, create, update, and delete the subscription product relationships details, such as relationship type, source subscription product PUID, and target subscription product PUID.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-item-response
Type:
Show Source
object-
AdhocBillLineFlag: boolean
Default Value:
falseAdhoc BillLine Flag -
Amount: number
Title:
AmountThe amount for which the bill is generated. -
BatchTag: string
Title:
Batch TagMaximum Length:30Batch Tag -
billAdjustments: array
Bill Adjustments
Title:
Bill AdjustmentsThe bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity. -
BillingPeriod: number
Title:
SequenceThe period for which the bill is generated. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BillLinePuid: string
Maximum Length:
120The public unique identifier of the bill line. -
BusinessUnitId: integer
The ID of the business unit associated with the bill line.
-
ChargeDefinition: string
Maximum Length:
30The definition that indicates the purpose of the charge. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeName: string
Title:
Charge NameMaximum Length:120The name of the charge associated with the bill line. -
ChargePeriod: number
Title:
PeriodThe usage period that was charged. -
ChargePeriodFactor: number
The change period factor associated with the bill line.
-
ChargePuid: string
Title:
Charge PUIDThe public unique identifier of the charge. -
CoveredLevelId: integer
(int64)
The unique identifier of the covered level.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the billing line. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the billing line was created. -
CreditMemoAmount: number
The amount for the credit memo.
-
CreditMemoFlag: string
Indicates if there is a credit memo associated with the bill line.
-
CreditMemoReason: string
The reason to raise the credit memo.
-
CreditMemoReasonCode: string
Title:
Credit Memo Reason CodeMaximum Length:30The code of the credit memo reason code. -
CustomerTrxTypeSequenceId: integer
(int64)
Customer Transaction Type Sequence Id
-
DateBilledFrom: string
(date)
Title:
Bill-from DateThe date from which the bill was generated. -
DateBilledTo: string
(date)
Title:
Bill-to DateThe date up to which the bill is generated. -
DateToInterface: string
(date)
Title:
Interface DateThe date to interface for the bill line. -
EstimatedQuantityYn: string
Estimated Quantity Yn
-
InterfacedFlag: boolean
Title:
InterfacedMaximum Length:1Default Value:falseIndicates whether the bill line is interfaced or not. -
InvoiceBillLineId: integer
(int64)
The unique identifier of the invoice bill line.
-
InvoiceDate: string
(date)
The date when the invoice was raised.
-
InvoiceText: string
Title:
Invoice TextMaximum Length:240The text in the bill line invoice. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the billing line was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the billing line. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the billing line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ListPrice: number
The list price of the product associated with the bill line.
-
MilestoneEventId: integer
(int64)
The ID of the milestone event associated with the bill line.
-
MilestoneEventName: string
Title:
Milestone NameThe name of the milestone event associated with the bill line. -
MilestoneEventPuid: string
Title:
Milestone Event PUIDMilestone Event Puid -
NewCreditMemoPUID: string
The unique public identifier of the new credit memo.
-
PricedQuantity: number
Title:
Priced QuantityThe quantity for which the bill line was charged. -
PricingError: string
Maximum Length:
1000The error in pricing, if any. -
RecurringFlag: boolean
Maximum Length:
1Indicates whether the line is recurring or not. -
RetrieveInvoiceFlag: boolean
Title:
Retrieve Invoice from ReceivablesMaximum Length:1Retrieve Invoice Flag -
RevenueLineId: integer
(int64)
The unique identifier of the revenue line.
-
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity PeriodsMaximum Length:30Revenue Period -
SentDate: string
(date)
Title:
Sent DateThe 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 IDSummarized Bill Line ID -
TransactionAmount: number
Title:
Invoice AmountThe amount for which the transaction occurred. -
TransactionClass: string
Title:
Transaction ClassMaximum Length:30The class of the transaction. -
TransactionClassMeaning: string
Title:
ClassThe meaning of transaction class lookup. -
TransactionDate: string
(date)
Title:
Invoice DateThe date when the transaction occurred. -
TransactionNumber: string
Title:
Invoice NumberMaximum Length:30The number of the transaction. -
TransactionTax: number
Title:
TaxThe tax levied on the transaction. -
TransactionTypeName: string
The transaction type name of the subscription bill line.
-
TruedUpYn: string
Maximum Length:
3Indicates if the bill line has a trueup period. -
TrxId: integer
(int64)
The AR transaction ID.
-
TrxLineId: integer
(int64)
The AR transaction line ID.
-
UsageAcquiredFlag: boolean
Maximum Length:
1Indicates whether the usage has been acquired or not. -
UsageCaptureDate: string
(date)
Title:
Usage Capture DateThe date when the usage was captured. -
UsageChargeType: string
Title:
Usage Charge TypeMaximum Length:30The type of usage charge. -
UsageChargeTypeName: string
Title:
Usage Charge TypeThe name of the usage charge type. -
UsageFlag: boolean
Maximum Length:
1Indicates whether the line is a usage line or not. -
UsageInvoiceAttachmentYn: string
Maximum Length:
1Indicates whether usage events invoice attachment is associated with the bill line. -
UsagePricedFlag: boolean
Maximum Length:
1Indicates whether the usage line has been priced or not. -
UsageQuantity: number
Title:
Usage QuantityThe quantity of the usage. -
UsageRatingProcess: string
Title:
Usage Rating ProcessMaximum Length:30Usage Rating Process
Nested Schema : Bill Adjustments
Type:
arrayTitle:
Bill AdjustmentsThe bill adjustments resource is used to view, create, update, and delete the subscription bill adjustment details, such as adjustment name, adjustment value, adjustment type, reason, and effectivity.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-billLines-billAdjustments-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Title:
BasisMaximum Length:30The basis on which the bill is adjusted. -
AdjustmentCategoryCode: string
Title:
Adjustment CategoryMaximum Length:30The code of the adjustment category. -
AdjustmentName: string
Title:
AdjustmentMaximum Length:120The name of the bill adjustment. -
AdjustmentReasonCode: string
Maximum Length:
30The code of the adjustment reason. -
AdjustmentStepSequenceNumber: number
Title:
Step Sequence NumberThe alternate unique identifier of the adjustment step sequence. -
AdjustmentType: string
Title:
TypeMaximum Length:30The type of the bill adjustment. -
AdjustmentValue: number
Title:
ValueThe value by which the bill is adjusted. -
AutoAdjustmentFlag: boolean
Maximum Length:
3Indicates whether the adjustment is automatic or not. -
BasisEnableFlag: boolean
Indicates if the base has been enabled for the bill adjustment.
-
BillAdjustmentId: integer
(int64)
The unique identifier of the bill adjustment.
-
BillAdjustmentPuid: string
Maximum Length:
120The public unique identifier of the bill adjustment. -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Title:
Charge Adjustment PUIDMaximum Length:120Charge Adjustment Puid -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the bill adjustment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the bill adjustment was created. -
CurrencyCode: string
The current code used for the bill adjustment.
-
Effectivity: string
Maximum Length:
30The effectivity of the bill adjustment. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the bill adjustment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the bill adjustment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the bill adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
PeriodFrom: number
The period from which the bill was adjusted.
-
PeriodUntil: number
The period until which the bill is adjusted.
-
PERPeriodFlag: boolean
Title:
Per periodMaximum Length:1Indicates whether the adjustment is per charge period. -
PERQuantityFlag: boolean
Title:
Per quantityMaximum Length:1Indicates whether the adjustment is per sub quantity. -
Reason: string
Title:
Reason DetailsMaximum Length:120The reason why the bill is adjusted. -
RevenueAdjustmentFromDate: string
(date)
Title:
Revenue Effective Start DateRevenue Adjustment From Date -
RevenueAdjustmentToDate: string
(date)
Title:
Revenue Effective End DateRevenue Adjustment To Date -
RevenueOption: string
Title:
Revenue Accounting OptionMaximum Length:30Revenue Option -
RevenuePeriod: string
Title:
Revenue Effectivity PeriodsMaximum Length:30Revenue Period -
SequenceNumber: number
Title:
SequenceThe sequence number of the bill adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-item-response
Type:
Show Source
object-
adjustments: array
Adjustments
Title:
AdjustmentsThe adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity. -
AggregationMethod: string
Title:
Aggregation MethodMaximum Length:30The aggregation method used for the charges. -
Allowance: number
Title:
AllowanceThe allowance part of the charge. -
AssetMeterYn: boolean
Title:
Asset Meter FlagMaximum Length:1The flag whether it is an asset meter or not. -
BatchTag: string
Title:
Batch TagMaximum Length:30Batch Tag -
BillingFreq: string
Title:
Billing FrequencyMaximum Length:30Billing Frequency -
BillingFreqName: string
Title:
Billing FrequencyMaximum Length:255Billing Frequency Name -
BillLineId: integer
(int64)
The unique identifier of the bill line.
-
BlockSize: number
Title:
Block SizeThe block size of the charge. -
chargeComponents: array
Subcription Product Charge Components Records
Title:
Subcription Product Charge Components RecordsThe subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products. -
ChargeDefinition: string
Title:
Charge NameMaximum Length:30The definition that indicates the purpose of the charge. -
ChargeDefinitionName: string
Title:
Charge DefinitionThe name of the charge definition. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
chargeMilestoneEvents: array
Charge Milestone Events
Title:
Charge Milestone EventsThe 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 NameMaximum Length:120The name of the charge. -
ChargePeriodCode: string
Title:
Charge Period CodeMaximum Length:30The code of the charge period associated with the charge. -
ChargePuid: string
Title:
Charge PUIDMaximum Length:120The public unique identifier of the charge. -
chargeTiers: array
Charge Tiers
Title:
Charge TiersThe charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price. -
CoveredLevelId: integer
(int64)
Title:
Covered Level IDThe unique identifier of the covered level. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the charge. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the charge was created. -
EnableProration: string
Title:
Enable ProrationMaximum Length:1Indicates whether proration is enabled or not. -
EstimatedAmount: number
Title:
Estimated AmountThe estimated amount of the charges. -
EstimatedMethodName: string
Title:
Estimation MethodThe method used to estimate the amount. -
EstimatedQuantity: number
Title:
Estimated QuantityThe estimated quantity for the charge. -
EstimationMethod: string
Title:
Estimation MethodMaximum Length:30The method used to estimate the amount. -
ExternalKey: string
Title:
External KeyMaximum Length:120The external key used to measure the charge. -
ExternalParentKey: string
Title:
External Parent KeyMaximum Length:120The external parent key. -
InitialMeterReadingId: integer
(int64)
Title:
Initial Meter Reading IDThe initial meter reading identifier value. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule IdThe ID of the invoice rule. -
InvoicingRuleName: string
Title:
Invoicing RuleThe name of the invoice rule. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the charge was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the charge. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the charge. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition IDThe unique identifier of the meter definition associated with the charges. -
MeterId: integer
(int64)
Title:
Meter IDThe unique identifier of the meter associated with the charges. -
MilestoneBillingFlag: boolean
Title:
Enable Milestone Based BillingIndicates whether the billing is impacted by milestone events or not. -
MilestoneRevenueFlag: boolean
Title:
Enable Milestone Based Revenue RecognitionIndicates whether the revenue is impacted by milestone events or not. -
MilestoneTemplateId: integer
(int64)
Title:
TemplateThe ID of the milestone event associated with a charge. -
MilestoneTemplateName: string
Maximum Length:
120The name of the milestone template associated with a charge. -
MinimumAmount: number
Title:
Minimum AmountThe minimum amount to be charged. -
MinimumQuantity: number
Title:
Minimum QuantityThe minimum quantity that is allowed. -
PeriodicBillingFlag: boolean
Title:
Enable Periodic BillingMaximum Length:1Indicates whether periodic billing is allowed or not. -
PeriodicRevenueFlag: boolean
Title:
Enable Periodic Revenue RecognitionMaximum Length:1Indicates the periodic revenue recognition of one-time charges. -
PrePaymentNumber: integer
(int64)
Title:
Prepayment NumberThe prepayment number for the charge. -
PricePeriodicity: string
Title:
PeriodicityMaximum Length:30The price periodicity for the charge. Indicates the frequency when the charge has to be applied. -
PricePeriodicityName: string
Title:
PeriodicityThe name of the price periodicity. -
PriceType: string
Title:
Price TypeMaximum Length:30The price type associated with the charge. -
QuotedTcv: number
Title:
Total Charge AmountThe quoted TCV of the charge. -
RecurringPricePeriodicityCode: string
Title:
Recurring Price Periodicity CodeMaximum Length:30The recurring price periodicity code of the charge. -
RollupFlag: boolean
Title:
Rollup FlagMaximum Length:1Indicates if the charge needs to be rolled up. -
SequenceNumber: integer
(int32)
Title:
Sequence NumberThe sequence number for the charge. -
SubscriptionId: integer
(int64)
Title:
Subscription IDThe unique identifier of the subscription. -
SubscriptionProductId: integer
(int64)
Title:
Subscription Product IDThe unique identifier of the subscription product. -
TieredFlag: boolean
Title:
TieredMaximum Length:3Indicates whether the charge has tiers. -
TieredPricingHeaderId: integer
Title:
Tiered Pricing Header IDTiered Pricing Header Id -
TierType: string
Title:
Tier TypeMaximum Length:30The type of the charge tier. -
TrueUpPeriod: string
Title:
True Up PeriodMaximum Length:30Default Value:ORA_OSS_USAGE_BILLING_PERIODThe identifier of the trueup period. -
TrueUpPeriodName: string
Title:
True Up PeriodThe name of the trueup period. -
UnitListPrice: number
Title:
List PriceThe price of the unit list. -
UsagePriceLockFlag: boolean
Title:
Usage Price LockMaximum Length:3Indicates whether the usage price is locked or not. -
UsageUnitOfMeasure: string
Title:
Usage UOMMaximum Length:3The usage unit of measure of the charge.
Nested Schema : Adjustments
Type:
arrayTitle:
AdjustmentsThe adjustments resource is used to view, create, update, and delete the subscription charge adjustment details, such as adjustment name, adjustment type, adjustment value, adjustment reason, and effectivity.
Show Source
Nested Schema : Subcription Product Charge Components Records
Type:
arrayTitle:
Subcription Product Charge Components RecordsThe subscription product charge components records resoure is used to view the price details of the individual charge components of subscription products.
Show Source
Nested Schema : Charge Milestone Events
Type:
arrayTitle:
Charge Milestone EventsThe 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:
arrayTitle:
Charge TiersThe charge tiers resource is used to view, create, update, and delete the subscription charge tier details, such as tier from, tier to, and list price.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-adjustments-item-response
Type:
Show Source
object-
AdjustmentBasis: string
Title:
BasisMaximum Length:30The basis of the adjustment. -
AdjustmentCategoryCode: string
Title:
Category CodeMaximum Length:30The code of the adjustment category. -
AdjustmentName: string
Title:
AdjustmentMaximum Length:120The name of the adjustment. -
AdjustmentReasonCode: string
Title:
ReasonMaximum Length:30The code of the adjustment reason. -
AdjustmentReasonMeaning: string
Title:
ReasonThe translated adjustment reason. -
AdjustmentStepSequenceNumber: number
Title:
Step Sequence NumberThe alternate unique identifier of the adjustment step sequence. -
AdjustmentType: string
Title:
TypeMaximum Length:30The type of the adjustment. -
AdjustmentValue: number
Title:
ValueThe value of the adjustment. -
AutoAdjustmentFlag: boolean
Maximum Length:
3Indicates whether the adjustment is automatic or not. -
ChargeAdjustmentId: integer
(int64)
The unique identifier of the charge adjustment.
-
ChargeAdjustmentPuid: string
Maximum Length:
120The public unique identifier of the charge adjustment. -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the adjustment. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the adjustment was created. -
Effectivity: string
Title:
EffectivityMaximum Length:30The adjustment effectivity -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the adjustment was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the adjustment. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the adjustment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NumberOfPeriods: number
The number of periods
-
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PeriodFrom: number
The period from which the adjustment was initiated.
-
PeriodUntil: number
The period until which the adjustment is initiated.
-
Reason: string
Title:
Reason DescriptionMaximum Length:120The reason for the adjustment. -
SequenceNumber: integer
(int32)
Title:
SequenceThe sequence number of the adjustment. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
ValidFrom: string
(date-time)
Valid From
-
ValidUntil: string
(date-time)
Valid Until
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-chargeComponents-item-response
Type:
Show Source
object-
ChargeComponentId: integer
(int64)
The identifier of the charge component.
-
ChargeComponentPuid: string
Maximum Length:
120The PUID of the charge component. -
ChargeCurrency: string
Title:
CurrencyMaximum Length:15The charge currency of the charge component. -
ChargeCurrencyExtAmount: number
Title:
Extended AmountThe extended amount of the charge component in charge currency. -
ChargeCurrencyName: string
Title:
CurrencyRead Only:trueMaximum Length:80The name of the charge currency. -
ChargeCurrencyUnitPrice: number
Title:
Currency Unit PriceThe unit price of the charge component in charge currency. -
ChargeId: integer
(int64)
Title:
Charge IDThe identifier of the charge. -
CoverageExtendedAmount: number
Title:
Coverage Extended AmountThe extended coverage amount of the charge component. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
Explanation: string
Title:
ExplanationMaximum Length:1000The explanation for the charge component. -
ExplanationMessageName: string
Title:
Explanation MessageMaximum Length:30The explanation message name of the charge component. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the subscription. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number of the charge component.
-
Price: number
Title:
AmountThe price of the charge component. -
PriceElement: string
Title:
Price ElementMaximum Length:30The price element of the charge component. -
PriceElementName: string
Title:
Price ElementRead Only:trueMaximum Length:80The name of the price element associated with the charge component. -
PriceElementUsage: string
Title:
Price Element UsageMaximum Length:30The price element usage of the charge component. -
PriceElementUsageName: string
Title:
Price Element UsageRead Only:trueMaximum Length:80The name of the price element usage associated with the charge component. -
PriceforQuantity: number
Title:
PriceThe price for quantity of the charge component. -
PricingSourceId: integer
(int64)
The identifier of the pricing source of the charge component.
-
PricingSourceType: string
Title:
Pricing Source TypeMaximum Length:30The type of pricing source of the charge component. -
PricingSourceTypeName: string
Title:
Pricing Source TypeRead Only:trueMaximum Length:80The name of the pricing source type. -
RollupFlag: boolean
Title:
Rollup FlagMaximum Length:1The indicator of whether charge component should be rolled up or not. -
SequenceNumber: integer
(int32)
Title:
Sequence NumberThe sequence number of the charge component. -
SubscriptionCurrency: string
Title:
Subscription CurrencyMaximum Length:15The subscription currency of the charge component. -
SubscriptionCurrencyName: string
Title:
Subscription CurrencyRead Only:trueMaximum Length:80The name of the subscription currency. -
SubscriptionId: integer
(int64)
Title:
Subscription IDThe identifier of the subscription. -
TaxIncludedFlag: boolean
Title:
Tax Included FlagMaximum Length:1The indicator of whether tax is included for the charge component or not. -
UnitPrice: number
Title:
Unit PriceThe unit price of the charge component.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-chargeMilestoneEvents-item-response
Type:
Show Source
object-
BillingOffset: number
The billing offset associated with a milestone event.
-
BillLineId: integer
(int64)
The bill line ID associated with the milestone event.
-
BillLinePuid: string
Title:
Bill Line PUIDMaximum Length:120Bill Line Puid -
ChargeId: integer
(int64)
The charge ID with which the milestone event is associated.
-
ChargePuid: string
Maximum Length:
120Default Value:Charges.ChargePuidThe 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:
trueMaximum Length:64The login of the user who created the milestone event. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which the milestone event was created. -
EventId: integer
(int64)
The ID of the milestone event.
-
EventSource: string
Maximum Length:
30The source of the milestone event. -
EventSourceReference: string
Maximum Length:
120The source reference of the milestone event. -
EventType: string
Maximum Length:
30The type of the milestone event. -
ExpectedCompletionDate: string
(date)
The expected completion date of a milestone event.
-
InterfacedFlag: boolean
Title:
InterfacedMaximum Length:1Default Value:falseIndicates whether the milestone event is interfaced or not. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date of which the milestone event was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who updated the milestone event the last. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login which updated the milestone event the last. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MilestoneComment: string
Maximum Length:
300The milestone event comment. -
MilestoneName: string
Maximum Length:
30The name of the milestone event. -
MilestonePuid: string
Maximum Length:
120The 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-charges-chargeTiers-item-response
Type:
Show Source
object-
AdditionalNumberFive: number
Title:
Additional Number FiveAdditional number, if any, for the charge tier. -
AdditionalNumberFour: number
Title:
Additional Number FourAdditional number, if any, for the charge tier. -
AdditionalNumberOne: number
Title:
Additional Number OneAdditional number, if any, for the charge tier. -
AdditionalNumberSix: number
Title:
Additional Number SixAdditional number, if any, for the charge tier. -
AdditionalNumberThree: number
Title:
Additional Number ThreeAdditional number, if any, for the charge tier. -
AdditionalNumberTwo: number
Title:
Additional Number TwoAdditional number, if any, for the charge tier. -
AdditionalTextOne: string
Title:
Additional Text OneMaximum Length:4000Additional text, if any, for the charge tier. -
AdditionalTextTwo: string
Title:
Additional Text TwoMaximum Length:4000Additional text, if any, for the charge tier. -
AdditionalTimestampOne: string
(date-time)
Title:
Additional Time-stamp OneAdditional timestamp, if any, for the charge tier. -
AdditionalTimestampThree: string
(date-time)
Title:
Additional Time-stamp ThreeAdditional timestamp, if any, for the charge tier. -
AdditionalTimestampTwo: string
(date-time)
Title:
Additional Time-stamp TwoAdditional timestamp, if any, for the charge tier. -
AddtionalTextThree: string
Title:
Additional Text ThreeMaximum Length:4000Additional text, if any, for the charge tier. -
BlockSize: number
Title:
Block SizeThe block size -
ChargeId: integer
(int64)
The unique identifier of the charge.
-
ChargeTierId: integer
(int64)
The unique identifier of the charge tier.
-
ChargeTierPuid: string
Maximum Length:
120The public unique identifier of the charge tier. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the charge tier. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the charge tier was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the charge tier was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the charge tier. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the charge tier. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ListPrice: number
Title:
List PriceThe list price -
PriceFormat: string
Title:
Price FormatMaximum Length:30The display format of the price. -
SequenceNumber: number
The sequence number
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
-
TierFrom: number
Title:
Tier FromThe tier from -
TierTo: number
Title:
Tier ToThe tier to
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-productAssetRelationships-item-response
Type:
Show Source
object-
AmendmentReason: string
Title:
Amendment ReasonRead Only:trueMaximum Length:4000The amendment reason of the product asset relationship. -
AmendmentReasonCode: string
Read Only:
trueMaximum Length:30The amendment reason code of the product asset relationship. -
AssociationNumber: string
Title:
Related Covered LevelRead Only:trueMaximum Length:300The association number of the source subscription. -
AssociationPuid: string
Read Only:
trueMaximum Length:120The association PUID of the source subscription. -
EffectiveDate: string
(date)
Title:
Effective DateRead Only:trueThe effective date of the relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProductAssociationId: integer
(int64)
Read Only:
trueThe product association ID of the source subscription. -
ProductId: integer
(int64)
Read Only:
trueThe source product ID of the product asset relationship. -
ProductPuid: string
Read Only:
trueMaximum Length:120The source product PUID of the product asset relationship. -
RelatedLineName: string
Title:
Related LineRead Only:trueMaximum Length:300The name of the related product asset. -
RelatedLineNumber: string
Read Only:
trueMaximum Length:300The number of the related product asset. -
RelatedLinePuid: string
Read Only:
trueMaximum Length:120The PUID of the related product asset. -
RelatedLineStatus: string
Title:
Related Line StatusRead Only:trueMaximum Length:4000The status of the related product asset. -
RelatedLineStatusCode: string
Read Only:
trueMaximum Length:30The status code of the related product asset. -
RelatedLineSubscriptionId: integer
(int64)
Read Only:
trueThe subscription ID of the related product asset. -
RelatedProdAssId: integer
(int64)
Read Only:
trueThe related product association ID of the product asset relationship. -
RelatedSubscriptionNumber: string
Title:
Related Subscription NumberRead Only:trueMaximum Length:120The subscription number of the related product asset. -
Relationship: string
Title:
RelationshipRead Only:trueMaximum Length:4000The relationship of the product asset relationship. -
RelationshipCode: string
Read Only:
trueMaximum Length:16The relationship code of the product asset relationship. -
SubscriptionId: integer
(int64)
Read Only:
trueThe source subscription ID of the product asset relationship. -
SubscriptionProductId: integer
(int64)
Read Only:
trueThe subscription product ID of the source subscription.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-coveredLevels-relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the relationship. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the relationship was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the relationship was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the relationship. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
OperationLinksPuid: string
Title:
Operation Links PUIDMaximum Length:120The public unique identifier of the operation links. -
RelationshipTypeCode: string
Title:
TypeMaximum Length:30The code indicating the type of the relationship. -
SourceAssetKey: string
Title:
Source Asset KeyMaximum Length:120The source asset key -
SourceProdAssociationId: integer
(int64)
Title:
Source Product Association IDThe unique identifier of the source product association. -
SourceProdAssociationPuid: string
Title:
Source Product Association PUIDMaximum Length:120The public unique identifier of the source product association. -
SourceProductPuid: string
Title:
Source Product PUIDMaximum Length:120The public unique identifier of the source product. -
SourceRootAssetKey: string
Title:
Source Root Asset KeyMaximum Length:120The source root asset key -
TargetProdAssociationId: integer
(int64)
Title:
Target Product Association IDThe unique identifier of the target product association. -
TargetProdAssociationPuid: string
Title:
Target Product Association PUIDMaximum Length:120The public unique identifier of the target product association. -
TargetProductPuid: string
Title:
Target Product PUIDMaximum Length:120The public unique identifier of the target product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-creditCards-item-response
Type:
Show Source
object-
AddressLine1: string
Read Only:
trueMaximum Length:255The address line 1 of the billing address. -
AddressLine2: string
Read Only:
trueMaximum Length:255The 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:
trueThe ID of the card billing address. -
CardHolderName: string
Title:
Cardholder NameThe name of the credit card holder. -
CardIssuerName: string
Read Only:
trueMaximum Length:255The name of the card issuer. -
City: string
Read Only:
trueMaximum Length:255The city of the billing address. -
Country: string
Read Only:
trueMaximum Length:255The country of the billing address. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the credit card. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the credit card was created. -
CreditCardId: integer
(int64)
The unique identifier of the credit card.
-
CreditCardPuid: string
Maximum Length:
120The public unique identifier of the credit card. -
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:
NumberThe instrument assignment ID associated with the credit card. -
IssuerCode: string
The credit card issuing company.
-
LastName: string
The last name of the credit card holder.
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the credit card was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the credit card. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the credit card. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaskedNumber: string
The masked credit card number.
-
Notes: string
Title:
NotesMaximum Length:300The notes, if any, associated with the credit card. -
PaymentSystemOrderNumber: string
The order number for the credit card payment.
-
PostalCode: string
Read Only:
trueMaximum Length:255The postal code of the billing address. -
RenewalCreditCardFlag: boolean
Maximum Length:
1Indicates whether the credit card is used as Renewal Payment Method. -
State: string
Read Only:
trueMaximum Length:255The state of the billing address. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The public unique identifier of the subscription product.
-
TokenNumber: string
The credit card token number used for processing.
-
TrxnExtensionId: integer
(int64)
Transaction Extension Id
-
VoiceAuthCode: string
The credit card voice authorization information.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-flexFields-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30The structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentThe display name for structure definition of the user descriptive flexfield. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedEntitlementPlanCommitments-item-response
Type:
Show Source
object-
Amount: number
Title:
AmountThe amount under subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance CodeMaximum Length:30The balance code of subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
Title:
Balance CodeThe unique identifier of balance code under subscription entitlement plan commitments. -
BalanceCodeMaxPrecision: integer
(int32)
Title:
Maximum PrecisionRead Only:trueThe maximum precision of balance code of the commitment rating model setup for the product. -
BalanceCodeType: string
Title:
Balance Code TypeMaximum Length:30The balance code type of the commitment rating model setup for the product. -
BalanceProfileId: integer
(int64)
Read Only:
trueThe unique identifier of the balance profile of the commitment rating model setup for the product. -
ChargeDefinitionCode: string
Maximum Length:
30The 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:
trueMaximum Length:64The user who created the subscription entitlement plan commitments. -
CreationDate: string
(date-time)
Read Only:
trueThe date of creation of the subscription entitlement plan commitments. -
CurrencyCode: string
Title:
Currency CodeMaximum Length:15The 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:
120The unique number of subscription entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
ExtendedPrecision: integer
(int32)
Title:
Extended PrecisionRead Only:trueThe actual extended precision of amount type balance code of the commitment rating model setup for the product. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription entitlement plan commitments was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription entitlement plan commitments. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription entitlement plan commitments. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe version number of subscription entitlement plan commitments. -
Period: string
Title:
PeriodicityThe period under subscription entitlement plan commitments. -
Quantity: number
Title:
QuantityThe quantity under subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30The 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 PeriodicityThe related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded QuantityThe rounded quantity under subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOMMaximum Length:3The unit of measure of allowance under subscription entitlement plan commitments.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedEntitlementPlanDetails-item-response
Type:
Show Source
object-
AllowancePeriodicity: string
Title:
PeriodicityMaximum Length:30The periodicity factor of allowance under subscription entitlement plan details. -
AllowanceQuantity: number
Title:
QuantityThe allowance quantity under subscription entitlement plan details. -
AllowanceRolloverPeriod: integer
Title:
Rollover PeriodThe allowance rollover period under subscription entitlement plan details. -
AllowanceRolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOMMaximum Length:3The unit of measure of allowance rollover under subscription entitlement plan details. -
AllowanceUnitOfMeasure: string
Title:
UOMMaximum Length:3The unit of measure of allowance specified for a negotiated entitlement plan. -
AllowanceValidityPeriod: integer
Title:
Validity PeriodThe allowance validity period under subscription entitlement plan details. -
AllowanceValidityPeriodUnitOfMeasure: string
Title:
Validity Period UOMMaximum Length:3The unit of measure of allowance validity under subscription entitlement plan details. -
Amount: number
Title:
AmountThe amount negotiated for an entitlement plan. -
BalanceCode: string
Title:
Balance CodeMaximum Length:30The balance code of subscription entitlement plan details. -
BalanceCodeDescription: string
Title:
NameRead Only:trueMaximum Length:120The description of balance code under subscription entitlement plan details. -
BalanceCodeId: integer
(int64)
Title:
Balance CodeThe unique identifier of balance code under subscription entitlement plan details. -
BalanceCodeMaxPrecision: integer
(int32)
Title:
Maximum PrecisionRead Only:trueThe maximum precision of balance code of the allowance rating model setup for the product. -
BalanceCodeType: string
Title:
Balance Code TypeMaximum Length:30The balance code type of the allowance rating model setup for the product. -
BalanceProfileId: integer
(int64)
Read Only:
trueThe unique identifier of the balance profile of the allowance rating model setup for the product. -
ChargeDefinitionCode: string
Maximum Length:
30The unique identifier for charge definition under subscription entitlement plan details. -
ChargeDefinitionId: integer
(int64)
The charge definition code under subscription entitlement plan details.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription entitlement plan details. -
CreationDate: string
(date-time)
Read Only:
trueThe date of creation of the subscription entitlement plan details. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The 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:
120The alternate unique number of subscription entitlement plan details. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
ExtendedPrecision: integer
(int32)
Title:
Extended PrecisionRead Only:trueThe actual extended precision of amount type balance code of the allowance rating model setup for the product. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription entitlement plan details was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription entitlement plan details. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription entitlement plan details. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement plan details.
-
PrecisionFactor: number
Title:
Rounding FactorRead Only:trueThe precision factor of subscription entitlement plan details. -
PrecisionType: string
Title:
Rounding TypeRead Only:trueMaximum Length:30The precision type of subscription entitlement plan details. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan details.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedEntitlementPlanEstimates-item-response
Type:
Show Source
object-
Amount: number
Title:
AmountThe amount under subscription entitlement plan estimates. -
BalanceCode: string
Title:
Balance CodeMaximum Length:30The balance code of subscription entitlement plan estimates. -
BalanceCodeId: integer
(int64)
Title:
Balance CodeThe unique identifier of balance code under subscription entitlement plan estimates. -
BalanceCodeMaxPrecision: integer
(int32)
Title:
Maximum PrecisionRead Only:trueThe maximum precision of balance code of the estimate rating model setup for the product. -
BalanceCodeType: string
Title:
Balance Code TypeMaximum Length:30The balance code type of the estimate rating model setup for the product. -
BalanceProfileId: integer
(int64)
Read Only:
trueThe unique identifier of the balance profile of the estimate rating model setup for the product. -
ChargeDefinitionCode: string
Maximum Length:
30The 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 PeriodThe estimate period of the subscription entitlement plan estimates. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription entitlement plan estimates. -
CreationDate: string
(date-time)
Read Only:
trueThe date of creation of the subscription entitlement plan estimates. -
CurrencyCode: string
Title:
Currency CodeMaximum Length:15The currency code of amount type balance code under subscription entitlement plan estimates. -
EnableRolloverFlag: boolean
Title:
Enable rolloverMaximum Length:1Default Value:falseIndicates where the rollover is enabled for the subscription entitlement plan estimate. -
EntitlementPlanEstimateId: integer
(int64)
The unique identifier of subscription entitlement plan estimates.
-
EntitlementPlanEstimateNumber: string
Maximum Length:
120The alternate unique number of subscription entitlement plan estimates. -
EntitlementPlanId: integer
(int64)
The unique identifier of subscription entitlement plan.
-
ExtendedPrecision: integer
(int32)
Title:
Extended PrecisionRead Only:trueThe actual extended precision of amount type balance code of the estimate rating model setup for the product. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription entitlement plan estimates was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription entitlement plan estimates. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription entitlement plan estimates. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe version number of subscription entitlement plan estimates. -
Period: string
Title:
PeriodicityThe period under subscription entitlement plan estimates. -
Quantity: number
Title:
QuantityThe quantity under subscription entitlement plan estimates. -
RelatedChargeDefinitionCode: string
Title:
Related ChargeMaximum Length:30The 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 PeriodicityThe related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RolloverPeriod: integer
Title:
Rollover PeriodThe rollover period of the subscription entitlement plan estimate. -
RolloverPeriodUnitOfMeasure: string
Title:
Rollover Period UOMMaximum Length:3The rollover period unit of measure of the subscription entitlement plan estimate. -
RoundedQuantity: number
Title:
Rounded QuantityThe rounded quantity under subscription entitlement plan estimates. -
SubscriptionProductId: integer
(int64)
The subscription product identifier of subscription entitlement plan estimates.
-
TrueupOverageFlag: boolean
Title:
True-up overageMaximum Length:1Default Value:trueIndicates whether the flag of the subscription entitlement plan estimates is overage shortage. -
TrueupShortageFlag: boolean
Title:
True-up shortageMaximum Length:1Default Value:trueIndicates whether the flag of the subscription entitlement plan estimates is trueup shortage. -
UnitOfMeasure: string
Title:
UOMMaximum Length:3The unit of measure under subscription entitlement plan estimates.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-negotiatedVolumePricingRules-item-response
Type:
Show Source
object-
AggregationBalanceCode: string
Title:
Aggregation Balance CodeMaximum Length:30The balance code which is eligible for aggregation rating. -
AggregationBalanceCodeId: integer
(int64)
Title:
Aggregation Balance Code IDThe unique identifier of the balance code which is eligible for aggregation rating. -
AggregationPeriod: string
Title:
Aggregation PeriodMaximum Length:30The charge period of balance code for volume rating. -
BalanceCode: string
Title:
Balance CodeMaximum Length:30The unique identifier of the balance code which is eligible for volume rating. -
BalanceCodeId: integer
(int64)
The balance code which is eligible for volume rating.
-
BalanceCodeUnitOfMeasure: string
Title:
UOMMaximum Length:3The unit of measure of balance code for volume rating -
BalanceProfileId: integer
(int64)
Title:
Balance Profile IDThe unique identifier of the subscription balance profile. -
ChargeDefinitionCode: string
Maximum Length:
30The charge definition code of the entitlement plan detail charge definition. -
ChargeDefinitionId: integer
(int64)
Title:
Charge Definition IDThe unique identifier of charge definition of the subscription entitlement plan commitments. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the subscription entitlement plan commitments. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date of creation of the subscription entitlement plan commitments. -
EligibilityBalanceCodeId: integer
(int64)
Title:
Eligible Balance Code IDThe unique identifier of the balance code which is eligible for volume rating. -
EntitlementPlanChargeRuleId: integer
(int64)
Title:
Profile Charge Rule IDThe unique identifier of the subscription entitlement plan charge rule. -
EntitlementPlanChargeRuleNumber: string
Title:
Charge Rule NumberMaximum Length:120The unique number of the subscription entitlement plan charge rule. -
EntitlementPlanId: integer
(int64)
Title:
Entitlement Plan IDThe unique identifier of entitlement plan of the subscription entitlement plan. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the subscription entitlement plan commitments was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the subscription entitlement plan commitments. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version NumberThe version number of the subscription entitlement plan commitments. -
PricingBalanceCode: string
Title:
Pricing Balance CodeMaximum Length:30The balance code which is eligible for volume rating. -
ProductEntitlementPlanId: integer
(int64)
Title:
Product Entitlement Plan IDThe unique identifier of entitlement plan product of the subscription entitlement plan. -
SubscriptionProductId: integer
(int64)
Title:
Subscription Product IDThe unique identifier of subscription product. -
VolumePricingAggregationFlag: boolean
Title:
Eligible for aggregationMaximum Length:1Indicates whether the balance code is enabled for aggregation of volume pricing. -
VolumePricingEligibilityFlag: boolean
Title:
Eligible for volume pricingMaximum Length:1Indicates whether the balance code is eligibile for volume pricing.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-productRelationships-item-response
Type:
Show Source
object-
AmendmentReason: string
Title:
Amendment ReasonRead Only:trueMaximum Length:30The amendment reason of the product relationship. -
AmendmentReasonCode: string
Read Only:
trueMaximum Length:30The amendment reason code of the product relationship. -
EffectiveDate: string
(date)
Title:
Effective DateRead Only:trueThe effective date of the product relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ProductId: integer
(int64)
Read Only:
trueThe source product ID of the product relationship. -
ProductPuid: string
Read Only:
trueMaximum Length:120The source product PUID of the product relationship. -
RelatedLineName: string
Title:
Related LineRead Only:trueMaximum Length:300The name of the related product. -
RelatedLineNumber: string
Read Only:
trueMaximum Length:300The number of the related product. -
RelatedLinePuid: string
Title:
Related LineRead Only:trueMaximum Length:120The PUID of the related product. -
RelatedLineStatus: string
Title:
Related Line StatusRead Only:trueMaximum Length:4000The status of the related product. -
RelatedLineStatusCode: string
Read Only:
trueMaximum Length:30The status code of the related product. -
RelatedLineSubscriptionId: integer
(int64)
Read Only:
trueThe subscription ID of the related product. -
RelatedSubscriptionNumber: string
Title:
Related SubscriptionRead Only:trueMaximum Length:120The subscription number of the related product. -
Relationship: string
Title:
RelationshipRead Only:trueMaximum Length:4000The relationship of the product relationship. -
RelationshipCode: string
Read Only:
trueMaximum Length:255The relationship code of the product relationship. -
SubscriptionId: integer
(int64)
Read Only:
trueThe source subscription ID of the product relationship. -
SubscriptionProductId: integer
(int64)
Read Only:
trueThe subscription product ID of the source subscription.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the relationship. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the relationship was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the relationship was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the relationship. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the relationship. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
OperationLinksPuid: string
Title:
Operation Links PUIDMaximum Length:120The public unique identifier of the operation links. -
RelationshipTypeCode: string
Title:
TypeMaximum Length:30The code indicating the type of the relationship. -
SourceAssetKey: string
Title:
Source Asset KeyMaximum Length:120The source asset key -
SourceProdAssociationId: integer
(int64)
Title:
Source Product Association IDThe unique identifier of the source product association. -
SourceProdAssociationPuid: string
Title:
Source Product Association PUIDMaximum Length:120The public unique identifier of the source product association. -
SourceProductPuid: string
Title:
Source Product PUIDMaximum Length:120The public unique identifier of the source product. -
SourceRootAssetKey: string
Title:
Source Root Asset KeyMaximum Length:120The source root asset key -
TargetProdAssociationId: integer
(int64)
Title:
Target Product Association IDThe unique identifier of the target product association. -
TargetProdAssociationPuid: string
Title:
Target Product Association PUIDMaximum Length:120The public unique identifier of the target product association. -
TargetProductPuid: string
Title:
Target Product PUIDMaximum Length:120The public unique identifier of the target product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-salesCredits-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the sales credit. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the sales credit was created. -
EndDate: string
(date)
Title:
End DateThe date when the sales credit was ends. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the sales credit was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the sales credit. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login details of the user who last updated the sales credit. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Percentage: number
Title:
PercentThe percentage -
QuotaFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the quota has been fulfilled. -
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Title:
NumberMaximum Length:120The public unique identifier of the sales credit. -
SalesCreditType: string
The type of the sales credit.
-
SalesCreditTypeId: integer
(int64)
Title:
Credit TypeThe unique identifier of the type of the sales credit. -
SalesPerson: string
The name of the sales person.
-
SalesPersonNumber: string
Title:
Salesperson NumberThe alternate identifier of a salesperson. -
SalesrepId: integer
(int64)
Title:
SalespersonThe unique identifier of the sales representative. -
StartDate: string
(date)
Title:
Start DateThe date when the sales credit started. -
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
Title:
Subscription Product IDThe unique identifier of the subscription product.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-serviceResources-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the service resource. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which the service resource was created. -
EnabledFlag: boolean
Title:
Enable Service ResourceMaximum Length:1Default Value:trueIndicates whether the service resource is enabled or not. -
EndDate: string
(date)
Title:
End DateThe end date of the service resource. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the service resource was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the service resource. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the service resource. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ServiceId: string
Title:
Service IdentifierMaximum Length:120The unique identifier of the service. -
ServiceResourceId: integer
(int64)
The unique identifier of the service resource.
-
ServiceResourcePuid: string
Title:
Service IdentifierMaximum Length:120The PUID of the service resource. -
StartDate: string
(date)
Title:
Start DateThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentThe JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message seeking confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type used when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256The display label of the subscription smart actions. -
Entity: string
Title:
Parent EntityMaximum Length:150The entity of the subscription smart actions. -
Href: string
Title:
REST EndpointMaximum Length:1024The HREF of the subscription smart actions. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512The included in application flag of the subscription smart actions. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1The mass action flag of the smart action. -
Method: string
Title:
HTTP MethodMaximum Length:15The method associated with the subscription smart actions. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function name of the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The page type of the smart action. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1The smart suggest flag of the smart action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1The flag indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512The update of attributes flag of the subscription smart actions. -
UserActionId: integer
(int64)
Title:
User Action IDThe unique identifier of the subscription user actions. -
UserActionName: string
Title:
Action NameMaximum Length:256The name of the subscription user actions. - UserActionNavigation: array User Action Request Payload
-
UserActionRank: integer
(int64)
Title:
PriorityThe user rank action of the smart action. -
UserActionRequestPayload: array
User Action URL Binding
Title:
User Action URL BindingThe user action request payload resource stores the payload information for every user action request. -
UserActionURLBinding: array
User Action Navigation
Title:
User Action NavigationThe user action URL binding resource stores the binding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : User Action URL Binding
Type:
arrayTitle:
User Action URL BindingThe user action request payload resource stores the payload information for every user action request.
Show Source
Nested Schema : User Action Navigation
Type:
arrayTitle:
User Action NavigationThe user action URL binding resource stores the binding metadata for a variable in the URL.
Show Source
Nested Schema : subscriptionProducts-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64The binding of the user action payload. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1The mandatory flag of the user action payload. -
RequestPayloadId: integer
(int64)
The request payload ID of the user action.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The request payload name of the user action. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The smart suggest path of the user action payload. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseThe system action flag of the user action request payload. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value of the user action payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20The value structure of the user action payload.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionProducts-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64The URL binding of user action. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseThe system action flag of the user action URL binding. -
URLBindingId: integer
(int64)
The identifier of URL binding of user action.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256The name of URL binding of user action. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000The value of URL binding of user action.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all subscription products by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"items": [
{
"SubscriptionProductId": 300100182015426,
"SubscriptionId": 300100181994494,
"LineNumber": "4",
"SubscriptionProductPuid": "CDRM_4016-PRDT-2017",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "CDRM_4016",
"SalesProductType": "SUBSCRIPTION",
"Description": "QP Item for SPT Subscription",
"InventoryItemId": 300100012368232,
"ItemUnitOfMeasure": "Ea",
"ProductName": "QP_Item3",
"Quantity": 1,
"StartDate": "2019-05-30",
"EndDate": null,
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -3,
"InvoicingRuleName": "Arrears Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038414,
"AccountingRuleName": "3 Months",
"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
"BillToAccountId": 300100006084313,
"BillToAccountNumber": "300100006084312",
"BillToAccountDescription": "FOS_Customer01",
"BillToSiteUseId": 300100006084331,
"BillToAddress": "151 N Street,CHICAGO, IL 60601",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 300100033038407,
"PaymentTermsName": "2 Net",
"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-05-31",
"PriceTransactionOn": "2019-05-31",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": null,
"Period": null,
"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-05-31T20:19:41+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-05-31T20:20:17.091+00:00",
"LastUpdateLogin": "8981B08476560847E0533EFDF40A8CB1",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
"links": ...
},
{
"SubscriptionProductId": 300100181994505,
"SubscriptionId": 300100181994494,
"LineNumber": "2",
"SubscriptionProductPuid": "CDRM_4016-PRDT-2013",
"DefinitionOrganizationId": 204,
"SubscriptionNumber": "CDRM_4016",
"SalesProductType": "COVERAGE",
"Description": "ZOSS_COVG_Item002-MONTH",
"InventoryItemId": 300100169590884,
"ItemUnitOfMeasure": "0zG",
"ProductName": "ZOSS_COVG_Item002",
"Quantity": 1,
"StartDate": "2019-05-30",
"EndDate": "2020-05-29",
"CloseReason": null,
"CloseCreditMethod": null,
"CancelReason": null,
"ClosedDate": null,
"CanceledDate": null,
"RenewedDate": null,
"PriceListId": null,
"UnitPrice": null,
"Status": "ORA_DRAFT",
"Currency": "USD",
"InvoicingRuleId": -3,
"InvoicingRuleName": "Arrears Invoice",
"BillOnDay": null,
"BillingOffsetDays": null,
"BillingFrequency": "0zG",
"BillingFrequencyName": "MONTH",
"AccountingRuleId": 300100033038414,
"AccountingRuleName": "3 Months",
"TransactionTypeName": "ORA_OSS_Invoice",
"InvoiceText": "[$Product Name]: [$Charge Name] [$Bill from Date]-[$Bill to Date]",
"BillToAccountId": 300100006084313,
"BillToAccountNumber": "300100006084312",
"BillToAccountDescription": "FOS_Customer01",
"BillToSiteUseId": 300100006084331,
"BillToAddress": "151 N Street,CHICAGO, IL 60601",
"ShipToPartyId": null,
"ShipToPartyName": null,
"ShipToPartySiteId": null,
"ShipToPartySiteName": null,
"PaymentMethod": null,
"PaymentMethodName": null,
"PONumber": null,
"WireNumber": null,
"PaymentTermsId": 300100033038407,
"PaymentTermsName": "2 Net",
"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-05-30",
"PriceTransactionOn": "2019-05-30",
"InvoicedAmount": null,
"CreditedAmount": null,
"CanceledAmount": null,
"ClosedAmount": null,
"SourceSystem": null,
"SourceKey": null,
"SourceNumber": null,
"SourceLineKey": null,
"SourceLineNumber": null,
"MonthlyRecurringRevenue": null,
"Duration": 1,
"Period": "0zE",
"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-05-30T22:58:27+00:00",
"LastUpdatedBy": "CONMGR",
"LastUpdateDate": "2019-05-30T22:58:46.148+00:00",
"LastUpdateLogin": "8981F1744B840850E0533EFDF40A2BF1",
"SummarizedBillingFlag": null,
"InterfaceOffsetDays": null,
"CoverageName": null,
"links":...
},
...