Service Directory > v31.2 > Financial_Management > Put_Allocation_Group_Set
 

Operation: Put_Allocation_Group_Set

This service will put an Allocation Group Set


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

Element containing Allocation Group Set for update
 
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.   
Allocation_Group_Set_Reference  Allocation_Group_SetObject  [0..1]  A Reference to an existing Allocation Group Set   
Allocation_Group_Set_Data  Allocation_Group_Set_Data  [1..1]  Contains the detailed information about an Allocation Group Set 
Validation Description
Enter an Allocation Group Set Name that isn't already in use.  The allocation group set name has already been used. 
All companies on Allocation Group Set must share the same Fiscal Schedule.  All companies on Allocation Group Set must share the same Fiscal Schedule. 
Fiscal Schedule of the Fiscal Summary Schedule must match the Fiscal Schedule of the companies on the Allocation Group Set.   
Fiscal Summary Interval is not allowed unless the time frame is Summary.  Fiscal Summary Interval is not allowed unless the time frame is Summary. 
Fiscal Summary Schedule is required if Time Frame is summary.   
Enter the Actuals ledger or a financial budget structure for the company.   
Only one value is allowed when Actuals or Budget Structure with Custom Period is selected.   
Reference IDs for Allocation Groups must be unique.  Reference IDs for Allocation Groups must be unique. 
Dependent Allocation Groups must be part of the Allocation Group Set.  Dependent Allocation Groups must be part of the Allocation Group Set. 
 
Validation Description
The Web Service is set to Add Only; but the Allocation Group Set already exists.   
top
 

Response Element: Put_Allocation_Group_Set_Response

Element containing Put Allocation Group Set Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Allocation_Group_Set_Reference  Allocation_Group_SetObject  [0..1]  Reference to an existing Allocation Group Set   
top
 

Allocation_Group_SetObject

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

Allocation_Group_SetObjectID

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

Allocation_Group_Set_Data

part of: Put_Allocation_Group_Set_Request
Contains the detailed information about an Allocation Group Set
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Set_ID  string  [0..1]  The ID for Allocation Group Set   
Allocation_Group_Set_Name  string  [1..1]  Text attribute identifying Allocation Group Set Name   
Allocation_Group_Set_Description  string  [0..1]  Text attribute identifying Allocation Group Set description   
Organization_Reference  OrganizationObject  [1..*]  A Reference to the Organization used by the Group Set   
Allocation_Time_Frame_Reference  Financial_Time_FrameObject  [1..1]  A Reference to the Financial Time Frame used by the Group Set   
Fiscal_Summary_Schedule_Reference  Fiscal_Summary_ScheduleObject  [0..1]  A Reference to the Fiscal Summary Schedule used by the Group Set   
Ledger_or_Budget_Structure_Reference  Financial_Entry_TypeObject  [0..*]  A Reference to the Ledger or Budget Structure used by the Group Set   
Inactive  boolean  [0..1]  A flag to determine if this Allocation Group Set is active or not.   
Allocation_Group_Data  Allocation_Group_Subedit_Data  [0..*]  Encapsulates the Allocation Group Data 
Validation Description
The Allocation Group ID provided does not belong to the Allocation Group Set  The Allocation Group ID provided does not belong to the Allocation Group Set 
An Allocation Group cannot be dependent on itself.  An Allocation Group cannot be dependent on itself. 
Dependent allocation definitions must belong to the same allocation group.  Dependent allocation definitions must belong to the same allocation group. 
 
Validation Description
Enter an Allocation Group Set Name that isn't already in use.  The allocation group set name has already been used. 
All companies on Allocation Group Set must share the same Fiscal Schedule.  All companies on Allocation Group Set must share the same Fiscal Schedule. 
Fiscal Schedule of the Fiscal Summary Schedule must match the Fiscal Schedule of the companies on the Allocation Group Set.   
Fiscal Summary Interval is not allowed unless the time frame is Summary.  Fiscal Summary Interval is not allowed unless the time frame is Summary. 
Fiscal Summary Schedule is required if Time Frame is summary.   
Enter the Actuals ledger or a financial budget structure for the company.   
Only one value is allowed when Actuals or Budget Structure with Custom Period is selected.   
Reference IDs for Allocation Groups must be unique.  Reference IDs for Allocation Groups must be unique. 
Dependent Allocation Groups must be part of the Allocation Group Set.  Dependent Allocation Groups must be part of the Allocation Group Set. 
top
 

OrganizationObject

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

Financial_Time_FrameObject

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

Financial_Time_FrameObjectID

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

Fiscal_Summary_ScheduleObject

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

Fiscal_Summary_ScheduleObjectID

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

Financial_Entry_TypeObject

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

Financial_Entry_TypeObjectID

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

Allocation_Group_Subedit_Data

part of: Allocation_Group_Set_Data
Encapsulates the Allocation Group Data
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_ID  string  [0..1]  The ID for the Allocation Group   
Order  string (6)   [1..1]  Text Attribute identifying Allocation Group Set Order   
Allocation_Group_Set_Name  string  [1..1]  Text Attribute identifying Allocation Group Name   
Allocation_Group_Dependency_ID  string  [0..1]  Text Attribute Identifying Allocation Group Dependency ID   
Allocation_Group_Line_Data  Allocation_Group_Line_Subedit_Data  [0..*]  Encapsulates the Allocation Group Set Line Data 
Validation Description
Allocation Definition is not valid for Company : [company]   
Allocation Definitions can only be included on one active Allocation Group Set   
 
Validation Description
The Allocation Group ID provided does not belong to the Allocation Group Set  The Allocation Group ID provided does not belong to the Allocation Group Set 
An Allocation Group cannot be dependent on itself.  An Allocation Group cannot be dependent on itself. 
Dependent allocation definitions must belong to the same allocation group.  Dependent allocation definitions must belong to the same allocation group. 
top
 

Allocation_Group_Line_Subedit_Data

part of: Allocation_Group_Subedit_Data
Encapsulates Allocation Group Line Data
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Line_ID  string  [0..1]  The ID For the Line Allocation Group   
Display_Order  string (6)   [1..1]  Text attribute identifying the Order of the Allocation Group   
Allocation_Definition_Reference  Allocation_DefinitionObject  [1..1]  A Reference to the Allocation Definition used in the Allocation Group   
Dependent_Allocation_Definition_Reference  Allocation_DefinitionObject  [0..*]  A Reference to the Dependent Allocation Definition   
Budget_Structure_Reference  Budget_StructureObject  [0..1]  A Reference to the Budget Structure used by the Allocation Group Line   
Validation Description
Allocation Definition is not valid for Company : [company]   
Allocation Definitions can only be included on one active Allocation Group Set   
top
 

Allocation_DefinitionObject

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

Allocation_DefinitionObjectID

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

Budget_StructureObject

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

Budget_StructureObjectID

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

Allocation_Group_SetReferenceEnumeration

part of: Allocation_Group_SetObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Financial_Time_FrameReferenceEnumeration

part of: Financial_Time_FrameObjectID
Base Type
string
top
 

Fiscal_Summary_ScheduleReferenceEnumeration

part of: Fiscal_Summary_ScheduleObjectID
Base Type
string
top
 

Financial_Entry_TypeReferenceEnumeration

part of: Financial_Entry_TypeObjectID
Base Type
string
top
 

Allocation_DefinitionReferenceEnumeration

part of: Allocation_DefinitionObjectID
Base Type
string
top
 

Budget_StructureReferenceEnumeration

part of: Budget_StructureObjectID
Base Type
string
top