Service Directory > v31.2 > Student_Finance > Submit_Student_Payment
 

Operation: Submit_Student_Payment

Records a new Student Payment for Charges with the information specified in the request. If Payment Receipt Type is omitted, it will be copied from the Student Payment Item.


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

Wrapper element for the Put Student Payment for Charges Request Information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update. This web service only allows adding, not updating.   
Student_Payment_Reference  Student_PaymentObject  [0..1]  The reference to the Student Payment for Charges being updated. Since this web service is add-only, this element will not exist   
Student_Payment_Data  Student_Payment_Data  [1..1]  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   
 
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
top
 

Response Element: Submit_Student_Payment_Response

Wrapper element for the Put Student Payment for Charges response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Payment_Reference  Student_PaymentObject  [0..1]  The Reference ID for the newly created Student Payment for Charges instance   
top
 

Student_PaymentObject

part of: Submit_Student_Payment_Request, Submit_Student_Payment_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_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_Data

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

StudentObject

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  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_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
 

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
 

Business_Process_Parameters

part of: Submit_Student_Payment_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
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.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

part of: Student_PaymentObjectID
Base Type
string
top
 

StudentReferenceEnumeration

part of: StudentObjectID
Base Type
string
top
 

Academic_PeriodReferenceEnumeration

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top