Service Directory > v31.2 > Financial_Management > Get_Loans
 

Operation: Get_Loans

This service operation will get loans. This service will return the Loan and its associated information. The request criteria can be for a single instance based on Reference, or all instances of loans can be retrieved if no Reference is specified.


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

Contains request reference, criteria, filter and response group for getting Loan data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Loan_Request_References  [0..1]  Get Loans Request References   
Request_Criteria [Choice]   Loan_Request_Criteria  [0..1]  Get Loans Request References   
Response_Filter  Response_Filter  [0..1]  Get Loans Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Loans_Response

Element containing Loan response elements including received criteria, references, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Loan_Request_References  [0..1]  Element containing reference instances for a Loan   
Request_Criteria  Loan_Request_Criteria  [0..1]  Element containing Loan 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_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  Loan_Response_Data  [0..1]  Element containing Loan response elements including received criteria, references, results filter and result summary   
top
 

Loan_Request_References

part of: Get_Loans_Request, Get_Loans_Response
References to existing Loans
 
Parameter name Type/Value Cardinality Description Validations
Loan_Reference  LoanObject  [1..*]  Reference to an existing Loan.   
top
 

LoanObject

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

LoanObjectID

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

Loan_Request_Criteria

part of: Get_Loans_Request, Get_Loans_Response
Criteria to get Loans
 
Parameter name Type/Value Cardinality Description Validations
Loan_Number  string  [0..1]  Loan Number   
Customer_Reference  CustomerObject  [0..*]  Customer Reference   
Property_ID  string  [0..1]  Property ID   
Loan_Vintage_Start_Date  date  [0..1]  Loan Vintage Start Date   
Loan_Vintage_End_Date  date  [0..1]  Loan Vintage End Date   
First_Referral_Start_Date  date  [0..1]  First Referral Start Date   
First_Referral_End_Date  date  [0..1]  First Referral End Date   
Referral_Type_Reference  Loan_Referral_TypeObject  [0..*]  Referral Type Reference   
Investor_Type_Reference  Loan_Investor_TypeObject  [0..*]  nvestor Type Reference   
Country_Reference  CountryObject  [0..*]  Country Reference   
Country_Region_Reference  Country_RegionObject  [0..*]  Country Region Reference   
Inactive  boolean  [0..1]  True of False for Inactive Loans   
top
 

CustomerObject

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

CustomerObjectID

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

Loan_Referral_TypeObject

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

Loan_Referral_TypeObjectID

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

Loan_Investor_TypeObject

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

Loan_Investor_TypeObjectID

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

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Country_RegionObject

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

Country_RegionObjectID

part of: Country_RegionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Region_ID, ISO_3166-2_Code  [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_Loans_Request, Get_Loans_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_Loans_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
 

Loan_Response_Data

part of: Get_Loans_Response
Element containing Loan response elements including received criteria, references, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
Loan  Loan  [0..*]  Element containing all Loan Data.   
top
 

Loan

part of: Loan_Response_Data
Wrapper Element that includes Loan Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Loan_Reference  LoanObject  [0..1]  Reference to an existing Loan.   
Loan_Data  Loan_Data  [0..1]  Loan Data 
Validation Description
Invalid Country Region for selected Country.   
 
top
 

Loan_Data

part of: Loan
Element containing all Loan Data.
 
Parameter name Type/Value Cardinality Description Validations
Loan_Number  string  [1..1]  Loan Number   
Customer_Reference  CustomerObject  [0..1]  Customer Reference   
Vintage_Date  date  [0..1]  Vintage Date   
First_Referral_Date  date  [0..1]  First Referral Date   
Property_ID  string  [0..1]  First Referral Date   
Referral_Type_Reference  Loan_Referral_TypeObject  [0..1]  Reference to an existing Referral Type   
Investor_Type_Reference  Loan_Investor_TypeObject  [0..1]  Reference to an existing Investor Type   
Country_Reference  CountryObject  [0..1]  Country Reference   
Country_Region_Reference  Country_RegionObject  [0..1]  Country Region Reference   
Inactive  boolean  [0..1]  Boolean Flag which when set to true inactivates the Loan.   
ID  string  [0..1]  Loan Reference ID. This is the Loan unique identifier.   
Related_Worktags_Data  Related_Worktag_Widget_Data  [0..1]  Reference to the existing Allowed or Default Related Worktags. 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
 
Validation Description
Invalid Country Region for selected Country.   
top
 

Related_Worktag_Widget_Data

part of: Loan_Data
Reference to the existing Allowed or Default Related Worktags.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  All existing related worktags (both allowed and default) are replaced with the ones specified in the request. It will supersede any "remove all" or delete option set to True by worktag type. When True, a default value must be provided for all worktag types that are configured with 'Default Required' in the 'Maintain Related Worktag Usage'.   
Related_Worktags_by_Type_Data  Related_Worktags_by_Worktag_Type_Data  [0..*]  Allowed and Default Related Worktags Data by Worktag Type. 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
top
 

Related_Worktags_by_Worktag_Type_Data

part of: Related_Worktag_Widget_Data
Allowed and Default Related Worktags Data by Worktag Type.
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..1]  The Worktag Type Reference ID cannot be duplicated within one request. Valid ID types for all worktag types that can be configured for a related worktag taggable type may include: BUSINESS_SITE, BUSINESS_UNIT, COST_CENTER, CUSTOM_ORGANIZATION_01-10, CUSTOM_WORKTAG_1-10, FUND, GIFT, GRANT, INVESTOR, OPPORTUNITY, PROGRAM, PROJECT, PROJECT_PHASE, PROJECT_TASK, REGION, SALES_ITEM.   
Required_On_Transaction  boolean  [0..1]  Boolean to indicate if the Worktag Type will be required on a transaction when a value for the worktag type that has related values is entered.   
Required_On_Transaction_For_Validation  boolean  [0..1]  Boolean to indicate if 'Required on Transaction' is enabled in either 'Maintain Related Worktag Usage' or on the Worktag instance. When you generate an EIB template with data, 'y' is returned when either boolean is true. This boolean is informational only in the 'Put' operation.   
Default_Worktag_Data  Default_Worktag_Data  [0..1]  Reference to existing Default Realted Worktag or Add new Default Related Worktag 
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Replace_All_Allowed_Values  boolean  [0..1]  Boolean to indicate that all existing allowed values are to be deleted. When set to true ('y' in EIB), if allowed values are also specified, they will become the new set of allowed values.   
Allowed_Worktag_Data  Allowed_Worktag_Data  [0..*]  Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags 
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
top
 

Accounting_Worktag_TypeObject

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

Default_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Default Realted Worktag or Add new Default Related Worktag
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Default_Value  boolean  [1..1]  Boolean to indicate if existing default value is to be deleted. The existing default value must be correctly specified. Do not set to true (or 'y' in EIB) to replace the existing default value.   
Default_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
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_Hierarchy_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_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_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_Family_Group_ID, Job_Family_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_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_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_Group_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
 

Allowed_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Allowed_Value  boolean  [1..1]  Boolean to indicate that specified allowed values are to be deleted. At least 1 existing allowed value must be specified When set to true (or 'y' in EIB). Cannot be set to true if 'Replace All Allowed Values' is set to true.   
Allowed_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_Hierarchy_ID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

LoanReferenceEnumeration

part of: LoanObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Loan_Referral_TypeReferenceEnumeration

part of: Loan_Referral_TypeObjectID
Base Type
string
top
 

Loan_Investor_TypeReferenceEnumeration

part of: Loan_Investor_TypeObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top