Skip to main content
Server path: /workday-compensation | Type: Application | PCID required: Yes

Tools

ToolDescription
workday_compensation_delete_scorecardresults_by_idDeletes the Scorecard Results with the specified ID.
workday_compensation_delete_scorecards_by_idDeletes a Compensation Scorecard with the specified ID.
workday_compensation_get_scorecardresultsProvides the ability to set up and retrieve Scores on Scorecard Results.
workday_compensation_get_scorecardresults_by_idProvides the ability to set up and retrieve Scores on Scorecard Results.
workday_compensation_get_scorecardsRetrieves Compensation Scorecard information.
workday_compensation_get_scorecards_by_idRetrieves Compensation Scorecard information.
workday_compensation_get_workersRetrieves a collection of workers.
workday_compensation_get_workers_by_idRetrieves a worker instance.
workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceidUpdates the Score for the specified Scorecard Result.
workday_compensation_post_scorecardresultsCreates a new Scorecard Result.
workday_compensation_post_scorecardsCreates a Compensation Scorecard
workday_compensation_post_workers_by_id_requestonetimepaymentRequest a one-time payment for a worker with the specified ID.
workday_compensation_put_scorecards_by_idUpdates a Compensation Scorecard

workday_compensation_delete_scorecardresults_by_id

Deletes the Scorecard Results with the specified ID. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_compensation_delete_scorecards_by_id

Deletes a Compensation Scorecard with the specified ID. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_compensation_get_scorecardresults

Provides the ability to set up and retrieve Scores on Scorecard Results. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_compensation_get_scorecardresults_by_id

Provides the ability to set up and retrieve Scores on Scorecard Results. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_compensation_get_scorecards

Retrieves Compensation Scorecard information. Parameters:
ParameterTypeRequiredDefaultDescription
effectiveDatestringNoEffective date the scorecard task takes effect.
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.

workday_compensation_get_scorecards_by_id

Retrieves Compensation Scorecard information. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_compensation_get_workers

Retrieves a collection of workers. Parameters:
ParameterTypeRequiredDefaultDescription
includeTerminatedWorkersbooleanNoInclude terminated workers in the output
limitintegerNoThe maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNoThe 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.
searchstringNosearch

workday_compensation_get_workers_by_id

Retrieves a worker instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.

workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid

Updates the Score for the specified Scorecard Result. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
subresourceIDstringYesThe Workday ID of the subresource.
achievementnumberNoThe achievement percentage for the scorecard criteria result.
descriptorstringNoThe display name of the instance
idstringNoWorkday Id or Reference Id of the instance.

workday_compensation_post_scorecardresults

Creates a new Scorecard Result. Parameters:
ParameterTypeRequiredDefaultDescription
descriptorstringNoThe display name of the instance
evaluationDatestringYesScorecard Result Evaluation Date
idstringNoWorkday Id or Reference Id of the instance.
scorecardIDobjectYesReturns the Default Scorecard for the Scorecard Result Instance
scorecardNamestringNoThe ~goal~ name of the scorecard criteria result.

workday_compensation_post_scorecards

Creates a Compensation Scorecard Parameters:
ParameterTypeRequiredDefaultDescription
defaultScorecardGoalsany[]YesThe ~goals~ for the Compensation Scorecard.
effectiveDatestringYesThe Effective Date of the Compensation Scorecard in format YYYY-MM-DD
idstringNoWorkday Id or Reference Id of the instance.
inactivebooleanNoIndicates whether the Scorecard is inactive using a value of true/false.
scorecardDescriptionstringNoThe description of the Compensation Scorecard.
scorecardNamestringYesThe name of the Compensation Scorecard.
scorecardProfilesany[]NoThe profiles for the Compensation Scorecard.

workday_compensation_post_workers_by_id_requestonetimepayment

Request a one-time payment for a worker with the specified ID. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
descriptorstringNoThe display name of the instance
effectiveDatestringNoThe date this business process takes effect.
employeeVisibilityDatestringNoReturns the date that a compensation change is visible to a ~worker~.
idstringNoWorkday Id or Reference Id of the instance.
oneTimePaymentsany[]NoAll one-time payments associated with the event.
positionobjectNoPosition Element
reasonobjectNoThe business process type, reason category and reason associated with the business process (e.g. Hire ~Employee~ > New Hire > New Position).

workday_compensation_put_scorecards_by_id

Updates a Compensation Scorecard Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe Workday ID of the resource.
defaultScorecardGoalsany[]YesReplaces the array of Default Scorecard Goal fields as of the specified effectiveDate.
effectiveDatestringYesThe Effective Date of the updates to the Compensation Scorecard. Date must be entered in format: YYYY-MM-DD.
idstringNoWorkday Id or Reference Id of the instance.
inactivebooleanNoReplaces the inactive status of the Compensation Scorecard as of the specified effectiveDate. Default value: false.
scorecardDescriptionstringNoReplaces 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.
scorecardNamestringYesReplaces the name of the Compensation Scorecard as of the specified effectiveDate.
scorecardProfilesany[]NoReplaces 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.