Service Directory > v32.1 > Payroll_GBR > Put_Payroll_Payee_Postgraduate_Loan
 

Operation: Put_Payroll_Payee_Postgraduate_Loan

Provides the ability to load one worker's UK PAYE Postgraduate Loan information.


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

Put information for creating/editing a Postgraduate Loan Details record.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_Postgraduate_Loans_Data  Payroll_Payee_Postgraduate_Loan_Data  [0..1]  Details for Postgraduate Loan Record 
Validation Description
Postgraduate Loan Stop Date entered must be on or after the PGL2 Stop Notification Received Date.   
A Stop Date is required if Stopped Without PGL2 is selected.   
A Stop Date is required if a PGL2 Stop Notification Received Date is provided.   
You can only enter a Stop Date with a valid PGL2 Stop Notification Received Date or when Stopped Without PGL2 is selected.   
Stop Date must be greater than or equal to Effective Date ([payroll asof date])   
A Postgraduate Loan already exists. Either remove the new record or stop the existing Postgraduate Loan record and add a new one.   
Postgraduate Loan dates cannot overlap existing details. Either change the effective date and / or stop date or review and modify the existing Postgraduate Loan details.   
An active Postgraduate Loan cannot pre-date an existing stopped Postgraduate Loan. Either change the effective date and / or stop date or review and modify the existing Postgraduate Loan details.   
PGL2 Stop Notification Received Date must be greater than Effective Date [payroll as of date].   
The Company specified is not valid for the Worker.   
A Postgraduate Loan already exists. Either remove the new record or stop the existing Postgraduate Loan record and add a new one.   
 
top
 

Response Element: Put_Payroll_Payee_Postgraduate_Loan_Response

Put Payroll Payee Postgraduate Loan Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_Postgraduate_Loan_Reference  Payroll_Payee_Postgraduate_LoanObject  [1..1]  Payroll Payee Postgraduate Loan Reference   
top
 

Payroll_Payee_Postgraduate_Loan_Data

part of: Put_Payroll_Payee_Postgraduate_Loan_Request
Details for Postgraduate Loan Record
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  The Worker for this record   
Effective_As_Of  date  [1..1]  Effective Date for this record   
Company_Reference  CompanyObject  [1..1]  Company for Worker of this record   
Start_Notification_Type_Reference  Payroll_Constant_TextObject  [1..1]  Notification Type for Postgraduate Loan   
PGL2_Stop_Notification_Received_Date  date  [0..1]  When was PGL2 Notification Received   
Stop_Date  date  [0..1]  The Stop Date for this Postgraduate Loan   
Stopped_Without_PGL2  boolean  [0..1]  Boolean flag indicating Postgraduate Loan stopped without a PGL2 notification   
Validation Description
Postgraduate Loan Stop Date entered must be on or after the PGL2 Stop Notification Received Date.   
A Stop Date is required if Stopped Without PGL2 is selected.   
A Stop Date is required if a PGL2 Stop Notification Received Date is provided.   
You can only enter a Stop Date with a valid PGL2 Stop Notification Received Date or when Stopped Without PGL2 is selected.   
Stop Date must be greater than or equal to Effective Date ([payroll asof date])   
A Postgraduate Loan already exists. Either remove the new record or stop the existing Postgraduate Loan record and add a new one.   
Postgraduate Loan dates cannot overlap existing details. Either change the effective date and / or stop date or review and modify the existing Postgraduate Loan details.   
An active Postgraduate Loan cannot pre-date an existing stopped Postgraduate Loan. Either change the effective date and / or stop date or review and modify the existing Postgraduate Loan details.   
PGL2 Stop Notification Received Date must be greater than Effective Date [payroll as of date].   
The Company specified is not valid for the Worker.   
A Postgraduate Loan already exists. Either remove the new record or stop the existing Postgraduate Loan record and add a new one.   
top
 

WorkerObject

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

CompanyObject

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

Payroll_Constant_TextObject

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

Payroll_Constant_TextObjectID

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

Payroll_Payee_Postgraduate_LoanObject

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

Payroll_Payee_Postgraduate_LoanObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Payroll_Constant_TextReferenceEnumeration

part of: Payroll_Constant_TextObjectID
Base Type
string
top
 

Payroll_Payee_Postgraduate_LoanReferenceEnumeration

part of: Payroll_Payee_Postgraduate_LoanObjectID
Base Type
string
top