Service Directory > v31.2 > Compensation > Put_Period_Activity_Rate_Matrix
 

Operation: Put_Period_Activity_Rate_Matrix

This operation creates or updates a Period Activity Rate Matrix


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

Request to create or update a Period Activity Rate Matrix
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Period Activity Rate Matrix will only be created and cannot already exist   
Period_Activity_Rate_Matrix_Reference  Period_Activity_Rate_MatrixObject  [0..1]  Period Activity Rate Matrix Reference   
Period_Activity_Rate_Matrix_Data  Period_Activity_Rate_Matrix_Data  [1..1]  Period Activity Rate Matrix data   
Validation Description
Period Activity Rate Matrix already exists.   
top
 

Response Element: Put_Period_Activity_Rate_Matrix_Response

Put Period Activity Rate Matrix response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Period_Activity_Rate_Matrix_Reference  Period_Activity_Rate_MatrixObject  [0..1]  New Period Activity Rate Matrix   
top
 

Period_Activity_Rate_MatrixObject

part of: Put_Period_Activity_Rate_Matrix_Request, Put_Period_Activity_Rate_Matrix_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  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
 

Period_Activity_Rate_Matrix_Data

part of: Put_Period_Activity_Rate_Matrix_Request
Period Activity Rate Matrix data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID   
Period_Activity_Rate_Table_Name  string  [1..1]  Name of the period activity rate matrix 
Validation Description
The Period Activity Rate Matrix Name is currently in use by another Period Activity Rate Matrix.  Period Activity Rate Matrix name must not already be in use. To update an existing matrix, you must provide a the reference or ID to the matrix. 
 
Effective_Date  date  [0..1]  Effective Date of the period activity rate matrix changes   
Condition_Rule_Reference  Condition_RuleObject  [0..*]  Associated condition rules   
Currency_Reference  CurrencyObject  [1..1]  Associated currency   
Inactive  boolean  [0..1]  Indicates whether the period activity rate matrix is inactive or not   
Period_Activity_Rate_Matrix_Entry_Data  Period_Activity_Rate_Matrix_Entry_Data  [1..*]  Period Activity Rate Matrix entry data for each row in the matrix   
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

part of: Period_Activity_Rate_Matrix_Data
Period Activity Rate Matrix entry data for each row in the matrix
 
Parameter name Type/Value Cardinality Description Validations
Period_Activity_Category_Reference  Period_Activity_CategoryObject  [1..1]  Period Activity Category reference   
Period_Activity_Unit_Reference  Period_Activity_UnitObject  [1..1]  Period Activity Unit reference 
Validation Description
The Period Activity Category and Period Activity Unit combination may only be used once for a Period Activity Rate Matrix.  Period Activity Category and Unit must only be used once in combination for a single Period Activity Rate Matrix. 
 
Period_Activity_Rate_Matrix_Entry_Sequence_Data  Period_Activity_Rate_Matrix_Entry_Sequence_Data  [1..1]  Period Activity Rate Matrix entry data for rate and accelerator   
top
 

Period_Activity_CategoryObject

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

Period_Activity_CategoryObjectID

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

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

Period_Activity_UnitObjectID

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

part of: Period_Activity_Rate_Matrix_Entry_Data
Period Activity Rate Matrix entry data for rate and accelerator
 
Parameter name Type/Value Cardinality Description Validations
Default_Unit_Rate  decimal (26, 6) >0   [0..1]  The default unit rate for rate matrix entry   
Accelerator_Amount [Choice]   decimal (26, 6) >0   [0..1]  The accelerator amoutn for rate matrix entry   
Accelerator_Percent [Choice]   decimal (12, 6) >0   [0..1]  The accelerator percent for rate matrix entry   
Accelerator_Base_Reference  Unique_IdentifierObject  [0..1]  Accelerator Base Reference   
top
 

Unique_IdentifierObject

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

Period_Activity_Rate_MatrixReferenceEnumeration

part of: Period_Activity_Rate_MatrixObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Period_Activity_CategoryReferenceEnumeration

part of: Period_Activity_CategoryObjectID
Base Type
string
top
 

Period_Activity_UnitReferenceEnumeration

part of: Period_Activity_UnitObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top