Service Directory > v32.1 > Payroll > Put_Payroll_History_Payment
 

Operation: Put_Payroll_History_Payment

This public web service operation is designed to add/update historical payroll payments from external systems into Workday Payroll.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Payroll_History_Payment_Request

This is the top-level Request element carrying all information necessary to make a Put Payroll History Payment service request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_History_Payment_Reference  Payroll_Off-cycle_Result_OverrideObject  [0..1]  Payroll Off-cycle Payment Reference   
Payroll_History_Payment_Data  Payroll_History_Payment_Data  [1..1]  The Payroll History Payment Data element contains all of the information necessary to define a history payment, including the functional keys (Worker, Period, Pay Group), the technical key (Payment ID), the payment information (Payment Date, Gross and Net Amounts, Sub-Period dates), Payroll Worktag overrides, and the line-item earnings and deductions detail. 
Validation Description
Payment ID is already in use by another off-cycle payment.   
This payment is not targeted for a valid history period for the Pay Group.   
Payment ID corresponds to a history payment that is already completed. Completed payments cannot be updated via this web service operation.   
Batch ID is already associated with other types of Application Batches.   
Payroll Reference Number is not valid for the specified company and pay period.   
A Batch ID must be entered for Put Payroll History Payment (Web Service)   
The worker was not assigned to the specified Pay Group as of the Period Date; or the system was unable to determine a valid Pay Group assignment for the worker as of the Period Date.   
The worker has multiple positions in the selected pay group that are in companies other than primary position’s company. In the Override Worktags section, select the Company of the position you are paying.   
The system cannot determine a Company applicable to this worker and history payment. Please supply a Company worktag override.   
The worker doesn’t have an active Payroll ID on or before the Period End Date (or Sub-Period End Date, if present). Before loading history payments for this period, assign a Payroll ID for the worker.   
 
top
 

Response Element: Put_Payroll_History_Payment_Response

This element contains the reference to the Payroll History Payment added or updated by the web service operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_History_Payment_Reference  Payroll_Off-cycle_Result_OverrideObject  [0..1]  The Payroll History Payment Reference is a unique identifier within Workday for a Payroll History Payment (Payroll Off-cycle Result Override).   
top
 

Payroll_Off-cycle_Result_OverrideObject

part of: Put_Payroll_History_Payment_Request, Put_Payroll_History_Payment_Response
 
Parameter name Type/Value Cardinality Description Validations
@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_Off-cycle_Result_OverrideObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Off-cycle_Result_OverrideObjectID

part of: Payroll_Off-cycle_Result_OverrideObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payment_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_History_Payment_Data

part of: Put_Payroll_History_Payment_Request
The Payroll History Payment Data element contains all of the information necessary to define a history payment, including the functional keys (Worker, Period, Pay Group), the technical key (Payment ID), the payment information (Payment Date, Gross and Net Amounts, Sub-Period dates), Payroll Worktag overrides, and the line-item earnings and deductions detail.
 
