Service Directory > v31.2 > Financial_Management > Put_Effort_Certification_Type
 

Operation: Put_Effort_Certification_Type

This service operation will modify an existing Effort Certification Type (if a valid ID is provided) or will create a new Effort Certification Type.


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

Put Effort Certification Type Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Effort_Certification_Type_Reference  Effort_Certification_TypeObject  [0..1]  Effort Certification Type Reference   
Effort_Certification_Type_Data  Effort_Certification_Type_Data  [1..1]  Effort Certification Type Data 
Validation Description
The "Group By" and "Use Full Worktags" fields cannot be changed because it may impact costing allocations of existing Effort Certifications.   
Worktags specified for a Payroll Actuals Costed To selection must be active. Please remove the following inactive worktags: [hierarchies]   
Worktags specified for a Payroll Actuals Costed To selection must be active. Please remove the following inactive worktags: [worktags]   
 
Validation Description
The Web Service is set to Add Only, but the Effort Certification Type already exists.  Create a new Effort Certification Type, or change 'Add Only' to 'false' to edit the Effort Certification Type. 
Please provide a Summary Worktag of allowed type. Allowed types are: [types]  The Worktag to group by must be enabled for Effort Certification. 
Please provide a Worktag Dimension of allowed type. Allowed types are: [types]  The Worktags to report on for this Effort Certification Type must be enabled for Effort Certification. 
The Hierarchy provided must be the same type as the "Summary Group By" provided.  Enter a Hierarchy that matches Summary Group by Worktag. 
Only Surveys that are of Survey Type: "Effort Certification" may be used on an Effort Certification Type. Please verify that the survey provided is of Survey Type: "Effort Certification."  Provide a Survey that is enabled for Effort Certification. 
top
 

Response Element: Put_Effort_Certification_Type_Response

Put Effort Certification Type Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Effort_Certification_Type_Reference  Effort_Certification_TypeObject  [0..1]  Effort Certification Type Reference   
top
 

Effort_Certification_TypeObject

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

Effort_Certification_TypeObjectID

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

Effort_Certification_Type_Data

part of: Put_Effort_Certification_Type_Request
Contains Effort Certification Type Data
 
Parameter name Type/Value Cardinality Description Validations
Effort_Certification_Type_ID  string  [0..1]  Effort Certification Type Reference ID   
Effort_Certification_Type_Name  string  [1..1]  Effort Certification Type Name   
Effort_Certification_Type_Description  string  [0..1]  Effort Certification Type Description   
Group_By_Reference  Accounting_Worktag_TypeObject  [1..*]  Effort Certification Type Group by Accounting Worktag Types   
Subtotal_By_Accounting_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [1..1]  Effort Certification Type Subtotal by Accounting Worktag Type   
Hierarchy_Reference  Accounting_Worktag_Aggregation_DimensionObject  [0..1]  Effort Certification Type Subtotal by Hierarchy   
Effort_Certifying_Text_Reference  Effort_Certifying_TextObject  [0..1]  Effort Certifying Text   
Display_Compensation_Amounts  boolean  [0..1]  Effort Certification Type Display Compensation Amounts   
Use_Full_Worktags  boolean  [0..1]  Boolean to determine if Effort Certifications will be generated with the all of the worktags from payroll results specific to earnings.   
Survey_Reference  Effort_Certification_SurveyObject  [0..1]  Effort Certification Type Survey   
Employee_Eligibility_Rule_Reference  Effort_Certification_Eligibility_RuleObject  [1..1]  Employee Eligibility Rule   
Pay_Component_Group_Reference  Pay_Component_Group__All_Object  [0..1]  Effort Certification Type Pay Component Group   
Payroll_Actuals_Costed_To_Selection  Payroll_Costed_Actuals_Filter_Data  [0..*]  Effort Certification Type can contain multiple Payroll Actuals Costed To selections. This is additional filter criteria to select which employees will be selected in the Run Effort Certification task. 
Validation Description
A dimension may only be specified once.   
Worktag type specified for a Pay Actuals Costed To selection is not valid. Valid worktag types: [validTypes]   
Worktags specified for a Pay Actuals Costed To Selection must match the Type selected   
 
Validation Description
The "Group By" and "Use Full Worktags" fields cannot be changed because it may impact costing allocations of existing Effort Certifications.   
Worktags specified for a Payroll Actuals Costed To selection must be active. Please remove the following inactive worktags: [hierarchies]   
Worktags specified for a Payroll Actuals Costed To selection must be active. Please remove the following inactive worktags: [worktags]   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

Accounting_Worktag_Aggregation_DimensionObject

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

Accounting_Worktag_Aggregation_DimensionObjectID

part of: Accounting_Worktag_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_Hierarchy_ID, Custom_Organization_Reference_ID, Customer_Category_ID, Customer_Group_ID, Expense_Item_Group_ID, Fund_Hierarchy_ID, Gift_Hierarchy_ID, Grant_Hierarchy_ID, Job_Family_Group_ID, Job_Family_ID, Organization_Reference_ID, Program_Hierarchy_ID, Project_Hierarchy_ID, Purchase_Item_Group_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Sales_Item_Group_ID, Sponsor_Type_ID, Supplier_Category_ID, Supplier_Group_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
 

Effort_Certifying_TextObject

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

Effort_Certifying_TextObjectID

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

Effort_Certification_SurveyObject

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

Effort_Certification_SurveyObjectID

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

Effort_Certification_Eligibility_RuleObject

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

Effort_Certification_Eligibility_RuleObjectID

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

Pay_Component_Group__All_Object

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

Pay_Component_Group__All_ObjectID

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

Payroll_Costed_Actuals_Filter_Data

part of: Effort_Certification_Type_Data
Effort Certification Type Data
 
Parameter name Type/Value Cardinality Description Validations
Accounting_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [1..1]  For Payroll Actual Costing, select the worktag type which will be used in the Run Effort Certification task to collect employees with payroll lines tagged with this type.   
Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [1..*]  Reference to existing Worktags. Worktags selected must match the worktag type selected previously. They have to be active and cannot be hierarchical. The Run Effort Certification task will then collect employees with payroll lines tagged with the worktags specified.   
Validation Description
A dimension may only be specified once.   
Worktag type specified for a Pay Actuals Costed To selection is not valid. Valid worktag types: [validTypes]   
Worktags specified for a Pay Actuals Costed To Selection must match the Type selected   
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Family_Group_ID, Job_Family_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_Group_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Effort_Certification_TypeReferenceEnumeration

part of: Effort_Certification_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_Aggregation_DimensionObjectID
Base Type
string
top
 

Effort_Certifying_TextReferenceEnumeration

part of: Effort_Certifying_TextObjectID
Base Type
string
top
 

Effort_Certification_SurveyReferenceEnumeration

part of: Effort_Certification_SurveyObjectID
Base Type
string
top
 

Effort_Certification_Eligibility_RuleReferenceEnumeration

part of: Effort_Certification_Eligibility_RuleObjectID
Base Type
string
top
 

Pay_Component_Group__All_ReferenceEnumeration

part of: Pay_Component_Group__All_ObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top