PayrollInputs

Captures and manages individual payroll input records, including employee-specific earnings, deductions, and adjustments for payroll processing.

Workday Resource Information

Retrieves a payroll input with the specified ID.

Secured by: Self-Service: Payroll Public API (Payroll Input), Worker Data: Payroll Public API (Payroll Input)

Scope: Core Payroll

Aggregate Fields

The component represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

InputDetails_Aggregate

[{
  id: Text /* Id of the instance */
  type: { /* The related calculation type for the input line. */
      descriptor: Text /* A preview of the instance */
      id: Text /* Id of the instance */
      name: Text /* The alternate ID of the related calculation for the pay component and pay component related calculation. */
  }
  value: Numeric /* The value for the input line. */
}]

RunCategories_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Worktags_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The unique identifier for the payroll input instance, used to track and reference specific records.
Adjustment	Bool	False	Indicates whether the payroll input is an adjustment. If the value is 'true,' it modifies an existing entry rather than replacing it.
Comment	String	False	A textual comment providing additional details or context about this specific payroll input.
Currency_Descriptor	String	False	A textual representation of the currency associated with this payroll input, typically the currency name or code.
Currency_Href	String	False	A direct URL reference to the currency instance in Workday, allowing navigation to more details about the currency.
Currency_Id	String	False	The unique identifier for the currency associated with the payroll input, which can be a Workday ID (WID), a reference ID, or another system-generated ID.
Descriptor	String	False	A brief textual preview summarizing key details of the payroll input record for easy identification.
EndDate	Datetime	False	The final date on which this payroll input remains applicable. After this date, the input is no longer valid.
FieldEditability	String	False	Specifies which fields in the payroll input request can be modified. Possible values can be all (full edit access), none (read-only), and end date only (only the end date can be changed).
InputDetails_Aggregate	String	False	Comprehensive details related to the payroll input, including metadata, references, or other key attributes.
Ongoing	Bool	False	Indicates whether the payroll input is continuous. If the value is 'true,' the input remains active indefinitely until explicitly ended.
PayComponent_Code	String	False	The code assigned to the pay component associated with this payroll input, used for categorization and processing.
PayComponent_Descriptor	String	False	A brief textual description providing context or details about the associated pay component.
PayComponent_Id	String	False	The unique identifier of the pay component related to this payroll input, used for system tracking and reference.
Position_Descriptor	String	False	A descriptive label or summary identifying the position related to this payroll input.
Position_Href	String	False	A direct URL reference to the position instance in Workday, allowing quick access to position details.
Position_Id	String	False	The unique identifier for the position associated with this payroll input, which can be a WID, a reference ID, or another system-generated ID.
RunCategories_Aggregate	String	False	Specifies the run category assigned to this payroll input, determining how and when it is processed within payroll cycles.
StartDate	Datetime	False	The initial date from which this payroll input becomes effective. Inputs before this date are not considered.
Worker_Descriptor	String	False	A summary or preview identifying the worker associated with this payroll input, typically including the worker’s name.
Worker_Id	String	False	The unique identifier of the worker to whom this payroll input applies, used for tracking and processing.
Worktags_Aggregate	String	False	A collection of worktags linked to this payroll input, which help categorize and track expenses, projects, or other financial allocations.
EndDate_Prompt	Date	False	A filter parameter that retrieves payroll inputs that are active on or before this specified end date. The date must be in the format YYYY-MM-DD.
PayComponent_Prompt	String	False	The WID of the pay component associated with the payroll input.
StartDate_Prompt	Date	False	A filter parameter that retrieves payroll inputs that are active on or after this specified start date. The date must be in the format YYYY-MM-DD.
Worker_Prompt	String	False	The WID of the worker associated with the payroll input. This can be retrieved using GET /workers in the Staffing service.