Service Directory > v31.2 > Payroll_Interface > Get_External_Payroll_Inputs
 

Operation: Get_External_Payroll_Inputs

This operation retrieves data related to External Payroll Inputs (e.g. associated with an External Earning/Deduction).


@ - 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: Get_External_Payroll_Inputs_Request

Request element used to find and get External Payroll Input entries and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   External_Payroll_Input_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of External Payroll Input and its associated data.   
Request_Criteria [Choice]   External_Payroll_Input_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter the returned population to those External Payroll Input entries that meet ALL of the criteria. 
Validation Description
The Pay Component Calculation Category must be Payroll Interface and the Payroll Input Type for the Pay Component Code must be either Adjustment or Input.   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_External_Payroll_Inputs_Response

Response element containing instances of External Payroll Inputs and each of its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  External_Payroll_Input_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of External Payroll Input and its associated data.   
Request_Criteria  External_Payroll_Input_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter the returned population to those External Payroll Input entries that meet ALL of the criteria. 
Validation Description
The Pay Component Calculation Category must be Payroll Interface and the Payroll Input Type for the Pay Component Code must be either Adjustment or Input.   
 
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  External_Payroll_Input_Response_Data  [0..1]  Contains each External Payroll Input based on the Request Criteria. The data returned is the current information as of the dates in the response filter.   
top
 

External_Payroll_Input_Request_References

part of: Get_External_Payroll_Inputs_Request, Get_External_Payroll_Inputs_Response
Utilize the Request References element to retrieve a specific instance(s) of External Payroll Input and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
External_Payroll_Input_Reference  Payroll_InputObject  [1..*]  Unique identifier for an External Payroll Input   
top
 

Payroll_InputObject

part of: External_Payroll_Input_Request_References, External_Payroll_Input
 
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_InputObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_InputObjectID

part of: Payroll_InputObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Payroll_Input_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
 

External_Payroll_Input_Request_Criteria

part of: Get_External_Payroll_Inputs_Request, Get_External_Payroll_Inputs_Response
Utilize the Request Criteria element to filter the returned population to those External Payroll Input entries that meet ALL of the criteria.
 
Parameter name Type/Value Cardinality Description Validations
Payee_Reference  WorkerObject  [0..*]  Unique identifier used to reference an Payee (e.g. Employee).   
Pay_Component_Workday_Reference  Pay_ComponentObject  [0..*]  Unique identifier used to reference a Pay Component (e.g. Earning, Deduction)   
Start_Date  date  [0..1]  Start Date   
End_Date  date  [0..1]  End Date   
Batch_Reference  Application_BatchObject  [0..*]  Batch Reference   
Validation Description
The Pay Component Calculation Category must be Payroll Interface and the Payroll Input Type for the Pay Component Code must be either Adjustment or Input.   
top
 

WorkerObject

part of: External_Payroll_Input_Request_Criteria
 
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  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, 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
 

Pay_ComponentObject

part of: External_Payroll_Input_Data, External_Payroll_Input_Request_Criteria
 
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_ComponentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Pay_ComponentObjectID

part of: Pay_ComponentObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Deduction_Code, Earning_Code, Workday_Deduction_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
 

Application_BatchObject

part of: External_Payroll_Input_Request_Criteria
 
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  Application_BatchObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Application_BatchObjectID

part of: Application_BatchObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Batch_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
 

Response_Filter

part of: Get_External_Payroll_Inputs_Request, Get_External_Payroll_Inputs_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_External_Payroll_Inputs_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

External_Payroll_Input_Response_Data

part of: Get_External_Payroll_Inputs_Response
Contains each External Payroll Input based on the Request Criteria. The data returned is the current information as of the dates in the response filter.
 
Parameter name Type/Value Cardinality Description Validations
External_Payroll_Input  External_Payroll_Input  [0..*]  Encapsulating element containing all External Payroll Input data.   
top
 

External_Payroll_Input

part of: External_Payroll_Input_Response_Data
Encapsulating element containing all External Payroll Input data.
 
