Service Directory > v31.2 > Revenue_Management > Put_Salary_Cap
 

Operation: Put_Salary_Cap

This service operation will add or update Award Salary Cap. Award Salary Cap Data includes Award Salary Cap Reference ID, Award Limit Name, Award Limit Snapshot Data.


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

Put Salary Cap Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Salary_Cap_Reference  Payroll_LimitObject  [0..1]  Award Salary Cap Reference   
Salary_Cap_Data  Payroll_Limit_Data  [1..1]  Award Salary Cap Data   
Validation Description
The Web Service is set to Add Only, but the Payroll Limit already exists  The Web Service is set to Add Only, but the Payroll Limit already exists 
top
 

Response Element: Put_Salary_Cap_Response

Element containing Put Salary Cap Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Salary_Cap_Reference  Payroll_LimitObject  [0..1]  Award Salary Cap Reference   
top
 

Payroll_LimitObject

part of: Payroll_Limit_Data, Put_Salary_Cap_Request, Put_Salary_Cap_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  Payroll_LimitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_LimitObjectID

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

Payroll_Limit_Data

part of: Put_Salary_Cap_Request
Element containing Award Salary Cap Data
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap_Reference  Payroll_LimitObject  [0..1]  Payroll Limit Reference   
Salary_Cap_ID  string  [0..1]  Award Salary Cap Reference ID   
Salary_Cap_Name  string  [1..1]  Award Limit Name 
Validation Description
Enter a Salary Cap Name that isn't already in use.   
 
Salary_Cap_Description  string  [0..1]  Award Limit Description   
Salary_Over_The_Cap_Type_Reference  Salary_Over_The_Cap_TypeObject  [1..1]  Salary Over The Cap Type Reference   
Pay_Component_Group_for_Salary_Cap_Reference  Pay_Component_Group__All_Object  [1..1]  Pay Component Group for Payroll Limit Reference   
Inactive  boolean  [0..1]  Inactive   
Salary_Cap_Interval_Data  Payroll_Limit_Snapshot_Data  [0..*]  Award Limit Snapshot Data 
Validation Description
The Salary Cap Interval Date From is later than Date To. Enter a Date From that is before Date To.   
Enter a Salary Cap Interval period that does not overlap another, existing Salary Cap Interval period.   
The Date To value on the Salary Cap Interval is missing. Only the last Salary Cap Interval can have a blank Date To value.   
Validation Description
You can't change interval dates of a Salary Cap that is In use.   
You can't change the Salary Cap Amount of a Salary Cap that is In use.   
 
top
 

Salary_Over_The_Cap_TypeObject

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

Salary_Over_The_Cap_TypeObjectID

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

Pay_Component_Group__All_Object

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

Pay_Component_Group__All_ObjectID

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

Payroll_Limit_Snapshot_Data

part of: Payroll_Limit_Data
Element containing Salary Cap Snapshot Data
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap_Interval_Reference  Payroll_Limit_SnapshotObject  [0..1]  Payroll Limit Snapshot Reference   
Salary_Cap_Interval_ID  string  [0..1]  Payroll Limit Snapshot Reference ID   
Date_From  date  [1..1]  Date From   
Date_To  date  [0..1]  Date To   
Salary_Cap_Amount  decimal (10, 2) >0   [1..1]  Award Limit Amount   
Validation Description
You can't change interval dates of a Salary Cap that is In use.   
You can't change the Salary Cap Amount of a Salary Cap that is In use.   
top
 

Payroll_Limit_SnapshotObject

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

Payroll_Limit_SnapshotObjectID

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

Payroll_LimitReferenceEnumeration

part of: Payroll_LimitObjectID
Base Type
string
top
 

Salary_Over_The_Cap_TypeReferenceEnumeration

part of: Salary_Over_The_Cap_TypeObjectID
Base Type
string
top
 

Pay_Component_Group__All_ReferenceEnumeration

part of: Pay_Component_Group__All_ObjectID
Base Type
string
top
 

Payroll_Limit_SnapshotReferenceEnumeration

part of: Payroll_Limit_SnapshotObjectID
Base Type
string
top