Parameter name Type/Value Cardinality Description Validations
Batch_ID  string  [0..1]  Unique reference to specific batch. Batch ID can be used to group off cycle payments together to run pay calculation, complete, cancel and settlement.   
Payment_ID  string  [1..1]  Unique reference to specific off cycle payment. If data is re-loaded for an existing off cycle payment ID, the system will consider it an update (and will reset the payment status back to Needs to be Re-Calculated if it has already been calculated). Otherwise, a new payment. Off Cycle Payment with Payment ID already exists in the system in a complete status can not be updated.   
Employee_Reference  EmployeeObject  [1..1]  Employee Reference.   
Period_Date  date  [1..1]  The period date will be used to default the actual period to be used in the off-cycle payment (based on Pay Group and Run Category). The system will use the applicable period that the specified period date falls within. We will derive period to use based on getting the period where the specified period date falls within (for applicable Run Category if entered, else Regular run category). This is based on the Pay Group (if specified), else the Pay Group of the worker as of the period date specified.   
Run_Category_Reference  Run_CategoryObject  [0..1]  The Run Category is an attribute of a Pay Group identifying a type of payroll run (for example, Regular or Bonus) with its own Period Schedule. Whenever a reference date (such as a Period End Date) is supplied, an associated Run Category must be specified, in order to resolve the date to an appropriate Pay Period. When Run Category is not provided, the system will use the Regular Run Category (for Pay Group specified or retrieved as of Period End Date) to determine.   
Pay_Group_Reference  Pay_GroupObject  [0..1]  Pay Group Reference. If no Pay Group entered, we retrieve Pay Group of worker as of Period Date specified.   
Payroll_ID_Reference  Payroll_IDObject  [0..1]  Payroll ID Reference. Output only value. Payroll ID is ignored in Put Requests   
History_Payment_Data  History_Payment_Data  [1..1]  The History Payment Data element contains attributes specific to this payment, such as the Gross and Net amounts, an optional Sub-period definition (if the payment is not for the full payroll Period) and optional Third Party Sick Pay indicator. 
Validation Description
The History Sub Period Dates specified are not valid in relation to the Period for this Payment. To define a Sub Period, both Dates must be entered and must fall within the Period. Further, the Sub Period Begin Date must be before the Sub Period End Date. Please review the Sub Period Dates and correct them as needed (or remove them).   
 
Result_Worktag_Overrides  Result_Worktag_Overrides_Data  [0..1]  This can be used to enter worktag overrides (if applicable) that will be respected at the 'result' level. If no override entered for a specific worktag, applicable default worktag value will be used.   
Add_to_Existing_Input_Data  boolean  [0..1]  When updating an existing History Payment, the default behavior is to replace all existing Input Data with the incoming data. When this flag is set to True, incoming data will be added into any existing Input Data, preserving the original data.   
History_Payment_Input_Data  History_Payment_Input_Data  [1..*]  This element contains the earnings and deductions detail that contributes to the history payment's Gross and Net. 
Validation Description
This Input uses an Earning or Deduction that has a Calculation Worktag defined, but that worktag is not included in the Payroll Worktags list.   
Subject Wages is not a valid related calculation for this Earning or Deduction. In general, Subject Wages applies only to certain taxes.   
Taxable Wages is not a valid related calculation for this Earning or Deduction. In general, Taxable Wages applies only to certain taxes.   
Third Party Sick Pay Earnings may not be entered when Third Party Sick Pay is set to False.  Third Party Sick Pay Earnings may not be entered when Third Party Sick Pay is set to False. 
Only Third Party Sick Pay earnings may be entered if the Third Party Sick Pay option is set to True.  Only Third Party Sick Pay earnings may be entered if the Third Party Sick Pay option is set to True. 
Only Statutory Taxes (EE) or Statutory Taxes (ER) may be entered if Third Party Sick Pay is set to True - no Customer-owned Deductions or Withholding Orders.  Only Statutory Taxes (EE) or Statutory Taxes (ER) may be entered if Third Party Sick Pay is set to True - no Customer-owned Deductions or Withholding Orders. 
The Pay Component (Deduction) entered is a statutory tax but is not supported by the Payroll Tax Authority as of the history Period. Please review the Payroll Tax Data setup.   
The History Payment Input does not have an entry for "Amount" - an "Amount" entry (even if zero) is required in order to record history for other Related Calculations (Taxable Wages, Hours, etc.)   
The History Payment Input Data uses the same Related Calculation (Amount, Taxable Wages, Hours, etc.) multiple times - within a History Payment Input Data row, each amount entry and detail Input Line must be for a different Related Calculation.   
The History Payment Input is an arrears balance adjustment and may only have the single "Arrears" Related Calculation line - no other input Lines are allowed.   
Inactive or Invalid Payroll Worktags found: [invalid_worktags]   
In order to specify a costing company, please enable the Intercompany Accounting setting in Edit Tenant Setup - Payroll.   
 
