Service Directory > v32.1 > Benefits_Administration > Put_Benefit_Annual_Rate
 

Operation: Put_Benefit_Annual_Rate

This service operation creates a Benefit Annual Rate for one or more employees.


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

Wrapper element for the Put Benefit Annual Rate Request information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Benefit_Annual_Rate_Data  Benefit_Annual_Rate_Data  [1..1]  Contains the Benefit Annual Rate data.   
top
 

Response Element: Put_Benefit_Annual_Rate_Response

Wrapper element for the Put Benefit Annual Rate Response information.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Benefit_Annual_Rate_Reference  Unique_IdentifierObject  [0..1]  A unique identifier for a Benefit Annual Rate.   
top
 

Benefit_Annual_Rate_Data

part of: Put_Benefit_Annual_Rate_Request
Contains the Benefit Annual Rate data.
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  The effective date for the Benefit Annual Rate.   
Worker_Reference  WorkerObject  [1..1]  The Worker for the Benefit Annual Rate.   
Benefit_Annual_Rate  decimal (21, 6) >0   [0..1]  The amount value for the Benefit Annual Rate.   
Currency_Reference  CurrencyObject  [1..1]  The currency for the Benefit Annual Rate.   
Benefit_Annual_Rate_Type_Reference  Benefit_Annual_Rate_TypeObject  [0..1]  The type for the Benefit Annual Rate.   
top
 

WorkerObject

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

CurrencyObject

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

Benefit_Annual_Rate_TypeObject

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

Benefit_Annual_Rate_TypeObjectID

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

Unique_IdentifierObject

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

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Benefit_Annual_Rate_TypeReferenceEnumeration

part of: Benefit_Annual_Rate_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top