Service Directory > v31.2 > Financial_Management > Put_Spend_Restriction
 

Operation: Put_Spend_Restriction

This web service operation will add or update a specified Spend Restriction.


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

Element containing Spend Restriction reference and 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. If an existing instance is found and this flag is set there will be an error.   
Spend_Restriction_Reference  Spend_RestrictionObject  [0..1]  Spend Restriction reference for update.   
Spend_Restriction_Data  Spend_Restriction_Data  [1..1]  Spend Restriction Data 
Validation Description
You must enter an object class set when the restriction type is Object Class.   
Object class set can only be entered if the restriction type is Object Class.   
You must select 1 or more restrictions.   
Object class can only be entered if the restriction type is Object Class.   
Spend category hierarchy, spend category, and pay component group can only be entered if the restriction type is Spend Category and Pay Component Group.   
 
Validation Description
Add Only is set to true. You can not submit a reference to update. Please remove the Add Only flag for updating.   
top
 

Response Element: Put_Spend_Restriction_Response

Response element for Spend Restriction put request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Spend_Restriction_Reference  Spend_RestrictionObject  [0..1]  Reference to Spend Restriction that was added or updated.   
top
 

Spend_RestrictionObject

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

Spend_RestrictionObjectID

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

Spend_Restriction_Data

part of: Put_Spend_Restriction_Request
Element containing Spend Restriction data.
 
Parameter name Type/Value Cardinality Description Validations
Spend_Restriction_Name  string  [1..1]  Spend Restriction name.   
Spend_Restriction_Reference_ID  string  [0..1]  Reference to an existing Spend Restriction for update only purposes.   
Inactive  boolean  [0..1]  Boolean flag to indicate Spend Restriction is inactive.   
Allowable_Costs [Choice]   boolean  [1..1]  Boolean flag to indicate Spend Restriction contains allowable costs.   
Unallowable_Costs [Choice]   boolean  [1..1]  Boolean flag to indicate Spend Restriction contains unallowable costs.   
Spend_Restriction_Type_Reference  Spend_Restriction_TypeObject  [1..1]  Spend Restriction Type reference.   
Object_Class_Set_Reference  Object_Class_SetObject  [0..1]  Object Class Set reference.   
Spend_Category_Hierarchies_Reference  Spend_Category_HierarchyObject  [0..*]  Spend Category Hierarchies reference.   
Spend_Categories_Reference  Spend_CategoryObject  [0..*]  Spend Categories reference.   
Pay_Component_Groups_Reference  Pay_Component_Group__All_Object  [0..*]  Earning Codes reference.   
Object_Classes_Reference  Object_ClassObject  [0..*]  Object Classes reference.   
Validation Description
You must enter an object class set when the restriction type is Object Class.   
Object class set can only be entered if the restriction type is Object Class.   
You must select 1 or more restrictions.   
Object class can only be entered if the restriction type is Object Class.   
Spend category hierarchy, spend category, and pay component group can only be entered if the restriction type is Spend Category and Pay Component Group.   
top
 

Spend_Restriction_TypeObject

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

Spend_Restriction_TypeObjectID

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

Object_Class_SetObject

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

Object_Class_SetObjectID

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

Spend_Category_HierarchyObject

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

Spend_Category_HierarchyObjectID

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

Spend_CategoryObject

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

Spend_CategoryObjectID

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

Pay_Component_Group__All_Object

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

Pay_Component_Group__All_ObjectID

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

Object_ClassObject

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

Object_ClassObjectID

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

Spend_RestrictionReferenceEnumeration

part of: Spend_RestrictionObjectID
Base Type
string
top
 

Spend_Restriction_TypeReferenceEnumeration

part of: Spend_Restriction_TypeObjectID
Base Type
string
top
 

Object_Class_SetReferenceEnumeration

part of: Object_Class_SetObjectID
Base Type
string
top
 

Spend_Category_HierarchyReferenceEnumeration

part of: Spend_Category_HierarchyObjectID
Base Type
string
top
 

Spend_CategoryReferenceEnumeration

part of: Spend_CategoryObjectID
Base Type
string
top
 

Pay_Component_Group__All_ReferenceEnumeration

part of: Pay_Component_Group__All_ObjectID
Base Type
string
top
 

Object_ClassReferenceEnumeration

part of: Object_ClassObjectID
Base Type
string
top