Service Directory > v32.1 > Financial_Aid > Get_Student_Sponsor_Contracts
 

Operation: Get_Student_Sponsor_Contracts

Returns Student Sponsor Contracts by Reference ID, or returns all Student Sponsor Contracts 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_Sponsor_Contracts_Request

Element Container for Get Student Sponsor Contracts Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Sponsor_Contract_Request_References  [0..1]  Element Container for Student Sponsor Contract Request references   
Request_Criteria [Choice]   Student_Sponsor_Contract_Request_Criteria  [0..1]  Element Container for Student Sponsor Contract Request Criteria   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filer 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Student_Sponsor_Contracts_Response

Element Container for Student Sponsor Contracts Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Sponsor_Contract_Request_References  [0..1]  Element Container for Student Sponsor Contract Request References   
Request_Criteria  Student_Sponsor_Contract_Request_Criteria  [0..1]  Element Container for Student Sponsor Contract Request Criteria   
Response_Filter  Response_Filter  [0..1]  Element Container for Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Element Container for Response Results   
Response_Data  Student_Sponsor_Contract_Response_Data  [0..1]  Element Container for Student Sponsor Contract Response Data   
top
 

Student_Sponsor_Contract_Request_References

part of: Get_Student_Sponsor_Contracts_Request, Get_Student_Sponsor_Contracts_Response
Element Container for Student Sponsor Contract Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Contract_Reference  Student_Sponsor_ContractObject  [1..*]  Student Sponsor Contracts for Student Sponsor Contracts Request Element   
top
 

Student_Sponsor_ContractObject

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

Student_Sponsor_ContractObjectID

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

part of: Get_Student_Sponsor_Contracts_Request, Get_Student_Sponsor_Contracts_Response
Element Container for Student Sponsor Contract Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Sponsor_Contracts_Request, Get_Student_Sponsor_Contracts_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_Sponsor_Contracts_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_Sponsor_Contract_Response_Data

part of: Get_Student_Sponsor_Contracts_Response
Element Container for Student Sponsor Contract Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Contract  Student_Sponsor_Contract  [0..*]  Element Container for Student Sponsor Contract   
top
 

Student_Sponsor_Contract

part of: Student_Sponsor_Contract_Response_Data
Element Container for Student Sponsor Contract
 
Parameter name Type/Value Cardinality Description Validations
Student_Sponsor_Contract_Reference  Student_Sponsor_ContractObject  [0..1]  Student Sponsor Contract Work Data for Student Sponsor Contract Element   
Student_Sponsor_Contract_Data  Student_Sponsor_Contract_Data  [0..*]  Element Container for Student Sponsor Contract Data 
Validation Description
Total Amount Awarded (sum of contract line award amounts) must be less than or equal to the Total Contract Amount.   
Student maximum must be greater than student minimum.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
Worktag Balancing is enabled for this AU and therefore a default value for the Primary Worktag Balancing Type [fund] must be selected.   
The disbursement schedule cannot be changed for an existing Sponsor Contract with Sponsor Contract Lines.   
These contract lines have the same student and academic period. Select a different student or academic period for these contract lines: [lines]   
You can't change the No FA or 1098-T Impact value because you've already applied a payment toward the student sponsor contract.   
 
top
 

Student_Sponsor_Contract_Data

part of: Student_Sponsor_Contract
Element Container for Student Sponsor Contract Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Sponsor Contract Data Element   
Academic_Unit_Data  Academic_Curricular_Division_Subedit_Level_Optional_Data  [1..1]  Contains Academic Unit information for a Student Prospect where the Academic Level is optional 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
 
Contract_Name  string  [1..1]  Contract Name for Student Sponsor Contract Data Element 
Validation Description
Student Sponsor Contract must have unique name.   
 
