workday-compensation

Server path: /workday-compensation | Type: Application | PCID required: Yes

Tools

Tool	Description
`workday_compensation_delete_scorecardresults_by_id`	Deletes the Scorecard Results with the specified ID.
`workday_compensation_delete_scorecards_by_id`	Deletes a Compensation Scorecard with the specified ID.
`workday_compensation_get_scorecardresults`	Provides the ability to set up and retrieve Scores on Scorecard Results.
`workday_compensation_get_scorecardresults_by_id`	Provides the ability to set up and retrieve Scores on Scorecard Results.
`workday_compensation_get_scorecards`	Retrieves Compensation Scorecard information.
`workday_compensation_get_scorecards_by_id`	Retrieves Compensation Scorecard information.
`workday_compensation_get_workers`	Retrieves a collection of workers.
`workday_compensation_get_workers_by_id`	Retrieves a worker instance.
`workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid`	Updates the Score for the specified Scorecard Result.
`workday_compensation_post_scorecardresults`	Creates a new Scorecard Result.
`workday_compensation_post_scorecards`	Creates a Compensation Scorecard
`workday_compensation_post_workers_by_id_requestonetimepayment`	Request a one-time payment for a worker with the specified ID.
`workday_compensation_put_scorecards_by_id`	Updates a Compensation Scorecard

workday_compensation_delete_scorecardresults_by_id

Deletes the Scorecard Results with the specified ID. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

workday_compensation_delete_scorecards_by_id

Deletes a Compensation Scorecard with the specified ID. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

workday_compensation_get_scorecardresults

Provides the ability to set up and retrieve Scores on Scorecard Results. Parameters:

Parameter	Type	Required	Default	Description
`limit`	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
`offset`	integer	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "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."
    }
  },
  "required": [
    "PCID"
  ]
}

workday_compensation_get_scorecardresults_by_id

Provides the ability to set up and retrieve Scores on Scorecard Results. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

workday_compensation_get_scorecards

Retrieves Compensation Scorecard information. Parameters:

Parameter	Type	Required	Default	Description
`effectiveDate`	string	No	—	Effective date the scorecard task takes effect.
`limit`	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
`offset`	integer	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "effectiveDate": {
      "type": "string",
      "description": "Effective date the scorecard task takes effect."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "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."
    }
  },
  "required": [
    "PCID"
  ]
}

workday_compensation_get_scorecards_by_id

Retrieves Compensation Scorecard information. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

workday_compensation_get_workers

Retrieves a collection of workers. Parameters:

Parameter	Type	Required	Default	Description
`includeTerminatedWorkers`	boolean	No	—	Include terminated workers in the output
`limit`	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
`offset`	integer	No	—	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.
`search`	string	No	—	The search value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "includeTerminatedWorkers": {
      "type": "boolean",
      "description": "Include terminated workers in the output"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "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."
    },
    "search": {
      "type": "string",
      "description": "The search value"
    }
  },
  "required": [
    "PCID"
  ]
}

workday_compensation_get_workers_by_id

Retrieves a worker instance. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid

Updates the Score for the specified Scorecard Result. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.
`subresourceID`	string	Yes	—	The Workday ID of the subresource.
`achievement`	number	No	—	The achievement percentage for the scorecard criteria result.
`descriptor`	string	No	—	The display name of the instance
`id`	string	No	—	Workday Id or Reference Id of the instance.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "subresourceID": {
      "type": "string",
      "description": "The Workday ID of the subresource."
    },
    "achievement": {
      "type": "number",
      "description": "The achievement percentage for the scorecard criteria result."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    }
  },
  "required": [
    "PCID",
    "ID",
    "subresourceID"
  ]
}

workday_compensation_post_scorecardresults

Creates a new Scorecard Result. Parameters:

Parameter	Type	Required	Default	Description
`descriptor`	string	No	—	The display name of the instance
`evaluationDate`	string	Yes	—	Scorecard Result Evaluation Date
`id`	string	No	—	Workday Id or Reference Id of the instance.
`scorecardID`	object	Yes	—	Returns the Default Scorecard for the Scorecard Result Instance
`scorecardName`	string	No	—	The ~goal~ name of the scorecard criteria result.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "evaluationDate": {
      "type": "string",
      "description": "Scorecard Result Evaluation Date"
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "scorecardID": {
      "description": "Returns the Default Scorecard for the Scorecard Result Instance"
    },
    "scorecardName": {
      "type": "string",
      "description": "The \\~goal\\~ name of the scorecard criteria result."
    }
  },
  "required": [
    "PCID",
    "evaluationDate",
    "scorecardID"
  ]
}

workday_compensation_post_scorecards

Creates a Compensation Scorecard Parameters:

