Jump to

• Request
• Response
• Examples

Update a balance code

patch

/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}

Request

Path Parameters

• BalanceCode(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BalanceCode: string
  Title: Code

  Maximum Length: 30

  The balance code of the subscription balance.
• balanceCodeCharges: array Subscription Balance Code Charges
  Title: Subscription Balance Code Charges

  The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge
• BalanceCodeDescription: string
  Title: Name

  Maximum Length: 120

  The balance code description of the subscription balance code.
• BalanceCodeStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of subscription balance code.
• conditionCriteria: 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.
• consumptionCriteria: 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.
• ObjectVersionNumber: integer (int32)
  The version number of subscription balance code.
• PrecisionFactor: number
  Title: Rounding Factor

  The precision factor of the subscription balance code.
• PrecisionType: string
  Title: Rounding Type

  Maximum Length: 30

  The precision type of the subscription balance code.

{
    "type":"object",
    "properties":{
        "conditionCriteria":{
            "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/subscriptionBalanceCodes-conditionCriteria-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "PrecisionFactor":{
            "title":"Rounding Factor",
            "type":"number",
            "description":"The precision factor of the subscription balance code.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceCodeType"
                ]
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription balance code.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "consumptionCriteria":{
            "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/subscriptionBalanceCodes-consumptionCriteria-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "BalanceCodeStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of subscription balance code.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrecisionType":{
            "title":"Rounding Type",
            "maxLength":"30",
            "type":"string",
            "description":"The precision type of the subscription balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BalanceCodeType"
                ]
            }
        },
        "balanceCodeCharges":{
            "title":"Subscription Balance Code Charges",
            "type":"array",
            "description":"The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceCodes-balanceCodeCharges-item-patch-request"
            }
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance.",
            "nullable":false
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance code description of the subscription balance code.",
            "nullable":true
        }
    }
}

Nested Schema : Subscription Balance Code Charges

Type: array

Title: Subscription Balance Code Charges

The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge

Show Source

• Array of: object subscriptionBalanceCodes-balanceCodeCharges-item-patch-request

{
    "title":"Subscription Balance Code Charges",
    "type":"array",
    "description":"The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceCodes-balanceCodeCharges-item-patch-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 schema

{
    "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/subscriptionBalanceCodes-conditionCriteria-item-patch-request"
    },
    "x-cardinality":"1"
}

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 subscriptionBalanceCodes-consumptionCriteria-item-patch-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/subscriptionBalanceCodes-consumptionCriteria-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : subscriptionBalanceCodes-balanceCodeCharges-item-patch-request

Type: object

Show Source

• BalanceCodeId: integer (int64)
  The balance code identifier of the subscription balance code charge.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code of the subscription balance code charge.
• ChargeDefinitionId: integer (int64)
  The charge definition identifier of the subscription balance code charge.

{
    "type":"object",
    "properties":{
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription balance code charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The balance code identifier of the subscription balance code charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The charge definition identifier of the subscription balance code charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

  The description of 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.
• 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":{
        "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/subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-patch-request"
            }
        },
        "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"
            }
        },
        "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 subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-patch-request

{
    "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/subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-patch-request"
    }
}

Nested Schema : subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-patch-request

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.
• 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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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 : subscriptionBalanceCodes-consumptionCriteria-item-patch-request

Type: object

Show Source

• BalanceCriteriaDescription: string
  Title: Description

  Maximum Length: 300

  The description of 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.
• 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":{
        "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/subscriptionBalanceCodes-consumptionCriteria-subscriptionBalancePredicates-item-patch-request"
            }
        },
        "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"
            }
        },
        "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/subscriptionBalanceCodes-consumptionCriteria-subscriptionBalancePredicates-item-patch-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.
• 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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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"
                ]
            }
        }
    }
}

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 : subscriptionBalanceCodes-item-response

Type: object

Show Source

• BalanceCode: string
  Title: Code

  Maximum Length: 30

  The balance code of the subscription balance.
• balanceCodeCharges: array Subscription Balance Code Charges
  Title: Subscription Balance Code Charges

  The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge
• BalanceCodeDescription: string
  Title: Name

  Maximum Length: 120

  The balance code description of the subscription balance code.
