Service Directory > v31.2 > Financial_Management > Get_Journal_Sources
 

Operation: Get_Journal_Sources

You can view Journal Sources using this Web Service Task


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

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Journal_Source_Request_References  [0..1]  The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.   
Request_Criteria [Choice]   Journal_Source_Request_Criteria  [0..1]  Request Criteria for Journal Source   
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. 
 
Response_Group  Journal_Source_Response_Group  [0..1]  The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.   
top
 

Response Element: Get_Journal_Sources_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Journal_Source_Request_References  [0..1]  The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.   
Request_Criteria  Journal_Source_Request_Criteria  [0..1]  Request Criteria   
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. 
 
Response_Group  Journal_Source_Response_Group  [0..1]  The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.   
Response_Results  Response_Results  [0..1]  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  Journal_Source_Response_Data  [0..1]  Journal Source Response Data   
top
 

Journal_Source_Request_References

part of: Get_Journal_Sources_Request, Get_Journal_Sources_Response
The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.
 
Parameter name Type/Value Cardinality Description Validations
Journal_Source_Reference  Journal_SourceObject  [1..*]  Journal Source Request Reference   
top
 

Journal_SourceObject

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

Journal_SourceObjectID

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

Journal_Source_Request_Criteria

part of: Get_Journal_Sources_Request, Get_Journal_Sources_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Journal_Sources_Request, Get_Journal_Sources_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
 

Journal_Source_Response_Group

part of: Get_Journal_Sources_Request, Get_Journal_Sources_Response
The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Account Posting Rule Set Reference data is to be included in the response.   
top
 

Response_Results

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

Journal_Source_Response_Data

part of: Get_Journal_Sources_Response
Journal Source Response Data
 
Parameter name Type/Value Cardinality Description Validations
Journal_Source  Journal_Source  [0..*]  Journal Source Datra   
top
 

Journal_Source

part of: Journal_Source_Response_Data
Journal Source Response Data
 
Parameter name Type/Value Cardinality Description Validations
Journal_Source_Reference  Journal_SourceObject  [0..1]  Journal Source Reference   
Journal_Source_Data  Journal_Source_Data  [0..*]  Journal Source Data 
Validation Description
Process Award Costs can only be selected when Accounting Source is selected.   
You must select Enable Suspense Processing for Web Service if you want to enter a Suspense Threshold Percent when submitting or importing the accounting journal.   
You must select Accounting Source if you want to Enable Suspense Processing when submitting or importing accounting journals   
 
top
 

Journal_Source_Data

part of: Journal_Source
Journal Source Data
 
Parameter name Type/Value Cardinality Description Validations
Journal_Source_ID  string  [0..1]  Journal Source ID   
Journal_Source_Name  string  [0..1]  Journal Source Name 
Validation Description
Enter a unique Journal Source Name. [name] is already in use.  The Journal Source Name is already in use. 
 
Source_For_Accounting_Journal  boolean  [0..1]  Source for Accounting Journal   
Process_Award_Costs  boolean  [0..1]  Process Award Costs   
Source_For_Ad_Hoc_Bank_Transaction  boolean  [0..1]  Source For Ad Hoc Bank Transaction   
Enable_Suspense_Processing_for_Web_Service  boolean  [0..1]  Enable Suspense Processing for Web Service   
Suspense_Threshold_Percent  decimal (2, 0) >0   [0..1]  Suspense Threshold Percent   
Source_For_Workday_Operational_Journal  boolean  [0..1]  Source For Workday Operational Journal   
Validation Description
Process Award Costs can only be selected when Accounting Source is selected.   
You must select Enable Suspense Processing for Web Service if you want to enter a Suspense Threshold Percent when submitting or importing the accounting journal.   
You must select Accounting Source if you want to Enable Suspense Processing when submitting or importing accounting journals   
top
 

Journal_SourceReferenceEnumeration

part of: Journal_SourceObjectID
Base Type
string
top