Service Directory > v31.2 > Student_Finance > Submit_Student_Deposit
 

Operation: Submit_Student_Deposit

Submit Student Deposit Web Service


@ - 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: Submit_Student_Deposit_Request

Contains Information for Student Deposit Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add only Boolean for Student Deposit   
Student_Deposit_Reference  Student_DepositObject  [0..1]  Student Deposit   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Student_Deposit_Data  Student_Deposit_Data  [1..1]  Contains data for Student Deposit 
Validation Description
The total amount of the Payments entered must equal the Control Total Amount.   
All payments for this deposit must have event complete and a status of "in-progress".   
A deposit with a status of approved is not editable.   
Payments attempting to be attached to this deposit cannot be associated with another deposit.   
All payments must have a student payment source that is tied to the company for this deposit.   
 
Validation Description
The web service is set to add only, but the Student Deposit already exists.   
top
 

Response Element: Submit_Student_Deposit_Response

Submit Student Deposit Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Deposit_Reference  Student_DepositObject  [0..1]  Student Deposit   
top
 

Student_DepositObject

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

Student_DepositObjectID

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

Financials_Business_Process_Parameters

part of: Submit_Student_Deposit_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

part of: Submit_Student_Deposit_Request
Contains Information for Student Deposit
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for Student Deposit.   
Bank_Account_Reference  Financial_AccountObject  [1..1]  Bank Account for the Student Deposit.   
Company_Reference  CompanyObject  [1..1]  The Company for the Student Deposit.   
Control_Total_Amount  decimal (26, 6)   [1..1]  Total Amount for the Student Deposit.   
Deposit_Date  date  [1..1]  Payment Posting date for the Student Deposit.   
Deposit_Transaction_Reference_Number  string  [0..1]  Reference Number for the Student Deposit.   
Customer_Payment_Reference  Student_PaymentObject  [1..*]  Student Payments for the Student Deposit.   
Submit  boolean  [0..1]  When Submit is True, the Deposit BP will be kicked off, if False the Deposit will be "saved for later".   
Validation Description
The total amount of the Payments entered must equal the Control Total Amount.   
All payments for this deposit must have event complete and a status of "in-progress".   
A deposit with a status of approved is not editable.   
Payments attempting to be attached to this deposit cannot be associated with another deposit.   
All payments must have a student payment source that is tied to the company for this deposit.   
top
 

Financial_AccountObject

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

Financial_AccountObjectID

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

CompanyObject

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

CompanyObjectID

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

Student_PaymentObject

part of: Student_Deposit_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_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_DepositReferenceEnumeration

part of: Student_DepositObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Student_PaymentReferenceEnumeration

part of: Student_PaymentObjectID
Base Type
string
top