Validation Description
Payment ID is already in use by another off-cycle payment.   
This payment is not targeted for a valid history period for the Pay Group.   
Payment ID corresponds to a history payment that is already completed. Completed payments cannot be updated via this web service operation.   
Batch ID is already associated with other types of Application Batches.   
Payroll Reference Number is not valid for the specified company and pay period.   
A Batch ID must be entered for Put Payroll History Payment (Web Service)   
The worker was not assigned to the specified Pay Group as of the Period Date; or the system was unable to determine a valid Pay Group assignment for the worker as of the Period Date.   
The worker has multiple positions in the selected pay group that are in companies other than primary position’s company. In the Override Worktags section, select the Company of the position you are paying.   
The system cannot determine a Company applicable to this worker and history payment. Please supply a Company worktag override.   
The worker doesn’t have an active Payroll ID on or before the Period End Date (or Sub-Period End Date, if present). Before loading history payments for this period, assign a Payroll ID for the worker.   
top
 

EmployeeObject

part of: Payroll_History_Payment_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  EmployeeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

EmployeeObjectID

part of: EmployeeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Run_CategoryObject

part of: Payroll_History_Payment_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Run_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Run_CategoryObjectID

part of: Run_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Run_Category_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Pay_GroupObject

part of: Payroll_History_Payment_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Pay_GroupObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_GroupObjectID

part of: Pay_GroupObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_IDObject

part of: Payroll_History_Payment_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_IDObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_IDObjectID

part of: Payroll_IDObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

History_Payment_Data

part of: Payroll_History_Payment_Data
The History Payment Data element contains attributes specific to this payment, such as the Gross and Net amounts, an optional Sub-period definition (if the payment is not for the full payroll Period) and optional Third Party Sick Pay indicator.
 
Parameter name Type/Value Cardinality Description Validations
Third_Party_Sick_Pay  boolean  [0..1]  Shows whether or not payment is a Third Party Sick Pay. Employee Taxes Deposited by a Third Party will be included in Tax Filing Integration as Regular/Non-Third Party liability.   
Payment_Date  date  [1..1]  Payment Date for off-cycle payment.   
Gross_Amount  decimal (18, 6)   [0..1]  The Gross Amount to be posted to the history payment. If the gross amount is not overridden here, the system will derive the value during payroll processing (based on the Gross Pay Accumulation definition for the Pay Group / Run Category).   
Net_Amount  decimal (18, 6)   [0..1]  The Net Amount to be posted to the history payment. If the net amount is not overridden here, the system will derive the value during payroll processing (based on the Net Pay Accumulation definition for the Pay Group / Run Category).   
Sub-Period_Start_Date  date  [0..1]  The Starting Date for the history sub-period. This date must be within the payroll Period for the history payment.   
Sub-Period_End_Date  date  [0..1]  The Ending Date for the history sub-period. This date must be within the payroll Period for the history payment, and must be after the sub-period Starting Date.   
Validation Description
The History Sub Period Dates specified are not valid in relation to the Period for this Payment. To define a Sub Period, both Dates must be entered and must fall within the Period. Further, the Sub Period Begin Date must be before the Sub Period End Date. Please review the Sub Period Dates and correct them as needed (or remove them).   
top
 

Result_Worktag_Overrides_Data

part of: Payroll_History_Payment_Data
This can be used to enter worktag overrides (if applicable) that will be respected at the 'result' level. If no override is entered for a specific worktag, an applicable default worktag value (as of Period end date) will be used.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Company worktag for the payment. Overrides any default company worktags.   
Region_Reference  RegionObject  [0..1]  Region worktag for the payment. Overrides any default region worktags.   
Location_Reference  LocationObject  [0..1]  Location worktag for the payment. Overrides any default location worktags. 
Validation Description
Location must be of usage Business Site.  Location must be of usage Business Site. 
 
