Service Directory > v32.1 > Student_Finance > Import_Student_Payments
 

Operation: Import_Student_Payments

This process uses a Put-type web service operation to load a large number of Student Payments. However, instead of loading all Student Payments in a single transaction, the Import Web Service Process splits up the request into smaller chunks that are processed in separate XpressO Jobs.


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

Import Student Payment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
ID  string  [0..1]  ID   
Student_Payment_Data  Student_Payment_Data  [0..*]  Data element containing information about the Student Payment 
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   
 
Validation Description
Enter a Student Payment Data Load ID that is not already in use.   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

Student_Payment_Data

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
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
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top