Skip to main content
PinkConnect service: workday | Type: Application (parent with child servers) | PCID required: Yes Workday is exposed as multiple MCP server IDs (one per functional area below). Each child server has its own server path and tool names.

​
Child servers

Child serverServer pathToolsDescription
workday-absence-management/workday-absence-management15Workday Absence Management - leaves of absence, time off requests and details
workday-accounts-payable/workday-accounts-payable12Workday Accounts Payable - supplier invoice requests, attachments, lines
workday-business-process/workday-business-process20Workday Business Process - events, event steps, approvals, comments
workday-common/workday-common39Workday Common - workers, organizations, currencies, supervisory organizations, job changes
workday-compensation/workday-compensation13Workday Compensation - scorecards, scorecard results, one-time payments
workday-connect/workday-connect10Workday Connect - message templates, notification types, send messages
workday-customer-accounts/workday-customer-accounts10Workday Customer Accounts - customers, invoices, payments
workday-payroll/workday-payroll25Workday Payroll - pay groups, payroll inputs, tax rates

​
workday-absence-management

Workday Absence Management - leaves of absence, time off requests and details Server path: /workday-absence-management | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_absence_management_get_balancesRetrieves the balance of all absence plan and leave of absence type for the specified worker ID.
workday_absence_management_get_balances_by_idRetrieves the specified balance of all absence plan and leave of absence types.
workday_absence_management_get_values_leave_statusThe status of the event that tracks the requested time off. <b>Secured by:</b> Self-Service: Leave of Absence, Worker Data: Leave of Absence <b>Scope:</b> Time Off and Leave
workday_absence_management_get_values_timeoff_statusThe possible statuses for a worker’s time off entry request event. They include: * Approved, 0391102bd1b542538d996936c8fa2fa7 * Not Submitted, eddf5968e6d4430ca4bce9a4cfaba337 * Sent Back, 070b249867f747a19bca64f73eafc9b8 * Submitted, dd817fe688db4ac7bf84e3ef79f72948 <b>Secured by:</b> Self-Service: Time Off, Worker Data: Time Off (Time Off Manager View), Worker Data: Time Off (Time Off) <b>Scope:</b> Time Off and Leave
workday_absence_management_get_workersRetrieves a collection of workers and current staffing information.
workday_absence_management_get_workers_by_idRetrieves a collection of workers and current staffing information.
workday_absence_management_get_workers_by_id_eligibleabsencetypesRetrieves a collection of eligible absence types for the specified worker.
workday_absence_management_get_workers_by_id_eligibleabsencetypes_by_subresourceidRetrieves the eligible absence type for the specified worker.
workday_absence_management_get_workers_by_id_leavesofabsenceRetrieves the Leaves Of Absence for a specified worker ID.
workday_absence_management_get_workers_by_id_leavesofabsence_by_subresourceidRetrieves the leave of absence for the specified worker.
workday_absence_management_get_workers_by_id_timeoffdetailsRetrieves a collection of time off details for a specified worker.
workday_absence_management_get_workers_by_id_timeoffdetails_by_subresourceidRetrieves details of a specified time off entry for a specified worker.
workday_absence_management_get_workers_by_id_validtimeoffdatesRetrieves the valid time off dates for the specified worker ID for the given dates.
workday_absence_management_post_workers_by_id_correcttimeoffentryCreates a time off correction for the specified worker ID and initiates the business process.
workday_absence_management_post_workers_by_id_requesttimeoffCreates a time off request for the specified worker ID and initiates the business process.

​
workday_absence_management_get_balances

Retrieves the balance of all absence plan and leave of absence type for the specified worker ID. Parameters:
ParameterTypeRequiredDefaultDescription
categorystringNo—The Workday ID of the time off, leave type, or absence table.
effectivestringNo—The absence balances as of the specified date using the yyyy-mm-dd format.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
workerstringNo—The Workday ID of the worker for which balances are returned. This is a required query parameter.

​
workday_absence_management_get_balances_by_id

Retrieves the specified balance of all absence plan and leave of absence types. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_absence_management_get_values_leave_status

The status of the event that tracks the requested time off. <b>Secured by:</b> Self-Service: Leave of Absence, Worker Data: Leave of Absence <b>Scope:</b> Time Off and Leave Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_absence_management_get_values_timeoff_status

The possible statuses for a worker’s time off entry request event. They include: * Approved, 0391102bd1b542538d996936c8fa2fa7 * Not Submitted, eddf5968e6d4430ca4bce9a4cfaba337 * Sent Back, 070b249867f747a19bca64f73eafc9b8 * Submitted, dd817fe688db4ac7bf84e3ef79f72948 <b>Secured by:</b> Self-Service: Time Off, Worker Data: Time Off (Time Off Manager View), Worker Data: Time Off (Time Off) <b>Scope:</b> Time Off and Leave Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_absence_management_get_workers

Retrieves a collection of workers and current staffing information. Parameters:
ParameterTypeRequiredDefaultDescription
includeTerminatedWorkersbooleanNo—Include terminated workers in the output
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
searchstringNo—Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.

​
workday_absence_management_get_workers_by_id

Retrieves a collection of workers and current staffing information. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_absence_management_get_workers_by_id_eligibleabsencetypes

Retrieves a collection of eligible absence types for the specified worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
categorystringNo—The Workday ID of the absence type category. Valid values: * Leave of Absence Type: 17bd6531c90c100016d74f8dfae007d0 * Absence Table: 17bd6531c90c100016da3f5b554007d2 * Time Off: 17bd6531c90c100016d4b06f2b8a07ce
effectivestringNo—The effective date for which eligible absence types need to be returned for the worker.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_absence_management_get_workers_by_id_eligibleabsencetypes_by_subresourceid

Retrieves the eligible absence type for the specified worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_absence_management_get_workers_by_id_leavesofabsence

Retrieves the Leaves Of Absence for a specified worker ID. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
fromDatestringNo—The start of a date range filter using the yyyy-mm-dd format.
leaveTypeany[]No—The Workday ID of the type of leave of absence. You can specify multiple leaveType query parameters.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
statusany[]No—The Workday ID of the status of the leave of absence. The valid statuses are Successfully Completed, In Progress, Canceled, Rescinded, and Process Terminated. To get valid values, call the GET /values/leave/status endpoint. You can specify multiple status query parameters.
toDatestringNo—The end of a date range filter using the yyyy-mm-dd format.

​
workday_absence_management_get_workers_by_id_leavesofabsence_by_subresourceid

Retrieves the leave of absence for the specified worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_absence_management_get_workers_by_id_timeoffdetails