Cost_Center_Reference  Cost_CenterObject  [0..1]  Cost center worktag for the payment. Overrides any default cost center worktags.   
Job_Profile_Reference  Job_ProfileObject  [0..1]  Job profile worktag for the payment. Overrides any default job profile worktags.   
State__Work__Reference  Payroll_State_AuthorityObject  [0..1]  Work state worktag for the payment. Overrides any default work state worktags.   
State__Resident__Reference  Payroll_State_AuthorityObject  [0..1]  Resident state worktag for the payment. Overrides any default resident state worktags.   
County__Work__Reference  Payroll_Local_County_AuthorityObject  [0..1]  County worktag for the payment. Overrides any default county worktags.   
County__Resident__Reference  Payroll_Local_County_AuthorityObject  [0..1]  County worktag for the payment. Overrides any default county worktags.   
City__Work__Reference  Payroll_Local_City_AuthorityObject  [0..1]  Work city worktag for the payment. Overrides any default work city worktags.   
City__Resident__Reference  Payroll_Local_City_AuthorityObject  [0..1]  Resident city worktag for the payment. Overrides any default resident city worktags.   
School_District__Resident__Reference  Payroll_Local_School_District_AuthorityObject  [0..1]  Resident school district worktag for the payment. Overrides any default resident school district worktags.   
Payroll_Reference_Number_Reference  Payroll_Reference_NumberObject  [0..1]  Payroll reference number worktag for the payment. Overrides any default payroll reference number worktags.   
top
 

CompanyObject

part of: Result_Worktag_Overrides_Data, History_Payment_Input_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CompanyObjectID

part of: CompanyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

RegionObject

part of: Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  RegionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

RegionObjectID

part of: RegionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Organization_Reference_ID, Region_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

LocationObject

part of: Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  LocationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LocationObjectID

part of: LocationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Location_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Cost_CenterObject

part of: Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Cost_CenterObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Cost_CenterObjectID

part of: Cost_CenterObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Cost_Center_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Job_ProfileObject

part of: Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Job_ProfileObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_ProfileObjectID

part of: Job_ProfileObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Job_Profile_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_State_AuthorityObject

part of: Result_Worktag_Overrides_Data, Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_State_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_State_AuthorityObjectID

part of: Payroll_State_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_State_Authority_Tax_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains 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_County_AuthorityObject

part of: Result_Worktag_Overrides_Data, Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_County_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Local_County_AuthorityObjectID

part of: Payroll_Local_County_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Local_County_Authority_Tax_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains 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

part of: Result_Worktag_Overrides_Data, Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_City_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Local_City_AuthorityObjectID

part of: Payroll_Local_City_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Local_City_Authority_Tax_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains 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_School_District_AuthorityObject

part of: Result_Worktag_Overrides_Data, Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Local_School_District_Authority_Tax_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_Reference_NumberObject

part of: Result_Worktag_Overrides_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_Reference_NumberObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Reference_NumberObjectID

part of: Payroll_Reference_NumberObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Reference_Number  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

History_Payment_Input_Data

part of: Payroll_History_Payment_Data
This element contains the earnings and deductions detail that contributes to the history payment's Gross and Net.
 
Parameter name Type/Value Cardinality Description Validations
Earning_Reference [Choice]   Earning__All_Object  [1..1]  This is a pay code uniquely identifying an earning already established in the Workday Payroll system.   
Deduction_Reference [Choice]   Deduction__All_Object  [1..1]  This is a pay code uniquely identifying an deduction already established in the Workday Payroll system.   
Position_Reference  Position_ElementObject  [0..1]  Position Reference applicable to the supplied worker. 
Validation Description
Position is required for this Pay Component.   
 
