Service Directory > v32.1 > Financial_Management > Get_Company_ID_Definitions
 

Operation: Get_Company_ID_Definitions

This web service returns Company ID Definitions and Journal Sequence Settings for an existing company.


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

Request element for Get Company ID Definitions WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Company_Request_Reference  [1..1]  Container for reference to an existing company.   
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_Company_ID_Definitions_Response

Response element for Get Company ID Definitions WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Reference  Company_Request_Reference  [0..*]  Container for reference to an existing company.   
Response_Filter  Response_Filter  [0..*]  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..*]  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  Company_ID_Response_Data  [0..*]  Container for Company ID Response Data.   
top
 

Company_Request_Reference

part of: Get_Company_ID_Definitions_Response, Get_Company_ID_Definitions_Request
Container for reference to an existing company.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [1..1]  Reference to an existing Company   
top
 

CompanyObject

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

Response_Filter

part of: Get_Company_ID_Definitions_Response, Get_Company_ID_Definitions_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_Company_ID_Definitions_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
 

Company_ID_Response_Data

part of: Get_Company_ID_Definitions_Response
Container for Company ID Response Data.
 
Parameter name Type/Value Cardinality Description Validations
Company_ID_Definitions_and_Journal_Sequence_Settings_Data  Company_ID_Definitions_and_Sequence_Settings  [0..*]  Contains Company ID Definitions as well as Journal Sequence Settings   
top
 

Company_ID_Definitions_and_Sequence_Settings

part of: Company_ID_Response_Data
Contains Company ID Definitions as well as Journal Sequence Settings
 
Parameter name Type/Value Cardinality Description Validations
Company_ID_Definition_Data  Company_ID_Definitions  [0..1]  Information relating to a Company's ID Definitions 
Validation Description
You cannot enter Unique Invoice Sequence Generators unless you opt in for Unique Invoice IDs at the Company level.   
 
Journal_Sequence_Settings_Data  Journal_Sequence_Settings_Data__Public_  [0..1]  Information relating to a Company's Journal Sequence Settings 
Validation Description
Enter a journal sequencing start period.   
Enable Journal Sequencing if you want to enter journal sequencing settings.   
Ledger periods from the selected sequencing start period must be in Created, Not Available, or Closed status. Update the status of these periods: [periods]   
[period] is not an actuals ledger period. Use an actuals ledger period as the sequencing start period.   
Sequencing Start Period cannot be changed once Sequence Generators have been created for [this company]. Delete all Sequence Generators for [this company] or restore the current Sequencing Start Period.   
You must delete journal sequencing ID generators before you can disable journal sequencing. You can't delete sequence ID generators if they are in use.   
No Journals with "Posted" status should exist for this company after the Sequencing Start Period.   
 
top
 

Company_ID_Definitions

part of: Company_ID_Definitions_and_Sequence_Settings
Information relating to a Company's ID Definitions
 
Parameter name Type/Value Cardinality Description Validations
Customer_Contract_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Customer Contracts   
Customer_Invoice_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Customer Invoices   
Consolidated_Customer_Invoice_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Consolidated Customer Invoices   
Customer_Invoice_Credit_Adjustment_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Customer Invoice Credit Adjustments   
Customer_Invoice_Debit_Adjustment_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Customer Invoice Debit Adjustments   
Customer_Invoice_Rebill_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Customer Invoice Rebills   
Supplier_Invoice_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Supplier Invoices   
Customer_Refund_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Customer Refunds   
Journal_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Journals   
Requisition_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Requisitions   
Purchase_Order_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Purchase Orders   
Purchase_Order_Acknowledgement_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Purchase Order Acknowledgement   
Advanced_Ship_Notice_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for ASN   
Receipt_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Receipts   
Spend_Authorization_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Spend Authorizations   
Expense_Reports_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Expense Reports   
Supplier_Contracts_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Supplier Contracts   
Settlement_Run_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Settlement Runs   
Prenote_Run_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Prenote Runs   
Receipt_Accrual_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Receipt Accruals   
Outsourced_Payment_Group_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Outsourced Payments   
Award_Contract_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Awards   
Award_Proposal_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Award Proposals   
Procurement_Card_Transaction_Verification_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Procurement Card Transaction Verification   
Return_to_Supplier_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Return to Supplier   
Request_for_Quote_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Request for Quote   
RFQ_Response_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for RFQ Response   
RFQ_Award_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for RFQ Award   
Inventory_Stock_Requests_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Stock Requests   
Inventory_Pick_Lists_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Pick Lists   
Inventory_Ship_Lists_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Ship Lists   
Inventory_Returns_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Returns   
Inventory_Count_Sheets_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Count Sheets   
Inventory_Par_Counts_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Par Counts   
Inventory_Goods_Deliveries_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Goods Deliveries   
Inventory_Goods_Delivery_Runs_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Inventory Goods Delivery Runs   
Internal_Service_Delivery_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Internal Service Delivery   
Supplier_Invoice_Request_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Supplier Invoice Request   
Ad_Hoc_Bank_Transaction_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Ad Hoc Bank Transactions   
Direct_Debit_Mandate_Reference_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Direct Debit Mandate   
Budget_Amendment_Sequence_Generator_Reference  Sequence_GeneratorObject  [0..1]  Reference to ID Generator for Budget Amendment   
Validation Description
You cannot enter Unique Invoice Sequence Generators unless you opt in for Unique Invoice IDs at the Company level.   
top
 

Sequence_GeneratorObject

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

Sequence_GeneratorObjectID

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

Journal_Sequence_Settings_Data__Public_

part of: Company_ID_Definitions_and_Sequence_Settings
Information relating to a Company's Journal Sequence Settings
 
Parameter name Type/Value Cardinality Description Validations
Enable_Journal_Sequencing  boolean  [0..1]  Determines whether Journals created by a company should have a sequence   
Sequence_Generator_Rule_Configuration_Reference  Journal_Sequence_Generator_Rule_ConfigurationObject  [0..1]  The Sequence Generator Configuration used by the company to generate new ID generators for Ledger Periods/Years   
Sequencing_Start_Period_Reference  Unique_IdentifierObject  [0..1]  The Ledger Posting Interval to begin Sequencing Journals during and after   
Create_Sequence_ID_Generators_with_New_Ledger_Years  boolean  [0..1]  Determines whether the Rule Configuration will be used to create ID Generators whenever new Ledger Years are created   
Validation Description
Enter a journal sequencing start period.   
Enable Journal Sequencing if you want to enter journal sequencing settings.   
Ledger periods from the selected sequencing start period must be in Created, Not Available, or Closed status. Update the status of these periods: [periods]   
[period] is not an actuals ledger period. Use an actuals ledger period as the sequencing start period.   
Sequencing Start Period cannot be changed once Sequence Generators have been created for [this company]. Delete all Sequence Generators for [this company] or restore the current Sequencing Start Period.   
You must delete journal sequencing ID generators before you can disable journal sequencing. You can't delete sequence ID generators if they are in use.   
No Journals with "Posted" status should exist for this company after the Sequencing Start Period.   
top
 

Journal_Sequence_Generator_Rule_ConfigurationObject

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

Journal_Sequence_Generator_Rule_ConfigurationObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Sequence_GeneratorReferenceEnumeration

part of: Sequence_GeneratorObjectID
Base Type
string
top
 

Journal_Sequence_Generator_Rule_ConfigurationReferenceEnumeration

part of: Journal_Sequence_Generator_Rule_ConfigurationObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top