Service Directory > v31.2 > Financial_Management > Get_Funding_Source_Rules
 

Operation: Get_Funding_Source_Rules

This service operation will get funding source rules for the specified criteria.


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

Get Funding Source Rules Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Funding_Source_Rule_Request_References  [0..1]  Funding Source Rule Request References   
Request_Criteria [Choice]   Funding_Source_Rule_Request_Criteria  [0..1]  Funding Source Rule 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. 
 
top
 

Response Element: Get_Funding_Source_Rules_Response

Get Funding Source Rules Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Funding_Source_Rule_Request_References  [0..*]  Funding Source Rule 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  Funding_Source_Rule_Response_Data  [0..*]  Funding Source Rule Response   
top
 

Funding_Source_Rule_Request_References

part of: Get_Funding_Source_Rules_Request, Get_Funding_Source_Rules_Response
Funding Source Rule Request References
 
Parameter name Type/Value Cardinality Description Validations
Funding_Source_Rule_Reference  Funding_Source_RuleObject  [1..*]  Funding Source Rule Reference   
top
 

Funding_Source_RuleObject

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

Funding_Source_RuleObjectID

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

Funding_Source_Rule_Request_Criteria

part of: Get_Funding_Source_Rules_Request
Funding Source Rule Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Project_Reference  Project_and_Project_Hierarchy_AbstractObject  [0..*]  Project   
Company_Reference  OrganizationObject  [0..*]  Company   
Evaluation_Date_Option_Reference  Evaluation_DateObject  [0..*]  Evaluation Date Option   
Default_Funding_Source_Reference  Default_Funding_SourceObject  [0..*]  Default Funding Source   
Inactive  boolean  [0..1]  Inactive   
Funding_Source_Reference  Abstract_Funding_SourceObject  [0..*]  Funding Source   
top
 

Project_and_Project_Hierarchy_AbstractObject

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

Project_and_Project_Hierarchy_AbstractObjectID

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

Evaluation_DateObject

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

Evaluation_DateObjectID

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

Default_Funding_SourceObject

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

Default_Funding_SourceObjectID

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

Abstract_Funding_SourceObject

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

Abstract_Funding_SourceObjectID

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

Funding_Source_Rule_Response_Data

part of: Get_Funding_Source_Rules_Response
Funding Source Rule Response
 
Parameter name Type/Value Cardinality Description Validations
Funding_Source_Rule  Funding_Source_Rule  [0..*]  Funding Source Rule Response Data   
top
 

Funding_Source_Rule

part of: Funding_Source_Rule_Response_Data
Funding Source Rule Response Data
 
Parameter name Type/Value Cardinality Description Validations
Funding_Source_Rule_Reference  Funding_Source_RuleObject  [0..1]  Funding Source Rule   
Funding_Source_Rule_Data  Funding_Source_Rule_Data  [0..1]  Funding Source Rule Data   
top
 

Funding_Source_Rule_Data

part of: Funding_Source_Rule
Funding Source Rule Data
 
Parameter name Type/Value Cardinality Description Validations
Funding_Source_Rule_ID  string  [0..1]  Funding Source Rule ID   
Project_or_Project_Hierarchy_Reference  Project_and_Project_Hierarchy_AbstractObject  [1..1]  Projects or Project Hierarchy 
Validation Description
The project or project hierarchy is already assigned to a funding source rule.   
 
Company_or_Company_Hierarchy_Reference  OrganizationObject  [1..1]  Company or Company Hierarchy   
Description  string  [0..1]  Description   
Evaluation_Date_Option_Reference  Evaluation_DateObject  [1..1]  Evaluation Date Option   
Default_Funding_Source_Reference  Default_Funding_SourceObject  [1..1]  Default Funding Source   
Inactive  boolean  [0..1]  Inactive   
Funding_Source_Priority_Data  Funding_Source_Priority_Data  [0..*]  Funding Source Priority Data   
top
 

Funding_Source_Priority_Data

part of: Funding_Source_Rule_Data
Funding Source Priority Data
 
Parameter name Type/Value Cardinality Description Validations
Evaluation_Order  string  [0..1]  Evaluation Order   
Description  string  [0..1]  Description   
Funding_Source_Priority_Section_Data  Funding_Source_Priority_Section_Data  [0..*]  Funding Source Priority Section Data 
Validation Description
Funding source percentages within a priority must total 100%.   
Funding Source Priority Section cannot contain duplicate funding sources.   
You must select funding sources within Priorities that use the same Currency.   
 
top
 

Funding_Source_Priority_Section_Data

part of: Funding_Source_Priority_Data
Funding Source Priority Section Data
 
Parameter name Type/Value Cardinality Description Validations
Funding_Source_Reference  Abstract_Funding_SourceObject  [1..1]  Funding Source 
Validation Description
Funding sources must be owned by the selected company or by a company in the selected hierarchy.   
 
Percentage  decimal (14, 4) >0   [1..1]  Percentage 
Validation Description
The percentage can't be greater than the maximum contribution percentage of the funding source.   
 
Current_Available_Balance  decimal (18, 6)   [0..1]  Current Available Balance   
top
 

Funding_Source_RuleReferenceEnumeration

part of: Funding_Source_RuleObjectID
Base Type
string
top
 

Project_and_Project_Hierarchy_AbstractReferenceEnumeration

part of: Project_and_Project_Hierarchy_AbstractObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Evaluation_DateReferenceEnumeration

part of: Evaluation_DateObjectID
Base Type
string
top
 

Default_Funding_SourceReferenceEnumeration

part of: Default_Funding_SourceObjectID
Base Type
string
top
 

Abstract_Funding_SourceReferenceEnumeration

part of: Abstract_Funding_SourceObjectID
Base Type
string
top