1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscription Balance Codes

Get all balance codes

get

/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • BalanceCodeAltKey Finds the subscription balance codes with the specific balance code alternative key.
      Finder Variables
      • BalanceCode; string; The unique balance code of the subscription balance codes.
    • PrimaryKey Finds the subscription balance codes with the specified primary key.
      Finder Variables
      • BalanceCodeId; integer; The unique balance code identifier of the subscription balance codes used to find it.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BalanceCode; string; The balance code of the subscription balance.
    • BalanceCodeDescription; string; The balance code description of the subscription balance code.
    • BalanceCodeId; integer; The balance code identifier of the subscription balance.
    • BalanceCodeStatus; string; The status of subscription balance code.
    • BalanceCodeType; string; The balance code type of the subscription balance code.
    • BalanceCurrencyCode; string; The currency code for the amount based subscription balance code.
    • BalanceUnitofMeasureCode; string; The code of measuring unit of the subscription balance criteria.
    • CreatedBy; string; The user who created the subscription balance code.
    • CreationDate; string; The date when the subscription balance code was created.
    • LastUpdateDate; string; The date when the subscription balance code was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the subscription balance code.
    • LastUpdatedBy; string; The user who has last updated the subscription balance code.
    • ObjectVersionNumber; integer; The version number of subscription balance code.
    • PrecisionFactor; number; The precision factor of the subscription balance code.
    • PrecisionType; string; The precision type of the subscription balance code.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : subscriptionBalanceCodes-item-response
Type: object
Show Source
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
Nested Schema : Subscription Balance Consumption Criteria
Type: array
Title: Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : Subscription Balance Consumption Criteria
Type: array
Title: Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionBalanceCodes-balanceCodeCharges-item-response
Type: object
Show Source
Nested Schema : subscriptionBalanceCodes-conditionCriteria-item-response
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type: array
Title: Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionBalanceCodes-conditionCriteria-subscriptionBalancePredicates-item-response
Type: object
Show Source
Nested Schema : subscriptionBalanceCodes-consumptionCriteria-item-response
Type: object
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type: array
Title: Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : subscriptionBalanceCodes-consumptionCriteria-subscriptionBalancePredicates-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all balance codes by submitting a GET request on the REST resource.

cURL Command

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

Example of Response Body

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

{
    "items": [
        {
            "BalanceCodeId": 300100570194504,
            "BalanceCode": "Gold Balance Code_27Feb1",
            "BalanceCodeDescription": "balance code with Inline criteria",
            "BalanceCodeStatus": "ORA_OSS_DRAFT",
            "ConsumptionCriteriaId": 300100570194509,
            "ChargeDefinitionCode": null,
            "ChargeDefinitionId": null,
            "PrecisionType": null,
            "PrecisionFactor": null,
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2023-02-27T10:14:23+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2023-02-27T10:14:53.376+00:00",
            "LastUpdateLogin": "F5A7821916E045AEE053B4A74564ABC7",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1",
                    "name": "subscriptionBalanceCodes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1",
                    "name": "subscriptionBalanceCodes",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/child/balanceCodeCharges",
                    "name": "balanceCodeCharges",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/child/conditionCriteria",
                    "name": "conditionCriteria",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/child/consumptionCriteria",
                    "name": "consumptionCriteria",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/action/activate",
                    "name": "activate",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_27Feb1/action/deActivate",
                    "name": "deActivate",
                    "kind": "other"
                }
            ]
        },
        {
            "BalanceCodeId": 300100570178614,
            "BalanceCode": "Gold Balance Code_6",
            "BalanceCodeDescription": "balance code with Inline criteria",
            "BalanceCodeStatus": "ORA_OSS_ACTIVE",
            "ConsumptionCriteriaId": 300100570178618,
            "ChargeDefinitionCode": null,
            "ChargeDefinitionId": null,
            "PrecisionType": null,
            "PrecisionFactor": null,
            "ObjectVersionNumber": 1,
            "CreatedBy": "CONMGR",
            "CreationDate": "2023-02-24T21:35:27+00:00",
            "LastUpdatedBy": "CONMGR",
            "LastUpdateDate": "2023-02-24T21:39:33.983+00:00",
            "LastUpdateLogin": "F575378765673540E053B4A74564AA99",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/Gold%20Balance%20Code_6",
                    "name": "subscriptionBalanceCodes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
...
}
Back to Top