Subscription Balance Registers
subscriptionBalanceRegisters Based on latest (2026.09)
Create, change, delete and look up Subscription Balance Registers, with subscription balance profile balance codes, subscription balance register grouping rules and profile charges. Actions include activate.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
BalanceRegisterNumber- Required on create
BalanceRegisterNumber- At a glance
- 31 fields1 finders26 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters?fields=ActivateRegisterFlag,AllowanceEffectivityType,AmendNewPartialPeriodOption,AmendTerminatedPartialPeriodOption,BalanceProfileName&limit=25&onlyData=true
{
"items": [
{
"ActivateRegisterFlag": false,
"AllowanceEffectivityType": "ORA_OSS_BAL_REGISTER_PERIOD",
"AmendNewPartialPeriodOption": "<string, max 30>",
"AmendTerminatedPartialPeriodOption": "<string, max 30>",
"BalanceProfileName": "<string, max 120>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 31
| Attribute | Type | Use |
|---|---|---|
ActivateRegisterFlag | yes/no · max 80 · default false | Optional on createUpdatable |
AllowanceEffectivityType | text · max 30 · default ORA_OSS_BAL_REGISTER_PERIOD | Read-onlySearchable |
AmendNewPartialPeriodOption | text · max 30 | Read-onlySearchable |
AmendTerminatedPartialPeriodOption | text · max 30 | Read-onlySearchable |
BalanceProfileName | text · max 120 | Optional on createSearchable |
BalanceProfileNumber | text · max 120 | Optional on createSearchable |
BalanceRegisterId | number | Optional on createSearchable |
BalanceRegisterNumber | text · max 120 | Required on createSearchable |
BalanceRegisterStatus | text · max 30 | Optional on createUpdatableSearchable |
BillOnDay | number | Read-onlySearchable |
BillPeriodAlignDate | date | Optional on createUpdatableSearchable |
BillingDateCode | text · max 30 | Read-onlySearchable |
BillingFrequency | text · max 30 | Read-onlySearchable |
BillingOffsetDays | number | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EstimateDateCode | text · max 30 | Read-onlySearchable |
FirstPartialPeriodOption | text · max 30 | Read-onlySearchable |
InterfaceOffsetDays | number | Read-onlySearchable |
InvoicingRuleId | number | Read-onlySearchable |
LastPartialPeriodOption | text · max 30 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ManualTrueupFlag | yes/no · max 1 · default false | Read-onlySearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
PeriodAlignDateType | text · max 30 · default ORA_OSS_BAL_REG_AND_BILL_LINES | Read-onlySearchable |
RegisterUpdateFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
TerminatedPartialPeriodOption | text · max 30 | Read-onlySearchable |
TrueupOffset | text · max 30 | Read-onlySearchable |
TrueupOverrideFlag | yes/no · max 1 · default false | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
BalanceRegisterAltKey·BalanceRegisterNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 26
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/<name>. Add them to a GET with expand.
SubscriptionBalanceProfileBalanceCodesGET Subscription Profile Balance Codes · 20 fields · 6 findersAllowanceGrantCodeFlagBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeIdForRestBalancePrecedenceBalanceProfileChargeIdBalanceProfileIdBalanceUnitofMeasureClassCodeCommitmentCodeFlagCreatedByCreationDateEstimateCodeFlagLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberProfileBalanceCodeIdProfileBalanceCodeNumberVolumePricingFlagSubscriptionBalanceRegisterGroupingRulesGET · POST · PATCH Subscription Balance Condition Predicates · 25 fields · 1 findersBalanceAttributeIdBalanceAttributeNameBalanceCriteriaIdBalanceCriteriaUsageBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceObjectSourceObjectIdSourceTypeprofileChargesGET Subscription Balance Profile Charges · 28 fields · 1 findersAllowanceGrantFlagBalanceProfileChargeIdBalanceProfileChargeNumberBalanceProfileIdBillingFrequencyBillingFrequencyUnitOfMeasureChargeDefinitionCodeChargeDefinitionIdChargePeriodChargePeriodUnitOfMeasureChargeTypeCommitmentFlagCreatedByCreationDateEstimateFlagInvoicingRuleInvoicingRuleForRestInvoicingRuleIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPriceTypeCodeRelatedChargeDefinitionCodeRelatedChargeDefinitionIdRelatedProfileChargeIdUsageCaptureFlagVolumePricingFlagregisterAllowancesGET · PATCH Subscription Balance Register Allowance Grants · 49 fields · 1 findersAdjustedAmountAdjustedQuantityAllowanceEffectiveEndDateAllowanceEffectiveStartDateAllowanceGrantIdAllowanceGrantNumberAmountBalanceCategoryCodeBalanceCategoryIdBalanceCategoryNameBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameConsumedAmountConsumedQuantityCreatedByCreationDateCurrencyCodeEndDateExtendedPrecisionGrantDateLastUpdateDateLastUpdateLoginLastUpdatedByLeAllowanceCurrentDateObjectVersionNumberPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityQuantityUnitOfMeasureRemainingAmountRemainingQuantityRolloverEndDateStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedAmountTerminatedQuantitySubscriptionBalanceRegisterAdjustmentsGET · POST · PATCH Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantityregisterCommitmentsGET · PATCH Subscription Balance Register Commitments · 47 fields · 1 findersActualUsageAmountActualUsageQuantityAdjustedCommitmentAmountAdjustedCommitmentQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceCommitmentIdBalanceCommitmentNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCommitmentAmountCommitmentQuantityCreatedByCreationDateCurrencyCodeEndDateExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeCommitmentCurrentDateObjectVersionNumberPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureRemainingCommitmentAmountRemainingCommitmentQuantityStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedCommitmentAmountTerminatedCommitmentQuantityTrueupAmountTrueupDateTrueupHoldFlagTrueupStatusTrueupUsageFlagSubscriptionBalanceRegisterAdjustmentsGET · POST · PATCH Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitySubscriptionBalanceRegisterCommitmentUsagesGET · PATCH Subscription Balance Register Commitments · 35 fields · 1 findersActualUsageAmountActualUsageQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceCommitmentIdBalanceCommitmentNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCreatedByCreationDateCurrencyCodeEndDateExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeCommitmentCurrentDateObjectVersionNumberPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTrueupUsageFlagregisterCriteriaGET · POST · PATCH · DELETE Subscription Balance Condition Criteria · 12 fields · 1 findersBalanceCriteriaDescriptionBalanceCriteriaIdBalanceCriteriaNumberBalanceCriteriaStatusBalanceCriteriaUsageCreatedByCreationDateCriteriaPrecedenceLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbersubscriptionBalancePredicatesGET · POST · PATCH · DELETE Subscription Balance Condition Predicates · 23 fields · 1 findersBalanceAttributeIdBalanceAttributeNameBalanceCriteriaIdBalanceCriteriaUsageBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceTyperegisterEstimatesGET · PATCH Subscription Balance Register Estimates · 65 fields · 1 findersActualUsageAmountActualUsageQuantityAdhocAdjustedEstimatedAmountAdhocAdjustedEstimatedQuantityAdhocAppliedRolloverAmountAdhocAppliedRolloverQuantityAdjustedEstimatedAmountAdjustedEstimatedQuantityAdjustedUsageAmountAdjustedUsageQuantityAppliedRolloverAmountAppliedRolloverQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceEstimateIdBalanceEstimateNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCreatedByCreationDateCurrencyCodeEnableTrueupFlagEndDateEstimateUsageFlagEstimatedAmountEstimatedQuantityExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeEstimateCurrentDateManualTrueupFlagObjectVersionNumberParentEstimateIdPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureRemainingEstimatedAmountRemainingEstimatedQuantityRolloverEndDateRolloverRemainingAmountRolloverRemainingQuantityRolloverUsageAmountRolloverUsageQuantityStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedEstimatedAmountTerminatedEstimatedQuantityTrueupAmountTrueupDateTrueupHoldFlagTrueupStatusTrueupTypeTrueupUsageFlagSubscriptionBalanceRegisterAdjustmentsGET · POST · PATCH Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitySubscriptionBalanceRegisterUsageEstimatesGET · PATCH Subscription Balance Register Estimates · 48 fields · 1 findersAdjustedEstimatedAmountAdjustedEstimatedQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceEstimateIdBalanceEstimateNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCreatedByCreationDateCurrencyCodeEndDateEstimateUsageFlagEstimatedAmountEstimatedQuantityExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeEstimateCurrentDateManualTrueupFlagObjectVersionNumberParentEstimateIdPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureRemainingEstimatedAmountRemainingEstimatedQuantityStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedEstimatedAmountTerminatedEstimatedQuantityTrueupAmountTrueupDateTrueupHoldFlagTrueupStatusTrueupTypeSubscriptionBalanceRegisterAdjustmentsGET · POST · PATCH Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitytrueupEstimatesGET · POST · PATCH · DELETE Subscription Balance Register Estimate True-Up · 36 fields · 1 findersActualUsageAmountActualUsageQuantityAppliedRolloverAmountAppliedRolloverQuantityBalanceCodeMaxPrecisionBalanceCodeTypeCreatedByCreationDateCurrencyCodeEstimatedAmountEstimatedQuantityExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeTrueupCurrentDateObjectVersionNumberOverrideEstimatedAmountOverrideEstimatedQuantityOverrideUsageAmountOverrideUsageQuantityParentBalanceEstimateNumberReferenceParentEstimateIdQuantityUnitOfMeasureRemainingEstimatedAmountRemainingEstimatedQuantityTrueupAmountTrueupDateTrueupEstimateIdTrueupEstimateNumberTrueupHoldFlagTrueupReasonTrueupReasonDescriptionTrueupStatusTrueupTypeTrueupUsageFlagregisterPeriodsGET Subscription Balance Periods · 11 fields · 1 findersBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberCreatedByCreationDateEndDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberStartDateallowanceGrantsGET · PATCH Subscription Balance Register Allowance Grants · 49 fields · 1 findersAdjustedAmountAdjustedQuantityAllowanceEffectiveEndDateAllowanceEffectiveStartDateAllowanceGrantIdAllowanceGrantNumberAmountBalanceCategoryCodeBalanceCategoryIdBalanceCategoryNameBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameConsumedAmountConsumedQuantityCreatedByCreationDateCurrencyCodeEndDateExtendedPrecisionGrantDateLastUpdateDateLastUpdateLoginLastUpdatedByLeAllowanceCurrentDateObjectVersionNumberPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityQuantityUnitOfMeasureRemainingAmountRemainingQuantityRolloverEndDateStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedAmountTerminatedQuantitySubscriptionBalanceRegisterAdjustmentsGET · POST Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitycommitmentsGET · PATCH Subscription Balance Register Commitments · 47 fields · 1 findersActualUsageAmountActualUsageQuantityAdjustedCommitmentAmountAdjustedCommitmentQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceCommitmentIdBalanceCommitmentNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCommitmentAmountCommitmentQuantityCreatedByCreationDateCurrencyCodeEndDateExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeCommitmentCurrentDateObjectVersionNumberPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureRemainingCommitmentAmountRemainingCommitmentQuantityStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedCommitmentAmountTerminatedCommitmentQuantityTrueupAmountTrueupDateTrueupHoldFlagTrueupStatusTrueupUsageFlagSubscriptionBalanceRegisterAdjustmentsGET · POST Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitySubscriptionBalanceRegisterCommitmentUsagesGET · PATCH Subscription Balance Register Commitments · 35 fields · 1 findersActualUsageAmountActualUsageQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceCommitmentIdBalanceCommitmentNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCreatedByCreationDateCurrencyCodeEndDateExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeCommitmentCurrentDateObjectVersionNumberPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTrueupUsageFlagestimatesGET · PATCH Subscription Balance Register Estimates · 65 fields · 1 findersActualUsageAmountActualUsageQuantityAdhocAdjustedEstimatedAmountAdhocAdjustedEstimatedQuantityAdhocAppliedRolloverAmountAdhocAppliedRolloverQuantityAdjustedEstimatedAmountAdjustedEstimatedQuantityAdjustedUsageAmountAdjustedUsageQuantityAppliedRolloverAmountAppliedRolloverQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceEstimateIdBalanceEstimateNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCreatedByCreationDateCurrencyCodeEnableTrueupFlagEndDateEstimateUsageFlagEstimatedAmountEstimatedQuantityExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeEstimateCurrentDateManualTrueupFlagObjectVersionNumberParentEstimateIdPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureRemainingEstimatedAmountRemainingEstimatedQuantityRolloverEndDateRolloverRemainingAmountRolloverRemainingQuantityRolloverUsageAmountRolloverUsageQuantityStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedEstimatedAmountTerminatedEstimatedQuantityTrueupAmountTrueupDateTrueupHoldFlagTrueupStatusTrueupTypeTrueupUsageFlagSubscriptionBalanceRegisterAdjustmentsGET · POST Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitySubscriptionBalanceRegisterUsageEstimatesGET · PATCH Subscription Balance Register Estimates · 48 fields · 1 findersAdjustedEstimatedAmountAdjustedEstimatedQuantityBalanceCodeBalanceCodeMaxPrecisionBalanceCodeTypeBalanceEstimateIdBalanceEstimateNumberBalanceRegisterIdBalanceRegisterPeriodIdBalanceRegisterPeriodNumberChargeDefinitionNameCreatedByCreationDateCurrencyCodeEndDateEstimateUsageFlagEstimatedAmountEstimatedQuantityExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeEstimateCurrentDateManualTrueupFlagObjectVersionNumberParentEstimateIdPartyNamePartyNumberProductClosedDateProductEndDateProductNameProductNumberProductStartDateQuantityUnitOfMeasureRemainingEstimatedAmountRemainingEstimatedQuantityStartDateSubscriptionEndDateSubscriptionNumberSubscriptionProductPuidSubscriptionStartDateTerminatedEstimatedAmountTerminatedEstimatedQuantityTrueupAmountTrueupDateTrueupHoldFlagTrueupStatusTrueupTypeSubscriptionBalanceRegisterAdjustmentsGET · POST Subscription Balance Register Adjustments · 36 fields · 1 findersAdjustedAmountAdjustedQuantityAdjustmentDescriptionAdjustmentNameAdjustmentReasonCodeAdjustmentTypeAdjustmentValueBalanceAdjustmentIdBalanceAdjustmentNumberBalanceAdjustmentPartialPeriodOptionBalanceAdjustmentTerminatedPartialPeriodOptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeTypeBalanceFirstPartialPeriodOptionBalanceLastPartialPeriodOptionBalanceRegisterIdBalanceRegisterPeriodIdBalanceTerminatedPartialPeriodOptionCreatedByCreationDateCurrencyCodeEntitlementIdEntitlementTypeExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByNetAdjustedAmountNetAdjustedQuantityObjectVersionNumberParentEntitlementNumberReferenceSequenceNumberSubscriptionProductIdTerminatedAmountTerminatedQuantitytrueupEstimatesGET · POST Subscription Balance Register Estimate True-Up · 36 fields · 1 findersActualUsageAmountActualUsageQuantityAppliedRolloverAmountAppliedRolloverQuantityBalanceCodeMaxPrecisionBalanceCodeTypeCreatedByCreationDateCurrencyCodeEstimatedAmountEstimatedQuantityExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByLeTrueupCurrentDateObjectVersionNumberOverrideEstimatedAmountOverrideEstimatedQuantityOverrideUsageAmountOverrideUsageQuantityParentBalanceEstimateNumberReferenceParentEstimateIdQuantityUnitOfMeasureRemainingEstimatedAmountRemainingEstimatedQuantityTrueupAmountTrueupDateTrueupEstimateIdTrueupEstimateNumberTrueupHoldFlagTrueupReasonTrueupReasonDescriptionTrueupStatusTrueupTypeTrueupUsageFlag
Actions 1
POST …/{BalanceRegisterNumber}/action/activate
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegistersand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
BalanceRegisterAltKeyfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ActivateRegisterFlag, notactivateregisterflag. - 22 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.