Service Directory > v31.2 > Financial_Management > Get_Account_Sets
 

Operation: Get_Account_Sets

This service operation will get Account Sets for the specified criteria. This service will return the Account Set, the Ledger Accounts included in the Account Set, any included Account Sets, and the Chart of Accounts designation. The request criteria can be for a single transaction based on Reference, or all transactions can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Account Set data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Account_Set_Request_References  [0..1]  Get Account Sets Request References   
Request_Criteria [Choice]   Account_Set_Request_Criteria  [0..1]  Get Account Sets Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Account Sets Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Account_Set_Response_Group  [0..1]  Get Account Sets Response Group   
top
 

Response Element: Get_Account_Sets_Response

Element containing Account Set response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Account_Set_Request_References  [0..1]  Get Account Sets Request References   
Request_Criteria  Account_Set_Request_Criteria  [0..1]  Get Account Sets Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Account Sets Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Account_Set_Response_Group  [0..1]  Get Account Sets Response Group   
Response_Results  Response_Results  [0..1]  Get Account Sets Response Results   
Response_Data  Account_Set_Response_Data  [0..1]  Get Account Sets Response Data   
top
 

Account_Set_Request_References

part of: Get_Account_Sets_Request, Get_Account_Sets_Response
Element containing reference instances for a Account Set
 
Parameter name Type/Value Cardinality Description Validations
Account_Set_Reference  Account_SetObject  [1..*]  Reference to an existing Account Set   
top
 

Account_SetObject

part of: Account_Set_Data, Account_Set_Request_References, Account_Set
 
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
 

Account_Set_Request_Criteria

part of: Get_Account_Sets_Request, Get_Account_Sets_Response
Element containing Account Set request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Account_Sets_Request, Get_Account_Sets_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
 

Account_Set_Response_Group

part of: Get_Account_Sets_Request, Get_Account_Sets_Response
Element containing Account Set response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Account_Set_Response_Data

part of: Get_Account_Sets_Response
Wrapper Element that includes Account Set Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Account_Set  Account_Set  [0..*]  Account Set Data   
top
 

Account_Set

part of: Account_Set_Response_Data
Wrapper Element that includes Account Set Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Account_Set_Reference  Account_SetObject  [0..1]  Reference to an existing Account Set   
Account_Set_Data  Account_Set_Data  [0..*]  Account Set Data 
Validation Description
An account set cannot be included in itself.  An account set cannot be included in itself. 
 
top
 

Account_Set_Data

part of: Account_Set
Element containing all Account Set data
 
Parameter name Type/Value Cardinality Description Validations
Account_Set_ID  string  [0..1]  Account Set Reference ID. This is the Account Set unique identifier   
Account_Set_Name  string  [1..1]  Account Set Name 
Validation Description
The Account Set Name has already been used. Please select a new one.  The Account Set Name has already been used. Please select a new one. 
 
Chart_of_Accounts  boolean  [0..1]  Boolean flag indicating if this account set is the Chart of Accounts   
Account_Set_Reference  Account_SetObject  [0..*]  Reference to an existing Account Set   
Ledger_Account_Data  Ledger_Account_Data  [0..*]  Ledger Account Data. An Account Set can contain multiple Ledger Accounts. 
Validation Description
A Ledger Account already exists in that Account Set with the same Ledger Name and a different Ledger ID.  A Ledger Account already exists in that Account Set with the same Ledger Name and a different Ledger ID. 
There are multiple ledger accounts in this load with the same Ledger Name and Account Set, but have a different Ledger ID.  There are multiple ledger accounts in this load with the same Ledger Name and Account Set, but have a different Ledger ID. 
The Ledger Account Type cannot be switched between Balance Sheet and Income Statement when the Ledger Account is in use.   
 
Validation Description
An account set cannot be included in itself.  An account set cannot be included in itself. 
top
 

Ledger_Account_Data

part of: Account_Set_Data
Element containing all Ledger Account data
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Account_Identifier  string  [1..1]  Ledger Account Identifier. The Ledger Account Identifier in combination with the Account Set create the unique identifier for a Ledger Account.   
Ledger_Account_Name  string  [1..1]  Free form text field for the Ledger Account Name   
Ledger_Account_Type_Reference  Ledger_Account_TypeObject  [1..1]  Reference to an existing Ledger Account Type   
Retired  boolean  [0..1]  Boolean flag indicating if the Ledger Account should be (for put) or has been (for get) retired.   
Restricted_To_Company_or_Hierarchy_Reference  OrganizationObject  [0..*]  The set of companies or company hierarchies to which this ledger account is restricted. This ledger account may not be used by any company or hierarchy that is not in this set.   
Validation Description
A Ledger Account already exists in that Account Set with the same Ledger Name and a different Ledger ID.  A Ledger Account already exists in that Account Set with the same Ledger Name and a different Ledger ID. 
There are multiple ledger accounts in this load with the same Ledger Name and Account Set, but have a different Ledger ID.  There are multiple ledger accounts in this load with the same Ledger Name and Account Set, but have a different Ledger ID. 
The Ledger Account Type cannot be switched between Balance Sheet and Income Statement when the Ledger Account is in use.   
top
 

Ledger_Account_TypeObject

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

Ledger_Account_TypeObjectID

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

OrganizationObject

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

OrganizationObjectID

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

Account_SetReferenceEnumeration

part of: Account_SetObjectID
Base Type
string
top
 

Ledger_Account_TypeReferenceEnumeration

part of: Ledger_Account_TypeObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top