Service Directory > v25.1 > Staffing > Maintain_Employee_Contracts
 

Operation: Maintain_Employee_Contracts

Adds or updates employee contracts. Uses the Maintain Employee Contracts 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: Maintain_Employee_Contracts_Request

Add or update employee contracts.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..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.   
Maintain_Employee_Contracts_Data  Maintain_Employee_Contracts_Data  [1..1]  Contains employee contracts for an employee.   
top
 

Response Element: Maintain_Employee_Contracts_Response

Responds with the Employee Contract that was added or updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Employee_Contract_Event_Reference  Unique_IdentifierObject  [0..1]  Event ID of the Employee Contract Event.   
Employee_Contract_Reference  Employee_ContractObject  [0..*]  Employee Contract that was added or modified.   
top
 

Business_Process_Parameters

part of: Maintain_Employee_Contracts_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.
 
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
 

Maintain_Employee_Contracts_Data

part of: Maintain_Employee_Contracts_Request
Contains employee contracts for an employee.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  The employee covered by the employee contracts.   
Employee_Contract_Data  Employee_Contract_Data  [1..*]  Contains data for an Employee Contract.   
top
 

EmployeeObject

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

Employee_Contract_Data

part of: Maintain_Employee_Contracts_Data
Contains data for an Employee Contract.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Contract_Reference  Employee_ContractObject  [0..1]  Employee Contract which is being edited. An employee contract may have many versions. The employee contract reference is common for each version. 1. Update existing contract if Employee Contract Reference is specified. 2. Add new contract if Employee Contract Reference is not specified. 
Validation Description
Employee Contract does not belong to the specified Employee.   
Employee Contract is not for the same position as the parent event's position.   
 
Employee_Contract_Reason_Reference  Employee_Contract_ReasonObject  [0..*]  The reference(s) to the Employee Contract Reason(s) for this Employee Contract.   
Employee_Contract_ID  string  [0..1]  Unique identifier for a an employee contract. 1. If Employee Contract Reference is specified, the existing employee contract will be updated with this Employee Contract ID. If the Employee Contract ID is not specified, the employee contract will retain its existing Employee Contract ID. 2. If Employee Contract Reference is not specified, a new employee contract will be created with this Employee Contract ID. If the Employee Contract ID is not specified, the system will automatically generate a unique identifier. 
Validation Description
Employee Contract ID is already in use.   
 
Contract_Version_Date  dateTime  [0..1]  The date the contract version is created. This is always set to the date and time of the last update. Any value sent in the request will be ignored.   
Contract_ID  string  [0..1]  This is a user-provided identifier and need not be unique. For the same contract it may change over time.   
Contract_Type_Reference  Employee_Contract_TypeObject  [0..1]  The type of contract, based on the contract types defined within your organization. 
Validation Description
Contract type is not valid.   
 
Contract_Start_Date  date  [1..1]  This is the start date in the contract itself. May not be earlier than Hire Date of the primary job or the start date of the Additional Job the contract is attached to. 
Validation Description
Employee contract date range overlaps with another employee contract for this position.   
Employee contract start date cannot be before the start date of the position. Contract Start Date: [contract] Position Date: [start]   
Contract Start Date cannot be after the end date of the position: Contract Start Date: [date1] Position End Date: [date2]   
 
Contract_End_Date  date  [0..1]  This is the end date (if any) in the contract itself. Before opening a new contract for an employee (for example, when transferring or changing jobs) you should end the old contract with an end date one day prior to the Change Job date. 
Validation Description
Contract End Date may not be earlier than Contract Start Date.   
Contract End Date cannot be after this position's end date: [date]   
Contract End Date cannot be after the proposed termination date: [date]   
 
Employee_Contract_Collective_Agreement_Reference  Collective_AgreementObject  [0..*]  The reference(s) to the Collective Agreement(s) for this Employee Contract. 
Validation Description
Only 1 Collective Agreement is allowed.   
 
Maximum_Weekly_Hours  decimal (12, 0) >0   [0..1]  The Maximum Weekly Hours entered for this Employee Contract. 
Validation Description
Maximum Weekly Hours is not valid for this Location.   
 
Minimum_Weekly_Hours  decimal (12, 0) >0   [0..1]  The Minimum Weekly Hours entered for this Employee Contract. 
Validation Description
Minimum Weekly Hours is not valid for this Location.   
 
Contract_Status_Reference  Employee_Contract_StatusObject  [1..1]  The status of the contract, based on the status types defined within your organization. The status values will be those defined for the location of the employee's primary position. 
Validation Description
Employee contract status is not valid.   
 
Position_Reference  Position_ElementObject  [0..1]  The position to which this contract is related. 
Validation Description
Position is not valid for the worker. Position: [position] Worker: [worker]   
Position Reference is required.   
 
Contract_Description  string  [0..1]  Use this field for any notes or details that pertain to this contract or contract version   
Date_Employee_Signed  date  [0..1]  The date the employee signed the contract. Must be within 1 month of the Contract Start Date and not later than the Contract End Date. 
Validation Description
Date Employee Signed cannot be later than the Contract End Date   
Date Employee Signed should be within the year before or month after the Contract Start Date.   
 
Date_Employer_Signed  date  [0..1]  The date the employer signed the contract. Must be within 1 month of the Contract Start Date and not later than the Contract End Date. 
Validation Description
Date Employer Signed should be within a month of the Contract Start Date   
Date Employer Signed cannot be later than the Contract End Date   
 
Worker_Document_Reference  Worker_DocumentObject  [0..*]  You may attach scanned contract images, addendums, or other file attachments.   
top
 

Employee_ContractObject

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

Employee_ContractObjectID

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

Employee_Contract_ReasonObject

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

Employee_Contract_ReasonObjectID

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

Employee_Contract_TypeObject

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

Employee_Contract_TypeObjectID

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

Collective_AgreementObject

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

Collective_AgreementObjectID

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

Employee_Contract_StatusObject

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

Employee_Contract_StatusObjectID

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

Worker_DocumentObject

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

Worker_DocumentObjectID

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

Unique_IdentifierObject

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

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
 

Employee_ContractReferenceEnumeration

part of: Employee_ContractObjectID
Base Type
string
top
 

Employee_Contract_ReasonReferenceEnumeration

part of: Employee_Contract_ReasonObjectID
Base Type
string
top
 

Employee_Contract_TypeReferenceEnumeration

part of: Employee_Contract_TypeObjectID
Base Type
string
top
 

Collective_AgreementReferenceEnumeration

part of: Collective_AgreementObjectID
Base Type
string
top
 

Employee_Contract_StatusReferenceEnumeration

part of: Employee_Contract_StatusObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Worker_DocumentReferenceEnumeration

part of: Worker_DocumentObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top