Service Directory > v31.2 > Revenue_Management > Put_Customer_Contract_Discount_and_Premium
 

Operation: Put_Customer_Contract_Discount_and_Premium

This service operation will add or update Contract Discounts and Premiums. These are used to adjust values on Contract Lines.


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

Put Customer Contract Discount and Premium Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
@Delete  boolean  [1..1]  Delete 
Validation Description
A Contract Discount and Premium must be supplied if Delete is set to true.   
You can't delete a discount or premium that's in use.   
 
Contract_Discount_and_Premium_Reference  Contract_Discount_PremiumObject  [0..1]  Reference to an existing Contract Discount and Premium for update only purposes.   
Contract_Discount_and_Premium_Data  Contract_Discount_and_Premium_Data  [0..1]  Customer Contract Discounts and Premiums Data 
Validation Description
Start Date must be before End Date.  Start Date must be before End Date. 
 
Validation Description
The Web Service is set to Add Only; but the Contract Discount and Premium already exists.   
If the Contract Discount and Premium is not being deleted, then there must be a Contract Discount and Premium Data element entered.   
top
 

Response Element: Put_Customer_Contract_Discount_and_Premium_Response

Put Customer Contract Discount and Premium Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Contract_Discount_and_Premium_Reference [Choice]   Contract_Discount_PremiumObject  [0..1]  Contract Discount and Premium Reference   
Delete_Confirmation [Choice]   string  [0..1]  Contract Discount and Premium Delete Confirmation   
top
 

Contract_Discount_PremiumObject

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

Contract_Discount_PremiumObjectID

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

Contract_Discount_and_Premium_Data

part of: Put_Customer_Contract_Discount_and_Premium_Request
Contract Discount and Premium Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Contract Discount and Premium ID   
Contract_Discount_and_Premium_Type  string  [1..1]  Contract Discount and Premium Type 
Validation Description
The Customer Discount and Premium Name entered has already been used. Please enter another.   
You can't update the name of a discount and premium that's in use.   
 
Contract_Discount_and_Premium_Percentage  decimal (9, 6)   [1..1]  Contract Discount and Premium Percentage 
Validation Description
Your discount percentage can't be more than 100.   
You can't change the percentage if a discount or premium is in use.   
 
Contract_Discount_and_Premium_Start_Date  date  [0..1]  Contract Discount and Premium Start Date   
Contract_Discount_and_Premium_End_Date  date  [0..1]  Contract Discount and Premium End Date   
in_Use  boolean  [0..1]  In Use   
is_Inactive  boolean  [0..1]  Is Inactive   
Contract_Discount_and_Premium_Notes  string  [0..1]  Discount/Premium Notes   
Validation Description
Start Date must be before End Date.  Start Date must be before End Date. 
top
 

Contract_Discount_PremiumReferenceEnumeration

part of: Contract_Discount_PremiumObjectID
Base Type
string
top