Retrieves a collection of time off details for a specified worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
fromDatestringNo—The start of a date range filter using the yyyy-mm-dd format.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
statusany[]No—The Workday ID of the time off status. You can specify multiple status query parameters. This method returns the most recent instance of a time off entry based on this query parameter. The valid statuses are Approved, Submitted, Not Submitted, and Sent Back. This method does not return Canceled and Denied Time Off Entries. To get the Workday ID of a status, call the GET /values/timeOff/status endpoint. You can specify multiple status query parameters. Example: An approved Time Off Entry for Vacation 8 hours was corrected to Vacation 4 hours and is not in submitted status. If the query parameter is status = approved, the Time Off Entry of Vacation, 8 hours, Approved is returned. If query parameter status = submitted, the Time Off Entry of Vacation, 4 hours, Submitted is returned. If no query parameter is passed, the Time Off Entry of Vacation, 4 hours, Submitted is returned.
timeOffTypeany[]No—The Workday ID of the Time Off Type. You can specify multiple timeOffType query parameters.
toDatestringNo—The end of a date range filter using the yyyy-mm-dd format.

​
workday_absence_management_get_workers_by_id_timeoffdetails_by_subresourceid

Retrieves details of a specified time off entry for a specified worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_absence_management_get_workers_by_id_validtimeoffdates

Retrieves the valid time off dates for the specified worker ID for the given dates. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
datestringNo—The dates being requested for which to validate. It should be in the yyyy-mm-dd format.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
positionstringNo—The Workday ID of the position.
timeOffstringNo—The Workday ID of the time off.

​
workday_absence_management_post_workers_by_id_correcttimeoffentry

Creates a time off correction for the specified worker ID and initiates the business process. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
businessProcessParametersobjectNo—The Action Event instance to be used with businessProcessLinkable linked service representations.
daysany[]No—The time off correction entries.
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.

​
workday_absence_management_post_workers_by_id_requesttimeoff

Creates a time off request for the specified worker ID and initiates the business process. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
businessProcessParametersobjectNo—The Action Event instance to be used with businessProcessLinkable linked service representations.
daysany[]No—Time Off Entries

​
workday-accounts-payable

Workday Accounts Payable - supplier invoice requests, attachments, lines Server path: /workday-accounts-payable | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_accounts_payable_get_supplierinvoicerequestsRetrieves a collection of supplier invoices.
workday_accounts_payable_get_supplierinvoicerequests_by_idRetrieves a single supplier invoice instance.
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachmentsRetrieves a collection of attachments for the specified supplier invoice.
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceidRetrieves a single attachment instance.
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid_viewcontent<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s)
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_viewcontent<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s)
workday_accounts_payable_get_supplierinvoicerequests_by_id_linesRetrieves a collection of supplier invoice lines.
workday_accounts_payable_get_supplierinvoicerequests_by_id_lines_by_subresourceidRetrieves a single supplier invoice line instance.
workday_accounts_payable_post_sendsupplierinvoiceattachmentsforscanningSends supplier invoice attachments for scanning.
workday_accounts_payable_post_supplierinvoicerequestsCreates the supplier invoice as specified in the request.
workday_accounts_payable_post_supplierinvoicerequests_by_id_attachmentsCreates a new attachment for the supplier invoice.
workday_accounts_payable_post_supplierinvoicerequests_by_id_submitSubmits a single supplier invoice instance.

​
workday_accounts_payable_get_supplierinvoicerequests

Retrieves a collection of supplier invoices. Parameters:
ParameterTypeRequiredDefaultDescription
companyany[]No—The company for the Common Financial Dimensions. This is for internal use only on a REST API.
fromDueDatestringNo—The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date.
fromInvoiceDatestringNo—The date on or after which the supplier invoice is created using the MM/DD/YYYY format.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
requesterany[]No—The ID of the worker generating the supplier invoice request.
statusany[]No—The status of the supplier invoice request. This is for internal use only on a REST API.
supplierany[]No—The supplier on the business documents.
toDueDatestringNo—The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date.
toInvoiceDatestringNo—The date on or before which the supplier invoice is created using the MM/DD/YYYY format.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id

Retrieves a single supplier invoice instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments

Retrieves a collection of attachments for the specified supplier invoice. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid

Retrieves a single attachment instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_by_subresourceid_viewcontent

<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s) Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id_attachments_viewcontent

<b>Secured by:</b> Process: Supplier Invoice - Request, View: Supplier Invoice Request <b>Scope:</b> Supplier Accounts Contains attachment(s) Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id_lines

Retrieves a collection of supplier invoice lines. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_accounts_payable_get_supplierinvoicerequests_by_id_lines_by_subresourceid

Retrieves a single supplier invoice line instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_accounts_payable_post_sendsupplierinvoiceattachmentsforscanning

Sends supplier invoice attachments for scanning. Parameters:
ParameterTypeRequiredDefaultDescription
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
ocrSupplierInvoicesany[]No—Container for OCR Supplier Invoice Root.

​
workday_accounts_payable_post_supplierinvoicerequests

Creates the supplier invoice as specified in the request. Parameters:
ParameterTypeRequiredDefaultDescription
companyobjectYes—The company used for Common Financial Dimensions. This is for internal use only on a REST API.
controlTotalAmountobjectNo—The amount entered that should match the total of the line amounts.
currencyobjectNo—The currency for the reporting transaction.
descriptorstringNo—The display name of the instance
freightAmountobjectNo—Freight amount for the supplier invoice request.
handlingCodeobjectNo—The handling code for Supplier Invoice Request.
idstringNo—Workday Id or Reference Id of the instance.
invoiceDatestringYes—The date when a request for a supplier invoice is created.
invoiceReceivedDatestringNo—The date an invoice is received.
linesany[]No—The Supplier Invoice Request Lines for a Supplier Invoice Request.
memostringNo—The memo for the Supplier Invoice Request.
paymentTermsobjectNo—The payment terms of the customer defined on the transaction or payment terms defined on the transaction directly. You can use this field to drill into details and access the related actions menu.
referenceNumberstringNo—The reference number encoded with the key payment information on the supplier invoice request.
referenceTypeobjectNo—The type of reference used to encode key payment information on the invoice documents.
remitToConnectionobjectNo—The remit-to address for the supplier on the supplier invoice request.
requesterobjectNo—The requester of the supplier invoice request.
shipToAddressobjectNo—The shipping address for Supplier Invoice Request.
statutoryInvoiceTypeobjectNo—The Invoice Type selected on the supplier invoice request.
supplierobjectYes—The supplier for the business documents. This field allows you to drill into the details and access related actions.
suppliersInvoiceNumberstringNo—The reference number provided by the supplier for the supplier invoice request.
taxAmountobjectNo—Tax amount for the supplier invoice request.

