Workday API v30.2 - Import - Payroll - Input Operation Details

Import_Payroll_Input Operation Details https://community.workday.com/sites/default/files/file-hosting/productio...
Service Directory > v30.2 > Payroll > Import_Payroll_Input
Operation: Import_Payroll_Input
This public web service operation is designed to bulk add/update Payroll Input data from external systems into Workday.
@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.
Contents
Web Service
Request
Response
Elements
Web Service
Payroll (v30.2)
Request
Element: Import_Payroll_Input_Request
Response
Element: Put_Import_Process_Response
Element(s)
Request Element: Import_Payroll_Input_Request

Import Payroll Input Request
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version
Default_Batch_ID string [1..1] Default Batch ID is required. Assign

Batch ID to a set of Payroll Inputs
so external systems can manage
Payroll Input data. To maintain
Payroll Input data by Batch ID, use
the transactions Payroll Input by
Batch ID and Delete Payroll Input
by Batch ID.
Payroll_Input_Data Submit_Payroll_Input_Data [0..*] Submit Payroll Input Data

Validation Description
Batch ID is already associated with Batch ID is

other types of Application Batches. already
[worker] associated with
other types of
Application
Batches.
Rate is not valid for the Pay Rate is not valid

Component. [worker] for the Pay
Component.
Hours is not valid for the Pay

Component. [worker]
Arrears Adjustments are not enabled Arrears

for the context Pay Component. Adjustments are
[worker] not enabled for
the context Pay
Component.
Previously added Pay Component for

Payroll Input cannot be subsequently
changed. [worker]
Invalid Worktag (Withholding Order

Case) for Pay Component
(Withholding Order). [worker]
1 of 32 7/14/2018, 8:49 PM
For Arrears Adjustment, the

Adjustment indicator must be set.
[worker]
Currency should be an active Currency should

currency. [worker] be an active
currency.
Third Party Sick Pay Earnings may Third Party Sick

not be submitted. [worker] Pay Earnings may
not be submitted
The earliest end date that can be

entered is the last completed pay
period end date for the appropriate
run category. [worker]
Updating an existing Completed One-

time Payroll Input is not allowed.
[worker]
Changing the worker associated with

a Payroll Input is not allowed when
updating an existing Payroll Input.
[worker]
Start Date must be before End Date.

[worker]
Amount, Hours, and Rate are not

allowed when inserting an Arrears
Balance Payroll Input. [worker]
Updating an existing Payroll Input with

Arrears Balance without an Arrears
Balance is not allowed. Also, trying
updating an existing Payroll Input
without an Arrears Balance with an
Arrears Balance is not allowed.
[worker]
End Date is required for One-time

Payroll Input. [worker]
Only Workday Payroll earnings and

deductions are allowed.
'[pay_component]' is not a Workday
Payroll earning or deduction. [worker]
Inactive or Invalid Payroll Worktags

found: [invalid_worktags]. [worker]
Country Code for Run Category does

not match Country Code for Pay
Component. [worker]
The following payroll worktag types

are required for this pay component:
[worktag list]. [worker]
You can only enter Coverage Dates

with a One-time Override pay input.
Coverage End Date must be on or

after Coverage Start Date.
If Coverage Dates are being entered,

both the Coverage Start Date and
Coverage End Date must be entered.
Batch ID is a required field. [worker]
The Source Reference being supplied

does not match the existing Batch ID's
Source. [worker]
The Source Reference being supplied

does not match the Default Batch ID's
Source. [worker]
Coverage dates cannot be entered

because the pay component is not set
up to use coverage dates.
top
2 of 32 7/14/2018, 8:49 PM
Response Element: Put_Import_Process_Response

Put Import Process Response element
@version string [0..1] Web Service version
Import_Process_Reference Web_Service_Background_Process_RuntimeObject [0..1] Web Service Background Process Runtime

element
Header_Instance_Reference InstanceObject [0..1] Header Instance element
top
Submit_Payroll_Input_Data
part of: Import_Payroll_Input_Request
Submit Payroll Input Data
@Last_Period_End_Date date [1..1] Information for outbound data only

(Example: Get Submit Payroll Input
request). Don't enter for a Submit
Payroll Input request. Displays the
period end date of the last completed
payroll result. Do not populate for a
Submit Payroll Input request.
Payroll_Input_ID string [0..1] Enter an existing Payroll Input ID to

update an existing payroll input
instance. To view existing payroll input
ids, select Integration IDs > View IDs
from the related actions menu of a
payroll input. Enter a new Payroll Input
ID for new input. If left blank, Workday
generates a new reference ID, which
can cause multiple records if you run
the same spreadsheet multiple times.
Batch_ID string [0..1] Enables external systems to manage

