Service Directory > v31.2 > Revenue_Management > Get_Facilities_and_Administration_Revenue_Allocation_Profiles
 

Operation: Get_Facilities_and_Administration_Revenue_Allocation_Profiles

This web service operation retrieves facilities and administration revenue allocation profiles, including profile ID, profile name, cost share, revenue distribution percent, worktag type reference, and worktag reference.


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

Facilities and administration revenue allocation profiles request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Facilities_and_Administration_Revenue_Allocation_Profile_Request_References  [0..1]  The element for facilities and administration revenue allocation profile request references.   
Request_Criteria [Choice]   Facilities_and_Administration_Revenue_Allocation_Profile_Request_Criteria  [0..1]  The element containing data for facilities and administration revenue allocation profile request criteria. There is no parameter implemented yet.   
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  Facilities_and_Administration_Revenue_Allocation_Profile_Response_Group  [0..1]  Response group that helps filter the information you want returned.   
top
 

Response Element: Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Response

The element containing facilities and administration revenue allocation profile request result.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Facilities_and_Administration_Revenue_Allocation_Profile_Request_References  [0..1]  The request element used to get facilities and administration revenue allocation profiles.   
Request_Criteria  Facilities_and_Administration_Revenue_Allocation_Profile_Request_Criteria  [0..1]  The element containing data for facilities and administration revenue allocation profile request criteria. There is no parameter implemented yet.   
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  Facilities_and_Administration_Revenue_Allocation_Profile_Response_Group  [0..1]  Revenue Allocation Profile Response Group   
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  Facilities_and_Administration_Revenue_Allocation_Profile_Response_Data  [0..1]  The element containing facilities and administration revenue allocation profile response data for requested references or criteria.   
top
 

Facilities_and_Administration_Revenue_Allocation_Profile_Request_References

part of: Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Request, Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Response
The request element used to get facilities and administration revenue allocation profiles.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Cost_Accounting_Rule_Reference  Facilities_and_Admin_Revenue_Allocation_ProfileObject  [1..*]  Utilize the Request References to retrieve a specific instance or instances of facilities and administration revenue allocation profile and the data.   
top
 

Facilities_and_Admin_Revenue_Allocation_ProfileObject

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

Facilities_and_Admin_Revenue_Allocation_ProfileObjectID

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

Facilities_and_Administration_Revenue_Allocation_Profile_Request_Criteria

part of: Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Request, Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Response
The element containing data for facilities and administration revenue allocation profile request criteria. There is no parameter implemented yet.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Request, Get_Facilities_and_Administration_Revenue_Allocation_Profiles_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
 

Facilities_and_Administration_Revenue_Allocation_Profile_Response_Group

part of: Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Request, Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Response
Revenue Allocation Profile Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  A boolean flag indicating if facilities and administration revenue allocation profile reference is to be included in the response.   
top
 

Response_Results

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

Facilities_and_Administration_Revenue_Allocation_Profile_Response_Data

part of: Get_Facilities_and_Administration_Revenue_Allocation_Profiles_Response
The element containing facilities and administration revenue allocation profile response data for requested references or criteria.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Revenue_Allocation_Profile  Facilities_and_Administration_Revenue_Allocation_Profile  [0..*]  The element containing a facilities and administration revenue allocation reference and all data for the single facilities and administration revenue allocation profile.   
top
 

Facilities_and_Administration_Revenue_Allocation_Profile

part of: Facilities_and_Administration_Revenue_Allocation_Profile_Response_Data
The element containing a facilities and administration revenue allocation reference and all data for the single facilities and administration revenue allocation profile.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Revenue_Allocation_Profile_Reference  Facilities_and_Admin_Revenue_Allocation_ProfileObject  [0..1]  The facilities and administration revenue allocation profile for which data is returned.   
Facilities_and_Administration_Revenue_Allocation_Profile_Data  Facilities_and_Admin_Revenue_Allocation_Profile_Data  [0..*]  Contains all references and attributes to represent a complete facilities and administration revenue allocation profile. 
Validation Description
An existing Facilities and Administration Revenue Allocation Profile already has the same name.   
Total Percent must equal 100.   
 
top
 

Facilities_and_Admin_Revenue_Allocation_Profile_Data

part of: Facilities_and_Administration_Revenue_Allocation_Profile
The element containing all references and attributes to represent a complete Facilities and Administration Revenue Allocation Profile.
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Revenue_Allocation_Profile_ID  string  [0..1]  Reference ID. This is the facilities and administration revenue allocation profile unique identifier.   
Facilities_and_Administration_Revenue_Allocation_Profile_Name  string  [1..1]  The facilities and administration revenue allocation profile name   
Generate_Facilities_and_Administration_Cost_Share  boolean  [0..1]  A boolean flag indicating if the profile is for generating facilities and administration cost share.   
Facilities_and_Admin_Revenue_Distribution_Data  Facilities_and_Admin_Revenue_Distribution_Data  [0..*]  The element containing facilities and administration revenue distribution percent and worktag offset override data 
Validation Description
Each Revenue Distribution must include a Worktag Override for the Worktag Type: Fund   
 
Validation Description
An existing Facilities and Administration Revenue Allocation Profile already has the same name.   
Total Percent must equal 100.   
top
 

Facilities_and_Admin_Revenue_Distribution_Data

part of: Facilities_and_Admin_Revenue_Allocation_Profile_Data
The element containing facilities and administration revenue distribution percent and worktag offset override data
 
Parameter name Type/Value Cardinality Description Validations
Facilities_and_Administration_Revenue_Distribution_Percent  decimal (18, 6) >0   [1..1]  The total allocation distribution percentage must equal to 100.   
Facilities_and_Admin_Worktag_Offset_Override_Data  Facilities_and_Admin_Revenue_Worktag_Offset_Override_Data  [0..*]  The element containing Accounting Worktag Type Reference and Worktag Reference. 
Validation Description
The Balancing Worktag Type: [balancingWT] must not be left blank.   
 
Validation Description
Each Revenue Distribution must include a Worktag Override for the Worktag Type: Fund   
top
 

Facilities_and_Admin_Revenue_Worktag_Offset_Override_Data

part of: Facilities_and_Admin_Revenue_Distribution_Data
The element containing Accounting Worktag Type Reference and Worktag Reference.
 
Parameter name Type/Value Cardinality Description Validations
Accounting_Worktag_Type_Reference  Accounting_Worktag_TypeObject  [1..1]  Accounting Worktag Type Reference for the worktag offset override 
Validation Description
Select a Type that isn't already in use.   
Accounting Worktag Type: [wtt] is invalid for use on Facilities and Administration Revenue Allocation Distribution   
 
Worktag_Reference  Accounting_WorktagObject  [0..1]  Worktag Reference 
Validation Description
The Accounting Worktag:[worktag] must be for the Accounting Worktag Type:[accounting worktag type].   
Select a Worktag Override for Worktag Type: Fund that doesn't have a fund type funded by a sponsor.   
 
Validation Description
The Balancing Worktag Type: [balancingWT] must not be left blank.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Facilities_and_Admin_Revenue_Allocation_ProfileReferenceEnumeration

part of: Facilities_and_Admin_Revenue_Allocation_ProfileObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top