Service Directory > v31.2 > Payroll_GBR > Get_Payroll_Payee_RTIs
 

Operation: Get_Payroll_Payee_RTIs

Provides the ability to retrieve all or some worker's PAYE RTI information based on Criteria (Company/Worker).


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

Get Payroll Payee RTIs Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Payee_RTI_Request_References  [0..1]  Payroll Payee RTI References   
Request_Criteria [Choice]   Payroll_Payee_RTI_Request_Criteria  [0..1]  Payroll Payee RTI Request Criteria   
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_Group  Payroll_Payee_RTI_Response_Group  [0..1]  Payroll Payee RTI Response Group   
top
 

Response Element: Get_Payroll_Payee_RTIs_Response

Get Payroll Payee RTI Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_RTI_Request_References  [0..1]  Payroll Payee RTI References   
Request_Criteria  Payroll_Payee_RTI_Request_Criteria  [0..1]  Payroll Payee RTI Request Criteria   
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_Group  Payroll_Payee_RTI_Response_Group  [0..1]  Payroll Payee RTI Response Group   
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  Payroll_Payee_RTI_Response_Data  [0..1]  Get Payroll Payee RTI Response   
top
 

Payroll_Payee_RTI_Request_References

part of: Get_Payroll_Payee_RTIs_Request, Get_Payroll_Payee_RTIs_Response
Payroll Payee RTI References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RTI_Reference  Unique_IdentifierObject  [1..*]  Payroll Payee RTI References   
top
 

Unique_IdentifierObject

part of: Payroll_Payee_RTI_Request_References, Payroll_Payee_RTI_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_Payee_RTI_Request_Criteria

part of: Get_Payroll_Payee_RTIs_Request, Get_Payroll_Payee_RTIs_Response
Payroll Payee RTI Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference [Choice]   WorkerObject  [1..*]  Payroll Payee RTI Request Worker   
Company_Reference [Choice]   CompanyObject  [1..*]  Payroll Payee RTI Request Companies   
Effective_As_Of  date  [0..1]  Payroll Payee RTI Request Effective Date   
top
 

WorkerObject

part of: Payroll_Payee_RTI_Data, Payroll_Payee_RTI_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
 

CompanyObject

part of: Payroll_Payee_RTI_Data, Payroll_Payee_RTI_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  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
 

Response_Filter

part of: Get_Payroll_Payee_RTIs_Request, Get_Payroll_Payee_RTIs_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
 

Payroll_Payee_RTI_Response_Group

part of: Get_Payroll_Payee_RTIs_Request, Get_Payroll_Payee_RTIs_Response
Payroll Payee RTI Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Payroll Payee RTI Reference in the Response   
top
 

Response_Results

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

Payroll_Payee_RTI_Response_Data

part of: Get_Payroll_Payee_RTIs_Response
Get Payroll Payee RTI Response
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RTI  Payroll_Payee_RTI_History  [0..*]  Payroll Payee RTI Data   
top
 

Payroll_Payee_RTI_History

part of: Payroll_Payee_RTI_Response_Data
Payroll Payee RTI Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RTI_Reference  Unique_IdentifierObject  [0..1]  Payroll Payee RTI Reference   
Payroll_Payee_RTI_Data  Payroll_Payee_RTI_Data  [0..*]  Payroll Payee RTI Data 
Validation Description
FPS submitted for Deceased Worker cannot be set for a Worker who is not deceased   
The Company specified is not valid for the Worker.   
Set the Override Contract End Date flag if the Contract End Date has been specified.   
Provide a Contract End Date if the worker has already been reported as a deceased worker in the FPS.   
 
top
 

Payroll_Payee_RTI_Data

part of: Payroll_Payee_RTI_History
Payroll Payee RTI Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
Effective_As_Of  date  [0..1]  Effective as of Date   
Company_Reference  CompanyObject  [0..1]  Company for employee   
Irregular_Payment_Pattern  boolean  [0..1]  Irregular payment pattern indicator   
Late_PAYE_Reporting_Reason_Reference  Payroll_Constant_TextObject  [0..1]  Late PAYE reporting reason code   
FPS_Submitted_for_Deceased_Worker  boolean  [0..1]  FPS has been submitted for the deceased worker.   
Override_Contract_End_Date  boolean  [0..1]  Override Contract End Date flag   
Contract_End_Date  date  [0..1]  Contract End Date   
Validation Description
FPS submitted for Deceased Worker cannot be set for a Worker who is not deceased   
The Company specified is not valid for the Worker.   
Set the Override Contract End Date flag if the Contract End Date has been specified.   
Provide a Contract End Date if the worker has already been reported as a deceased worker in the FPS.   
top
 

Payroll_Constant_TextObject

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

Payroll_Constant_TextObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_Constant_TextReferenceEnumeration

part of: Payroll_Constant_TextObjectID
Base Type
string
top