Service Directory > v31.2 > Payroll_GBR > Get_Payroll_Holiday_Pay_History
 

Operation: Get_Payroll_Holiday_Pay_History

This public web service operation is designed to retrieve UK Holiday Pay Historical Pay Data for a Pay Group, group of ~Workers~ or all data.


@ - 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_Payroll_Holiday_Pay_History_Request

Get Payroll Holiday Pay History Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Payroll_Holiday_Pay_Request_Criteria  [0..*]  Get Payroll Holiday Pay History Request Element   
Response_Filter  Response_Filter  [0..*]  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_Payroll_Holiday_Pay_History_Response

Get Payroll Holiday Pay History Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Payroll_Holiday_Pay_Request_Criteria  [0..*]  Get Payroll Holiday Pay History Request Element   
Response_Filter  Response_Filter  [0..*]  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_Data  Payroll_Holiday_Pay_History_Response_Data  [0..*]  Payroll Holiday Pay History Response Element   
top
 

Payroll_Holiday_Pay_Request_Criteria

part of: Get_Payroll_Holiday_Pay_History_Response, Get_Payroll_Holiday_Pay_History_Request
Get Payroll Holiday Pay History Request Element
 
Parameter name Type/Value Cardinality Description Validations
Pay_Group_Reference  Pay_GroupObject  [0..1]  UK Pay Group to retrieve UK Holiday Pay Historical Pay Data for.   
Worker_Reference  WorkerObject  [0..*]  Workers to retrieve UK Holiday Pay Historical Data for.   
top
 

Pay_GroupObject

part of: Payroll_Holiday_Pay_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_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
 

WorkerObject

part of: Payroll_Holiday_Pay_History_Data, Payroll_Holiday_Pay_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
 

Response_Filter

part of: Get_Payroll_Holiday_Pay_History_Response, Get_Payroll_Holiday_Pay_History_Request
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
 

Payroll_Holiday_Pay_History_Response_Data

part of: Get_Payroll_Holiday_Pay_History_Response
Payroll Holiday Pay History Response Element
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Holiday_Pay_History  Payroll_Holiday_Pay_History  [0..*]  Get UK Holiday Pay Historical Pay Data Response Subedit Element   
top
 

Payroll_Holiday_Pay_History

part of: Payroll_Holiday_Pay_History_Response_Data
Payroll Holiday Pay History Element
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Holiday_Pay_History_Data_Reference  Unique_IdentifierObject  [0..1]  Payroll Holiday Pay History instance reference.   
Payroll_Holiday_Pay_History_Data  Payroll_Holiday_Pay_History_Data  [0..*]  Payroll Holiday Pay History Element   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Payroll_Holiday_Pay_History
Payroll Holiday Pay History Element
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  The Worker for the Historical Holiday Pay payment.   
Period_Reference  PeriodObject  [0..1]  The Period of the Historical Holiday Pay payment.   
Payment_Date  date  [0..1]  The Payment Date of the Historical Holiday Pay payment.   
Amount  decimal (26, 6)   [0..1]  The Amount of the Historical Holiday Pay payment.   
Earnings_Pay_Component_Group_Reference  Pay_Component_Group__All_Object  [0..1]  The Earnings Pay Component Group of the Historical Holiday Pay payment.   
Hours_Worked  decimal (14, 2)   [0..1]  The Hours Worked of the Historical Holiday Pay payment.   
Hours_Pay_Component_Group_Reference  Pay_Component_Group__All_Object  [0..1]  The Hours Pay Component Group of the Historical Holiday Pay payment.   
Use_in_Pay_Calculations  boolean  [0..1]  Specifies whether this Historical Holiday Pay payment is to be used in calculations.   
Exclude_from_Pay_Calculations  boolean  [0..1]  Specifies whether this Historical Holiday Pay payment is to be excluded from calculations.   
top
 

PeriodObject

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

PeriodObjectID

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

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

Pay_Component_Group__All_ObjectID

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

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

Pay_Component_Group__All_ReferenceEnumeration

part of: Pay_Component_Group__All_ObjectID
Base Type
string
top