Service Directory > v32.1 > Financial_Management > Put_Statistic
 

Operation: Put_Statistic

This service operation will add or update Statistics. Data includes: reference to the related Statistic Definition, Fiscal Period, Memo, the Statistics line values (Company, Worktags and Line Value), and optional file attachment.


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

Element for the Statistic data put request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Statistic_Reference  StatisticObject  [0..1]  Statistic Reference   
Statistic_Data  Statistic_Data  [0..1]  Statistic Data 
Validation Description
Values must sum to 100% since this statistic definition is percent-based.  Values must sum to 100% since this statistic definition is percent-based. 
Statistic Definition may not be changed on existing Statistic with configured dimensions.  Statistic Definition may not be changed on existing Statistic with configured dimensions. 
A Fiscal Period does not exist for the year and posting interval provided   
More than one Statistic exists for this Statistic Definition, Ledger/Budget Structure and Period.   
More than one Statistic exists for this Statistic Definition, Ledger/Budget Structure and Summary period   
Fiscal Period is required if Statistic has Ledger Type or Budget Structures without Summary Schedule   
There is more than one Statistic Line with the same Company ([company]), Plan ([name]) and Worktag ([wtags]) Values   
 
Validation Description
Statistic already exists.   
top
 

Response Element: Put_Statistic_Response

Element containing the response for a Statistic when adding or updating
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Statistic_Reference  StatisticObject  [0..1]  Statistic Reference   
top
 

StatisticObject

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

StatisticObjectID

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

part of: Put_Statistic_Request
Element containing Statistics data
 
Parameter name Type/Value Cardinality Description Validations
Statistic_ID  string  [0..1]  Statistic ID   
Statistic_Definition_Reference  Statistic_DefinitionObject  [1..1]  Statistic Definition Reference   
Ledger_Budget_Structure_Statistic_Reference  Financial_Entry_TypeObject  [0..*]  Ledger / Budget Structure of Statistic Reference 
Validation Description
Enter either Ledger Type or Budget Structures for Ledger Budget Structure Statistic Reference, not both  Enter either Ledger Type or Budget Structures for Ledger Budget Structure Statistic Reference, not both 
All Budget Structures should have same Entry (by Summary or by Period)  All Budget Structures should have same Entry (by Summary or by Period) 
All Budget Structures by summary should have same summary schedule  All Budget Structures by summary should have same summary schedule 
Ledger / Budget Structure values of Statistic must be among Ledger / Budget Structures of Statistic Definition  Ledger / Budget Structure values of Statistic must be among Ledger / Budget Structures of Statistic Definition 
Statistic must have a value for Ledger Budget Structure Reference if Statistic Definition does not have Actuals. Edit the Statistic Definition to include Actuals or Input a value for Statistic's Ledger Budget Structure Reference.   
 
Fiscal_Period_Reference_Data  Fiscal_Period_Reference_Data  [0..1]  Fiscal Period Reference   
Fiscal_Summary_Year_Reference  Fiscal_YearObject  [0..1]  Fiscal Summary Year Reference 
Validation Description
Fiscal Year for Summary must be among Fiscal year values based on Fiscal schedule of Statistic definition   
Fiscal Summary Year is required if Budget Structure(s) have Summary schedule   
Fiscal Summary Year cannot be entered if Budget Structure(s) do not have Summary schedule   
 
Fiscal_Summary_Interval_Reference  Fiscal_Summary_IntervalObject  [0..1]  Fiscal Summary Interval Reference 
Validation Description
Fiscal Summary Interval cannot be entered if Budget Structure(s) do not have Summary schedule  Fiscal Summary Interval cannot be entered if Budget Structure(s) do not have Summary schedule 
Fiscal Summary Interval is required if Budget Structure(s) have Summary schedule  Fiscal Summary Interval is required if Budget Structure(s) have Summary schedule 
Fiscal Summary Interval must be among allowed values based on Summary schedule of Budget Structure(s) of Statistic   
 
Statistic_Memo  string  [0..1]  Statistic Memo   
Statistic_Values_Replacement_Data  Statistic_Line_Data  [0..*]  Statistic Values Reference, which includes Company (if the Statistics Definition requires it), required dimensions as worktags, and line values. If Company is not included, it should not be included in the line data. 
Validation Description
Company is required if Statistic Definition includes Company.  Company is required if Statistic Definition includes Company. 
Company cannot be entered if Statistic Definition does not include Company.  Company cannot be entered if Statistic Definition does not include Company. 
A Worktag is required for each dimension configured.  A Worktag is required for each dimension configured. 
Only one worktag for each type is allowed for each statistic.  Only one worktag for each type is allowed for each statistic. 
Use Worktags for required or optional dimensions.   
Enter Worktags for each Required Dimension.   
The following worktags are not allowed: [non-allowed worktags message]   
[Text for Non Allowed Worktags and Company Combinations]   
 
