Jump to

• Request
• Response

Create a subscription balance register

post

/crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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(required): 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.
• BillPeriodAlignDate: string (date)
  Title: Align Billing From

  The bill alignment date of the subscription balance registers.
• 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.

{
    "required":[
        "BalanceRegisterNumber"
    ],
    "type":"object",
    "properties":{
        "BalanceProfileNumber":{
            "title":"Profile Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile number of the subscription balance registers.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceRegisterStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription balance register.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "registerCommitments":{
            "title":"Subscription Balance Register Commitments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCommitments-item-post-request"
            }
        },
        "registerEstimates":{
            "title":"Subscription Balance Register Estimates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-item-post-request"
            }
        },
        "BalanceProfileName":{
            "title":"Profile Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile name of the subscription balance registers.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "registerAllowances":{
            "title":"Subscription Balance Register Allowance Grants",
            "type":"array",
            "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerAllowances-item-post-request"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance registers.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "BalanceRegisterNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register number of the subscription balance registers.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            }
        },
        "profileCharges":{
            "title":"Subscription Balance Profile Charges",
            "type":"array",
            "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-profileCharges-item-post-request"
            }
        },
        "registerCriteria":{
            "title":"Subscription Balance Consumption Criteria",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-item-post-request"
            },
            "x-cardinality":"1"
        },
        "registerPeriods":{
            "title":"Subscription Balance Periods",
            "type":"array",
            "description":"The subscription balance register periods resource is used to view a balance register period.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-item-post-request"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance registers.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RegisterUpdateFlag":{
            "title":"Allow register update",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the register is enabled for update.",
            "nullable":true,
            "default":false
        },
        "BillPeriodAlignDate":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The bill alignment date of the subscription balance registers.",
            "format":"date",
            "nullable":true
        }
    }
}

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

• Array of: object subscriptionBalanceRegisters-profileCharges-item-post-request