Financial_Aid_Award_Year_Reference  Financial_Aid_Award_YearObject  [1..1]  Financial Aid Award Year Reference for Student Sponsor Contract Data Element   
Contract_Description  string  [0..1]  Contract Description for Student Sponsor Contract Data Element   
Document_Date  date  [1..1]  Document Date for Student Sponsor Contract Data Element   
Contract_Signed_Date  date  [0..1]  Customer Contract Signed Date for Student Sponsor Contract Data Element   
Payment_Terms_Reference  Payment_TermsObject  [0..1]  Payment Terms Reference for Student Sponsor Contract Data Element   
Sponsor_Reflected_Reference  SponsorObject  [1..1]  Sponsor Reflected Reference for Student Sponsor Contract Data Element   
Award_Contract_Bill_To_Sponsor_Reference  SponsorObject  [1..1]  Award Contract Bill to Sponsor Reference for Student Sponsor Contract Data Element   
Payment_Type_Reference  Payment_TypeObject  [0..1]  Payment Type Reference for Student Sponsor Contract Data Element   
No_FA_Need_Impact  boolean  [0..1]  No FA Need Impact field for Student Sponsor Contract Data Element   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference for Student Sponsor Contract Data Element   
Student_Precedence_Group_for_Academic_Unit_Reference  Student_Precedence_GroupObject  [1..1]  Precedence Group for Academic Unit for Student Sponsor Contracts 
Validation Description
Precedence Group must be for specific Academic Unit   
 
Student_Minimum  decimal (12, 2) >0   [0..1]  Student Minimum for Student Sponsor Contract Data Element   
Student_Maximum  decimal (12, 2) >0   [0..1]  Student Maximum for Student Sponsor Contract Data Element   
Disbursement_Schedule_Reference  Student_Disbursement_ScheduleObject  [0..1]  Student Disbursement Schedule for Student Sponsor Contract Data Element   
Calculation_Reference  CalculationObject  [0..1]  Eligibility Calculation for Student Sponsor Contract Data Element   
Amount_Calculation_Reference  CalculationObject  [0..1]  Amount Calculation for Student Sponsor Contract Data Element   
Refundable  boolean  [0..1]  Refundable Boolean for Student Sponsor Contract Data Element   
Total_Contract_Amount  decimal (17, 2) >0   [1..1]  Total Contract Amount for Student Sponsor Contract Data Element   
Revenue_Category_Reference  Revenue_CategoryObject  [1..1]  Revenue Category   
Worktags_Reference  Accounting_WorktagObject  [0..*]  Worktags for Student Sponsor Contract 
Validation Description
[list of worktag types] not valid for this transaction.  The Worktags provided are not valid for this transaction 
[list of types] are required for Student Sponsor Contract  The Worktags provided are not valid for this transaction 
 
Header_Numeric_Field_1  decimal (50, 0) >0   [0..1]  Header Numeric Field 1 for Student Sponsor Contract Data   
Student_Sponsor_Contract_Line_Data  Student_Sponsor_Contract_Line_Data  [0..*]  Element Container for Student Sponsor Contract Line Data   
Validation Description
Total Amount Awarded (sum of contract line award amounts) must be less than or equal to the Total Contract Amount.   
Student maximum must be greater than student minimum.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
Worktag Balancing is enabled for this AU and therefore a default value for the Primary Worktag Balancing Type [fund] must be selected.   
The disbursement schedule cannot be changed for an existing Sponsor Contract with Sponsor Contract Lines.   
These contract lines have the same student and academic period. Select a different student or academic period for these contract lines: [lines]   
You can't change the No FA or 1098-T Impact value because you've already applied a payment toward the student sponsor contract.   
top
 

Academic_Curricular_Division_Subedit_Level_Optional_Data

part of: Student_Sponsor_Contract_Data
Contains Academic Unit information for a Student Prospect where the Academic Level is optional
 
Parameter name Type/Value Cardinality Description Validations
Academic_Level_Reference  Academic_LevelObject  [0..1]  References an Academic Level for a Student Prospect   
Academic_Unit_Reference  Academic_Curricular_DivisionObject  [1..1]  Academic Unit Reference 
Validation Description
The Academic Unit Reference must be an Academic Unit.   
 
Validation Description
The Academic Unit is not valid for the selected Academic Level.   
top
 

Academic_LevelObject

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

Academic_LevelObjectID

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

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

Academic_Curricular_DivisionObjectID

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

Financial_Aid_Award_YearObject

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

Payment_TermsObject

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

Payment_TermsObjectID

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

