Service Directory > v31.2 > Financial_Management > Get_Lease_Contract_Book_Code_Configurations
 

Operation: Get_Lease_Contract_Book_Code_Configurations

You can view existing Lease Contract Book Configurations using this web service task


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

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Lease_Contract_Book_Code_Configuration_Request_References  [0..1]  The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.   
Request_Criteria [Choice]   Lease_Contract_Book_Code_Configuration_Request_Criteria  [0..1]  Request Criteria for Lease Contract Book Code Configurations   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Lease_Contract_Book_Code_Configurations_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Lease_Contract_Book_Code_Configuration_Request_References  [0..1]  The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.   
Request_Criteria  Lease_Contract_Book_Code_Configuration_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Lease_Contract_Book_Code_Configuration_Response_Data  [0..1]  Lease Contract Book Code Configurations Response Data   
top
 

Lease_Contract_Book_Code_Configuration_Request_References

part of: Get_Lease_Contract_Book_Code_Configurations_Response, Get_Lease_Contract_Book_Code_Configurations_Request
The Request References element contains the specific instance set that should be returned in the Get operation. Either a Reference ID or the Workday ID (GUID) should be specified for each instance to be returned.
 
Parameter name Type/Value Cardinality Description Validations
Lease_Contract_Book_Code_Configuration_Reference  Alternate_Supplier_Contract_Book_Code_ConfigurationObject  [1..*]  Lease Contract Book Code Configuration Reference   
top
 

Alternate_Supplier_Contract_Book_Code_ConfigurationObject

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

Alternate_Supplier_Contract_Book_Code_ConfigurationObjectID

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

part of: Get_Lease_Contract_Book_Code_Configurations_Response, Get_Lease_Contract_Book_Code_Configurations_Request
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Lease_Contract_Book_Code_Configurations_Response, Get_Lease_Contract_Book_Code_Configurations_Request
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Lease_Contract_Book_Code_Configurations_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Lease_Contract_Book_Code_Configuration_Response_Data

part of: Get_Lease_Contract_Book_Code_Configurations_Response
Lease Contract Book Code Configurations Response Data
 
Parameter name Type/Value Cardinality Description Validations
Lease_Contract_Book_Code_Configuration  Lease_Contract_Book_Code_Configuration  [0..*]  Lease Contract Book Code Configuration Reference   
top
 

Lease_Contract_Book_Code_Configuration

part of: Lease_Contract_Book_Code_Configuration_Response_Data
Lease Contract Book Code Configuration Response Data
 
Parameter name Type/Value Cardinality Description Validations
Lease_Contract_Book_Code_Configuration_Reference  Alternate_Supplier_Contract_Book_Code_ConfigurationObject  [0..1]  Lease Contract Book Configuration Reference   
Lease_Contract_Book_Code_Configuration_Data  Lease_Contract_Book_Code_Configuration_Data  [0..*]  Lease Contract Book Code Configuration Reference 
Validation Description
You must select a contract type and book code for each organization you add.   
You can only select 1 accounting method per book code.   
You can only select 1 book code per combination of company, contract type, and accounting method   
 
top
 

Lease_Contract_Book_Code_Configuration_Data

part of: Lease_Contract_Book_Code_Configuration
Lease Contract Book Code Configuration Reference
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Lease Contract Book Code Configuration Reference ID   
Order  string (6)   [1..1]  Order   
Organization_Reference  OrganizationObject  [1..*]  Reference to existing Organization 
Validation Description
You can only select a Company or Company Hierarchy once. To add additional Company or Company Hierarchy configurations, you must add rows to the selected Company or Company Hierarchy.   
You must enter a Company or Company Hierarchy  Validation message to ensure that company is a required field 
You can't change the book code configuration. Workday has already generated operational journals for the selected configuration of company, lease contract types, and accounting method.   
 
Lease_Contract_Book_Code_Configuration_Details_Data  Lease_Contract_Book_Code_Configuration_Details_Data  [1..*]  Contains the detail information about the book code configuration for the selected organization 
Validation Description
You can't change the book code configuration. Workday has already generated operational journals for the selected configuration of company, lease contract types, and accounting method.   
You cannot remove a contract type if there is a supplier contract existing for company, contract type, and accounting method selected.   
 
Validation Description
You must select a contract type and book code for each organization you add.   
You can only select 1 accounting method per book code.   
You can only select 1 book code per combination of company, contract type, and accounting method   
top
 

OrganizationObject

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

Lease_Contract_Book_Code_Configuration_Details_Data

part of: Lease_Contract_Book_Code_Configuration_Data
Lease Contract Book Code Configuration Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Lease Contract Book Code Configuration Detail Reference ID   
Lease_Contract_Book_Code_Configuration_Detail_Reference  Alternate_Supplier_Contract_Book_Code_Configuration_DetailsObject  [0..1]  Lease Contract Book Code Configuration Detail Reference   
Supplier_Contract_Type_Reference  Supplier_Contract_TypeObject  [1..*]  Lease Contract Type Reference 
Validation Description
Lease Contract Type is a required field.  Validation to ensure that lease contract type is a required field 
You can't select both operating lease and financial lease as the contract types.  Validation to ensure that you cannot select both operating lease and finance lease 
 
Lease_Accounting_Method_Reference  Lease_Accounting_MethodObject  [0..1]  Lease Accounting Method Reference 
Validation Description
Accounting Method is not applicable to financial lease contract types  Validation to ensure that accounting method is not applicable to financial lease contract type. 
You must select an accounting method of ROU Asset Depreciation Expense if your contract type is operating lease, and allows you to receive contract lines.  Validation to ensure that accounting method ROU Asset Depreciation Expense is selected when the contract type allows to receive contract lines 
You must select an accounting method of ROU Asset Operating Expense or Straight Line Expense if your contract type is operating lease, and doesn't allow you to receive contract lines.  Validation to ensure that accounting method ROU Asset Operating Expense or Straight Line Expense is selected when the contract type does not allow to receive contract lines 
You must select an accounting method if your contract type is operating lease  Validation to ensure that accounting method is a required field for operating lease 
 
Book_Code_Reference  Book_CodeObject  [1..1]  Book Code Reference 
Validation Description
You must enter a book code. Your book code can't be a blank book code  Validation to ensure that book code is a required field 
 
Validation Description
You can't change the book code configuration. Workday has already generated operational journals for the selected configuration of company, lease contract types, and accounting method.   
You cannot remove a contract type if there is a supplier contract existing for company, contract type, and accounting method selected.   
top
 

Alternate_Supplier_Contract_Book_Code_Configuration_DetailsObject

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

Alternate_Supplier_Contract_Book_Code_Configuration_DetailsObjectID

part of: Alternate_Supplier_Contract_Book_Code_Configuration_DetailsObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Alternate_Supplier_Contract_Book_Code_Configuration_Details_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Alternate_Supplier_Contract_Book_Code_Configuration_ID  [1..1]  The unique identifier type of a parent object   
top
 

Supplier_Contract_TypeObject

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

Book_CodeObject

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

Book_CodeObjectID

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

Alternate_Supplier_Contract_Book_Code_ConfigurationReferenceEnumeration

part of: Alternate_Supplier_Contract_Book_Code_ConfigurationObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Alternate_Supplier_Contract_Book_Code_Configuration_DetailsReferenceEnumeration

part of: Alternate_Supplier_Contract_Book_Code_Configuration_DetailsObjectID
Base Type
string
top
 

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
 

Book_CodeReferenceEnumeration

part of: Book_CodeObjectID
Base Type
string
top