Service Directory > v31.2 > Payroll > Get_Company_Payment_Dates
 

Operation: Get_Company_Payment_Dates

This operation returns a list of Payment Dates for a given Company and Date Range parms.


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

Get Payment Dates for Company and Date Range Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Company_Payment_Dates_Request_Criteria  [1..1]  Payment Dates for Comapny and Date Range Request Criteria element   
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_Company_Payment_Dates_Response

Get Payment Dates for Company and Date Range Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Company_Payment_Dates_Request_Criteria  [0..1]  Payment Dates for Comapny and Date Range Request Criteria element   
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  Company_Payment_Dates_Response_Data  [0..1]  Payment Dates for Company and Date Range Response Data element   
top
 

Company_Payment_Dates_Request_Criteria

part of: Get_Company_Payment_Dates_Request, Get_Company_Payment_Dates_Response
Payment Dates for Comapny and Date Range Request Criteria element
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company Reference   
Include_Related_Companies_for_Legal_Entity  boolean  [0..1]  If the requested company is a single legal entity, the response will include results from other companies in the relationship when this flag is true.   
Result_Completed_From  dateTime  [1..1]  Start Date Time stamp for when payroll results were completed as part of the selection criteria.   
Result_Completed_To  dateTime  [1..1]  End Date Time stamp for when payroll results were completed as part of the selection criteria.   
top
 

CompanyObject

part of: Company_Payment_Dates_Request_Criteria, Company_Payment_Dates_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
 

Response_Filter

part of: Get_Company_Payment_Dates_Request, Get_Company_Payment_Dates_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_Company_Payment_Dates_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
 

Company_Payment_Dates_Response_Data

part of: Get_Company_Payment_Dates_Response
Payment Dates for Company and Date Range Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Company_Payment_Dates_Data  Company_Payment_Dates_Data  [0..*]  Payment Dates for Company and Date Range Data element.   
top
 

Company_Payment_Dates_Data

part of: Company_Payment_Dates_Response_Data
Payment Dates for Company and Date Range Data element
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Payroll Input Reference   
Payment_Date  date  [0..1]  Payment Date.   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top