Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workday Payroll Payroll Summaries API

Access aggregated payroll result summaries

Workday Payroll Payroll Summaries API is one of 21 APIs that Workday Payroll publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 138 JSON Schema definitions.

Tagged areas include Payroll Summaries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 138 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against 2 base URLs: https://api.workday.com/payroll-input/v1, https://{tenant}.workday.com/api/payroll-input/v1.

3 operations 3 paths 6 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.workday.com/payroll/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Workday Payroll Payroll Summaries API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer token obtained through Workday authentication.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Payroll Summaries 3

Access aggregated payroll result summaries

GET
/payRuns/{payRunId}/results
Workday Payroll Get Pay Run Results
getPayRunResults 1 param → 200401404
GET
/payRuns/{payRunId}/results/workers
Workday Payroll List Worker-level Results for a Pay Run
listPayRunWorkerResults 3 params → 200401404
GET
/payRuns/{payRunId}/results/workers/{workerId}
Workday Payroll Get a Worker Result for a Pay Run
getPayRunWorkerResult 2 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PayRunResult (10 properties), WorkerResult (8 properties), Error (2 properties), WorkerResultCollection (2 properties). Each schema is shown below with its type and property counts.

PayPeriod
object
2 properties
WorkerRef
object
2 properties
WorkerResultCollection
object
2 properties
WorkerResult
object
8 properties
Error
object
2 properties
PayRunResult
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-payroll-payroll-summaries-api-openapi.yml Raw ↑

Other APIs Workday Payroll publishes across the network.

Workday Payroll agentDefinition API
Workday Payroll Deductions API
Workday Payroll Earnings API
Workday Payroll Input Batches API
Workday Payroll One-Time Payments API
Workday Payroll Pay Groups API
Workday Payroll Pay Runs API
Workday Payroll Payment Elections API
Workday Payroll Payment Results API
Workday Payroll Payroll Adjustments API
Workday Payroll Payroll Calculations API
Workday Payroll Payslips API