JDBC Driver for Workday

Build 24.0.9062

PayrollInputs

Retrieves a single payroll input instance.

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 本製品 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.

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: { /* Returns the Related Calculation for which entry was made on the current \~Worker\~ 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

Id of the instance

Adjustment Bool False

Supported for: SELECT, INSERT, UPDATE. If true, the input is for an adjustment as opposed to an override.

Comment String False

Supported for: SELECT, INSERT, UPDATE. The text comment for this input.

Currency_Descriptor String False

Supported for: SELECT. A description of the instance

Currency_Href String False

Supported for: SELECT. A link to the instance

Currency_Id String False

Supported for: SELECT, INSERT, UPDATE. wid / id / reference id

Descriptor String False

Supported for: SELECT, INSERT, UPDATE. A preview of the instance

EndDate Datetime False

Supported for: SELECT, INSERT, UPDATE. The end date after which this input does not apply.

FieldEditability String False

Supported for: SELECT, INSERT, UPDATE. The editability status indicating the fields that can be updated in the payroll input request. Possible values: all, none, endDateOnly

InputDetails_Aggregate String False

Supported for: INSERT. A JSON aggregate. The details for this payroll input.

Ongoing Bool False

Supported for: SELECT, INSERT, UPDATE. If true, the payroll input is ongoing.

PayComponent_Code String False

Supported for: SELECT, INSERT, UPDATE. The payroll code of the pay component.

PayComponent_Descriptor String False

Supported for: SELECT, INSERT, UPDATE. A preview of the instance

PayComponent_Id String False

Supported for: SELECT, INSERT, UPDATE. Id of the instance

Position_Descriptor String False

Supported for: SELECT. A description of the instance

Position_Href String False

Supported for: SELECT. A link to the instance

Position_Id String False

Supported for: SELECT, INSERT, UPDATE. wid / id / reference id

RunCategories_Aggregate String False

Supported for: INSERT. A JSON aggregate. The run category for the payroll input.

StartDate Datetime False

Supported for: SELECT, INSERT, UPDATE. The start date before which this input does not apply.

Worker_Descriptor String False

Supported for: SELECT, INSERT, UPDATE. A preview of the instance

Worker_Id String False

Supported for: SELECT, INSERT, UPDATE. Id of the instance

Worktags_Aggregate String False

Supported for: INSERT. A JSON aggregate. The worktags associated with the payroll input.

EndDate_Prompt Date False

The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd.

PayComponent_Prompt String False

Accepts multiple inputs. The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents.

StartDate_Prompt Date False

The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd.

Worker_Prompt String False

Accepts multiple inputs. The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062