Service Directory > v32.1 > Payroll_Interface > Get_Worker_Costing_Allocations
 

Operation: Get_Worker_Costing_Allocations

Get Worker- or Position Restrictions-based costing allocations, either for specific criteria or for all workers or positions. Can include only the external integration references or the full allocation details.


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

Request criteria (specific and universal) for the Get Worker Costing Allocations service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Worker_Costing_Allocations_Request_Criteria  [0..1]  Specific request criteria for the Get Worker Costing Allocations service. 
Validation Description
The individual Costing Override Criteria references and the "Include All" attributes are both submitted - use one option or the other.  The individual Costing Override Criteria references and the "Include All" attributes are both submitted - use one option or the other. 
 
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  Worker_Costing_Allocations_Response_Group  [0..1]  Configure the content returned for the Get Worker Costing Allocations service.   
top
 

Response Element: Get_Worker_Costing_Allocations_Response

Wrapper for the data returned by the Get Worker Costing Allocations service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Worker_Costing_Allocations_Request_Criteria  [0..1]  Specific request criteria for the Get Worker Costing Allocations service. 
Validation Description
The individual Costing Override Criteria references and the "Include All" attributes are both submitted - use one option or the other.  The individual Costing Override Criteria references and the "Include All" attributes are both submitted - use one option or the other. 
 
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  Worker_Costing_Allocations_Response_Group  [0..1]  Configure the content returned for the Get Worker Costing Allocations service.   
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  Worker_Costing_Allocations_Response_Data  [0..1]  Wrapper for the data returned by the Get Worker Costing Allocations service.   
top
 

Worker_Costing_Allocations_Request_Criteria

part of: Get_Worker_Costing_Allocations_Request, Get_Worker_Costing_Allocations_Response
Specific request criteria for the Get Worker Costing Allocations service.
 
Parameter name Type/Value Cardinality Description Validations
Costing_Override_Criteria  Costing_Override_Criteria  [0..1]  High-level criteria identifying individual Costing Allocation Overrides to be returned by the Get Worker Costing Allocations service.   
Include_All_Worker_Costing_Allocations  boolean  [0..1]  Instead of specifying individual selection criteria, this option returns all existing Worker-based Costing Allocation Overrides.   
Include_All_Position_Restrictions_Costing_Allocations  boolean  [0..1]  Instead of specifying individual selection criteria, this option returns all existing Position Restrictions-based Costing Allocation Overrides.   
Include_Only_Current_Costing_Override_Interval  boolean  [0..1]  Instructs the service to return only the single currently-effective Costing Override date range for each high-level costing criteria combination (Worker/Position/Earning).   
Validation Description
The individual Costing Override Criteria references and the "Include All" attributes are both submitted - use one option or the other.  The individual Costing Override Criteria references and the "Include All" attributes are both submitted - use one option or the other. 
top
 

Costing_Override_Criteria

part of: Worker_Costing_Allocations_Request_Criteria
High-level criteria identifying individual Costing Allocation Overrides to be returned by the Get Worker Costing Allocations service.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  Worker Reference as primary criteria identifying individual Costing Allocation Override to be returned.   
Position_Restriction_Reference  Position_RestrictionsObject  [0..*]  Position Restrictions Reference as primary criteria identifying individual Costing Allocation Override to be returned.   
top
 

WorkerObject

part of: Costing_Override_Criteria, Worker_Costing_Allocations_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
 

Position_RestrictionsObject

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

Position_RestrictionsObjectID

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

Worker_Costing_Allocations_Response_Group

part of: Get_Worker_Costing_Allocations_Request, Get_Worker_Costing_Allocations_Response
Configure the content returned for the Get Worker Costing Allocations service.
 
Parameter name Type/Value Cardinality Description Validations
Exclude_Allocation_Detail_Data  boolean  [0..1]  Instructs the service to return only the Costing Override keys (ID and date range) and to exclude the distribution details.   
top
 

Response_Results

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

Worker_Costing_Allocations_Response_Data

part of: Get_Worker_Costing_Allocations_Response
Wrapper for the data returned by the Get Worker Costing Allocations service.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Costing_Allocations_Data  Worker_Costing_Allocations_Data  [0..*]  Primary (Worker or Position Restrictions) and Secondary (Position and Earning) keys identifying the level of the costing allocation data.   
top
 

Worker_Costing_Allocations_Data