Attachment_Data  Financials_Attachment_Data  [0..*]  Attachment Data 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Validation Description
Values must sum to 100% since this statistic definition is percent-based.  Values must sum to 100% since this statistic definition is percent-based. 
Statistic Definition may not be changed on existing Statistic with configured dimensions.  Statistic Definition may not be changed on existing Statistic with configured dimensions. 
A Fiscal Period does not exist for the year and posting interval provided   
More than one Statistic exists for this Statistic Definition, Ledger/Budget Structure and Period.   
More than one Statistic exists for this Statistic Definition, Ledger/Budget Structure and Summary period   
Fiscal Period is required if Statistic has Ledger Type or Budget Structures without Summary Schedule   
There is more than one Statistic Line with the same Company ([company]), Plan ([name]) and Worktag ([wtags]) Values   
top
 

Statistic_DefinitionObject

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

Financial_Entry_TypeObject

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

Financial_Entry_TypeObjectID

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

Fiscal_Period_Reference_Data

part of: Statistic_Data
Element containing Fiscal Posting Interval and Fiscal Year references
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Year_Reference  Fiscal_YearObject  [1..1]  Fiscal Year Reference   
Fiscal_Posting_Interval_Reference  Fiscal_Posting_IntervalObject  [1..1]  Fiscal Posting Interval Reference   
top
 

Fiscal_YearObject

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

Fiscal_YearObjectID

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

Fiscal_Posting_IntervalObject

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

Fiscal_Posting_IntervalObjectID

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

Fiscal_Summary_IntervalObject

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

Fiscal_Summary_IntervalObjectID

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

part of: Statistic_Data
Element containing data for the statistic lines associated with a Statistic
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company. This value is required if the Statistic Definition requires Company and is not allowed if the Statistic Definition does not require Company.   
Budget_Name_Reference  Financial_BudgetObject  [0..1]  Custom Budget Name Reference 
Validation Description
Budget Name must be among Budget Names of the Custom Period Budget Structures of Statistic   
Budget Name cannot be supplied if Statistic has no Budget Structures with Custom Time Period   
 
Statistic_Line_Value  decimal (18, 6)   [0..1]  Statistic Line Value. If the Statistic Type is percent-based, these values must sum to 100%.   
Worktag_Reference  Accounting_WorktagObject  [1..*]  Worktag Reference includes one of each required Dimension, identified at the Statistic Definition   
Validation Description
Company is required if Statistic Definition includes Company.  Company is required if Statistic Definition includes Company. 
Company cannot be entered if Statistic Definition does not include Company.  Company cannot be entered if Statistic Definition does not include Company. 
A Worktag is required for each dimension configured.  A Worktag is required for each dimension configured. 
Only one worktag for each type is allowed for each statistic.  Only one worktag for each type is allowed for each statistic. 
Use Worktags for required or optional dimensions.   
Enter Worktags for each Required Dimension.   
The following worktags are not allowed: [non-allowed worktags message]   
[Text for Non Allowed Worktags and Company Combinations]   
top
 

CompanyObject

part of: Statistic_Line_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_BudgetObject

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

Financial_BudgetObjectID

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

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
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, Alternate_Supplier_Contract_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_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_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_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_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_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_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_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_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
 

Financials_Attachment_Data

part of: Statistic_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

StatisticReferenceEnumeration

part of: StatisticObjectID
Base Type
string
top
 

Statistic_DefinitionReferenceEnumeration

part of: Statistic_DefinitionObjectID
Base Type
string
top
 

Financial_Entry_TypeReferenceEnumeration

part of: Financial_Entry_TypeObjectID
Base Type
string
top
 

Fiscal_YearReferenceEnumeration

part of: Fiscal_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Fiscal_Posting_IntervalReferenceEnumeration

part of: Fiscal_Posting_IntervalObjectID
Base Type
string
top
 

Fiscal_Summary_IntervalReferenceEnumeration

part of: Fiscal_Summary_IntervalObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Financial_BudgetReferenceEnumeration

part of: Financial_BudgetObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top