Service Directory > v32.1 > Financial_Management > Get_Ledger_Year_and_Ledger_Periods
 

Operation: Get_Ledger_Year_and_Ledger_Periods

This web service returns ledger years and ledger periods for a fiscal year on 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_Ledger_Year_and_Ledger_Periods_Request

Request element for Put Ledger Year and Ledger Periods WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Ledger_Year_and_Periods_Request_Reference  [1..1]  Request References   
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_Ledger_Year_and_Ledger_Periods_Response

Response element for Get Ledger Year and Ledger Periods WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Ledger_Year_and_Periods_Request_Reference  [0..*]  Request References   
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_Year_and_Periods_Response_Data  [0..*]  Response Data for Ledger Year and Ledger Periods   
top
 

Ledger_Year_and_Periods_Request_Reference

part of: Get_Ledger_Year_and_Ledger_Periods_Response, Get_Ledger_Year_and_Ledger_Periods_Request
Request References
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  OrganizationObject  [1..1]  Reference to an existing Company   
Fiscal_Year_Reference  Fiscal_YearObject  [1..1]  Reference to a fiscal year   
top
 

OrganizationObject

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

Fiscal_YearObject

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

Response_Filter

part of: Get_Ledger_Year_and_Ledger_Periods_Response, Get_Ledger_Year_and_Ledger_Periods_Request
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_Ledger_Year_and_Ledger_Periods_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_Year_and_Periods_Response_Data

part of: Get_Ledger_Year_and_Ledger_Periods_Response
Response Data for Ledger Year and Ledger Periods
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Data  Ledger_Year_Data_Container  [0..*]  Ledger Year Data   
top
 

Ledger_Year_Data_Container

part of: Ledger_Year_and_Periods_Response_Data
Container for Ledger Year Data
 
Parameter name Type/Value Cardinality Description Validations
Ledger_Year_Reference  Unique_IdentifierObject  [0..1]  Reference to an existing instance of Ledger Year   
Ledger_Year_Data  Ledger_Year_Data__Public_  [0..*]  Ledger Year Data   
top
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

part of: Ledger_Year_Data_Container
Ledger Year Data
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Year_Reference  Schedule_YearObject  [1..1]  Reference to a fiscal year 
Validation Description
[schedule] is not valid for these companies: [company].   
 
Ledger_Year_Status_Reference  Ledger_Year_StatusObject  [0..1]  Reference to a Ledger Year status 
Validation Description
Ledger Year Status Reference cannot be entered in the request.   
 
Ledger_Period_Data  Ledger_Period_Data__Public_  [0..*]  Ledger Period Data   
top
 

Schedule_YearObject

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

Schedule_YearObjectID

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

Ledger_Year_StatusObject

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

Ledger_Year_StatusObjectID

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

Ledger_Period_Data__Public_

part of: Ledger_Year_Data__Public_
Ledger Period Data
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Period_Reference_Data  Fiscal_Period_Reference__Public_  [0..1]  Fiscal Period Reference Data (non-enterable)   
Ledger_Period_Status_Reference  Ledger_Period_StatusObject  [0..1]  Reference to a Ledger Period Status (non-enterable) 
Validation Description
Ledger Period Status Reference cannot be entered in the request.   
 
Closed_Activity_Reference  Period_Close_Activity_Group__Tenanted_Object  [0..*]  Reference to Closed Activity (non-enterable) 
Validation Description
Closed Activity Reference cannot be entered in the request.   
When ledger period status is 'Close in Progress', Closed Activity is required. Closed Activity is not allowed for any other ledger period status.   
 
top
 

Fiscal_Period_Reference__Public_

part of: Ledger_Period_Data__Public_
Fiscal Period Reference Data (non-enterable)
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Posting_Interval_Reference  Fiscal_Posting_IntervalObject  [1..1]  Reference to a Fiscal Posting Interval (non-enterable) 
Validation Description
Fiscal Period does not exist.   
Fiscal Posting Interval Reference cannot be entered in the request.   
 
top
 

Fiscal_Posting_IntervalObject

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

Ledger_Period_StatusObject

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

Ledger_Period_StatusObjectID

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

Period_Close_Activity_Group__Tenanted_Object

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

Period_Close_Activity_Group__Tenanted_ObjectID

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

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Fiscal_YearReferenceEnumeration

part of: Fiscal_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Schedule_YearReferenceEnumeration

part of: Schedule_YearObjectID
Base Type
string
top
 

Base Type
string

top
 

Ledger_Year_StatusReferenceEnumeration

part of: Ledger_Year_StatusObjectID
Base Type
string
top
 

Fiscal_Posting_IntervalReferenceEnumeration

part of: Fiscal_Posting_IntervalObjectID
Base Type
string
top
 

Ledger_Period_StatusReferenceEnumeration

part of: Ledger_Period_StatusObjectID
Base Type
string
top
 

Period_Close_Activity_Group__Tenanted_ReferenceEnumeration

part of: Period_Close_Activity_Group__Tenanted_ObjectID
Base Type
string
top