​
workday_accounts_payable_post_supplierinvoicerequests_by_id_attachments

Creates a new attachment for the supplier invoice. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
contentTypeobjectNo—Content type of the attachment.
descriptorstringNo—The display name of the instance
fileLengthintegerNo—File length of the attachment.
fileNamestringNo—File name of the attachment.
idstringNo—Workday Id or Reference Id of the instance.

​
workday_accounts_payable_post_supplierinvoicerequests_by_id_submit

Submits a single supplier invoice instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.

​
workday-business-process

Workday Business Process - events, event steps, approvals, comments Server path: /workday-business-process | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_business_process_get_eventsRetrieves business process events.
workday_business_process_get_events_by_idRetrieves a business process event.
workday_business_process_get_events_by_id_attachmentsRetrieves attachments for a business process event.
workday_business_process_get_events_by_id_commentsRetrieves comments for a business process event.
workday_business_process_get_events_by_id_completedstepsRetrieves completed steps for a business process event.
workday_business_process_get_events_by_id_inprogressstepsRetrieves in progress steps for a business process event.
workday_business_process_get_events_by_id_remainingstepsRetrieves remaining steps for a business process event.
workday_business_process_get_eventstepsRetrieves business process event steps.
workday_business_process_get_eventsteps_by_idRetrieves a business process event step.
workday_business_process_get_typesRetrieves all business process types.
workday_business_process_get_types_by_idRetrieves a business process type.
workday_business_process_get_types_by_id_attachmentcategoriesRetrieves attachment categories for a business process type.
workday_business_process_get_values_sendback_toRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Public Business Processes <b>Scope:</b> Tenant Non-Configurable
workday_business_process_post_events_by_id_cancelCancels a business process event.
workday_business_process_post_events_by_id_rescindRescinds a business process event.
workday_business_process_post_eventsteps_by_id_approveApproves a business process event step.
workday_business_process_post_eventsteps_by_id_denyDenies a business process event step.
workday_business_process_post_eventsteps_by_id_questionnairePost an action for a Complete Questionnaire step in a business process.
workday_business_process_post_eventsteps_by_id_sendbackSends back a business process event step.
workday_business_process_post_eventsteps_by_id_todoPost an action for a To Do step in a business process.

​
workday_business_process_get_events

Retrieves business process events. Parameters:
ParameterTypeRequiredDefaultDescription
businessProcessany[]No—businessProcess
completedOnOrAfterstringNo—completedOnOrAfter
completedOnOrBeforestringNo—completedOnOrBefore
initiatedOnOrAfterstringNo—initiatedOnOrAfter
initiatedOnOrBeforestringNo—initiatedOnOrBefore
initiatorany[]No—initiator
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
statusany[]No—status
workerstringNo—worker

​
workday_business_process_get_events_by_id

Retrieves a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_business_process_get_events_by_id_attachments

Retrieves attachments for a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_events_by_id_comments

Retrieves comments for a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_events_by_id_completedsteps

Retrieves completed steps for a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_events_by_id_inprogresssteps

Retrieves in progress steps for a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_events_by_id_remainingsteps

Retrieves remaining steps for a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_eventsteps

Retrieves business process event steps. Parameters:
ParameterTypeRequiredDefaultDescription
businessProcessany[]No—businessProcess
createdOnOrAfterstringNo—createdOnOrAfter
createdOnOrBeforestringNo—createdOnOrBefore
dueDateOnOrAfterstringNo—dueDateOnOrAfter
dueDateOnOrBeforestringNo—dueDateOnOrBefore
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
stepTypeany[]No—stepType

​
workday_business_process_get_eventsteps_by_id

Retrieves a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_business_process_get_types

Retrieves all business process types. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_types_by_id

Retrieves a business process type. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_business_process_get_types_by_id_attachmentcategories

Retrieves attachment categories for a business process type. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
eventTargetstringNo—The Workday ID of the event target that this business process is about. You can use a returned id from an API that returns instances of the event target type. For example, if your event target is a worker, use GET /workers in the Staffing service.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_business_process_get_values_sendback_to

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Public Business Processes <b>Scope:</b> Tenant Non-Configurable Parameters:
ParameterTypeRequiredDefaultDescription
eventStepstringNo—eventStep
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_business_process_post_events_by_id_cancel

Cancels a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
commentstringNo—comment
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
statusstringNo—status

​
workday_business_process_post_events_by_id_rescind

Rescinds a business process event. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
commentstringNo—comment
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
statusstringNo—status

​
workday_business_process_post_eventsteps_by_id_approve

Approves a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
commentstringNo—Returns user’s comment for Event Record.
descriptorstringNo—The display name of the instance
eventStatusobjectNo—Returns the Workflow State of the current Action Event
idstringNo—Workday Id or Reference Id of the instance.

​
workday_business_process_post_eventsteps_by_id_deny

Denies a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
commentstringNo—Returns user’s comment for Event Record.
descriptorstringNo—The display name of the instance
eventStatusobjectNo—Returns the Workflow State of the current Action Event
idstringNo—Workday Id or Reference Id of the instance.
stepActionobjectNo—The status of this business process step.

​
workday_business_process_post_eventsteps_by_id_questionnaire

Post an action for a Complete Questionnaire step in a business process. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
questionnaireResponseobjectNo—Questionnaire Response
stepActionobjectNo—The status of the step

​
workday_business_process_post_eventsteps_by_id_sendback

Sends back a business process event step. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
reasonstringYes—Returns user’s comment for Event Record.
statusobjectNo—The status of this business process step.
toobjectYes—a set containing no instances

​
workday_business_process_post_eventsteps_by_id_todo

Post an action for a To Do step in a business process. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
commentstringNo—Last Comment
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
stepActionobjectYes—The status of the step

​
workday-common

