Service Directory > v31.2 > Financial_Management > Import_Statistic_Plan
 

Operation: Import_Statistic_Plan

This service operation will add or update Statistics Plan Lines asynchronously.


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

Contains data for creating or updating Statistics Plan Details. A unique instance of the Plan is identified by the Statistics Plan Reference. A Plan period is identified by the Plan (Plan type) and the Fiscal Period (Fiscal Year and Company's Fiscal Schedule and Fiscal Posting Interval ie: 2018-Jan).
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Statistic_Plan_Reference  BudgetObject  [1..1]  Statistics Plan   
Import_Mode_Reference  Budget_Import_ModeObject  [1..1]  Statistics Plan Web Service Import Mode   
Submit  boolean  [0..1]  Submit Action   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Statistic_Plan_High_Volume_Data  Statistics_Plan_High_Volume_Data  [0..*]  Element containing Statistics Plan data 
Validation Description
You can't use a fiscal year or a fiscal period that doesn't match the plan periods for the plan that is being updated.  You can't use a fiscal year or a fiscal period that doesn't match the plan periods for the plan that is being updated. 
 
Validation Description
The Statistics Plan cannot be updated since it is not in draft status.  The Statistics Plan cannot be updated since it is not in draft status. 
You can't import plan lines into Plans with inactive Plan Template.  You can't import plan lines into Plans with inactive Plan Template. 
You can't import plan lines into Plans with associated worksheet.  You can't import plan lines into Plans with associated worksheet. 
The Plan must be a Statistical Plan type.   
You can't import plan lines into Plans that have a worksheet currently being generated.  You can't import plan lines into Plans that have a worksheet currently being generated. 
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

BudgetObject

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

BudgetObjectID

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

Budget_Import_ModeObject

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

Budget_Import_ModeObjectID

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

Financials_Business_Process_Parameters

part of: Import_Statistic_Plan_High_Volume_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Statistics_Plan_High_Volume_Data

part of: Import_Statistic_Plan_High_Volume_Request
Element containing Statistics Plan data
 
Parameter name Type/Value Cardinality Description Validations
Year  decimal (4, 0) >0   [1..1]  4 Digit numeric field that contains Fiscal Year Number (ie: 2008, 2009, etc). The combination of the Fiscal Year Number and the Fiscal Schedule determine the Fiscal Year for a company. Note that Fiscal Year Reference is not used for Budget since for Budget, the Company's configured Fiscal Schedule is used in all cases to determine the Fiscal Year.   
Fiscal_Time_Interval_Reference  Fiscal_Time_IntervalObject  [1..1]  Reference to an existing Fiscal Posting Interval, Fiscal Summary Interval, Award Posting Interval. The Fiscal Summary Interval is used for the Award Summary Interval. If the Budget is being entered by Fiscal Summary Schedules, provide the first the Summary Interval, otherwise provide the Posting Interval.   
Statistic_Plan_Lines_Data  Statistics_Plan_Line_High_Volume_Data  [1..*]  Element containing Statistics Plan Line data 
Validation Description
Only one worktag for each type is allowed for each document line.  Only one worktag for each type is allowed for each document line. 
 
Validation Description
You can't use a fiscal year or a fiscal period that doesn't match the plan periods for the plan that is being updated.  You can't use a fiscal year or a fiscal period that doesn't match the plan periods for the plan that is being updated. 
top
 

Fiscal_Time_IntervalObject

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

Fiscal_Time_IntervalObjectID

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

Statistics_Plan_Line_High_Volume_Data

part of: Statistics_Plan_High_Volume_Data
Element containing Statistics Plan Line data
 
Parameter name Type/Value Cardinality Description Validations
Line_Order  string  [0..1]  Optional line order. If specified, lines will be sorted by this value when displayed and when invoice is printed.   
Statistic_Line_Value  decimal (18, 6)   [0..1]  Statistic Line Value   
Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..*]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. Each transaction can include one value for each worktag type and is subject to configurable validation when submitted for approval. 
Validation Description
The following worktag values are not valid for this Budget Entry line: [worktags]   
The following dimension types are not valid for this transaction: [dimension types]  Accounting Worktags specified don't match with the Plan Type 
The plan line must have a dimension corresponding to every required dimension in the plan structure associated with the plan. Missing dimension(s): [Required Dimension Type]  The budget entry line must have a dimension corresponding to every required dimension in the plan structure associated with the plan 
 
Company_Reference  CompanyObject  [0..1]  Company 
Validation Description
Company must be defined on the plan structure.  Company must be defined on the plan structure. 
The Company dimension is required for each plan line.  The Company dimension is required for each plan line. 
 
Ledger_Account_or_Ledger_Account_Summary_Reference  Financial_Report_GroupObject  [0..1]  Ledger Accounts or Summary Accounts for line 
Validation Description
Ledger Account or Ledger Account Summary is required.   
The Ledger Account or Ledger Account Summary specified is not valid for the Budget Structure.   
Neither Ledger Account nor Ledger Account Summary may be specified since Ledger Account is not a Structured Dimension on the Budget Structure.   
 
Position_Status_Reference  Position_StatusObject  [0..1]  Position Status 
Validation Description
The Position Status specified is not valid for the Plan Structure.  The Position Status specified is not valid for the Plan Structure. 
Position Status may not be specified since it is not a Structured Dimension on the Plan Structure.  Position Status may not be specified since it is not a Structured Dimension on the Plan Structure. 
Position Status is required.  Position Status is required. 
 
Statistic_Definition_Reference  Statistic_DefinitionObject  [1..1]  Statistic Definition   
Validation Description
Only one worktag for each type is allowed for each document line.  Only one worktag for each type is allowed for each document line. 
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

CompanyObject

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

Financial_Report_GroupObject

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

Financial_Report_GroupObjectID

part of: Financial_Report_GroupObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_Account_ID, Ledger_Account_Summary_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Account_Set_ID  [1..1]  The unique identifier type of a parent object   
top
 

Position_StatusObject

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

Position_StatusObjectID

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

Statistic_DefinitionObject

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

Statistic_DefinitionObjectID

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

BudgetReferenceEnumeration

part of: BudgetObjectID
Base Type
string
top
 

Budget_Import_ModeReferenceEnumeration

part of: Budget_Import_ModeObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Fiscal_Time_IntervalReferenceEnumeration

part of: Fiscal_Time_IntervalObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Financial_Report_GroupReferenceEnumeration

part of: Financial_Report_GroupObjectID
Base Type
string
top
 

Base Type
string

top
 

Position_StatusReferenceEnumeration

part of: Position_StatusObjectID
Base Type
string
top
 

Statistic_DefinitionReferenceEnumeration

part of: Statistic_DefinitionObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top