batches of payroll input data. In
Workday, you can use the Payroll Input
by Batch ID and Delete Payroll Input by
Batch ID tasks.
Source_Reference Integration_System__Audited_Object [0..1] Enter the reference to an integration

system. Use to categorize Batch IDs.
Ongoing_Input boolean [0..1] Enter Y when payroll input values

stretch across more than 1 payroll
period.
Start_Date date [1..1] One-time entries require a Start and

End Date. Ongoing entries require a
Start Date.
End_Date date [0..1] One-time entries require a Start and

End Date. Ongoing entries can have
an End Date, but it isn't required.
Run_Category_Reference Run_CategoryObject [0..*] Run Category Reference
Worker_Reference WorkerObject [1..1] Worker Reference
Position_Reference Position_ElementObject [0..1] Position Reference applicable to the

supplied worker. Validation Description
Position is required
for this Pay
Component.
Earning_Reference [Choice] Earning__All_Object [1..1] To import values for Workday-owned

earnings, select Separate Type
Column for this field in the template
model before generating the
spreadsheet. This splits the column
into: ID type - Enter the type of
reference id (Workday_Earning_Code
or Earning_Code) & ID value - Enter
the reference id.
3 of 32 7/14/2018, 8:49 PM
Deduction_Reference [Choice] Deduction__All_Object [1..1] To import values for Workday-owned

deductions, select Separate Type
Column for this field in the template
model before generating the
spreadsheet. This splits the column
into: ID type - Enter the type of
reference id
(Workday_Deduction_Code or
Deduction_Code) & ID value - Enter
the reference id.
Amount decimal (26, 6) [0..1] Enter the earning or deduction

amount.
Hours decimal (26, 6) [0..1] Enter the value of the unprorated hours
(related calculation W_HRSU) for the
pay component. If you complete this
column, don't enter W_HRSU in the
related calculation column.
Rate decimal (26, 6) [0..1] Enter the value of the rate (related
calculation W_RATE) associated with
the pay component. If you complete
this column, don't enter W_RATE in the
related calculation column.
Adjustment boolean [0..1] Enter Y to create an additional entry on

payroll results that increases or
decreases a pay component. Enter N
to overwrite the pay component
amount, the pay component related
calculations, or both.
Worktag_Data Payroll_Input_Worktags_Data [0..1] Worktag Data List of Worktags

Inactive Project
entered
Inactive Job Profile

entered
Inactive Location
entered
Inactive Region
entered
Inactive Cost
Center entered
Fund is not enabled

as a worktag
dimension for
payroll accounting.
Grant is not
enabled as a
worktag dimension
for payroll
accounting.
Object Class is not

enabled as a
worktag dimension
for payroll
accounting.
Project Plan Task is

not enabled as a
worktag dimension
for payroll
accounting.
Project Plan Phase

is not enabled as a
worktag dimension
for payroll
accounting.
Business Unit is not

enabled as a
worktag dimension
for payroll
accounting.
4 of 32 7/14/2018, 8:49 PM
Program is not
enabled as a
worktag dimension
for payroll
accounting.
Gift is not enabled

as a worktag
dimension for
payroll
accounting.{+1}
Additional_Input_Details_Data Additional_Input_Details [0..*] Additional Input Details Data Where

there are multiple Input Lines, the user Validation Description
can enter one or more rows here.
The arrears
balance adjustment
Input may only
have the single
"Arrears" Input
detail line - no other
input Types are
allowed.
Multiple Input Detail

lines exist for the
same Input Type
Comment string [0..1] Comment
Currency_Reference CurrencyObject [0..1] Currency
Match_Existing_Input boolean [0..1] Internal Use Only - Used by Kronos

Worker Data Import - Payroll V1
Migration. When set to true, this flag
will cause the input to be matched to
existing input, thereby updating any
existing input if it exists. Matching is
based on Worker, Pay Component,
Worktags, Adjustment, Arrears, Batch
ID, Start and End Dates
Company_Reference CompanyObject [0..1] Use for worker-based pay components.

Enter a company related to the Validation Description
worker's past, present, or future
positions. If you don't select a Worker does not
company, Workday calculates the input have any positions
for each company it processes for the in the Company
worker during the run. specified.
Company
Reference is not
allowed when using
a Position based
Earning or
Deduction
Reference.
Coverage_Start_Date date [0..1] When a payroll processor needs to pay

an FLSA bonus, they need to be able
to enter a coverage start date and
coverage end date associated with that
payment.
Coverage_End_Date date [0..1] When a payroll processor needs to pay