Workday Common - workers, organizations, currencies, supervisory organizations, job changes Server path: /workday-common | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_common_get_businesstitlechanges_by_idRetrieves a business title change instance.
workday_common_get_currenciesRetrieves a collection of currencies.
workday_common_get_currencies_by_idRetrieves a currency instance.
workday_common_get_customers_by_idRetrieves a customer instance.
workday_common_get_customers_by_id_activitiesRetrieves a collection of activities for a specific customer.
workday_common_get_customers_by_id_activities_by_subresourceidRetrieves an activity instance for a specific customer.
workday_common_get_jobchangereasonsRetrieves a collection of job change reasons.
workday_common_get_jobchangereasons_by_idRetrieves a job change reason instance.
workday_common_get_organizationsRetrieves a collection of organizations.
workday_common_get_organizations_by_idRetrieves an organization instance.
workday_common_get_organizationtypesRetrieves a collection of organization types.
workday_common_get_organizationtypes_by_idRetrieves an organization type instance.
workday_common_get_supervisoryorganizationsRetrieves a collection of supervisory organizations.
workday_common_get_supervisoryorganizations_by_idRetrieves a supervisory organization instance.
workday_common_get_supervisoryorganizations_by_id_workersRetrieves a collection of workers for a specific supervisory organization.
workday_common_get_supervisoryorganizations_by_id_workers_by_subresourceidRetrieves a worker instance for a specific supervisory organization.
workday_common_get_workersRetrieves a collection of workers.
workday_common_get_workers_by_idRetrieves a worker instance.
workday_common_get_workers_by_id_businesstitlechangesRetrieves a collection of business title changes for a specific worker.
workday_common_get_workers_by_id_businesstitlechanges_by_subresourceidRetrieves a business title change instance for a specific worker.
workday_common_get_workers_by_id_directreportsRetrieves a collection of direct reports for a specific worker.
workday_common_get_workers_by_id_directreports_by_subresourceidRetrieves a direct report instance for a specific worker.
workday_common_get_workers_by_id_historyRetrieves a collection of history items for a specific worker.
workday_common_get_workers_by_id_history_by_subresourceidRetrieves a history instance for a specific worker.
workday_common_get_workers_by_id_inboxtasksRetrieves a collection of inbox tasks for a specific worker.
workday_common_get_workers_by_id_inboxtasks_by_subresourceidRetrieves an inbox task instance for a specific worker.
workday_common_get_workers_by_id_organizationsRetrieves a collection of organizations for a specific worker.
workday_common_get_workers_by_id_organizations_by_subresourceidRetrieves an organization instance for a specific worker.
workday_common_get_workers_by_id_payslipsRetrieves a collection of pay slips for a specific worker.
workday_common_get_workers_by_id_payslips_by_subresourceidRetrieves a pay slip instance for a specific worker.
workday_common_get_workers_by_id_supervisoryorganizationsmanagedRetrieves a collection of supervisory organizations managed by a specific worker.
workday_common_get_workers_by_id_supervisoryorganizationsmanaged_by_subresourceidRetrieves a supervisory organization managed by a specific worker.
workday_common_get_workers_by_id_timeoffentriesRetrieves a collection of time off entries for a specific worker.
workday_common_get_workers_by_id_timeoffentries_by_subresourceidRetrieves a time off entry for a specific worker.
workday_common_get_workers_by_id_timeoffplansRetrieves a collection of time off plans for a specific worker.
workday_common_get_workers_by_id_timeoffplans_by_subresourceidRetrieves a particular time off plan for a specific worker.
workday_common_post_workers_by_id_businesstitlechangesCreates a business title change instance with the specified data.
workday_common_post_workers_by_id_businesstitlechanges_me<b>Secured by:</b> Change My Business Title <b>Scope:</b> Staffing
workday_common_post_workers_by_id_jobchangesCreates a job change instance with the specified data.

​
workday_common_get_businesstitlechanges_by_id

Retrieves a business title change instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_currencies

Retrieves a collection of currencies. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_currencies_by_id

Retrieves a currency instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_customers_by_id

Retrieves a customer instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_customers_by_id_activities

Retrieves a collection of activities for a specific customer. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
fromDatestringNo—fromDate
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
toDatestringNo—toDate

​
workday_common_get_customers_by_id_activities_by_subresourceid

Retrieves an activity instance for a specific customer. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_jobchangereasons

Retrieves a collection of job change reasons. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_jobchangereasons_by_id

Retrieves a job change reason instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_organizations

Retrieves a collection of organizations. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
organizationTypestringNo—Reference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type.

​
workday_common_get_organizations_by_id

Retrieves an organization instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_organizationtypes

Retrieves a collection of organization types. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_organizationtypes_by_id

Retrieves an organization type instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_supervisoryorganizations

Retrieves a collection of supervisory organizations. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_supervisoryorganizations_by_id

Retrieves a supervisory organization instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_supervisoryorganizations_by_id_workers

Retrieves a collection of workers for a specific supervisory organization. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_supervisoryorganizations_by_id_workers_by_subresourceid

Retrieves a worker instance for a specific supervisory organization. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers

Retrieves a collection of workers. Parameters:
ParameterTypeRequiredDefaultDescription
includeTerminatedWorkersbooleanNo—Include terminated workers in the output
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
searchstringNo—search

​
workday_common_get_workers_by_id

Retrieves a worker instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_common_get_workers_by_id_businesstitlechanges

Retrieves a collection of business title changes for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_businesstitlechanges_by_subresourceid

Retrieves a business title change instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_directreports

Retrieves a collection of direct reports for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_directreports_by_subresourceid

Retrieves a direct report instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_history

Retrieves a collection of history items for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_history_by_subresourceid

Retrieves a history instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_inboxtasks

Retrieves a collection of inbox tasks for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_inboxtasks_by_subresourceid

Retrieves an inbox task instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_organizations

Retrieves a collection of organizations for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_organizations_by_subresourceid

Retrieves an organization instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_payslips

Retrieves a collection of pay slips for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_payslips_by_subresourceid

Retrieves a pay slip instance for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_supervisoryorganizationsmanaged

Retrieves a collection of supervisory organizations managed by a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_supervisoryorganizationsmanaged_by_subresourceid

Retrieves a supervisory organization managed by a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_timeoffentries

Retrieves a collection of time off entries for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_timeoffentries_by_subresourceid

Retrieves a time off entry for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_get_workers_by_id_timeoffplans

Retrieves a collection of time off plans for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_common_get_workers_by_id_timeoffplans_by_subresourceid

Retrieves a particular time off plan for a specific worker. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_common_post_workers_by_id_businesstitlechanges

Creates a business title change instance with the specified data. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
hrefstringNo—A link to the instance
idstringNo—Workday Id or Reference Id of the instance.
proposedBusinessTitlestringNo—The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.

​
workday_common_post_workers_by_id_businesstitlechanges_me

<b>Secured by:</b> Change My Business Title <b>Scope:</b> Staffing Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
hrefstringNo—A link to the instance
idstringNo—Workday Id or Reference Id of the instance.
proposedBusinessTitlestringNo—The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name.

​
workday_common_post_workers_by_id_jobchanges