• BalanceCodeId: integer (int64)
  The balance code identifier of the subscription balance.
• BalanceCodeStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OSS_DRAFT

  The status of subscription balance code.
• BalanceCodeType: string
  Title: Type

  Maximum Length: 30

  Default Value: ORA_OSS_QUANTITY

  The balance code type of the subscription balance code.
• BalanceCurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for the amount based subscription balance code.
• BalanceUnitofMeasureCode: string
  Title: Usage UOM

  Maximum Length: 3

  The code of measuring unit of the subscription balance criteria.
• conditionCriteria: 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.
• consumptionCriteria: 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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance code.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance code was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance code was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance code.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The version number of subscription balance code.
• PrecisionFactor: number
  Title: Rounding Factor

  The precision factor of the subscription balance code.
• PrecisionType: string
  Title: Rounding Type

  Maximum Length: 30

  The precision type of the subscription balance code.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance code was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "conditionCriteria":{
            "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/subscriptionBalanceCodes-conditionCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the subscription balance code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "consumptionCriteria":{
            "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/subscriptionBalanceCodes-consumptionCriteria-item-response"
            },
            "x-cardinality":"1"
        },
        "PrecisionType":{
            "title":"Rounding Type",
            "maxLength":"30",
            "type":"string",
            "description":"The precision type of the subscription balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BalanceCodeType"
                ]
            },
            "x-queryable":true
        },
        "balanceCodeCharges":{
            "title":"Subscription Balance Code Charges",
            "type":"array",
            "description":"The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge",
            "items":{
                "$ref":"#/components/schemas/subscriptionBalanceCodes-balanceCodeCharges-item-response"
            }
        },
        "BalanceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code of the subscription balance.",
            "nullable":false,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The balance code identifier of the subscription balance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrecisionFactor":{
            "title":"Rounding Factor",
            "type":"number",
            "description":"The precision factor of the subscription balance code.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "BalanceCodeType"
                ]
            },
            "x-queryable":true
        },
        "BalanceUnitofMeasureCode":{
            "title":"Usage UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The code of measuring unit of the subscription balance criteria.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "BalanceCodeType"
                ]
            },
            "x-queryable":true
        },
        "BalanceCurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code for the amount based subscription balance code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "BalanceCodeType"
                ]
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription balance code.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "BalanceCodeType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The balance code type of the subscription balance code.",
            "nullable":false,
            "default":"ORA_OSS_QUANTITY",
            "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"
            }
        },
        "BalanceCodeStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of subscription balance code.",
            "nullable":false,
            "default":"ORA_OSS_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance code 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 code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeDescription":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"The balance code description of the subscription balance code.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Subscription Balance Code Charges

Type: array

Title: Subscription Balance Code Charges

The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge

Show Source

• Array of: object subscriptionBalanceCodes-balanceCodeCharges-item-response

{
    "title":"Subscription Balance Code Charges",
    "type":"array",
    "description":"The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge",
    "items":{
        "$ref":"#/components/schemas/subscriptionBalanceCodes-balanceCodeCharges-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 subscriptionBalanceCodes-conditionCriteria-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/subscriptionBalanceCodes-conditionCriteria-item-response"
    },
    "x-cardinality":"1"
}

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 subscriptionBalanceCodes-consumptionCriteria-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/subscriptionBalanceCodes-consumptionCriteria-item-response"
    },
    "x-cardinality":"1"
}

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 : subscriptionBalanceCodes-balanceCodeCharges-item-response

Type: object

Show Source

• BalanceCodeChargeId: integer (int64)
  The unique identifier of subscription balance code charge.
• BalanceCodeChargeNumber: string
  Title: Number

  Maximum Length: 120

  The unique number for the subscription balance code charge.
• BalanceCodeId: integer (int64)
  The balance code identifier of the subscription balance code charge.
• ChargeDefinitionCode: string
  Title: Charge Definition

  Maximum Length: 30

  The charge definition code of the subscription balance code charge.
• ChargeDefinitionId: integer (int64)
  The charge definition identifier of the subscription balance code charge.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the subscription balance code charge.