an FLSA bonus, they need to be able
to enter a coverage start date and
coverage end date associated with that
payment.
Batch ID is already associated with other types of Application Batches. [worker] Batch ID is already associated with other
types of Application Batches.
Rate is not valid for the Pay Component. [worker] Rate is not valid for the Pay Component.
Hours is not valid for the Pay Component. [worker]
5 of 32 7/14/2018, 8:49 PM
Arrears Adjustments are not enabled for the context Pay Component. [worker] Arrears Adjustments are not enabled for
the context Pay Component.
Previously added Pay Component for Payroll Input cannot be subsequently changed. [worker]
Invalid Worktag (Withholding Order Case) for Pay Component (Withholding Order). [worker]
For Arrears Adjustment, the Adjustment indicator must be set. [worker]
Currency should be an active currency. [worker] Currency should be an active currency.
Third Party Sick Pay Earnings may not be submitted. [worker] Third Party Sick Pay Earnings may not be
submitted
The earliest end date that can be entered is the last completed pay period end date for the appropriate run category.
[worker]
Updating an existing Completed One-time Payroll Input is not allowed. [worker]
Changing the worker associated with a Payroll Input is not allowed when updating an existing Payroll Input. [worker]
Start Date must be before End Date. [worker]
Amount, Hours, and Rate are not allowed when inserting an Arrears Balance Payroll Input. [worker]
Updating an existing Payroll Input with Arrears Balance without an Arrears Balance is not allowed. Also, trying updating
an existing Payroll Input without an Arrears Balance with an Arrears Balance is not allowed. [worker]
End Date is required for One-time Payroll Input. [worker]
Only Workday Payroll earnings and deductions are allowed. '[pay_component]' is not a Workday Payroll earning or
deduction. [worker]
Inactive or Invalid Payroll Worktags found: [invalid_worktags]. [worker]
Country Code for Run Category does not match Country Code for Pay Component. [worker]
The following payroll worktag types are required for this pay component: [worktag list]. [worker]
You can only enter Coverage Dates with a One-time Override pay input.
Coverage End Date must be on or after Coverage Start Date.
If Coverage Dates are being entered, both the Coverage Start Date and Coverage End Date must be entered.
Batch ID is a required field. [worker]
The Source Reference being supplied does not match the existing Batch ID's Source. [worker]
The Source Reference being supplied does not match the Default Batch ID's Source. [worker]
Coverage dates cannot be entered because the pay component is not set up to use coverage dates.
top
Integration_System__Audited_Object
part of: Submit_Payroll_Input_Data
Parameter Type/Value Cardinality Description Validations

name
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional'
information is for outbound descriptive purposes only and is not processed on
inbound Workday Web Services requests.
ID Integration_System__Audited_ObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Integration_System__Audited_ObjectID
part of: Integration_System__Audited_Object
Contains a unique identifier for an instance of an object.

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and a value.
Integration_System_ID A single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Run_CategoryObject
6 of 32 7/14/2018, 8:49 PM
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information is for top
outbound descriptive purposes only and is not processed on inbound Workday Web Services
Run_CategoryObjectID requests.
part
ID of: Run_CategoryObject
Run_CategoryObjectID [0..*] Contains a unique identifier for an instance of an object.

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A
Run_Category_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
WorkerObject

name
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information is for
requests.
ID WorkerObjectID [0..*] Contains a unique identifier for an instance of an object.
top
WorkerObjectID
part of: WorkerObject

name
#text string
@type WID, Contingent_Worker_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and a
Employee_ID value. A single instance of an object can have multiple "ID" but only a single "ID" per
"type".
top
Position_ElementObject

name
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information is
for outbound descriptive purposes only and is not processed on inbound Workday Web
Services requests.
ID Position_ElementObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Position_ElementObjectID
part of: Position_ElementObject

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single
Position_ID instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Earning__All_Object
7 of 32 7/14/2018, 8:49 PM
name
requests.
ID Earning__All_ObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Earning__All_ObjectID
part of: Earning__All_Object

name
#text string
@type WID, Earning_Code, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and
Workday_Earning_Code a value. A single instance of an object can have multiple "ID" but only a single "ID"
per "type".
top
Deduction__All_Object

name
Services requests.
ID Deduction__All_ObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Deduction__All_ObjectID
part of: Deduction__All_Object

name
#text string
@type WID, Deduction_Code, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type
Workday_Deduction_Code and a value. A single instance of an object can have multiple "ID" but only a single
"ID" per "type".
top
Payroll_Input_Worktags_Data
Payroll Worktags
Location_Reference LocationObject [0..1] Location Reference

