Service Directory > v33.1 > Student_Finance > Get_Student_Application_Fee_Payments
 

Operation: Get_Student_Application_Fee_Payments

Returns Student Application Fee Payments by Reference ID, or returns all Student Application Fee Payments if no Reference ID is provided; for use by payment processor integration


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

Element Container for Get Student Application Fee Payments Request Reference
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Application_Fee_Payment_Request_References  [0..1]  Contains data for Student Application Fee Payment Request References   
Request_Criteria [Choice]   Student_Application_Fee_Payment_Request_Criteria  [0..1]  Contains data for Student Application Fee Payment 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. 
 
top
 

Response Element: Get_Student_Application_Fee_Payments_Response

Get Student Application Fee Payments Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Application_Fee_Payment_Request_References  [0..1]  Element Container for Student Application Fee Payment Request References   
Request_Criteria  Student_Application_Fee_Payment_Request_Criteria  [0..1]  Element Container for Student Application Fee Payment 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  Student_Application_Fee_Payment_Response_Data  [0..1]  Element Container for Student Application Fee Payment Response Data   
top
 

Student_Application_Fee_Payment_Request_References

part of: Get_Student_Application_Fee_Payments_Request, Get_Student_Application_Fee_Payments_Response
Contains Student Application Fee Payment Request Information
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Fee_Payment_Reference  Student_Application_Fee_PaymentObject  [1..*]  Student Application Fee Payment for Request   
top
 

Student_Application_Fee_PaymentObject

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

Student_Application_Fee_PaymentObjectID

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

part of: Get_Student_Application_Fee_Payments_Request, Get_Student_Application_Fee_Payments_Response
Element Container for Student Application Fee Payment Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Application_Fee_Payments_Request, Get_Student_Application_Fee_Payments_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Student_Application_Fee_Payments_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Student_Application_Fee_Payment_Response_Data

part of: Get_Student_Application_Fee_Payments_Response
Element Container for Student Application Fee Payment Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Fee_Payment  Student_Application_Fee_Payment  [0..*]  Element Container for Student Application Fee Payment   
top
 

Student_Application_Fee_Payment

part of: Student_Application_Fee_Payment_Response_Data
Element Container for Student Application Fee Payment
 
Parameter name Type/Value Cardinality Description Validations
Student_Application_Fee_Payment_Reference  Student_Application_Fee_PaymentObject  [0..1]  The Student Application Fee Payment instance   
Student_Application_Fee_Payment_Data  Student_Application_Fee_Payment_with_Student_Application_Data  [0..*]  Element Container for Student Application Fee Payment Data 
Validation Description
Student Application already has a Student Application Fee Payment.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
The Student Charge Item must have a Charge Type of Application Fee.   
Student Application Reference is required.   
You can't submit an application fee for an inactive student application.   
Payment Type with method of [payment method] is not allowed.   
 
top
 

Student_Application_Fee_Payment_with_Student_Application_Data

part of: Student_Application_Fee_Payment
Element Container for Import Student Application Fee Payment Request
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Student Application Fee Payment   
Student_Application_Reference  Student_ApplicationObject  [0..1]  Student Application for the Student Application Fee Payment   
Transaction_Date  date  [1..1]  Transaction Date for the Student Application Fee Payment   
Student_Charge_Item_Reference  Student_Charge_ItemObject  [1..1]  Student Charge Item for the Student Application Fee Payment   
Payment_Type_Reference  Payment_TypeObject  [1..1]  Payment Type for the Student Application Fee Payment   
Transaction_Amount  decimal (18, 3)   [1..1]  Transaction Amount for the Student Application Fee Payment   
Currency_Reference  CurrencyObject  [1..1]  Currency for the Student Application Fee Payment   
Memo  string  [0..1]  Student Application Fee Payment Memo for the Student Application Fee Payment   
Transaction_Number  string  [0..1]  Student Application Fee Payment Transaction Number for the Student Application Fee Payment   
Line_Number  string  [0..1]  Student Application Fee Payment Line Number for the Student Application Fee Payment   
Cashier  string  [0..1]  Student Application Fee Payment Cashier for the Student Application Fee Payment   
Cashier_Station  string  [0..1]  Student Application Fee Payment Cashier Station for the Student Application Fee Payment   
Cashier_Location  string  [0..1]  Student Application Fee Payment Cashier Location for the Student Application Fee Payment   
Validation Description
Student Application already has a Student Application Fee Payment.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
The Student Charge Item must have a Charge Type of Application Fee.   
Student Application Reference is required.   
You can't submit an application fee for an inactive student application.   
Payment Type with method of [payment method] is not allowed.   
top
 

Student_ApplicationObject

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

Student_ApplicationObjectID

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

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

Student_Charge_ItemObjectID

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

CurrencyObject

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

CurrencyObjectID

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

part of: Student_Application_Fee_PaymentObjectID
Base Type
string
top
 

Student_ApplicationReferenceEnumeration

part of: Student_ApplicationObjectID
Base Type
string
top
 

Student_Charge_ItemReferenceEnumeration

part of: Student_Charge_ItemObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top