Service Directory > v32.1 > Financial_Management > Put_Fund_Hierarchy
 

Operation: Put_Fund_Hierarchy

This service operation will add or update Fund Hierarchies. This operation will allow the addition of an existing Fund Hierarchy as the superior and the addition of existing Funds as subordinates.


@ - 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: Put_Fund_Hierarchy_Request

Element containing Fund Hierarchy reference for update and all Fund Hierarchy data items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Fund_Hierarchy_Reference  Fund_HierarchyObject  [0..1]  Reference to an existing Fund Hierarchy   
Fund_Hierarchy_Data  Fund_Hierarchy_Data  [0..*]  Fund Hierarchy Data 
Validation Description
Funds cannot be used more than once in a single hierarchy. Please change the Parent or modify the Funds to Include. (Funds: [fund])   
Parent Fund Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the parent hierarchy or select a new one.   
This Fund Hierarchy cannot be inactivated because it has active subordinates.   
An inactive Fund Hierarchy cannot be assigned as the superior of a Fund Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
 
Validation Description
Fund Hierarchy exists where Web Service is set to Add Only.   
Fund Hierarchy Name matches a Fund Hierarchy Name in an existing Fund Hierarchy. Change Fund Hierarchy Name.   
top
 

Response Element: Put_Fund_Hierarchy_Response

Element containing Put Fund Hierarchy Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Fund_Hierarchy_Reference  Fund_HierarchyObject  [0..1]  Reference to an existing Fund Hierarchy   
top
 

Fund_HierarchyObject

part of: Fund_Hierarchy_Data, Put_Fund_Hierarchy_Request, Put_Fund_Hierarchy_Response
 
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  Fund_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Fund_HierarchyObjectID

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

Fund_Hierarchy_Data

part of: Put_Fund_Hierarchy_Request
Element containing all Fund Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
Fund_Hierarchy_ID  string  [0..1]  Fund Hierarchy Reference ID. This is the Fund Hierarchy unique identifier.   
Fund_Hierarchy_Name  string  [1..1]  Fund Hierarchy Name.   
Include_Fund_Hierarchy_ID_in_Name  boolean  [0..1]  Boolean flag which when set to true will include the Fund Hierarchy ID in the Fund Hierarchy Name.   
Fund_Hierarchy_is_Inactive  boolean  [0..1]  Boolean Flag which when set to true Inactivates the Fund Hierarchy.   
Organization_Subtype_Reference  Organization_SubtypeObject  [0..1]  Reference to an existing Organization Subtype valid for Fund Hierarchies. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Parent_Fund_Hierarchy_Reference  Fund_HierarchyObject  [0..1]  Reference to an existing Fund Hierarchy to add as the superior.   
Contains_Funds_Reference  FundObject  [0..*]  Reference to existing Funds to add as the subordinates.   
Validation Description
Funds cannot be used more than once in a single hierarchy. Please change the Parent or modify the Funds to Include. (Funds: [fund])   
Parent Fund Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the parent hierarchy or select a new one.   
This Fund Hierarchy cannot be inactivated because it has active subordinates.   
An inactive Fund Hierarchy cannot be assigned as the superior of a Fund Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
top
 

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

FundObject

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

FundObjectID

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

Fund_HierarchyReferenceEnumeration

part of: Fund_HierarchyObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

FundReferenceEnumeration

part of: FundObjectID
Base Type
string
top