Service Directory > v31.2 > Student_Finance > Get_Student_Payments
 

Operation: Get_Student_Payments

GET web service to return specific Student Payments or all Student Payments


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

Wrapper element for the Get Student Payment Item Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Student_Payment_Request_References  [0..1]  Element containing the list of Student Payment(s) for Charges for which data is requested.   
Request_Criteria [Choice]   Student_Payment_Request_Criteria  [0..1]  Element to specify criteria options to search for Student Payment for Charges within the Workday system. Search by Name.   
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_Payments_Response

Wrapper element for the Student Payment for Charges Information returned as a result of a Get Student Payment for Charges
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Student_Payment_Request_References  [0..1]  Element containing the list of Student Payment(s) for Charges for which data is requested.   
Request_Criteria  Student_Payment_Request_Criteria  [0..1]  Utilize the following criteria options to search for Student Payment for Charges within the Workday system. Provide either the Data Load reference, Academic Period or Student references.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Student Payment for Charges Group Response   
Response_Data  Student_Payment_Response_Data  [0..1]  Wrapper Element for the Student Payment for Charges data   
top
 

Student_Payment_Request_References

part of: Get_Student_Payments_Request, Get_Student_Payments_Response
Element containing the list of Student Payment(s) for Charges for which data is requested.
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment_Reference  Student_PaymentObject  [1..*]  Workset of Student Payment for Charges for which data is requested.   
top
 

Student_PaymentObject

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

Student_PaymentObjectID

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

part of: Get_Student_Payments_Request, Get_Student_Payments_Response
Utilize the following criteria options to search for Student Payment for Charges within the Workday system. Provide either the Data Load reference, Academic Period or Student references.
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment_Data_Load_Reference  Student_Payment_Data_LoadObject  [0..1]  Reference to the Student Payment Data Load   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Reference to the optional Academic Period   
Student_Reference  StudentObject  [0..1]  Reference to the optional Student   
top
 

Student_Payment_Data_LoadObject

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

Student_Payment_Data_LoadObjectID

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

StudentObject

part of: Student_Payment_Request_Criteria, Student_Payment_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
 

Response_Filter

part of: Get_Student_Payments_Request, Get_Student_Payments_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_Payments_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_Payment_Response_Data

part of: Get_Student_Payments_Response
Wrapper element for the returned instance(s) of the get request
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment  Student_Payment  [0..*]  Wrapper Element for the Student Payment for Charges data   
top
 

Student_Payment

part of: Student_Payment_Response_Data
Wrapper Element for the Student Payment for Charges data
 
Parameter name Type/Value Cardinality Description Validations
Student_Payment_Reference  Student_PaymentObject  [0..1]  The reference to the Student Payment for Charges   
Student_Payment_Data  Student_Payment_Data  [0..*]  Contains data about the Student Payment for Charges 
Validation Description
The Item used for the Student Payment cannot be marked Inactive.   
Payment Type must be one of the Payment Types allowed for the Payment Item.   
Provide a Credit Card Type or change the Payment Type.   
Change the Payment Type to Credit Card or remove the Credit Card Type.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
Provide an Academic Period valid for the student   
 
top
 

Student_Payment_Data

part of: Student_Payment
Data for Student Payment
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the Student Payment for Charges 
Validation Description
This web service does not allow editing of existing payments.   
 
Student_Reference  StudentObject  [1..1]  Student making the payment   
Payment_Date  date  [0..1]  The date the payment is posted   
Academic_Period_Reference  Academic_PeriodObject  [0..1]  Academic Period for payment   
Payment_Item_Reference  Student_Payment_ItemObject  [1..1]  Payment Source for the the payment   
Payment_Type_Reference  Payment_TypeObject  [1..1]  Payment Type for the payment   
Credit_Card_Type_Reference  Credit_Card_TypeObject  [0..1]  Credit Card Type for the payment   
Payment_Receipt_Type_Reference  Student_Finance_Payment_Receipt_TypeObject  [1..1]  Payment Receipt Type for the payment. Will be automatically filled in omitted.   
Payment_Amount  decimal (18, 3)   [1..1]  Payment amount for payment   
Currency_Reference  CurrencyObject  [1..1]  Currency for the payment   
Batch  string  [0..1]  Batch Number for the payment   
Transaction_Number  string  [0..1]  Transaction Number for the payment   
Payment_Reference_Number  string  [0..1]  Check number for payment   
Memo  string  [0..1]  Memo for payment   
Line_Number  string  [0..1]  Line number for the payment   
Cashiering_Station  string  [0..1]  Cashiering station for the payment   
Cashiering_Location  string  [0..1]  Cashiering location for the payment   
Cashier  string  [0..1]  Cashier for the payment   
Notify_Financial_Aid  boolean  [0..1]  Whether to send a notification to the Financial Aid administrator to notify him/her of a private scholarship   
Validation Description
The Item used for the Student Payment cannot be marked Inactive.   
Payment Type must be one of the Payment Types allowed for the Payment Item.   
Provide a Credit Card Type or change the Payment Type.   
Change the Payment Type to Credit Card or remove the Credit Card Type.   
Change the Currency to match the default currency for the student's academic unit: [currency]   
Provide an Academic Period valid for the student   
top
 

Student_Payment_ItemObject

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

Student_Payment_ItemObjectID

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

Payment_TypeObject

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

Credit_Card_TypeObject

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

Credit_Card_TypeObjectID

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

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

Student_Finance_Payment_Receipt_TypeObjectID

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

part of: Student_PaymentObjectID
Base Type
string
top
 

Student_Payment_Data_LoadReferenceEnumeration

part of: Student_Payment_Data_LoadObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

part of: Academic_PeriodObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Student_Payment_ItemReferenceEnumeration

part of: Student_Payment_ItemObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Credit_Card_TypeReferenceEnumeration

part of: Credit_Card_TypeObjectID
Base Type
string
top
 

Student_Finance_Payment_Receipt_TypeReferenceEnumeration

part of: Student_Finance_Payment_Receipt_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top