Service Directory > v32.1 > Financial_Management > Put_Payment_Term
 

Operation: Put_Payment_Term

This service operation will add or update a Payment Term. Data includes Payment Terms ID, Payment Terms Name, Due Days, Payment Discount Days, Payment Discount Percent, and Grace Days.


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

Element containing Payment Term reference for add or update and Payment Term data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only. If true, will not allow update of an already existing Payment Term object.   
Payment_Term_Reference  Payment_TermsObject  [0..1]  Payment Term Reference   
Payment_Term_Data  Payment_Terms_Data  [1..1]  Payment Terms Data   
Validation Description
The Web Service is set to Add Only; but the Payment Term already exists.   
top
 

Response Element: Put_Payment_Term_Response

Element containing Payment Term Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payment_Term_Reference  Payment_TermsObject  [0..1]  This is the reference id value of the Payment Term object   
top
 

Payment_TermsObject

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

Payment_TermsObjectID

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

Payment_Terms_Data

part of: Put_Payment_Term_Request
Payment Terms Data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Terms_ID  string  [0..1]  The unique identifier for the Payment Terms   
Payment_Terms_Name  string  [1..1]  Payment Terms Name 
Validation Description
Enter a unique Payment Terms Name. [name] is already in use.  The Payment Terms Name is already in use. 
 
Payment_Term_Rules_Data  Payment_Term_Rule_Data  [1..*]  The Element for the Payment Term Rule Data used in the Put/Get WWS 
Validation Description
You can't apply a cut off to Add Months as it's a required Rule Type when you select Day of Month.  You can't apply a cut off to Add Months as it's a required Rule Type when you select Day of Month. 
Select Apply Cutoff for at least 1 Due Date Rule Type when you've entered a number for Cut-Off Day.  Select Apply Cutoff for at least 1 Due Date Rule Type when you've entered a number for Cut-Off Day. 
You must have at least 1 Due Date Rule Type without Apply Cut Off.  You must have at least 1 Due Date Rule Type without Apply Cut Off. 
 
Cut-Off_Day  decimal (2, 0) >0   [0..1]  Day of the month to apply the cut-off. 
Validation Description
Enter a number that isn't greater than 30 for Cut-Off Day.   
 
Payment_Discount_Days  decimal (4, 0) >0   [0..1]  Payment Discount Days   
Payment_Discount_Percent  decimal (5, 2) >0   [0..1]  Payment Discount Percent   
Grace_Days  decimal (4, 0) >0   [0..1]  Grace Days   
top
 

Payment_Term_Rule_Data

part of: Payment_Terms_Data
The Element for the Payment Term Rule Data used in the Put/Get WWS
 
Parameter name Type/Value Cardinality Description Validations
Payment_Term_Rule_ID  string  [0..1]  The reference ID instance.   
Payment_Term_Rule_Reference  Payment_Terms_RuleObject  [0..*]  Payment Terms Rule instance   
Order  string (6)   [1..1]  The order in which the rule is to be processed.   
Payment_Rule_Type_Reference  Payment_Terms_Rule_TypeObject  [1..1]  The rule type. Can be 1 of the these: - Add Days - Add Month - Day of Month - End of Month 
Validation Description
You must use [rule_types_required] with [current_rule_type].   
You can't select [previous_rule_type] before [current_rule_type] on the Due Date Rule order.   
You can't select 2 consecutive [current_rule_type] rule types.   
 
Rule_Modifier_Value  decimal (4, 0) >0   [0..1]  The numeric value to select for a specific rule type. 
Validation Description
Enter a number other than zero for [current_rule_type].   
Enter a number from 1 through [rule_modifier_max_value] for [current_rule_type].   
 
Apply_Cut-Off_Condition  boolean  [0..1]  Apply the cut-off condition to the specific rule type. 
Validation Description
Clear Apply Cut-Off for the Day of Month Rule Type.  Clear Apply Cut-Off for the Day of Month Rule Type. 
Do not Apply Cut-Off without specifying a Cut-Off Day.  Do not Apply Cut-Off without specifying a Cut-Off Day. 
 
top
 

Payment_Terms_RuleObject

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

Payment_Terms_RuleObjectID

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

Payment_Terms_Rule_TypeObject

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

Payment_Terms_Rule_TypeObjectID

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

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

Payment_Terms_RuleReferenceEnumeration

part of: Payment_Terms_RuleObjectID
Base Type
string
top
 

Payment_Terms_Rule_TypeReferenceEnumeration

part of: Payment_Terms_Rule_TypeObjectID
Base Type
string
top