Jump to

• Request
• Response
• Examples

Update a rate table

patch

/fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}

Request

Path Parameters

• RateTableId(required): integer(int64)
  The unique identifier for the rate table.

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

• Description: string
  Title: Description

  Maximum Length: 1000

  The additional details added by the user related to rate tables.
• DisplayName: string
  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.
• Name: string
  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.
• RateTableDimensions: array 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.
• RateTableRates: array 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.
• RateTableType: string
  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.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"80",
            "type":"string",
            "description":"The optional name of the rate table that is shown to the sales representative's user interface to represent this rate table.",
            "nullable":true
        },
        "RateTableRates":{
            "title":"Rate Table Rates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableRates-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional details added by the user related to rate tables.",
            "nullable":true
        },
        "RateTableDimensions":{
            "title":"Rate Table Dimensions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-patch-request"
            }
        },
        "RateTableType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"AMOUNT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false
        }
    }
}

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

• Array of: object rateTables-RateTableDimensions-item-patch-request

{
    "title":"Rate Table Dimensions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-patch-request"
    }
}

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

• Array of: object schema

{
    "title":"Rate Table Rates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableRates-item-patch-request"
    }
}

Nested Schema : rateTables-RateTableDimensions-item-patch-request

Type: object

Show Source

• RateTableDimensionTiers: array RateTableDimensionTiers

{
    "type":"object",
    "properties":{
        "RateTableDimensionTiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-patch-request"
            }
        }
    }
}

Nested Schema : RateTableDimensionTiers

Type: array

Show Source

• Array of: object rateTables-RateTableDimensions-RateTableDimensionTiers-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-patch-request"
    }
}

Nested Schema : rateTables-RateTableDimensions-RateTableDimensionTiers-item-patch-request

Type: object

Show Source

• MaximumAmount: number
  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.
• MaximumExpressionId: integer (int64)
  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.
• MinimumAmount: number
  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.
• MinimumExpressionId: integer (int64)
  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.
• RateDimensionId: integer (int64)
  The unique identifier of a rate dimension.
• StringValue: string
  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.

