Service Directory > v32.1 > Payroll_Interface > Put_External_Pay_Group
 

Operation: Put_External_Pay_Group

This web service operation allows the user to do the following: 1 - Update Last Extract Created for External Pay Group by providing External Pay Group Reference, Integration System Reference, and Date Time. Also Updates Date Time for Additional Run for Effective Stack Sync Integrations. 2 - Update External Payroll Period Status by providing Pay Group Reference, Period Reference, and Period Status Reference. Note: Put Pay Group (Web Service) allows the user to add/update the full External Pay Group instance with all required details.


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

Put External Pay Group Request element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
External_Pay_Group_Data  Put_External_Pay_Group_Data  [0..1]  Main element containing Put External Pay Group Data 
Validation Description
Pay Group Reference is not a Payroll Interface Pay Group. The Pay Group Reference must have Used In Payroll Interface Boolean set to True in order to update External Pay Group data.   
Invalid Period Status. Period Status can only be set to In Progress or Complete.   
Please provide at least one of the following elements to be updated: - External Pay Group Last Extract Created Data - External Pay Group Period Status Data   
 
top
 

Response Element: Put_External_Pay_Group_Response

Put External Pay Group Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
External_Pay_Group_Reference  Pay_GroupObject  [0..1]  External Pay Group Reference from the request echoed back in the response.   
top
 

Put_External_Pay_Group_Data

part of: Put_External_Pay_Group_Request
Put External Pay Group Request element
 
Parameter name Type/Value Cardinality Description Validations
External_Pay_Group_Reference  Pay_GroupObject  [1..1]  External Pay Group Reference. This is the Pay Group instance with Used in Payroll Interface = True.   
Last_Extract_Created_Data  Last_Extract_Created_Data  [0..1]  This sub-element contains Last Extract Created Data: Integration System Reference and Date Time. 
Validation Description
Created Date Time cannot be greater than current date time.   
Created Date Time for Additional Run cannot be greater than Current date time   
 
Period_Status_Data  Period_Status_Data  [0..1]  This sub-element contains Period Status Data: Period Reference and Period Status Reference.   
Validation Description
Pay Group Reference is not a Payroll Interface Pay Group. The Pay Group Reference must have Used In Payroll Interface Boolean set to True in order to update External Pay Group data.   
Invalid Period Status. Period Status can only be set to In Progress or Complete.   
Please provide at least one of the following elements to be updated: - External Pay Group Last Extract Created Data - External Pay Group Period Status Data   
top
 

Pay_GroupObject

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

Pay_GroupObjectID

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

Last_Extract_Created_Data

part of: Put_External_Pay_Group_Data
External Pay Group Last Extract Created Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_System_Reference  Integration_System__Audited_Object  [1..1]  Integration System Reference.   
Date_Time  dateTime  [1..1]  Date Time stamp when Payroll Interface Extract was last created.   
Date_Time_for_Additional_Run  dateTime  [0..1]  Date Time stamp for when Payroll Interface Additional Extract was last created.   
Validation Description
Created Date Time cannot be greater than current date time.   
Created Date Time for Additional Run cannot be greater than Current date time   
top
 

Integration_System__Audited_Object

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

Integration_System__Audited_ObjectID

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

Period_Status_Data

part of: Put_External_Pay_Group_Data
Period Status Data element
 
Parameter name Type/Value Cardinality Description Validations
Period_Reference  PeriodObject  [1..1]  Period Reference. It identifies which Period instance to update the Period Status (In Progress or Complete).   
Period_Status_Reference  Unique_IdentifierObject  [1..1]  Period Status Reference. It must be In Progress or Complete.   
top
 

PeriodObject

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

PeriodObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Pay_GroupReferenceEnumeration

part of: Pay_GroupObjectID
Base Type
string
top
 

Integration_System__Audited_ReferenceEnumeration

part of: Integration_System__Audited_ObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top