Amount  decimal (26, 6)   [0..1]  Amount for Earning or Deduction.   
Taxable_Wages  decimal (26, 6)   [0..1]  For context deductions that are taxes, this allows entry of the associated taxable wages related calculation without having to use a separate Input Line.   
Subject_Wages  decimal (26, 6)   [0..1]  For context deductions that are taxes, this allows entry of the associated subject wages related calculation without having to use a separate Input Line.   
Payroll_Input_Worktags_Data  Payroll_Input_Worktags_Data  [0..1]  Payroll Worktags 
Validation Description
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}   
 
Comment  string  [0..1]  Comment   
History_Payment_Input_Line_Data  History_Payment_Input_Line_Data  [0..*]  This element contains the value details (amount, hours, rate, etc.) that contribute to an earning or deduction. 
Validation Description
Arrears Adjustments are not enabled for the context Pay Component.   
The Related Calculation specified is not supported by the context Earning or Deduction.   
 
Costing_Company_Reference  CompanyObject  [0..1]  Optional: Specify a costing company to charge this history payment to. Intercompany Accounting must be enabled in Edit Tenant Setup - Payroll.   
Validation Description
This Input uses an Earning or Deduction that has a Calculation Worktag defined, but that worktag is not included in the Payroll Worktags list.   
Subject Wages is not a valid related calculation for this Earning or Deduction. In general, Subject Wages applies only to certain taxes.   
Taxable Wages is not a valid related calculation for this Earning or Deduction. In general, Taxable Wages applies only to certain taxes.   
Third Party Sick Pay Earnings may not be entered when Third Party Sick Pay is set to False.  Third Party Sick Pay Earnings may not be entered when Third Party Sick Pay is set to False. 
Only Third Party Sick Pay earnings may be entered if the Third Party Sick Pay option is set to True.  Only Third Party Sick Pay earnings may be entered if the Third Party Sick Pay option is set to True. 
Only Statutory Taxes (EE) or Statutory Taxes (ER) may be entered if Third Party Sick Pay is set to True - no Customer-owned Deductions or Withholding Orders.  Only Statutory Taxes (EE) or Statutory Taxes (ER) may be entered if Third Party Sick Pay is set to True - no Customer-owned Deductions or Withholding Orders. 
The Pay Component (Deduction) entered is a statutory tax but is not supported by the Payroll Tax Authority as of the history Period. Please review the Payroll Tax Data setup.   
The History Payment Input does not have an entry for "Amount" - an "Amount" entry (even if zero) is required in order to record history for other Related Calculations (Taxable Wages, Hours, etc.)   
The History Payment Input Data uses the same Related Calculation (Amount, Taxable Wages, Hours, etc.) multiple times - within a History Payment Input Data row, each amount entry and detail Input Line must be for a different Related Calculation.   
The History Payment Input is an arrears balance adjustment and may only have the single "Arrears" Related Calculation line - no other input Lines are allowed.   
Inactive or Invalid Payroll Worktags found: [invalid_worktags]   
In order to specify a costing company, please enable the Intercompany Accounting setting in Edit Tenant Setup - Payroll.   
top
 

Earning__All_Object

part of: History_Payment_Input_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Earning__All_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Earning__All_ObjectID

part of: Earning__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Earning_Code, Workday_Earning_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Deduction__All_Object

part of: History_Payment_Input_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Deduction__All_ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Deduction__All_ObjectID

part of: Deduction__All_Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Code, Workday_Deduction_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Position_ElementObject

part of: History_Payment_Input_Data
 
Parameter name Type/Value Cardinality Description Validations
@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
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Position_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type 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

part of: History_Payment_Input_Data
Payroll Worktags
 
Parameter name Type/Value Cardinality Description Validations
Location_Reference  LocationObject  [0..1]  Reference ID for the location. 
Validation Description
Location must be of usage Business Site.  Location must be of usage Business Site. 
 
