Service Directory > v31.2 > Financial_Management > Get_Intercompany_Profiles
 

Operation: Get_Intercompany_Profiles

This web service operation will retrieve the specified intercompany profiles.


@ - 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_Intercompany_Profiles_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]   Intercompany_Profile_Request_References  [0..1]  Reference to existing intercompany profile.   
Request_Criteria [Choice]   Intercompany_Profile_Request_Criteria  [0..1]  Get intercompany profile 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  Intercompany_Profile_Response_Group  [0..1]  The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.   
top
 

Response Element: Get_Intercompany_Profiles_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  Intercompany_Profile_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  Intercompany_Profile_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_Group  Intercompany_Profile_Response_Group  [0..1]  The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.   
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  Intercompany_Profile_Response_Data  [0..1]  Intercompany profile response data.   
top
 

Intercompany_Profile_Request_References

part of: Get_Intercompany_Profiles_Request, Get_Intercompany_Profiles_Response
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
Intercompany_Profile_Reference  Intercompany_ProfileObject  [1..*]  Reference to an existing intercompany profile.   
top
 

Intercompany_ProfileObject

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

Intercompany_ProfileObjectID

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

Intercompany_Profile_Request_Criteria

part of: Get_Intercompany_Profiles_Request, Get_Intercompany_Profiles_Response
Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Intercompany_Profile_Response_Group

part of: Get_Intercompany_Profiles_Request, Get_Intercompany_Profiles_Response
The Response Group allows the request to specify which data attributes should be returned in the Response, such as whether to include reference elements, attachments, etc.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean flag to include Reference in response.   
top
 

Response_Results

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

Intercompany_Profile_Response_Data

part of: Get_Intercompany_Profiles_Response
Intercompany profile response data.
 
Parameter name Type/Value Cardinality Description Validations
Intercompany_Profile  Intercompany_Profile  [0..*]  Intercompany Profile.   
top
 

Intercompany_Profile

part of: Intercompany_Profile_Response_Data
Intercompany profile response data.
 
Parameter name Type/Value Cardinality Description Validations
Intercompany_Profile_Reference  Intercompany_ProfileObject  [0..1]  Reference to an existing intercompany profile.   
Intercompany_Profile_Data  Intercompany_Profile_Data  [0..1]  Element containing Intercompany Profile data. 
Validation Description
Default Payment Type : [1] must be included in the list of valid payment types   
In order to check the option to Transfer Asset Original, intercompany transactions must also be allowed.   
The bank account selected is not a valid for the selected companies.   
You must enable Record Intercompany Receipts to add a Bank Account for Intercompany.   
Select a bank account to record an intercompany receipt.   
 
top
 

Intercompany_Profile_Data

part of: Intercompany_Profile
Element containing Intercompany Profile data.
 
Parameter name Type/Value Cardinality Description Validations
Intercompany_Profile_Memo  string  [0..1]  An optional memo for intercompany profile.   
Intercompany_Transactions_Allowed  boolean  [0..1]  Boolean flag indicating if the intercompany profile is initiate/transactions allowed.   
Intercompany_Settle_Only  boolean  [0..1]  Boolean flag indicating if the intercompany profile is for settle only. 
Validation Description
Either Intercompany Allowed or Intercompany Settle Only can be selected but not both.   
 
From_Company_Reference  CompanyObject  [1..1]  Reference to company that the intercompany profile is from.   
To_Company_Reference  CompanyObject  [1..1]  Reference to company that the intercompany profile is connected to.   
Settlement_Instruction_Reference  Settlement_InstructionObject  [0..*]  Reference to settlement instruction or bank account.   
Allowed_Payment_Type_Reference  Payment_TypeObject  [0..*]  List of allowed payment types for the intercompany profile.   
Default_Payment_Type_Reference  Payment_TypeObject  [0..1]  The default payment type for the intercompany profile.   
Transfer_Asset_as_Original  boolean  [0..1]  When this is checked, assets are transferred to the transfer-to company with the same in-service date, total asset cost and accumulated depreciation as the asset in the transfer-from company. When not checked, assets are transferred to the transfer-to company with asset cost equal to the net book value and the in-service date is specified in the transfer-to company.   
Record_Intercompany_Receipt_Reference  boolean  [0..1]  Option to automatically record intercompany receipt after settlement run.   
Bank_Account_for_Intercompany_Receipt_Reference  Bank_AccountObject  [0..1]  Reference to bank account for recording intercompany receipt.   
Validation Description
Default Payment Type : [1] must be included in the list of valid payment types   
In order to check the option to Transfer Asset Original, intercompany transactions must also be allowed.   
The bank account selected is not a valid for the selected companies.   
You must enable Record Intercompany Receipts to add a Bank Account for Intercompany.   
Select a bank account to record an intercompany receipt.   
top
 

CompanyObject

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

Settlement_InstructionObject

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

Settlement_InstructionObjectID

part of: Settlement_InstructionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Bank_Account_ID, External_Bank_Account_Request_ID, Intermediary_Bank_Account_ID, Payee_Settlement_Bank_Account_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, Academic_Person_ID, Ad_hoc_Payee_ID, Applicant_ID, Company_Reference_ID, Contingent_Worker_ID, Corporate_Credit_Card_Account_ID, Customer_ID, Customer_Reference_ID, Deduction_Recipient_ID, Employee_ID, External_Committee_Member_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investor_ID, Organization_Reference_ID, Sponsor_ID, Sponsor_Reference_ID, Student_ID, Student_Proxy_ID, Supplier_Connection_ID, Supplier_ID, Supplier_Reference_ID, Tax_Authority_ID, Tax_Authority_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Payment_TypeObject

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

Payment_TypeObjectID

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

Bank_AccountObject

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

Bank_AccountObjectID

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

Intercompany_ProfileReferenceEnumeration

part of: Intercompany_ProfileObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

Settlement_InstructionReferenceEnumeration

part of: Settlement_InstructionObjectID
Base Type
string
top
 

Base Type
string

top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Bank_AccountReferenceEnumeration

part of: Bank_AccountObjectID
Base Type
string
top