Service Directory > v32.1 > Financial_Management > Get_Ledgers
 

Operation: Get_Ledgers

This web service returns all related ledger information for an existing company.


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

Request element for Get Ledger Details WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Ledger_Details_Request_Reference  [1..1]  Container for request reference data   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Ledgers_Response

Response element for Get Ledger Details WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Ledger_Details_Request_Reference  [0..*]  Container for request reference data   
Response_Filter  Response_Filter  [0..*]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..*]  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.   
Response_Data  Ledger_Response_Data__Public_  [0..*]  Response Data for Request   
top
 

Ledger_Details_Request_Reference

part of: Get_Ledgers_Request, Get_Ledgers_Response
Container for request reference data
 
Parameter name Type/Value Cardinality Description Validations
Actuals_Ledger_Reference  LedgerObject  [1..*]  Reference to an existing Actuals Ledger   
top
 

LedgerObject

part of: Obligation_Ledger_Data__Public_, Commitment_Ledger_Data__Public_, Ledger_Details_Request_Reference, Ledger__Public_
 
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  LedgerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

LedgerObjectID

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

Response_Filter

part of: Get_Ledgers_Request, Get_Ledgers_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
 

Response_Results

part of: Get_Ledgers_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_Response_Data__Public_

part of: Get_Ledgers_Response
Container for Response Data
 
Parameter name Type/Value Cardinality Description Validations
Ledger  Ledger__Public_  [0..*]  Data relating to the specific ledger being retrieved.   
top
 

Ledger__Public_

part of: Ledger_Response_Data__Public_
Container for ledger data
 
Parameter name Type/Value Cardinality Description Validations
Actuals_Ledger_Reference  LedgerObject  [0..1]  Reference to an existing Actuals Ledger   
Ledger_Data  Ledger_Only_Data  [0..*]  Data for Put Ledger Details 
Validation Description
A ledger does not exist for the company and ledger type provided, but the company already has a ledger. A company can only have one ledger and the type can not be updated.   
If Payroll Commitments are enabled, then Payroll Obligations must also be enabled.   
If Procurement Commitments are enabled, then Procurement Obligations must also be enabled.   
If you choose to create commitment or obligation ledgers, the View Budget Date flag must be set to true.   
The Ledger Type must be an Actuals Type.   
If Fringe Benefit Obligations are enabled, then Payroll Obligations must also be enabled.   
If Fringe Benefit Commitments are enabled, then Fringe Benefit Obligations, Payroll Obligations, and Payroll Commitments must all be enabled.   
Expenses Obligation should not be enabled.   
If you have commitment or obligation ledgers, the View Budget Date flag must be set to true.   
You must enable the Commitment ledger before you can enable ledger period roll forward or create journal entries.   
You must enable the Obligation ledger before you can enable ledger period roll forward or create journal entries.   
To enable Ledger Period Roll Forward for Procurement, you must also enable Create Journal Entries for Procurement.   
To enable Ledger Period Roll Forward for Procurement, you must also enable Create Journal Entries for Procurement.   
 
top
 

Ledger_Only_Data

part of: Ledger__Public_
Data for Put Ledger Details
 
Parameter name Type/Value Cardinality Description Validations
Actuals_Ledger_ID  string  [0..1]  ID for Ledger 
Validation Description
The Ledger for [ID] does not match the Ledger Type or Company provided in the request.   
 
Company_Reference  CompanyObject  [1..1]  Reference to an existing Company   
Actuals_Ledger_Type_Reference  Ledger_TypeObject  [1..1]  Reference to an existing Ledger Type   
Can_View_Budget_Date  boolean  [0..1]  If the Budget Date can be viewed for Journal Line   
Commitment_Ledger_Data  Commitment_Ledger_Data__Public_  [0..*]  Data relating to Commitment Ledger 
Validation Description
The Commitment Ledger for this Ledger Type Group is unnamed and cannot be created.   
Once enabled, you can't disable the Commitment Ledger.   
 
Obligation_Ledger_Data  Obligation_Ledger_Data__Public_  [0..*]  Data relating to Obligation Ledger 
Validation Description
The Obligation Ledger for this Ledger Type Group is unnamed and cannot be created.   
Once enabled, you can't disable the Obligation Ledger.   
 
