Service Directory > v31.2 > Resource_Management > Put_Asset_Book_Rules
 

Operation: Put_Asset_Book_Rules

This service allows you to put or replace asset book rules for asset books. Asset Book Rules are ordered; you specify Asset Book, Accounting Treatment and Depreciation Profile based on Spend Category, Asset Class, Asset Type, Company, Amount, Currency, and Amount Basis Reference (Unit Amount or Extended Amount). If rules are sent a subsequent time, all rules are replaced.


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

Root element for the Request on the Asset Book Rules operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Enable to ensure that the request will not delete or modify any existing Asset Book Rules.   
Asset_Book_Rule_Data  Asset_Book_Rule_Data  [0..1]  Element containing the Asset Book and all its corresponding Asset Book Rules   
top
 

Response Element: Put_Asset_Book_Rules_Response

Root element for the Response on the Put operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Asset_Book_Reference  Asset_BookObject  [0..1]  Reference to an existing asset book to which the asset book rule data applies   
top
 

Asset_Book_Rule_Data

part of: Put_Asset_Book_Rules_Request
Element containing the Asset Book and all its corresponding Asset Book Rules
 
Parameter name Type/Value Cardinality Description Validations
Asset_Book_Reference  Asset_BookObject  [1..1]  Reference to an asset book to which the asset bool rules apply.   
Asset_Book_Rule_Replacement_Data  Asset_Book_Rule_Replacement_Data  [0..*]  Element containing asset book rule replacement data 
Validation Description
Use another ID for the Asset Book Rule or unset the Add Only attribute. An Asset Book Rule already exists for the ID [ID].  The Put Asset Book Rules web service cannot be used to edit an existing rule; it can only add rules, or replace all rules. 
Rule order must be unique.   
 
top
 

Asset_BookObject

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

Asset_BookObjectID

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

Asset_Book_Rule_Replacement_Data

part of: Asset_Book_Rule_Data
Element containing asset book rule replacement data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  This is a unique reference identifier to the set of asset book rules.   
Asset_Book_Rule_Order  string  [0..1]  Used to define the order of the rules (ascending).   
Spend_Category_or_Hierarchy_Reference  Spend_Category_or_HierarchyObject  [0..*]  Reference to existing spend categories or spend category hierarchies to which the asset book rule applies.   
Asset_Class_Reference  Asset_ClassObject  [0..*]  Reference to existing asset classes to which the asset book rule applies.   
Asset_Type_Reference  Asset_TypeObject  [0..*]  Reference to existing asset types to which the asset book rule applies.   
Company_Reference  OrganizationObject  [0..*]  Reference to existing companies or company hierarchies to which the asset book rule applies. 
Validation Description
One or more companies for a rule for Spend Category ([spend category]) have a company currency that does not match the currency specified.   
 
Currency_Reference  CurrencyObject  [0..1]  Reference to an existing currency to which the asset book rule applies. This is required if Greater than Amount is specified.   
Amount_Threshold  decimal (26, 6)   [0..1]  The amount above which the asset book rule applies.   
Amount_Basis_Reference  Business_Asset_Amount_BasisObject  [0..1]  Reference to UNIT or EXTENDED Amount basis reference. This is required when specifying 'Greater Than Amount'. 
Validation Description
Either amount, currency and amount basis must all be entered, or all three fields must be blank.   
 
Accounting_Treatment_Reference  Accounting_TreatmentObject  [1..1]  Reference to the resulting accounting treatment for the asset book rule. 
Validation Description
When spend category is intangible, asset book rules should return accounting treatment of Depreciable Capital.   
Select a valid accounting treatment. The Inventory Asset accounting treatment isn’t valid for assets.   
 
Depreciation_Profile_Reference  Depreciation_ProfileObject  [0..1]  Reference to the resulting depreciation profile for the asset book rule. 
Validation Description
Depreciation profile is required for depreciable capital accounting treatments. If accounting treatment is expense or non-depreciable capital, then depreciation profile should be blank.   
 
Validation Description
Use another ID for the Asset Book Rule or unset the Add Only attribute. An Asset Book Rule already exists for the ID [ID].  The Put Asset Book Rules web service cannot be used to edit an existing rule; it can only add rules, or replace all rules. 
Rule order must be unique.   
top
 

Spend_Category_or_HierarchyObject

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

Spend_Category_or_HierarchyObjectID

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

Asset_ClassObject

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

Asset_ClassObjectID

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

Asset_TypeObject

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

Asset_TypeObjectID

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

OrganizationObject

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

CurrencyObject

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

CurrencyObjectID

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

Business_Asset_Amount_BasisObject

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

Business_Asset_Amount_BasisObjectID

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

Accounting_TreatmentObject

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

Accounting_TreatmentObjectID

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

Depreciation_ProfileObject

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

Depreciation_ProfileObjectID

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

Asset_BookReferenceEnumeration

part of: Asset_BookObjectID
Base Type
string
top
 

Spend_Category_or_HierarchyReferenceEnumeration

part of: Spend_Category_or_HierarchyObjectID
Base Type
string
top
 

Asset_ClassReferenceEnumeration

part of: Asset_ClassObjectID
Base Type
string
top
 

Asset_TypeReferenceEnumeration

part of: Asset_TypeObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Business_Asset_Amount_BasisReferenceEnumeration

part of: Business_Asset_Amount_BasisObjectID
Base Type
string
top
 

Accounting_TreatmentReferenceEnumeration

part of: Accounting_TreatmentObjectID
Base Type
string
top
 

Depreciation_ProfileReferenceEnumeration

part of: Depreciation_ProfileObjectID
Base Type
string
top