{
    "type":"object",
    "properties":{
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":"30",
            "type":"string",
            "description":"The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• OrgId: integer (int64)
  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.
• Rate: number
  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.
• RateTableId: integer (int64)
  The unique identifier of the rate table.
• RateTableNumberDim: integer
  Title: Number of Dimensions

  The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.

{
    "type":"object",
    "properties":{
        "OrgId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RateTableNumberDim":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.",
            "nullable":true,
            "x-queryable":false
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the rate table record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the rate table record was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The additional details added by the user related to rate tables.
• DisplayName: string
  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.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the rate table record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the rate table record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  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.
• NumberDim: integer (int64)
  Title: Number of Dimensions

  Read Only: true

  Default Value: 0

  The number of dimensions in the rate table. Default value is 0.
• OrgId: integer (int64)
  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.
• RateTableDimensions: array 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.
• RateTableId: integer (int64)
  Read Only: true

  The unique identifier for the rate table.
• RateTableRates: array 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.
• RateTableType: string
  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the rate table record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the rate table record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rate table record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional details added by the user related to rate tables.",
            "nullable":true,
            "x-queryable":true
        },
        "RateTableType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"AMOUNT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateTableRates":{
            "title":"Rate Table Rates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableRates-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "NumberDim":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions in the rate table. Default value is 0.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"80",
            "type":"string",
            "description":"The optional name of the rate table that is shown to the sales representative's user interface to represent this rate table.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateTableDimensions":{
            "title":"Rate Table Dimensions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-response"
            }
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier for the rate table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the rate table record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "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 : 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

• Array of: object rateTables-RateTableDimensions-item-response

{
    "title":"Rate Table Dimensions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-item-response"
    }
}

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

• Array of: object rateTables-RateTableRates-item-response

{
    "title":"Rate Table Rates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableRates-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : rateTables-RateTableDimensions-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created this record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when this record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated this record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberTier: integer (int64)
  Title: Number of Tiers

  Read Only: true

  Default Value: 0

  The number of tiers in the rate table dimension within the rate table.
• RateDimensionId: integer (int64)
  Title: Name

  The unique identifier for a rate dimension record.
• RateDimensionName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the rate dimension. A rate table can have one or more rate dimensions.
• RateDimensionType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Default Value: AMOUNT

  The unit of measurement for a rate table dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RateDimSequence: integer (int32)
  Title: Sequence

  Read Only: true

  The specified order of a rate dimension within a rate table.
• RateTableDimensionsUpdateFlag: boolean
  Read Only: true

  Indicates whether the rate table dimension can be updated.
• RateTableDimensionTiers: array Rate Dimensions Tiers
  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.
• RateTableDimId: integer (int64)
  The unique identifier for the rate table's dimension record.
• RateTableId: integer (int64)
  Title: Name

  The unique identifier for a rate table.
• RateTableName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionsUpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate table dimension can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate dimension record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimensionName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the rate dimension. A rate table can have one or more rate dimensions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionTiers":{
            "title":"Rate Dimensions Tiers",
            "type":"array",
            "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
            "items":{
                "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-response"
            }
        },
        "RateTableDimId":{
            "type":"integer",
            "description":"The unique identifier for the rate table's dimension record.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The specified order of a rate dimension within a rate table.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "NumberTier":{
            "title":"Number of Tiers",
            "type":"integer",
            "description":"The number of tiers in the rate table dimension within the rate table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimensionType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The unit of measurement for a rate table dimension. Possible values include AMOUNT, EXPRESSION, PERCENT, and STRING. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_DIM_UNIT_CODE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "RateTableId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier for a rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when this record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "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 : 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

• Array of: object rateTables-RateTableDimensions-RateTableDimensionTiers-item-response

{
    "title":"Rate Dimensions Tiers",
    "type":"array",
    "description":"The rate dimensions tiers resource is only used to view all the details of the tiers in a rate dimension of the rate table.",
    "items":{
        "$ref":"#/components/schemas/rateTables-RateTableDimensions-RateTableDimensionTiers-item-response"
    }
}

Nested Schema : rateTables-RateTableDimensions-RateTableDimensionTiers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumAmount: number
  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.
• MaximumExpressionId: integer (int64)
  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.
• MaximumExpressionName: string
  Title: To

  Read Only: true

  The name of the maximum expression.
• MinimumAmount: number
  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.
• MinimumExpressionId: integer (int64)
  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.
• MinimumExpressionName: string
  Title: From

  Read Only: true

  The name of the minimum expression.
• RateDimensionId: integer (int64)
  The unique identifier of a rate dimension.
• RateDimTierId: integer (int64)
  Read Only: true

  The unique identifier of a rate dimension tier.
• RateTableDimensionTiersDeleteFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the rate table dimension tiers record can be deleted using this service.
• RateTableDimensionTiersUpdateFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the rate table dimension tiers record can be updated using this service.
• StringValue: string
  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.
• TierSequence: integer (int32)
  Title: Sequence

  Read Only: true

  The specified order of a tier within a rate dimension.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDimensionTiersDeleteFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the rate table dimension tiers record can be deleted using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimensionId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimTierId":{
            "type":"integer",
            "description":"The unique identifier of a rate dimension tier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"To",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumExpressionId":{
            "title":"From",
            "type":"integer",
            "description":"The unique identifier of the minimum expression. This represents the rate dimension starting tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaximumExpressionId":{
            "title":"To",
            "type":"integer",
            "description":"The unique identifier of the maximum expression. This represents the rate dimension ending tier only when rate dimension type is set as Expression.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateTableDimensionTiersUpdateFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the rate table dimension tiers record can be updated using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "MinimumExpressionName":{
            "title":"From",
            "type":"string",
            "description":"The name of the minimum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The specified order of a tier within a rate dimension.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MinimumAmount":{
            "title":"From",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "StringValue":{
            "title":"String",
            "maxLength":"30",
            "type":"string",
            "description":"The alphanumeric value of a rate tier. This attribute is only used when the rate dimension type is set as string.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumExpressionName":{
            "title":"To",
            "type":"string",
            "description":"The name of the maximum expression.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "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 : rateTables-RateTableRates-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  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.
• Rate: number
  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.
• RateDimension10Id: string
  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.
• RateDimension10TierId: string
  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.
• RateDimension1Id: string
  The unique identifier of the first rate dimension record associated with the rate value.
• RateDimension1TierId: string
  The unique identifier of the first rate dimension tier associated with the rate value.
• RateDimension2Id: string
  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.
• RateDimension2TierId: string
  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.
• RateDimension3Id: string
  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.
• RateDimension3TierId: string
  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.
• RateDimension4Id: string
  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.
• RateDimension4TierId: string
  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.
• RateDimension5Id: string
  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.
• RateDimension5TierId: string
  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.
• RateDimension6Id: string
  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.
• RateDimension6TierId: string
  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.
• RateDimension7Id: string
  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.
• RateDimension7TierId: string
  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.
• RateDimension8Id: string
  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.
• RateDimension8TierId: string
  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.
• RateDimension9Id: string
  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.
• RateDimension9TierId: string
  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.
• RateTableId: integer (int64)
  The unique identifier of the rate table.
• RateTableNumberDim: integer
  Title: Number of Dimensions

  The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.
• RateTableRateId: integer (int64)
  Read Only: true

  The unique identifier of the rate table value.
• RateTableRatesDeleteFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates that the rate table rates record cannot be deleted using this service.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension3TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension1TierId":{
            "type":"string",
            "description":"The unique identifier of the first rate dimension tier associated with the rate value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateDimension1Id",
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension10Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateTableRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate table value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension10TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension4Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension6Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension8Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension5TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension7Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateTableNumberDim":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions in the rate table. The rate table REST service only supports up to 10 dimensions.",
            "nullable":true,
            "x-queryable":false
        },
        "RateDimension2Id":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1Id":{
            "type":"string",
            "description":"The unique identifier of the first rate dimension record associated with the rate value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension9TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "RateDimension7TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateTableRatesDeleteFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates that the rate table rates record cannot be deleted using this service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"N"
            }
        },
        "RateDimension2TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension6TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimension4TierId":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

BusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

The business units list of values resource is used to view the list of defined business units.

CnLookupRateTableTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_COMMISSION_UNIT_CODE

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

RateTableDimensions

Operation: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableDimensions

Parameters:

• RateTableId: $request.path.RateTableId

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.

RateTableRates

Operation: /fscmRestApi/resources/11.13.18.05/rateTables/{RateTableId}/child/RateTableRates

Parameters:

• RateTableId: $request.path.RateTableId

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.

Back to Top

Examples

The following example shows how to update a rate table by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089814734

Example of Request Body

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

{
"Description": "Duplicate rate table updated"
}

Example of Response Body

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

{
  "RateTableId": 300100089814734,
  "Name": "Copy R2T",
  "Description": "Duplicate rate table updated",
  "OrgId": 204,
  "NumberDim": 1,
  "DisplayName": "Duplicate RT",
  "RateTableType": "AMOUNT",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-05-03T07:47:29-07:00",
  "LastUpdateDate": "2017-05-03T07:49:54-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateLogin": "4EA0A90F547C12A4E0532DD6F00A31AB",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089814734",
      "name": "rateTables",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089814734",
      "name": "rateTables",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089814734/lov/CnLookupRateTableTypeVO",
      "name": "CnLookupRateTableTypeVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089814734/lov/BusinessUnitPVO",
      "name": "BusinessUnitPVO",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/rateTables/300100089814734/child/RateTableDimensions",
      "name": "RateTableDimensions",
      "kind": "collection"
    }
  ]
}

Back to Top