Region_Reference  RegionObject  [0..1]  Reference ID for the region.   
Job_Profile_Reference  Job_ProfileObject  [0..1]  Reference ID for the job profile.   
Cost_Center_Reference  Cost_CenterObject  [0..1]  Reference ID for the cost center.   
Project_Reference [Choice]   ProjectObject  [0..1]  Reference ID for the project.   
Project_Phase_Reference [Choice]   Project_Plan_PhaseObject  [0..1]  Reference ID for the project phase.   
Project_Task_Reference [Choice]   Project_Plan_TaskObject  [0..1]  Reference ID for the project task.   
Withholding_Order_Case_Reference  Withholding_Order_CaseObject  [0..1]  Reference ID for the withholding order case. 
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]  Numeric reference id for the payroll state authority worktag. Required when loading certain pay components such as state withholding. You can find the reference id in the Payroll Authority Tax Code column on the All Payroll Tax Authorites report.   
Workers_Compensation_Code_Reference  Workers_Compensation_CodeObject  [0..1]  Reference ID for worker's compensation code.   
County_Authority_Reference  Payroll_Local_County_AuthorityObject  [0..1]  Reference ID for payroll local county authority.   
City_Authority_Reference  Payroll_Local_City_AuthorityObject  [0..1]  Reference ID for payroll local city authority.   
School_District_Authority_Reference  Payroll_Local_School_District_AuthorityObject  [0..1]  Reference ID for 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.   
Custom_Worktag_02_Reference  Custom_Worktag_02Object  [0..1]  Only enter worktag values that have a reference id type of Custom_Worktag_2_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.   
Custom_Worktag_03_Reference  Custom_Worktag_03Object  [0..1]  Only enter worktag values that have a reference id type of Custom_Worktag_3_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.   
Custom_Worktag_04_Reference  Custom_Worktag_04Object  [0..1]  Only enter worktag values that have a reference id type of Custom_Worktag_4_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.   
Custom_Worktag_05_Reference  Custom_Worktag_05Object  [0..1]  Only enter worktag values that have a reference id type of Custom_Worktag_5_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.   
Fund_Reference  FundObject  [0..1]  Reference ID for fund.   
Grant_Reference  GrantObject  [0..1]  Reference ID for grant.   
Gift_Reference  GiftObject  [0..1]  Reference ID for gift.   
Program_Reference  ProgramObject  [0..1]  Reference ID for program.   
Business_Unit_Reference  Business_UnitObject  [0..1]  Reference ID for business unit.   
Object_Class_Reference  Object_ClassObject  [0..1]  Reference ID for object class.   
Custom_Organization_Reference  Custom_OrganizationObject  [0..*]  Reference ID for custom organization. 
Validation Description
Only one Custom Organization Worktag Reference is allowed for each Organization Type.   
 
Custom_Worktag_06_Reference  Custom_Worktag_06Object  [0..1]  Only enter worktag values that have a reference id type of Custom_Worktag_6_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.   
Custom_Worktag_07_Reference  Custom_Worktag_07Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_7_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.   
Custom_Worktag_08_Reference  Custom_Worktag_08Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_8_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.   
Custom_Worktag_09_Reference  Custom_Worktag_09Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_9_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.   
Custom_Worktag_10_Reference  Custom_Worktag_10Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_10_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.   
Custom_Worktag_11_Reference  Custom_Worktag_11Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_11_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.   
Custom_Worktag_12_Reference  Custom_Worktag_12Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_12_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.   
Custom_Worktag_13_Reference  Custom_Worktag_13Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_13_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.   
Custom_Worktag_14_Reference  Custom_Worktag_14Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_14_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.   
Custom_Worktag_15_Reference  Custom_Worktag_15Object  [0..1]  Only enter worktag values that have a reference ID type of Custom_Worktag_15_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.   
Local_Other_Tax_Authority_Reference  Payroll_Other_AuthorityObject  [0..1]  Reference ID for other tax authority.   
NI_Category_Reference  NI_CategoryObject  [0..1]  Reference ID for national insurance category. 
Validation Description
NI Category Worktag Value "[worktag]" is not valid for the Deduction [deduction]   
 
