Service Directory > v31.2 > Financial_Management > Get_Receivables_Overpayment_Reasons
 

Operation: Get_Receivables_Overpayment_Reasons

This service operation will get Receivables Overpayment Reasons for the specified criteria.


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

Contains request reference, criteria, filter, and response group for getting Receivables Overpayment Reasons data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Receivables_Overpayment_Reason_Request_References  [0..1]  Get Receivable Overpayment Reason Request References   
Request_Criteria [Choice]   Receivables_Overpayment_Reason_Request_Criteria  [0..1]  Element containing Get Receivable Overpayment Reason Request Criteria.   
Response_Filter  Response_Filter  [0..1]  Get Receivable Overpayment Reason Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Receivables_Overpayment_Reasons_Response

Element containing Receivable Overpayment Reasons Response elements including received criteria, references, data based on criteria and grouping, results filter, and result summary.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Receivables_Overpayment_Reason_Request_References  [0..1]  Element containing reference instances for a Receivables Overpayment Reason.   
Request_Criteria  Receivables_Overpayment_Reason_Request_Criteria  [0..1]  Element containing Receivable Overpayment Reasons 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_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  Receivables_Overpayment_Reason_Response_Data  [0..1]  Wrapper Element that includes Receivable Overpayment Reasons instance and data.   
top
 

Receivables_Overpayment_Reason_Request_References

part of: Get_Receivables_Overpayment_Reasons_Request, Get_Receivables_Overpayment_Reasons_Response
Element containing reference instances for a Receivables Overpayment Reason.
 
Parameter name Type/Value Cardinality Description Validations
Receivables_Overpayment_Reason_Reference  Receivables_Overpayment_ReasonObject  [1..*]  Instance set containing the Receivable Overpayment Reason object.   
top
 

Receivables_Overpayment_ReasonObject

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

Receivables_Overpayment_ReasonObjectID

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

Receivables_Overpayment_Reason_Request_Criteria

part of: Get_Receivables_Overpayment_Reasons_Request, Get_Receivables_Overpayment_Reasons_Response
Element containing Receivable Overpayment Reasons request criteria.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Receivables_Overpayment_Reasons_Request, Get_Receivables_Overpayment_Reasons_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
 

Response_Results

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

Receivables_Overpayment_Reason_Response_Data

part of: Get_Receivables_Overpayment_Reasons_Response
Wrapper Element that includes Receivable Overpayment Reasons instance and data.
 
Parameter name Type/Value Cardinality Description Validations
Receivables_Overpayment_Reason  Receivables_Overpayment_Reason  [0..*]  Wrapper Element that includes Receivable Overpayment Reason instance and data.   
Overpayment_Reason_Name  string  [0..1]  Overpayment Reason Name   
top
 

Receivables_Overpayment_Reason

part of: Receivables_Overpayment_Reason_Response_Data
Wrapper Element that includes Receivable Overpayment Reason instance and data.
 
Parameter name Type/Value Cardinality Description Validations
Receivables_Overpayment_Reason_Reference  Receivables_Overpayment_ReasonObject  [0..1]  Workset for Receivables Overpayment Reason.   
Receivables_Overpayment_Reason_Data  Receivables_Overpayment_Reason_WWS_Data  [0..*]  Element containing data for the Receivable Overpayment Reason.   
top
 

Receivables_Overpayment_Reason_WWS_Data

part of: Receivables_Overpayment_Reason
Element containing data for the Receivable Overpayment Reason.
 
Parameter name Type/Value Cardinality Description Validations
Receivables_Overpayment_Reason_Name  string  [1..1]  Free form text field that provides the name of the Receivable Overpayment Reason.   
Inactive  boolean  [0..1]  Inactive status of the Receivable Overpayment Reason.   
ID  string  [0..1]  Receivable Overpayment Reason Reference ID. This is a unique identifier for the Receivable Overpayment Reason.   
top
 

Receivables_Overpayment_ReasonReferenceEnumeration

part of: Receivables_Overpayment_ReasonObjectID
Base Type
string
top