Validation Description
A ledger does not exist for the company and ledger type provided, but the company already has a ledger. A company can only have one ledger and the type can not be updated.   
If Payroll Commitments are enabled, then Payroll Obligations must also be enabled.   
If Procurement Commitments are enabled, then Procurement Obligations must also be enabled.   
If you choose to create commitment or obligation ledgers, the View Budget Date flag must be set to true.   
The Ledger Type must be an Actuals Type.   
If Fringe Benefit Obligations are enabled, then Payroll Obligations must also be enabled.   
If Fringe Benefit Commitments are enabled, then Fringe Benefit Obligations, Payroll Obligations, and Payroll Commitments must all be enabled.   
Expenses Obligation should not be enabled.   
If you have commitment or obligation ledgers, the View Budget Date flag must be set to true.   
You must enable the Commitment ledger before you can enable ledger period roll forward or create journal entries.   
You must enable the Obligation ledger before you can enable ledger period roll forward or create journal entries.   
To enable Ledger Period Roll Forward for Procurement, you must also enable Create Journal Entries for Procurement.   
To enable Ledger Period Roll Forward for Procurement, you must also enable Create Journal Entries for Procurement.   
top
 

CompanyObject

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

Ledger_TypeObject

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

Ledger_TypeObjectID

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

Commitment_Ledger_Data__Public_

part of: Ledger_Only_Data
Data relating to Commitment Ledger
 
Parameter name Type/Value Cardinality Description Validations
Commitment_Ledger_Reference  LedgerObject  [0..1]  Reference to an existing Commitment Ledger   
Enable_Commitment_Ledger  boolean  [0..1]  Whether to enable a Commitment Ledger   
Spend_Transaction_Data  Spend_Transaction_Data  [0..1]  Container for information relating to Spend Transactions 
Validation Description
Invalid Spend Transaction.   
 
Payroll_Transaction_Data  Payroll_Transaction_Data__Public_  [0..1]  Container for information relating to Payroll Transactions 
Validation Description
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Commitment for Payroll Transactions for the commitment ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Obligation for Payroll Transactions for the obligation ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Obligation for Fringe Benefits for the obligation ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Commitment for Fringe Benefits for the commitment ledger.   
 
Validation Description
The Commitment Ledger for this Ledger Type Group is unnamed and cannot be created.   
Once enabled, you can't disable the Commitment Ledger.   
top
 

Spend_Transaction_Data

part of: Obligation_Ledger_Data__Public_, Commitment_Ledger_Data__Public_
Container for information relating to Spend Transactions
 
Parameter name Type/Value Cardinality Description Validations
Create_Journal_Entries_for_Procurement  boolean  [0..1]  Whether to Create relevant Journal Entries for Procurement   
Create_Journal_Entries_for_Expenses  boolean  [0..1]  Whether to Create relevant Journal Entries for Expenses   
Ledger_Period_Roll_Forward_for_Procurement  boolean  [0..1]  Whether Journals posted to a Closed Period Should Roll Over to the Next Open Period   
Validation Description
Invalid Spend Transaction.   
top
 

Payroll_Transaction_Data__Public_

part of: Obligation_Ledger_Data__Public_, Commitment_Ledger_Data__Public_
Container for information relating to Payroll Transactions
 
Parameter name Type/Value Cardinality Description Validations
Create_Journal_Entries_for_Payroll_Transactions  boolean  [0..1]  Whether to create relevant Journal Entries for Payroll Transactions   
Create_Journal_Entries_for_Fringe_Benefits  boolean  [0..1]  Whether to create relevant Journal Entries for Fringe Benefits   
Validation Description
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Commitment for Payroll Transactions for the commitment ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Obligation for Payroll Transactions for the obligation ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Obligation for Fringe Benefits for the obligation ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Commitment for Fringe Benefits for the commitment ledger.   
top
 

Obligation_Ledger_Data__Public_

part of: Ledger_Only_Data
Data relating to Commitment Ledger
 
Parameter name Type/Value Cardinality Description Validations
Obligation_Ledger_Reference  LedgerObject  [0..1]  Reference to an existing Obligation Ledger   
Enable_Obligation_Ledger  boolean  [0..1]  Whether to enable an Obligation Ledger   
Spend_Transaction_Data  Spend_Transaction_Data  [0..1]  Container for information relating to Spend Transactions 
Validation Description
Invalid Spend Transaction.   
 
Payroll_Transaction_Data  Payroll_Transaction_Data__Public_  [0..1]  Container for information relating to Payroll Transactions 
Validation Description
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Commitment for Payroll Transactions for the commitment ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Obligation for Payroll Transactions for the obligation ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Obligation for Fringe Benefits for the obligation ledger.   
Select Require Job Requisitions for all Position Management staffing events option on the Tenant Setup - HCM task under the Job Requisitions section before you enable Commitment for Fringe Benefits for the commitment ledger.   
 
Validation Description
The Obligation Ledger for this Ledger Type Group is unnamed and cannot be created.   
Once enabled, you can't disable the Obligation Ledger.   
top
 

LedgerReferenceEnumeration

part of: LedgerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Ledger_TypeReferenceEnumeration

part of: Ledger_TypeObjectID
Base Type
string
top