Creates a job change instance with the specified data. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
effectivestringNo—The date this business process takes effect.
hrefstringNo—A link to the instance
idstringNo—Workday Id or Reference Id of the instance.
jobChangeReasonobjectNo—Returns the reason used in a Change Job business process.
moveManagersTeambooleanNo—Returns a boolean that indicates whether teams reporting to the ~Manager~ moved with them during the Change Job Event.
proposedOrganizationsany[]No—Contains the organizations with staffing behavior that are assigned to the position as a result of this event. All staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit).
supervisoryOrganizationobjectNo—The ~supervisory organization~ for the ~worker~ as of the effective date.

​
workday-compensation

Workday Compensation - scorecards, scorecard results, one-time payments 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
IDstringYes—The Workday ID of the resource.

​
workday_compensation_delete_scorecards_by_id

Deletes a Compensation Scorecard with the specified ID. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_compensation_get_scorecardresults

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

​
workday_compensation_get_scorecardresults_by_id

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

​
workday_compensation_get_scorecards

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

​
workday_compensation_get_scorecards_by_id

Retrieves Compensation Scorecard information. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_compensation_get_workers

Retrieves a collection of workers. Parameters:
ParameterTypeRequiredDefaultDescription
includeTerminatedWorkersbooleanNo—Include terminated workers in the output
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
searchstringNo—search

​
workday_compensation_get_workers_by_id

Retrieves a worker instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_compensation_patch_scorecardresults_by_id_scores_by_subresourceid

Updates the Score for the specified Scorecard Result. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.
achievementnumberNo—The achievement percentage for the scorecard criteria result.
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.

​
workday_compensation_post_scorecardresults

Creates a new Scorecard Result. Parameters:
ParameterTypeRequiredDefaultDescription
descriptorstringNo—The display name of the instance
evaluationDatestringYes—Scorecard Result Evaluation Date
idstringNo—Workday Id or Reference Id of the instance.
scorecardIDobjectYes—Returns the Default Scorecard for the Scorecard Result Instance
scorecardNamestringNo—The ~goal~ name of the scorecard criteria result.

​
workday_compensation_post_scorecards

Creates a Compensation Scorecard Parameters:
ParameterTypeRequiredDefaultDescription
defaultScorecardGoalsany[]Yes—The ~goals~ for the Compensation Scorecard.
effectiveDatestringYes—The Effective Date of the Compensation Scorecard in format YYYY-MM-DD
idstringNo—Workday Id or Reference Id of the instance.
inactivebooleanNo—Indicates whether the Scorecard is inactive using a value of true/false.
scorecardDescriptionstringNo—The description of the Compensation Scorecard.
scorecardNamestringYes—The name of the Compensation Scorecard.
scorecardProfilesany[]No—The 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
IDstringYes—The Workday ID of the resource.
descriptorstringNo—The display name of the instance
effectiveDatestringNo—The date this business process takes effect.
employeeVisibilityDatestringNo—Returns the date that a compensation change is visible to a ~worker~.
idstringNo—Workday Id or Reference Id of the instance.
oneTimePaymentsany[]No—All one-time payments associated with the event.
positionobjectNo—Position Element
reasonobjectNo—The 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
IDstringYes—The Workday ID of the resource.
defaultScorecardGoalsany[]Yes—Replaces the array of Default Scorecard Goal fields as of the specified effectiveDate.
effectiveDatestringYes—The Effective Date of the updates to the Compensation Scorecard. Date must be entered in format: YYYY-MM-DD.
idstringNo—Workday Id or Reference Id of the instance.
inactivebooleanNo—Replaces the inactive status of the Compensation Scorecard as of the specified effectiveDate. Default value: false.
scorecardDescriptionstringNo—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.
scorecardNamestringYes—Replaces the name of the Compensation Scorecard as of the specified effectiveDate.
scorecardProfilesany[]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.

​
workday-connect

Workday Connect - message templates, notification types, send messages Server path: /workday-connect | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_connect_get_messagetemplatesRetrieves a collection of message templates.
workday_connect_get_messagetemplates_by_idRetrieves a message template with the specific ID.
workday_connect_get_notificationtypesRetrieves a collection of notification types.
workday_connect_get_notificationtypes_by_idRetrieves a notification type.
workday_connect_get_values_audiencepromptgroup_audiencetypeRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System
workday_connect_get_values_audiencepromptgroup_selectionRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System
workday_connect_patch_messagetemplates_by_idPartially updates an existing message template instance.
workday_connect_post_messagetemplates<b>Secured by:</b> Set Up: Message Templates <b>Scope:</b> Learning Core, System
workday_connect_post_sendmessagesendMessage API
workday_connect_put_messagetemplates_by_idUpdates an existing message template instance.

​
workday_connect_get_messagetemplates

Retrieves a collection of message templates. Parameters:
ParameterTypeRequiredDefaultDescription
inactivebooleanNo—inactive
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
namestringNo—name
notificationTypestringNo—notificationType
offsetintegerNo—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.

​
workday_connect_get_messagetemplates_by_id

Retrieves a message template with the specific ID. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_connect_get_notificationtypes

Retrieves a collection of notification types. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_connect_get_notificationtypes_by_id

Retrieves a notification type. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_connect_get_values_audiencepromptgroup_audiencetype

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System Parameters:
ParameterTypeRequiredDefaultDescription
audienceTypeParmstringNo—audienceTypeParm
connectTypestringNo—connectType
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_connect_get_values_audiencepromptgroup_selection

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System Parameters:
ParameterTypeRequiredDefaultDescription
audienceTypeParmstringNo—audienceTypeParm
connectTypestringNo—connectType
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_connect_patch_messagetemplates_by_id

Partially updates an existing message template instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
createdByobjectNo—Message Template creator.
createdOnstringNo—Gives the date that the instance was originally created.
descriptorstringNo—The display name of the instance
emailDetailobjectNo—Email Configuration container for REST API.
idstringNo—Workday Id or Reference Id of the instance.
inactivebooleanNo—Indicates template is active or has been disabled.
lastUpdatedstringNo—lastUpdated
lastUpdatedByobjectNo—Person who last updated the instance.
namestringYes—Message Template Name
notificationTypeobjectYes—Notification Type indicates where the template can be used.
pushDetailobjectNo—Container for push notification data, used in REST API.
referenceIDstringNo—The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the ‘Organization ID’
usageCountintegerNo—Count of instances using this Message Template

​
workday_connect_post_messagetemplates

