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 Advanced Compensation Employee Compensation API

Manage individual employee compensation packages

Workday Advanced Compensation Employee Compensation API is one of 8 APIs that Workday Advanced Compensation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 18 JSON Schema definitions.

Tagged areas include Employee Compensation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 18 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version v41.1.

Requests are made against a single base URL, https://{tenant}.workday.com/api/compensation/v1.

2 operations 1 paths 7 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v41.1
Server
https://{tenant}.workday.com/api/compensation/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Workday Advanced Compensation Employee Compensation API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 2 scopes. By default, every request must be authenticated.

  • oauth2 — Workday OAuth 2.0 authentication

Paths & Operations 2

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

Employee Compensation 2

Manage individual employee compensation packages

GET
/employees/{employeeId}/compensation
Workday Get Employee Compensation
getEmployeeCompensation 1 param → 200404403
POST
/employees/{employeeId}/compensation
Workday Submit Compensation Change
submitCompensationChange 1 param body → 201400403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are EmployeeCompensation (7 properties), CompensationChangeResponse (5 properties), CompensationChangeRequest (5 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

CompensationChangeRequest
object
Request to change employee compensation
5 properties 2 required
PayComponent
object
Base pay component
3 properties
EmployeeCompensation
object
Current compensation package for an employee
7 properties
BonusComponent
object
Bonus target component
3 properties
CompensationChangeResponse
object
Response from a compensation change submission
5 properties
StockComponent
object
Stock grant component
2 properties
ErrorResponse
object
Workday API error response
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-advanced-compensation-employee-compensation-api-openapi.yml Raw ↑

Other APIs Workday Advanced Compensation publishes across the network.

Workday Advanced Compensation Bonus Plans API
Workday Advanced Compensation Compensation Budgets API
Workday Advanced Compensation Compensation Grades API
Workday Advanced Compensation Compensation Plans API
Workday Advanced Compensation Compensation Reviews API
Workday Advanced Compensation Merit Plans API
Workday Advanced Compensation Stock Plans API