Service Directory > v31.2 > Settlement_Services > Put_Payment_Type
 

Operation: Put_Payment_Type

This service operation will add or update Payment Type. Data includes ID, Payment Type Name, and Payment Method.


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

Element containing Payment Type reference for update and Payment Type 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 Type object.   
Payment_Type_Reference  Payment_TypeObject  [0..1]  Payment Type Reference   
Payment_Type_Data  Payment_Type_Data  [1..1]  Payment Type Data   
Validation Description
The Web Service is set to Add Only; but the Payment Type already exists.   
top
 

Response Element: Put_Payment_Type_Response

Element containing Payment Type Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payment_Type_Reference  Payment_TypeObject  [0..1]  This is the reference id value of the Payment Type object   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Element containing Exceptions Data   
top
 

Payment_TypeObject

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

Payment_TypeObjectID

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

part of: Put_Payment_Type_Request
Payment Type Data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Type_ID  string  [0..1]  The unique identifier for the Payment Type   
Payment_Type_Name  string  [1..1]  Payment Type Name 
Validation Description
The Payment Type Name entered has already been used.  The Payment Type Name entered has already been used. 
 
Payment_Method_Reference  Payment_MethodObject  [1..1]  Payment Method associated with the Payment Type   
top
 

Payment_MethodObject

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

Payment_MethodObjectID

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

Application_Instance_Related_Exceptions_Data

part of: Put_Payment_Type_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Payment_MethodReferenceEnumeration

part of: Payment_MethodObjectID
Base Type
string
top