Service Directory > v32.1 > Financial_Management > Get_Ledger_Account_Summaries
 

Operation: Get_Ledger_Account_Summaries

This Web Service will return Ledger Account Summaries, included Ledger Accounts and indirectly included accounts depending on Response Group setting. To Return All Ledger Accounts (indirectly included) set the Response Group 'Include All Ledger Account Data'


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

Get Ledger Account Summary Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Ledger_Account_Summary_Request_References  [0..1]  Get Ledger Account Summaries Request   
Request_Criteria [Choice]   Ledger_Account_Summary_Request_Criteria  [0..1]  Get Ledger Account Summaries Request   
Response_Filter  Response_Filter  [0..1]  Get Ledger Account Summary Request 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Ledger_Account_Summary_Response_Group  [0..1]  Get Ledger Account Summaries Request Response Group   
top
 

Response Element: Get_Ledger_Account_Summaries_Response

Ledger Account Summaries Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Ledger_Account_Summary_Request_References  [0..1]  Get Ledger Account Summaries Response for Request References   
Request_Criteria  Ledger_Account_Summary_Request_Criteria  [0..1]  Get Ledger Account Summaries Response for Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Ledger Account Summaries Response-Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Ledger_Account_Summary_Response_Group  [0..1]  Get Ledger Account Summaries Response-Ledger Account Summaries Response Group   
Response_Results  Response_Results  [0..1]  Get Ledger Account Summaries Response-Response Results   
Response_Data  Ledger_Account_Summary_Response_Data  [0..1]  Get Ledger Account Summaries Response-Ledger Account Summaries Response Data   
top
 

Ledger_Account_Summary_Request_References

part of: Get_Ledger_Account_Summary_Request, Get_Ledger_Account_Summaries_Response
Element containing reference instances for a Ledger Account Summary
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Account_Summary_Reference  Ledger_Account_SummaryObject  [1..*]  Ledger Account Summaries Request References   
top
 

Ledger_Account_SummaryObject

part of: Ledger_Account_Summary_Data, Ledger_Account_Summary_Request_References, Ledger_Account_Summary
 
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  Ledger_Account_SummaryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Ledger_Account_SummaryObjectID

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

Ledger_Account_Summary_Request_Criteria

part of: Get_Ledger_Account_Summary_Request, Get_Ledger_Account_Summaries_Response
Element containing Ledger Account Summary request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Ledger_Account_Summary_Request, Get_Ledger_Account_Summaries_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Ledger_Account_Summary_Response_Group

part of: Get_Ledger_Account_Summary_Request, Get_Ledger_Account_Summaries_Response
Element containing Ledger Account Summary response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Ledger Account Summaries Response Group-include Reference   
Include_All_Ledger_Account_Data  boolean  [0..1]  Ledger Account Summaries Response Group-Include All Ledger Account Data   
top
 

Response_Results

part of: Get_Ledger_Account_Summaries_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Ledger_Account_Summary_Response_Data

part of: Get_Ledger_Account_Summaries_Response
Wrapper Element that includes Ledger Account Summary Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Account_Summary  Ledger_Account_Summary  [0..*]  Ledger Account Summaries Response Data-Ledger Account Summaries   
top
 

Ledger_Account_Summary