<b>Secured by:</b> Set Up: Message Templates <b>Scope:</b> Learning Core, System Parameters:
ParameterTypeRequiredDefaultDescription
createdByobjectNo—Message Template creator.
createdOnstringNo—Gives the date that the instance was originally created.
descriptorstringNo—The display name of the instance
emailDetailobjectNo—Email Configuration container for REST API.
idstringNo—Workday Id or Reference Id of the instance.
inactivebooleanNo—Indicates template is active or has been disabled.
lastUpdatedstringNo—lastUpdated
lastUpdatedByobjectNo—Person who last updated the instance.
namestringYes—Message Template Name
notificationTypeobjectYes—Notification Type indicates where the template can be used.
pushDetailobjectNo—Container for push notification data, used in REST API.
referenceIDstringNo—The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the ‘Organization ID’
usageCountintegerNo—Count of instances using this Message Template

​
workday_connect_post_sendmessage

sendMessage API Parameters:
ParameterTypeRequiredDefaultDescription
commIDobjectNo—Group Communication
emailDetailobjectNo—Email Configuration Data
messageTemplateobjectNo—Message Template used by Ad-hoc/Group Communications
notificationTypeobjectNo—Notification Type indicates where the template can be used.
pushDetailobjectNo—Container for push notification data, used in REST API
recipientsobjectNo—This field is just used by REST framework to provide a container, there is no real data behind it.
senderOverrideobjectNo—This field affects the sender icon that will be displayed in the Workday Inbox.

​
workday_connect_put_messagetemplates_by_id

Updates an existing message template instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
createdByobjectNo—Message Template creator.
createdOnstringNo—Gives the date that the instance was originally created.
descriptorstringNo—The display name of the instance
emailDetailobjectNo—Email Configuration container for REST API.
idstringNo—Workday Id or Reference Id of the instance.
inactivebooleanNo—Indicates template is active or has been disabled.
lastUpdatedstringNo—lastUpdated
lastUpdatedByobjectNo—Person who last updated the instance.
namestringYes—Message Template Name
notificationTypeobjectYes—Notification Type indicates where the template can be used.
pushDetailobjectNo—Container for push notification data, used in REST API.
referenceIDstringNo—The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the ‘Organization ID’
usageCountintegerNo—Count of instances using this Message Template

​
workday-customer-accounts

Workday Customer Accounts - customers, invoices, payments Server path: /workday-customer-accounts | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_customer_accounts_get_customersRetrieves a collection of customers.
workday_customer_accounts_get_customers_by_idRetrieves a single customer instance.
workday_customer_accounts_get_invoicesRetrieves a collection of customer invoices and adjustments.
workday_customer_accounts_get_invoices_by_idRetrieves a single customer invoice or adjustment instance.
workday_customer_accounts_get_invoices_by_id_printrunsRetrieves a collection of customer invoice print runs for the specified customer invoice or adjustment.
workday_customer_accounts_get_invoices_by_id_printruns_by_subresourceidRetrieves a single customer invoice print run.
workday_customer_accounts_get_payments_by_idRetrieves a single customer invoice payment instance.
workday_customer_accounts_get_payments_by_id_remittancedetails_by_subresourceidRetrieves a single customer invoice payment remittance line instance.
workday_customer_accounts_post_paymentsCreates customer invoice payments.
workday_customer_accounts_post_payments_by_id_remittancedetailsCreates customer invoice payment remittance lines.

​
workday_customer_accounts_get_customers

Retrieves a collection of customers. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
namestringNo—name
offsetintegerNo—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.

​
workday_customer_accounts_get_customers_by_id

Retrieves a single customer instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_customer_accounts_get_invoices

Retrieves a collection of customer invoices and adjustments. Parameters:
ParameterTypeRequiredDefaultDescription
billToCustomerany[]No—The customer on the invoice.
companyany[]No—company
fromDueDatestringNo—The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
fromInvoiceDatestringNo—The date of the customer invoice, formatted as YYYY-MM-DD.
invoiceStatusany[]No—The current status of an invoice document. Include invoices with these invoice statuses: Approved (91b0d382d50848e898733757caa9f84a), Canceled (dc76c9b6446c11de98360015c5e6daf6), Denied (dc76c7cc446c11de98360015c5e6daf6), Draft (dc76c4fc446c11de98360015c5e6daf6), Incomplete(e264bc68581342baa70ab61bf71032fe), In Progress (dc76c8bc446c11de98360015c5e6daf6).
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
paymentStatusany[]No—The payment status of an invoice document. Include invoices with these payments statuses: Paid (d9e4362a446c11de98360015c5e6daf6), Unpaid (d9e43940446c11de98360015c5e6daf6), Partially Paid (d9e43706446c11de98360015c5e6daf6).
toDueDatestringNo—The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD.
toInvoiceDatestringNo—The date of the customer invoice, formatted as YYYY-MM-DD.
transactionTypestringNo—The transaction type of this customer transaction. Use the string “invoice” or “adjustment” to filter to retrieve either only invoices or adjustments.

​
workday_customer_accounts_get_invoices_by_id

Retrieves a single customer invoice or adjustment instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_customer_accounts_get_invoices_by_id_printruns

Retrieves a collection of customer invoice print runs for the specified customer invoice or adjustment. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_customer_accounts_get_invoices_by_id_printruns_by_subresourceid

Retrieves a single customer invoice print run. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_customer_accounts_get_payments_by_id

Retrieves a single customer invoice payment instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_customer_accounts_get_payments_by_id_remittancedetails_by_subresourceid

Retrieves a single customer invoice payment remittance line instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_customer_accounts_post_payments

Creates customer invoice payments. Parameters:
ParameterTypeRequiredDefaultDescription
amountobjectNo—The amount of the customer payment in transaction currency.
companyobjectNo—The company for the customer invoice.
datestringNo—The date the customer payment was made.
descriptorstringNo—The display name of the instance
idstringNo—Workday Id or Reference Id of the instance.
memostringNo—A memo associated with the customer payment.
readyToAutoApplybooleanNo—True if the customer payment is ready for automatic application for a cash sale.
referencestringNo—The reference to a customer payment that’s processed through a settlement run. This field is blank when the Payment Status is In Progress or when the Payment Type is Check or ETF.
remitFromCustomerobjectNo—The customer for the invoice.
transactionNumberstringNo—The transaction number for the reporting transaction.
typeobjectNo—The payment type for the reporting transaction.

​
workday_customer_accounts_post_payments_by_id_remittancedetails

Creates customer invoice payment remittance lines. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
amountToPayobjectNo—The amount to pay specified on the invoice line of the customer payment.
billToCustomerobjectNo—The bill-to customer or sponsor specified on the invoice line of the customer payment.
idstringNo—Workday Id or Reference Id of the instance.
invoiceobjectNo—The invoice associated with the payment remittance.

​
workday-payroll

Workday Payroll - pay groups, payroll inputs, tax rates Server path: /workday-payroll | Type: Application | PCID required: Yes

​
Tools

