Service Directory > v32.1 > Student_Finance > Submit_Student_Sponsor_Refund
 

Operation: Submit_Student_Sponsor_Refund

Create instances of 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: Submit_Student_Sponsor_Refund_Request

The top-level element for a student sponsor refund request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Sponsor_Refund_Data  Student_Sponsor_Refund_Data  [1..1]  The data container element for a student sponsor refund request 
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. 
 
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Validation Description
Clear the Automatically Complete field. You can't use this web service to auto-complete the generated student sponsor refund event.   
top
 

Response Element: Submit_Student_Sponsor_Refund_Response

The top-level response element for a Put Student Sponsor Refund request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Sponsor_Refund_Reference  Student_Sponsor_RefundObject  [0..1]  The student sponsor refund   
top
 

Student_Sponsor_Refund_Data

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

Business_Process_Parameters

part of: Submit_Student_Sponsor_Refund_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

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

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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Student_Sponsor_RefundReferenceEnumeration

part of: Student_Sponsor_RefundObjectID
Base Type
string
top