Service Directory > v31.2 > Payroll_Interface > Get_Batches
 

Operation: Get_Batches

This operation retrieves data related to an externally loaded Batch and its associated Application Input (e.g. Payroll, External Payroll, Absence).


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

Request element used to find and get Batches and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Batch_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Batch and its associated data.   
Request_Criteria [Choice]   Batch_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter the returned population to those Batches that meet ALL of the criteria. 
Validation Description
Batch ID is required if Source Reference (e.g. Integration System) is populated.  Batch ID is required if Source Reference (e.g. Integration System) is populated. 
Source Reference is required if Batch ID is populated.  Source Reference is required if Batch ID is populated. 
 
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_Batches_Response

Response element containing instances of Batch and each of its associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Batch_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Batch and its associated data.   
Request_Criteria  Batch_Request_Criteria  [0..1]  Utilize the Request Criteria element to filter the returned population to those Batches that meet ALL of the criteria. 
Validation Description
Batch ID is required if Source Reference (e.g. Integration System) is populated.  Batch ID is required if Source Reference (e.g. Integration System) is populated. 
Source Reference is required if Batch ID is populated.  Source Reference is required if Batch ID is populated. 
 
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  Batch_Response_Data  [0..1]  Contains each Batch based on the Request Criteria. The data returned is the current information as of the dates in the response filter.   
top
 

Batch_Request_References

part of: Get_Batches_Request, Get_Batches_Response
Utilize the Request References element to retrieve a specific instance(s) of Batch and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Batch_Reference  Application_BatchObject  [1..*]  Batch Reference   
top
 

Application_BatchObject

part of: Application_Batch, Batch_Request_References
 
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
 

Batch_Request_Criteria

part of: Get_Batches_Request, Get_Batches_Response
Utilize the Request Criteria element to filter the returned population to those Batches that meet ALL of the criteria.
 
Parameter name Type/Value Cardinality Description Validations
Batch_ID  string  [0..1]  Batch ID   
Source_Reference  Integration_System__Audited_Object  [0..1]  Source (e.g. Integration System)   
Validation Description
Batch ID is required if Source Reference (e.g. Integration System) is populated.  Batch ID is required if Source Reference (e.g. Integration System) is populated. 
Source Reference is required if Batch ID is populated.  Source Reference is required if Batch ID is populated. 
top
 

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

Batch_Response_Data

part of: Get_Batches_Response
Contains each Batch 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
Batch  Application_Batch  [0..*]  Encapsulating element containing all Batch data.   
top
 

Application_Batch

part of: Batch_Response_Data
Encapsulating element containing all Batch data.
 
Parameter name Type/Value Cardinality Description Validations
Batch_Reference  Application_BatchObject  [0..1]  Batch Reference   
Batch_Data  Application_Batch_Data  [1..1]  Contains each Batch based on the Request Criteria. The data returned is the current information as of the dates in the response filter.   
Batch_Totals_Data  Input_Line_Currency_Totals_Data  [0..*]  Information on the summary of all Payroll Inputs associated with a Currency   
Batch_Pay_Component_Totals_Data  Batch_Pay_Component_Totals_Data  [0..*]  Information on the summary of all Payroll Inputs associated with a Pay Component   
top
 

Application_Batch_Data

part of: Application_Batch
Contains each Batch 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
Batch_ID  string  [1..1]  Batch ID is the unique identifier.   
Application_Batch_Usage_Reference  Application_Batch_UsageObject  [1..1]  The application batch usage ID; valid values are ABSENCE, PAYROLL, PAYROLL_HISTORY, PAYROLL_INTERFACE, or PAYROLL_OFF-CYCLE. Although Batch Usage is not yet required, entering an application batch usage improves performance by allowing processing in parallel.   
Source_Reference  Integration_System__Audited_Object  [0..1]  Source (e.g. Integration System)   
top
 

Application_Batch_UsageObject

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

Application_Batch_UsageObjectID

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

Input_Line_Currency_Totals_Data

part of: Application_Batch, Batch_Pay_Component_Totals_Data
Information on the summary of all Payroll Inputs associated with a Currency
 
Parameter name Type/Value Cardinality Description Validations
Currency_Reference  CurrencyObject  [1..1]  Currency Reference   
Count  decimal (12, 0) >0   [0..1]  Count of Payroll Inputs   
Sum_Input_Value  decimal (26, 6)   [0..1]  Sum Input Value   
Sum_Goal_Amount  decimal (26, 6)   [0..1]  Sum Goal Amount   
Sum_Adjustment_Value  decimal (30, 6)   [0..1]  Sum Adjustment Value   
top
 

CurrencyObject

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

Batch_Pay_Component_Totals_Data

part of: Application_Batch
Information on the summary of all Payroll Inputs associated with a Pay Component
 
Parameter name Type/Value Cardinality Description Validations
Pay_Component_Reference  Input_InterfaceObject  [0..1]  Unique identifier used to reference a Pay Component (e.g. Earning, Deduction)   
Pay_Component_Totals_Data  Input_Line_Currency_Totals_Data  [0..*]  Information on the summary of all Payroll Inputs associated with a Currency   
top
 

Input_InterfaceObject

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

Input_InterfaceObjectID

part of: Input_InterfaceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Accrual_Code, Deduction_Code, Earning_Code, Pay_Component_Related_Calculation_Code, Related_Calculation_ID, Time_Off_Code, Workday_Absence_Code, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Component_Related_Calculation_Code, Workday_Related_Calculation_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
 

Application_BatchReferenceEnumeration

part of: Application_BatchObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

Application_Batch_UsageReferenceEnumeration

part of: Application_Batch_UsageObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Input_InterfaceReferenceEnumeration

part of: Input_InterfaceObjectID
Base Type
string
top