Service Directory > v32.1 > Payroll_GBR > Put_Payroll_Payee_RTI
 

Operation: Put_Payroll_Payee_RTI

Provides the ability to load one worker's UK RTI 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_RTI_Request

The request holds one Payee RTI record.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_RTI_Reference  Payroll_Payee_RTIObject  [0..1]  Payroll Payee RTI Reference   
Payroll_Payee_RTI_Data  Payroll_Payee_RTI_Data  [0..1]  Payroll Payee RTI Data 
Validation Description
FPS submitted for Deceased Worker cannot be set for a Worker who is not deceased   
The Company specified is not valid for the Worker.   
Set the Override Contract End Date flag if the Contract End Date has been specified.   
Provide a Contract End Date if the worker has already been reported as a deceased worker in the FPS.   
 
Validation Description
The Late PAYE Reporting Reason is not valid on the associated effective date   
If Payroll Payee RTI Reference is specified you cannot specify the Worker, Company or Effective Date   
If Payroll Payee RTI Reference is not specified you must specify the Worker, Company and Effective Date   
top
 

Response Element: Put_Payroll_Payee_RTI_Response

Put Payroll Payee RTI Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Payee_RTI_Reference  Payroll_Payee_RTIObject  [1..1]  The record ID.   
top
 

Payroll_Payee_RTIObject

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

Payroll_Payee_RTIObjectID

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

Payroll_Payee_RTI_Data

part of: Put_Payroll_Payee_RTI_Request
Payroll Payee RTI Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
Effective_As_Of  date  [0..1]  Effective as of Date   
Company_Reference  CompanyObject  [0..1]  Company for employee   
Irregular_Payment_Pattern  boolean  [0..1]  Irregular payment pattern indicator   
Late_PAYE_Reporting_Reason_Reference  Payroll_Constant_TextObject  [0..1]  Late PAYE reporting reason code   
FPS_Submitted_for_Deceased_Worker  boolean  [0..1]  FPS has been submitted for the deceased worker.   
Override_Contract_End_Date  boolean  [0..1]  Override Contract End Date flag   
Contract_End_Date  date  [0..1]  Contract End Date   
Validation Description
FPS submitted for Deceased Worker cannot be set for a Worker who is not deceased   
The Company specified is not valid for the Worker.   
Set the Override Contract End Date flag if the Contract End Date has been specified.   
Provide a Contract End Date if the worker has already been reported as a deceased worker in the FPS.   
top
 

WorkerObject

part of: Payroll_Payee_RTI_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_RTI_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_RTI_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_RTIReferenceEnumeration

part of: Payroll_Payee_RTIObjectID
Base Type
string
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