{ "openapi": "3.0.1", "info": { "title": "Changelog for compensation", "description": "The Compensation service enables applications to extend Workday's HCM Compensation features.", "version": "v3" }, "servers": [ { "url": "https:///compensation/v3" } ], "tags": [ { "name": "08/17/2026", "description": "Changes for v2026.33" }, { "name": "06/30/2026", "description": "Changes for v2026.26" }, { "name": "06/15/2026", "description": "Changes for v2026.24" }, { "name": "04/18/2026", "description": "Changes for v2026.16" } ], "paths": { "2026.16/workers/{ID}": { "get": { "tags": [ "04/18/2026" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: GET /workers/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me** | \n\n| Previous Value | \n| :--- | \n| The Workday ID of the resource. | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ], "enum": [ "ID", "me" ] } } ] } }, "2026.16/workers/{ID}/requestOneTimePayment": { "post": { "tags": [ "04/18/2026" ], "summary": "Parameters have been modified.", "description": "
\n\n
\n View this Endpoint: POST /workers/{ID}/requestOneTimePayment\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Description changed \n| Updated Value | \n| :--- | \n| The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me** | \n\n| Previous Value | \n| :--- | \n| The Workday ID of the resource. | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "type": "string", "exampleSetFlag": false, "types": [ "string" ], "enum": [ "ID", "me" ] } } ] } }, "2026.24/scorecardResults/{ID}/scores/{subresourceID}": { "patch": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sets the achievement value for the specified Score in the specified Scorecard Result.\nSpecify the required achievement value as a percentage (1-100%).
|
Sets the achievement value for the specified Score in the specified Scorecard Result.\nSpecify the required achievement value as a percentage (1-100%).
Secured by: Set Up: Merit and Bonus
Scope: Advanced Compensation
| \n\n
\n\n
\n View this Endpoint: PATCH /scorecardResults/{ID}/scores/{subresourceID}\n
\n
" } }, "2026.24/workers": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive.
|
Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive.
Secured by: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports
Scope: Staffing
| \n\n
\n\n
\n View this Endpoint: GET /workers\n
\n
" } }, "2026.24/workers/{ID}": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a worker instance with the specific ID.
|
Retrieves a worker instance with the specific ID.
Secured by: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports
Scope: Staffing
| \n\n
\n\n
\n View this Endpoint: GET /workers/{ID}\n
\n
" } }, "2026.24/values/oneTimePaymentPlanGroup/oneTimePaymentPlan/": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves instances that can be used as values for other endpoint parameters in this service.
|
Retrieves instances that can be used as values for other endpoint parameters in this service.
Secured by: Request: One-Time Payment
Scope: Core Compensation
| \n\n
\n\n
\n View this Endpoint: GET /values/oneTimePaymentPlanGroup/oneTimePaymentPlan/\n
\n
" } }, "2026.24/scorecards": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Creates a new Compensation Scorecard.
In 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} ].
|
Creates a new Compensation Scorecard.
In 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} ].
Secured by: Set Up: Merit and Bonus
Scope: Advanced Compensation
| \n\n
\n\n
\n View this Endpoint: POST /scorecards\n
\n
" } }, "2026.24/scorecards/{ID}": { "put": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
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[].
|
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[].
Secured by: Set Up: Merit and Bonus
Scope: Advanced Compensation
| \n\n
\n\n
\n View this Endpoint: PUT /scorecards/{ID}\n
\n
" } }, "2026.24/workers/{ID}/requestOneTimePayment": { "post": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Creates a one-time payment for a worker with the specified ID, and initiates the Request One-Time Payment business process. In the request body, specify at least these required fields: reason{id}, position{id}, oneTimePayments[ paymentCurrency{id}, oneTimePaymentPlan {id}].
Sample format for paymentAmount:\n\"payment Amount\": {\n \"value\": \"2500\"\n}
|
Creates a one-time payment for a worker with the specified ID, and initiates the Request One-Time Payment business process. In the request body, specify at least these required fields: reason{id}, position{id}, oneTimePayments[ paymentCurrency{id}, oneTimePaymentPlan {id}].
Sample format for paymentAmount:\n\"payment Amount\": {\n \"value\": \"2500\"\n}
Secured by: Request One-Time Payment (REST Service)
Scope: Core Compensation
| \n\n
\n\n
\n View this Endpoint: POST /workers/{ID}/requestOneTimePayment\n
\n
" } }, "2026.24/scorecardResults": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the Scorecard Results.
|
Retrieves the Scorecard Results.
Secured by: Set Up: Merit and Bonus
Scope: Advanced Compensation
| \n\n
\n\n
\n View this Endpoint: GET /scorecardResults\n
\n
" } }, "2026.24/scorecardResults/{ID}": { "get": { "tags": [ "06/15/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the Scorecard Results.
|
Retrieves the Scorecard Results.
Secured by: Set Up: Merit and Bonus
Scope: Advanced Compensation
| \n\n
\n\n
\n View this Endpoint: GET /scorecardResults/{ID}\n
\n
" } }, "2026.26/scorecardResults/{ID}/scores/{subresourceID}": { "patch": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Sets the achievement value for the specified Score in the specified Scorecard Result.\nSpecify the required achievement value as a percentage (1-100%).
Secured By Domain: Set Up: Merit and Bonus
Scope: Advanced Compensation
|
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
\n\n
\n View this Endpoint: PATCH /scorecardResults/{ID}/scores/{subresourceID}\n
\n
" } }, "2026.26/workers": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive.
Secured By Domain: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports
Scope: Staffing
|
Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive.
| \n\n
\n\n
\n View this Endpoint: GET /workers\n
\n
" } }, "2026.26/workers/{ID}": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves a worker instance with the specific ID.
Secured By Domain: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports
Scope: Staffing
|
Retrieves a worker instance with the specific ID.
| \n\n
\n\n
\n View this Endpoint: GET /workers/{ID}\n
\n
" } }, "2026.26/workers/{ID}/requestOneTimePayment": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Creates a one-time payment for a worker with the specified ID, and initiates the Request One-Time Payment business process. In the request body, specify at least these required fields: reason{id}, position{id}, oneTimePayments[ paymentCurrency{id}, oneTimePaymentPlan {id}].
Sample format for paymentAmount:\n\"payment Amount\": {\n \"value\": \"2500\"\n}
Secured By Business Process Type: Request One-Time Payment
Scope: Core Compensation
|
Creates a one-time payment for a worker with the specified ID, and initiates the Request One-Time Payment business process. In the request body, specify at least these required fields: reason{id}, position{id}, oneTimePayments[ paymentCurrency{id}, oneTimePaymentPlan {id}].
Sample format for paymentAmount:\n\"payment Amount\": {\n \"value\": \"2500\"\n}
| \n\n
\n\n
\n View this Endpoint: POST /workers/{ID}/requestOneTimePayment\n
\n
" } }, "2026.26/scorecards": { "post": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Creates a new Compensation Scorecard.
In 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} ].
Secured By Domain: Set Up: Merit and Bonus
Scope: Advanced Compensation
|
Creates a new Compensation Scorecard.
In 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
\n\n
\n View this Endpoint: POST /scorecards\n
\n
" } }, "2026.26/scorecards/{ID}": { "put": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
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[].
Secured By Domain: Set Up: Merit and Bonus
Scope: Advanced Compensation
|
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
\n\n
\n View this Endpoint: PUT /scorecards/{ID}\n
\n
" } }, "2026.26/scorecardResults": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the Scorecard Results.
Secured By Domain: Set Up: Merit and Bonus
Scope: Advanced Compensation
|
Retrieves the Scorecard Results.
| \n\n
\n\n
\n View this Endpoint: GET /scorecardResults\n
\n
" } }, "2026.26/scorecardResults/{ID}": { "get": { "tags": [ "06/30/2026" ], "summary": "Description has been changed", "description": "## Description changed \n|
Updated Value
|
Previous Value
| \n| :--- | :--- | \n|
Retrieves the Scorecard Results.
Secured By Domain: Set Up: Merit and Bonus
Scope: Advanced Compensation
|
Retrieves the Scorecard Results.
| \n\n
\n\n
\n View this Endpoint: GET /scorecardResults/{ID}\n
\n
" } }, "2026.33/scorecardResults/{ID}/scores/{subresourceID}": { "patch": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: PATCH /scorecardResults/{ID}/scores/{subresourceID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_scorecardResults", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Compensation_Performance_Scorecard_Result_ID=21002", "valueSetFlag": true } } }, { "name": "subresourceID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_scores", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true } } } ] } }, "2026.33/workers/{ID}": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /workers/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_workers", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Employee_ID=21002", "valueSetFlag": true }, "me": { "summary": "Named entry", "value": "me", "valueSetFlag": true } } } ] } }, "2026.33/scorecards/{ID}": { "put": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: PUT /scorecards/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_scorecards", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Performance_Scorecard_ID=21002", "valueSetFlag": true } } } ] } }, "2026.33/workers/{ID}/requestOneTimePayment": { "post": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: POST /workers/{ID}/requestOneTimePayment\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_workers", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Employee_ID=21002", "valueSetFlag": true }, "me": { "summary": "Named entry", "value": "me", "valueSetFlag": true } } } ] } }, "2026.33/scorecardResults/{ID}": { "get": { "tags": [ "08/17/2026" ], "summary": "Modified this existing endpoint", "description": "
\n\n
\n View this Endpoint: GET /scorecardResults/{ID}\n
\n
", "parameters": [ { "name": "ID", "in": "path", "description": "Parameter Schema Type changed \n| Updated Value | \n| :--- | \n| None | \n\n| Previous Value | \n| :--- | \n| None | \n\n", "required": true, "style": "SIMPLE", "explode": false, "schema": { "$ref": "#/components/schemas/ResourceIdPathValue_scorecardResults", "exampleSetFlag": false }, "examples": { "wid": { "summary": "Specific resource WID", "value": "a3f5b554007d20e98360015c5e6daf6", "valueSetFlag": true }, "referenceId": { "summary": "Reference ID", "value": "Compensation_Performance_Scorecard_Result_ID=21002", "valueSetFlag": true } } } ] } } }, "components": { "schemas": { "INSTANCE_MODEL_REFERENCE": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$", "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "readOnly": true, "exampleSetFlag": false, "types": [ "string" ] }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "ERROR_MODEL_REFERENCE": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string", "description": "A description of the error", "exampleSetFlag": false, "types": [ "string" ] }, "code": { "type": "string", "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change", "exampleSetFlag": false, "types": [ "string" ] }, "field": { "type": "string", "description": "The field related to the error", "exampleSetFlag": false, "types": [ "string" ] }, "path": { "type": "string", "description": "The path of the field related to the error", "exampleSetFlag": false, "types": [ "string" ] }, "severity": { "type": "string", "description": "Severity of the validation (e.g. Critical, Warning).", "exampleSetFlag": false, "types": [ "string" ] }, "internalMessage": { "type": "string", "description": "Internal message providing additional context for the validation (e.g. representation content validation details).", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "VALIDATION_ERROR_MODEL_REFERENCE": { "exampleSetFlag": false, "allOf": [ { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string", "description": "A description of the error", "exampleSetFlag": false, "types": [ "string" ] }, "errors": { "type": "array", "description": "An array of validation errors", "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "FACETS_MODEL_REFERENCE": { "type": "array", "exampleSetFlag": false, "items": { "type": "object", "properties": { "descriptor": { "type": "string", "description": "A description of the facet", "exampleSetFlag": false, "types": [ "string" ] }, "facetParameter": { "type": "string", "description": "The alias used to select the facet", "exampleSetFlag": false, "types": [ "string" ] }, "values": { "type": "array", "description": "the facet values", "exampleSetFlag": false, "items": { "required": [ "id" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of instances returned by this facet", "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "id": { "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$", "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "A description of the facet", "exampleSetFlag": false, "types": [ "string" ] }, "href": { "type": "string", "description": "A link to the instance", "readOnly": true, "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "types": [ "array" ] } }, "description": "This object represents the possible facets for this resource", "readOnly": true, "exampleSetFlag": false, "types": [ "object" ] }, "types": [ "array" ] }, "MULTIPLE_INSTANCE_MODEL_REFERENCE": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "exampleSetFlag": false, "types": [ "integer" ] }, "data": { "type": "array", "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, "types": [ "array" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "WorkdayId": { "pattern": "^[0-9a-f]{32}$", "type": "string", "description": "Workday ID (32-character lowercase hexadecimal string).", "example": "a3f5b554007d20e98360015c5e6daf6", "exampleSetFlag": true, "types": [ "string" ] }, "NamedEntry_workers": { "type": "string", "description": "Named entry alias", "exampleSetFlag": false, "types": [ "string" ], "enum": [ "me" ] }, "WorkdayReferenceId_workers": { "pattern": "^(Employee_ID|Contingent_Worker_ID)=\\S+$", "type": "string", "description": "Workday reference ID (Type=Value). Valid types: Employee_ID, Contingent_Worker_ID", "example": "Employee_ID=21002", "exampleSetFlag": true, "types": [ "string" ] }, "ResourceIdPathValue_workers": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false }, { "$ref": "#/components/schemas/WorkdayReferenceId_workers", "exampleSetFlag": false }, { "$ref": "#/components/schemas/NamedEntry_workers", "exampleSetFlag": false } ] }, "location_d6235be431f940598806053af7ba94ef": { "description": "Contains the location for the \\~worker\\~.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "primarySupervisoryOrganization_851e1342d4c2489c9680fb2a899227ca": { "description": "The \\~supervisory organization\\~ for the \\~worker's\\~ primary position, if the \\~supervisory organization\\~ is viewable by everyone.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "workerProfile_c0a0dce56eb142d39dbffeb505becf7a": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "supervisoryOrganizationsManaged": { "type": "string", "description": "All \\~supervisory organizations\\~, excluding inherited organizations, in which the \\~worker\\~ has a leadership role.", "format": "url", "readOnly": true, "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "types": [ "string" ] }, "dateOfBirth": { "type": "string", "description": "The birth date of the \\~worker\\~.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "businessTitle": { "type": "string", "description": "The business title for the \\~worker's\\~ primary position. If no business title is defined for a position, the position title is returned back.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "isManager": { "type": "boolean", "description": "Identifies if the \\~worker\\~ has a \\~manager\\~ role.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "primaryWorkEmail": { "type": "string", "description": "The primary work email address for the \\~worker\\~.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "location": { "$ref": "#/components/schemas/location_d6235be431f940598806053af7ba94ef", "exampleSetFlag": false }, "primaryWorkPhone": { "type": "string", "description": "The primary work phone number for the \\~worker\\~ including the area code and \\~country\\~ code.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "primaryWorkAddressText": { "type": "string", "description": "Returns the primary work address for the \\~worker\\~, or from their default primary work location, full format on a single line.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "primarySupervisoryOrganization": { "$ref": "#/components/schemas/primarySupervisoryOrganization_851e1342d4c2489c9680fb2a899227ca", "exampleSetFlag": false }, "yearsOfService": { "type": "number", "description": "The years of service for the \\~worker\\~.", "format": "double", "example": 99999999999.99, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "href": { "type": "string", "description": "A link to the instance", "exampleSetFlag": false, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "primarySupervisoryOrganization_642d7497e69c48da946fc503f66d7da1": { "description": "The \\~supervisory organization\\~ for the \\~worker's\\~ primary position, if the \\~supervisory organization\\~ is viewable by everyone.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "workerSummary_a489aef739484c13a59e6d502a9e7b68": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "isManager": { "type": "boolean", "description": "Identifies if the \\~worker\\~ has a \\~manager\\~ role.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "primaryWorkPhone": { "type": "string", "description": "The primary work phone number for the \\~worker\\~ including the area code and \\~country\\~ code.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "primaryWorkEmail": { "type": "string", "description": "The primary work email address for the \\~worker\\~.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "primarySupervisoryOrganization": { "$ref": "#/components/schemas/primarySupervisoryOrganization_642d7497e69c48da946fc503f66d7da1", "exampleSetFlag": false }, "businessTitle": { "type": "string", "description": "The business title for the \\~worker's\\~ primary position. If no business title is defined for a position, the position title is returned back.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "href": { "type": "string", "description": "A link to the instance", "exampleSetFlag": false, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "position_aa655adbcee910002fcec09dadb70084": { "description": "Position Element", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "reason_ada36316d338100012078240be64002b": { "description": "The business process type, reason category and reason associated with the business process (e.g. Hire \\~Employee\\~ > New Hire > New Position).", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "oneTimePaymentPlanEventInput_ada36316d338100011ac2ed696990026": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "oneTimePayments": { "type": "array", "description": "All one-time payments associated with the event.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/oneTimePayments_74e74326e3da1000191f2a639d170046", "exampleSetFlag": false }, "types": [ "array" ] }, "position": { "$ref": "#/components/schemas/position_aa655adbcee910002fcec09dadb70084", "exampleSetFlag": false }, "reason": { "$ref": "#/components/schemas/reason_ada36316d338100012078240be64002b", "exampleSetFlag": false }, "effectiveDate": { "type": "string", "description": "The date this business process takes effect.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "employeeVisibilityDate": { "type": "string", "description": "Returns the date that a compensation change is visible to a \\~worker\\~.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "WorkdayReferenceId_scorecards": { "pattern": "^(Performance_Scorecard_ID)=\\S+$", "type": "string", "description": "Workday reference ID (Type=Value). Valid types: Performance_Scorecard_ID", "example": "Performance_Scorecard_ID=21002", "exampleSetFlag": true, "types": [ "string" ] }, "ResourceIdPathValue_scorecards": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false }, { "$ref": "#/components/schemas/WorkdayReferenceId_scorecards", "exampleSetFlag": false } ] }, "editScorecards_6316bca5e030100008492348577100af": { "exampleSetFlag": false, "allOf": [ { "required": [ "defaultScorecardGoals", "effectiveDate", "scorecardName" ], "type": "object", "properties": { "scorecardProfiles": { "type": "array", "description": "Replaces the array of Profile Scorecard Goals and Eligibility Rules as of the specified effectiveDate. Creates a new array if one does not exist. Deletes the array if one exists as of the specified effectiveDate and the array is not included in the PUT.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/scorecardProfiles_ab761d753f94100006dd7a5a55e50192", "exampleSetFlag": false }, "types": [ "array" ] }, "defaultScorecardGoals": { "type": "array", "description": "Replaces the array of Default Scorecard Goal fields as of the specified effectiveDate.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/defaultScorecardGoals_fcedbf0ab58c10000983d0b90d360134", "exampleSetFlag": false }, "types": [ "array" ] }, "scorecardName": { "type": "string", "description": "Replaces the name of the Compensation Scorecard as of the specified effectiveDate.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "inactive": { "type": "boolean", "description": "Replaces the inactive status of the Compensation Scorecard as of the specified effectiveDate. Default value: false.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "effectiveDate": { "type": "string", "description": "The Effective Date of the updates to the Compensation Scorecard. Date must be entered in format: YYYY-MM-DD.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "scorecardDescription": { "type": "string", "description": "Replaces the description of the Compensation Scorecard as of the specified effectiveDate. Deletes the description if a description exists as of the specified effectiveDate and this field is not included in the PUT.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "createScorecard_e783e109d05a100008666e71ee9200c1": { "exampleSetFlag": false, "allOf": [ { "required": [ "defaultScorecardGoals", "effectiveDate", "scorecardName" ], "type": "object", "properties": { "defaultScorecardGoals": { "type": "array", "description": "The \\~goals\\~ for the Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/defaultScorecardGoals_e783e109d05a100008666ebe55a100c4", "exampleSetFlag": false }, "types": [ "array" ] }, "scorecardName": { "type": "string", "description": "The name of the Compensation Scorecard.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "inactive": { "type": "boolean", "description": "Indicates whether the Scorecard is inactive using a value of true/false.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "scorecardProfiles": { "type": "array", "description": "The profiles for the Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/scorecardProfiles_e783e109d05a100008666e9829b100c2", "exampleSetFlag": false }, "types": [ "array" ] }, "scorecardDescription": { "type": "string", "description": "The description of the Compensation Scorecard.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "effectiveDate": { "type": "string", "description": "The Effective Date of the Compensation Scorecard in format YYYY-MM-DD", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecard_e8cffc5e0fe810000b26ce3a5d2200f4": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "scorecardProfiles": { "type": "array", "description": "The profiles for the Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/scorecardProfiles_5ec11e698afe10000c93771015820144", "exampleSetFlag": false }, "types": [ "array" ] }, "scorecardName": { "type": "string", "description": "The name of the Compensation Scorecard.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "effectiveDate": { "type": "string", "description": "The Effective Date of the Compensation Scorecard in format YYYY-MM-DD.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "inactive": { "type": "boolean", "description": "Indicates whether the Scorecard is inactive using a value of true/false.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "scorecardDescription": { "type": "string", "description": "The description of the Compensation Scorecard.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "defaultScorecardGoals": { "type": "array", "description": "The goals for the Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/defaultScorecardGoals_5ec11e698afe10000c0792b20d370140", "exampleSetFlag": false }, "types": [ "array" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "WorkdayReferenceId_scorecardResults": { "pattern": "^(Compensation_Performance_Scorecard_Result_ID)=\\S+$", "type": "string", "description": "Workday reference ID (Type=Value). Valid types: Compensation_Performance_Scorecard_Result_ID", "example": "Compensation_Performance_Scorecard_Result_ID=21002", "exampleSetFlag": true, "types": [ "string" ] }, "ResourceIdPathValue_scorecardResults": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false }, { "$ref": "#/components/schemas/WorkdayReferenceId_scorecardResults", "exampleSetFlag": false } ] }, "scorecardID_788fbbd8885d1000099731d83fc70160": { "description": "Returns the Default Scorecard for the Scorecard Result Instance", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/defaultScorecard_c04de7a15cc210000fc41acababf0019", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "createScorecardResults_788fbbd8885d100009973168b6ea015e": { "exampleSetFlag": false, "allOf": [ { "required": [ "evaluationDate", "scorecardID" ], "type": "object", "properties": { "scorecardName": { "type": "string", "description": "The \\~goal\\~ name of the scorecard criteria result.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text", "x-readOnly": true }, "exampleSetFlag": true, "types": [ "string" ] }, "evaluationDate": { "type": "string", "description": "Scorecard Result Evaluation Date", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "scorecardID": { "$ref": "#/components/schemas/scorecardID_788fbbd8885d1000099731d83fc70160", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardID_9417ca9c97d9100010b7515ebf9e010b": { "description": "Returns the Default Scorecard for the Scorecard Result Instance", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/defaultScorecard_c04de7a15cc210000fc41acababf0019", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "defaultScorecardGoalsResult_9417ca9c97d91000112f60d761110113": { "description": "Returns the Default Score for a Scorecard Result.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scoreset_9417ca9c97d91000112e77cec5c70111", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "scoresetContainer_9417ca9c97d910000b2cd7813b5b00fc": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "scorecardID": { "$ref": "#/components/schemas/scorecardID_9417ca9c97d9100010b7515ebf9e010b", "exampleSetFlag": false }, "defaultScorecardGoalsResult": { "$ref": "#/components/schemas/defaultScorecardGoalsResult_9417ca9c97d91000112f60d761110113", "exampleSetFlag": false }, "profileScorecardGoalsResult": { "type": "array", "description": "Returns the Scorecard Profiles for a Scorecard Result", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/profileScorecardGoalsResult_031a6cc942de1000135e69b35a4601cd", "exampleSetFlag": false }, "types": [ "array" ] }, "evaluationDate": { "type": "string", "description": "Scorecard Result Evaluation Date", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "scorecardDescription": { "type": "string", "description": "Returns the Scorecard's Description", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "scorecardName": { "type": "string", "description": "The \\~goal\\~ name of the scorecard criteria result.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "ResourceIdPathValue_scores": { "exampleSetFlag": false, "oneOf": [ { "$ref": "#/components/schemas/WorkdayId", "exampleSetFlag": false } ] }, "scoreInput_b919a306ff7e10000e12a527cd2c0166": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "achievement": { "type": "number", "description": "The achievement percentage for the scorecard criteria result.", "format": "double", "example": 1, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "Workday Id or Reference Id of the instance.", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "payrollWorktags_65d8813baebc100013a407fcbbc6021e": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Tenanted Payroll Worktag Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "oneTimePaymentPlan_ada36316d33810001344646d1df60036": { "description": "The one-time payment plan name for this one-time payment. Displays only if the payment is a one-time payment.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "payrollWorktags_65d8813baebc100013a5391af084022b": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/payrollWorktags_65d8813baebc100013a407fcbbc6021e", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Tenanted Payroll Worktag Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "paymentCurrency_ada36316d33810001344647d7c610037": { "description": "The currency for this compensation payment", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "oneTimePaymentInput_ada36316d338100012347e847126002d": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "additionalInformation": { "type": "string", "description": "Additional information for this compensation payment", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "coverageEndDate": { "type": "string", "description": "The end date of the Coverage Period for the payment, which enables Workday Payroll or Payroll Integration to associate dates with the one-time payment for Fair Labor Standards Act (FLSA) reporting requirements.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "oneTimePaymentPlan": { "$ref": "#/components/schemas/oneTimePaymentPlan_ada36316d33810001344646d1df60036", "exampleSetFlag": false }, "paymentPercent": { "type": "number", "description": "The actual amount for the \\~bonus\\~ payment represented as a percentage. The percentage is usually calculated as a percentage of base pay, but on the \\~bonus\\~ plan setup it is possible to override the calculation basis to calculate as a percentage of a set of compensation elements.", "format": "double", "example": 100000000000, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "sendToPayroll": { "type": "boolean", "description": "This is true if you selected Send to Payroll on the \\~bonus\\~ payment, future payment, or one-time payment. If false, Workday Payroll doesn't process the payment.", "example": true, "extensions": { "x-workday-type": "Boolean" }, "exampleSetFlag": true, "types": [ "boolean" ] }, "scheduledPaymentDate": { "type": "string", "description": "The payment date scheduled for the one-time payment request.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "payrollWorktags": { "type": "array", "description": "One-Time Payment Worktags for REST API", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/payrollWorktags_65d8813baebc100013a5391af084022b", "exampleSetFlag": false }, "types": [ "array" ] }, "coverageStartDate": { "type": "string", "description": "The start date of the Coverage Period for the payment, which enables Workday Payroll or Payroll Integration to associate dates with the one-time payment for Fair Labor Standards Act (FLSA) reporting requirements.", "format": "date", "extensions": { "x-workday-type": "Date" }, "exampleSetFlag": false, "types": [ "string" ] }, "paymentCurrency": { "$ref": "#/components/schemas/paymentCurrency_ada36316d33810001344647d7c610037", "exampleSetFlag": false }, "paymentAmount": { "type": "object", "description": "Amount of compensation payment", "example": "99999999999.999999", "extensions": { "x-workday-type": "Currency" }, "exampleSetFlag": true, "types": [ "object" ] }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for One-Time Payment Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "oneTimePayments_74e74326e3da1000191f2a639d170046": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/oneTimePaymentInput_ada36316d338100012347e847126002d", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for One-Time Payment Representation", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardGoals_739602a83e141000065bcbec559400c4": { "exampleSetFlag": false, "allOf": [ { "required": [ "goalName", "goalWeight" ], "type": "object", "properties": { "goalWeight": { "type": "number", "description": "Replaces the weight of the Compensation Scorecard \\~Goal\\~ as of the specified effectiveDate. [Weight should be entered as 0.9 for a goalWeight of 90%]", "format": "double", "example": 999999.9999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "goalName": { "type": "string", "description": "Replaces the name of the Compensation Scorecard Goal as of the specified effectiveDate.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "goalDescription": { "type": "string", "description": "Replaces the description of the Compensation Scorecard Goal as of the specified effectiveDate. Deletes the description if a description exists as of the specified effectiveDate and this field is not included in the PUT.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "profileScorecardGoals_ab761d753f94100006db1fc25c4a018d": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scorecardGoals_739602a83e141000065bcbec559400c4", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "eligibilityRule_ab761d753f941000087efd5da96b01b0": { "description": "Replaces the Eligibility Rule object as of the specified effectiveDate.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardProfiles_ab761d753f94100006db1f4fab80018c": { "exampleSetFlag": false, "allOf": [ { "required": [ "eligibilityRule", "profileScorecardGoals" ], "type": "object", "properties": { "profileScorecardGoals": { "type": "array", "description": "Replaces the array of Profile Scorecard Goal fields as of the specified effectiveDate. Creates a new array if one does not exist. Deletes the array if one exists as of the specified effectiveDate and the scorecardProfiles array is not included in the PUT.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/profileScorecardGoals_ab761d753f94100006db1fc25c4a018d", "exampleSetFlag": false }, "types": [ "array" ] }, "eligibilityRule": { "$ref": "#/components/schemas/eligibilityRule_ab761d753f941000087efd5da96b01b0", "exampleSetFlag": false }, "id": { "type": "string", "description": "The id for Scorecard Profile", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardProfiles_ab761d753f94100006dd7a5a55e50192": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scorecardProfiles_ab761d753f94100006db1f4fab80018c", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Scorecard Profile", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "defaultScorecardGoals_fcedbf0ab58c10000983d0b90d360134": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scorecardGoals_739602a83e141000065bcbec559400c4", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "createGoals_e783e109d05a10000add0e9d914f1817": { "exampleSetFlag": false, "allOf": [ { "required": [ "goalName", "goalWeight" ], "type": "object", "properties": { "goalWeight": { "type": "number", "description": "The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9]", "format": "double", "example": 999999.9999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "goalName": { "type": "string", "description": "The name of the Compensation Scorecard Goal.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "goalDescription": { "type": "string", "description": "The description of the Compensation Scorecard Goal", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "eligibilityRule_e783e109d05a10000aa2f66be77e17e2": { "description": "The name of the Compensation Eligibility Rule assigned to the Compensation Scorecard Profile.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "profileScorecardGoals_e783e109d05a10000aa2f664cef617e1": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/createGoals_e783e109d05a10000add0e9d914f1817", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "createScorecardProfiles_e783e109d05a10000aa2f64beebf17df": { "exampleSetFlag": false, "allOf": [ { "required": [ "eligibilityRule", "profileScorecardGoals" ], "type": "object", "properties": { "eligibilityRule": { "$ref": "#/components/schemas/eligibilityRule_e783e109d05a10000aa2f66be77e17e2", "exampleSetFlag": false }, "profileScorecardGoals": { "type": "array", "description": "The \\~goals\\~ for the Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/profileScorecardGoals_e783e109d05a10000aa2f664cef617e1", "exampleSetFlag": false }, "types": [ "array" ] }, "id": { "type": "string", "description": "The id for Scorecard Profile", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "defaultScorecardGoals_e783e109d05a100008666ebe55a100c4": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/createGoals_e783e109d05a10000add0e9d914f1817", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardProfiles_e783e109d05a100008666e9829b100c2": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/createScorecardProfiles_e783e109d05a10000aa2f64beebf17df", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Scorecard Profile", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardGoalSummary_e8cffc5e0fe8100015e8c9f2a2a30110": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "goalWeight": { "type": "number", "description": "The weight given to the Compensation Scorecard \\~Goal\\~. [90% will be displayed as 0.9]", "format": "double", "example": 999999.9999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "goalDescription": { "type": "string", "description": "The description of the Compensation Scorecard \\~Goal\\~.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "goalName": { "type": "string", "description": "The name of the Compensation Scorecard \\~Goal\\~.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "eligibilityRule_e8cffc5e0fe8100019d298288b26011c": { "description": "The name of the Compensation Eligibility Rule assigned to the Compensation Scorecard Profile.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "profileScorecardGoals_e8cffc5e0fe8100019d298117ae00119": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scorecardGoalSummary_e8cffc5e0fe8100015e8c9f2a2a30110", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardProfile_e8cffc5e0fe8100019d2980406830118": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "eligibilityRule": { "$ref": "#/components/schemas/eligibilityRule_e8cffc5e0fe8100019d298288b26011c", "exampleSetFlag": false }, "profileScorecardGoals": { "type": "array", "description": "The goals for the Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/profileScorecardGoals_e8cffc5e0fe8100019d298117ae00119", "exampleSetFlag": false }, "types": [ "array" ] }, "id": { "type": "string", "description": "The id for Scorecard Profile", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scorecardProfiles_5ec11e698afe10000c93771015820144": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scorecardProfile_e8cffc5e0fe8100019d2980406830118", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Scorecard Profile", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "defaultScorecardGoals_5ec11e698afe10000c0792b20d370140": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scorecardGoalSummary_e8cffc5e0fe8100015e8c9f2a2a30110", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "defaultScorecard_c04de7a15cc210000fc41acababf0019": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Compensation Scorecard", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "scoreGoal_99e36113850b10000c88dae09c9b00c0": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Performance Criteria", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "goalID_031a6cc942de10001432e1711d9201d6": { "description": "The criteria for the scorecard criteria result.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scoreGoal_99e36113850b10000c88dae09c9b00c0", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "scoresetScore_031a6cc942de10001432e156a86901d4": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "achievement": { "type": "number", "description": "The achievement percentage for the scorecard criteria result.", "format": "double", "example": 999999.999999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "goalWeight": { "type": "number", "description": "The criteria weighted percentage of the scorecard criteria result.", "format": "double", "example": 999999.999999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "goalID": { "$ref": "#/components/schemas/goalID_031a6cc942de10001432e1711d9201d6", "exampleSetFlag": false }, "goalName": { "type": "string", "description": "The \\~goal\\~ name of the scorecard criteria result.", "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.", "extensions": { "x-workday-type": "Text" }, "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Score", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "performanceScores_031a6cc942de100013eade974c9a01d2": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scoresetScore_031a6cc942de10001432e156a86901d4", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Score", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "eligibiltyRule_031a6cc942de100015833eaa47c701e4": { "description": "The Eligibility Rule for a Scorecard Profile.", "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE", "exampleSetFlag": false }, { "type": "object", "exampleSetFlag": false, "types": [ "object" ] } ] }, "scoreset_9417ca9c97d91000112e77cec5c70111": { "exampleSetFlag": false, "allOf": [ { "type": "object", "properties": { "performanceScores": { "type": "array", "description": "The set of Performance Scores for a Compensation Scorecard.", "extensions": { "x-workday-type": "Multi-instance" }, "exampleSetFlag": false, "items": { "$ref": "#/components/schemas/performanceScores_031a6cc942de100013eade974c9a01d2", "exampleSetFlag": false }, "types": [ "array" ] }, "weightedFundingPercent": { "type": "number", "description": "Calculates the total Weighted Funding Percent for all the scores in the scorecard result set.", "format": "double", "example": 999999.999999, "extensions": { "x-workday-type": "Numeric" }, "exampleSetFlag": true, "types": [ "number" ] }, "eligibiltyRule": { "$ref": "#/components/schemas/eligibiltyRule_031a6cc942de100015833eaa47c701e4", "exampleSetFlag": false }, "descriptor": { "type": "string", "description": "The display name of the instance", "example": "Lorem ipsum dolor sit ame", "exampleSetFlag": true, "types": [ "string" ] }, "id": { "type": "string", "description": "The id for Compensation Scorecard Result", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] }, "profileScorecardGoalsResult_031a6cc942de1000135e69b35a4601cd": { "exampleSetFlag": false, "allOf": [ { "$ref": "#/components/schemas/scoreset_9417ca9c97d91000112e77cec5c70111", "exampleSetFlag": false }, { "type": "object", "properties": { "id": { "type": "string", "description": "The id for Compensation Scorecard Result", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] } ] } }, "securitySchemes": { "OAuth2": { "flows": { "implicit": { "authorizationUrl": "https://", "scopes": {} } } } }, "extensions": {} } }