SponsorObject

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

SponsorObjectID

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

Payment_TypeObject

part of: Student_Sponsor_Contract_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_Sponsor_Contract_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_Precedence_GroupObject

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

Student_Precedence_GroupObjectID

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

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

Student_Disbursement_ScheduleObjectID

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

CalculationObject

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

CalculationObjectID

part of: CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Balance_ID, Absence_Component_Related_Calculation_ID, Absence_Plan_ID, Accrual_Code, Aggregate_Calculation_ID, Arithmetic_Calculation_ID, Build_Date_Calculation_ID, Calculation_Compensation_Basis_ID, Compensation_Basis_ID, Compensation_Plan_ID, Conditional_Calculation_ID, Constant_Date_Calculation_ID, Constant_Value_Calculation_ID, Date_Difference_Calculation_ID, Date_Extract_Calculation_ID, Date_Increment_Decrement_Calculation_ID, Deduction_Code, Earning_Code, Instance_Set_Comparison_Calculation, Instance_Value_Calculation_ID, Logic_Calculation_ID, Lookup_Calculation_ID, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Related_Calculation_ID, Time_Off_Code, Value_Comparison_Calculation_ID, Workday_Absence_Balance_ID, Workday_Absence_Code, Workday_Absence_Component_Related_Calculation_ID, Workday_Absence_Plan_ID, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_Code, Workday_Related_Calculation_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
 

Revenue_CategoryObject

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

Revenue_CategoryObjectID

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

Accounting_WorktagObject

part of: Student_Sponsor_Contract_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, Alternate_Supplier_Contract_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, Lease_Expense_Recognition_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
 

Student_Sponsor_Contract_Line_Data

part of: Student_Sponsor_Contract_Data
Element Container for Student Sponsor Contract Line Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Sponsor Contract Line Data Element   
Student_Reference  StudentObject  [1..1]  Student Reference for Student Sponsor Contract Line Data Element   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period Reference for Student Sponsor Contract Line Data Element 
Validation Description
The selected academic period doesn't exist on the student's financial aid attendance plan. Select an academic period that occurs after the expected completion date of the student's current reporting record.   
 
Calculate_Amount  boolean  [0..1]  Calculate Amount for Student Sponsor Contract Line Data Element   
Contract_Amount  decimal (18, 3)   [0..1]  Contract Amount for Student Sponsor Contract Line Data Element 
Validation Description
Amount extended must be greater than Student Minimum defined above.   
Amount extended must be less than student maximum defined above.   
 
Line_Numeric_Field_1  decimal (50, 0) >0   [0..1]  Line Numeric Field 1 for Student Sponsor Contract Line Data Element   
Line_Numeric_Field_2  decimal (50, 0) >0   [0..1]  Line Numeric Field 2 for Student Sponsor Contract Line Data Element   
Line_Boolean_Field_1  boolean  [0..1]  Line Boolean Field 1 for Student Sponsor Contract Line Data Element   
Delete  boolean  [0..1]  Mark Delete as true to remove this Student Sponsor Contract Line from the Student Sponsor Contract   
top
 

StudentObject

part of: Student_Sponsor_Contract_Line_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_PeriodObject

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

Academic_PeriodObjectID

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

Student_Sponsor_ContractReferenceEnumeration

part of: Student_Sponsor_ContractObjectID
Base Type
string
top
 

Academic_LevelReferenceEnumeration

part of: Academic_LevelObjectID
Base Type
string
top
 

Academic_Curricular_DivisionReferenceEnumeration

part of: Academic_Curricular_DivisionObjectID
Base Type
string
top
 

Financial_Aid_Award_YearReferenceEnumeration

part of: Financial_Aid_Award_YearObjectID
Base Type
string
top
 

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

SponsorReferenceEnumeration

part of: SponsorObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Student_Precedence_GroupReferenceEnumeration

part of: Student_Precedence_GroupObjectID
Base Type
string
top
 

Student_Disbursement_ScheduleReferenceEnumeration

part of: Student_Disbursement_ScheduleObjectID
Base Type
string
top
 

CalculationReferenceEnumeration

part of: CalculationObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top