Service Directory > v31.2 > Compensation > Manage_Period_Activity_Pay_Assignments
 

Operation: Manage_Period_Activity_Pay_Assignments

This operation allows the management of period activity based assignments for a given worker and a bounding date range or period via the Manage Period Activity Pay Assignments business process.


@ - 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: Manage_Period_Activity_Pay_Assignments_Request

This operation allows the management of period activity based assignments for a given worker and a bounding date range or period via the Manage Period Activity Pay Assignments business process.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [1..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Period_Activity_Pay_Assignments  Period_Activity_Pay_Assignments_Data  [1..1]  Contains Period Activity Assignment information for a given Worker and Period range in a format suitable for constructing a Manage Period Activity Pay operation request.   
top
 

Response Element: Manage_Period_Activity_Pay_Assignments_Response

Contains the detailed business process event information resulting from a successful Manage Period Activity Pay Assignments request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Period_Activity_Pay_Assigment_Event  Period_Activity_Assignment_Event_Data  [0..1]  Contains a reference to the Manage Period Activity Pay Assignments business process event and the assignment details.   
top
 

Business_Process_Parameters

part of: Manage_Period_Activity_Pay_Assignments_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Period_Activity_Pay_Assignments_Data

part of: Manage_Period_Activity_Pay_Assignments_Request
Contains Period Activity Assignment information for a given Worker and Period range in a format suitable for constructing a Manage Period Activity Pay operation request.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Effective Date of the individual assignment changes.   
Employee_Reference  EmployeeObject  [1..1]  Reference element representing a unique instance of Employee.   
Position_Reference  Position_ElementObject  [0..1]  Employee's current position. Used in multiple-job scenarios. 
Validation Description
The employee you have selected has more than one job. You must supply the job to which this operation applies.  The employee you have selected has more than one job. You must supply the job to which this operation applies. 
Position submitted is not filled as of the effective date.  Position submitted is not filled as of the effective date. 
The job is not valid for the employee.  The job is not valid for the employee. 
There is already a pending Period Activity Pay event for the position [position].  There is already a pending Period Activity Pay event in progress for the position. 
 
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Reference element to an Academic Period to provide the bounding start and end dates of existing Period Activity Pay Assignments   
Period_Activity_Rate_Matrix_Reference  Period_Activity_Rate_MatrixObject  [1..1]  Reference element to a Period Activity specific Rate Matrix used to determine rates and currency when none are provided in the individual pay assignment   
Reason_Reference  Event_Classification_SubcategoryObject  [1..1]  Period Activity specific reason referencing indicating the purpose of the assignments   
Period_Activity_Pay_Assignment  Period_Activity_Pay_Assignment_Data  [1..*]  Contains each individual assignment within the given period. An assignment can be new, change to an existing assignment, or marked for deletion if allowed. 
Validation Description
The assignment can not be deleted as at least one payment has been made against the assignment. The assignment can only be modified.   
The assignment requires a pay amount. Provide an amount or ensure a quantity and unit rate are available to determine the amount.   
There are 1 or more missing payroll periods for the payment dates entered.   
 
top
 

EmployeeObject

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

EmployeeObjectID

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

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

Academic_PeriodObject

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

Academic_PeriodObjectID

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

Period_Activity_Rate_MatrixObject

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

Period_Activity_Rate_MatrixObjectID

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

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_ID, Undo_Move_Subcategory_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
 

Period_Activity_Pay_Assignment_Data

part of: Period_Activity_Pay_Assignments_Data
Contains the individual assignment details of a new activity, changes to an existing activity, or an existing activity to be deleted.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  When the value is True, the given assignment will be removed if no payment activity has been made against the assignment.   
Period_Activity_Pay_Assignment_Reference  Period_Activity_AssignmentObject  [0..1]  Reference element to an existing individual period activity assignment. Must be provided when changing or deleting an assignment   
Period_Activity_Reference  Period_ActivityObject  [0..1]  Reference element to a Period Activity. Required when adding a new period activity assignment.   
Period_Activity_Task_or_Course_Section_Reference  Period_Activity_Task_InterfaceObject  [0..1]  Reference element of a Period Activity Task or Course Section. Use when adding a new period activity task or course section assignment 
Validation Description
The appointee must be assigned to teach this Course Section.   
 
Period_Activity_Start_Date  date  [0..1]  Start Date of the activity assignment. Must fall on or after the Period Range if provided. Defaults from the given Period Range if not provided.   
Period_Activity_End_Date  date  [0..1]  End Date of the activity assignment. Must fall on or before the Period Range if provided. Defaults from the given Period Range if not provided.   
Currency_Reference  CurrencyObject  [0..1]  Currency reference for any provided amounts. Defaults from the given Period Activity Rate Matrix if not provided.   
Assigned_Amount [Choice]   decimal (36, 6) >0   [0..1]  A total payment amount for the duration of the assignment in the reference currency. If not provided, the quantity and unit rate will be used to calculate this value. 
Validation Description
The Total Amount must be greater than or equal to the Amount Paid to Date.   
 
Assigned_Quantity [Choice]   decimal (16, 6) >0   [0..1]  A quantity representing the activity in the units of the activity or activity task. If not provided the assigned amount and unit rate will be used to calculate this value. 
Validation Description
The quantity is different than the required default task or eligibility based quantity. Remove the quantity to accept the default quantity.   
 
Assigned_Unit_Rate  decimal (26, 6) >0   [0..1]  A unit rate amount in the reference currency used to calculate the assigned amount or quantity if necessary. Defaults from the given Period Activity Rate Matrix if not provided.   
Payment_Start_Date  date  [0..1]  Start Date of the payment for the activity assignment. Defaults from the given Period Range if not provided. 
Validation Description
The Payment Start Date cannot be before the Activity Start Date. Please adjust the Payment Start Date to be on or after the Activity Start Date.  Ensures payment start date is valid when the position has as pay group and the assignment is not being deleted. 
Payment Start Date must be on or after period activity start date and on or before payment end date.   
The Payment Start Date or Payment End Date is provided however the Employee is not configured for payments. Please review the Employee pay configuration.   
If period activity assignment has an existing payment, the payment start date can not be modified - Period Activity Assignment: [assignment], Last Payment Date: [last pay date]   
 
Payment_End_Date  date  [0..1]  End Date of the payment for the activity assignment. Defaults from the given Period Range if not provided. 
Validation Description
Payment End Date must be on or after period activity start date and payment start date.   
The Payment Start Date or Payment End Date is provided however the Employee is not configured for payments. Please review the Employee pay configuration.   
The payment end date cannot be before the last payment made for this assignment - Period Activity Assignment: [assignment], Payment End Date: [end date], Last Payment Date: [last pay date]   
 
Do_Not_Pay  boolean  [0..1]  If the Do Not Pay boolean value is set, then the Payment Start and Payment End dates will be cleared and no payment schedule will be generated. This will result in no payments for this assignment. 
Validation Description
The Payment Start date and Payment End date cannot be set and the Do Not Pay flag set to true - Period Activity Assignment: [assignment]   
 
Comment  string (500)   [0..1]  An optional comment about the assignment   
Period_Activity_Pay_Costing  Period_Activity_Pay_Costing_Data  [0..1]  Container for costing allocations for Period Activity Pay assignment line   
Validation Description
The assignment can not be deleted as at least one payment has been made against the assignment. The assignment can only be modified.   
The assignment requires a pay amount. Provide an amount or ensure a quantity and unit rate are available to determine the amount.   
There are 1 or more missing payroll periods for the payment dates entered.   
top
 

Period_Activity_AssignmentObject

part of: Period_Activity_Pay_Assignment_Data, Period_Activity_Assignment_Version_Data, Period_Activity_Assignment_Deleted_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  Period_Activity_AssignmentObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Period_Activity_AssignmentObjectID

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

Period_ActivityObject

part of: Period_Activity_Pay_Assignment_Data, Period_Activity_Assignment_Version_Data, Period_Activity_Assignment_Deleted_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  Period_ActivityObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Period_ActivityObjectID

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

Period_Activity_Task_InterfaceObject

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

Period_Activity_Task_InterfaceObjectID

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

CurrencyObject

part of: Period_Activity_Pay_Assignment_Data, Period_Activity_Assignment_Version_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
 

Period_Activity_Pay_Costing_Data

part of: Period_Activity_Pay_Assignment_Data, Period_Activity_Assignment_Version_Data
Contains one or more costing allocation splits for the specific Period Activity Pay assignment line
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Detail_for_Period_Pay  Allocation_Detail_for_Period_Pay_Data  [1..*]  Costing allocation for Period Activity Pay assignment line. 
Validation Description
Sum of costing split percentages must be equal to 100.   
Validation Description
Each Allocation Detail within a Costing Allocation Interval date range should use a unique combination of distribution worktags - the set of worktags assigned for this Allocation Detail matches that used by another Allocation Detail.   
Each distribution worktag for an Allocation Detail must belong to a unique costing dimension - the set of worktags assigned for this Allocation Detail includes a costing dimension more than once.   
Each Costing Allocation Detail within a Costing Allocation Interval must have its own unique ordering  Each Costing Allocation Detail within a Costing Allocation Interval must have its own unique ordering 
 
top
 

Allocation_Detail_for_Period_Pay_Data

part of: Period_Activity_Pay_Costing_Data
Contains costing allocation for Period Activity Pay assignment line.
 
Parameter name Type/Value Cardinality Description Validations
Order  string  [0..1]  Order assign to costing allocation   
Costing_Worktag_Reference  Tenanted_Payroll_WorktagObject  [0..*]  Worktag to use for costing allocation 
Validation Description
The override worktags entered do not satisfy the set of required allocation dimensions that have been established in the Maintain Organization Types task.   
Invalid worktag types.   
Required worktag types are missing.   
Balancing Worktag is enabled. Include the Balancing Worktag Type: [balancing worktag]   
 
Distribution_Percent  decimal (9, 6) >0   [0..1]  Percentage of line amount to be distributed on the specified costing worktag   
Distribution_Amount  decimal (38, 12) >0   [0..1]  Amount to be distributed on the specified costing worktag   
Validation Description
Each Allocation Detail within a Costing Allocation Interval date range should use a unique combination of distribution worktags - the set of worktags assigned for this Allocation Detail matches that used by another Allocation Detail.   
Each distribution worktag for an Allocation Detail must belong to a unique costing dimension - the set of worktags assigned for this Allocation Detail includes a costing dimension more than once.   
Each Costing Allocation Detail within a Costing Allocation Interval must have its own unique ordering  Each Costing Allocation Detail within a Costing Allocation Interval must have its own unique ordering 
top
 

Tenanted_Payroll_WorktagObject

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

Period_Activity_Assignment_Event_Data

part of: Manage_Period_Activity_Pay_Assignments_Response
Contains a reference to the Manage Period Activity Pay Assignments business process event and the assignment details.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Assignment_Event_Reference  Unique_IdentifierObject  [0..1]  Reference to the Manage Period Activity Pay Assignments business process event.   
Effective_Date  date  [0..1]  Effective Date of the individual assignment changes.   
Employee__Reference  EmployeeObject  [0..1]  Reference element representing a unique instance of Employee.   
Position_Reference  PositionObject  [0..1]  Reference element representing a unique instance of Position.   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Reference element to an Academic Period to provide the bounding start and end dates of existing Period Activity Pay Assignments   
Period_Activity_Rate_Matrix_Reference  Period_Activity_Rate_MatrixObject  [0..1]  Reference element to a Period Activity specific Rate Matrix used to determine rates and currency when none are provided in the individual pay assignment   
Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Period Activity specific reason referencing indicating the purpose of the assignments   
Period_Activity_Pay_Assignment  Period_Activity_Assignment_Version_Data  [0..*]  Contains each individual assignment within the given period. An assignment can be new, change to an existing assignment, or marked for deletion if allowed.   
Period_Activity_Pay_Assignment_Removed  Period_Activity_Assignment_Deleted_Data  [0..*]  Contains assignments which have been removed from the employee. An assignment can only be removed if no pay activity has occurred.   
top
 

Unique_IdentifierObject

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

PositionObject

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

PositionObjectID

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

Period_Activity_Assignment_Version_Data

part of: Period_Activity_Assignment_Event_Data
Contains the individual assignment details of a new activity, changes to an existing activity, or an existing activity to be deleted.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Pay_Assignment_Reference  Period_Activity_AssignmentObject  [0..1]  Reference element to an existing individual period activity assignment. Must be provided when changing or deleting an assignment   
Period_Activity_Reference  Period_ActivityObject  [0..1]  Reference element to a Period Activity. Required when adding a new period activity assignment.   
Period_Activity_Task_Reference  Period_Activity_TaskObject  [0..1]  Reference element of a Period Activity Task. Use when adding a new period activity task assignment.   
Period_Activity_Start_Date  date  [0..1]  Start Date of the activity assignment. Must fall on or after the Period Range if provided. Defaults from the given Period Range if not provided.   
Period_Activity_End_Date  date  [0..1]  End Date of the activity assignment. Must fall on or before the Period Range if provided. Defaults from the given Period Range if not provided.   
Currency_Reference  CurrencyObject  [0..1]  Currency reference for any provided amounts. Defaults from the given Period Activity Rate Matrix if not provided.   
Assigned_Amount  decimal (36, 6) >0   [0..1]  A total payment amount for the duration of the assignment in the reference currency. If not provided, the quantity and unit rate will be used to calculate this value.   
Assigned_Quantity  decimal (16, 6) >0   [0..1]  A quantity representing the activity in the units of the activity or activity task. If not provided the assigned amount and unit rate will be used to calculate this value.   
Assigned_Unit_Rate  decimal (26, 6) >0   [0..1]  A unit rate amount in the reference currency used to calculate the assigned amount or quantity if necessary. Defaults from the given Period Activity Rate Matrix if not provided.   
Payment_Start_Date  date  [0..1]  Start Date of the payment for the activity assignment. Defaults from the given Period Range if not provided.   
Payment_End_Date  date  [0..1]  End Date of the payment for the activity assignment. Defaults from the given Period Range if not provided.   
Do_Not_Pay  boolean  [0..1]  If the Do Not Pay boolean value is set, then the Payment Start and Payment End dates will be cleared and no payment schedule will be generated. This will result in no payments for this assignment.   
Comment  string (500)   [0..1]  An optional comment about the assignment   
Period_Activity_Pay_Costing  Period_Activity_Pay_Costing_Data  [0..1]  Contains one or more costing allocation splits for the specific Period Activity Pay assignment line   
top
 

Period_Activity_TaskObject

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

Period_Activity_TaskObjectID

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

Period_Activity_Assignment_Deleted_Data

part of: Period_Activity_Assignment_Event_Data
Contains assignments which have been removed from the employee. An assignment can only be removed if no pay activity has occurred.
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Assignment_Reference  Period_Activity_AssignmentObject  [0..1]  Reference element to an existing individual period activity assignment. Must be provided when changing or deleting an assignment   
Period_Activity_Reference  Period_ActivityObject  [0..1]  Reference element to a Period Activity. Required when adding a new period activity assignment.   
Period_Activity_Task_Reference  Period_Activity_TaskObject  [0..1]  Reference element of a Period Activity Task. Use when adding a new period activity task assignment.   
Period_Activity_Start_Date  date  [0..1]  Start Date of the activity assignment. Must fall on or after the Period Range if provided. Defaults from the given Period Range if not provided.   
Period_Activity_End_Date  date  [0..1]  End Date of the activity assignment. Must fall on or before the Period Range if provided. Defaults from the given Period Range if not provided.   
Comment  string (500)   [0..1]  An optional comment about the assignment   
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Period_Activity_Rate_MatrixReferenceEnumeration

part of: Period_Activity_Rate_MatrixObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Period_Activity_AssignmentReferenceEnumeration

part of: Period_Activity_AssignmentObjectID
Base Type
string
top
 

Period_ActivityReferenceEnumeration

part of: Period_ActivityObjectID
Base Type
string
top
 

Period_Activity_Task_InterfaceReferenceEnumeration

part of: Period_Activity_Task_InterfaceObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Tenanted_Payroll_WorktagReferenceEnumeration

part of: Tenanted_Payroll_WorktagObjectID
Base Type
string
top
 

Base Type
string

top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

PositionReferenceEnumeration

part of: PositionObjectID
Base Type
string
top
 

Period_Activity_TaskReferenceEnumeration

part of: Period_Activity_TaskObjectID
Base Type
string
top