Location Location
must be of must be of
usage usage
Business Business
Site. Site.
Region_Reference RegionObject [0..1] Region Reference
Job_Profile_Reference Job_ProfileObject [0..1] Job Profile Reference
Cost_Center_Reference Cost_CenterObject [0..1] Cost Center Reference
Project_Reference [Choice] ProjectObject [0..1] Project Reference
Project_Phase_Reference [Choice] Project_Plan_PhaseObject [0..1] Project Phase

Reference
Project_Task_Reference [Choice] Project_Plan_TaskObject [0..1] Project Task Reference
8 of 32 7/14/2018, 8:49 PM
Withholding_Order_Case_Reference Withholding_Order_CaseObject [0..1] Withholding Order Case

Reference Validation Description
The
Company
for the
payroll input
must match
the
company
associated
with the
withholding
order
worktag.
State_Authority_Reference Payroll_State_AuthorityObject [0..1] Worktag - Payroll State

Authority.
Workers_Compensation_Code_Reference Workers_Compensation_CodeObject [0..1] Worktag - Workers

Compensation Code
County_Authority_Reference Payroll_Local_County_AuthorityObject [0..1] Worktag - Payroll Local

County Authority.
City_Authority_Reference Payroll_Local_City_AuthorityObject [0..1] Worktag - Payroll Local

City Authority.
School_District_Authority_Reference Payroll_Local_School_District_AuthorityObject [0..1] Worktag - Payroll Local

School District.
Custom_Worktag_01_Reference Custom_Worktag_01Object [0..1] Only enter worktag

values that have a
reference id type of
Custom_Worktag_1_ID.
To view the reference id
for a custom worktag
value, access the
Custom Worktag Values
task and select
Integration IDs > View
IDs from the related
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
9 of 32 7/14/2018, 8:49 PM

actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.
Fund_Reference FundObject [0..1] Fund Reference
Grant_Reference GrantObject [0..1] Grant Reference
Gift_Reference GiftObject [0..1] Fund Reference
Program_Reference ProgramObject [0..1] Program Reference
Business_Unit_Reference Business_UnitObject [0..1] Business Unit

Reference
Object_Class_Reference Object_ClassObject [0..1] Object Class Reference
Custom_Organization_Reference Custom_OrganizationObject [0..*] Worktag - Custom

Organizations Validation Description
Only one
Custom
Organization
Worktag
Reference is
allowed for
each
Organization
Type.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
10 of 32 7/14/2018, 8:49 PM
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.

values that have a
value, access the
task and select
actions menu of a
11 of 32 7/14/2018, 8:49 PM
worktag value.

values that have a
value, access the
task and select
actions menu of a
worktag value.
Local_Other_Tax_Authority_Reference Payroll_Other_AuthorityObject [0..1] Other Tax Authority

Reference
NI_Category_Reference NI_CategoryObject [0..1] National Insurance

Category Reference. Validation Description
NI Category
Worktag
Value
"[worktag]"
is not valid
for the
Deduction
[deduction]
ARRCO-AGIRC_Category_Reference ARRCO-AGIRC_Rubric_ValueObject [0..1] ARRCO-AGIRC

Category Validation Description
ARRCO-
AGIRC
Category
Worktag
Value
"[worktag]"
is not valid
for the
Deduction
[deduction]
Inactive Project entered
Inactive Job Profile entered
Inactive Location entered
Inactive Region entered
Inactive Cost Center entered
Fund is not enabled as a worktag dimension for payroll accounting.
Grant is not enabled as a worktag dimension for payroll accounting.
Object Class is not enabled as a worktag dimension for payroll accounting.
Project Plan Task is not enabled as a worktag dimension for payroll accounting.
Project Plan Phase is not enabled as a worktag dimension for payroll accounting.
Business Unit is not enabled as a worktag dimension for payroll accounting.
Program is not enabled as a worktag dimension for payroll accounting.
Gift is not enabled as a worktag dimension for payroll accounting.{+1}
top
LocationObject
part of: Payroll_Input_Worktags_Data

name
12 of 32 7/14/2018, 8:49 PM
requests.
ID LocationObjectID [0..*] Contains a unique identifier for an instance of an object.
top
LocationObjectID
part of: LocationObject

name
#text string
Location_ID instance of an object can have multiple "ID" but only a single "ID" per "type".
top
RegionObject

name
requests.
ID RegionObjectID [0..*] Contains a unique identifier for an instance of an object.
top
RegionObjectID
part of: RegionObject

name
#text string
@type WID, Organization_Reference_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a
Region_Reference_ID type and a value. A single instance of an object can have multiple "ID" but only
a single "ID" per "type".
top
Job_ProfileObject

