Service Directory > v31.2 > Settlement_Services > Get_Payment_Types
 

Operation: Get_Payment_Types

This service operation will get Payment Type data for the specified criteria. Data includes ID, Payment Type Name, and Payment Method. The request criteria can be for a specific Payment Type based on reference(s), Payment Type Name (partial match ok), and Payment Method criteria. If no criteria are specified, all Payment Types will be retrieved.


@ - 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: Get_Payment_Types_Request

Contains request reference, criteria, filter and response group for getting Payment Type data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payment_Type_Request_References  [0..1]  Payment Type Request References   
Request_Criteria [Choice]   Payment_Type_Request_Criteria  [0..1]  Payment Type Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payment_Type_Response_Group  [0..1]  Payment Type Response Group   
top
 

Response Element: Get_Payment_Types_Response

Element containing Payment Type response elements including received criteria, references, data based on criteria and grouping, and response filter
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payment_Type_Request_References  [0..1]  Payment Type Request References   
Request_Criteria  Payment_Type_Request_Criteria  [0..1]  Payment Type Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Payment_Type_Response_Group  [0..1]  Payment Type Response Group   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Payment_Type_Response_Data  [0..1]  Wrapper Element that includes Payment Type Reference(s) and Payment Type Data   
top
 

Payment_Type_Request_References

part of: Get_Payment_Types_Request, Get_Payment_Types_Response
Payment Type Request References
 
Parameter name Type/Value Cardinality Description Validations
Payment_Type_Reference  Payment_TypeObject  [1..*]  Payment Type Reference   
top
 

Payment_TypeObject

part of: Payment_Type_Request_References, Payment_Type
 
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_Request_Criteria

part of: Get_Payment_Types_Request, Get_Payment_Types_Response
Payment Type Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Payment_Type_Name  string  [0..1]  Search by Payment Type Name. Can be a match of a partial string.   
Payment_Method_Reference  Payment_MethodObject  [0..*]  Search by Payment Method   
top
 

Payment_MethodObject

part of: Payment_Type_Data, Payment_Type_Request_Criteria
 
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
 

Response_Filter

part of: Get_Payment_Types_Request, Get_Payment_Types_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Payment_Type_Response_Group

part of: Get_Payment_Types_Request, Get_Payment_Types_Response
Payment Type Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payment_Types_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Payment_Type_Response_Data

part of: Get_Payment_Types_Response
Wrapper Element that includes Payment Type Reference Instance and Payment Type Data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Type  Payment_Type  [0..*]  Contains data for a given Payment Type object   
top
 

Payment_Type

part of: Payment_Type_Response_Data
Element containing Payment Type reference and data
 
Parameter name Type/Value Cardinality Description Validations
Payment_Type_Reference  Payment_TypeObject  [0..1]  Payment Type Reference   
Payment_Type_Data  Payment_Type_Data  [0..1]  Payment Type Data   
top
 

Payment_Type_Data

part of: Payment_Type
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_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Payment_MethodReferenceEnumeration

part of: Payment_MethodObjectID
Base Type
string
top