Service Directory > v31.2 > Revenue_Management > Get_Companies_as_Business_Entities
 

Operation: Get_Companies_as_Business_Entities

This service operation will get Company as Business Entity instances for the specified criteria.


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

This element is the top-level request element for all Company as business entity "Get" operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Company_as_Business_Entity_Request_References  [0..1]  This element is the top-level request element for all Company as business entities.   
Request_Criteria [Choice]   Company_as_Business_Entity_Request_Criteria  [0..1]  Get Company as Business entity 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_Group  Company_as_Business_Entity_Response_Group  [0..1]  Element containing Company as business entity response grouping options.   
top
 

Response Element: Get_Companies_as_Business_Entities_Response

Element containing Company as Business Entity response elements including echoed request data and request result data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Company_as_Business_Entity_Request_References  [0..1]  Reference to existing Company as Business entity.   
Request_Criteria  Company_as_Business_Entity_Request_Criteria  [0..1]  Element containing search criteria for Company as business entity.   
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_Group  Company_as_Business_Entity_Response_Group  [0..1]  Element containing Company as business entity response grouping options.   
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  Company_as_Business_Entity_Response_Data  [0..1]  Wrapper element containing Company as Business Entity Response Data for requested references or criteria.   
top
 

Company_as_Business_Entity_Request_References

part of: Get_Companies_as_Business_Entities_Request, Get_Companies_as_Business_Entities_Response
Reference to existing Company as Business entity.
 
Parameter name Type/Value Cardinality Description Validations
Company_as_Business_Entity_Reference  Company_as_Business_EntityObject  [1..*]  Reference for Company as business entity.   
top
 

Company_as_Business_EntityObject

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

Company_as_Business_EntityObjectID

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

part of: Get_Companies_as_Business_Entities_Request, Get_Companies_as_Business_Entities_Response
Element containing search criteria for Company as business entity.
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company that the request criteria is for.   
Customer_Reference  CustomerObject  [0..*]  Reference to existing Customer that the request criteria is for.   
Supplier_Reference  SupplierObject  [0..*]  Reference to existing Supplier that the request criteria is for.   
top
 

CompanyObject

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

CustomerObject

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

CustomerObjectID

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

SupplierObject

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

SupplierObjectID

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

Company_as_Business_Entity_Response_Group

part of: Get_Companies_as_Business_Entities_Request, Get_Companies_as_Business_Entities_Response
Element containing Company as business entity response grouping options.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Companies_as_Business_Entities_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_as_Business_Entity_Response_Data

part of: Get_Companies_as_Business_Entities_Response
Wrapper element containing Company as Business Entity Response Data for requested references or criteria.
 
Parameter name Type/Value Cardinality Description Validations
Company_as_Business_Entity  Company_as_Business_Entity  [0..*]  Wrapper element containing Company as Business Entity Instance and Data.   
top
 

Company_as_Business_Entity

part of: Company_as_Business_Entity_Response_Data
Wrapper element containing Company as Business Entity Instance and Data.
 
Parameter name Type/Value Cardinality Description Validations
Company_as_Business_Entity_Reference  Company_as_Business_EntityObject  [0..1]  Reference to existing Company as Business Entity.   
Company_as_Business_Entity_Data  Company_as_Business_Entity_Data  [0..*]  Company as Business Entity Data contains essential information about Company as Business Entity. 
Validation Description
Please provide value for either Customer or Supplier or both for Company as Business Entity.   
Please provide value for Company.   
 
top
 

Company_as_Business_Entity_Data

part of: Company_as_Business_Entity
Company as Business Entity Data contains essential information about Company as Business Entity.
 
Parameter name Type/Value Cardinality Description Validations
Company_as_Business_Entity_ID  string  [0..1]  Company as Business Entity ID. This is the Customer as Business Entity unique identifier.   
Company_Reference  CompanyObject  [1..1]  Company as Business Entity relationship with Company. This is the reference id value of the company. 
Validation Description
Company cannot be selected more than once for Company, Customer and Supplier Configuration  Company cannot be selected more than once for Company, Customer and Supplier Configuration 
 
Customer_Reference  CustomerObject  [0..1]  Company as Business Entity has Customer. This is the reference id value of the Customer. 
Validation Description
The selected Customers/Suppliers have relationships with another company different than the selected company.  The selected Customers/Suppliers have relationships with another company different than the selected company. 
 
Supplier_Reference  SupplierObject  [0..1]  Company as Business Entity has Supplier. This is the reference id value of the supplier. 
Validation Description
The selected Customers/Suppliers have relationships with another company different than the selected company.  The selected Customers/Suppliers have relationships with another company different than the selected company. 
You can't select a supplier that can invoice other suppliers. Remove the Invoice Any Supplier supplier option for this supplier using Create Supplier Change task.   
 
Comments  RichText  [0..1]  Free form comments for the Company as Business Entity.   
Copy_Worktags  boolean  [0..1]  Copy Worktags from the Customer Invoice to the Supplier Invoice 
Validation Description
You can only select Copy Worktags for a company that operates as a customer.   
 
Copy_Tax_Fields  boolean  [0..1]  Copy Tax Fields from the Customer Invoice to the Supplier Invoice 
Validation Description
You can only select Copy Tax Fields for a company that operates as a customer.   
 
Copy_Attachments  boolean  [0..1]  Copy Attachments from the Customer Invoice to the Supplier Invoice 
Validation Description
You can only select Copy Attachments for a company that operates as a customer.   
 
Default_Affiliate  boolean  [0..1]  Default Affiliate from Customer Invoice to Supplier Invoice   
Validation Description
Please provide value for either Customer or Supplier or both for Company as Business Entity.   
Please provide value for Company.   
top
 

Company_as_Business_EntityReferenceEnumeration

part of: Company_as_Business_EntityObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

SupplierReferenceEnumeration

part of: SupplierObjectID
Base Type
string
top
 

RichText

part of: Company_as_Business_Entity_Data
Base Type
string
top