name
requests.
ID Job_ProfileObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Job_ProfileObjectID
part of: Job_ProfileObject

name
#text string
Job_Profile_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Cost_CenterObject
13 of 32 7/14/2018, 8:49 PM

name
requests.
ID Cost_CenterObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Cost_CenterObjectID
part of: Cost_CenterObject

name
#text string
@type WID, Cost_Center_Reference_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a
Organization_Reference_ID type and a value. A single instance of an object can have multiple "ID" but
only a single "ID" per "type".
top
ProjectObject

name
requests.
ID ProjectObjectID [0..*] Contains a unique identifier for an instance of an object.
top
ProjectObjectID
part of: ProjectObject

name
#text string
Project_ID instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Project_Plan_PhaseObject

name
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information
is for outbound descriptive purposes only and is not processed on inbound Workday
Web Services requests.
ID Project_Plan_PhaseObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Project_Plan_PhaseObjectID
part of: Project_Plan_PhaseObject

name
#text string
Project_Plan_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
14 of 32 7/14/2018, 8:49 PM
Project_Plan_TaskObject

name
Services requests.
ID Project_Plan_TaskObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Project_Plan_TaskObjectID
part of: Project_Plan_TaskObject

name
#text string
Project_Plan_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Withholding_Order_CaseObject

name
ID Withholding_Order_CaseObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Withholding_Order_CaseObjectID
part of: Withholding_Order_CaseObject

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and a
Withholding_Order_Case_ID value. A single instance of an object can have multiple "ID" but only a single "ID" per
"type".
top
Payroll_State_AuthorityObject

name
ID Payroll_State_AuthorityObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Payroll_State_AuthorityObjectID
part of: Payroll_State_AuthorityObject

name
#text string
15 of 32 7/14/2018, 8:49 PM
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type
Payroll_State_Authority_Tax_Code and a value. A single instance of an object can have multiple "ID" but only a
single "ID" per "type".
top
Workers_Compensation_CodeObject

name
ID Workers_Compensation_CodeObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Workers_Compensation_CodeObjectID
part of: Workers_Compensation_CodeObject

name
#text string
Workers_Compensation_ID value. A single instance of an object can have multiple "ID" but only a single "ID" per
"type".
top
Payroll_Local_County_AuthorityObject

name
information is for outbound descriptive purposes only and is not processed
on inbound Workday Web Services requests.
ID Payroll_Local_County_AuthorityObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Payroll_Local_County_AuthorityObjectID
part of: Payroll_Local_County_AuthorityObject

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains
Payroll_Local_County_Authority_Tax_Code a type and a value. A single instance of an object can have multiple "ID"
but only a single "ID" per "type".
top
Payroll_Local_City_AuthorityObject

name
ID Payroll_Local_City_AuthorityObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Payroll_Local_City_AuthorityObjectID
part of: Payroll_Local_City_AuthorityObject
16 of 32 7/14/2018, 8:49 PM

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a
Payroll_Local_City_Authority_Tax_Code type and a value. A single instance of an object can have multiple "ID" but
top
Payroll_Local_School_District_AuthorityObject

name
@Descriptor string [1..1] Display information used to describe an instance of an object. This
'optional' information is for outbound descriptive purposes only and is
not processed on inbound Workday Web Services requests.
ID Payroll_Local_School_District_AuthorityObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Payroll_Local_School_District_AuthorityObjectID
part of: Payroll_Local_School_District_AuthorityObject

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object
Payroll_Local_School_District_Authority_Tax_Code contains a type and a value. A single instance of an object can
have multiple "ID" but only a single "ID" per "type".
top
Custom_Worktag_01Object

name
ID Custom_Worktag_01ObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Custom_Worktag_01ObjectID
part of: Custom_Worktag_01Object

name
#text string
Custom_Worktag_1_ID value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".
top

name
top
17 of 32 7/14/2018, 8:49 PM

name
#text string
top

name
top

name
#text string
top

name
top

name
#text string
top

name
18 of 32 7/14/2018, 8:49 PM
top

name
#text string
top
FundObject

name
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information is for outbound
descriptive purposes only and is not processed on inbound Workday Web Services requests.
ID FundObjectID [0..*] Contains a unique identifier for an instance of an object.
top
FundObjectID
part of: FundObject

name
#text string
Fund_ID instance of an object can have multiple "ID" but only a single "ID" per "type".
top
GrantObject

name
requests.
ID GrantObjectID [0..*] Contains a unique identifier for an instance of an object.
top
GrantObjectID
part of: GrantObject

name
#text string
Grant_ID instance of an object can have multiple "ID" but only a single "ID" per "type".
top
GiftObject

