Service Directory > v31.2 > Payroll > Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers
 

Operation: Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers

This web service is used to return RPP and DPSP registration numbers


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

Get Payroll Payee RPP or DPSP Registration Numbers Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_RPP_or_DPSP_Registration_Number_Request_References  [0..1]  Element to hold all Payroll Payee Request References   
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_RPP_or_DPSP_Registration_Number_Response_Group  [0..1]  Element to hold all information about the Payroll Payee RPP or DPSP Registration Number Response Group   
top
 

Response Element: Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_Response

Get Payroll Payee RPP or DPSP Registration Numbers Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Payee_RPP_or_DPSP_Registration_Number_Request_References  [0..1]  All RPP or DPSP Registration Numbers to get from their References   
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_RPP_or_DPSP_Registration_Number_Response_Group  [0..1]  Element to hold all information about the Payroll Payee RPP or DPSP Registration Number 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_RPP_or_DPSP_Registration_Number_Response_Data  [0..1]  Element to hold all data to Respond with about the Payroll Payee RPP or DPSP Registration Numbers   
top
 

Payroll_Payee_RPP_or_DPSP_Registration_Number_Request_References

part of: Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_Request, Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_Response
Element to hold all Payroll Payee Request References
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RPP_or_DPSP_Registration_Number_Reference  Payroll_Payee_RPP_or_DPSP_Registration_NumbersObject  [1..*]  All Payroll Payee RPP or DPSP Registration Numbers from the references given   
top
 

Payroll_Payee_RPP_or_DPSP_Registration_NumbersObject

part of: Payroll_Payee_RPP_or_DPSP_Registration_Number_Request_References, Payroll_Payee_RPP_or_DPSP_Registration_Number, Payroll_Payee_RPP_or_DPSP_Registration_Number_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_Payee_RPP_or_DPSP_Registration_NumbersObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_Payee_RPP_or_DPSP_Registration_NumbersObjectID

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

part of: Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_Request, Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_Response
Element to hold all information about the Payroll Payee RPP or DPSP Registration Number Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Boolean   
top
 

Response_Results

part of: Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_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_RPP_or_DPSP_Registration_Number_Response_Data

part of: Get_Payroll_Payee_RPP_or_DPSP_Registration_Numbers_Response
Element to hold all data to Respond with about the Payroll Payee RPP or DPSP Registration Numbers
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RPP_or_DPSP_Registration_Number  Payroll_Payee_RPP_or_DPSP_Registration_Number  [0..*]  Element to hold all information about the Payroll Payee RPP or DPSP Registration Number Response Group   
top
 

Payroll_Payee_RPP_or_DPSP_Registration_Number

part of: Payroll_Payee_RPP_or_DPSP_Registration_Number_Response_Data
Element to hold all information about the Payroll Payee RPP or DPSP Registration Number Response Group
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RPP_or_DPSP_Registration_Number_Reference  Payroll_Payee_RPP_or_DPSP_Registration_NumbersObject  [0..1]  Instance of the RPP or DPSP Registration Number record returned   
Payroll_Payee_RPP_or_DPSP_Registration_Number_Data  Payroll_Payee_RPP_or_DPSP_Registration_Number_Data  [0..*]  Payroll Payee RPP or DPSP Registration Number Data 
Validation Description
Worker has no Position within this company. Tax Elections can only be created for Companies for which the Worker has a Position.   
The RPP or DPSP Registration Number does not exist.   
 
top
 

Payroll_Payee_RPP_or_DPSP_Registration_Number_Data

part of: Payroll_Payee_RPP_or_DPSP_Registration_Number
Payroll Payee RPP or DPSP Registration Number Data
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Payee_RPP_or_DPSP_Registration_Number_Reference  Payroll_Payee_RPP_or_DPSP_Registration_NumbersObject  [0..1]  All Payroll Payee RPP or DPSP Registration Numbers from the references given   
Company_Reference  CompanyObject  [1..1]  Company for this RPP or DPSP Registration Number Record   
Worker_Reference  WorkerObject  [1..1]  Worker Reference for this RPP or DPSP Registration Number   
Effective_Date  date  [1..1]  Effective Date for this RPP or DPSP Registration Number Record   
RPP_or_DPSP_Registration_Number  string (7)   [1..1]  RPP or DPSP Registration Number Record   
Last_Updated  dateTime  [0..1]  Creation Date for this RPP or DPSP Registration Number Record   
Validation Description
Worker has no Position within this company. Tax Elections can only be created for Companies for which the Worker has a Position.   
The RPP or DPSP Registration Number does not exist.   
top
 

CompanyObject

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

WorkerObject

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

Payroll_Payee_RPP_or_DPSP_Registration_NumbersReferenceEnumeration

part of: Payroll_Payee_RPP_or_DPSP_Registration_NumbersObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top