Service Directory > v32.1 > Student_Finance > Get_Student_Sponsor_Refunds
 

Operation: Get_Student_Sponsor_Refunds

Retrieve instances of student sponsor refunds. If you don't provide reference IDs, the web service returns all student sponsor refunds.


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

This is the top-level element for Student Sponsor Refund Get requests.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Sponsor_Refund_Request_References  [0..1]  This element contains the instance set of requested Student Sponsor Refunds.   
Request_Criteria [Choice]   Student_Sponsor_Refund_Request_Criteria  [0..1]  Element contains criteria to retrieve Student Sponsor Refunds.   
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. 
 
top
 

Response Element: Get_Student_Sponsor_Refunds_Response

This element is the top-level request element for all Student Sponsor Refund "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Sponsor_Refund_Request_References  [0..1]  This element contains the instance set of requested Student Sponsor Refunds.   
Request_Criteria  Student_Sponsor_Refund_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria needed to search for Student Sponsor Refunds.   
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  Student_Sponsor_Refund_Response_Data  [0..1]  Element content containing the Student Sponsor Refund Data element.   
top
 

Student_Sponsor_Refund_Request_References

part of: Get_Student_Sponsor_Refunds_Response, Get_Student_Sponsor_Refunds_Request
This element contains the instance set of requested Student Sponsor Refunds.
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Refund_Reference  Student_Sponsor_RefundObject  [1..*]  This element contains the instance set of requested Student Sponsor Refunds.   
top
 

Student_Sponsor_RefundObject

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

Student_Sponsor_RefundObjectID

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

Student_Sponsor_Refund_Request_Criteria

part of: Get_Student_Sponsor_Refunds_Response, Get_Student_Sponsor_Refunds_Request
Currently there are no criteria for Get Student Sponsor Refund Requests.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Sponsor_Refunds_Response, Get_Student_Sponsor_Refunds_Request
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_Student_Sponsor_Refunds_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
 

Student_Sponsor_Refund_Response_Data

part of: Get_Student_Sponsor_Refunds_Response
Container element for response from Get Student Sponsor Refunds request.
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Refund  Student_Sponsor_Refund  [0..*]  Element to contain retrieved instances of Student Sponsor Refund.   
top
 

Student_Sponsor_Refund

part of: Student_Sponsor_Refund_Response_Data
Element to contain retrieved instances of Student Sponsor Refund.
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Refund_Reference  Student_Sponsor_RefundObject  [0..1]  Retrieved Student Sponsor Refund instance.   
Student_Sponsor_Refund_Data  Student_Sponsor_Refund_Data  [0..*]  This element contains the data for a student sponsor refund 
Validation Description
This web service doesn't support these fields: Document Payment Status, Document Status, Refund Amount, Refund Date. Remove data from those fields before submitting student sponsor refunds.  These fields will all be set during processing of the Submit request. 
The institutional academic unit for each student sponsor payment to be refunded must match the institutional academic unit submitted in this web service.  The Institutional Academic Unit selected when recording Student Sponsor Payments must match the IAU selected in the Submit request. 
One or more of the selected student sponsor payments doesn't match the selected company and sponsor. Select a different student sponsor payment to refund or change the company and sponsor.  The Company, Institution, and Sponsor of the Payment being Refunded must match those of the Student Sponsor Refund to be created. 
You can't use this web service to edit existing refunds.   
Select at least one student sponsor payment to refund.  A Student Sponsor Refund must be for at least one Student Sponsor Payment. 
One or more of the selected student sponsor payments already has an associated student sponsor refund. Select a different student sponsor payment to refund.  A Student Sponsor Refund cannot be Submitted for Payments which already have Refunds in progress or completed. 
One or more of the selected student sponsor payments doesn't have a deposited on-account balance greater than zero. Select a different student sponsor payment to refund.  Only Payments with an on-account, approved deposited balance that isn't canceled or returnedare eligible for Refund. 
The payment type must have a payment method of check, cash, manual, wire, or EFT.  This validation ensures all Submitted Payment Types have a valid Payment Method. 
 
top
 

Student_Sponsor_Refund_Data

