1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Rate Tables

Get all rate table details

get

/fscmRestApi/resources/11.13.18.05/rateTables

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:

    • PrimaryKey: Finds the rate table by RateTableId.
      Finder Variables:
      • RateTableId; integer; The unique identifier for the rate table.
  • 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:
    • CreatedBy; string; The user who created the rate table record.
    • CreationDate; string; The date and time when the rate table record was created.
    • Description; string; The additional details added by the user related to rate tables.
    • DisplayName; string; The optional name of the rate table that is shown to the sales representative's user interface to represent this rate table.
    • LastUpdateDate; string; The date when the rate table record was last updated.
    • LastUpdateLogin; string; The session login associated with the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the rate table record.
    • Name; string; The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.
    • NumberDim; integer; The number of dimensions in the rate table. Default value is 0.
    • OrgId; integer; The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance.
    • RateTableId; integer; The unique identifier for the rate table.
    • RateTableType; string; The lookup code that represents the nature of rates in the rate table, such as a percentage and amount. Possible values include AMOUNT and PERCENT. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_COMMISSION_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • 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 : rateTables
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : rateTables-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the rate table record.
  • Title: Creation Date
    Read Only: true
    The date and time when the rate table record was created.
  • Title: Description
    Maximum Length: 1000
    The additional details added by the user related to rate tables.
  • Title: Display Name
    Maximum Length: 80
    The optional name of the rate table that is shown to the sales representative's user interface to represent this rate table.
  • Title: Last Updated Date
    Read Only: true
    The date when the rate table record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the rate table record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the record.
  • Links
  • Title: Name
    Maximum Length: 80
    The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.
  • Title: Number of Dimensions
    Read Only: true
    Default Value: 0
    The number of dimensions in the rate table. Default value is 0.
  • Title: Business Unit
    The unique identifier of the business unit. The value can be updated from a list of acceptable values in the Manage Business Units task in Setup and Maintenance.
  • Rate Table Dimensions
    Title: Rate Table Dimensions
    The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.
  • Read Only: true
    The unique identifier for the rate table.
  • Rate Table Rates
    Title: Rate Table Rates
    The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.
  • Title: Type
    Maximum Length: 30
    Default Value: AMOUNT
    The lookup code that represents the nature of rates in the rate table, such as a percentage and amount. Possible values include AMOUNT and PERCENT. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_COMMISSION_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Rate Table Dimensions
Type: array
Title: Rate Table Dimensions
The rate table - dimensions resource is used to create, update, or delete the association of dimensions to a rate table. It can also be used to display all details of the dimensions in a rate table. You can only add up to ten rate dimensions to a rate table using REST Services.
Show Source
Nested Schema : Rate Table Rates
Type: array
Title: Rate Table Rates
The rate table rates resource is used to create, view, or update the rates for a rate table or a scorecard. It can also be used to display all the rates of a rate table or a scorecard. You can only create rates with non-zero values.
Show Source
Nested Schema : rateTables-RateTableDimensions-item-response
Type: object
Show Source
Nested Schema : Rate Dimensions Tiers
Type: array
Title: Rate Dimensions Tiers
The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.
Show Source
Nested Schema : rateTables-RateTableDimensions-RateTableDimensionTiers-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the record.
  • Links
  • Title: To
    The maximum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the maximum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the maximum amount is 20%, then 20 is maximum amount value.
  • Title: To
    The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.
  • Title: To
    Read Only: true
    The name of the maximum expression.
  • Title: From
    The minimum amount of the rate tier. This attribute is only used when the rate dimension type is set as amount or percent. If the rate dimension type is percent, then the minimum amount stored here needs to be divided by 100 to get the actual value. For example, if the rate dimension is percent and the minimum amount is 10%, then 10 is the minimum amount value.
  • Title: From
    The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.
  • Title: From
    Read Only: true
    The name of the minimum expression.
  • The unique identifier of a rate dimension.
  • Read Only: true
    The unique identifier of a rate dimension tier.
  • Read Only: true
    Maximum Length: 255
    Indicates whether the rate table dimension tiers record can be deleted using this service.
  • Read Only: true
    Maximum Length: 255
    Indicates whether the rate table dimension tiers record can be updated using this service.
  • Title: String
    Maximum Length: 30
    The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.
  • Title: Sequence
    Read Only: true
    The specified order of a tier within a rate dimension.