Parameter	Type	Required	Default	Description
`defaultScorecardGoals`	any[]	Yes	—	The ~goals~ for the Compensation Scorecard.
`effectiveDate`	string	Yes	—	The Effective Date of the Compensation Scorecard in format YYYY-MM-DD
`id`	string	No	—	Workday Id or Reference Id of the instance.
`inactive`	boolean	No	—	Indicates whether the Scorecard is inactive using a value of true/false.
`scorecardDescription`	string	No	—	The description of the Compensation Scorecard.
`scorecardName`	string	Yes	—	The name of the Compensation Scorecard.
`scorecardProfiles`	any[]	No	—	The profiles for the Compensation Scorecard.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "defaultScorecardGoals": {
      "type": "array",
      "description": "The \\~goals\\~ for the Compensation Scorecard."
    },
    "effectiveDate": {
      "type": "string",
      "description": "The Effective Date of the Compensation Scorecard in format YYYY-MM-DD"
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "inactive": {
      "type": "boolean",
      "description": "Indicates whether the Scorecard is inactive using a value of true/false."
    },
    "scorecardDescription": {
      "type": "string",
      "description": "The description of the Compensation Scorecard."
    },
    "scorecardName": {
      "type": "string",
      "description": "The name of the Compensation Scorecard."
    },
    "scorecardProfiles": {
      "type": "array",
      "description": "The profiles for the Compensation Scorecard."
    }
  },
  "required": [
    "PCID",
    "defaultScorecardGoals",
    "effectiveDate",
    "scorecardName"
  ]
}

workday_compensation_post_workers_by_id_requestonetimepayment

Request a one-time payment for a worker with the specified ID. Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.
`descriptor`	string	No	—	The display name of the instance
`effectiveDate`	string	No	—	The date this business process takes effect.
`employeeVisibilityDate`	string	No	—	Returns the date that a compensation change is visible to a ~worker~.
`id`	string	No	—	Workday Id or Reference Id of the instance.
`oneTimePayments`	any[]	No	—	All one-time payments associated with the event.
`position`	object	No	—	Position Element
`reason`	object	No	—	The business process type, reason category and reason associated with the business process (e.g. Hire ~Employee~ > New Hire > New Position).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "effectiveDate": {
      "type": "string",
      "description": "The date this business process takes effect."
    },
    "employeeVisibilityDate": {
      "type": "string",
      "description": "Returns the date that a compensation change is visible to a \\~worker\\~."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "oneTimePayments": {
      "type": "array",
      "description": "All one-time payments associated with the event."
    },
    "position": {
      "description": "Position Element"
    },
    "reason": {
      "description": "The business process type, reason category and reason associated with the business process (e.g. Hire \\~Employee\\~ > New Hire > New Position)."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

workday_compensation_put_scorecards_by_id

Updates a Compensation Scorecard Parameters:

Parameter	Type	Required	Default	Description
`ID`	string	Yes	—	The Workday ID of the resource.
`defaultScorecardGoals`	any[]	Yes	—	Replaces the array of Default Scorecard Goal fields as of the specified effectiveDate.
`effectiveDate`	string	Yes	—	The Effective Date of the updates to the Compensation Scorecard. Date must be entered in format: YYYY-MM-DD.
`id`	string	No	—	Workday Id or Reference Id of the instance.
`inactive`	boolean	No	—	Replaces the inactive status of the Compensation Scorecard as of the specified effectiveDate. Default value: false.
`scorecardDescription`	string	No	—	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.
`scorecardName`	string	Yes	—	Replaces the name of the Compensation Scorecard as of the specified effectiveDate.
`scorecardProfiles`	any[]	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "defaultScorecardGoals": {
      "type": "array",
      "description": "Replaces the array of Default Scorecard Goal fields as of the specified effectiveDate."
    },
    "effectiveDate": {
      "type": "string",
      "description": "The Effective Date of the updates to the Compensation Scorecard.  Date must be entered in format: YYYY-MM-DD."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "inactive": {
      "type": "boolean",
      "description": "Replaces the inactive status of the Compensation Scorecard as of the specified effectiveDate.  Default value: false."
    },
    "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."
    },
    "scorecardName": {
      "type": "string",
      "description": "Replaces the name of the Compensation Scorecard as of the specified effectiveDate."
    },
    "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."
    }
  },
  "required": [
    "PCID",
    "ID",
    "defaultScorecardGoals",
    "effectiveDate",
    "scorecardName"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Skills Guides

Tools

workday_compensation_delete_scorecardresults_by_id

workday_compensation_delete_scorecards_by_id

workday_compensation_get_scorecardresults

workday_compensation_get_scorecardresults_by_id

workday_compensation_get_scorecards

workday_compensation_get_scorecards_by_id

workday_compensation_get_workers

workday_compensation_get_workers_by_id

workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid

workday_compensation_post_scorecardresults

workday_compensation_post_scorecards

workday_compensation_post_workers_by_id_requestonetimepayment

workday_compensation_put_scorecards_by_id

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Skills Guides

Documentation Index

​Tools

​workday_compensation_delete_scorecardresults_by_id

​workday_compensation_delete_scorecards_by_id

​workday_compensation_get_scorecardresults

​workday_compensation_get_scorecardresults_by_id

​workday_compensation_get_scorecards

​workday_compensation_get_scorecards_by_id

​workday_compensation_get_workers

​workday_compensation_get_workers_by_id

​workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid

​workday_compensation_post_scorecardresults

​workday_compensation_post_scorecards

​workday_compensation_post_workers_by_id_requestonetimepayment

​workday_compensation_put_scorecards_by_id

Tools

workday_compensation_delete_scorecardresults_by_id

workday_compensation_delete_scorecards_by_id

workday_compensation_get_scorecardresults

workday_compensation_get_scorecardresults_by_id

workday_compensation_get_scorecards

workday_compensation_get_scorecards_by_id

workday_compensation_get_workers

workday_compensation_get_workers_by_id

workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid

workday_compensation_post_scorecardresults

workday_compensation_post_scorecards

workday_compensation_post_workers_by_id_requestonetimepayment

workday_compensation_put_scorecards_by_id