part of: Student_Sponsor_Refund
This element contains the data for a student sponsor refund
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Student Sponsor Refund   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  The Institutional Academic Unit of a Student Sponsor Refund   
Company_Reference  CompanyObject  [1..1]  The Company of a Student Sponsor Refund   
Sponsor_Reference  Billable_EntityObject  [1..1]  The Sponsor of a Student Sponsor Refund   
Refund_Memo  string  [0..1]  The Memo of a Student Sponsor Refund   
Payment_Type_Reference  Payment_TypeObject  [1..1]  The Payment Type of a Student Sponsor Refund   
Refund_Amount  decimal (26, 6) >0   [0..1]  The Amount of a Student Sponsor Refund   
Refund_Date  date  [0..1]  The Date of a Student Sponsor Refund   
Payment_Status_Reference  Document_Payment_StatusObject  [0..1]  The Payment Status of a Student Sponsor Refund   
Document_Status_Reference  Document_StatusObject  [0..1]  The Document Status of a Student Sponsor Refund   
Unapplied_Payments_Data  Student_Sponsor_Unapplied_Payment_Refund_Data  [0..*]  This element contains the Overpayments of a Student Sponsor Refund   
Student_Attachment_Data  Student_Attachment_Drag_and_Drop_Data  [0..*]  Wrapper element for Student Attachments   
Validation Description
This web service doesn't support these fields: Document Payment Status, Document Status, Refund Amount, Refund Date. Remove data from those fields before submitting student sponsor refunds.  These fields will all be set during processing of the Submit request. 
The institutional academic unit for each student sponsor payment to be refunded must match the institutional academic unit submitted in this web service.  The Institutional Academic Unit selected when recording Student Sponsor Payments must match the IAU selected in the Submit request. 
One or more of the selected student sponsor payments doesn't match the selected company and sponsor. Select a different student sponsor payment to refund or change the company and sponsor.  The Company, Institution, and Sponsor of the Payment being Refunded must match those of the Student Sponsor Refund to be created. 
You can't use this web service to edit existing refunds.   
Select at least one student sponsor payment to refund.  A Student Sponsor Refund must be for at least one Student Sponsor Payment. 
One or more of the selected student sponsor payments already has an associated student sponsor refund. Select a different student sponsor payment to refund.  A Student Sponsor Refund cannot be Submitted for Payments which already have Refunds in progress or completed. 
One or more of the selected student sponsor payments doesn't have a deposited on-account balance greater than zero. Select a different student sponsor payment to refund.  Only Payments with an on-account, approved deposited balance that isn't canceled or returnedare eligible for Refund. 
The payment type must have a payment method of check, cash, manual, wire, or EFT.  This validation ensures all Submitted Payment Types have a valid Payment Method. 
top
 

Academic_UnitObject

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

Academic_UnitObjectID

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

CompanyObject

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

CompanyObjectID

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

Billable_EntityObject

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

Billable_EntityObjectID

part of: Billable_EntityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Customer_ID, Customer_Reference_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Financial_Account_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_TypeObject

part of: Student_Sponsor_Refund_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_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
 

Document_Payment_StatusObject

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

Document_Payment_StatusObjectID

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

Document_StatusObject

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

Document_StatusObjectID

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

Student_Sponsor_Unapplied_Payment_Refund_Data

part of: Student_Sponsor_Refund_Data
This element contains an overpayment for refund
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Payment_Reference  Student_Sponsor_PaymentObject  [0..1]  A Payment to be refunded by a Student Sponsor Refund.   
top
 

Student_Sponsor_PaymentObject

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

Student_Sponsor_PaymentObjectID

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

Student_Attachment_Drag_and_Drop_Data

part of: Student_Sponsor_Refund_Data
Wrapper element for Student Attachments
 
Parameter name Type/Value Cardinality Description Validations
Student_Attachment_Reference  Student_AttachmentObject  [0..1]  The instance of the Student Attachment.   
Attachments  Attachment_WWS_Data  [0..*]  Attachment WWS Data element that provides the attachment functionality   
top
 

Student_AttachmentObject

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

Student_AttachmentObjectID

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

Attachment_WWS_Data

part of: Student_Attachment_Drag_and_Drop_Data
Attachment WWS Data element
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
Filename  string (255)   [1..1]  Filename for the attachment.   
File_Content  base64Binary  [1..1]  File content in binary format.   
Mime_Type_Reference  Mime_TypeObject  [0..1]  Mime Type Reference   
Comment  string  [0..1]  Comment   
top
 

Mime_TypeObject

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

Mime_TypeObjectID

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

Student_Sponsor_RefundReferenceEnumeration

part of: Student_Sponsor_RefundObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Billable_EntityReferenceEnumeration

part of: Billable_EntityObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Document_Payment_StatusReferenceEnumeration

part of: Document_Payment_StatusObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Student_Sponsor_PaymentReferenceEnumeration

part of: Student_Sponsor_PaymentObjectID
Base Type
string
top
 

Student_AttachmentReferenceEnumeration

part of: Student_AttachmentObjectID
Base Type
string
top
 

Mime_TypeReferenceEnumeration

part of: Mime_TypeObjectID
Base Type
string
top