name
19 of 32 7/14/2018, 8:49 PM
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information is for outbound
descriptive purposes only and is not processed on inbound Workday Web Services requests.
ID GiftObjectID [0..*] Contains a unique identifier for an instance of an object.
top
GiftObjectID
part of: GiftObject

name
#text string
Gift_Reference_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
ProgramObject

name
requests.
ID ProgramObjectID [0..*] Contains a unique identifier for an instance of an object.
top
ProgramObjectID
part of: ProgramObject

name
#text string
Program_ID instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Business_UnitObject

name
requests.
ID Business_UnitObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Business_UnitObjectID
part of: Business_UnitObject

name
#text string
Business_Unit_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Object_ClassObject
20 of 32 7/14/2018, 8:49 PM
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information is for top
Object_ClassObjectID requests.
part
ID of: Object_ClassObject
Object_ClassObjectID [0..*] Contains a unique identifier for an instance of an object.

name
#text string
Object_Class_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Custom_OrganizationObject

name
information is for outbound descriptive purposes only and is not processed on inbound
Workday Web Services requests.
ID Custom_OrganizationObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Custom_OrganizationObjectID
part of: Custom_OrganizationObject

name
#text string
@type WID, Custom_Organization_Reference_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object
Organization_Reference_ID contains a type and a value. A single instance of an object can have
multiple "ID" but only a single "ID" per "type".
top

name
top

name
#text string
Custom_Worktag_06_ID value. A single instance of an object can have multiple "ID" but only a single "ID" per
"type".
top
21 of 32 7/14/2018, 8:49 PM
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' information top
Custom_Worktag_07ObjectID Web Services requests.
part
ID of: Custom_Worktag_07Object
Custom_Worktag_07ObjectID [0..*] Contains a unique identifier for an instance of an object.

name
#text string
"type".
top

name
top

name
#text string
"type".
top

name
top

name
#text string
"type".
top
22 of 32 7/14/2018, 8:49 PM
part

name
#text string
"type".
top

name
top

name
#text string
"type".
top

name
top

name
#text string
"type".
top
23 of 32 7/14/2018, 8:49 PM
part

name
#text string
"type".
top

name
top

name
#text string
"type".
top

name
top

name
#text string
"type".
top
Payroll_Other_AuthorityObject
24 of 32 7/14/2018, 8:49 PM
@Descriptor string [1..1] Display information used to describe an instance of an object. This 'optional' top
Payroll_Other_AuthorityObjectID inbound Workday Web Services requests.
part
ID of: Payroll_Other_AuthorityObject
Payroll_Other_AuthorityObjectID [0..*] Contains a unique identifier for an instance of an object.

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a
Payroll_Local_Other_Authority_Tax_Code type and a value. A single instance of an object can have multiple "ID" but
top
NI_CategoryObject

name
requests.
ID NI_CategoryObjectID [0..*] Contains a unique identifier for an instance of an object.
top
NI_CategoryObjectID
part of: NI_CategoryObject

name
#text string
NI_Category_Letter single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
ARRCO-AGIRC_Rubric_ValueObject

name
ID ARRCO- [0..*] Contains a unique identifier for an instance of an object.

AGIRC_Rubric_ValueObjectID
top
ARRCO-AGIRC_Rubric_ValueObjectID
part of: ARRCO-AGIRC_Rubric_ValueObject

name
#text string
Rubric_Value_ID single instance of an object can have multiple "ID" but only a single "ID" per "type".
top
Additional_Input_Details
Additional Input Details
25 of 32 7/14/2018, 8:49 PM
Related_Calculation_Reference Related_Calculation__All_Object [0..1] Enter the related calculation reference id for the
Validation type of input. Don't enter Workday related Validation Description
Description
calculations W_RATE or W_HRSU if you
The arrears balance adjustment Input may only have the single "Arrears" Input detail line - nothe
complete other input
Rate Types columns
or Hours are allowed.
in the The Related
Payroll Input Data section. To enter the pay Calculation
Multiple Input Detail lines exist for the same Input Type specified,
component amount use the Amount column in
the Payroll Input Data section. To import values '[rc]', is not
top
for Workday-owned calculations, select Separate supported by
Type Column for this field in the template model the context
Related_Calculation__All_Object before generating the spreadsheet. This splits Earning or
the column into: ID type - Enter the type of Deduction,
part of: Additional_Input_Details '[pc]'.
reference id (Workday_Related_Calculation_ID
or Related_Calculation_ID) & ID value - Enter
the reference id.
name
Input_Value decimal (26, 6) [0..1] Enter the value of the related calculation.
ID Related_Calculation__All_ObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Related_Calculation__All_ObjectID
part of: Related_Calculation__All_Object

