Service Directory > v31.2 > Student_Finance > Get_Charges_for_Students
 

Operation: Get_Charges_for_Students

Returns the charge information and lists the adjustments made to the charge


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

Wrapper element for Get Charges for Student Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Charge_for_Student_Request_Reference  [0..1]  Wrapper element for Charge for Student Request Reference   
Request_Criteria [Choice]   Charge_for_Student_Request_Criteria  [0..1]  Wrapper element for Charge for Student 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_Charges_for_Students_Response

Wrapper element for Get Charges for Students Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Charge_for_Student_Request_Reference  [0..1]  Wrapper element for Charge for Student Request Reference   
Request_Criteria  Charge_for_Student_Request_Criteria  [0..1]  Wrapper element for Charge for Student 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  Charge_for_Student_Response_Data  [0..1]  Wrapper element for Charge for Student Response Data   
top
 

Charge_for_Student_Request_Reference

part of: Get_Charges_for_Students_Response, Get_Charges_for_Students_Request
Wrapper element for Charge for Student Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Student_Charge_Reference  Student_ChargeObject  [1..*]  Student Charge for which data has been requested   
top
 

Student_ChargeObject

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

Student_ChargeObjectID

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

Charge_for_Student_Request_Criteria

part of: Get_Charges_for_Students_Response, Get_Charges_for_Students_Request
Wrapper element for Charge for Student Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Charges_for_Students_Response, Get_Charges_for_Students_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_Charges_for_Students_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
 

Charge_for_Student_Response_Data

part of: Get_Charges_for_Students_Response
Wrapper element for Charge for Student Response Data
 
Parameter name Type/Value Cardinality Description Validations
Charge_for_Student  Charge_for_Student  [0..*]  Wrapper element for Charge for Student   
top
 

Charge_for_Student

part of: Charge_for_Student_Response_Data
Wrapper element for Charge for Student
 
Parameter name Type/Value Cardinality Description Validations
Student_Charge_Reference  Student_ChargeObject  [1..1]  Student Charge for which data is requested   
Student_Charge_Data  Charge_for_Student_Adjustment_History_Data  [0..*]  Wrapper element for Charge for Student Adjustment History Data   
top
 

Charge_for_Student_Adjustment_History_Data

part of: Charge_for_Student
Wrapper element for Charge for Student Adjustment History Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of the Student Charge for which data was requested   
Apply_Student_Charge_Data  Apply_Student_Charge_Data  [0..*]  Wrapper element for the Apply Student Charge Data 
Validation Description
Charge amount must be greater than zero.   
Charge items with type of Refund Recovery cannot be submitted by this task.   
 
Adjust_Student_Charge_Data  Adjust_Student_Charge_Data  [0..*]  Wrapper element for Adjust Student Charge Data 
Validation Description
A Charge Adjustment Reason is required.   
The following are valid Charge Adjustment Reasons: [reasons]   
 
top
 

Apply_Student_Charge_Data

part of: Charge_for_Student_Adjustment_History_Data
Wrapper element for the Apply Student Charge Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Reference  StudentObject  [1..1]  Student Reference for the Student Charge   
Transaction_Date  date  [0..1]  Student Charge Transaction Date   
Due_Date  date  [1..1]  Student Charge Due Date 
Validation Description
Due Date must be on or after Transaction Date   
 
Academic_Period_Reference  Academic_Period_AbstractObject  [0..1]  Academic Period Reference 
Validation Description
The Academic Period Type provided does not match a valid Academic Period for the Student.   
An Academic Period or Academic Period Type must be provided for a Student Charge with a Housing or Board Charge Type.   
Academic Period Type provided is invalid for next Academic Period.   
Specify an Academic Period or Academic Period Type. If you don't have those values, either today's current date or the Transaction Date must occur after the student's first academic period begins. The student's first academic period begins on: [date].   
Since the transaction date is before any valid academic periods, mark Is_Student_Charge_for_past_Academic_Period as False.   
Invalid Academic Period Type for the submitted past Student Charge. Please provide the Academic Period Type for the previous Academic Period.   
The Academic Period provided is invalid for the Student.   
 
Academic_Period_Type_Reference  Academic_Period_TypeObject  [0..1]  Academic Period Type 
Validation Description
The Academic Period Type is invalid for the provided Academic Period.   
 
Student_Charge_Item_Reference  Student_Charge_ItemObject  [1..1]  Student Cost Item Reference   
Amount  decimal (26, 6)   [1..1]  Student Charge Amount   
Worktags_Reference  Accounting_WorktagObject  [0..*]  Worktags Reference for this Student Charge 
Validation Description
[list of worktag types] not valid for this transaction.  The Worktags provided are not valid for this transaction 
 
Memo  string  [0..1]  Student Charge Memo   
Is_Student_Charge_for_past_Academic_Period  boolean  [0..1]  Is Student Charge for past Academic Period   
Transaction_Number  string  [0..1]  Transaction Number for cashiering   
Line_Number  string  [0..1]  Line Number for cashiering   
Locked  boolean  [0..1]  Student Charge is applied manually   
Is_Penalty  boolean  [0..1]  Student Charge is a penalty charge   
Validation Description
Charge amount must be greater than zero.   
Charge items with type of Refund Recovery cannot be submitted by this task.   
top
 

StudentObject

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

Academic_Period_AbstractObject

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

Academic_Period_AbstractObjectID

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

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

Academic_Period_TypeObjectID

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

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Adjust_Student_Charge_Data

part of: Charge_for_Student_Adjustment_History_Data
Wrapper element for Adjust Student Charge Data
 
Parameter name Type/Value Cardinality Description Validations
Amount  decimal (18, 3)   [0..1]  The new amount that the charge should be adjusted to.   
Due_Date  date  [1..1]  The new due date for the charge   
Student_Charge_Adjustment_Reason_Reference  Student_Charge_Adjustment_ReasonObject  [0..1]  The reason the charge is being adjusted   
Locked  boolean  [0..1]  The lock state of the charge   
Validation Description
A Charge Adjustment Reason is required.   
The following are valid Charge Adjustment Reasons: [reasons]   
top
 

Student_Charge_Adjustment_ReasonObject

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

Student_Charge_Adjustment_ReasonObjectID

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

part of: Student_ChargeObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_Period_AbstractReferenceEnumeration

part of: Academic_Period_AbstractObjectID
Base Type
string
top
 

Academic_Period_TypeReferenceEnumeration

part of: Academic_Period_TypeObjectID
Base Type
string
top
 

Student_Charge_ItemReferenceEnumeration

part of: Student_Charge_ItemObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Student_Charge_Adjustment_ReasonReferenceEnumeration

part of: Student_Charge_Adjustment_ReasonObjectID
Base Type
string
top