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 One-Time Payments API

Submit and manage one-time payment requests

Workday Payroll One-Time Payments 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 One-Time Payments. 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 5 operations across 2 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.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 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 One-Time Payments 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 5

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

One-Time Payments 5

Submit and manage one-time payment requests

GET
/oneTimePayments
Workday Payroll List One-time Payments
listOneTimePayments 4 params → 200401
POST
/oneTimePayments
Workday Payroll Create a One-time Payment
createOneTimePayment body → 201400401
GET
/oneTimePayments/{paymentId}
Workday Payroll Get a One-time Payment
getOneTimePayment 1 param → 200401404
PATCH
/oneTimePayments/{paymentId}
Workday Payroll Update a One-time Payment
updateOneTimePayment 1 param body → 200400401404
DELETE
/oneTimePayments/{paymentId}
Workday Payroll Delete a One-time Payment
deleteOneTimePayment 1 param → 204401404

Schemas 6

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

OneTimePaymentCollection
object
2 properties
CreateOneTimePaymentRequest
object
6 properties 3 required
OneTimePayment
object
10 properties
WorkerRef
object
2 properties
UpdateOneTimePaymentRequest
object
3 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-payroll-one-time-payments-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 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
Workday Payroll Payslips API