Service Directory > v31.2 > Resource_Management > Put_Company_Asset_Book_Restrictions
 

Operation: Put_Company_Asset_Book_Restrictions

You can put or replace Company Asset Book Restrictions for company asset books. Company Asset Book Restrictions are ordered; you can specify Spend Category or Hierarchy, Restricted to Books and Asset Book for Primary Asset Book Override based on Company. If rules are subsequently sent with matching ID, the rules are updated.


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

Root element for the Request on the Company Asset Book Restrictions operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Ensure that the request will not delete or modify any existing Company Asset Book Restrictions.   
Company_Asset_Book_Restriction_Data  Company_Asset_Book_Restrictions_Data  [0..1]  Create, update, or delete Company Asset Book Restrictions for specified Company.   
top
 

Response Element: Put_Company_Asset_Book_Restrictions_Response

Element containing the Company for Company Asset Book Restrictions and all its corresponding Company Asset Book Restrictions
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Company_Reference  CompanyObject  [0..1]  Company   
Company_Asset_Book_Restriction_Data  Company_Asset_Book_Restriction_Data_Response  [0..*]  Responds with the IDs of the created or updated Company Asset Book Restrictions.   
top
 

Company_Asset_Book_Restrictions_Data

part of: Put_Company_Asset_Book_Restrictions_Request
Element for create, update, or delete Company Asset Book Restrictions by Company.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Company reference for company asset book restrictions   
Company_Asset_Book_Restriction_Replacement_Data  Company_Asset_Book_Restriction_Replacement_Data  [0..*]  Element containing Company Asset Book Restriction replacement data. 
Validation Description
Valid ID must be provided when Delete flag is set.  Valid ID must be provided when Delete flag is set. 
Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction.  Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction. 
Primary Book Override must be included within Restricted to Books.  Primary Book Override must be included within Restricted to Books. 
[missing required parm] is required to create or update a Company Asset Book Restriction.  Company Asset Book Restriction Order, Restrict to Books Reference, and Primary Asset Book Reference are required to create or update a Company Asset Book Restriction. 
The Company Asset Book Restriction cannot be updated, it does not match the Company of the request.  The Company Asset Book Restriction cannot be updated, it does not match the Company of the request. 
The specified Asset Book is not configured for the Company.  The specified Asset Book is not configured for the Company. 
Primary Book Override must be the Primary Book if specified within Restricted to Books.  Primary Book Override must be the Primary Book if specified within Restricted to Books. 
Primary Book Override must be an accounting book.   
You can only select Supplier Contract types that have Receive Contract Lines.   
You can only select ROU Depreciation Expense for the Lease Accounting Method.   
 
top
 

CompanyObject

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

CompanyObjectID

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

Company_Asset_Book_Restriction_Replacement_Data

part of: Company_Asset_Book_Restrictions_Data
Element containing Company Asset Book Restriction replacement data.
 
Parameter name Type/Value Cardinality Description Validations
Delete  boolean  [0..1]  Flag indicating the referenced Company Asset Book Restriction should be deleted from the Company.   
ID  string  [0..1]  This is a unique reference identifier to the set of Company Asset Book Restrictions.   
Company_Asset_Book_Restriction_Order  string  [0..1]  Used to define the order of the rules (ascending). 
Validation Description
A Company Asset Book Restriction with this order already exists.   
 
Spend_Category_or_Hierarchy_Reference  Spend_Category_or_HierarchyObject  [0..*]  Reference to Spend Categories or Hierarchies for a Company Asset Book Restriction.   
Supplier_Contract_Type_Reference  Supplier_Contract_TypeObject  [0..*]  Reference to Supplier Contract Types for a Company Asset Book Restriction.   
Lease_Accounting_Method_Reference  Lease_Accounting_MethodObject  [0..*]  Reference to Lease Accounting Methods for a Company Asset Book Restriction.   
Restrict_to_Asset_Book_Reference  Asset_BookObject  [0..*]  Reference to the restricted books for a company asset book restriction   
Primary_Asset_Book_Override_Reference  Asset_BookObject  [0..1]  Reference to the primary override for a company asset book restriction   
Validation Description
Valid ID must be provided when Delete flag is set.  Valid ID must be provided when Delete flag is set. 
Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction.  Add Only Flag is set and ID already exists for Company Asset Book Restriction. Use a unique ID to create a Company Asset Book Restriction. 
Primary Book Override must be included within Restricted to Books.  Primary Book Override must be included within Restricted to Books. 
[missing required parm] is required to create or update a Company Asset Book Restriction.  Company Asset Book Restriction Order, Restrict to Books Reference, and Primary Asset Book Reference are required to create or update a Company Asset Book Restriction. 
The Company Asset Book Restriction cannot be updated, it does not match the Company of the request.  The Company Asset Book Restriction cannot be updated, it does not match the Company of the request. 
The specified Asset Book is not configured for the Company.  The specified Asset Book is not configured for the Company. 
Primary Book Override must be the Primary Book if specified within Restricted to Books.  Primary Book Override must be the Primary Book if specified within Restricted to Books. 
Primary Book Override must be an accounting book.   
You can only select Supplier Contract types that have Receive Contract Lines.   
You can only select ROU Depreciation Expense for the Lease Accounting Method.   
top
 

Spend_Category_or_HierarchyObject

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

Supplier_Contract_TypeObject

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

Supplier_Contract_TypeObjectID

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

Lease_Accounting_MethodObject

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

Lease_Accounting_MethodObjectID

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

part of: Company_Asset_Book_Restriction_Replacement_Data, Company_Asset_Book_Restriction_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_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
 

Company_Asset_Book_Restriction_Data_Response

part of: Put_Company_Asset_Book_Restrictions_Response
Responds with the IDs of the created or updated Company Asset Book Restrictions.
 
Parameter name Type/Value Cardinality Description Validations
ID_Reference  string  [0..1]  ID of the created or updated Company Asset Book Restriction.   
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Spend_Category_or_HierarchyReferenceEnumeration

part of: Spend_Category_or_HierarchyObjectID
Base Type
string
top
 

Supplier_Contract_TypeReferenceEnumeration

part of: Supplier_Contract_TypeObjectID
Base Type
string
top
 

Lease_Accounting_MethodReferenceEnumeration

part of: Lease_Accounting_MethodObjectID
Base Type
string
top
 

Asset_BookReferenceEnumeration

part of: Asset_BookObjectID
Base Type
string
top