Service Directory > v32.1 > Financial_Management > Put_Company_Organization
 

Operation: Put_Company_Organization

This web service adds a new company or updates an existing company with basic information on your organization. Please note that the web service strictly enables you to create and edit organizations, and doesn't allow you to provide details on other configurations, such as financials, payroll, and taxes.


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

Request element for Add Update Company WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company   
Company_Organization_Data  Company_Organization_Data  [1..1]  Company Organization Data   
Validation Description
Organization already exists.   
Currency cannot be changed unless there are no journal entries or business documents for the company.   
top
 

Response Element: Put_Company_Organization_Response

Response element for Add Update Company WS
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Company_Reference  CompanyObject  [0..1]  Reference to an existing Company   
top
 

CompanyObject

part of: Put_Company_Organization_Request, Put_Company_Organization_Response
 
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_Organization_Data

part of: Put_Company_Organization_Request
Company Organization Data
 
Parameter name Type/Value Cardinality Description Validations
@Effective_Date  date  [1..1]  Effective Date for Put Company Organization Request which is used for Container Organization Associations/Removals as well as Organization Name Changes   
Organization_Data  Organization_Common_Data  [1..1]  Company Organization Data Element Content 
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.  'Include Organization ID in Name' can only be set to true for supervisory organizations. 
Choose a different REFERENCE_ID. The current value is already in use by the [org type]:[var]   
You can't submit this field(Phonetic Name) until you first select both the Enabled and Workday-Supported checkboxes for your preferred language(Japanese, Korean, Chinese) in the Languages Section on the Edit Tenant Setup - Global task. You must also specify your preferred language in the "Enable Languages of Phonetic Name for Company" field.   
You are using an invalid task to submit this field (Phonetic Name).   
 
Organization_Subtype_Reference  Organization_SubtypeObject  [1..1]  A unique identifier for the subtype of the organization. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Organization_Containers_Data  Organization_Containers_Data  [0..1]  Contains fields that enable you to add/remove or replace the company hierarchies of the target company.   
Currency_Reference  CurrencyObject  [1..1]  Company Default Currency   
top
 

Organization_Common_Data

part of: Company_Organization_Data
Contains the detailed information about an Organization.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Integration Reference ID used for integration purposes; This is also the Organization ID   
Include_Organization_ID_in_Name  boolean  [0..1]  If this option is turned on, Organization ID will be shown in Organization Name. This option is only activated for Supervisory Organizations for now. A new effective-dated organization name is automatically created if value for this field is different as of specified effective date.   
Organization_Name  string  [0..1]  The name of the Organization that appears on pages and reports. A new effective-dated organization name is automatically created if value for this field is different as of specified effective date. 
Validation Description
Enter an Organization Name or select the 'Include Manager/Leader in Name' checkbox or use the Organization Code as the name by entering an Organization Code and selecting the 'Include Organization Code in Name' checkbox.  Enter an Organization Name or select the 'Include Manager/Leader in Name' checkbox or use the Organization Code as the name by entering an Organization Code and selecting the 'Include Organization Code in Name' checkbox. 
 
Phonetic_Name  string  [0..1]  Phonetic Name   
Organization_Code  string  [0..1]  Text attribute identifying Organization Code. A new effective-dated organization name is automatically created if value for this field is different as of specified effective date. 
Validation Description
Organization Code is required If 'Include Organization Code in Name' is selected.  Organization Code is required If 'Include Organization Code in Name' is selected. 
 