Parameter name Type/Value Cardinality Description Validations
External_Payroll_Input_Reference  Payroll_InputObject  [0..1]  Unique identifier for an External Payroll Input entry   
External_Payroll_Input_Data  External_Payroll_Input_Data  [0..1]  Contains each External Payroll Input based on the Request Criteria. The data returned is the current information as of the dates in the response filter. 
Validation Description
Pay Calculation (Earning, Deduction, or a Related Calculation) must allow input.  Pay Calculation (Earning, Deduction, or a Related Calculation) must allow input. 
Payroll Input may only contain a Goal Amount when the Payroll Input Types associated with the Pay Component include Goal Amount.  Payroll Input may only contain a Goal Amount when the Payroll Input Types associated with the Pay Component include Goal Amount. 
Payroll Input may only contain an Adjustment Value when the Payroll Input Types associated with the Pay Component include Adjustment.  Payroll Input may only contain an Adjustment Value when the Payroll Input Types associated with the Pay Component include Adjustment. 
Payroll Input cannot contain a Goal Amount when an Adjustment Value has been entered.  Payroll Input cannot contain a Goal Amount when an Adjustment Value has been entered. 
The End Date must be greater than the Start Date.  The End Date must be greater than the Start Date. 
Overlapping Input Line: for input lines that pertain to the same Earning/Deduction and are non-adjustments, there can not be an overlap in Start and End Dates (Note: no value for End Date assumes an on-going Payroll Input)  Overlapping Input Line: for input lines that pertain to the same Earning/Deduction and are non-adjustments, there can not be an overlap in Start and End Dates (Note: no value for End Date assumes an on-going Payroll Input) 
Duplicate Input Line: for input lines that are non-adjustments, there can only be a maximum of 1 line with the combination of Earning/Deduction, Start Date and End Date.  Duplicate Input Line: for input lines that are non-adjustments, there can only be a maximum of 1 line with the combination of Earning/Deduction, Start Date and End Date. 
Payroll Input may only contain either Amount Value or Adjustment Value, but not a value for both.  Payroll Input may only contain either Amount Value or Adjustment Value, but not a value for both. 
Batch ID is already associated with other types of Application Batches.   
Position should not be entered if pay component is not position based.   
Position is required if pay component is position based.   
Position reference cannot be entered because multiple jobs are not enabled in this tenant.   
Worker's primary position must be in a payroll interface pay group if position is not supplied on the external payroll input.  Worker's primary position must be in a payroll interface pay group if position is not supplied on the external payroll input. 
Ongoing Payroll Input for Terminated Employee is not allowed.  Ongoing Payroll Input for Terminated Employee is not allowed. 
Ongoing Payroll Input is not allowed for an Ended Position.  Ongoing Payroll Input is not allowed for an Ended Position. 
The field End Date is required and must have a value.  The field End Date is required and must have a value. 
For adjustment entry enter an End Date that is the same as the start date.  For adjustment entry enter an End Date that is the same as the start date. 
Previously added Pay Component for Payroll Input cannot be subsequently changed. [worker]   
Changing the worker associated with a Payroll Input is not allowed when updating an existing Payroll Input. [worker]   
Start Date must be greater than or equal to [validationDate]   
End Date must be greater than or equal to [validationDate]   
 
top
 

External_Payroll_Input_Data