name
#text string
@type WID, Related_Calculation_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains
Workday_Related_Calculation_ID a type and a value. A single instance of an object can have multiple "ID"
but only a single "ID" per "type".
top
CurrencyObject

name
requests.
ID CurrencyObjectID [0..*] Contains a unique identifier for an instance of an object.
top
CurrencyObjectID
part of: CurrencyObject

name
#text string
@type WID, Currency_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type and
Currency_Numeric_Code a value. A single instance of an object can have multiple "ID" but only a single "ID"
per "type".
top
CompanyObject

name
requests.
ID CompanyObjectID [0..*] Contains a unique identifier for an instance of an object.
top
26 of 32 7/14/2018, 8:49 PM
CompanyObjectID
part of: CompanyObject

name
#text string
@type WID, Company_Reference_ID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a
Organization_Reference_ID type and a value. A single instance of an object can have multiple "ID" but only
a single "ID" per "type".
top
Web_Service_Background_Process_RuntimeObject
part of: Put_Import_Process_Response

name
@Descriptor string [1..1] Display information used to describe an instance of an object.

This 'optional' information is for outbound descriptive purposes
only and is not processed on inbound Workday Web Services
requests.
ID Web_Service_Background_Process_RuntimeObjectID [0..*] Contains a unique identifier for an instance of an object.
top
Web_Service_Background_Process_RuntimeObjectID
part of: Web_Service_Background_Process_RuntimeObject

name
#text string
@type WID, [1..1] The unique identifier type. Each "ID" for an instance of an object contains a type
Background_Process_Instance_ID and a value. A single instance of an object can have multiple "ID" but only a
single "ID" per "type".
top
InstanceObject
part of: Put_Import_Process_Response
@Descriptor string [1..1]
ID Instance_ID [0..*]
top
Instance_ID
part of: InstanceObject
#text string
@parent_id string [1..1]
@parent_type string [1..1]
@type string [1..1]
top
Integration_System__Audited_ReferenceEnumeration
part of: Integration_System__Audited_ObjectID
Base Type
string
top
27 of 32 7/14/2018, 8:49 PM
Run_CategoryReferenceEnumeration
part of: Run_CategoryObjectID
Base Type
string
top
WorkerReferenceEnumeration
part of: WorkerObjectID
Base Type
string
top
Position_ElementReferenceEnumeration
part of: Position_ElementObjectID
Base Type
string
top
Earning__All_ReferenceEnumeration
part of: Earning__All_ObjectID
Base Type
string
top
Deduction__All_ReferenceEnumeration
part of: Deduction__All_ObjectID
Base Type
string
top
LocationReferenceEnumeration
part of: LocationObjectID
Base Type
string
top
RegionReferenceEnumeration
part of: RegionObjectID
Base Type
string
top
Job_ProfileReferenceEnumeration
part of: Job_ProfileObjectID
Base Type
string
top
Cost_CenterReferenceEnumeration
part of: Cost_CenterObjectID
Base Type
string
top
ProjectReferenceEnumeration
part of: ProjectObjectID
Base Type
28 of 32 7/14/2018, 8:49 PM
string
top
Project_Plan_PhaseReferenceEnumeration
part of: Project_Plan_PhaseObjectID
Base Type
string
top
Project_Plan_TaskReferenceEnumeration
part of: Project_Plan_TaskObjectID
Base Type
string
top
Withholding_Order_CaseReferenceEnumeration
part of: Withholding_Order_CaseObjectID
Base Type
string
top
Payroll_State_AuthorityReferenceEnumeration
part of: Payroll_State_AuthorityObjectID
Base Type
string
top
Workers_Compensation_CodeReferenceEnumeration
part of: Workers_Compensation_CodeObjectID
Base Type
string
top
Payroll_Local_County_AuthorityReferenceEnumeration
part of: Payroll_Local_County_AuthorityObjectID
Base Type
string
top
Payroll_Local_City_AuthorityReferenceEnumeration
part of: Payroll_Local_City_AuthorityObjectID
Base Type
string
top
Payroll_Local_School_District_AuthorityReferenceEnumeration
part of: Payroll_Local_School_District_AuthorityObjectID
Base Type
string
top
Custom_Worktag_01ReferenceEnumeration
part of: Custom_Worktag_01ObjectID
Base Type
string
top
29 of 32 7/14/2018, 8:49 PM
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
FundReferenceEnumeration
part of: FundObjectID
Base Type
string
top
GrantReferenceEnumeration
part of: GrantObjectID
Base Type
string
top
GiftReferenceEnumeration
part of: GiftObjectID
Base Type
string
top
ProgramReferenceEnumeration
part of: ProgramObjectID
Base Type
string
top
Business_UnitReferenceEnumeration
part of: Business_UnitObjectID
Base Type
string
top
Object_ClassReferenceEnumeration
part of: Object_ClassObjectID
Base Type
30 of 32 7/14/2018, 8:49 PM
string
top
Custom_OrganizationReferenceEnumeration
part of: Custom_OrganizationObjectID
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
Base Type
string
top
31 of 32 7/14/2018, 8:49 PM
Base Type
string
top
Base Type
string
top
Payroll_Other_AuthorityReferenceEnumeration
part of: Payroll_Other_AuthorityObjectID
Base Type
string
top
NI_CategoryReferenceEnumeration
part of: NI_CategoryObjectID
Base Type
string
top
ARRCO-AGIRC_Rubric_ValueReferenceEnumeration
part of: ARRCO-AGIRC_Rubric_ValueObjectID
Base Type
string
top
Related_Calculation__All_ReferenceEnumeration
part of: Related_Calculation__All_ObjectID
Base Type
string
top
CurrencyReferenceEnumeration
part of: CurrencyObjectID
Base Type
string
top
CompanyReferenceEnumeration
part of: CompanyObjectID
Base Type
string
top
Web_Service_Background_Process_RuntimeReferenceEnumeration
part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top
32 of 32 7/14/2018, 8:49 PM