ARRCO-AGIRC_Category_Reference  ARRCO-AGIRC_Rubric_ValueObject  [0..1]  Reference ID for ARRCO-AGIRC category. 
Validation Description
ARRCO-AGIRC Category Worktag Value "[worktag]" is not valid for the Deduction [deduction]   
 
Income_Code_Reference  Payroll_Income_CodeObject  [0..1]  Income Code   
Validation Description
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
 

ProjectObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  ProjectObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

ProjectObjectID

part of: ProjectObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Project_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Project_Plan_PhaseObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Project_Plan_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Project_Plan_TaskObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_TaskObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Project_Plan_TaskObjectID

part of: Project_Plan_TaskObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Project_Plan_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Withholding_Order_CaseObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Withholding_Order_CaseObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Withholding_Order_CaseObjectID

part of: Withholding_Order_CaseObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Withholding_Order_Case_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Workers_Compensation_CodeObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Workers_Compensation_CodeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Workers_Compensation_CodeObjectID

part of: Workers_Compensation_CodeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Workers_Compensation_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_01ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_01ObjectID

part of: Custom_Worktag_01Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_1_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_02Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_02ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_02ObjectID

part of: Custom_Worktag_02Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_2_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_03Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_03ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_03ObjectID

part of: Custom_Worktag_03Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_3_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_04Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_04ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_04ObjectID

part of: Custom_Worktag_04Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_4_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_05Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_05ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_05ObjectID

part of: Custom_Worktag_05Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_5_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

FundObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Fund_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

GrantObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  GrantObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

GrantObjectID

part of: GrantObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Grant_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

GiftObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Gift_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

ProgramObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  ProgramObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

ProgramObjectID

part of: ProgramObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Program_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Business_UnitObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Business_UnitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Business_UnitObjectID

part of: Business_UnitObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Object_ClassObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Object_ClassObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Object_ClassObjectID

part of: Object_ClassObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Object_Class_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_OrganizationObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_OrganizationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_OrganizationObjectID

part of: Custom_OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Organization_Reference_ID, Organization_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_06Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_06ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_06ObjectID

part of: Custom_Worktag_06Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_06_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_07Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_07ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_07ObjectID

part of: Custom_Worktag_07Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_07_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_08Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_08ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_08ObjectID

part of: Custom_Worktag_08Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_08_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_09Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_09ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_09ObjectID

part of: Custom_Worktag_09Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_09_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_10Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_10ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_10ObjectID

part of: Custom_Worktag_10Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_10_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_11Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_11ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_11ObjectID

part of: Custom_Worktag_11Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_11_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_12Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_12ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_12ObjectID

part of: Custom_Worktag_12Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_12_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_13Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_13ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_13ObjectID

part of: Custom_Worktag_13Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_13_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_14Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_14ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_14ObjectID

part of: Custom_Worktag_14Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_14_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object 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_15Object

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  Custom_Worktag_15ObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Custom_Worktag_15ObjectID

part of: Custom_Worktag_15Object
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Custom_Worktag_15_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_Other_AuthorityObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_Other_AuthorityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Other_AuthorityObjectID

part of: Payroll_Other_AuthorityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Local_Other_Authority_Tax_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

NI_CategoryObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  NI_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

NI_CategoryObjectID

part of: NI_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, NI_Category_Letter  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

ARRCO-AGIRC_Rubric_ValueObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  ARRCO-AGIRC_Rubric_ValueObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

ARRCO-AGIRC_Rubric_ValueObjectID

part of: ARRCO-AGIRC_Rubric_ValueObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Rubric_Value_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_Income_CodeObject

part of: Payroll_Input_Worktags_Data
 
Parameter name Type/Value Cardinality Description Validations
@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_Income_CodeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Income_CodeObjectID

part of: Payroll_Income_CodeObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Income_Code  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

History_Payment_Input_Line_Data

part of: History_Payment_Input_Data
This element contains the value details (amount, hours, rate, etc.) that contribute to an earning or deduction.
 
