Service Directory > v32.1 > Student_Finance > Get_Student_Credit_Memos
 

Operation: Get_Student_Credit_Memos

Returns Student Credit Memos by Reference ID, or returns all Student Credit Memos 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_Credit_Memos_Request

Element Container for Get Student Credit Memos Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Credit_Memo_Request_References  [0..1]  Element Container for Student Credit Memo Request References   
Request_Criteria [Choice]   Student_Credit_Memo_Request_Criteria  [0..1]  Element Container for Student Credit Memo 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_Credit_Memos_Response

Element Container for Get Student Credit Memos Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Credit_Memo_Request_References  [0..1]  Element Container for Student Credit Memo Request References   
Request_Criteria  Student_Credit_Memo_Request_Criteria  [0..1]  Element Container for Student Credit Memo 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_Credit_Memo_Response_Data  [0..1]  Element Container for Student Credit Memo Response Data   
top
 

Student_Credit_Memo_Request_References

part of: Get_Student_Credit_Memos_Request, Get_Student_Credit_Memos_Response
Element Container for Student Credit Memo Request References
 
Parameter name Type/Value Cardinality Description Validations
Student_Credit_Memo_Reference  Student_Credit_MemoObject  [1..*]  Student Credit Memo Instance for Student Credit Memo Request References   
top
 

Student_Credit_MemoObject

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

Student_Credit_MemoObjectID

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

part of: Get_Student_Credit_Memos_Request, Get_Student_Credit_Memos_Response
Element Container for Student Credit Memo Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Student_Credit_Memos_Request, Get_Student_Credit_Memos_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_Credit_Memos_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_Credit_Memo_Response_Data

part of: Get_Student_Credit_Memos_Response
Element Container for Student Credit Memo Response Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Credit_Memo  Student_Credit_Memo  [0..*]  Element Container for All Student Credit Memo Data   
top
 

Student_Credit_Memo

part of: Student_Credit_Memo_Response_Data
Element Container for All Student Credit Memo Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Credit_Memo_Reference  Student_Credit_MemoObject  [0..1]  Student Credit Memo Reference Instance   
Student_Credit_Memo_Data  Student_Credit_Memo_Data  [0..*]  Data for Student Credit Memo 
Validation Description
Provide a Student Credit Memo ID that isn't already in use.   
Provide an Academic Period valid for the student   
The student has a refund hold. Resolve the refund hold before importing a credit memo for the student, or select another student.   
Provide at least one line on the credit memo.   
 
top
 

Student_Credit_Memo_Data

part of: Student_Credit_Memo
Data for Student Credit Memo
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Credit Memo   
Student_Reference  StudentObject  [1..1]  Student for the Student Credit Memo   
Academic_Unit_Reference  Academic_UnitObject  [1..1]  The Institution Academic Unit for the Student Credit Memo.   
Academic_Period_Reference  Academic_PeriodObject  [1..1]  Academic Period for the Student Credit Memo   
Memo  string  [0..1]  Memo text for the Student Credit Memo   
Student_Credit_Memo_Line_Data  Student_Credit_Memo_Line_Data  [0..*]  Element Container for Student Credit Memo Line Data 
Validation Description
Remove either the Spend Category or Revenue Category. Account Corrections can specify one or the other, but not both.   
Remove the Revenue Category. Revenue Categories do not apply to Expense Conversion Credits.   
Provide a Spend Category. Expense Conversion Credits require a Spend Category.   
Provide a Revenue Category. Revenue Conversion Credits require a Revenue Category.   
Remove the Spend Category. Spend Categories do not apply to Revenue Conversion Credits.   
Line amount must be greater than zero.   
Worktag Balancing is enabled for this AU and therefore a default value for the Primary Worktag Balancing Type [fund] must be selected.   
 
Validation Description
Provide a Student Credit Memo ID that isn't already in use.   
Provide an Academic Period valid for the student   
The student has a refund hold. Resolve the refund hold before importing a credit memo for the student, or select another student.   
Provide at least one line on the credit memo.   
top
 

StudentObject

part of: Student_Credit_Memo_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_UnitObject

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

Academic_UnitObjectID

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

Academic_PeriodObject

part of: Student_Credit_Memo_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_Credit_Memo_Line_Data

part of: Student_Credit_Memo_Data
Wrapper Element for Student Credit Memo Line Data
 
Parameter name Type/Value Cardinality Description Validations
Memo  string  [0..1]  Memo text for the Student Credit Memo Line   
Transaction_Amount  decimal (18, 3)   [1..1]  Student Credit Memo Line Amount   
Student_Credit_Memo_Reason_Reference  Student_Credit_Memo_ReasonObject  [1..1]  Student Credit Memo Reason for the Student Credit Memo Line   
Worktags_Reference  Accounting_WorktagObject  [0..*]  Worktags for Student Credit Memo Line 
Validation Description
[list of types] are required for Student Credit Memo Line.  The Worktags provided are not valid for this transaction 
[list of worktag types] not valid for this transaction.  The Worktags provided are not valid for this transaction 
 
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Revenue Category for Student Credit Memo Line   
Spend_Category_Reference  Spend_CategoryObject  [0..1]  Spend Category for Student Credit Memo Line   
Validation Description
Remove either the Spend Category or Revenue Category. Account Corrections can specify one or the other, but not both.   
Remove the Revenue Category. Revenue Categories do not apply to Expense Conversion Credits.   
Provide a Spend Category. Expense Conversion Credits require a Spend Category.   
Provide a Revenue Category. Revenue Conversion Credits require a Revenue Category.   
Remove the Spend Category. Spend Categories do not apply to Revenue Conversion Credits.   
Line amount must be greater than zero.   
Worktag Balancing is enabled for this AU and therefore a default value for the Primary Worktag Balancing Type [fund] must be selected.   
top
 

Student_Credit_Memo_ReasonObject

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

Student_Credit_Memo_ReasonObjectID

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

Accounting_WorktagObject

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

Revenue_CategoryObject

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Student_Credit_MemoReferenceEnumeration

part of: Student_Credit_MemoObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

Student_Credit_Memo_ReasonReferenceEnumeration

part of: Student_Credit_Memo_ReasonObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top