Service Directory > v31.2 > Student_Finance > Get_Student_Historical_Charges
 

Operation: Get_Student_Historical_Charges

Returns Student Historical Transactions by Reference ID, or returns all Student Historical Transactions if no Reference ID is provided.


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

Element Container for Get Historical Student Charges Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Historical_Charge_Request_References  [0..1]  Element Content Container for Get Historical Student Charges Request   
Request_Criteria [Choice]   Student_Historical_Charge_Request_Criteria  [0..1]  Element Content Container for Get Historical Student Charges Request   
Response_Filter  Response_Filter  [0..1]  Element Content Container for Get Historical Student Charges Request 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Historical_Charges_Response

Element Container for Get Historical Student Charges Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Historical_Charge_Request_References  [0..1]  Element Content Container for Get Historical Student Charges Response   
Request_Criteria  Student_Historical_Charge_Request_Criteria  [0..1]  Element Content Container for Get Historical Student Charges Response   
Response_Filter  Response_Filter  [0..1]  Element Content Container for Get Historical Student Charges Response 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Content Container for Get Historical Student Charges Response   
Response_Data  Student_Historical_Charge_Response_Data  [0..1]  Element Content Container for Get Historical Student Charges Response   
top
 

Student_Historical_Charge_Request_References

part of: Get_Student_Historical_Charges_Request, Get_Student_Historical_Charges_Response
Element Container for Historical Student Charge Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Historical_Charge_Reference  Student_Historical_ChargeObject  [1..*]  Element Content Container for Historical Student Charge Request References   
top
 

Student_Historical_ChargeObject

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

Student_Historical_ChargeObjectID

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

part of: Get_Student_Historical_Charges_Request, Get_Student_Historical_Charges_Response
Element Container for Historical Student Charge Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Historical_Charges_Request, Get_Student_Historical_Charges_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_Student_Historical_Charges_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_Historical_Charge_Response_Data

part of: Get_Student_Historical_Charges_Response
Element Container for Historical Student Charge Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Historical_Charge  Student_Historical_Charge  [0..*]  Element Content Container for Historical Student Charge Response Data   
top
 

Student_Historical_Charge

part of: Student_Historical_Charge_Response_Data
Element Container for Historical Student Charge
 
Parameter name Type/Value Cardinality Description Validations
Student_Historical_Charge_Reference  Student_Historical_ChargeObject  [0..1]  Element Content Container for Historical Student Charge   
Student_Historical_Charge_Data  Student_Historical_Charge_Data  [0..*]  Element Content Container for Historical Student Charge   
top
 

Student_Historical_Charge_Data

part of: Student_Historical_Charge
Element Container for Historical Student Charge Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Element Content Container for Historical Student Charge Data   
Student_Reference  StudentObject  [1..1]  Element Content Container for Historical Student Charge Data   
Transaction_Date  dateTime  [1..1]  Element Content Container for Historical Student Charge Data   
Academic_Period_Text  string  [1..1]  Element Content Container for Historical Student Charge Data   
Student_Historical_Transaction_Item  string  [1..1]  Element Content Container for Historical Student Charge Data   
Transaction_Amount  decimal (18, 3)   [1..1]  Element Content Container for Historical Student Charge Data   
Due_Date  date  [0..1]  Element Content Container for Historical Student Charge Data   
Reference_1  string  [0..1]  Reference 1 for Historical Student Charge Data   
Reference_2  string  [0..1]  Reference 2 for Historical Student Charge Data   
top
 

StudentObject

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

StudentObjectID

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

part of: Student_Historical_ChargeObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top