Parameter name Type/Value Cardinality Description Validations
Related_Calculation_Reference  Related_Calculation__All_Object  [1..1]  This is a pay code uniquely identifying a related calculation already established in the Workday Payroll system.   
Input_Value  decimal (26, 6)   [0..1]  This element contains the value details (amount, hours, rate, etc.) that contribute to an earning or deduction.   
Validation Description
Arrears Adjustments are not enabled for the context Pay Component.   
The Related Calculation specified is not supported by the context Earning or Deduction.   
top
 

Related_Calculation__All_Object

part of: History_Payment_Input_Line_Data
 
Parameter name Type/Value Cardinality Description Validations
@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  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
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Related_Calculation_ID, Workday_Related_Calculation_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Payroll_Off-cycle_Result_OverrideReferenceEnumeration

part of: Payroll_Off-cycle_Result_OverrideObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Run_CategoryReferenceEnumeration

part of: Run_CategoryObjectID
Base Type
string
top
 

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

Payroll_IDReferenceEnumeration

part of: Payroll_IDObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

RegionReferenceEnumeration

part of: RegionObjectID
Base Type
string
top
 

LocationReferenceEnumeration

part of: LocationObjectID
Base Type
string
top
 

Cost_CenterReferenceEnumeration

part of: Cost_CenterObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Payroll_State_AuthorityReferenceEnumeration

part of: Payroll_State_AuthorityObjectID
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
 

Payroll_Reference_NumberReferenceEnumeration

part of: Payroll_Reference_NumberObjectID
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
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

ProjectReferenceEnumeration

part of: ProjectObjectID
Base Type
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
 

Workers_Compensation_CodeReferenceEnumeration

part of: Workers_Compensation_CodeObjectID
Base Type
string
top
 

Custom_Worktag_01ReferenceEnumeration

part of: Custom_Worktag_01ObjectID
Base Type
string
top
 

Custom_Worktag_02ReferenceEnumeration

part of: Custom_Worktag_02ObjectID
Base Type
string
top
 

Custom_Worktag_03ReferenceEnumeration

part of: Custom_Worktag_03ObjectID
Base Type
string
top
 

Custom_Worktag_04ReferenceEnumeration

part of: Custom_Worktag_04ObjectID
Base Type
string
top
 

Custom_Worktag_05ReferenceEnumeration

part of: Custom_Worktag_05ObjectID
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
string
top
 

Custom_OrganizationReferenceEnumeration

part of: Custom_OrganizationObjectID
Base Type
string
top
 

Custom_Worktag_06ReferenceEnumeration

part of: Custom_Worktag_06ObjectID
Base Type
string
top
 

Custom_Worktag_07ReferenceEnumeration

part of: Custom_Worktag_07ObjectID
Base Type
string
top
 

Custom_Worktag_08ReferenceEnumeration

part of: Custom_Worktag_08ObjectID
Base Type
string
top
 

Custom_Worktag_09ReferenceEnumeration

part of: Custom_Worktag_09ObjectID
Base Type
string
top
 

Custom_Worktag_10ReferenceEnumeration

part of: Custom_Worktag_10ObjectID
Base Type
string
top
 

Custom_Worktag_11ReferenceEnumeration

part of: Custom_Worktag_11ObjectID
Base Type
string
top
 

Custom_Worktag_12ReferenceEnumeration

part of: Custom_Worktag_12ObjectID
Base Type
string
top
 

Custom_Worktag_13ReferenceEnumeration

part of: Custom_Worktag_13ObjectID
Base Type
string
top
 

Custom_Worktag_14ReferenceEnumeration

part of: Custom_Worktag_14ObjectID
Base Type
string
top
 

Custom_Worktag_15ReferenceEnumeration

part of: Custom_Worktag_15ObjectID
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
 

Payroll_Income_CodeReferenceEnumeration

part of: Payroll_Income_CodeObjectID
Base Type
string
top
 

Related_Calculation__All_ReferenceEnumeration

part of: Related_Calculation__All_ObjectID
Base Type
string
top