Service Directory > v32.1 > Payroll_GBR > Put_Payroll_ID
 

Operation: Put_Payroll_ID

Provides the ability to load one worker's Payroll ID 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_ID_Request

The request holds one Payroll ID record.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_ID_Reference  Payroll_IDObject  [0..1]  Payroll ID Reference   
Payroll_ID_Data  Payroll_ID_Data  [1..1]  Payroll ID Data   
Validation Description
The Payroll ID must comply with the pattern for HMRC 'FullPaymentSubmission_CharsetG' and be no more than 35 characters in length.   
The worker must be in a UK pay group on the Payroll ID effective date.   
The Payroll ID assignment reason reference ID value isn't valid, submit a valid reason.   
The effective date must be later than any existing Payroll ID effective date for this worker.   
This Payroll ID can't be corrected because this isn't the worker's latest effective Payroll ID.   
This Payroll ID can't be moved to a different worker.   
This Payroll ID can't be corrected because the payroll for the pay period has already been processed.   
top
 

Response Element: Put_Payroll_ID_Response

Payroll ID Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Reference  WorkerObject  [0..1]  Employee ID   
Payroll_ID_Reference  Payroll_IDObject  [0..1]  Payroll ID Reference   
Assignment_Reason  string  [0..1]  Reason for Payroll ID assignment   
Effective_Date  date  [0..1]  Effective Date   
Automatic_Assignment  boolean  [0..1]  Reason for Payroll ID assignment   
top
 

Payroll_IDObject

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

Payroll_IDObjectID

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

part of: Put_Payroll_ID_Request
Payroll ID Data
 
Parameter name Type/Value Cardinality Description Validations
ID [Choice]   string  [0..1]  Payroll ID   
Automatic_Assignment [Choice]   boolean  [0..1]  If true, a Workday-specific Payroll ID code is generated.   
Worker_Reference  WorkerObject  [1..1]  Employee ID   
Effective_Date  date  [0..1]  Effective Date   
Assignment_Reason_Reference  Payroll_Constant_TextObject  [1..1]  Reason for Payroll ID assignment   
top
 

WorkerObject

part of: Payroll_ID_Data, Put_Payroll_ID_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  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
 

Payroll_Constant_TextObject

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

part of: Payroll_IDObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Payroll_Constant_TextReferenceEnumeration

part of: Payroll_Constant_TextObjectID
Base Type
string
top