part of: External_Payroll_Input
Contains each External Payroll Input based on the Request Criteria. The data returned is the current information as of the dates in the response filter.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Input_ID  string  [0..1]  The integration ID used to reference the Payroll Input. If the ID for the Payroll Input is found, the web service will update the existing data. Otherwise, a new Payroll Input instance will be created.   
Payee_Reference  EmployeeObject  [1..1]  Unique identifier used to reference an Payee (e.g. Employee).   
Pay_Component_Workday_Reference  Pay_ComponentObject  [1..1]  Unique identifier used to reference a Pay Component (e.g. Earning, Deduction)   
External_Payroll_Code  string  [0..1]  A non-unique code used by some Payroll Interface customers. External Payroll Code is available in Workday 13 if the customer has enabled it via the Tenant Setup page.   
Batch_ID  string  [0..1]  Batch ID can be assigned to a set of Payroll Inputs to enable the external system to manage Payroll Input data by Batch ID. There are transactions in Workday Payroll that let the user maintain Payroll Input data by Batch ID (Payroll Input by Batch ID and Delete Payroll Input by Batch ID).   
Start_Date  date  [1..1]  Start Date (e.g. the date on which the Payroll Input commences)   
End_Date  date  [0..1]  End Date (e.g. the date on which the Payroll Input ends, if applicable)   
Position_Reference  Position_ElementObject  [0..1]  Position reference associated with the external payroll input.   
Worktag_Reference  Payroll_WorktagObject  [0..1]  Reference to a worktag associated with the external payroll input.   
Input_Value  decimal (26, 6)   [0..1]  Value (for Currency)   
Goal_Amount  decimal (26, 6)   [0..1]  Goal Amount (for Currency)   
Adjustment_Value  decimal (26, 6)   [0..1]  Adjustment Value (for Currency)   
Comment  string  [0..1]  Comment   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference   
Validation Description
Pay Calculation (Earning, Deduction, or a Related Calculation) must allow input.  Pay Calculation (Earning, Deduction, or a Related Calculation) must allow input. 
Payroll Input may only contain a Goal Amount when the Payroll Input Types associated with the Pay Component include Goal Amount.  Payroll Input may only contain a Goal Amount when the Payroll Input Types associated with the Pay Component include Goal Amount. 
Payroll Input may only contain an Adjustment Value when the Payroll Input Types associated with the Pay Component include Adjustment.  Payroll Input may only contain an Adjustment Value when the Payroll Input Types associated with the Pay Component include Adjustment. 
Payroll Input cannot contain a Goal Amount when an Adjustment Value has been entered.  Payroll Input cannot contain a Goal Amount when an Adjustment Value has been entered. 
The End Date must be greater than the Start Date.  The End Date must be greater than the Start Date. 
Overlapping Input Line: for input lines that pertain to the same Earning/Deduction and are non-adjustments, there can not be an overlap in Start and End Dates (Note: no value for End Date assumes an on-going Payroll Input)  Overlapping Input Line: for input lines that pertain to the same Earning/Deduction and are non-adjustments, there can not be an overlap in Start and End Dates (Note: no value for End Date assumes an on-going Payroll Input) 
Duplicate Input Line: for input lines that are non-adjustments, there can only be a maximum of 1 line with the combination of Earning/Deduction, Start Date and End Date.  Duplicate Input Line: for input lines that are non-adjustments, there can only be a maximum of 1 line with the combination of Earning/Deduction, Start Date and End Date. 
Payroll Input may only contain either Amount Value or Adjustment Value, but not a value for both.  Payroll Input may only contain either Amount Value or Adjustment Value, but not a value for both. 
Batch ID is already associated with other types of Application Batches.   
Position should not be entered if pay component is not position based.   
Position is required if pay component is position based.   
Position reference cannot be entered because multiple jobs are not enabled in this tenant.   
Worker's primary position must be in a payroll interface pay group if position is not supplied on the external payroll input.  Worker's primary position must be in a payroll interface pay group if position is not supplied on the external payroll input. 
Ongoing Payroll Input for Terminated Employee is not allowed.  Ongoing Payroll Input for Terminated Employee is not allowed. 
Ongoing Payroll Input is not allowed for an Ended Position.  Ongoing Payroll Input is not allowed for an Ended Position. 
The field End Date is required and must have a value.  The field End Date is required and must have a value. 
For adjustment entry enter an End Date that is the same as the start date.  For adjustment entry enter an End Date that is the same as the start date. 
Previously added Pay Component for Payroll Input cannot be subsequently changed. [worker]   
Changing the worker associated with a Payroll Input is not allowed when updating an existing Payroll Input. [worker]   
Start Date must be greater than or equal to [validationDate]   
End Date must be greater than or equal to [validationDate]   
top
 

EmployeeObject

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

Position_ElementObject

part of: External_Payroll_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_WorktagObject

part of: External_Payroll_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  Payroll_WorktagObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_WorktagObjectID

part of: Payroll_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Employee_ID, FLSA_Workweek_Calendar_Event_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Holiday_Calendar_Event_ID, Job_Profile_ID, Location_ID, NI_Category_Letter, Object_Class_ID, Organization_Reference_ID, Payroll_Federal_Authority_Tax_Code, Payroll_ID, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Position_ID, Program_ID, Project_ID, Project_Plan_ID, Region_Reference_ID, Rubric_Value_ID, Run_Category_ID, Withholding_Order_Case_ID, 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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, FLSA_Workweek_Calendar_ID, Holiday_Calendar_ID  [1..1]  The unique identifier type of a parent object   
top
 

CurrencyObject

part of: External_Payroll_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  CurrencyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CurrencyObjectID

part of: CurrencyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Currency_ID, Currency_Numeric_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_InputReferenceEnumeration

part of: Payroll_InputObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Pay_ComponentReferenceEnumeration

part of: Pay_ComponentObjectID
Base Type
string
top
 

Application_BatchReferenceEnumeration

part of: Application_BatchObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Payroll_WorktagReferenceEnumeration

part of: Payroll_WorktagObjectID
Base Type
string
top
 

Base Type
string

top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top