part of: Ledger_Account_Summary_Response_Data
Ledger Account Summaries data returned from Request
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Account_Summary_Reference  Ledger_Account_SummaryObject  [0..1]  Ledger Account Summaries-Ledger Account Summary for Ledger Account Summary   
Ledger_Account_Summary_Data  Ledger_Account_Summary_Data  [0..*]  Ledger Account Summaries-Ledger Account Summaries Data 
Validation Description
The Account Set of all Ledger Account Summaries must be the same.  The Account Set of all Ledger Account Summaries must be the same. 
This Ledger Account Summary contains overlapping Ledger Account ranges. Please modify the From Value or the To Value on one or more contained Ledger Account ranges so they do not overlap with each other.  The included Ledger Account ranges must not overlap with each other in a Ledger Account Summary. 
The Account Set of the Ledger Accounts and the Ledger Summary must be the same.  The Account Set of the Ledger Accounts and the Ledger Summary must be the same. 
A hierarchy structure has been defined for this ledger account summary. Please delete the hierarchy structure before including it as a child of this ledger account summary.  A hierarchy structure has been defined for this ledger account summary. Please delete the hierarchy structure before including it as a child of this ledger account summary. 
Ledger Account Summaries included must be exclusively of Income Statement Type Accounts where the Ledger Account Summary is in use by a Business Plan Year.   
Ledger Account Summaries included must be exclusively of Income Statement Type Accounts where the Ledger Account Summary is in use by a Business Plan Year.   
A top-level Hierarchy Structure exists and is enforced for this Ledger Account Summary. Please unenforce the top-level Hierarchy Structure first before changing the Hierarchy Level for this Ledger Account Summary.   
A top-level Hierarchy Structure exists and is enforced for this Ledger Account Summary. Please unenforce the top-level Hierarchy Structure first before changing the included Ledger Account Summaries.   
A ledger account cannot belong to more than one ledger account summary that rolls up to the highest level in the hierarchy. The following ledger accounts are included in specific ledger accounts or are included in account ranges in other ledger account summaries: [Ledger Accounts with issues] Please update the ledger account summary to ensure that each ledger account belongs to one ledger account summary.   
"[name]" is already in use in "[ledger account summary]" on "[date]". Enter a unique Summary Name for the Account Set.   
Effective Date must be greater than equal to 01/01/1900   
A Ledger Account Summary cannot be included in itself. This might be a result of an included Ledger Account Summary several levels down.   
A Ledger Account Summary cannot belong to more than one parent Ledger Summary that rolls up to the highest level in the hierarchy. The following Ledger Account Summaries are present in more than one parent Ledger Account Summary: [comma separated duplicate ledger account summaries] Please update the Ledger Account Summaries to ensure that each Ledger Account Summary belongs to one parent Ledger Account Summary.   
A future effective dated ledger account summary cannot be included in the current ledger account summary. The following future effective dated ledger account summaries are included in the current ledger account summary: [comma separated Ledger Account Summaries] Please update the effective date of the above ledger account summaries before including them in the current ledger account summary.   
An account range in one ledger account summary cannot overlap with another ledger account summary that rolls up to the highest level in the hierarchy. The following ledger account summaries have overlapping account ranges: [comma separated overlapping ranges ledger account summaries with date] Please update the ledger account summaries to ensure that account ranges do not overlap.   
 
All_Ledger_Account_Data  All_Ledger_Account_Data  [0..*]  Ledger Account Summaries-All Ledger Account Data   
top
 

Ledger_Account_Summary_Data

part of: Ledger_Account_Summary
Wrapper Element that includes Ledger Account Summary Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Account_Summary_ID  string  [0..1]  Ledger Account Summaries Data   
Effective_Date  date  [0..1]  Effective Date   
Ledger_Account_Summary_Name  string  [1..1]  Ledger Account Summaries Data-Ledger Account Summary Name   
Account_Set_Reference  Account_SetObject  [1..1]  Ledger Account Summaries Data-Ledger Account Summary.defined for Account Set Required Field 
Validation Description
A Ledger Account Summary can only be created for Chart of Account Account Sets. Please verify that you are using the correct Account Set for the Ledger Account Summary, or that the Account Set is correctly marked as a Chart of Accounts.  A Ledger Account Summary can only be created for Chart of Account Account Sets. Please verify that you are using the correct Account Set for the Ledger Account Summary, or that the Account Set is correctly marked as a Chart of Accounts. 
 
Hierarchy_Level_Reference  Hierarchy_LevelObject  [0..1]  Reference to an existing Hierarchy Level valid for Ledger Account Summaries. 
Validation Description
Hierarchy Level is not valid for Ledger Account Summary.  Hierarchy Level needs to be valid for Ledger Account Summary. 
 
Ledger_Account_Summary_Reference  Ledger_Account_SummaryObject  [0..*]  Ledger Account Summaries Data-Ledger Account Summaries for Report Group   
Included_Ledger_Account_Reference  Ledger_AccountObject  [0..*]  Included Ledger Accounts   
Included_Ledger_Account_Range_Data  Ledger_Account_Range_Data  [0..*]  Included Ledger Account Ranges 
Validation Description
The From Value cannot be larger than the To Value. From Value: [from] To Value: [to]  The To Value must be larger than the From Value. 
 