Workday API v30.2 - Import - Payroll - Input Operation Details

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Workday API v30.2 - Import - Payroll - Input Operation Details

Uploaded by

Copyright:

Available Formats

Import_Payroll_Input Operation Details https://community.workday.com/sites/default/files/file-hosting/productio...

Service Directory > v30.2 > Payroll > Import_Payroll_Input

Request Element: Import_Payroll_Input_Request

Parameter name Type/Value Cardinality Description Validations

@version string [0..1] Web Service version

Default_Batch_ID string [1..1] Default Batch ID is required. Assign

Payroll_Input_Data Submit_Payroll_Input_Data [0..*] Submit Payroll Input Data

Batch ID is already associated with Batch ID is

Rate is not valid for the Pay Rate is not valid

Hours is not valid for the Pay

Arrears Adjustments are not enabled Arrears

Previously added Pay Component for

Invalid Worktag (Withholding Order

For Arrears Adjustment, the

Currency should be an active Currency should

Third Party Sick Pay Earnings may Third Party Sick

The earliest end date that can be

Updating an existing Completed One-

Changing the worker associated with

Start Date must be before End Date.

Amount, Hours, and Rate are not

Updating an existing Payroll Input with

End Date is required for One-time

Only Workday Payroll earnings and

Inactive or Invalid Payroll Worktags

Country Code for Run Category does

The following payroll worktag types

You can only enter Coverage Dates

Coverage End Date must be on or

If Coverage Dates are being entered,

Batch ID is a required field. [worker]

The Source Reference being supplied

The Source Reference being supplied

Coverage dates cannot be entered

Response Element: Put_Import_Process_Response

Parameter name Type/Value Cardinality Description Validations

@version string [0..1] Web Service version

Import_Process_Reference Web_Service_Background_Process_RuntimeObject [0..1] Web Service Background Process Runtime

Header_Instance_Reference InstanceObject [0..1] Header Instance element

Parameter name Type/Value Cardinality Description Validations

@Last_Period_End_Date date [1..1] Information for outbound data only

Payroll_Input_ID string [0..1] Enter an existing Payroll Input ID to

Batch_ID string [0..1] Enables external systems to manage

Source_Reference Integration_System__Audited_Object [0..1] Enter the reference to an integration

Ongoing_Input boolean [0..1] Enter Y when payroll input values

Start_Date date [1..1] One-time entries require a Start and

End_Date date [0..1] One-time entries require a Start and

Run_Category_Reference Run_CategoryObject [0..*] Run Category Reference

Worker_Reference WorkerObject [1..1] Worker Reference

Position_Reference Position_ElementObject [0..1] Position Reference applicable to the

Earning_Reference [Choice] Earning__All_Object [1..1] To import values for Workday-owned

Deduction_Reference [Choice] Deduction__All_Object [1..1] To import values for Workday-owned

Amount decimal (26, 6) [0..1] Enter the earning or deduction

Adjustment boolean [0..1] Enter Y to create an additional entry on

Worktag_Data Payroll_Input_Worktags_Data [0..1] Worktag Data List of Worktags

Inactive Job Profile

Fund is not enabled

Object Class is not

Project Plan Task is

Project Plan Phase

Business Unit is not

Gift is not enabled