Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "compensation",
"description": "The Compensation service enables applications to extend Workday's HCM Compensation features.",
"version": "v3",
"x-workday-confidence-level": "Production",
"x-workday-internal-source": "xo",
"x-workday-internal-routing": "Public",
"x-workday-internal-protected-usage-enabled": false,
"x-workday-internal-service-container-id": "2d8b79dba7251000105e1cc54b0a13e1"
},
"servers": [
{
"url": "https://<tenantHostname>/compensation/v3"
}
],
"tags": [
{
"name": "scorecardResults",
"description": "Provides the ability to set up and retrieve Scores on Scorecard Results."
},
{
"name": "scorecards",
"description": "Provides the ability to set up and retrieve Scores on Scorecard Results."
},
{
"name": "workers"
},
{
"name": "Prompt Values",
"description": "Retrieves instances that can be used as values for other endpoint parameters in this service."
}
],
"paths": {
"/scorecardResults": {
"get": {
"tags": [
"scorecardResults"
],
"summary": "Provides the ability to set up and retrieve Scores on Scorecard Results.",
"description": "Retrieves the Scorecard Results.\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/scoresetContainer_9417ca9c97d910000b2cd7813b5b00fc"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "true",
"x-workday-operation-id": "9417ca9c97d910000b4e27fc474400ff",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
},
"post": {
"tags": [
"scorecardResults"
],
"summary": "Creates a new Scorecard Result.",
"description": "In the request body, specify these required fields:\n\n* compensationScorecard - The Workday ID of a Compensation Scorecard. You can use a returned id from the GET /scorecards method.\n* evaluationDate - The date when the Scorecard Result is evaluated. Use the yyyy-mm-dd format.\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createScorecardResults_788fbbd8885d100009973168b6ea015e"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createScorecardResults_788fbbd8885d100009973168b6ea015e"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nChange the Evaluation Date to a date that is on or after the Effective Date of the selected Scorecard. The specified Evaluation Date is before the earliest Effective Date of the selected Scorecard.\n\nEither specify a different Evaluation Date or edit the existing Scores. The Scorecard Result for the specified Scorecard and Evaluation Date already exists:([scores])",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "788fbbd8885d1000099999c29d8d0162",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
}
},
"/scorecardResults/{ID}/scores/{subresourceID}": {
"patch": {
"tags": [
"scorecardResults"
],
"summary": "Updates the Score for the specified Scorecard Result.",
"description": "Sets the achievement value for the specified Score in the specified Scorecard Result.\nSpecify the required achievement value as a percentage (1-100%).\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Compensation_Performance_Scorecard_Result_ID",
"required": true,
"schema": {
"$ref": "#/components/schemas/ResourceIdPathValue_scorecardResults"
},
"examples": {
"wid": {
"summary": "Specific resource WID",
"value": "a3f5b554007d20e98360015c5e6daf6"
},
"referenceId": {
"summary": "Reference ID",
"value": "Compensation_Performance_Scorecard_Result_ID=21002"
}
}
},
{
"name": "subresourceID",
"in": "path",
"description": "The Workday ID of the subresource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).",
"required": true,
"schema": {
"$ref": "#/components/schemas/ResourceIdPathValue_scores"
},
"examples": {
"wid": {
"summary": "Specific resource WID",
"value": "a3f5b554007d20e98360015c5e6daf6"
}
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/scoreInput_b919a306ff7e10000e12a527cd2c0166"
}
}
}
},
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data. Updating resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/scoreInput_b919a306ff7e10000e12a527cd2c0166"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nYou can’t update Scorecard Results used in a completed compensation review process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "b919a306ff7e10000ceaf185bf270163",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
}
},
"/scorecardResults/{ID}": {
"get": {
"tags": [
"scorecardResults"
],
"summary": "Provides the ability to set up and retrieve Scores on Scorecard Results.",
"description": "Retrieves the Scorecard Results.\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Compensation_Performance_Scorecard_Result_ID",
"required": true,
"schema": {
"$ref": "#/components/schemas/ResourceIdPathValue_scorecardResults"
},
"examples": {
"wid": {
"summary": "Specific resource WID",
"value": "a3f5b554007d20e98360015c5e6daf6"
},
"referenceId": {
"summary": "Reference ID",
"value": "Compensation_Performance_Scorecard_Result_ID=21002"
}
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/scoresetContainer_9417ca9c97d910000b2cd7813b5b00fc"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "true",
"x-workday-operation-id": "9417ca9c97d910000b4e27fc474400ff",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
},
"delete": {
"tags": [
"scorecardResults"
],
"summary": "Deletes the Scorecard Results with the specified ID.",
"description": "Deletes the Scorecard Results with the specified ID.\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Compensation_Performance_Scorecard_Result_ID",
"required": true,
"schema": {
"$ref": "#/components/schemas/ResourceIdPathValue_scorecardResults"
},
"examples": {
"wid": {
"summary": "Specific resource WID",
"value": "a3f5b554007d20e98360015c5e6daf6"
},
"referenceId": {
"summary": "Reference ID",
"value": "Compensation_Performance_Scorecard_Result_ID=21002"
}
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data. Deleting resource.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nYou can’t delete the Scorecard Results used in a completed or in-progress compensation review process.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "e41bd18d448910000d5f670d61e6026e",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
}
},
"/scorecards": {
"get": {
"tags": [
"scorecards"
],
"summary": "Retrieves Compensation Scorecard information.",
"description": "Retrieves Compensation Scorecard information including the scorecardName, scorecardDescription, inactive status, defaultScorecardGoals, scorecardProfiles containing profileScorecardGoals as of the effective date. The default effective date is the request date.\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "effectiveDate",
"in": "query",
"description": "Effective date the scorecard task takes effect.",
"schema": {
"type": "string",
"format": "date"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "offset",
"in": "query",
"description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/scorecard_e8cffc5e0fe810000b26ce3a5d2200f4"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "true",
"x-workday-operation-id": "e8cffc5e0fe810000ac04722d79c00f2",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
},
"post": {
"tags": [
"scorecards"
],
"summary": "Creates a Compensation Scorecard",
"description": "Creates a new Compensation Scorecard.\n\nIn the request body, specify these required fields: scorecardName, effectiveDate, and defaultScorecardGoals[ {goalName, goalWeight} ]. \nIf you specify the optional scorecardProfiles[], you must specify the eligibilityRule{id} and at least 1 goal in profileScorecardGoals[ {goalName, goalWeight} ].\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createScorecard_e783e109d05a100008666e71ee9200c1"
}
}
}
},
"responses": {
"201": {
"description": "Resource created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/createScorecard_e783e109d05a100008666e71ee9200c1"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nA Default Scorecard \\~Goal\\~ is missing\n\nA \\~Goal\\~ is missing for a Scorecard Profile.\n\nScorecard Name entered has already been used.\n\nThe sum of the \\~goal\\~ weightings must equal 100%.\n\nThere are duplicate eligibility rules on this request.\n\n\\~Goal\\~ Weights must be greater than 0.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "false",
"x-workday-operation-id": "e783e109d05a10000778a8412a8900b4",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
}
},
"/scorecards/{ID}": {
"get": {
"tags": [
"scorecards"
],
"summary": "Retrieves Compensation Scorecard information.",
"description": "Retrieves Compensation Scorecard information including the scorecardName, scorecardDescription, inactive status, defaultScorecardGoals, scorecardProfiles containing profileScorecardGoals as of the effective date. The default effective date is the request date.\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.\n\nAccepts:\n- **Workday ID**: Workday ID (32-character lowercase hexadecimal string).\n- **Reference ID**: Workday reference ID (Type=Value). Valid types: Performance_Scorecard_ID",
"required": true,
"schema": {
"$ref": "#/components/schemas/ResourceIdPathValue_scorecards"
},
"examples": {
"wid": {
"summary": "Specific resource WID",
"value": "a3f5b554007d20e98360015c5e6daf6"
},
"referenceId": {
"summary": "Reference ID",
"value": "Performance_Scorecard_ID=21002"
}
}
}
],
"responses": {
"200": {
"description": "Successful response. A successful response can return no matched data.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/scorecard_e8cffc5e0fe810000b26ce3a5d2200f4"
}
}
}
},
"400": {
"description": "Invalid request. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"401": {
"description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"403": {
"description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"404": {
"description": "Resource not found. (https://community.workday.com/rest/error-messages)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
}
}
}
},
"default": {
"description": "An error occurred.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
}
}
}
}
},
"x-workday-internal-try-enabled": "true",
"x-workday-operation-id": "e8cffc5e0fe810000ac04722d79c00f2",
"x-workday-secured-by-domains": [
"Set Up: Merit and Bonus"
]
},
"put": {
"tags": [
"scorecards"
],
"summary": "Updates a Compensation Scorecard",
"description": "Replaces an existing Compensation Scorecard as of the specified effectiveDate. \nCall GET /scorecards/{ID} to initially populate the request body with the existing data. You can then update the scorecardName, scorecardDescription, and inactive fields. You can also add, update, and delete the existing data in defaultScorecardGoals[], scorecardProfiles[], and profileScorecardGoals[].\n\n<b>Secured By Domain:</b> Set Up: Merit and Bonus\n\n<b>Scope:</b> Advanced Compensation",
"parameters": [
{
"name": "ID",
"in": "path",
"description": "The Workday ID of the resource.\n\nAccepts
# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/workday-advanced-compensation/refs/heads/main/openapi/workday-advanced-compensation-compensation-rest-v3-openapi.json