Validation Description
The Account Set of all Ledger Account Summaries must be the same.  The Account Set of all Ledger Account Summaries must be the same. 
This Ledger Account Summary contains overlapping Ledger Account ranges. Please modify the From Value or the To Value on one or more contained Ledger Account ranges so they do not overlap with each other.  The included Ledger Account ranges must not overlap with each other in a Ledger Account Summary. 
The Account Set of the Ledger Accounts and the Ledger Summary must be the same.  The Account Set of the Ledger Accounts and the Ledger Summary must be the same. 
A hierarchy structure has been defined for this ledger account summary. Please delete the hierarchy structure before including it as a child of this ledger account summary.  A hierarchy structure has been defined for this ledger account summary. Please delete the hierarchy structure before including it as a child of this ledger account summary. 
Ledger Account Summaries included must be exclusively of Income Statement Type Accounts where the Ledger Account Summary is in use by a Business Plan Year.   
Ledger Account Summaries included must be exclusively of Income Statement Type Accounts where the Ledger Account Summary is in use by a Business Plan Year.   
A top-level Hierarchy Structure exists and is enforced for this Ledger Account Summary. Please unenforce the top-level Hierarchy Structure first before changing the Hierarchy Level for this Ledger Account Summary.   
A top-level Hierarchy Structure exists and is enforced for this Ledger Account Summary. Please unenforce the top-level Hierarchy Structure first before changing the included Ledger Account Summaries.   
A ledger account cannot belong to more than one ledger account summary that rolls up to the highest level in the hierarchy. The following ledger accounts are included in specific ledger accounts or are included in account ranges in other ledger account summaries: [Ledger Accounts with issues] Please update the ledger account summary to ensure that each ledger account belongs to one ledger account summary.   
"[name]" is already in use in "[ledger account summary]" on "[date]". Enter a unique Summary Name for the Account Set.   
Effective Date must be greater than equal to 01/01/1900   
A Ledger Account Summary cannot be included in itself. This might be a result of an included Ledger Account Summary several levels down.   
A Ledger Account Summary cannot belong to more than one parent Ledger Summary that rolls up to the highest level in the hierarchy. The following Ledger Account Summaries are present in more than one parent Ledger Account Summary: [comma separated duplicate ledger account summaries] Please update the Ledger Account Summaries to ensure that each Ledger Account Summary belongs to one parent Ledger Account Summary.   
A future effective dated ledger account summary cannot be included in the current ledger account summary. The following future effective dated ledger account summaries are included in the current ledger account summary: [comma separated Ledger Account Summaries] Please update the effective date of the above ledger account summaries before including them in the current ledger account summary.   
An account range in one ledger account summary cannot overlap with another ledger account summary that rolls up to the highest level in the hierarchy. The following ledger account summaries have overlapping account ranges: [comma separated overlapping ranges ledger account summaries with date] Please update the ledger account summaries to ensure that account ranges do not overlap.   
top
 

Account_SetObject

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

Account_SetObjectID

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

Hierarchy_LevelObject

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

Hierarchy_LevelObjectID

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

Ledger_AccountObject

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

Ledger_AccountObjectID

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

Ledger_Account_Range_Data

part of: Ledger_Account_Summary_Data
Included Ledger Account Ranges
 
Parameter name Type/Value Cardinality Description Validations
From_Value  string  [1..1]  Ledger Account From Value   
To_Value  string  [1..1]  Ledger Account To Value   
Validation Description
The From Value cannot be larger than the To Value. From Value: [from] To Value: [to]  The To Value must be larger than the From Value. 
top
 

All_Ledger_Account_Data

part of: Ledger_Account_Summary
All directly and indirectly included Ledger Accounts
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Account_Included_Reference  Ledger_AccountObject  [0..*]  All Ledger Account Data-Ledger Accounts Included By Ledger Account Summary   
top
 

Ledger_Account_SummaryReferenceEnumeration

part of: Ledger_Account_SummaryObjectID
Base Type
string
top
 

Base Type
string

top
 

Account_SetReferenceEnumeration

part of: Account_SetObjectID
Base Type
string
top
 

Hierarchy_LevelReferenceEnumeration

part of: Hierarchy_LevelObjectID
Base Type
string
top
 

Ledger_AccountReferenceEnumeration

part of: Ledger_AccountObjectID
Base Type
string
top
 

Base Type
string

top