ToolDescription
workday_payroll_delete_payrollinputs_by_idDeletes an existing payroll input instance.
workday_payroll_get_jobsRetrieves a collection of jobs.
workday_payroll_get_jobs_by_idRetrieves a single job instance.
workday_payroll_get_jobs_by_id_paygroupRetrieves the pay group for a specified job ID. This method always returns 1 pay group.
workday_payroll_get_jobs_by_id_paygroup_by_subresourceidRetrieves a single pay group instance.
workday_payroll_get_minimumwageratesRetrieves a collection of minimum wage rates.
workday_payroll_get_minimumwagerates_by_idRetrieves a collection of minimum wage rates.
workday_payroll_get_paygroupdetailsRetrieves a collection of pay group details.
workday_payroll_get_paygroupdetails_by_idRetrieves a single pay group detail instance.
workday_payroll_get_paygroupsRetrieves a collection of pay groups.
workday_payroll_get_paygroups_by_idRetrieves a single pay group instance.
workday_payroll_get_payrollinputsRetrieves a collection of payroll inputs. At least 1 query parameter is required to get data.
workday_payroll_get_payrollinputs_by_idRetrieves a single payroll input instance.
workday_payroll_get_taxratesRetrieves a single or a collection of company SUI rates.
workday_payroll_get_values_minimumwageratesgroup_countriesRetrieves a list of all countries available as query parameters in the /minimumWageRates endpoint. <b>Secured by:</b> Set Up: Payroll (Minimum Wages View) - CAN, Set Up: Payroll (Minimum Wages View) - USA, Set Up: Payroll Authority Minimum Wages View (Compensation functional area) <b>Scope:</b> CAN Payroll, Core Compensation, USA Payroll
workday_payroll_get_values_minimumwageratesgroup_taxauthoritiesRetrieves a list of tax authorities available for use as query parameters in the /minimumWageRates endpoint. <b>Secured by:</b> Set Up: Payroll (Minimum Wages View) - CAN, Set Up: Payroll (Minimum Wages View) - USA, Set Up: Payroll Authority Minimum Wages View (Compensation functional area) <b>Scope:</b> CAN Payroll, Core Compensation, USA Payroll
workday_payroll_get_values_payrollinputsgroup_paycomponentsRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll
workday_payroll_get_values_payrollinputsgroup_positionsRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll
workday_payroll_get_values_payrollinputsgroup_runcategoriesRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll
workday_payroll_get_values_payrollinputsgroup_worktagsRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll
workday_payroll_get_values_taxratesgroup_companyinstancesRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Process: Tax Filing/W-2s (Run) - USA <b>Scope:</b> USA Payroll
workday_payroll_get_values_taxratesgroup_stateinstancesRetrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Process: Tax Filing/W-2s (Run) - USA <b>Scope:</b> USA Payroll
workday_payroll_patch_payrollinputs_by_idPartially updates an existing payroll input instance.
workday_payroll_post_payrollinputsCreates payroll inputs.
workday_payroll_post_taxratesCreates a single or a collection of Company SUI Rates.

​
workday_payroll_delete_payrollinputs_by_id

Deletes an existing payroll input instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_payroll_get_jobs

Retrieves a collection of jobs. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_payroll_get_jobs_by_id

Retrieves a single job instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_payroll_get_jobs_by_id_paygroup

Retrieves the pay group for a specified job ID. This method always returns 1 pay group. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
effectivestringNo—The effective date of the pay group, using the date format yyyy-mm-dd.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_payroll_get_jobs_by_id_paygroup_by_subresourceid

Retrieves a single pay group instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
subresourceIDstringYes—The Workday ID of the subresource.

​
workday_payroll_get_minimumwagerates

Retrieves a collection of minimum wage rates. Parameters:
ParameterTypeRequiredDefaultDescription
asOfDatestringNo—The minimum wage rates that are effective on the date specified using the yyyy-mm-dd format.
countrystringNo—The Workday ID of the country for the minimum wages rates. You can use a returned id from GET /values/minimumWageRatesGroup/countries. You can specify 1 country query parameter. Example: country=country.
includeLocalTaxAuthoritiesbooleanNo—If true, returns minimum wage rates for local tax authorities, such as cities and counties, in addition to federal and state rates. If false (default), only returns federal and state minimum wage rates.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
taxAuthorityany[]No—The Workday ID of the payroll tax authority for the minimum wages rates. You can use a returned id from GET /values/minimumWageRatesGroup/taxAuthorities. You can specify 1 or more tax authority query parameters. Example: taxAuthority=taxAuthority1&taxAuthority=taxAuthority2.

​
workday_payroll_get_minimumwagerates_by_id

Retrieves a collection of minimum wage rates. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_payroll_get_paygroupdetails

Retrieves a collection of pay group details. Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
runCategoriesany[]No—One or more Workday IDs of run categories for the pay group. You can use returned ids from GET /values/payrollInputsGroup/runCategories.You can specify 1 or more runCategories query parameters, example: runCategories=category1&runCategories=category2

​
workday_payroll_get_paygroupdetails_by_id

Retrieves a single pay group detail instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_payroll_get_paygroups

Retrieves a collection of pay groups. Parameters:
ParameterTypeRequiredDefaultDescription
countrystringNo—The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.

​
workday_payroll_get_paygroups_by_id

Retrieves a single pay group instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_payroll_get_payrollinputs

Retrieves a collection of payroll inputs. At least 1 query parameter is required to get data. Parameters:
ParameterTypeRequiredDefaultDescription
endDatestringNo—The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
payComponentany[]No—The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents.
startDatestringNo—The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd.
workerany[]No—The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service.

​
workday_payroll_get_payrollinputs_by_id

Retrieves a single payroll input instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.

​
workday_payroll_get_taxrates

Retrieves a single or a collection of company SUI rates. Parameters:
ParameterTypeRequiredDefaultDescription
companystringNo—The company reference ID or WID that represents 1 or more companies. Example: company=comp1&company=comp2&company=cb550da820584750aae8f807882fa79a
effectivestringNo—The effective date for the SUI rate, using the yyyy-mm-dd format.
limitintegerNo—The maximum number of objects in a single response. The default is 20. The maximum is 100.
offsetintegerNo—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.
payrollStateAuthorityTaxCodestringNo—The FIPS code or WID that represents 1 or more states. Example: payrollStateAuthorityTaxCode=06&payrollStateAuthorityTaxCode=3b3d378d5f4a48b8b3ac46fee0703226&payrollStateAuthorityTaxCode=48

​
workday_payroll_get_values_minimumwageratesgroup_countries