part of: Worker_Costing_Allocations_Response_Data
Primary (Worker or Position Restrictions) and Secondary (Position and Earning) keys identifying the level of the costing allocation data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference [Choice]   WorkerObject  [1..1]  Primary (Worker or Position Restrictions) key identifying the level of the costing allocation data.   
Position_Restrictions_Reference [Choice]   Position_RestrictionsObject  [1..1]  Primary (Worker or Position Restrictions) key identifying the level of the costing allocation data.   
Position_Reference  Position_ElementObject  [0..1]  Secondary (Position and Earning) key identifying the level of the costing allocation data.   
Earning_Reference  Earning__All_Object  [0..1]  Secondary (Position and Earning) key identifying the level of the costing allocation data.   
Worker_Costing_Allocation_Interval_Data  Worker_Costing_Allocation_Interval_Data  [0..*]  Costing Allocation Data effective over a specified date range.   
top
 

Position_ElementObject

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

Position_ElementObjectID

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

Earning__All_Object

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

Earning__All_ObjectID

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

Worker_Costing_Allocation_Interval_Data

part of: Worker_Costing_Allocations_Data
Costing Allocation Data effective over a specified date range.
 
Parameter name Type/Value Cardinality Description Validations
Costing_Override_ID  string  [0..1]  A unique identifier for the Costing Allocation Interval within the Workday system.   
Start_Date  date  [0..1]  Start date for the allocation.   
End_Date  date  [0..1]  End date for the allocation.   
Worker_Costing_Allocation_Detail_Data  Worker_Costing_Allocation_Detail_Data  [0..*]  Details of the allocation, (e.g., a set of allocation dimensions and percentages)   
top
 

Worker_Costing_Allocation_Detail_Data

part of: Worker_Costing_Allocation_Interval_Data
Details of the allocation, (e.g., a set of allocation dimensions and percentages)
 
Parameter name Type/Value Cardinality Description Validations
Order  string  [0..1]  Orders the allocation detail (e.g., 'a', 'b', 'c', ...). Note that during general ledger costing, any rounding issues resulting from the distributions are reconciled in the last allocation detail.   
Default_from_Organization_Assignment  boolean  [0..1]  Flag indicating that the corresponding percentage should be allocated using the worker's (or position's) default organizational assignments with no overrides. Note that the system will detect if this Request represents a sub-event imbedded within a higher-level business process, and if so search for a possible Assign Organization sub-event which contains proposed assignments.   
Costing_Override_Company_Reference  CompanyObject  [0..1]  Overriding Company for an Allocation Detail, used for Intercompany Accounting   
Costing_Override_Worktag_Reference  Tenanted_Payroll_WorktagObject  [0..*]  The costing dimension value(s) to use for the override (e.g., cost center reference, fund reference, etc.).   
Distribution_Percent  decimal (9, 6) >0   [0..1]  The percentage, represented as a decimal value (e.g., .5), for the given allocation detail   
Salary_Over_the_Cap_Costing_Allocation_Detail_Data  Salary_Over_the_Cap_Costing_Allocation_Detail_Data  [0..*]  Details of the Salary over the Cap allocation, (e.g., a set of allocation dimensions and percentages) 
Validation Description
A Grant may not exist in the override worktags entered for the Salary Over the Cap sub-allocation.  A Grant may not exist in the override worktags entered for the Salary Over the Cap sub-allocation. 
Each distribution worktag for a Salary Over the Cap Allocation Detail must belong to a unique costing dimension - the set of worktags assigned for this Salary Over the Cap Allocation Detail includes a costing dimension more than once.  Each distribution worktag for a Salary Over the Cap Allocation Detail must belong to a unique costing dimension - the set of worktags assigned for this Salary Over the Cap Allocation Detail includes a costing dimension more than once. 
Each Salary Over the Cap Allocation Detail within an Allocation Detail must have its own unique ordering.  Each Salary Over the Cap Allocation Detail within an Allocation Detail must have its own unique ordering. 
The override worktags entered for the Salary Over the Cap sub-allocation do not satisfy the set of required allocation dimensions that have been established in the Maintain Worktag Usage task.  The override worktags entered for the Salary Over the Cap sub-allocation do not satisfy the set of required allocation dimensions that have been established in the Maintain Worktag Usage task. 
Company override may only be entered if Intercompany Accounting is enabled in the Edit Tenant Setup - Payroll.   
Each Salary Over the Cap sub-allocation within an Allocation Detail should use a unique combination of distribution worktags - the set of worktags assigned for this Salary Over the Cap sub-allocation matches that used by another Salary Over the Cap sub-allocation.   
You must select only Default from Organization Assignment, or any combination of Costing Override References in the Salary Over the Cap suballocation detail.   
You must select either Default from Organization Assignment[C2C] in the Salary Over the Cap suballocation detail.   
You must select either Default from Organization Assignment[error_msg] in the Salary Over the Cap suballocation detail.   
 
