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 Supplemental Earnings API

Submit supplemental earnings such as bonuses and commissions

Workday Payroll Supplemental Earnings 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 Supplemental Earnings. 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 4 operations across 2 paths, and defines 5 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.

4 operations 2 paths 5 schemas 1 DELETE2 GET1 POST

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 Supplemental Earnings 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Supplemental Earnings 4

Submit supplemental earnings such as bonuses and commissions

GET
/supplementalEarnings
Workday Payroll List Supplemental Earnings
listSupplementalEarnings 3 params → 200401
POST
/supplementalEarnings
Workday Payroll Create a Supplemental Earning
createSupplementalEarning body → 201400401
GET
/supplementalEarnings/{earningId}
Workday Payroll Get a Supplemental Earning
getSupplementalEarning 1 param → 200401404
DELETE
/supplementalEarnings/{earningId}
Workday Payroll Delete a Supplemental Earning
deleteSupplementalEarning 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SupplementalEarning (10 properties), CreateSupplementalEarningRequest (7 properties), Error (2 properties), WorkerRef (2 properties). Each schema is shown below with its type and property counts.

SupplementalEarning
object
10 properties
SupplementalEarningCollection
object
2 properties
CreateSupplementalEarningRequest
object
7 properties 3 required
WorkerRef
object
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-payroll-supplemental-earnings-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 Payroll Summaries API