Include_Organization_Code_in_Name  boolean  [0..1]  Boolean attribute identifying whether to include the Organization Code within the name (Display ID within Workday). A new effective-dated organization name is automatically created if value for this field is different as of specified effective date.   
Organization_Active  boolean  [0..1]  Field that indicates if the organization is active.   
Availability_Date  date  [1..1]  Date the Organization is available for staffing events. If availability date is specified, it must be earlier or equal to the existing availability date, otherwise it will be ignored. If availability date is not specified, the existing availability date will be retained. If availability date is not specified, and there is no existing availability date, the current effective moment will be set as the availability date.   
Organization_Visibility_Reference  Unique_IdentifierObject  [0..1]  Visibility for the organization. A subordinate organization inherits visibility from its top-level organization. If visibility is not specified for a top-level organization, it defaults to Everyone. If visibility is specified for a subordinate organization, it will be ignored.   
External_URL_Reference  External_URLObject  [0..1]  Non-Workday URL link for more Organizational information.   
Integration_ID_Data  External_Integration_ID_Data  [0..*]  Contains external system name and its corresponding ID that can be used to match data between systems during an integration.   
Validation Description
'Include Organization ID in Name' can only be set to true for supervisory organizations.  'Include Organization ID in Name' can only be set to true for supervisory organizations. 
Choose a different REFERENCE_ID. The current value is already in use by the [org type]:[var]   
You can't submit this field(Phonetic Name) until you first select both the Enabled and Workday-Supported checkboxes for your preferred language(Japanese, Korean, Chinese) in the Languages Section on the Edit Tenant Setup - Global task. You must also specify your preferred language in the "Enable Languages of Phonetic Name for Company" field.   
You are using an invalid task to submit this field (Phonetic Name).   
top
 

Unique_IdentifierObject

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

External_URLObject

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

External_URLObjectID

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

External_Integration_ID_Data

part of: Organization_Common_Data
Integration ID Help Text
 
Parameter name Type/Value Cardinality Description Validations
ID  ID  [1..*]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

Organization_Containers_Data

part of: Company_Organization_Data
Contains fields that enable you to add/remove or replace the company hierarchies of the target company.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Container_To_Replace_All_Data  Organization_Container_To_Replace_All_Data  [0..1]  Contains field where user can specify a company hierarchy (or hierarchies) to replace all current hierarchies on target company.   
Organization_Container_to_Add_Data  Organization_Container_to_Add_Data  [0..1]  Specify Company Hierarchies you want to add or remove from the target Company   
Organization_Container_To_Delete_Data  Organization_Container_To_Delete_Data  [0..1]  Contains field which allows you to specify company hierarchies to remove as superiors from target company.   
top
 

Organization_Container_To_Replace_All_Data

part of: Organization_Containers_Data
Contains field where user can specify a company hierarchy (or hierarchies) to replace all current hierarchies on target company.
 
Parameter name Type/Value Cardinality Description Validations
Organization_Container_Reference  Custom_OrganizationObject  [0..*]  Replace All Company Hierarchies assigned to target Company with these Hierarchies 
Validation Description
You can't replace all hierarchies on a new company.   
An organization that is inactive now or will be inactive in future cannot include an active organization.  An organization that is inactive now or will be inactive in future cannot include an active organization. 
You can't add, remove, and replace company hierarchies at the same time. Split your replace and your addition and removal of company hierarchies into separate requests.   
The organization type does not match the organization type allowed for roll-up by the container organization.  The organization type does not match the organization type allowed for roll-up by the container organization. 
Two or more of the proposed Container Organizations belong to the same top level hierarchy  Two or more of the proposed Container Organizations belong to the same top level hierarchy 
 
top
 

Custom_OrganizationObject

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

Custom_OrganizationObjectID

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

Organization_Container_to_Add_Data

part of: Organization_Containers_Data
Add or remove company hierarchies as superiors
 
Parameter name Type/Value Cardinality Description Validations
Organization_Container_Reference  Custom_OrganizationObject  [0..*]  Specify Company Hierarchies to add to the target company. 
Validation Description
Two or more of the proposed Container Organizations belong to the same top level hierarchy  Two or more of the proposed Container Organizations belong to the same top level hierarchy 
The organization type does not match the organization type allowed for roll-up by the container organization.  The organization type does not match the organization type allowed for roll-up by the container organization. 
An organization that is inactive now or will be inactive in future cannot include an active organization.  An organization that is inactive now or will be inactive in future cannot include an active organization. 
Enter a company hierarchy that isn't already a superior on this company.   
 
top
 

Organization_Container_To_Delete_Data

part of: Organization_Containers_Data
Container Element to specify company hierarchies to remove from the target company in the request
 
Parameter name Type/Value Cardinality Description Validations
Organization_Container_Reference  Custom_OrganizationObject  [0..*]  Specify Company Hierarchies to remove from the target company. 
Validation Description
You can't remove company hierarchies from new companies.   
You can't remove an unassociated company hierarchy from a company.   
 
top
 

CurrencyObject

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

CurrencyObjectID

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

Custom_OrganizationReferenceEnumeration

part of: Custom_OrganizationObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top