top
 

CompanyObject

part of: Worker_Costing_Allocation_Detail_Data, Salary_Over_the_Cap_Costing_Allocation_Detail_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
 

Tenanted_Payroll_WorktagObject

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

Tenanted_Payroll_WorktagObjectID

part of: Tenanted_Payroll_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Employee_ID, FLSA_Workweek_Calendar_Event_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Holiday_Calendar_Event_ID, Job_Profile_ID, Location_ID, Object_Class_ID, Organization_Reference_ID, Payroll_ID, Position_ID, Program_ID, Project_ID, Project_Plan_ID, Region_Reference_ID, Run_Category_ID, Withholding_Order_Case_ID, Workers_Compensation_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, FLSA_Workweek_Calendar_ID, Holiday_Calendar_ID  [1..1]  The unique identifier type of a parent object   
top
 

Salary_Over_the_Cap_Costing_Allocation_Detail_Data

part of: Worker_Costing_Allocation_Detail_Data
Details of the Salary over the Cap allocation, (e.g., a set of allocation dimensions and percentages)
 
Parameter name Type/Value Cardinality Description Validations
SOC_Order  string  [1..1]  Orders the allocation detail (e.g., 'a', 'b', 'c', ...). Note that during general ledger costing, any rounding issues resulting from the distributions are reconciled in the last allocation detail.   
SOC_Default_from_Organization_Assignment  boolean  [0..1]  Select Yes (Y) to indicate that the corresponding percentage should be allocated using the worker's (or position's) default organizational assignments with no overrides. Workday detects if this Request represents a sub-event embedded within a higher-level business process, and if so searches for a possible Assign Organization sub-event which contains proposed assignments.   
SOC_Costing_Override_Company_Reference  CompanyObject  [0..1]  Overriding Company for an Allocation Detail, used for Intercompany Accounting 
Validation Description
Enter a valid Company and Cost Center combination in the Salary Over the Cap suballocation detail.   
Enter a valid intercompany combination in the Salary Over the Cap suballocation detail.   
Review the Salary Over the Cap sub-allocation and enter a company that matches on the award line in effect for grant: [grant]. This company doesn't match the grant on the award line: [company].   
 
SOC_Override_Worktag_Reference  Tenanted_Payroll_WorktagObject  [0..*]  The costing dimension value(s) to use for the override (e.g., cost center reference, fund reference, etc.).   
SOC_Distribution_Percent  decimal (9, 6) >0   [1..1]  The percentage for the given allocation detail, represented as a decimal value (e.g., .5).   
Validation Description
A Grant may not exist in the override worktags entered for the Salary Over the Cap sub-allocation.  A Grant may not exist in the override worktags entered for the Salary Over the Cap sub-allocation. 
Each distribution worktag for a Salary Over the Cap Allocation Detail must belong to a unique costing dimension - the set of worktags assigned for this Salary Over the Cap Allocation Detail includes a costing dimension more than once.  Each distribution worktag for a Salary Over the Cap Allocation Detail must belong to a unique costing dimension - the set of worktags assigned for this Salary Over the Cap Allocation Detail includes a costing dimension more than once. 
Each Salary Over the Cap Allocation Detail within an Allocation Detail must have its own unique ordering.  Each Salary Over the Cap Allocation Detail within an Allocation Detail must have its own unique ordering. 
The override worktags entered for the Salary Over the Cap sub-allocation do not satisfy the set of required allocation dimensions that have been established in the Maintain Worktag Usage task.  The override worktags entered for the Salary Over the Cap sub-allocation do not satisfy the set of required allocation dimensions that have been established in the Maintain Worktag Usage task. 
Company override may only be entered if Intercompany Accounting is enabled in the Edit Tenant Setup - Payroll.   
Each Salary Over the Cap sub-allocation within an Allocation Detail should use a unique combination of distribution worktags - the set of worktags assigned for this Salary Over the Cap sub-allocation matches that used by another Salary Over the Cap sub-allocation.   
You must select only Default from Organization Assignment, or any combination of Costing Override References in the Salary Over the Cap suballocation detail.   
You must select either Default from Organization Assignment[C2C] in the Salary Over the Cap suballocation detail.   
You must select either Default from Organization Assignment[error_msg] in the Salary Over the Cap suballocation detail.   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_RestrictionsReferenceEnumeration

part of: Position_RestrictionsObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Earning__All_ReferenceEnumeration

part of: Earning__All_ObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Tenanted_Payroll_WorktagReferenceEnumeration

part of: Tenanted_Payroll_WorktagObjectID
Base Type
string
top
 

Base Type
string

top