Get a subscription balance register
get
/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}
Request
Path Parameters
-
BalanceRegisterNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : subscriptionBalanceRegisters-item-response
Type:
Show Source
object
-
BalanceProfileName: string
Title:
Profile Name
Maximum Length:120
The balance profile name of the subscription balance registers. -
BalanceProfileNumber: string
Title:
Profile Number
Maximum Length:120
The balance profile number of the subscription balance registers. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance registers.
-
BalanceRegisterNumber: string
Title:
Number
Maximum Length:120
The balance register number of the subscription balance registers. -
BalanceRegisterStatus: string
Title:
Status
Maximum Length:30
The status of the subscription balance register. -
BillingDateCode: string
Title:
Billing Date
Read Only:true
Maximum Length:30
The billing date code of the subscription balance registers. -
BillingFrequency: string
Title:
Billing Frequency
Read Only:true
Maximum Length:30
The billing frequency of the subscription balance registers. -
BillingOffsetDays: integer
(int32)
Title:
Offset
Read Only:true
The billing offset day of the subscription balance registers. -
BillOnDay: integer
(int32)
Title:
Day
Read Only:true
The bill on day of the subscription balance registers. -
BillPeriodAlignDate: string
(date)
Title:
Align Billing From
The bill alignment date of the subscription balance registers. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance registers. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription balance registers. -
InterfaceOffsetDays: integer
(int32)
Title:
Billing Interface Offset Days
Read Only:true
The interface offset day of the subscription balance registers. -
InvoicingRuleId: integer
(int64)
Title:
Invoicing Rule
Read Only:true
The invoice rule identifier of the subscription balance registers. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance registers was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the subscription balance registers. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance registers. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number of the subscription balance registers.
-
profileCharges: array
Subscription Balance Profile Charges
Title:
Subscription Balance Profile Charges
The subscription balance profile charges resource is used to view a balance profile charges. -
registerAllowances: array
Subscription Balance Register Allowance Grants
Title:
Subscription Balance Register Allowance Grants
The subscription balance register allowance grants resource is used to view a balance register allowance grant. -
registerCommitments: array
Subscription Balance Register Commitments
Title:
Subscription Balance Register Commitments
The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled. -
registerCriteria: array
Subscription Balance Consumption Criteria
Title:
Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later. -
registerEstimates: array
Subscription Balance Register Estimates
Title:
Subscription Balance Register Estimates
The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled. -
registerPeriods: array
Subscription Balance Periods
Title:
Subscription Balance Periods
The subscription balance register periods resource is used to view a balance register period. -
RegisterUpdateFlag: boolean
Title:
Allow register update
Maximum Length:1
Default Value:false
Indicates whether the register is enabled for update.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Profile Charges
Type:
array
Title:
Subscription Balance Profile Charges
The subscription balance profile charges resource is used to view a balance profile charges.
Show Source
Nested Schema : Subscription Balance Register Allowance Grants
Type:
array
Title:
Subscription Balance Register Allowance Grants
The subscription balance register allowance grants resource is used to view a balance register allowance grant.
Show Source
Nested Schema : Subscription Balance Register Commitments
Type:
array
Title:
Subscription Balance Register Commitments
The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled.
Show Source
Nested Schema : Subscription Balance Consumption Criteria
Type:
array
Title:
Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : Subscription Balance Register Estimates
Type:
array
Title:
Subscription Balance Register Estimates
The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled.
Show Source
Nested Schema : Subscription Balance Periods
Type:
array
Title:
Subscription Balance Periods
The subscription balance register periods resource is used to view a balance register period.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionBalanceRegisters-profileCharges-item-response
Type:
Show Source
object
-
AllowanceGrantFlag: boolean
Title:
Enable allowance
Maximum Length:1
Default Value:false
Indicates whether the allowance grant is enabled for a balance register profile charge. -
BalanceProfileChargeId: integer
(int64)
The balance profile charge identifier of the subscription balance profile charges.
-
BalanceProfileChargeNumber: string
Title:
Profile Charge Number
Maximum Length:120
The balance profile charge number of the subscription balance profile charges. -
BalanceProfileId: integer
(int64)
The balance profile identifier of the subscription balance profile charges.
-
BillingFrequency: string
Maximum Length:
30
The billing frequency of the subscription balance profile charge. -
BillingFrequencyUnitOfMeasure: string
Title:
Billing Frequency
Maximum Length:25
The billing frequency unit of measure of the subscription balance profile charge. -
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription balance profile charges. -
ChargeDefinitionId: integer
(int64)
Title:
Charge Name
The balance charge definition identifier of the subscription balance profile charges. -
ChargePeriod: string
Title:
Periodicity
Maximum Length:30
The charge period of the subscription balance profile charges. -
ChargePeriodUnitOfMeasure: string
Title:
Periodicity
Maximum Length:25
The charge period unit of measure of the subscription balance profile charges. -
CommitmentFlag: boolean
Title:
Enable commitment
Maximum Length:1
Default Value:false
Indicates whether the commitment is enabled for a balance register profile charge. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance profile charges. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance profile charge was created. -
EstimateFlag: boolean
Title:
Enable estimate
Maximum Length:1
Default Value:false
Indicates whether the estimate is enabled for a balance register profile charge. -
InvoicingRule: string
Title:
Invoicing Rule
Maximum Length:30
The invoicing rule of the subscription balance profile charge. -
InvoicingRuleId: integer
(int64)
The invoicing rule identifier of the subscription balance profile charge.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription profile charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance criterion. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription profile charge. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription profile charge.
-
RelatedChargeDefinitionCode: string
Title:
Related Charge
Maximum Length:30
The charge definition code of the related profile charge. -
RelatedChargeDefinitionId: integer
(int64)
Title:
Related Charge
The charge definition identifier of the related profile charge. -
RelatedProfileChargeId: integer
(int64)
The balance profile charge identifier of the related charge identifier.
-
UsageCaptureFlag: boolean
Title:
Enable usage capture
Maximum Length:1
Default Value:false
Indicates whether the usage capture is enabled for a balance register profile charge.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerAllowances-item-response
Type:
Show Source
object
-
AllowanceGrantId: integer
(int64)
The balance register allowance grant identifier of the subscription balance register allowance grants.
-
AllowanceGrantNumber: string
Title:
Allowance Grant Number
Maximum Length:120
The balance register allowance grant number of the subscription balance allowance grants. -
Amount: number
The amount of the subscription balance allowance grants.
-
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance allowance grants. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance register allowance grants. -
ConsumedAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance allowance grants. -
ConsumedQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance allowance grants. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance allowance grant. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance allowance grant was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance allowance grants. -
EndDate: string
(date)
Title:
End Date
The date when the allowance grant ends. -
GrantDate: string
(date)
Title:
Grant Date
The date when the allowance is granted. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance allowance grant was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance allowance grants. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance allowance grants. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance allowance grants.
-
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register allowance grants. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register allowance grants. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register allowance grants. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance allowance grants. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance allowance grants. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register allowance grants. -
Quantity: number
The quantity of the subscription balance allowance grants.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance allowance grants. -
RemainingAmount: number
Title:
Remaining Amount
The remaining amount of the subscription balance allowance grants. -
RemainingQuantity: number
Title:
Remaining Quantity
The remaining quantity of the subscription balance allowance grants. -
RolloverEndDate: string
(date)
Title:
Rollover End Date
The rollover end date of the subscription balance allowance grants. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance allowance grants. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register allowance grants. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance allowance grants. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance allowance grants. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register allowance grants. -
TerminatedAmount: number
Title:
Terminated Amount
The terminated amount of the subscription balance register allowance grants. -
TerminatedQuantity: number
Title:
Terminated Quantity
The terminated quantity of the subscription balance register allowance grants.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerCommitments-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance commitments. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance commitments. -
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance commitments. -
BalanceCommitmentId: integer
(int64)
The balance register commitment identifier of the subscription balance register commitments.
-
BalanceCommitmentNumber: string
Title:
Commitment Period Number
Maximum Length:120
The balance register commitment number of the subscription balance commitments. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance commitments.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance commitments.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance register commitments. -
ChargeDefinitionName: string
Title:
Charge
Read Only:true
Maximum Length:80
The charge definition name of the subscription balance register commitments. -
CommitmentAmount: number
Title:
Amount
The committed amount of the subscription balance commitments. -
CommitmentQuantity: number
Title:
Quantity
The committed quantity of the subscription balance commitments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance commitment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance commitment was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance commitments. -
EndDate: string
(date)
Title:
End Date
The end date of the subscription balance commitments. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance commitment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number updated after every update of a subscription balance commitments. -
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register commitments. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register commitments. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register commitments. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance register commitments. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance register commitments. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register commitments. -
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance register commitments. -
RemainingCommitmentAmount: number
Title:
Remaining Amount
The remaining committed amount of the subscription balance commitments. -
RemainingCommitmentQuantity: number
Title:
Remaining Quantity
The remaining committed quantity of the subscription balance commitments. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance register commitments. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register commitments. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance register commitments. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance register commitments. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register commitments. -
TerminatedCommitmentAmount: number
Title:
Terminated Amount
The terminated commitment amount of the subscription balance register commitments. -
TerminatedCommitmentQuantity: number
Title:
Terminated Quantity
The terminated commitment quantity of the subscription balance register commitments. -
TrueupAmount: number
Title:
True-Up Amount
The true-up amount of the subscription balance register commitment. -
TrueupDate: string
(date)
Title:
True-Up Date
The true-up date of the subscription balance register commitment. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true-up status of the subscription balance register commitment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerCriteria-item-response
Type:
Show Source
object
-
BalanceCriteriaDescription: string
Title:
Description
Maximum Length:300
The description of subscription balance consumption criterion. -
BalanceCriteriaId: integer
(int64)
The unique identifier of the subscription balance consumption criterion.
-
BalanceCriteriaNumber: string
Title:
Criteria
Maximum Length:120
The unique number of the subscription balance consumption criterion. -
BalanceCriteriaStatus: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of the subscription balance consumption criterion. -
BalanceCriteriaUsage: string
Title:
Usage
Maximum Length:30
The usage condition of subscription balance consumption criterion. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance consumption criterion. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption criterion was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption criterion was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance consumption criterion. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance consumption criterion. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance consumption criterion.
-
subscriptionBalancePredicates: array
Subscription Balance Consumption Predicates
Title:
Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type:
array
Title:
Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-response
Type:
Show Source
object
-
BalanceAttributeId: integer
(int64)
The unique identifier of the subscription balance consumption attribute.
-
BalanceAttributeName: string
Title:
Attribute Name
Maximum Length:240
The name of the subscription balance consumption attribute. -
BalanceCriteriaId: integer
(int64)
The balance criteria identifier of subscription balance consumption predicate.
-
BalanceObjectId: integer
(int64)
The balance object identifier of subscription balance consumption predicate.
-
BalanceObjectName: string
Title:
Object Name
Maximum Length:120
The balance object name of subscription balance consumption predicate. -
BalancePredicateCharacterValue: string
Title:
Value
Maximum Length:600
The balance predicate character value of subscription balance consumption predicate. -
BalancePredicateDateValue: string
(date)
Title:
Value
The balance predicate date value of subscription balance consumption predicate. -
BalancePredicateDecimalValue: number
Title:
Value
The balance predicate decimal value of subscription balance consumption predicate. -
BalancePredicateId: integer
(int64)
The unique identifier of the subscription balance consumption predicate.
-
BalancePredicateNumber: string
Title:
Number
Maximum Length:120
The unique number of the subscription balance consumption predicate. -
BalancePredicateNumberValue: integer
Title:
Value
The number value of the subscription balance consumption predicate. -
BalancePredicateOperator: string
Title:
Operator
Maximum Length:30
The operator value of the subscription balance consumption predicate. -
BalancePredicateSequence: integer
Title:
Sequence
The balance predicate sequence of the subscription balance consumption predicate. -
BalancePredicateSortBy: string
Title:
Sort Order
Maximum Length:30
The sort by criterion of the subscription balance consumption predicate. -
BalancePredicateTimeValue: string
(date-time)
Title:
Value
The time value of the subscription balance consumption predicate. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance consumption predicate. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption predicate was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption predicate was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance consumption predicate. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance consumption predicate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number of the subscription balance consumption predicate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerEstimates-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance estimates. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance estimates. -
AdhocAdjustedEstimatedAmount: number
Title:
Ad-hoc Adjusted Estimated Amount
The ad-hoc adjusted estimated amount of the subscription balance estimates. -
AdhocAdjustedEstimatedQuantity: number
Title:
Ad-hoc Adjusted Estimated Quantity
The ad-hoc adjusted estimated quantity of the subscription balance estimates. -
AdhocAppliedRolloverAmount: number
Title:
Ad-hoc Applied Rollover Amount
The ad-hoc applied rollover amount of the subscription balance estimates. -
AdhocAppliedRolloverQuantity: number
Title:
Ad-hoc Applied Rollover Quantity
The ad-hoc applied rollover quantity of the subscription balance estimates. -
AdjustedEstimatedAmount: number
Title:
Adjusted Estimated Amount
The adjusted estimated amount of the subscription balance estimates. -
AdjustedEstimatedQuantity: number
Title:
Adjusted Estimated Quantity
The adjusted estimated quantity of the subscription balance estimates. -
AdjustedUsageAmount: number
Title:
Adjusted Usage Amount
The adjusted usage amount of the subscription balance estimates. -
AdjustedUsageQuantity: number
Title:
Adjusted Usage Quantity
The adjusted usage quantity of the subscription balance estimates. -
AppliedRolloverAmount: number
Title:
Applied Rollover Amount
The applied rollover amount of the subscription balance estimates. -
AppliedRolloverQuantity: number
Title:
Applied Rollover Quantity
The applied rollover quantity of the subscription balance estimates. -
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance register estimates. -
BalanceEstimateId: integer
(int64)
The balance register estimate identifier of the subscription balance register estimates.
-
BalanceEstimateNumber: string
Title:
Estimate Period Number
Maximum Length:120
The balance register estimate number of the subscription balance register estimates. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance estimates.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance estimates.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance estimates. -
ChargeDefinitionName: string
Title:
Charge
Read Only:true
Maximum Length:80
The charge definition name of the subscription balance estimates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance estimate. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance estimate was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance estimates. -
EnableTrueupFlag: boolean
Title:
Enable True-up
Maximum Length:1
Indicates whether the true up is enabled. -
EndDate: string
(date)
Title:
End Date
The end date of the subscription balance register estimates. -
EstimatedAmount: number
Title:
Amount
The estimated amount of the subscription balance register estimates. -
EstimatedQuantity: number
Title:
Quantity
The estimated quantity of the subscription balance register estimates. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance estimates was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance estimates. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance estimates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number updated after every update of a subscription balance estimates. -
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register estimates. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register estimates. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register estimates. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance register estimates. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance register estimates. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register estimates. -
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance register estimates. -
RemainingEstimatedAmount: number
Title:
Remaining Amount
The remaining amount of the subscription balance estimates. -
RemainingEstimatedQuantity: number
Title:
Remaining Quantity
The remaining quantity of the subscription balance estimates. -
RolloverEndDate: string
(date)
Title:
Rollover End Date
The rollover end date of the subscription balance estimates. -
RolloverRemainingAmount: number
Title:
Rollover Remaining Amount
The rollover remaining amount of subscription balance estimates. -
RolloverRemainingQuantity: number
Title:
Rollover Remaining Quantity
The rollover remaining quantity of subscription balance estimates. -
RolloverUsageAmount: number
Title:
Rollover Usage Amount
The rollover usage amount of the subscription balance estimates. -
RolloverUsageQuantity: number
Title:
Rollover Usage Quantity
The rollover usage quantity of the subscription balance estimates. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance register estimates. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register estimates. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance register estimates. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance register estimates. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register estimates. -
TerminatedEstimatedAmount: number
Title:
Terminated Amount
The terminated estimated amount of the subscription balance estimates. -
TerminatedEstimatedQuantity: number
Title:
Terminated Quantity
The terminated estimated quantity of the subscription balance estimates. -
TrueupAmount: number
Title:
True-Up Amount
The true-up amount of the subscription balance register estimate. -
TrueupDate: string
(date)
Title:
True-Up Date
The true-up date of the subscription balance register estimate. -
trueupEstimates: array
Subscription Balance Register Estimate True-Up
Title:
Subscription Balance Register Estimate True-Up
The true-up estimate resource is used to view, create, update, and delete ad-hoc true-up. You can create the ad-hoc true-up only for those balance codes where the allow manual true-up flag is checked in the balance profile. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true-up status of the subscription balance register estimate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Register Estimate True-Up
Type:
array
Title:
Subscription Balance Register Estimate True-Up
The true-up estimate resource is used to view, create, update, and delete ad-hoc true-up. You can create the ad-hoc true-up only for those balance codes where the allow manual true-up flag is checked in the balance profile.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The actual usage amount of true up estimate. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The actual usage quantity of true up estimate. -
AppliedRolloverAmount: number
Title:
Ad-hoc Applied Rollover Amount
The applied rollover amount of true-up estimate. -
AppliedRolloverQuantity: number
Title:
Ad-hoc Applied Rollover Quantity
The applied rollover quantity of true-up estimate. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the true up estimate -
CreationDate: string
(date-time)
Read Only:
true
The date when the true up estimate was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The actual currency code of true up estimate. -
EstimatedAmount: number
Title:
Prorated Estimated Amount
The actual estimated amount of true up estimate. -
EstimatedQuantity: number
Title:
Prorated Estimated Quantity
The actual estimated quantity of true up estimate. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the true up estimate was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the true up estimate. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the true up estimate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a true up estimate.
-
OverrideEstimatedAmount: number
Title:
Override Estimated Amount
The override estimated amount of true up estimate. -
OverrideEstimatedQuantity: number
Title:
Override Estimated Quantity
The override estimated quantity of true-up estimate. -
OverrideUsageAmount: number
Title:
Override Consumed Amount
The override usage amount of true up estimate. -
OverrideUsageQuantity: number
Title:
Override Consumed Quantity
The override usage quantity of true up estimate. -
ParentEstimateId: integer
(int64)
The parent estimate identifier of true up estimate.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of true up estimate. -
RemainingEstimatedAmount: number
Title:
Remaining Amount
The remaining estimated amount of true-up estimate. -
RemainingEstimatedQuantity: number
Title:
Remaining Quantity
The remaining estimated quantity of true-up estimate. -
TrueupAmount: number
Title:
True-Up Amount
The true up amount of true-up estimate. -
TrueupDate: string
(date)
Title:
Date
The true up date of true up estimate. -
TrueupEstimateId: integer
(int64)
The true up estimate identifier of true up estimate.
-
TrueupEstimateNumber: string
Maximum Length:
120
The true up estimate number of true up estimate. -
TrueupHoldFlag: boolean
Title:
Hold true-up
Maximum Length:1
Indicates whether the true up hold is enabled. -
TrueupReason: string
Title:
Reason
Maximum Length:30
The true up reason of true up estimate. -
TrueupReasonDescription: string
Title:
Reason Description
Maximum Length:120
The true up reason description of true up estimate. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true up status of true-up estimate. -
TrueupType: string
Title:
True-Up Type
Maximum Length:30
The true up type of true up estimate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerPeriods-item-response
Type:
Show Source
object
-
allowanceGrants: array
Subscription Balance Register Allowance Grants
Title:
Subscription Balance Register Allowance Grants
The subscription balance register allowance grants resource is used to view a balance register allowance grant. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance register periods.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance register periods.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Maximum Length:120
The balance register period number of the subscription balance register periods. -
commitments: array
Subscription Balance Register Commitments
Title:
Subscription Balance Register Commitments
The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance criterion. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance criterion was created. -
EndDate: string
(date)
Title:
End Date
The end date of the subscription balance register periods. -
estimates: array
Subscription Balance Register Estimates
Title:
Subscription Balance Register Estimates
The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance criterion was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance criterion. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance criterion. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number updated after every update of a subscription balance criterion. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance register periods.
Nested Schema : Subscription Balance Register Allowance Grants
Type:
array
Title:
Subscription Balance Register Allowance Grants
The subscription balance register allowance grants resource is used to view a balance register allowance grant.
Show Source
Nested Schema : Subscription Balance Register Commitments
Type:
array
Title:
Subscription Balance Register Commitments
The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled.
Show Source
Nested Schema : Subscription Balance Register Estimates
Type:
array
Title:
Subscription Balance Register Estimates
The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response
Type:
Show Source
object
-
AllowanceGrantId: integer
(int64)
The balance register allowance grant identifier of the subscription balance register allowance grants.
-
AllowanceGrantNumber: string
Title:
Allowance Grant Number
Maximum Length:120
The balance register allowance grant number of the subscription balance allowance grants. -
Amount: number
The amount of the subscription balance allowance grants.
-
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance allowance grants. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance allowance grants.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance register allowance grants. -
ConsumedAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance allowance grants. -
ConsumedQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance allowance grants. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance allowance grant. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance allowance grant was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance allowance grants. -
EndDate: string
(date)
Title:
End Date
The date when the allowance grant ends. -
GrantDate: string
(date)
Title:
Grant Date
The date when the allowance is granted. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance allowance grant was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance allowance grants. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance allowance grants. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance allowance grants.
-
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register allowance grants. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register allowance grants. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register allowance grants. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance allowance grants. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance allowance grants. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register allowance grants. -
Quantity: number
The quantity of the subscription balance allowance grants.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance allowance grants. -
RemainingAmount: number
Title:
Remaining Amount
The remaining amount of the subscription balance allowance grants. -
RemainingQuantity: number
Title:
Remaining Quantity
The remaining quantity of the subscription balance allowance grants. -
RolloverEndDate: string
(date)
Title:
Rollover End Date
The rollover end date of the subscription balance allowance grants. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance allowance grants. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register allowance grants. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance allowance grants. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance allowance grants. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register allowance grants. -
TerminatedAmount: number
Title:
Terminated Amount
The terminated amount of the subscription balance register allowance grants. -
TerminatedQuantity: number
Title:
Terminated Quantity
The terminated quantity of the subscription balance register allowance grants.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerPeriods-commitments-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance commitments. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance commitments. -
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance commitments. -
BalanceCommitmentId: integer
(int64)
The balance register commitment identifier of the subscription balance register commitments.
-
BalanceCommitmentNumber: string
Title:
Commitment Period Number
Maximum Length:120
The balance register commitment number of the subscription balance commitments. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance commitments.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance commitments.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance register commitments. -
ChargeDefinitionName: string
Title:
Charge
Read Only:true
Maximum Length:80
The charge definition name of the subscription balance register commitments. -
CommitmentAmount: number
Title:
Amount
The committed amount of the subscription balance commitments. -
CommitmentQuantity: number
Title:
Quantity
The committed quantity of the subscription balance commitments. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance commitment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance commitment was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance commitments. -
EndDate: string
(date)
Title:
End Date
The end date of the subscription balance commitments. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance commitment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number updated after every update of a subscription balance commitments. -
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register commitments. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register commitments. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register commitments. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance register commitments. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance register commitments. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register commitments. -
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance register commitments. -
RemainingCommitmentAmount: number
Title:
Remaining Amount
The remaining committed amount of the subscription balance commitments. -
RemainingCommitmentQuantity: number
Title:
Remaining Quantity
The remaining committed quantity of the subscription balance commitments. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance register commitments. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register commitments. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance register commitments. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance register commitments. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register commitments. -
TerminatedCommitmentAmount: number
Title:
Terminated Amount
The terminated commitment amount of the subscription balance register commitments. -
TerminatedCommitmentQuantity: number
Title:
Terminated Quantity
The terminated commitment quantity of the subscription balance register commitments. -
TrueupAmount: number
Title:
True-Up Amount
The true-up amount of the subscription balance register commitment. -
TrueupDate: string
(date)
Title:
True-Up Date
The true-up date of the subscription balance register commitment. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true-up status of the subscription balance register commitment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerPeriods-estimates-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The consumed amount of the subscription balance estimates. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The consumed quantity of the subscription balance estimates. -
AdhocAdjustedEstimatedAmount: number
Title:
Ad-hoc Adjusted Estimated Amount
The ad-hoc adjusted estimated amount of the subscription balance estimates. -
AdhocAdjustedEstimatedQuantity: number
Title:
Ad-hoc Adjusted Estimated Quantity
The ad-hoc adjusted estimated quantity of the subscription balance estimates. -
AdhocAppliedRolloverAmount: number
Title:
Ad-hoc Applied Rollover Amount
The ad-hoc applied rollover amount of the subscription balance estimates. -
AdhocAppliedRolloverQuantity: number
Title:
Ad-hoc Applied Rollover Quantity
The ad-hoc applied rollover quantity of the subscription balance estimates. -
AdjustedEstimatedAmount: number
Title:
Adjusted Estimated Amount
The adjusted estimated amount of the subscription balance estimates. -
AdjustedEstimatedQuantity: number
Title:
Adjusted Estimated Quantity
The adjusted estimated quantity of the subscription balance estimates. -
AdjustedUsageAmount: number
Title:
Adjusted Usage Amount
The adjusted usage amount of the subscription balance estimates. -
AdjustedUsageQuantity: number
Title:
Adjusted Usage Quantity
The adjusted usage quantity of the subscription balance estimates. -
AppliedRolloverAmount: number
Title:
Applied Rollover Amount
The applied rollover amount of the subscription balance estimates. -
AppliedRolloverQuantity: number
Title:
Applied Rollover Quantity
The applied rollover quantity of the subscription balance estimates. -
BalanceCode: string
Title:
Balance Code
Read Only:true
Maximum Length:30
The balance code of the subscription balance register estimates. -
BalanceEstimateId: integer
(int64)
The balance register estimate identifier of the subscription balance register estimates.
-
BalanceEstimateNumber: string
Title:
Estimate Period Number
Maximum Length:120
The balance register estimate number of the subscription balance register estimates. -
BalanceRegisterId: integer
(int64)
The balance register identifier of the subscription balance estimates.
-
BalanceRegisterPeriodId: integer
(int64)
The balance register period identifier of the subscription balance estimates.
-
BalanceRegisterPeriodNumber: string
Title:
Register Period Number
Read Only:true
Maximum Length:120
The balance register period number of the subscription balance estimates. -
ChargeDefinitionName: string
Title:
Charge
Read Only:true
Maximum Length:80
The charge definition name of the subscription balance estimates. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance estimate. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance estimate was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the subscription balance estimates. -
EnableTrueupFlag: boolean
Title:
Enable True-up
Maximum Length:1
Indicates whether the true up is enabled. -
EndDate: string
(date)
Title:
End Date
The end date of the subscription balance register estimates. -
EstimatedAmount: number
Title:
Amount
The estimated amount of the subscription balance register estimates. -
EstimatedQuantity: number
Title:
Quantity
The estimated quantity of the subscription balance register estimates. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance estimates was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance estimates. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance estimates. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number updated after every update of a subscription balance estimates. -
PartyName: string
Title:
Customer
Read Only:true
Maximum Length:360
The party name of the subscription balance register estimates. -
PartyNumber: string
Title:
Party Number
Read Only:true
Maximum Length:30
The party number of the subscription balance register estimates. -
ProductEndDate: string
(date)
Title:
Product End Date
Read Only:true
The product end date of the subscription balance register estimates. -
ProductName: string
Title:
Product Name
Read Only:true
Maximum Length:300
The product name of the subscription balance register estimates. -
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The product number of the subscription balance register estimates. -
ProductStartDate: string
(date)
Title:
Product Start Date
Read Only:true
The product start date of the subscription balance register estimates. -
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of the subscription balance register estimates. -
RemainingEstimatedAmount: number
Title:
Remaining Amount
The remaining amount of the subscription balance estimates. -
RemainingEstimatedQuantity: number
Title:
Remaining Quantity
The remaining quantity of the subscription balance estimates. -
RolloverEndDate: string
(date)
Title:
Rollover End Date
The rollover end date of the subscription balance estimates. -
RolloverRemainingAmount: number
Title:
Rollover Remaining Amount
The rollover remaining amount of subscription balance estimates. -
RolloverRemainingQuantity: number
Title:
Rollover Remaining Quantity
The rollover remaining quantity of subscription balance estimates. -
RolloverUsageAmount: number
Title:
Rollover Usage Amount
The rollover usage amount of the subscription balance estimates. -
RolloverUsageQuantity: number
Title:
Rollover Usage Quantity
The rollover usage quantity of the subscription balance estimates. -
StartDate: string
(date)
Title:
Start Date
The start date of the subscription balance register estimates. -
SubscriptionEndDate: string
(date)
Title:
Subscription End Date
Read Only:true
The subscription end date of the subscription balance register estimates. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The subscription number of the subscription balance register estimates. -
SubscriptionProductPuid: string
Title:
Subscription Product PUID
Read Only:true
Maximum Length:120
The subscription product PUID of the subscription balance register estimates. -
SubscriptionStartDate: string
(date)
Title:
Subscription Start Date
Read Only:true
The subscription start date of the subscription balance register estimates. -
TerminatedEstimatedAmount: number
Title:
Terminated Amount
The terminated estimated amount of the subscription balance estimates. -
TerminatedEstimatedQuantity: number
Title:
Terminated Quantity
The terminated estimated quantity of the subscription balance estimates. -
TrueupAmount: number
Title:
True-Up Amount
The true-up amount of the subscription balance register estimate. -
TrueupDate: string
(date)
Title:
True-Up Date
The true-up date of the subscription balance register estimate. -
trueupEstimates: array
Subscription Balance Register Estimate True-Up
Title:
Subscription Balance Register Estimate True-Up
The true-up estimate resource is used to view, create, update, and delete ad-hoc true-up. You can create the ad-hoc true-up only for those balance codes where the allow manual true-up flag is checked in the balance profile. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true-up status of the subscription balance register estimate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Register Estimate True-Up
Type:
array
Title:
Subscription Balance Register Estimate True-Up
The true-up estimate resource is used to view, create, update, and delete ad-hoc true-up. You can create the ad-hoc true-up only for those balance codes where the allow manual true-up flag is checked in the balance profile.
Show Source
Nested Schema : subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-response
Type:
Show Source
object
-
ActualUsageAmount: number
Title:
Consumed Amount
The actual usage amount of true up estimate. -
ActualUsageQuantity: number
Title:
Consumed Quantity
The actual usage quantity of true up estimate. -
AppliedRolloverAmount: number
Title:
Ad-hoc Applied Rollover Amount
The applied rollover amount of true-up estimate. -
AppliedRolloverQuantity: number
Title:
Ad-hoc Applied Rollover Quantity
The applied rollover quantity of true-up estimate. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the true up estimate -
CreationDate: string
(date-time)
Read Only:
true
The date when the true up estimate was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The actual currency code of true up estimate. -
EstimatedAmount: number
Title:
Prorated Estimated Amount
The actual estimated amount of true up estimate. -
EstimatedQuantity: number
Title:
Prorated Estimated Quantity
The actual estimated quantity of true up estimate. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the true up estimate was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the true up estimate. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the true up estimate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a true up estimate.
-
OverrideEstimatedAmount: number
Title:
Override Estimated Amount
The override estimated amount of true up estimate. -
OverrideEstimatedQuantity: number
Title:
Override Estimated Quantity
The override estimated quantity of true-up estimate. -
OverrideUsageAmount: number
Title:
Override Consumed Amount
The override usage amount of true up estimate. -
OverrideUsageQuantity: number
Title:
Override Consumed Quantity
The override usage quantity of true up estimate. -
ParentEstimateId: integer
(int64)
The parent estimate identifier of true up estimate.
-
QuantityUnitOfMeasure: string
Title:
UOM
Maximum Length:3
The quantity unit of measure of true up estimate. -
RemainingEstimatedAmount: number
Title:
Remaining Amount
The remaining estimated amount of true-up estimate. -
RemainingEstimatedQuantity: number
Title:
Remaining Quantity
The remaining estimated quantity of true-up estimate. -
TrueupAmount: number
Title:
True-Up Amount
The true up amount of true-up estimate. -
TrueupDate: string
(date)
Title:
Date
The true up date of true up estimate. -
TrueupEstimateId: integer
(int64)
The true up estimate identifier of true up estimate.
-
TrueupEstimateNumber: string
Maximum Length:
120
The true up estimate number of true up estimate. -
TrueupHoldFlag: boolean
Title:
Hold true-up
Maximum Length:1
Indicates whether the true up hold is enabled. -
TrueupReason: string
Title:
Reason
Maximum Length:30
The true up reason of true up estimate. -
TrueupReasonDescription: string
Title:
Reason Description
Maximum Length:120
The true up reason description of true up estimate. -
TrueupStatus: string
Title:
True-Up Status
Maximum Length:30
The true up status of true-up estimate. -
TrueupType: string
Title:
True-Up Type
Maximum Length:30
The true up type of true up estimate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- activate
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The method is used to activate a balance register. - BalanceRegisterNumber:
- profileCharges
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The subscription balance profile charges resource is used to view a balance profile charges. - BalanceRegisterNumber:
- registerAllowances
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The subscription balance register allowance grants resource is used to view a balance register allowance grant. - BalanceRegisterNumber:
- registerCommitments
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The commitments resource is used to view a register which displays the commitment records. These records are displayed only for those balance codes which have the commitment flag enabled. - BalanceRegisterNumber:
- registerCriteria
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later. - BalanceRegisterNumber:
- registerEstimates
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The estimates resource is used to view a register which displays the estimates records. These records are displayed only for those balance codes which have the estimate flag enabled. - BalanceRegisterNumber:
- registerPeriods
-
Parameters:
- BalanceRegisterNumber:
$request.path.BalanceRegisterNumber
The subscription balance register periods resource is used to view a balance register period. - BalanceRegisterNumber: