Service Directory > v32.1 > Student_Finance > Import_Student_Sponsor_Payment
 

Operation: Import_Student_Sponsor_Payment

Import Student Sponsor Payment. Records a Student Sponsor Payment with optional deposit created. Auto applies payment if Students are in the sub element by looking up the Customer Invoice Documents associated with the Student and Student Sponsor Contract on the Request.


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

Import Student Sponsor Payment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Student_Sponsor_Payment_Data  Student_Sponsor_Payment_Data  [1..1]  Record Student Sponsor Payment Import Data   
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_Sponsor_Payment_Data

part of: Import_Student_Sponsor_Payment_Request
Student Sponsor Payment Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID for Student Sponsor Payment   
Institutional_Academic_Unit_Reference  Academic_UnitObject  [1..1]  Institutional Academic Unit   
Student_Sponsor_Contract_Reference  Student_Sponsor_ContractObject  [1..1]  Student Sponsor Contract   
Sponsor_Reference  SponsorObject  [1..1]  Sponsor   
Currency_Reference  CurrencyObject  [1..1]  Currency   
Transaction_Date  date  [1..1]  Transaction Date   
Payment_Type_Reference  Payment_TypeObject  [1..1]  Payment Type   
Transaction_Amount  decimal (18, 3)   [1..1]  Transaction Amount   
Payment_Memo  string  [0..1]  Payment Memo   
Record_Deposit  boolean  [0..1]  Record Deposit   
Financial_Account_Reference  Financial_AccountObject  [0..1]  Bank Account for Student Sponsor Deposit   
Payment_Deposit_Date  date  [0..1]  Payment Deposit Date   
Deposit_Reference_Number  string  [0..1]  Deposit Reference Number   
Student_Sponsor_Payment_Student_Payment_Line_Data  Student_Sponsor_Payment_Student_Payment_Line_Data  [0..*]  Student Sponsor Payment Student Payment Line Data   
top
 

Academic_UnitObject

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

Student_Sponsor_ContractObject

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

Student_Sponsor_ContractObjectID

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

SponsorObject

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

SponsorObjectID

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

CurrencyObject

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

Payment_TypeObject

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

Financial_AccountObject

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

Student_Sponsor_Payment_Student_Payment_Line_Data

part of: Student_Sponsor_Payment_Data
Student Sponsor Payment Student Payment Line Data
 
Parameter name Type/Value Cardinality Description Validations
Student_Social_Security_Number  string (9)   [1..1]  Student SSN   
Student_Last_Name  string  [1..1]  Student Last Name   
Amount_Billed  decimal (26, 6)   [0..1]  Amount Billed   
Amount_Paid  decimal (26, 6)   [1..1]  Amount Paid   
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
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top
 

Student_Sponsor_ContractReferenceEnumeration

part of: Student_Sponsor_ContractObjectID
Base Type
string
top
 

SponsorReferenceEnumeration

part of: SponsorObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Financial_AccountReferenceEnumeration

part of: Financial_AccountObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top