Nested Schema : rateTables-RateTableRates-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date and time when the record was created.
  • Read Only: true
    The date and time when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The session login associated with the user who last updated the record.
  • Links
  • The unique identifier of the business unit. You can update this value from a list of acceptable values in the Manage Business Units task in Setup and Maintenance work area.
  • Title: Rate
    The output value of the rate table, which can be used to calculate the earning rate or the attainment rate. This value could be a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.
  • The unique identifier of the tenth rate dimension record associated with the rate value. This value will only be filled if the rate table has 10 rate dimensions.
  • The unique identifier of the tenth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 10 rate dimensions.
  • The unique identifier of the first rate dimension record associated with the rate value.
  • The unique identifier of the first rate dimension tier associated with the rate value.
  • The unique identifier of the second rate dimension record associated with the rate value. This value will only be filled if the rate table has 2 or more rate dimensions.
  • The unique identifier of the second rate dimension tier associated with the rate value. This value will only be filled if this rate table has 2 or more rate dimensions.
  • The unique identifier of the third rate dimension record associated with the rate value. This value will only be filled if the rate table has 3 or more rate dimensions.
  • The unique identifier of the third rate dimension tier associated with the rate value. This value will only be filled if this rate table has 3 or more rate dimensions.
  • The unique identifier of the fourth rate dimension record associated with the rate value. This value will only be filled if the rate table has 4 or more rate dimensions.
  • The unique identifier of the fourth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 4 or more rate dimensions.
  • The unique identifier of the fifth rate dimension record associated with the rate value. This value will only be filled if the rate table has 5 or more rate dimensions.
  • The unique identifier of the fifth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 5 or more rate dimensions.
  • The unique identifier of the sixth rate dimension record associated with the rate value. This value will only be filled if the rate table has 6 or more rate dimensions.
  • The unique identifier of the sixth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 6 or more rate dimensions.
  • The unique identifier of the seventh rate dimension record associated with the rate value. This value will only be filled if the rate table has 7 or more rate dimensions.
  • The unique identifier of the seventh rate dimension tier associated with the rate value. This value will only be filled if this rate table has 7 or more rate dimensions.
  • The unique identifier of the eighth rate dimension record associated with the rate value. This value will only be filled if the rate table has 8 or more rate dimensions.
  • The unique identifier of the eighth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 8 or more rate dimensions.
  • The unique identifier of the ninth rate dimension record associated with the rate value. This value will only be filled if the rate table has 9 or more rate dimensions.
  • The unique identifier of the ninth rate dimension tier associated with the rate value. This value will only be filled if this rate table has 9 or more rate dimensions.
  • The unique identifier of the rate table.
  • Title: Number of Dimensions
    The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.
  • Read Only: true
    The unique identifier of the rate table value.
  • Read Only: true
    Maximum Length: 255
    Indicates that the rate table rates record cannot be deleted using this service.
Back to Top

Examples

The following example shows how to get all rate tables by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables

Example of Response Body

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

{
  "items": [
    {
      "RateTableId": 300100007837032,
      "Name": "QA rate table for scenario 800",
      "Description": "0 -30\t1000\t1500\n30-50\t2000\t2500\n50-75\t3000\t3500\n75-100\t4000\t4500\n100 and above\t5000\t5500\n",
      "OrgId": 204,
      "NumberDim": 2,
      "DisplayName": "QA rate table for scenario 800",
      "RateTableType": "AMOUNT",
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2012-04-23T23:38:37-07:00",
      "LastUpdateDate": "2012-04-23T23:40:42.897-07:00",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "LastUpdateLogin": "BE55AD2BE2450B7DE0432220F00A4B43",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032",
          "name": "rateTables",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032",
          "name": "rateTables",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032/lov/CnLookupRateTableTypeVO",
          "name": "CnLookupRateTableTypeVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032/lov/BusinessUnitPVO",
          "name": "BusinessUnitPVO",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100007837032/child/RateTableDimensions",
          "name": "RateTableDimensions",
          "kind": "collection"
        }
      ]
    },
    {
      "RateTableId": 300100011436041,
      "Name": "CN Percent Amount RT 20120828104114",
      "Description": null,
      "OrgId": 204,
      "NumberDim": 1,
      "DisplayName": "CN Percent Amount RT 20120828104114",
      "RateTableType": "AMOUNT",
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2012-08-28T04:27:46-07:00",
      "LastUpdateDate": "2012-08-28T04:28:02.108-07:00",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "LastUpdateLogin": "C852B7EF4A7E6C14E0432620F00A588D",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100011436041",
          "name": "rateTables",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100011436041",
          "name": "rateTables",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100011436041/lov/CnLookupRateTableTypeVO",
          "name": "CnLookupRateTableTypeVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100011436041/lov/BusinessUnitPVO",
          "name": "BusinessUnitPVO",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100011436041/child/RateTableDimensions",
          "name": "RateTableDimensions",
          "kind": "collection"
        }
      ]
    },


   . . . 


    {
      "RateTableId": 300100010640012,
      "Name": "CN Percent Amount RT 20120530060025",
      "Description": null,
      "OrgId": 204,
      "NumberDim": 1,
      "DisplayName": "CN Percent Amount RT 20120530060025",
      "RateTableType": "AMOUNT",
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2012-05-29T23:46:02-07:00",
      "LastUpdateDate": "2012-05-29T23:46:18.500-07:00",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "LastUpdateLogin": "C13C2DD4B3337F8FE0432620F00A3236",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100010640012",
          "name": "rateTables",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100010640012",
          "name": "rateTables",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100010640012/lov/CnLookupRateTableTypeVO",
          "name": "CnLookupRateTableTypeVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100010640012/lov/BusinessUnitPVO",
          "name": "BusinessUnitPVO",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100010640012/child/RateTableDimensions",
          "name": "RateTableDimensions",
          "kind": "collection"
        }
      ]
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables",
      "name": "rateTables",
      "kind": "collection"
    }
  ]
}
Back to Top