Service Directory > v32.1 > Financial_Aid > Get_Direct_Loan_Disbursements
 

Operation: Get_Direct_Loan_Disbursements

The Direct Loan School Account Statement (DLSAS) is provided by the Department of Education to schools. It helps schools compare their Direct Loan cash and disbursement transaction information for a given period of time with those of the Department of Education. This web service provides institutions a way to pull their disbursement records out of Workday and into Direct Loan Tools to perform the actual reconciliation process.


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

Incoming Web Service Request Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Direct_Loan_Disbursement_Request_Criteria  [1..1]  Direct Loan Disbursement Request Criteria Parameters 
Validation Description
Enter an End Date that is on or after the Start Date.   
Enter a valid Direct Loan School Code. This Direct Loan School Code is not valid: [school code].   
 
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_Direct_Loan_Disbursements_Response

Web Service Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Direct_Loan_Disbursement_Request_Criteria  [0..1]  Direct Loan Disbursement Request Criteria Parameters 
Validation Description
Enter an End Date that is on or after the Start Date.   
Enter a valid Direct Loan School Code. This Direct Loan School Code is not valid: [school code].   
 
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  Direct_Loan_Disbursement_Response_Data  [0..1]  Collection of Student Anticipated Disbursements returned by query   
top
 

Direct_Loan_Disbursement_Request_Criteria

part of: Get_Direct_Loan_Disbursements_Response, Get_Direct_Loan_Disbursements_Request
Direct Loan Disbursement Request Criteria Parameters
 
Parameter name Type/Value Cardinality Description Validations
Direct_Loan_School_Code  string (6)   [1..1]  This is the Direct Loan School Code   
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [1..1]  Financial Aid Award Year Reference ID   
Start_Date  date  [1..1]  Starting Date criteria   
End_Date  date  [1..1]  Ending Date Criteria   
Validation Description
Enter an End Date that is on or after the Start Date.   
Enter a valid Direct Loan School Code. This Direct Loan School Code is not valid: [school code].   
top
 

Financial_Aid_Award_YearObject

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

Financial_Aid_Award_YearObjectID

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

Direct_Loan_Disbursement_Response_Data

part of: Get_Direct_Loan_Disbursements_Response
Collection of Student Anticipated Disbursements returned by query
 
Parameter name Type/Value Cardinality Description Validations
Direct_Loan_Disbursement  Direct_Loan_Disbursement_Data  [0..*]  Detailed information regarding the Student Anticipated Disbursement   
top
 

Direct_Loan_Disbursement_Data

part of: Direct_Loan_Disbursement_Response_Data
Detailed information regarding the Student Anticipated Disbursement
 
Parameter name Type/Value Cardinality Description Validations
End_Date  string  [0..1]  The last day of the reporting period   
Booked  boolean  [0..1]  Booked Boolean: disbursement is an actual disbursement that is acknowledged by COD   
Loan_Identifier  string (21)   [0..1]  Unique Identifier created at the time of origination   
School_Code  string (6)   [0..1]  This is the Direct Loan School Code   
Total_Gross_Amount  decimal (10, 0) >0   [0..1]  The sum of the actual gross amounts (in dollars) for the loan   
Total_Loan_Fee_Amount  decimal (10, 0) >0   [0..1]  The sum of the actual loan fee amounts (in dollars) for the loan   
Total_Interest_Rebate_Amount  decimal (1, 0)   [0..1]  The sum of the actual interest rebate amounts (in dollars) for the loan   
Total_Net_Amount  decimal (10, 0) >0   [0..1]  The sum of the actual net amount (in dollars) for the loan   
Disbursement_Actual_Gross_Amount  decimal (20, 0) >0   [0..1]  Total gross amount disbursed for this disbursement of the award including adjustments   
Disbursement_Actual_Loan_Fee_Amount  decimal (10, 0) >0   [0..1]  The Loan Fee amount for the disbursement   
Disbursement_Actual_Interest_Rebate_Amount  decimal (1, 0) >0   [0..1]  The interest rebate amount (in dollars) for the loan   
Disbursement_Actual_Net_Amount  decimal (10, 0) >0   [0..1]  The actual Net amount for the disbursement   
Disbursement_Actual_Net_Adjustment  decimal (12, 2)   [0..1]  For disbursements, this is 0. For adjustments, this is the actual disbursement adjustment amount.   
Disbursement_Number  decimal (1, 0) >0   [0..1]  The disbursement number for the current disbursement transaction   
Disbursement_Sequence_Number  decimal (3, 0) >0   [0..1]  The sequence number that determines the order in which the disbursement activity is processed within EDExpress   
Previous_Disbursement_Sequence_Number  decimal (3, 0)   [0..1]  The Disbursement Sequence Number of the disbursement activity immediately preceding this disbursement record   
Disbursement_Transaction_Type  string (1)   [0..1]  Disbursement Activity recorded at COD   
Transaction_Date  string  [0..1]  Date disbursement activity occurred at the school   
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top