{
    "title":"Subscription Balance Profile Charges",
    "type":"array",
    "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-profileCharges-item-post-request"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerAllowances-item-post-request

{
    "title":"Subscription Balance Register Allowance Grants",
    "type":"array",
    "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerAllowances-item-post-request"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerCommitments-item-post-request

{
    "title":"Subscription Balance Register Commitments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCommitments-item-post-request"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerCriteria-item-post-request

{
    "title":"Subscription Balance Consumption Criteria",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-item-post-request"
    },
    "x-cardinality":"1"
}

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

• Array of: object subscriptionBalanceRegisters-registerEstimates-item-post-request

{
    "title":"Subscription Balance Register Estimates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-item-post-request"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-item-post-request

{
    "title":"Subscription Balance Periods",
    "type":"array",
    "description":"The subscription balance register periods resource is used to view a balance register period.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-item-post-request"
    }
}

Nested Schema : subscriptionBalanceRegisters-profileCharges-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "UsageCaptureFlag":{
            "title":"Enable usage capture",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the usage capture is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        },
        "EstimateFlag":{
            "title":"Enable estimate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the estimate is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule identifier of the subscription balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillingFrequency":{
            "maxLength":"30",
            "type":"string",
            "description":"The billing frequency of the subscription balance profile charge.",
            "nullable":true
        },
        "AllowanceGrantFlag":{
            "title":"Enable allowance",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the allowance grant is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the related charge identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CommitmentFlag":{
            "title":"Enable commitment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the commitment is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":"25",
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "InvoicingRule":{
            "title":"Invoicing Rule",
            "maxLength":"30",
            "type":"string",
            "description":"The invoicing rule of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RelatedChargeDefinitionId":{
            "title":"Related Charge",
            "type":"integer",
            "description":"The charge definition identifier of the related profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "AllowanceGrantFlag",
                    "CommitmentFlag",
                    "EstimateFlag"
                ]
            }
        },
        "RelatedChargeDefinitionCode":{
            "title":"Related Charge",
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":"25",
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":"30",
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            }
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerAllowances-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance 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.
• 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.

{
    "type":"object",
    "properties":{
        "AllowanceGrantNumber":{
            "title":"Allowance Grant Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register allowance grant number of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TerminatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated amount of the subscription balance register allowance grants.",
            "nullable":true
        },
        "RemainingQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ConsumedAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the allowance grant ends.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true
        },
        "ConsumedQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance allowance grants.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "TerminatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated quantity of the subscription balance register allowance grants.",
            "nullable":true
        },
        "AllowanceGrantId":{
            "type":"integer",
            "description":"The balance register allowance grant identifier of the subscription balance register allowance grants.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "GrantDate":{
            "title":"Grant Date",
            "type":"string",
            "description":"The date when the allowance is granted.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerCommitments-item-post-request

Type: object

Show Source

• 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.
• 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.
• CommitmentAmount: number
  Title: Amount

  The committed amount of the subscription balance commitments.
• CommitmentQuantity: number
  Title: Quantity

  The committed quantity of the subscription balance commitments.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CommitmentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TerminatedCommitmentQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated commitment quantity of the subscription balance register commitments.",
            "nullable":true
        },
        "BalanceCommitmentNumber":{
            "title":"Commitment Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register commitment number of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RemainingCommitmentAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance commitments.",
            "format":"date",
            "nullable":true
        },
        "BalanceCommitmentId":{
            "type":"integer",
            "description":"The balance register commitment identifier of the subscription balance register commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RemainingCommitmentQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "CommitmentAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register commitment.",
            "format":"date",
            "nullable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "TerminatedCommitmentAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated commitment amount of the subscription balance register commitments.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerCriteria-item-post-request

Type: object

Show Source

• 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(required): 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(required): string
  Title: Usage

  Maximum Length: 30

  The usage condition of subscription balance consumption criterion.
• 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.

{
    "required":[
        "BalanceCriteriaNumber",
        "BalanceCriteriaUsage"
    ],
    "type":"object",
    "properties":{
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The description of subscription balance consumption criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance consumption criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The usage condition of subscription balance consumption criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Consumption Predicates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-post-request"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription balance consumption criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption criterion.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Subscription Balance Consumption Predicates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria identifier of subscription balance consumption predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":"30",
            "type":"string",
            "description":"The sort by criterion of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance consumption predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance consumption predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance object name of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance consumption predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":"30",
            "type":"string",
            "description":"The operator value of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":"600",
            "type":"string",
            "description":"The balance predicate character value of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance consumption predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption predicate.",
            "nullable":false
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the subscription balance consumption attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            }
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerEstimates-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EnableTrueupFlag":{
            "title":"Enable True-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up is enabled.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdhocAppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The ad-hoc applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EstimatedAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated amount of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AppliedRolloverQuantity":{
            "title":"Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AppliedRolloverAmount":{
            "title":"Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RolloverRemainingQuantity":{
            "title":"Rollover Remaining Quantity",
            "type":"number",
            "description":"The rollover remaining quantity of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceEstimateId":{
            "type":"integer",
            "description":"The balance register estimate identifier of the subscription balance register estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RolloverUsageQuantity":{
            "title":"Rollover Usage Quantity",
            "type":"number",
            "description":"The rollover usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TerminatedEstimatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register estimate.",
            "format":"date",
            "nullable":true
        },
        "AdjustedEstimatedQuantity":{
            "title":"Adjusted Estimated Quantity",
            "type":"number",
            "description":"The adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdhocAdjustedEstimatedQuantity":{
            "title":"Ad-hoc Adjusted Estimated Quantity",
            "type":"number",
            "description":"The ad-hoc adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance estimates.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EstimatedQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The estimated quantity of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdjustedUsageAmount":{
            "title":"Adjusted Usage Amount",
            "type":"number",
            "description":"The adjusted usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdjustedEstimatedAmount":{
            "title":"Adjusted Estimated Amount",
            "type":"number",
            "description":"The adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverRemainingAmount":{
            "title":"Rollover Remaining Amount",
            "type":"number",
            "description":"The rollover remaining amount of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true
        },
        "BalanceEstimateNumber":{
            "title":"Estimate Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register estimate number of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverUsageAmount":{
            "title":"Rollover Usage Amount",
            "type":"number",
            "description":"The rollover usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "trueupEstimates":{
            "title":"Subscription Balance Register Estimate True-Up",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-post-request"
            }
        },
        "TerminatedEstimatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdjustedUsageQuantity":{
            "title":"Adjusted Usage Quantity",
            "type":"number",
            "description":"The adjusted usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdhocAdjustedEstimatedAmount":{
            "title":"Ad-hoc Adjusted Estimated Amount",
            "type":"number",
            "description":"The ad-hoc adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "AdhocAppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The ad-hoc applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Subscription Balance Register Estimate True-Up",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EstimatedAmount":{
            "title":"Prorated Estimated Amount",
            "type":"number",
            "description":"The actual estimated amount of true up estimate.",
            "nullable":true
        },
        "AppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of true-up estimate.",
            "nullable":true
        },
        "AppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of true-up estimate.",
            "nullable":true
        },
        "TrueupReasonDescription":{
            "title":"Reason Description",
            "maxLength":"120",
            "type":"string",
            "description":"The true up reason description of true up estimate.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The actual currency code of true up estimate.",
            "nullable":true
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining estimated quantity of true-up estimate.",
            "nullable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true up status of true-up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining estimated amount of true-up estimate.",
            "nullable":true
        },
        "TrueupDate":{
            "title":"Date",
            "type":"string",
            "description":"The true up date of true up estimate.",
            "format":"date",
            "nullable":true
        },
        "TrueupHoldFlag":{
            "title":"Hold true-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up hold is enabled.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a true up estimate.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The actual usage amount of true up estimate.",
            "nullable":true
        },
        "TrueupEstimateId":{
            "type":"integer",
            "description":"The true up estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EstimatedQuantity":{
            "title":"Prorated Estimated Quantity",
            "type":"number",
            "description":"The actual estimated quantity of true up estimate.",
            "nullable":true
        },
        "OverrideEstimatedQuantity":{
            "title":"Override Estimated Quantity",
            "type":"number",
            "description":"The override estimated quantity of true-up estimate.",
            "nullable":true
        },
        "TrueupType":{
            "title":"True-Up Type",
            "maxLength":"30",
            "type":"string",
            "description":"The true up type of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TrueupEstimateNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The true up estimate number of true up estimate.",
            "nullable":false
        },
        "OverrideUsageAmount":{
            "title":"Override Consumed Amount",
            "type":"number",
            "description":"The override usage amount of true up estimate.",
            "nullable":true
        },
        "TrueupReason":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The true up reason of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideUsageQuantity":{
            "title":"Override Consumed Quantity",
            "type":"number",
            "description":"The override usage quantity of true up estimate.",
            "nullable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true up amount of true-up estimate.",
            "nullable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of true up estimate.",
            "nullable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The actual usage quantity of true up estimate.",
            "nullable":true
        },
        "ParentEstimateId":{
            "type":"integer",
            "description":"The parent estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "OverrideEstimatedAmount":{
            "title":"Override Estimated Amount",
            "type":"number",
            "description":"The override estimated amount of true up estimate.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-item-post-request

Type: object

Show Source

• 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(required): 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(required): 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.
• 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.
• StartDate(required): string (date)
  Title: Start Date

  The start date of the subscription balance register periods.

{
    "required":[
        "BalanceRegisterId",
        "BalanceRegisterPeriodNumber",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register periods.",
            "format":"date",
            "nullable":false
        },
        "commitments":{
            "title":"Subscription Balance Register Commitments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-commitments-item-post-request"
            }
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance register periods.",
            "nullable":false
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance register periods.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance register periods.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance register periods.",
            "format":"date",
            "nullable":true
        },
        "allowanceGrants":{
            "title":"Subscription Balance Register Allowance Grants",
            "type":"array",
            "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-post-request"
            }
        },
        "estimates":{
            "title":"Subscription Balance Register Estimates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-item-post-request"
            }
        }
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-post-request

{
    "title":"Subscription Balance Register Allowance Grants",
    "type":"array",
    "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-post-request"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-commitments-item-post-request

{
    "title":"Subscription Balance Register Commitments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-commitments-item-post-request"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-estimates-item-post-request

{
    "title":"Subscription Balance Register Estimates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-item-post-request"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.
• ObjectVersionNumber: integer (int32)
  The object version number updated after every update of a subscription balance 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.
• 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.

{
    "type":"object",
    "properties":{
        "AllowanceGrantNumber":{
            "title":"Allowance Grant Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register allowance grant number of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TerminatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated amount of the subscription balance register allowance grants.",
            "nullable":true
        },
        "RemainingQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ConsumedAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the allowance grant ends.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true
        },
        "ConsumedQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance allowance grants.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "TerminatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated quantity of the subscription balance register allowance grants.",
            "nullable":true
        },
        "AllowanceGrantId":{
            "type":"integer",
            "description":"The balance register allowance grant identifier of the subscription balance register allowance grants.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "GrantDate":{
            "title":"Grant Date",
            "type":"string",
            "description":"The date when the allowance is granted.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-commitments-item-post-request

Type: object

Show Source

• 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.
• 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.
• CommitmentAmount: number
  Title: Amount

  The committed amount of the subscription balance commitments.
• CommitmentQuantity: number
  Title: Quantity

  The committed quantity of the subscription balance commitments.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CommitmentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TerminatedCommitmentQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated commitment quantity of the subscription balance register commitments.",
            "nullable":true
        },
        "BalanceCommitmentNumber":{
            "title":"Commitment Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register commitment number of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RemainingCommitmentAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance commitments.",
            "format":"date",
            "nullable":true
        },
        "BalanceCommitmentId":{
            "type":"integer",
            "description":"The balance register commitment identifier of the subscription balance register commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RemainingCommitmentQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "CommitmentAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register commitment.",
            "format":"date",
            "nullable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "TerminatedCommitmentAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated commitment amount of the subscription balance register commitments.",
            "nullable":true
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-estimates-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EnableTrueupFlag":{
            "title":"Enable True-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up is enabled.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdhocAppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The ad-hoc applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EstimatedAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated amount of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AppliedRolloverQuantity":{
            "title":"Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AppliedRolloverAmount":{
            "title":"Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RolloverRemainingQuantity":{
            "title":"Rollover Remaining Quantity",
            "type":"number",
            "description":"The rollover remaining quantity of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceEstimateId":{
            "type":"integer",
            "description":"The balance register estimate identifier of the subscription balance register estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "RolloverUsageQuantity":{
            "title":"Rollover Usage Quantity",
            "type":"number",
            "description":"The rollover usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TerminatedEstimatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register estimate.",
            "format":"date",
            "nullable":true
        },
        "AdjustedEstimatedQuantity":{
            "title":"Adjusted Estimated Quantity",
            "type":"number",
            "description":"The adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdhocAdjustedEstimatedQuantity":{
            "title":"Ad-hoc Adjusted Estimated Quantity",
            "type":"number",
            "description":"The ad-hoc adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance estimates.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EstimatedQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The estimated quantity of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdjustedUsageAmount":{
            "title":"Adjusted Usage Amount",
            "type":"number",
            "description":"The adjusted usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdjustedEstimatedAmount":{
            "title":"Adjusted Estimated Amount",
            "type":"number",
            "description":"The adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverRemainingAmount":{
            "title":"Rollover Remaining Amount",
            "type":"number",
            "description":"The rollover remaining amount of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true
        },
        "BalanceEstimateNumber":{
            "title":"Estimate Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register estimate number of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "RolloverUsageAmount":{
            "title":"Rollover Usage Amount",
            "type":"number",
            "description":"The rollover usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            }
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "trueupEstimates":{
            "title":"Subscription Balance Register Estimate True-Up",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-post-request"
            }
        },
        "TerminatedEstimatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdjustedUsageQuantity":{
            "title":"Adjusted Usage Quantity",
            "type":"number",
            "description":"The adjusted usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "AdhocAdjustedEstimatedAmount":{
            "title":"Ad-hoc Adjusted Estimated Amount",
            "type":"number",
            "description":"The ad-hoc adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "AdhocAppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The ad-hoc applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        }
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-post-request

{
    "title":"Subscription Balance Register Estimate True-Up",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-post-request"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-post-request

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EstimatedAmount":{
            "title":"Prorated Estimated Amount",
            "type":"number",
            "description":"The actual estimated amount of true up estimate.",
            "nullable":true
        },
        "AppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of true-up estimate.",
            "nullable":true
        },
        "AppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of true-up estimate.",
            "nullable":true
        },
        "TrueupReasonDescription":{
            "title":"Reason Description",
            "maxLength":"120",
            "type":"string",
            "description":"The true up reason description of true up estimate.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The actual currency code of true up estimate.",
            "nullable":true
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining estimated quantity of true-up estimate.",
            "nullable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true up status of true-up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining estimated amount of true-up estimate.",
            "nullable":true
        },
        "TrueupDate":{
            "title":"Date",
            "type":"string",
            "description":"The true up date of true up estimate.",
            "format":"date",
            "nullable":true
        },
        "TrueupHoldFlag":{
            "title":"Hold true-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up hold is enabled.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a true up estimate.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The actual usage amount of true up estimate.",
            "nullable":true
        },
        "TrueupEstimateId":{
            "type":"integer",
            "description":"The true up estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EstimatedQuantity":{
            "title":"Prorated Estimated Quantity",
            "type":"number",
            "description":"The actual estimated quantity of true up estimate.",
            "nullable":true
        },
        "OverrideEstimatedQuantity":{
            "title":"Override Estimated Quantity",
            "type":"number",
            "description":"The override estimated quantity of true-up estimate.",
            "nullable":true
        },
        "TrueupType":{
            "title":"True-Up Type",
            "maxLength":"30",
            "type":"string",
            "description":"The true up type of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TrueupEstimateNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The true up estimate number of true up estimate.",
            "nullable":false
        },
        "OverrideUsageAmount":{
            "title":"Override Consumed Amount",
            "type":"number",
            "description":"The override usage amount of true up estimate.",
            "nullable":true
        },
        "TrueupReason":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The true up reason of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OverrideUsageQuantity":{
            "title":"Override Consumed Quantity",
            "type":"number",
            "description":"The override usage quantity of true up estimate.",
            "nullable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true up amount of true-up estimate.",
            "nullable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of true up estimate.",
            "nullable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The actual usage quantity of true up estimate.",
            "nullable":true
        },
        "ParentEstimateId":{
            "type":"integer",
            "description":"The parent estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            }
        },
        "OverrideEstimatedAmount":{
            "title":"Override Estimated Amount",
            "type":"number",
            "description":"The override estimated amount of true up estimate.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionBalanceRegisters-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date of creation of the subscription balance registers.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingOffsetDays":{
            "title":"Offset",
            "type":"integer",
            "description":"The billing offset day of the subscription balance registers.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "BalanceProfileName":{
            "title":"Profile Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile name of the subscription balance registers.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "registerAllowances":{
            "title":"Subscription Balance Register Allowance Grants",
            "type":"array",
            "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerAllowances-item-response"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance registers.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BalanceRegisterNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register number of the subscription balance registers.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterfaceOffsetDays":{
            "title":"Billing Interface Offset Days",
            "type":"integer",
            "description":"The interface offset day of the subscription balance registers.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the subscription balance registers.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceProfileNumber":{
            "title":"Profile Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile number of the subscription balance registers.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "title":"Invoicing Rule",
            "type":"integer",
            "description":"The invoice rule identifier of the subscription balance registers.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillingDateCode":{
            "title":"Billing Date",
            "maxLength":"30",
            "type":"string",
            "description":"The billing date code of the subscription balance registers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceRegisterStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription balance register.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance registers.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingFrequency":{
            "title":"Billing Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"The billing frequency of the subscription balance registers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "registerCommitments":{
            "title":"Subscription Balance Register Commitments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCommitments-item-response"
            }
        },
        "registerEstimates":{
            "title":"Subscription Balance Register Estimates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-item-response"
            }
        },
        "BillOnDay":{
            "title":"Day",
            "type":"integer",
            "description":"The bill on day of the subscription balance registers.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "profileCharges":{
            "title":"Subscription Balance Profile Charges",
            "type":"array",
            "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-profileCharges-item-response"
            }
        },
        "registerCriteria":{
            "title":"Subscription Balance Consumption Criteria",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "registerPeriods":{
            "title":"Subscription Balance Periods",
            "type":"array",
            "description":"The subscription balance register periods resource is used to view a balance register period.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-item-response"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance registers.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RegisterUpdateFlag":{
            "title":"Allow register update",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the register is enabled for update.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BillPeriodAlignDate":{
            "title":"Align Billing From",
            "type":"string",
            "description":"The bill alignment date of the subscription balance registers.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance registers was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance registers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionBalanceRegisters-profileCharges-item-response

{
    "title":"Subscription Balance Profile Charges",
    "type":"array",
    "description":"The subscription balance profile charges resource is used to view a balance profile charges.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-profileCharges-item-response"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerAllowances-item-response

{
    "title":"Subscription Balance Register Allowance Grants",
    "type":"array",
    "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerAllowances-item-response"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerCommitments-item-response

{
    "title":"Subscription Balance Register Commitments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCommitments-item-response"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerCriteria-item-response

{
    "title":"Subscription Balance Consumption Criteria",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object subscriptionBalanceRegisters-registerEstimates-item-response

{
    "title":"Subscription Balance Register Estimates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-item-response"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-item-response

{
    "title":"Subscription Balance Periods",
    "type":"array",
    "description":"The subscription balance register periods resource is used to view a balance register period.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : subscriptionBalanceRegisters-profileCharges-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance profile charge was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowanceGrantFlag":{
            "title":"Enable allowance",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the allowance grant is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "BalanceProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceProfileChargeNumber":{
            "title":"Profile Charge Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance profile charge number of the subscription balance profile charges.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription profile charge.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionId":{
            "title":"Related Charge",
            "type":"integer",
            "description":"The charge definition identifier of the related profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "AllowanceGrantFlag",
                    "CommitmentFlag",
                    "EstimateFlag"
                ]
            },
            "x-queryable":true
        },
        "RelatedChargeDefinitionCode":{
            "title":"Related Charge",
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the related profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargePeriodUnitOfMeasure":{
            "title":"Periodicity",
            "maxLength":"25",
            "type":"string",
            "description":"The charge period unit of measure of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargePeriod":{
            "title":"Periodicity",
            "maxLength":"30",
            "type":"string",
            "description":"The charge period of the subscription balance profile charges.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCaptureFlag":{
            "title":"Enable usage capture",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the usage capture is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "EstimateFlag":{
            "title":"Enable estimate",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the estimate is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "InvoicingRuleId":{
            "type":"integer",
            "description":"The invoicing rule identifier of the subscription balance profile charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance profile charges.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingFrequency":{
            "maxLength":"30",
            "type":"string",
            "description":"The billing frequency of the subscription balance profile charge.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedProfileChargeId":{
            "type":"integer",
            "description":"The balance profile charge identifier of the related charge identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommitmentFlag":{
            "title":"Enable commitment",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the commitment is enabled for a balance register profile charge.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "dependencies":[
                    "ChargeDefinitionId"
                ]
            },
            "x-queryable":true
        },
        "BalanceProfileId":{
            "type":"integer",
            "description":"The balance profile identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillingFrequencyUnitOfMeasure":{
            "title":"Billing Frequency",
            "maxLength":"25",
            "type":"string",
            "description":"The billing frequency unit of measure of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Name",
            "type":"integer",
            "description":"The balance charge definition identifier of the subscription balance profile charges.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoicingRule":{
            "title":"Invoicing Rule",
            "maxLength":"30",
            "type":"string",
            "description":"The invoicing rule of the subscription balance profile charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription profile charge was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription profile charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerAllowances-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance allowance grant was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":"300",
            "type":"string",
            "description":"The product name of the subscription balance allowance grants.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ConsumedAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance allowance grants.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerminatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated quantity of the subscription balance register allowance grants.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AllowanceGrantNumber":{
            "title":"Allowance Grant Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register allowance grant number of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription number of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance allowance grant.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated amount of the subscription balance register allowance grants.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The product number of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the allowance grant ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumedQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance allowance grant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance allowance grants.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AllowanceGrantId":{
            "type":"integer",
            "description":"The balance register allowance grant identifier of the subscription balance register allowance grants.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "GrantDate":{
            "title":"Grant Date",
            "type":"string",
            "description":"The date when the allowance is granted.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerCommitments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance commitment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":"300",
            "type":"string",
            "description":"The product name of the subscription balance register commitments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "CommitmentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TerminatedCommitmentQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated commitment quantity of the subscription balance register commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceCommitmentNumber":{
            "title":"Commitment Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register commitment number of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RemainingCommitmentAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCommitmentId":{
            "type":"integer",
            "description":"The balance register commitment identifier of the subscription balance register commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge",
            "maxLength":"80",
            "type":"string",
            "description":"The charge definition name of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RemainingCommitmentQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CommitmentAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register commitment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance commitments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerminatedCommitmentAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated commitment amount of the subscription balance register commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance commitment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The product number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance commitments.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance commitment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance commitments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerCriteria-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance consumption criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption criterion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance consumption criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance consumption criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "subscriptionBalancePredicates":{
            "title":"Subscription Balance Consumption Predicates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-response"
            }
        },
        "BalanceCriteriaStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the subscription balance consumption criterion.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceCriteriaNumber":{
            "title":"Criteria",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption criterion.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCriteriaDescription":{
            "title":"Description",
            "maxLength":"300",
            "type":"string",
            "description":"The description of subscription balance consumption criterion.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance consumption criterion.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BalanceCriteriaUsage":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The usage condition of subscription balance consumption criterion.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance consumption criterion was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance consumption criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-response

{
    "title":"Subscription Balance Consumption Predicates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-response"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerCriteria-subscriptionBalancePredicates-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance consumption predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCriteriaId":{
            "type":"integer",
            "description":"The balance criteria identifier of subscription balance consumption predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalancePredicateSortBy":{
            "title":"Sort Order",
            "maxLength":"30",
            "type":"string",
            "description":"The sort by criterion of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance consumption predicate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance consumption predicate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalancePredicateDateValue":{
            "title":"Value",
            "type":"string",
            "description":"The balance predicate date value of subscription balance consumption predicate.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The balance predicate sequence of the subscription balance consumption predicate.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalanceObjectName":{
            "title":"Object Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance object name of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BalanceObjectId":{
            "type":"integer",
            "description":"The balance object identifier of subscription balance consumption predicate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalancePredicateOperator":{
            "title":"Operator",
            "maxLength":"30",
            "type":"string",
            "description":"The operator value of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the subscription balance consumption predicate.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BalancePredicateCharacterValue":{
            "title":"Value",
            "maxLength":"600",
            "type":"string",
            "description":"The balance predicate character value of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateNumberValue":{
            "title":"Value",
            "type":"integer",
            "description":"The number value of the subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "BalancePredicateId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption predicate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalancePredicateTimeValue":{
            "title":"Value",
            "type":"string",
            "description":"The time value of the subscription balance consumption predicate.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalancePredicateNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number of the subscription balance consumption predicate.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceAttributeName":{
            "title":"Attribute Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the subscription balance consumption attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the subscription balance consumption attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance consumption predicate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance consumption predicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalancePredicateDecimalValue":{
            "title":"Value",
            "type":"number",
            "description":"The balance predicate decimal value of subscription balance consumption predicate.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceAttributeName",
                    "BalanceObjectName"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerEstimates-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance estimate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableTrueupFlag":{
            "title":"Enable True-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up is enabled.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":"300",
            "type":"string",
            "description":"The product name of the subscription balance register estimates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated amount of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AppliedRolloverQuantity":{
            "title":"Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AppliedRolloverAmount":{
            "title":"Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RolloverRemainingQuantity":{
            "title":"Rollover Remaining Quantity",
            "type":"number",
            "description":"The rollover remaining quantity of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance estimates.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The estimated quantity of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance estimate.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustedUsageAmount":{
            "title":"Adjusted Usage Amount",
            "type":"number",
            "description":"The adjusted usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "AdjustedEstimatedAmount":{
            "title":"Adjusted Estimated Amount",
            "type":"number",
            "description":"The adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The product number of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "RolloverRemainingAmount":{
            "title":"Rollover Remaining Amount",
            "type":"number",
            "description":"The rollover remaining amount of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverUsageAmount":{
            "title":"Rollover Usage Amount",
            "type":"number",
            "description":"The rollover usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "trueupEstimates":{
            "title":"Subscription Balance Register Estimate True-Up",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-response"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance estimates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The ad-hoc applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceEstimateId":{
            "type":"integer",
            "description":"The balance register estimate identifier of the subscription balance register estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverUsageQuantity":{
            "title":"Rollover Usage Quantity",
            "type":"number",
            "description":"The rollover usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge",
            "maxLength":"80",
            "type":"string",
            "description":"The charge definition name of the subscription balance estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminatedEstimatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register estimate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance estimates.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "AdjustedEstimatedQuantity":{
            "title":"Adjusted Estimated Quantity",
            "type":"number",
            "description":"The adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAdjustedEstimatedQuantity":{
            "title":"Ad-hoc Adjusted Estimated Quantity",
            "type":"number",
            "description":"The ad-hoc adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription number of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceEstimateNumber":{
            "title":"Estimate Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register estimate number of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TerminatedEstimatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdjustedUsageQuantity":{
            "title":"Adjusted Usage Quantity",
            "type":"number",
            "description":"The adjusted usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAdjustedEstimatedAmount":{
            "title":"Ad-hoc Adjusted Estimated Amount",
            "type":"number",
            "description":"The ad-hoc adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The ad-hoc applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance estimates was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-response

{
    "title":"Subscription Balance Register Estimate True-Up",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-response"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerEstimates-trueupEstimates-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the true up estimate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Prorated Estimated Amount",
            "type":"number",
            "description":"The actual estimated amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "AppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "AppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupReasonDescription":{
            "title":"Reason Description",
            "maxLength":"120",
            "type":"string",
            "description":"The true up reason description of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The actual currency code of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining estimated quantity of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true up status of true-up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining estimated amount of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupDate":{
            "title":"Date",
            "type":"string",
            "description":"The true up date of true up estimate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupHoldFlag":{
            "title":"Hold true-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up hold is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a true up estimate.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The actual usage amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the true up estimate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrueupEstimateId":{
            "type":"integer",
            "description":"The true up estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Prorated Estimated Quantity",
            "type":"number",
            "description":"The actual estimated quantity of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the true up estimate",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideEstimatedQuantity":{
            "title":"Override Estimated Quantity",
            "type":"number",
            "description":"The override estimated quantity of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupType":{
            "title":"True-Up Type",
            "maxLength":"30",
            "type":"string",
            "description":"The true up type of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TrueupEstimateNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The true up estimate number of true up estimate.",
            "nullable":false,
            "x-queryable":true
        },
        "OverrideUsageAmount":{
            "title":"Override Consumed Amount",
            "type":"number",
            "description":"The override usage amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupReason":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The true up reason of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideUsageQuantity":{
            "title":"Override Consumed Quantity",
            "type":"number",
            "description":"The override usage quantity of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true up amount of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The actual usage quantity of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEstimateId":{
            "type":"integer",
            "description":"The parent estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverrideEstimatedAmount":{
            "title":"Override Estimated Amount",
            "type":"number",
            "description":"The override estimated amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the true up estimate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the true up estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "commitments":{
            "title":"Subscription Balance Register Commitments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-commitments-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance register periods.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance register periods.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance register periods.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register periods.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance criterion.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance register periods.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "allowanceGrants":{
            "title":"Subscription Balance Register Allowance Grants",
            "type":"array",
            "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance criterion was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "estimates":{
            "title":"Subscription Balance Register Estimates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-item-response"
            }
        }
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response

{
    "title":"Subscription Balance Register Allowance Grants",
    "type":"array",
    "description":"The subscription balance register allowance grants resource is used to view a balance register allowance grant.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-commitments-item-response

{
    "title":"Subscription Balance Register Commitments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-commitments-item-response"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-estimates-item-response

{
    "title":"Subscription Balance Register Estimates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-allowanceGrants-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance allowance grant was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":"300",
            "type":"string",
            "description":"The product name of the subscription balance allowance grants.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ConsumedAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance allowance grants.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerminatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated quantity of the subscription balance register allowance grants.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AllowanceGrantNumber":{
            "title":"Allowance Grant Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register allowance grant number of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance allowance grants.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription number of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance allowance grant.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated amount of the subscription balance register allowance grants.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"The amount of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"The quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The product number of the subscription balance allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the allowance grant ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the subscription balance register allowance grants.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register allowance grants.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumedQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance allowance grants.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance allowance grants.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance allowance grant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance allowance grants.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AllowanceGrantId":{
            "type":"integer",
            "description":"The balance register allowance grant identifier of the subscription balance register allowance grants.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "GrantDate":{
            "title":"Grant Date",
            "type":"string",
            "description":"The date when the allowance is granted.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-commitments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance commitment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":"300",
            "type":"string",
            "description":"The product name of the subscription balance register commitments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "CommitmentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TerminatedCommitmentQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated commitment quantity of the subscription balance register commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceCommitmentNumber":{
            "title":"Commitment Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register commitment number of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RemainingCommitmentAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceCommitmentId":{
            "type":"integer",
            "description":"The balance register commitment identifier of the subscription balance register commitments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge",
            "maxLength":"80",
            "type":"string",
            "description":"The charge definition name of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RemainingCommitmentQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining committed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CommitmentAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The committed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register commitment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance commitments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TerminatedCommitmentAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated commitment amount of the subscription balance register commitments.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance commitment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The product number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register commitments.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance commitments.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register commitments.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the subscription balance register commitments.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register commitment.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance commitments.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance commitments.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance commitment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance commitments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-estimates-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance estimate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionStartDate":{
            "title":"Subscription Start Date",
            "type":"string",
            "description":"The subscription start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EnableTrueupFlag":{
            "title":"Enable True-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up is enabled.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductName":{
            "title":"Product Name",
            "maxLength":"300",
            "type":"string",
            "description":"The product name of the subscription balance register estimates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated amount of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AppliedRolloverQuantity":{
            "title":"Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AppliedRolloverAmount":{
            "title":"Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Customer",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodId":{
            "type":"integer",
            "description":"The balance register period identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RolloverRemainingQuantity":{
            "title":"Rollover Remaining Quantity",
            "type":"number",
            "description":"The rollover remaining quantity of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true-up status of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The consumed amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverEndDate":{
            "title":"Rollover End Date",
            "type":"string",
            "description":"The rollover end date of the subscription balance estimates.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The estimated quantity of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance estimate.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductEndDate":{
            "title":"Product End Date",
            "type":"string",
            "description":"The product end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustedUsageAmount":{
            "title":"Adjusted Usage Amount",
            "type":"number",
            "description":"The adjusted usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "title":"Subscription Product PUID",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription product PUID of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "AdjustedEstimatedAmount":{
            "title":"Adjusted Estimated Amount",
            "type":"number",
            "description":"The adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceRegisterPeriodNumber":{
            "title":"Register Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register period number of the subscription balance estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The product number of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "RolloverRemainingAmount":{
            "title":"Rollover Remaining Amount",
            "type":"number",
            "description":"The rollover remaining amount of subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProductStartDate":{
            "title":"Product Start Date",
            "type":"string",
            "description":"The product start date of the subscription balance register estimates.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionEndDate":{
            "title":"Subscription End Date",
            "type":"string",
            "description":"The subscription end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverUsageAmount":{
            "title":"Rollover Usage Amount",
            "type":"number",
            "description":"The rollover usage amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "trueupEstimates":{
            "title":"Subscription Balance Register Estimate True-Up",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-response"
            }
        },
        "BalanceRegisterId":{
            "type":"integer",
            "description":"The balance register identifier of the subscription balance estimates.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the subscription balance estimates.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The ad-hoc applied rollover quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "BalanceEstimateId":{
            "type":"integer",
            "description":"The balance register estimate identifier of the subscription balance register estimates.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceCode":{
            "title":"Balance Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RolloverUsageQuantity":{
            "title":"Rollover Usage Quantity",
            "type":"number",
            "description":"The rollover usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge",
            "maxLength":"80",
            "type":"string",
            "description":"The charge definition name of the subscription balance estimates.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminatedEstimatedQuantity":{
            "title":"Terminated Quantity",
            "type":"number",
            "description":"The terminated estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupDate":{
            "title":"True-Up Date",
            "type":"string",
            "description":"The true-up date of the subscription balance register estimate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a subscription balance estimates.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"9"
            },
            "x-queryable":true
        },
        "AdjustedEstimatedQuantity":{
            "title":"Adjusted Estimated Quantity",
            "type":"number",
            "description":"The adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAdjustedEstimatedQuantity":{
            "title":"Ad-hoc Adjusted Estimated Quantity",
            "type":"number",
            "description":"The ad-hoc adjusted estimated quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":"120",
            "type":"string",
            "description":"The subscription number of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the subscription balance register estimates.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the subscription balance register estimates.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "="
                ]
            },
            "x-queryable":true
        },
        "BalanceEstimateNumber":{
            "title":"Estimate Period Number",
            "maxLength":"120",
            "type":"string",
            "description":"The balance register estimate number of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true-up amount of the subscription balance register estimate.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of the subscription balance register estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The consumed quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "TerminatedEstimatedAmount":{
            "title":"Terminated Amount",
            "type":"number",
            "description":"The terminated estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdjustedUsageQuantity":{
            "title":"Adjusted Usage Quantity",
            "type":"number",
            "description":"The adjusted usage quantity of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAdjustedEstimatedAmount":{
            "title":"Ad-hoc Adjusted Estimated Amount",
            "type":"number",
            "description":"The ad-hoc adjusted estimated amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "AdhocAppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The ad-hoc applied rollover amount of the subscription balance estimates.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance estimates was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-response

{
    "title":"Subscription Balance Register Estimate True-Up",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-response"
    }
}

Nested Schema : subscriptionBalanceRegisters-registerPeriods-estimates-trueupEstimates-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the true up estimate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Prorated Estimated Amount",
            "type":"number",
            "description":"The actual estimated amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "AppliedRolloverQuantity":{
            "title":"Ad-hoc Applied Rollover Quantity",
            "type":"number",
            "description":"The applied rollover quantity of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "AppliedRolloverAmount":{
            "title":"Ad-hoc Applied Rollover Amount",
            "type":"number",
            "description":"The applied rollover amount of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupReasonDescription":{
            "title":"Reason Description",
            "maxLength":"120",
            "type":"string",
            "description":"The true up reason description of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The actual currency code of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingEstimatedQuantity":{
            "title":"Remaining Quantity",
            "type":"number",
            "description":"The remaining estimated quantity of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupStatus":{
            "title":"True-Up Status",
            "maxLength":"30",
            "type":"string",
            "description":"The true up status of true-up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RemainingEstimatedAmount":{
            "title":"Remaining Amount",
            "type":"number",
            "description":"The remaining estimated amount of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupDate":{
            "title":"Date",
            "type":"string",
            "description":"The true up date of true up estimate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupHoldFlag":{
            "title":"Hold true-up",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the true up hold is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number updated after every update of a true up estimate.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ActualUsageAmount":{
            "title":"Consumed Amount",
            "type":"number",
            "description":"The actual usage amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the true up estimate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrueupEstimateId":{
            "type":"integer",
            "description":"The true up estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EstimatedQuantity":{
            "title":"Prorated Estimated Quantity",
            "type":"number",
            "description":"The actual estimated quantity of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the true up estimate",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideEstimatedQuantity":{
            "title":"Override Estimated Quantity",
            "type":"number",
            "description":"The override estimated quantity of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupType":{
            "title":"True-Up Type",
            "maxLength":"30",
            "type":"string",
            "description":"The true up type of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TrueupEstimateNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The true up estimate number of true up estimate.",
            "nullable":false,
            "x-queryable":true
        },
        "OverrideUsageAmount":{
            "title":"Override Consumed Amount",
            "type":"number",
            "description":"The override usage amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupReason":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"The true up reason of true up estimate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OverrideUsageQuantity":{
            "title":"Override Consumed Quantity",
            "type":"number",
            "description":"The override usage quantity of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "TrueupAmount":{
            "title":"True-Up Amount",
            "type":"number",
            "description":"The true up amount of true-up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityUnitOfMeasure":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The quantity unit of measure of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualUsageQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"The actual usage quantity of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentEstimateId":{
            "type":"integer",
            "description":"The parent estimate identifier of true up estimate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverrideEstimatedAmount":{
            "title":"Override Estimated Amount",
            "type":"number",
            "description":"The override estimated amount of true up estimate.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the true up estimate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the true up estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

activate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/action/activate

Parameters:

• BalanceRegisterNumber: $request.path.BalanceRegisterNumber

The method is used to activate a balance register.

profileCharges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/profileCharges

Parameters:

• BalanceRegisterNumber: $request.path.BalanceRegisterNumber

The subscription balance profile charges resource is used to view a balance profile charges.

registerAllowances

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerAllowances

Parameters:

• BalanceRegisterNumber: $request.path.BalanceRegisterNumber

The subscription balance register allowance grants resource is used to view a balance register allowance grant.

registerCommitments

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/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.

registerCriteria

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/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.

registerEstimates

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/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.

registerPeriods

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceRegisters/{BalanceRegisterNumber}/child/registerPeriods

Parameters:

• BalanceRegisterNumber: $request.path.BalanceRegisterNumber

The subscription balance register periods resource is used to view a balance register period.

Back to Top