Retrieves a list of all countries available as query parameters in the /minimumWageRates endpoint. <b>Secured by:</b> Set Up: Payroll (Minimum Wages View) - CAN, Set Up: Payroll (Minimum Wages View) - USA, Set Up: Payroll Authority Minimum Wages View (Compensation functional area) <b>Scope:</b> CAN Payroll, Core Compensation, USA Payroll Parameters:
ParameterTypeRequiredDefaultDescription
countrystringNo—The Workday ID of the country for the tax authorities. You can use a returned id from GET /values/minimumWageRatesGroup/countries. You can specify 1 country query parameter. Example: country=country.
includeLocalTaxAuthoritiesbooleanNo—If true, returns local tax authorities, such as cities and counties, in addition to federal and state tax authorities. If false (default), only returns federal and state tax authorities.
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_payroll_get_values_minimumwageratesgroup_taxauthorities

Retrieves a list of tax authorities available for use as query parameters in the /minimumWageRates endpoint. <b>Secured by:</b> Set Up: Payroll (Minimum Wages View) - CAN, Set Up: Payroll (Minimum Wages View) - USA, Set Up: Payroll Authority Minimum Wages View (Compensation functional area) <b>Scope:</b> CAN Payroll, Core Compensation, USA Payroll Parameters:
ParameterTypeRequiredDefaultDescription
countrystringNo—The Workday ID of the country for the tax authorities. You can use a returned id from GET /values/minimumWageRatesGroup/countries. You can specify 1 country query parameter. Example: country=country.
includeLocalTaxAuthoritiesbooleanNo—If true, returns local tax authorities, such as cities and counties, in addition to federal and state tax authorities. If false (default), only returns federal and state tax authorities.
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_payroll_get_values_payrollinputsgroup_paycomponents

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll Parameters:
ParameterTypeRequiredDefaultDescription
endDatestringNo—The end date for the positions, using the date format yyyy-mm-dd.
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
payComponentstringNo—The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.
startDatestringNo—The start date for the positions, using the date format yyyy-mm-dd.
workerstringNo—The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.

​
workday_payroll_get_values_payrollinputsgroup_positions

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll Parameters:
ParameterTypeRequiredDefaultDescription
endDatestringNo—The end date for the positions, using the date format yyyy-mm-dd.
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
payComponentstringNo—The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.
startDatestringNo—The start date for the positions, using the date format yyyy-mm-dd.
workerstringNo—The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.

​
workday_payroll_get_values_payrollinputsgroup_runcategories

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll Parameters:
ParameterTypeRequiredDefaultDescription
endDatestringNo—The end date for the positions, using the date format yyyy-mm-dd.
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
payComponentstringNo—The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.
startDatestringNo—The start date for the positions, using the date format yyyy-mm-dd.
workerstringNo—The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.

​
workday_payroll_get_values_payrollinputsgroup_worktags

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Worker Data: Payroll Public API (Payroll Input) <b>Scope:</b> Core Payroll Parameters:
ParameterTypeRequiredDefaultDescription
endDatestringNo—The end date for the positions, using the date format yyyy-mm-dd.
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
payComponentstringNo—The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.
startDatestringNo—The start date for the positions, using the date format yyyy-mm-dd.
workerstringNo—The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service.

​
workday_payroll_get_values_taxratesgroup_companyinstances

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Process: Tax Filing/W-2s (Run) - USA <b>Scope:</b> USA Payroll Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_payroll_get_values_taxratesgroup_stateinstances

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Process: Tax Filing/W-2s (Run) - USA <b>Scope:</b> USA Payroll Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNo—The maximum number of objects in a single response. The default and maximum is 1000.
offsetintegerNo—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.
searchstringNo—A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

​
workday_payroll_patch_payrollinputs_by_id

Partially updates an existing payroll input instance. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYes—The Workday ID of the resource.
adjustmentbooleanNo—If true, the input is for an adjustment as opposed to an override.
commentstringNo—The text comment for this input.
currencyobjectNo—The currency for the payroll input. If no currency exists, the system assumes the Pay Group currency. The Pay Group currency is derived from the default currency for the Pay Group country.
descriptorstringNo—The display name of the instance
endDatestringNo—The end date after which this input does not apply.
fieldEditabilitystringNo—The editability status indicating the fields that can be updated in the payroll input request. Possible values: all, none, endDateOnly
idstringNo—Workday Id or Reference Id of the instance.
inputDetailsany[]No—The details for this payroll input.
ongoingbooleanNo—If true, the payroll input is ongoing.
payComponentobjectNo—The pay component for this payroll input.
positionobjectNo—The worker’s position the payroll input applies to if Multi Job Payroll is used.
runCategoriesany[]No—The run category for the payroll input.
startDatestringNo—The start date before which this input does not apply.
workerobjectNo—The worker for this payroll input.
worktagsany[]No—The worktags associated with the payroll input.

​
workday_payroll_post_payrollinputs

Creates payroll inputs. Parameters:
ParameterTypeRequiredDefaultDescription
adjustmentbooleanNo—If true, the input is for an adjustment as opposed to an override.
commentstringNo—The text comment for this input.
currencyobjectNo—The currency for the payroll input. If no currency exists, the system assumes the Pay Group currency. The Pay Group currency is derived from the default currency for the Pay Group country.
descriptorstringNo—The display name of the instance
endDatestringNo—The end date after which this input does not apply.
fieldEditabilitystringNo—The editability status indicating the fields that can be updated in the payroll input request. Possible values: all, none, endDateOnly
idstringNo—Workday Id or Reference Id of the instance.
inputDetailsany[]No—The details for this payroll input.
ongoingbooleanNo—If true, the payroll input is ongoing.
payComponentobjectNo—The pay component for this payroll input.
positionobjectNo—The worker’s position the payroll input applies to if Multi Job Payroll is used.
runCategoriesany[]No—The run category for the payroll input.
startDatestringNo—The start date before which this input does not apply.
workerobjectNo—The worker for this payroll input.
worktagsany[]No—The worktags associated with the payroll input.

​
workday_payroll_post_taxrates

Creates a single or a collection of Company SUI Rates. Parameters:
ParameterTypeRequiredDefaultDescription
applicableRatestringNo—The tax override rate for company tax reporting.
companyInstanceobjectYes—The company object for company tax reporting.
einstringNo—The payroll tax authority EIN field for company tax reporting.
endDatestringNo—The end date for company tax reporting.
exemptbooleanNo—If true, the SUI rate is exempt.
idstringNo—Workday Id or Reference Id of the instance.
startDatestringYes—The start date for company tax reporting.
stateInstanceobjectYes—The payroll tax authority object for company tax reporting.
taxCodestringYes—The deduction for company tax reporting.