Retrieving employee pay data safely from Workday requires combining the right interface for each level of detail while keeping every call strictly inside Self-Service: Payroll (My Payslips) (and Self-Service: Pay worklet/card policies): GET /common/v1/workers/{ID}/paySlips returns fast gross-and-net check summaries, WQL (payrollResults), RaaS, or Get_Payroll_Payslips SOAP returns itemized earnings, taxes, and benefit deductions, and Get_Payroll_Pre-Printed_Payslips (or external payslip document integrations) serves printable PDF payslips.
Payroll is the highest-sensitivity functional area in any Workday tenant. Connecting an external portal or AI tool to Payroll via a shared Integration System User (Worker Data: Payroll (Payslips) or Reports: Pay Calculation Results for Worker (Payslips)) risks leaking executive pay or releasing unfinalized off-cycle checks days before payday. Running every query under user-delegated OAuth 2.0 ensures Workday’s own payslip visibility rules and self-service security domains enforce row-level and date-level access automatically.
Comparing Workday’s Four Payslip & Payroll Result Surfaces
Note that the payroll/v2 REST service handles administrative payroll inputs (payrollInputs), pay groups, SUI tax rates, and batch runPayCompleteByResults—not employee payslip retrieval. Employee payslip reads live across these four interfaces under the Core Payroll (or Payroll Interface) scope:
| API Surface | Endpoint / Operation / Data Source | Data Returned | Governing Security Domain |
|---|---|---|---|
API SurfaceCommon REST (v1) |
Endpoint / Operation / Data SourceGET /workers/{ID}/paySlips & /paySlips/{subresourceID} |
Data ReturnedCheck id, date, gross, net, status, and descriptor (summary only; no line items or PDF bytes). |
Governing Security DomainSelf-Service: Payroll (My Payslips) or Worker Data: Payroll (Payslips). |
| API SurfaceWorkday Query Language (WQL) | Endpoint / Operation / Data SourcepayrollResults (with ESS filter) & workersPayslips |
Data ReturnedGross pay, net pay, taxes/deductions summaries, pay period, and mapped pay component amounts. | Governing Security DomainSelf-Service: Payroll (My Payslips) when filtered by current-worker ESS filter; Reports: Pay Calculation Results for Worker for Payroll admins. |
API SurfacePayroll SOAP (Payroll) |
Endpoint / Operation / Data SourceGet_Payroll_Payslips & Get_Payroll_Results |
Data ReturnedFull structured XML breakdown: Run_Category_Data, earnings, deductions, taxes, YTD balances, and remittance data. |
Governing Security DomainCore Payroll SOAP / Self-Service when invoked with user-delegated OAuth Bearer header. |
| API SurfacePre-Printed & External PDF SOAP | Endpoint / Operation / Data SourceGet_Payroll_Pre-Printed_Payslips (Payroll) / External_Payslip_Data (Payroll_Interface) |
Data ReturnedPre-rendered BIRT PDF payslip documents (Payroll_Pre-Printed_Payslip_Document_Data) or third-party vendor PDFs. |
Governing Security DomainProcess: Payslip Bulk Print (batch) or worker self-service document security. |
Step 1: Fetching Fast Check Summaries via common/v1 REST
When an employee opens a self-service pay card or asks “What was my net pay on my last two paychecks?”, start with GET /common/v1/workers/{ID}/paySlips:
GET /ccx/api/common/v1/{tenant}/workers/3aa5550b7fe348b98d7b5741afc6f534/paySlips?limit=5 HTTP/1.1
Authorization: Bearer <user_delegated_access_credential>
Accept: application/jsonWorkday evaluates Self-Service: Payroll (My Payslips) for the signed-in worker (and Terminee As Self if your tenant allows former employees to retrieve final payslips and W-2s after termination) and returns only released checks:
{
"total": 2,
"data": [
{
"id": "8f12c904b7a3100029d411abc0650012",
"descriptor": "11/13/2026 - Regular (11/01/2026 - 11/15/2026)",
"date": "2026-11-13",
"gross": 4850,
"net": 3392,
"status": {
"id": "056982a2aa04100005cc4858775a0026",
"descriptor": "Complete"
}
}
]
}Step 2: Explaining Itemized Earnings, Taxes, and Deductions with WQL or RaaS
Whenever an employee asks why net pay changed between October 30 and November 13—for example, hitting the annual Social Security OASDI wage base cap, changing a 401(k) deferral, or receiving a retroactive bonus—summary gross and net integers are not enough.
To read itemized payroll figures without violating payslip embargo rules, query the payrollResults WQL data source using an ESS-scoped data source filter (filterIsRequired: true), or expose a custom RaaS report built on Payslips for Worker / Payroll Results under user-delegated OAuth (see running RaaS under user-delegated OAuth vs. ISU):
SELECT
period,
payGroupDetail,
grossPay,
taxesDeductions,
netPay,
status,
allPaymentsForPayrollResult
FROM payrollResults(
dataSourceFilter = 'payrollResultsVisibleOnPayslipsForCurrentWorkerCountryPaymentDateRange',
country = 'bc33aa3152ec42d4995f4791a106ed09',
fromPaymentDate = '2026-10-01',
toPaymentDate = '2026-11-15'
)Respecting Payslip Embargo Dates and Hidden Payslips
Why is the payrollResultsVisibleOnPayslipsForCurrentWorkerCountryPaymentDateRange (or payrollResultsVisibleToESSOnDate) filter mandatory?
- Pay Complete Precedes Payday: Payroll teams routinely run Pay Complete (
POST /payroll/v2/runPayCompleteByResults) on Wednesday for a Friday payment date. Between Wednesday afternoon and Friday morning, thePayroll Resulthas statusComplete, yet the employee’s payslip is not yet visible in self-service. - Visibility Overrides and Hidden Checks: Administrators can hide individual checks (
Hide Payslip from Worker,Hide or Display Payslips for Group of Workers), disable online viewing tenant-wide (Edit Tenant Setup - Payroll), or set a time-of-day embargo (Payroll Visibility Time OverrideonEdit Payroll Action Reasonfor US off-cycle checks). - Automatic Enforcement: ESS-visibility filters and
GET /workers/{ID}/paySlipshonor every one of those release timestamps automatically, whereas an privileged administrativeGet_Payroll_Resultsintegration call would expose unreleased checks early.
Step 3: Printable PDF Payslips and Report Designer (BIRT) Architecture
In Workday Payroll (USA, Canada, UK, Ireland, Australia, and France), printable PDF payslips (8.5 in × 11 in US Letter or local A4 layouts) are rendered by Report Designer (BIRT) layouts configured on Maintain Payroll Payslip Configuration and Edit Tenant Setup - Payroll (Print Payslips Using Report Designer Layout in Self-Service):
- Pre-Printing for Peak Payday Traffic: Rendering complex BIRT PDFs with YTD absence balances on the fly for 15,000 employees at 8:00 AM Friday strains tenant report servers. Best practice is enabling Persist Absence Data for Payslips at Pay Complete and scheduling
Schedule BIRT Payslip Pre-Printwith Smart Print Payslips enabled during overnight quiet hours. - Retrieving Pre-Printed or External PDFs: Once pre-printed,
Get_Payroll_Pre-Printed_Payslipsin thePayrollSOAP web service referencesPayroll_Pre-Printed_Payslip_Document_Reference/Payroll_Pre-Printed_Payslip_Document_ID. For countries where payroll runs outside Workday (via Global Payroll Connect or Import External Payslips inPayroll_Interface), Workday stores or links external vendor PDFs underSelf-Service: Payroll Interface. - Zero-Storage Streaming Rule: When serving a payslip PDF or line-item breakdown to an external browser or phone app, stream the response in memory directly to the authenticated employee with
Cache-Control: no-store—never persist PDF payslips in S3 buckets, CDN caches, or application logs.
Organizations building unified employee pay experiences use Kiweely Leaf (coming next) to show live check summaries, YTD breakdowns, and payslip views alongside time off and benefits on a single stateless pass-through screen without a Workday Extend license—or Kiweely Bridge (coming next) so employees can compare two pay periods and understand tax or deduction shifts directly in Claude, ChatGPT, or Gemini under their own Self-Service: Payroll permissions, with zero stored payloads.
Frequently asked questions
Does GET /workers/{ID}/paySlips in the Workday Common v1 REST API return itemized tax and deduction lines?
No. GET /workers/{ID}/paySlips and /paySlips/{subresourceID} return only top-level payslip summary fields: id, descriptor, payment date, gross, net, and status. To retrieve itemized earnings, pre-tax deductions, and taxes, query WQL payrollResults/payrollResultLines, RaaS, or Get_Payroll_Payslips SOAP.
Which Workday security domain controls an employee's ability to read their own payslips over APIs?
Self-Service: Payroll (My Payslips) in the Core Payroll functional area (or Self-Service: Payroll Interface when external third-party payslips are imported) governs employee self-service access, paired with the Core Payroll OAuth API client scope.
Why would an API return a completed Payroll Result before the employee can see their payslip in Workday?
Administrators control payslip release timing via Payslip Printing Options, Hide Payslip from Worker, or Payroll Visibility Time Override on the payroll action reason. Queries must use ESS-visibility filters such as payrollResultsVisibleOnPayslipsForCurrentWorkerCountryPaymentDateRange so future-dated checks stay hidden until release.
How are printable PDF payslips generated and retrieved via Workday web services?
Workday generates PDF payslips from Report Designer (BIRT) layouts either on demand or in advance via the Schedule BIRT Payslip Pre-Print task (Smart Print Payslips). Pre-printed PDF documents are retrieved through Get_Payroll_Pre-Printed_Payslips in the Payroll SOAP web service or external payslip document endpoints.