• CreationDate: string (date-time)
  Read Only: true

  The date when the subscription balance code charge was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the subscription balance code charge was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who has last updated the subscription balance code charge.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the subscription balance code charge.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The version number of subscription balance code charge.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who has last updated the subscription balance code charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the subscription balance code charge 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 code charge.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceCodeId":{
            "type":"integer",
            "description":"The balance code identifier of the subscription balance code charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BalanceCodeChargeId":{
            "type":"integer",
            "description":"The unique identifier of subscription balance code charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The version number of subscription balance code charge.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "type":"integer",
            "description":"The charge definition identifier of the subscription balance code charge.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeDefinitionCode":{
            "title":"Charge Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The charge definition code of the subscription balance code charge.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BalanceCodeChargeNumber":{
            "title":"Number",
            "maxLength":"120",
            "type":"string",
            "description":"The unique number for the subscription balance code charge.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the subscription balance code 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 balance code 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 : 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 : subscriptionBalanceCodes-conditionCriteria-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/subscriptionBalanceCodes-conditionCriteria-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 subscriptionBalanceCodes-conditionCriteria-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/subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-response"
    }
}

Nested Schema : subscriptionBalanceCodes-conditionCriteria-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 : subscriptionBalanceCodes-consumptionCriteria-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/subscriptionBalanceCodes-consumptionCriteria-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 subscriptionBalanceCodes-consumptionCriteria-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/subscriptionBalanceCodes-consumptionCriteria-subscriptionBalancePredicates-item-response"
    }
}

Nested Schema : subscriptionBalanceCodes-consumptionCriteria-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"
    }
}

Links

BalanceCodePrecisionTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_PRECISION_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: PrecisionType; Target Attribute: LookupCode
• Display Attribute: Meaning

BalanceCodeStatusVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_MGMT_SETUP_STS

The following properties are defined on the LOV link relation:

• Source Attribute: BalanceCodeStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

activate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/action/activate

Parameters:

• BalanceCode: $request.path.BalanceCode

The method is used to activate a subscription balance code.

balanceCodeCharges

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/balanceCodeCharges

Parameters:

• BalanceCode: $request.path.BalanceCode

The subscription balance codes charges resource is used to view, create, update, and delete a balance code charge

conditionCriteria

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/conditionCriteria

Parameters:

• BalanceCode: $request.path.BalanceCode

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.

consumptionCriteria

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/consumptionCriteria

Parameters:

• BalanceCode: $request.path.BalanceCode

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.

deActivate

Operation: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/action/deActivate

Parameters:

• BalanceCode: $request.path.BalanceCode

The method is used to deactivate a subscription balance code.

Back to Top

Examples

The following example shows how to update a balance code by submitting a PATCH request on the REST resource.

cURL Command

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionBalanceCodes/Silver Balance Code 17jan_7  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "BalanceCodeDescription": "The balance code with inline criteria"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "BalanceCodeId": 300100570199607,
    "BalanceCode": "Silver Balance Code 17jan_7",
    "BalanceCodeDescription": "The balance code with inline criteria",
    "BalanceCodeStatus": "ORA_OSS_DRAFT",
    "ConsumptionCriteriaId": 300100570199610,
    "ChargeDefinitionCode": "MOBILE_CHARGE",
    "ChargeDefinitionId": 300100542702863,
    "PrecisionType": null,
    "PrecisionFactor": null,
    "ObjectVersionNumber": 2,
    "CreatedBy": "CONMGR",
    "CreationDate": "2023-02-28T12:07:21+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2023-02-28T12:13:57+00:00",
    "LastUpdateLogin": "F5BDBD9017214D2EE053B4A745641903",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7",
            "name": "subscriptionBalanceCodes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7",
            "name": "subscriptionBalanceCodes",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/child/balanceCodeCharges",
            "name": "balanceCodeCharges",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/child/conditionCriteria",
            "name": "conditionCriteria",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/child/consumptionCriteria",
            "name": "consumptionCriteria",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/action/activate",
            "name": "activate",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Silver%20Balance%20Code%2017jan_7/action/deActivate",
            "name": "deActivate",
            "kind": "other"
        }
    ]
}

Back to Top