Service Directory > v32.1 > Revenue_Management > Get_Customers
 

Operation: Get_Customers

This service operation will get Customers for the specified criteria. Customer data includes Customer ID, Customer Reference ID, Customer Name, Customer Category, Customer Group, Payment Terms, default Payment Terms, Tax Code, Lock Box, Business Entity data, Settlement Account data, Customer Status data, Always Separate Payments Flag, Business Entity Alternate Name Data, Business Entity Attachment data. Business Entity data includes Name, Tax ID, External ID, Contact Information data, and Business Entity Logo. Contact Information data includes Address, Phone, Email, Instant Messenger and Web Address data. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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

This element is the top-level request element for all "Get" Customers operations.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Customer_Request_References  [0..*]  Customer Reference element contains the specific instance set containing the requested Customer. The ID is either the Lookup ID or the Workday ID (GUID).   
Request_Criteria [Choice]   Customer_Request_Criteria  [0..*]  The Request Criteria is a wrapper element around a list of elements representing the operation specific criteria needed to search for Customer instances   
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_Group  Customer_Response_Group  [0..*]  The Response Group is a wrapper element around a list of elements representing the amount of data that should be included in the response.   
top
 

Response Element: Get_Customers_Response

Top-level response element for all "Get" Customers operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Customer_Request_References  [0..*]  Customer Request References   
Request_Criteria  Customer_Request_Criteria  [0..*]  Customer Request Criteria   
Response_Filter  Response_Filter  [0..*]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Customer_Response_Group  [0..*]  Customer Request Response Group   
Response_Results  Response_Results  [0..*]  Customer Request Response Results   
Response_Data  Customer_Response_Data  [0..*]  Customer Response Data   
top
 

Customer_Request_References

part of: Get_Customers_Request, Get_Customers_Response
Customer Reference element contains the specific instance set containing the requested Customer. The ID is either the Lookup ID or the Workday ID (GUID).
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [0..*]  Reference to an existing Customer for update only purposes   
top
 

CustomerObject

part of: Customer_Request_References, Customer, Customer_WWS_Data, Customer_WWS_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
 

Customer_Request_Criteria

part of: Get_Customers_Request, Get_Customers_Response
Wrapper element around a list of elements representing the Customer specific criteria needed to search for instances (all of the elements are "AND" conditions). These are attributes and/or references that provide an alternate way to find instances or data outside of the Workday IDs and Lookup IDs contained within the "Request_References" element.
 
Parameter name Type/Value Cardinality Description Validations
Event_Reference [Choice]   Transaction_LogObject  [0..1]  Event   
Reporting_Transaction_Reference [Choice]   Reporting_TransactionObject  [0..1]  Reporting Transaction Reference   
Customer_ID  string  [0..1]  Customer ID is a unique identifier for a specific Customer. Provided as a criteria to search for customer with matching ID (Ignore Case).   
Customer_Name  string  [0..1]  Name of the Customer. Provided as a criteria to search for customers whose name starts with the search string (Ignore Case).   
Customer_Category_Reference  Customer_CategoryObject  [0..*]  Customer Category Reference is a reference to a specific Customer Category. Provided as a criteria to search for customers with matching category.   
Customer_Group_Reference  Customer_GroupObject  [0..*]  Customer Group Reference is a reference to a specific Customer Group. Provided as a criteria to search for customers with matching group.   
Payment_Terms_Reference  Payment_TermsObject  [0..*]  Payment Terms Reference is a reference to a specific Payment Term. Provided as a criteria to search for customers with matching payment terms.   
Default_Payment_Type_Reference  Payment_TypeObject  [0..*]  Default Payment Type Reference is a reference to a specific Payment Type. Provided as a criteria to search for customers with matching default payment type.   
Customer_Status_Value_Reference  Business_Entity_Status_ValueObject  [0..*]  Status Value Reference is a reference to a specific Business Entity Status Value. Provided as a criteria to search for customers with matching status.   
Reason_for_Customer_Status_Change_Reference  Reason_for_Customer_Status_ChangeObject  [0..*]  Reason for Customer Status Change Reference is a reference to a specific Reason for Customer Status Change. Provided as a criteria to search for customers with matching status change reason.   
Basic_Worktag_Only  boolean  [0..1]  Boolean to indicate whether to search for customers used as basic worktag only. If true, return customers used as basic worktag only. If false or not provided, return all customers.   
top
 

Transaction_LogObject

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

Transaction_LogObjectID

part of: Transaction_LogObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assign_Pay_Group_Event_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Quick_Issue_Reference_ID, Receipt_Number, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_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
 

Reporting_TransactionObject

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

Reporting_TransactionObjectID

part of: Reporting_TransactionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ad_hoc_Payment_Reference_ID, Advanced_Ship_Notice_ID, Advanced_Ship_Notice_Number, Alternate_Supplier_Contract_ID, Award_Contract_Amendment_ID, Award_Proposal_ID, Award_Reference_ID, Bank_Account_Transfer_Payment_ID, Cash_Sale_ID, Change_Order_Reference_ID, Consolidated_Invoice_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Amendment_Reference_ID, Customer_Contract_Intercompany_ID, Customer_Contract_Reference_ID, Customer_Invoice_Adjustment_Reference_ID, Customer_Invoice_Reference_ID, Customer_Overpayment_Reference_ID, Customer_Payment_for_Invoices_Reference_ID, Customer_Refund_Reference_ID, Document_Number, EFT_Payment_ID, Expense_Report_Reference_ID, Good_Delivery_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Internal_Service_Delivery_Document_Number, Internal_Service_Delivery_ID, Inventory_Count_Sheet_Reference_ID, Inventory_Par_Count_Reference_ID, Inventory_Pick_List_Reference_ID, Inventory_Return_Reference_ID, Inventory_Ship_List_Reference_ID, Inventory_Stock_Request_Reference_ID, Miscellaneous_Payment_Request_Reference_ID, PO_Acknowledgement_Number, PO_Acknowledgement_Reference_ID, Procurement_Card_Transaction_Verification_ID, Purchase_Order_Reference_ID, Quick_Issue_Reference_ID, Receipt_Number, Request_for_Quote_Award_ID, Request_for_Quote_ID, Request_for_Quote_Response_ID, Requisition_Number, Requisition_Template_ID, Return_to_Supplier_ID, Sales_Order_Reference_ID, Spend_Authorization_ID, Student_Application_Fee_Payment_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Credit_Memo_ID, Student_Disbursement_Payment_ID, Student_Historical_Payment_ID, Student_Payment_ID, Student_Sponsor_Contract_ID, Student_Sponsor_Payment_ID, Student_Sponsor_Refund_Payment_ID, Student_Waiver_Payment_ID, Supplier_Acknowledgement_Number, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Adjustment_Reference_ID, Supplier_Invoice_Contract_ID, Supplier_Invoice_Reference_ID, Supplier_Invoice_Request_Document_Number, Supplier_Invoice_Request_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, Document_Number, Purchase_Order_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

Customer_CategoryObject

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

Customer_CategoryObjectID

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

Customer_GroupObject

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

Customer_GroupObjectID

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

Payment_TermsObject

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

Payment_TermsObjectID

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

Payment_TypeObject

part of: Customer_Request_Criteria, Customer_WWS_Data, Customer_WWS_Data, Settlement_Account_WWS_Data, Settlement_Account_WWS_Data, Settlement_Account_WWS_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
 

Business_Entity_Status_ValueObject

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

Business_Entity_Status_ValueObjectID

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

Reason_for_Customer_Status_ChangeObject

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

Reason_for_Customer_Status_ChangeObjectID

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

Customer_Response_Group

part of: Get_Customers_Request, Get_Customers_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Customer response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Customer reference is to be included in the response   
Include_Customer_Data  boolean  [0..1]  Flag indicating if the Customer data is to be included in the response   
Include_Customer_Balance  boolean  [0..1]  Flag indicating if the Customer Balance data is to be included in the response   
Include_Customer_Activity_Detail  boolean  [0..1]  Include Customer Activity Summary for Summary Date Range   
top
 

Response_Results

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

Customer_Response_Data

part of: Get_Customers_Response
Customer wrapper element that contains the Customer data elements that are included in the response as requested by the references, criteria and grouping
 
Parameter name Type/Value Cardinality Description Validations
Customer  Customer  [0..*]  Customer wrapper element that contains the Customer "Data" elements that are included in the response   
top
 

Customer

part of: Customer_Response_Data
This element is the wrapper element for all Customer data
 
Parameter name Type/Value Cardinality Description Validations
Customer_Reference  CustomerObject  [0..1]  Customer Reference   
Customer_Data  Customer_WWS_Data  [0..1]  This Element contains Customer attributes 
Validation Description
Only one active Settlement Bank Account allowed for the given entity.  Only one active Settlement Bank Account allowed for the given entity. 
A specific alternate name usage can only be used once per business entity  A specific alternate name usage can only be used once per business entity 
Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance.  Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance. 
Multiple lockboxes for the same company have been provided. A Customer may only remit to one lockbox per Company.  Multiple lockboxes for the same company have been provided. A Customer may only remit to one lockbox per Company. 
A lockbox is already configured for the Company of the lockbox provided ([lockbox]). A Customer may only remit to one lockbox per Company.  A lockbox is already configured for the Company of the lockbox provided. A Customer may only remit to one lockbox per Company. 
The default payment type selected requires Credit Card Information to be entered. Please add Credit Card Information any credit card payment would use for this Customer.  The default payment type selected requires Credit Card Information to be entered. Please add Credit Card Information any credit card payment would use for this Customer. 
Must have one customer credit card profile marked as primary.  Must have one customer credit card profile marked as primary. 
One or more of the Customer Children provided belong to another Customer Hierarchy. A Customer must be uniquely assigned to a hierarchy  One or more of the Customer Children provided belong to another Customer Hierarchy. A Customer must be uniquely assigned to a hierarchy 
Assigning this Customer as a child of the Customer provided would create a circular reference. Only Customers that are not parents of the Customer being processed may be assigned.  Assigning this Customer as a child of the Customer provided would create a circular reference. Only Customers that are not parents of the Customer being processed may be assigned. 
Business Entity to create from is only applicable when creating a Customer, not updating an existing Customer  Business Entity to create from is only applicable when creating a Customer, not updating an existing Customer 
Billing Phone Number is required if any Credit Card Information records have been entered for this customer.  Billing Phone Number is required if any Credit Card Information records have been entered for this customer. 
Primary Email Address is required if any Credit Card Information records have been entered for this customer.  Primary Email Address is required if any Credit Card Information records have been entered for this customer. 
Billing Address is required if any Credit Card Information records have been entered for this customer.  Billing Address is required if any Credit Card Information records have been entered for this customer. 
Only one worktag for each type is allowed for each document line.   
Remit-from Customer cannot be the same as the Entry Customer.  Remit-from Customer cannot be the same as the Entry Customer. 
Remit-from customer reference is for a customer that can be used as a basic worktag only.  Remit-from customer reference is for a customer that can be used as a basic worktag only. 
Included children reference is for a customer that can be used as a basic worktag only.  Included children reference is for a customer that can be used as a basic worktag only. 
Only Customer Name and Customer Status Data can be entered when the Basic Worktag Only is true.  Only Customer Name and Customer Status Data can be entered when the Basic Worktag Only is true. 
Can not switch an existing non-basic, non-worktag only customer to be a basic, worktag only.  Can not switch an existing non-basic, non-worktag only customer to be a basic, worktag only. 
You cannot select a remit-from customer who has a different remit-from customer than itself.  You cannot select a remit-from customer who has a different remit-from customer than itself. 
Can not create instance from a Business Entity for Supplier where the Supplier can be used as a basic worktag only  Can not create instance from a Business Entity for Supplier where the Supplier can be used as a basic worktag only 
You cannot select a remit-from customer for this customer because it is the remit-from customer for at least 1 other customer.  You cannot select a remit-from customer for this customer because it is the remit-from customer for at least 1 other customer. 
The Investor, Financial Institution, Supplier, or Tax Authority selected to create the Customer from already exists as another Customer.  The Investor, Financial Institution, Supplier, or Tax Authority selected to create the Customer from already exists as another Customer. 
Default Currency needs to be amongst accepted currencies for Customer.   
Required worktag type(s) are missing.  Required worktag type(s) are missing. 
The default payment type selected requires a Settlement Bank Account. Please enter the appropriate Settlement Bank Account information.  The default payment type selected requires a Settlement Bank Account. Please enter the appropriate Settlement Bank Account information. 
Enter a payment type that is associated with the Direct Debit payment method.   
Enter a Default Mandate with Active status.   
When no mandate is required, you cannot have a value in the Direct Debit Payment Type Reference and Default Mandate Reference fields.   
Customer Status Data field is not valid.   
A Customer Change Business Process Event is In-Progress. Cannot submit changes that impact this existing In-Progress event.   
A Customer Credit Change Business Process Event is In-Progress. You can’t submit credit changes while this event is running. Wait until after the event is complete to submit additional changes.   
Customer Credit Limit Currency is required if either Credit Limit or Hierarchy Credit Limit is specified.  Customer Credit Limit Currency is required if either Credit Limit or Hierarchy Credit Limit is specified. 
A Customer Payment Change Business Process Event is In-Progress. You can’t submit payment changes while this event is running. Wait until after the event is complete to submit additional changes.   
Customer Category Reference is required.  Customer Category Reference is required. 
Customer Name is required.   
Business Entity Data is required.   
Customer Name must match Business Entity Name.  Customer Name must match Business Entity Name. 
The document delivery options selected for email recipients are invalid for Dunning Letter.   
The document delivery options selected for email recipients are invalid for Customer Invoice.   
The document delivery options selected for email recipients are invalid for Customer Statement.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Invoices.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Cash Sale.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Customer Contracts.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Invoice Adjustments.   
The Customer Reference must match the Customer on the Direct Debit Mandate.   
 
Customer_Balance_Data  Customer_Balance_Data  [0..1]  This Element contains the overall Customer Balance calculated attributes.   
top
 

Customer_WWS_Data

part of: Customer
This Element contains Customer attributes
 
Parameter name Type/Value Cardinality Description Validations
Customer_ID  string  [0..1]  Customer ID. This is a unique identifier for the Customer   
Customer_Reference_ID  string  [0..1]  Customer Reference ID. The Customer Reference ID can be used to uniquely identify a Customer. Unlike Customer ID, Workday will not automatically generate a Customer Reference ID if one is not received. The recommended use for Customer Reference ID is where Workday is not the source system of the Customer.   
Customer_Name  string  [0..1]  Customer Name   
Worktag_Only  boolean  [0..1]  Boolean to indicate if customer is used as a worktag only and not a complete customer instance   
Submit  boolean  [0..1]  Submit for Approval is a boolean flag indicating if the Customer is to be submitted or saved in draft mode. If this flag is set, the Customer will be submitted, otherwise the Customer is saved in draft. Default to 1 if the Submit flag does not exist in the request.   
Create_Customer_from_Financial_Institution_Reference [Choice]   Financial_InstitutionObject  [0..1]  Reference to an existing Financial Institution from which this Customer is to be associated.   
Create_Customer_from_Supplier_Reference [Choice]   SupplierObject  [0..1]  Reference to an existing Supplier from which this Customer is to be associated.   
Create_Customer_from_Tax_Authority_Reference [Choice]   Tax_AuthorityObject  [0..1]  Reference to an existing Tax Authority from which this Customer is to be associated.   
Create_Customer_from_Investor_Reference [Choice]   InvestorObject  [0..1]  Reference to an existing Investor from which this Customer is to be associated.   
Customer_Category_Reference  Customer_CategoryObject  [0..1]  Customer Category Reference is a reference to a specific Customer Category.   
Restricted_To_Companies_Reference  OrganizationObject  [0..*]  Restrict To Companies   
Customer_Group_Reference  Customer_GroupObject  [0..*]  Customer Group Reference is a reference to a specific Customer Group   
Customer_Preferred_Locale_Reference  LocaleObject  [0..1]  Preferred Locale for Customer Invoice   
Customer_Preferred_Language_Reference  User_LanguageObject  [0..1]  Preferred Language for Customer.   
Payment_Terms_Reference  Payment_TermsObject  [0..1]  Payment Terms Reference is a reference to a specific Payment Term that is to be used as the default Payment Terms.   
Default_Payment_Type_Reference  Payment_TypeObject  [0..1]  Default Payment Type Reference is a reference to the specific Payment Type that is to be the default Payment Type.   
DUNS_Number  string (9)   [0..1]  DUNS Number that uniquely identifies the user's credit information with Dun & Bradstreet.   
Credit_Limit_Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Credit_Limit  decimal (26, 6) >0   [0..1]  Credit Limit is the maximum amount that a customer can keep on account.   
Hierarchy_Credit_Limit  decimal (26, 6) >0   [0..1]  Hierarchy Credit Limit is the total amount of credit allowed for the current customer plus all child customers in the hierarchy. 
Validation Description
Hierarchy Credit Limit cannot be entered if this Customer has no Included Children as a Customer Hierarchy.  Hierarchy Credit Limit cannot be entered if this Customer has no Included Children as a Customer Hierarchy. 
 
Credit_Verification_Date  date  [0..1]  Credit Verification Date is the date that a customer either has or will have their credit status verified.   
Commercial_Credit_Score  decimal (12, 0) >0   [0..1]  D&B® Commercial Credit Score.   
Commercial_Credit_Score_Date  date  [0..1]  Commercial Credit Score is the date when D&B® Commercial Credit Score is populated.   
Commercial_Credit_Score_Note  string  [0..1]  Commercial Credit Score Note is the note for D&B® Commercial Credit Score.   
Composite_Risk_Score  decimal (12, 0) >0   [0..1]  D&B® Composite Risk Score.   
Composite_Risk_Date  date  [0..1]  Composite Risk Date is the date when D&B® Composite Risk Score is populated.   
Composite_Risk_Note  string  [0..1]  Composite Risk Note is the note for D&B® Composite Risk Score.   
Customer_Satisfaction_Score  decimal (12, 0) >0   [0..1]  Customer Satisfaction Score.   
Customer_Satisfaction_Date  date  [0..1]  Customer Satisfaction Date is the date when Customer Satisfaction Score is populated.   
Customer_Satisfaction_Note  string  [0..1]  Customer Satisfaction Note is the note for Customer Satisfaction Score.   
Tax_Code_Reference  Tax_CodeObject  [0..1]  Tax Code Reference is a reference to the specific Tax Code that is to be used as the default for the Customer 
Validation Description
Tax Codes with Withholding Tax Rates cannot be used as the Default Tax Code.   
 
Tax_ID_Data  Tax_ID_Data  [0..*]  Tax ID values for current customer. 
Validation Description
Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank.  Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank. 
Enter the Identification # for the Transaction Tax ID.  Enter the Identification # for the Transaction Tax ID. 
You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax.  You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax. 
You can only have 1 Primary Tax ID.  You can only have 1 Primary Tax ID. 
You can only select the Tax ID Type once for a Country.  You can only select the Tax ID Type once for a Country. 
Tax ID Type cannot be used for a [businessEntityType]  The Tax ID Type selected for this Tax ID cannot be used in this webservice. 
The Country has conflicting Tax ID Types. Select 1 of these Tax ID Types for the Country: [taxIDTypes].  The Tax ID Type used is mutually exclusive with other Tax ID Types in the set. Only one can be used for the country. 
You can't change or delete tax IDs when they are in use on taxable documents. Delete the taxable documents or enter these tax IDs: [tax id]   
If HMRC Office Number, Employer PAYE Reference, or Employer Accounts Office Reference Number is defined, the three Tax IDs need to be defined.   
 
Lockbox_Reference  LockboxObject  [0..*]  Lockbox Reference is a reference to the specific Lockbox for the Customer   
Included_Children_Reference  CustomerObject  [0..*]  Reference to existing Customers to be added as children. A child Customer can only belong to one parent and a parent can not be self-referencing.   
Customer_Security_Segment_Reference  Customer_Security_SegmentObject  [0..*]  Reference to an existing Customer Security Segment. If segmented security is implemented, this will control who has access to this Customer.   
Business_Entity_Data  Customer_Business_Entity_WWS_Data  [0..1]  Business Entity Data is the name, taxid and contact data. 
Validation Description
Usage Type is Invalid for this Contactable.   
Enable phonetic names in at least one language in the tenant setup.  Enable phonetic names in at least one language in the tenant setup. 
 
Settlement_Account_Data  Settlement_Account_WWS_Data  [0..*]  Settlement Account Data is the Customer Settlement Account detailed data. 
Validation Description
Invalid IBAN number.   
Bank Format Error: [error_msg]   
Bank Account Format Error: [error_msg]   
Branch ID Format Error: [error_msg]   
IBAN is required for this country.  IBAN is required for this country. 
Routing Transit or Institution Number is required for this country.  Routing Transit or Institution Number is required for this country. 
Financial Account Number is required for this country.  Financial Account Number is required for this country. 
Roll number is required for this country.   
Check Digit is required for this country.   
Bank Account Name is required for this country.   
Branch name is required for this country.   
Branch ID is required for this country.   
Country field is required for this bank account   
[digit_format_error_msg]   
Bank Instructions are only valid for a Customer, Supplier, Ad Hoc Payment, Ad Hoc Payee, Investor, or Tax Authority.   
The check sum validation failed for the entered Routing Transit Number. Please verify it against the Routing Transit Number provided by your financial institution.   
Bank Name is required for this Country   
SWIFT BIC is required for this Country   
Bank Format Error: [error_msg]   
Prenote Payment Type is required and must have a valid value.   
Use a unique Settlement Bank Account ID for each settlement account. [ID] is already used on another settlement account.   
Bank Account Type is required.   
 
Credit_Card_Data  Customer_Credit_Card_Profile_WWS_Data  [0..*]  Credit Card Data is the Customer Credit Card Information data.   
Approval_Status_Reference  Document_StatusObject  [0..1]  Approval Status. This field is read only.   
Customer_Status_Data  Customer_Status_Data  [0..*]  Customer Status Data is the Customer status detail data. 
Validation Description
The Customer Status Change Reason is required if the Customer Status has changed.  The Customer Status Change Reason is required if the Customer Status has changed. 
 
Proposed_Customer_Status_Data  Customer_Proposed_Status_Data  [0..*]  Customer Proposed Status Data is the Proposed Customer status detail data.   
Always_Separate_Payments  boolean  [0..1]  Always Separate Payments is a true/false flag used to indicate is payments should be seperated   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
Accepted_Currencies_Reference  CurrencyObject  [0..*]  Accepted Currencies Reference. When no accepted currencies are passed in the web service, the bank account will accept all currencies.   
Remit-from_Customer_Reference  CustomerObject  [0..1]  Remit-from Customer. This is the optional Customer, that pays the entered Customer.   
Invoice_Delivery_Method_Reference  Delivery_MethodObject  [0..*]  Invoice Delivery Method, either Email or Print, specifying how Customer Invoices will be delivered for this Customer.   
Invoice_Notification_Email_Recipients_Reference  Customer_Document_Email_Recipient_OptionObject  [0..*]  Options to specify recipients for Email Notifications for Customer Invoices. Can provide zero, one, or more.   
Statement_Delivery_Method_Reference  Delivery_MethodObject  [0..*]  Statement Delivery Method, either Email or Print, specifying how Customer Statements will be delivered for this Customer.   
Statement_Notification_Email_Recipients_Reference  Customer_Document_Email_Recipient_OptionObject  [0..*]  Statement Notification Email Recipients 
Validation Description
Customer Document Email Recipient Option is not Valid   
 
Dunning_Delivery_Method_Reference  Delivery_MethodObject  [0..*]  Dunning Letter Method, either Email or Print, specifying how Dunning Letters will be delivered for this Customer.   
Dunning_Letter_Notification_Email_Recipients_Reference  Customer_Document_Email_Recipient_OptionObject  [0..*]  Options to specify recipients for Email Notifications for Dunning Letters. Can provide zero, one, or more.   
Electronic_Invoicing_Start_Date  date  [0..1]  The date that a customer agrees to receive electronic invoicing.   
Electronic_Invoicing_Government_Issued_Customer_ID  string  [0..1]  An identifier for a vendor that offers electronic invoicing transformation and transmission services, e.g. Basware, PAC to tax authority and customers.   
Electronic_Invoicing_Intermediary_Vendor_ID  string  [0..1]  A customer identifier issued by the government, e.g. OVT code for electronic invoicing.   
Electronic_Invoicing_Vendor_Issued_Customer_ID  string  [0..1]  A customer identifier assigned by the electronic invoicing vendor.   
Mandate_Required  boolean  [0..1]  Mandate Required   
Direct_Debit_Payment_Type_Reference  Payment_TypeObject  [0..1]  This is the Reference ID for the Direct Debit Payment Type for SEPA Mandate regulation purposes.   
Default_Mandate_Reference  Direct_Debit_MandateObject  [0..1]  This is the Reference ID for the Default Direct Debit Mandate for Direct Debit Mandate regulation purposes.   
Business_Entity_Alternate_Name_Data  Business_Entity_Alternate_Name_Data  [0..*]  Business Entity Alternate Name Data 
Validation Description
The alternate name usage is not valid for a Supplier  The alternate name usage is not valid for a Supplier 
The alternate name usage is not valid for a Customer  The alternate name usage is not valid for a Customer 
The alternate name usage is not valid for an Investor.  The alternate name usage is not valid for an Investor. 
 
Tax_Status_Data  Tax_Status_Data  [0..*]  Tax Status Data includes: Country, Transaction Tax Status, and Withholding Tax Status. 
Validation Description
Select a Transaction Tax Status or Withholding Tax Status for the Country.   
The selected Country is already in use.   
 
Business_Entity_Attachment_Data  Financials_Attachment_Data  [0..*]  Business Entity Attachment Data 
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
 
Note_Data  Note_WWS_Data  [0..*]  Includes Notes that have been made for a business object. On a Get operation, all existing Notes will be populated. On a Put or Submit operation, any note information on the request will be added as new notes. Existing notes cannot be updated on a Put or Submit request.   
Followup_Date  date  [0..1]  Followup Date is the date defined to follow up with customer. This field is optional and can be entered using related action "Add Note" from Customer. 
Validation Description
Followup date cannot be in the past.   
 
Related_Worktags_Data  Related_Worktag_Widget_Data  [0..1]  Reference to the existing Allowed or Default Related Worktags. 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
 
Validation Description
Only one active Settlement Bank Account allowed for the given entity.  Only one active Settlement Bank Account allowed for the given entity. 
A specific alternate name usage can only be used once per business entity  A specific alternate name usage can only be used once per business entity 
Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance.  Two Reference ID's have been provided that resolve to different instances. Please provide only one Reference ID or verify that both Reference ID's resolve to the same instance. 
Multiple lockboxes for the same company have been provided. A Customer may only remit to one lockbox per Company.  Multiple lockboxes for the same company have been provided. A Customer may only remit to one lockbox per Company. 
A lockbox is already configured for the Company of the lockbox provided ([lockbox]). A Customer may only remit to one lockbox per Company.  A lockbox is already configured for the Company of the lockbox provided. A Customer may only remit to one lockbox per Company. 
The default payment type selected requires Credit Card Information to be entered. Please add Credit Card Information any credit card payment would use for this Customer.  The default payment type selected requires Credit Card Information to be entered. Please add Credit Card Information any credit card payment would use for this Customer. 
Must have one customer credit card profile marked as primary.  Must have one customer credit card profile marked as primary. 
One or more of the Customer Children provided belong to another Customer Hierarchy. A Customer must be uniquely assigned to a hierarchy  One or more of the Customer Children provided belong to another Customer Hierarchy. A Customer must be uniquely assigned to a hierarchy 
Assigning this Customer as a child of the Customer provided would create a circular reference. Only Customers that are not parents of the Customer being processed may be assigned.  Assigning this Customer as a child of the Customer provided would create a circular reference. Only Customers that are not parents of the Customer being processed may be assigned. 
Business Entity to create from is only applicable when creating a Customer, not updating an existing Customer  Business Entity to create from is only applicable when creating a Customer, not updating an existing Customer 
Billing Phone Number is required if any Credit Card Information records have been entered for this customer.  Billing Phone Number is required if any Credit Card Information records have been entered for this customer. 
Primary Email Address is required if any Credit Card Information records have been entered for this customer.  Primary Email Address is required if any Credit Card Information records have been entered for this customer. 
Billing Address is required if any Credit Card Information records have been entered for this customer.  Billing Address is required if any Credit Card Information records have been entered for this customer. 
Only one worktag for each type is allowed for each document line.   
Remit-from Customer cannot be the same as the Entry Customer.  Remit-from Customer cannot be the same as the Entry Customer. 
Remit-from customer reference is for a customer that can be used as a basic worktag only.  Remit-from customer reference is for a customer that can be used as a basic worktag only. 
Included children reference is for a customer that can be used as a basic worktag only.  Included children reference is for a customer that can be used as a basic worktag only. 
Only Customer Name and Customer Status Data can be entered when the Basic Worktag Only is true.  Only Customer Name and Customer Status Data can be entered when the Basic Worktag Only is true. 
Can not switch an existing non-basic, non-worktag only customer to be a basic, worktag only.  Can not switch an existing non-basic, non-worktag only customer to be a basic, worktag only. 
You cannot select a remit-from customer who has a different remit-from customer than itself.  You cannot select a remit-from customer who has a different remit-from customer than itself. 
Can not create instance from a Business Entity for Supplier where the Supplier can be used as a basic worktag only  Can not create instance from a Business Entity for Supplier where the Supplier can be used as a basic worktag only 
You cannot select a remit-from customer for this customer because it is the remit-from customer for at least 1 other customer.  You cannot select a remit-from customer for this customer because it is the remit-from customer for at least 1 other customer. 
The Investor, Financial Institution, Supplier, or Tax Authority selected to create the Customer from already exists as another Customer.  The Investor, Financial Institution, Supplier, or Tax Authority selected to create the Customer from already exists as another Customer. 
Default Currency needs to be amongst accepted currencies for Customer.   
Required worktag type(s) are missing.  Required worktag type(s) are missing. 
The default payment type selected requires a Settlement Bank Account. Please enter the appropriate Settlement Bank Account information.  The default payment type selected requires a Settlement Bank Account. Please enter the appropriate Settlement Bank Account information. 
Enter a payment type that is associated with the Direct Debit payment method.   
Enter a Default Mandate with Active status.   
When no mandate is required, you cannot have a value in the Direct Debit Payment Type Reference and Default Mandate Reference fields.   
Customer Status Data field is not valid.   
A Customer Change Business Process Event is In-Progress. Cannot submit changes that impact this existing In-Progress event.   
A Customer Credit Change Business Process Event is In-Progress. You can’t submit credit changes while this event is running. Wait until after the event is complete to submit additional changes.   
Customer Credit Limit Currency is required if either Credit Limit or Hierarchy Credit Limit is specified.  Customer Credit Limit Currency is required if either Credit Limit or Hierarchy Credit Limit is specified. 
A Customer Payment Change Business Process Event is In-Progress. You can’t submit payment changes while this event is running. Wait until after the event is complete to submit additional changes.   
Customer Category Reference is required.  Customer Category Reference is required. 
Customer Name is required.   
Business Entity Data is required.   
Customer Name must match Business Entity Name.  Customer Name must match Business Entity Name. 
The document delivery options selected for email recipients are invalid for Dunning Letter.   
The document delivery options selected for email recipients are invalid for Customer Invoice.   
The document delivery options selected for email recipients are invalid for Customer Statement.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Invoices.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Cash Sale.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Customer Contracts.   
Customer is missing the following Restricted to Companies: [companies] Because there are In Progress Invoice Adjustments.   
The Customer Reference must match the Customer on the Direct Debit Mandate.   
top
 

Financial_InstitutionObject

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

Financial_InstitutionObjectID

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

Tax_AuthorityObject

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

Tax_AuthorityObjectID

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

InvestorObject

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

InvestorObjectID

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

OrganizationObject

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

LocaleObject

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

LocaleObjectID

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

User_LanguageObject

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

User_LanguageObjectID

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

CurrencyObject

part of: Customer_Balance_Data, Customer_WWS_Data, Customer_WWS_Data, Customer_WWS_Data, Settlement_Account_WWS_Data, Intermediary_Bank_Account_WWS_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
 

Tax_CodeObject

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

Tax_CodeObjectID

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

Tax_ID_Data

part of: Customer_WWS_Data
Tax ID Data element to specify 1 or more Tax IDs for a company.
 
Parameter name Type/Value Cardinality Description Validations
Tax_ID_Text  string  [0..1]  Enter the Tax ID value for the respective Tax Type. 
Validation Description
Invalid HMRC Office Number. HMRC Office Number must be 3 characters, numeric and in the range 001 – 999. Where applicable, leading zeroes must be present.   
Invalid Employer PAYE Reference number. Employer PAYE Reference must not exceed 10 characters, and must contain only alphanumeric or special characters.   
Invalid Employer Accounts Office Reference number: Characters 1-3 of Employer Accounts Office Reference number must be numeric. Character 4 of Employer Accounts Office Reference number must be 'P'. Character 5 of Employer Accounts Office Reference number must be alpha. Characters 6-12 of Employer Accounts Office Reference number must be numeric. Last digit of Employer Accounts Office Reference number must be numeric or ‘X’.   
Invalid ECON. ECON is nine characters in length and is formatted as follows: 1. Character 1 must be alpha - "E". 2. Characters 2 - 8 must be numeric in the range 3000000 - 3999999. 3. Character 9 must be Alpha. 4. The 9th character must pass the modulus 19 check. 5. Character 9 may not be "G", "I", "O", "S", "U", "V" or "Z".   
 
Tax_ID_Type_Reference  Tax_ID_TypeObject  [0..1]  Enter the Tax Type tied to the Tax ID value entered.   
Transaction_Tax_ID  boolean  [0..1]  Indicates if the Tax ID is used as the Transaction Tax ID for the country.   
Primary_Tax_ID  boolean  [0..1]  Indicates if the Tax ID is used as the Primary Tax ID.   
Validation Description
Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank.  Transaction Tax ID can only be selected when the Tax ID Type is selected as a Transaction Tax ID. Otherwise it must be blank. 
Enter the Identification # for the Transaction Tax ID.  Enter the Identification # for the Transaction Tax ID. 
You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax.  You can only select 1 Transaction Tax ID for a country. Unselect the Transaction Tax ID check box for the Tax IDs that you don't want to use for recording transaction tax. 
You can only have 1 Primary Tax ID.  You can only have 1 Primary Tax ID. 
You can only select the Tax ID Type once for a Country.  You can only select the Tax ID Type once for a Country. 
Tax ID Type cannot be used for a [businessEntityType]  The Tax ID Type selected for this Tax ID cannot be used in this webservice. 
The Country has conflicting Tax ID Types. Select 1 of these Tax ID Types for the Country: [taxIDTypes].  The Tax ID Type used is mutually exclusive with other Tax ID Types in the set. Only one can be used for the country. 
You can't change or delete tax IDs when they are in use on taxable documents. Delete the taxable documents or enter these tax IDs: [tax id]   
If HMRC Office Number, Employer PAYE Reference, or Employer Accounts Office Reference Number is defined, the three Tax IDs need to be defined.   
top
 

Tax_ID_TypeObject

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

Tax_ID_TypeObjectID

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

LockboxObject

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

LockboxObjectID

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

Customer_Security_SegmentObject

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

Customer_Security_SegmentObjectID

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

Customer_Business_Entity_WWS_Data

part of: Customer_WWS_Data
Business Entity Data Element which is a wrapper for all business entity data of name and contract information
 
Parameter name Type/Value Cardinality Description Validations
Business_Entity_Name  string  [1..1]  Business Entity Name is the name for the business entity. Business entities can not be duplicated across different business entity types, ie: a Customer can not have the same name as a Financial Institution unless they share the Business Entity.   
Business_Entity_Phonetic_Name  string  [0..1]  Represents the business entity name in phonetic characters. Before using, enable phonetic names in at least one language in the tenant setup.   
External_Entity_ID  string  [0..1]  External Entity ID. The External Entity ID can be used as a non unique reference to the same Business Entity in an external system.   
Contact_Data  Contact_Information_Data  [0..1]  Contact Information Data 
Validation Description
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request.  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request. 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
One and only one Institutional email address must be marked as primary.  One and only one Institutional email address must be marked as primary. 
One and only one Institutional phone must be marked as primary.  One and only one Institutional phone must be marked as primary. 
One and only one Institutional address must be marked as primary.  One and only one Institutional address must be marked as primary. 
One and only one Institutional instant messenger address must be marked as primary.  One and only one Institutional instant messenger address must be marked as primary. 
One and only one Institutional web address must be marked as primary.  One and only one Institutional web address must be marked as primary. 
Only one address of type International Assignment is allowed for a country.  Only one address of type International Assignment is allowed for a country. 
Only one address of type work from home is allowed.  Only one address of type work from home is allowed. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
At least one Primary Email must be specified in order to add an Additional Email  At least one Primary Email must be specified in order to add an Additional Email 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
At least one Primary Phone must be specified in order to add an Additional Phone  At least one Primary Phone must be specified in order to add an Additional Phone 
Either a phone number, or an email address must be specified for an emergency contact.  Either a phone number, or an email address must be specified for an emergency contact. 
Primary address on Ship-To location must have a use of [Shipping]  Primary address on Ship-To location must have a use of that maps to Shipping. 
 
Business_Entity_Logo_Image_Data  Business_Entity_Logo_Image_Data  [0..1]  Business Entity Logo Image Data is the logo data for the Business entity including filename and mime formatted image   
Validation Description
Usage Type is Invalid for this Contactable.   
Enable phonetic names in at least one language in the tenant setup.  Enable phonetic names in at least one language in the tenant setup. 
top
 

Contact_Information_Data

part of: Customer_Business_Entity_WWS_Data
All of the person's contact data (address, phone, email, instant messenger, web address).
 
Parameter name Type/Value Cardinality Description Validations
Address_Data  Address_Information_Data  [0..*]  Address information 
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
Enter a postal code in the valid format: [PostalCodeValidationMessage]   
Postal Code is required for [countryWithMustHavePostalCode]   
One or more addresses are missing a Country City reference. This field is required because the City Prompt localization is active for: [countryref].   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
International Assignment is only valid for Non-Primary Home Addresses   
Number of Days cannot be greater than 7.  Number of Days cannot be greater than 7. 
Number of Days is not allowed for the country specified.  Number of Days is not allowed for the country specified. 
You must enter a Country City reference instead of a text element because the City Prompt localization is active for: [countryref]. You entered this text element: [cityattrib] [citylocalattrib].   
You entered this Country City reference: [countrycityref]. To use this Country City reference, you must activate the City Prompt localization for: [countryref]. Perform either one of these actions: Activate the City Prompt localization. Enter a municipality instead of a Country City reference.   
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
 
Phone_Data  Phone_Information_Data  [0..*]  Phone Information 
Validation Description
Invalid Usage Type and Use For combination for Phone.  Invalid Usage Type and Use For combination for Phone. 
[country code] is not a valid country code for [country iso code]   
[country iso code] is not a valid country code   
You cannot specify the same usage type more than once for an address.   
Usage Data is required unless you are deleting a phone number.  Usage Data is required unless you are deleting a phone number. 
Phone Reference is required when you delete a phone number.  Phone Reference is required when you delete a phone number. 
You can't change a primary phone to an additional phone or an additional phone to a primary phone.  You can't change a primary phone to an additional phone or an additional phone to a primary phone. 
Phone Number is required unless you are deleting a phone number.  Phone Number is required unless you are deleting a phone number. 
You can't change the Usage Type of an existing phone.  You can't change the Usage Type of an existing phone. 
When Do Not Replace All is False for all phone elements, Delete can't be True.  When Do Not Replace All is False for all phone elements, Delete can't be True. 
Invalid Phone Reference or the phone number with this Phone Reference has been deleted.  Invalid Phone Reference or the phone number with this Phone Reference has been deleted. 
Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record.  Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record. 
When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference.  When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference. 
Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data'  Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data' 
Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data'  Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data' 
Phone "[ID]" is already in use by another phone (possibly on another contactable). Please choose a different Phone ID.  The Phone ID field is for updating the value of the Phone Reference. It cannot be the same as another existing phone. 
 
Email_Address_Data  Email_Address_Information_Data  [0..*]  Email Address Information 
Validation Description
Invalid Usage Type and Use For combination for Email Address.  Invalid Usage Type and Use For combination for Email Address. 
You cannot specify the same usage type more than once for an address.   
Email Reference is required when you delete an email address  Email Reference is required when you delete an email address 
Usage Data is required unless you are deleting an email address.  Usage Data is required unless you are deleting an email address. 
Email Address is required unless you are deleting an email address.  Email Address is required unless you are deleting an email address. 
When Do Not Replace All is False for all email elements, you can't pass an Email Reference.  When Do Not Replace All is False for all email elements, you can't pass an Email Reference. 
When Do Not Replace All is False for all email elements, Delete can't be True.  When Do Not Replace All is False for all email elements, Delete can't be True. 
You can't change a primary email to an additional email or an additional email to a primary email.  You can't change a primary email to an additional email or an additional email to a primary email. 
You can't change the Usage Type of an existing email address.  You can't change the Usage Type of an existing email address. 
Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record.  Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record. 
Invalid Email Reference or the email with this Email Reference has been deleted.  Invalid Email Reference or the email with this Email Reference has been deleted. 
Email "[ID]" is already in use by another email address (possibly on another contactable). Please choose a different Email ID.  The Email ID field is for updating the value of the Email Reference. It cannot be the same as another existing email. 
 
Instant_Messenger_Data  Instant_Messenger_Information_Data  [0..*]  Instant Messenger Information 
Validation Description
Invalid Usage Type and Use For combination for Instant Messenger Address.  Invalid Usage Type and Use For combination for Instant Messenger Address. 
You cannot specify the same usage type more than once for an address.   
You can't change the Usage Type of an existing Instant Messenger  You can't change the Usage Type of an existing Instant Messenger 
Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record.  Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record. 
You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger  You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger 
Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger.  Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger. 
When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True.  When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True. 
Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted.  Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted. 
When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference.  When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference. 
Instant Messenger Reference is required when you delete an instant messenger.  Instant Messenger Reference is required when you delete an instant messenger. 
Instant Messenger is required unless you are deleting an instant messenger.  Instant Messenger is required unless you are deleting an instant messenger. 
Instant Messenger "[ID]" is already in use by another instant messenger (possibly on another contactable). Please choose a different Instant Messenger ID.  The Instant Messenger ID field is for updating the value of the Instant Messenger Reference. It cannot be the same as another existing instant messenger. 
 
Web_Address_Data  Web_Address_Information_Data  [0..*]  Web Address Information 
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Usage Data is required unless you are deleting a Web Address.  Usage Data is required unless you are deleting a Web Address. 
Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record.  Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record. 
When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference.  When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference. 
You can't change a primary web address to an additional web address or an additional web address to a primary web address.  You can't change a primary web address to an additional web address or an additional web address to a primary web address. 
When Do Not Replace All is False for all web address elements, Delete can't be True.  When Do Not Replace All is False for all web address elements, Delete can't be True. 
Invalid Web Address Reference or the Web Address with this Reference has been deleted.  Invalid Web Address Reference or the Web Address with this Reference has been deleted. 
Web Address Reference is required when you delete a web address.  Web Address Reference is required when you delete a web address. 
Web Address is required unless you are deleting a web address.  Web Address is required unless you are deleting a web address. 
You can't change the Usage Type of an existing Web Address  You can't change the Usage Type of an existing Web Address 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Web Address "[ID]" is already in use by another web address (possibly on another contactable). Please choose a different Web Address ID.  The Web Address ID field is for updating the value of the Web Address Reference. It cannot be the same as another existing web address. 
 
Validation Description
One and only one work web address must be marked as primary.  One and only one work web address must be marked as primary. 
One and only one home web address must be marked as primary.  One and only one home web address must be marked as primary. 
One and only one business web address must be marked as primary.  One and only one business web address must be marked as primary. 
One and only one work instant messenger address must be marked as primary.  One and only one work instant messenger address must be marked as primary. 
One and only one home instant messenger address must be marked as primary.  One and only one home instant messenger address must be marked as primary. 
One and only one business instant messenger address must be marked as primary.  One and only one business instant messenger address must be marked as primary. 
One and only one work address must be marked as primary.  One and only one work address must be marked as primary. 
One and only one home address must be marked as primary.  One and only one home address must be marked as primary. 
One and only one lockbox address must be marked as primary.  One and only one lockbox address must be marked as primary. 
Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work web address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business email address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary lockbox address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary home instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business instant messenger address in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request.  Subject worker must have exactly one primary home phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request. 
Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary work phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request  Subject worker must have exactly one primary business phone number in order to submit non-primary entries. The primary contact information may be either previously entered or included within this request 
Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types.  Only one Primary Address change is allowed per request. However, the one Primary Address can share both home and work usage types. 
One and only one business address must be marked as primary.  One and only one business address must be marked as primary. 
One and only one Institutional email address must be marked as primary.  One and only one Institutional email address must be marked as primary. 
One and only one Institutional phone must be marked as primary.  One and only one Institutional phone must be marked as primary. 
One and only one Institutional address must be marked as primary.  One and only one Institutional address must be marked as primary. 
One and only one Institutional instant messenger address must be marked as primary.  One and only one Institutional instant messenger address must be marked as primary. 
One and only one Institutional web address must be marked as primary.  One and only one Institutional web address must be marked as primary. 
Only one address of type International Assignment is allowed for a country.  Only one address of type International Assignment is allowed for a country. 
Only one address of type work from home is allowed.  Only one address of type work from home is allowed. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
At least one Primary Email must be specified in order to add an Additional Email  At least one Primary Email must be specified in order to add an Additional Email 
One and only one work phone must be marked as primary.  One and only one work phone must be marked as primary. 
One and only one business email address must be marked as primary.  One and only one business email address must be marked as primary. 
One and only one home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one work email address must be marked as primary.  One and only one work email address must be marked as primary. 
One and only one home email address must be marked as primary.  One and only one home email address must be marked as primary. 
At least one Primary Phone must be specified in order to add an Additional Phone  At least one Primary Phone must be specified in order to add an Additional Phone 
Either a phone number, or an email address must be specified for an emergency contact.  Either a phone number, or an email address must be specified for an emergency contact. 
Primary address on Ship-To location must have a use of [Shipping]  Primary address on Ship-To location must have a use of that maps to Shipping. 
top
 

Address_Information_Data

part of: Contact_Information_Data
Address information
 
Parameter name Type/Value Cardinality Description Validations
@Formatted_Address  string  [1..1]  Returns the formatted address in the format specified for the country. This data is not used for inbound requests and any data provided in this element will be ignored.   
@Address_Format_Type  string  [1..1]  The format type of the address.   
@Defaulted_Business_Site_Address  boolean  [1..1]  Set to 1 if the address is a defaulted location address. If this value is 1, this address will not be processed for inbound web services.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced address. If this flag is set, the Reference ID field becomes required, and all other address fields that would otherwise be required will be optional and meaningless. 
Validation Description
The referenced address is in use as a primary home address and cannot be deleted.  The referenced address is in use as a primary home address and cannot be deleted. 
 
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary address data will be replaced. A value of true means only the referenced address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY address in the request.   
@Effective_Date  date  [1..1]  Effective date of address.   
Country_Reference  CountryObject  [0..1]  Country for the address.   
Last_Modified  dateTime  [0..1]  The moment when the address was last modified.   
Address_Line_Data  Address_Line_Information_Data  [0..*]  The address line for the address. This typically contains Street name, street number, apartment, suite number. 
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
 
Municipality  string  [0..1]  City part of the address.   
Country_City_Reference  Country_CityObject  [0..1]  Country city for the address.   
Submunicipality_Data  Submunicipality_Information_Data  [0..*]  The submunicipality of the address.   
Country_Region_Reference  Country_RegionObject  [0..1]  The region part of the address. Typically this contains the state/province information.   
Country_Region_Descriptor  string  [0..1]  The region part of the address. Typically this contains the state/province information.   
Subregion_Data  Subregion_Information_Data  [0..*]  The subregion part of the address.   
Postal_Code  string  [0..1]  The postal code part of the address.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Number_of_Days  decimal (1, 0) >0   [0..1]  Tracks the number of days an employee works from home per week.   
Municipality_Local  string  [0..1]  City in local script part of the address.   
Address_Reference  Address_ReferenceObject  [0..1]  The address Reference ID.   
Address_ID  string  [0..1]  New ID value used in address updates. The ID cannot already be in use by another address.   
Validation Description
Postal Code is not a valid address component for certain countries.  Postal Code is not a valid address component for certain countries. 
Municipality is not a valid address component for certain countries .  Municipality is not a valid address component for certain countries . 
Postal Code is required for certain countries.  Postal Code is required for certain countries. 
Municipality is required for certain countries.  Municipality is required for certain countries. 
Region Name must be valid for the specified Country.  Region Name must be valid for the specified Country. 
Usage Type and Use For combination must be valid for Address.  Usage Type and Use For combination must be valid for Address. 
Second Address Line is required for certain countries.  Second Address Line is required for certain countries. 
Third Address Line is required for certain countries.  Third Address Line is required for certain countries. 
Fourth Address Line is required for certain countries.  Fourth Address Line is required for certain countries. 
Subregion is required for certain countries.  Subregion is required for certain countries. 
Second Subregion is required for certain countries.  Second Subregion is required for certain countries. 
Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries.  Submunicipality (or City Subdivision - Local if configured on Tenant Setup Global) is required for certain countries. 
Second Submunicipality is required for certain countries.  Second Submunicipality is required for certain countries. 
Second Address Line is not a valid address component for certain countries.  Second Address Line is not a valid address component for certain countries. 
Third Address Line is not a valid address component for certain countries.  Third Address Line is not a valid address component for certain countries. 
Fourth Address Line is not a valid address component for certain countries.  Fourth Address Line is not a valid address component for certain countries. 
Subregion is not a valid address component for certain countries.  Subregion is not a valid address component for certain countries. 
Second Subregion is not a valid address component for certain countries.  Second Subregion is not a valid address component for certain countries. 
Submunicipality is not a valid address component for certain countries.  Submunicipality is not a valid address component for certain countries. 
Second Submunicipality is not a valid address component for certain countries.  Second Submunicipality is not a valid address component for certain countries. 
A maximum of four Submunicipalities are allowed in an address.  A maximum of four Submunicipalities are allowed in an address. 
A maximum of four Subregions are allowed in an address.  A maximum of four Subregions are allowed in an address. 
A maximum of four Address Lines are allowed in an address.  A maximum of four Address Lines are allowed in an address. 
Region is required for certain countries.  Region is required for certain countries. 
Home addresses which are not additionally used as work addresses cannot be marked as public.  Home addresses which are not additionally used as work addresses cannot be marked as public. 
[postal code] is not a valid postal code for [region]  Postal Code must be valid for the Region. 
Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 1 (or Address Line 1 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 1 is not valid for this Country.  Address Line 1 is not valid for this Country. 
Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country.  Address Line 2 (or Address Line 2 - Local if configured on Tenant Setup Global) is Required in this Country. 
Address Line 2 not Valid for this Country.  Address Line 2 not Valid for this Country. 
Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 3 (or Address Line 3 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 3 is not Valid for this Country.  Address Line 3 is not Valid for this Country. 
Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 4 (or Address Line 4 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 4 is not Valid for this Country.  Address Line 4 is not Valid for this Country. 
Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 5 (or Address Line 5 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 5 is not Valid for this Country.  Address Line 5 is not Valid for this Country. 
Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 6 (or Address Line 6 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 7 (or Address Line 7 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 7 is not Valid for this Country.  Address Line 7 is not Valid for this Country. 
Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 8 (or Address Line 8 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 8 is not Valid for this Country.  Address Line 8 is not Valid for this Country. 
Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country.  Address Line 9 (or Address Line 9 - Local if configured on Tenant Setup Global) is Required for this Country. 
Address Line 9 is not Valid for this Country.  Address Line 9 is not Valid for this Country. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Address Line 1 - Local is not valid for this Country.  Address Line 1 - Local is not valid for this Country. 
Municipality - Local is not a valid address component for certain countries .  Municipality - Local is not a valid address component for certain countries . 
Address Line 2 - Local is not valid for this Country.  Address Line 2 - Local is not valid for this Country. 
Address Line 3 - Local is not Valid for this Country.  Address Line 3 - Local is not Valid for this Country. 
Address Line 9 - Local is not Valid for this Country.  Address Line 9 - Local is not Valid for this Country. 
Address Line 8 - Local is not Valid for this Country.  Address Line 8 - Local is not Valid for this Country. 
Address Line 7 - Local is not Valid for this Country.  Address Line 7 - Local is not Valid for this Country. 
Address Line 6 is not Valid for this Country.  Address Line 6 is not Valid for this Country. 
Address Line 5 - Local is not Valid for this Country.  Address Line 5 - Local is not Valid for this Country. 
Address Line 4 - Local is not Valid for this Country.  Address Line 4 - Local is not Valid for this Country. 
City Subdivision 1 - Local is not a valid address component for certain countries.  City Subdivision 1 - Local is not a valid address component for certain countries. 
City Subdivision 2 - Local is not a valid address component for certain countries.  City Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 1 - Local is not a valid address component for certain countries.  Region Subdivision 1 - Local is not a valid address component for certain countries. 
Region Subdivision 2 - Local is not a valid address component for certain countries.  Region Subdivision 2 - Local is not a valid address component for certain countries. 
Region Subdivision 2 is not a valid address component for certain countries.  Region Subdivision 2 is not a valid address component for certain countries. 
City Subdivision 2 is not a valid address component for certain countries.  City Subdivision 2 is not a valid address component for certain countries. 
Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country.  Submunicipality ("City Subdivision 1", or "City Subdivision 1 - Local" if Local Script configured on tenant setup global) is required in this country. 
Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country.  Submunicipality (City Subdivision 2 or City Subdivision 2 - Local if Local Scripts configured on Tenant Setup - Global) are required for this Country. 
Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 1 (or Subregion 1 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country.  Subregion 2 (or Subregion 2 - Local if Local Scripts configured on Tenant Setup - Global) is required for this country. 
If one local script address field is submitted, all required local script address fields must be submitted.  If one local script address field is submitted, all required local script address fields must be submitted. 
Address Reference is required when deleting an address  Address Reference is required when deleting an address 
Usage Data is required unless address is being deleted  Usage Data is required unless address is being deleted 
Country Reference is required unless address is being deleted  Country Reference is required unless address is being deleted 
Address deletion is not supported in this web service request  Address deletion is not supported in this web service request 
If one western script field is submitted, all required western script address fields must be submitted.  If one western script field is submitted, all required western script address fields must be submitted. 
Address Reference must match an existing (and not deleted) address in use by the worker subject of this request  Address Reference must match an existing (and not deleted) address in use by the worker subject of this request 
Use a unique Address Reference ID for each address. [ID] is already used on another address.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
You can only update addresses that belong to this customer.   
You can't use an existing address for a new customer.   
Existing addresses can't be future dated. Select an effective date that is on or before today, or create a new address with a future date.   
The Address ID must match the Address Reference.   
You can't use an existing address for a new customer request.   
You can't use an existing address for a new prospect.   
You can only update addresses that belong to this customer request.   
You can only update addresses that belong to this prospect.   
Enter a postal code in the valid format: [PostalCodeValidationMessage]   
Postal Code is required for [countryWithMustHavePostalCode]   
One or more addresses are missing a Country City reference. This field is required because the City Prompt localization is active for: [countryref].   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
International Assignment is only valid for Non-Primary Home Addresses   
Number of Days cannot be greater than 7.  Number of Days cannot be greater than 7. 
Number of Days is not allowed for the country specified.  Number of Days is not allowed for the country specified. 
You must enter a Country City reference instead of a text element because the City Prompt localization is active for: [countryref]. You entered this text element: [cityattrib] [citylocalattrib].   
You entered this Country City reference: [countrycityref]. To use this Country City reference, you must activate the City Prompt localization for: [countryref]. Perform either one of these actions: Activate the City Prompt localization. Enter a municipality instead of a Country City reference.   
Address "[ID]" is already in use by another address (possibly on another contactable). Please choose a different Address ID.  The Address ID field is for updating the value of the Address Reference. It cannot be the same as another existing address. 
Address Line is required for certain countries.  Address Line is required for certain countries. 
top
 

CountryObject

part of: Address_Information_Data, Settlement_Account_WWS_Data, Intermediary_Bank_Account_WWS_Data, Tax_Status_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  CountryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Address_Line_Information_Data

part of: Address_Information_Data
The address line for the address. This typically contains Street name, street number, apartment, suite number.
 
Parameter name Type/Value Cardinality Description Validations
#text  string     
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
 
@Descriptor  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Apartment Number or Building Number) that helps describe the usage of the type (such as ADDRESS_LINE_5 and ADDRESS_LINE_6) for each country.   
@Type  string  [1..1]  Enter the address line type, such as ADDRESS_LINE_1, or ADDRESS_LINE_2.   
Validation Description
A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request.  A value is required on internal element 'Address Line Data'. If you do not want to set a value for a non-required type such as ADDRESS_LINE_2, remove it completely from the web service request. 
Type is required when you submit an Address Line Data.  Type is required when you submit an Address Line Data. 
The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL.  The Type isn't valid. Valid types include: ADDRESS_LINE_1 to ADDRESS_LINE_9, ADDRESS_LINE_1_LOCAL to ADDRESS_LINE_9_LOCAL, CITY, CITY_LOCAL, CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2, CITY_SUBDIVISION_1_LOCAL or CITY_SUBDIVISION_2_LOCAL, POSTAL_CODE, REGION, REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2, REGION_SUBDIVISION_1_LOCAL or REGION_SUBDIVISION_2_LOCAL. 
top
 

Country_CityObject

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

Country_CityObjectID

part of: Country_CityObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Country_Subregion_Code_In_Country, Country_Subregion_Internal_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, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [1..1]  The unique identifier type of a parent object   
top
 

Submunicipality_Information_Data

part of: Address_Information_Data
The submunicipality of the address.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Address_Component_Name  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Municipality or District) that helps describe the usage of the type (such as CITY_SUBDIVISION_1 or CITY_SUBDIVISION_2) for each country.   
@Type  string  [1..1]  The city subdivision part of the address.   
top
 

Country_RegionObject

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

Country_RegionObjectID

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

Subregion_Information_Data

part of: Address_Information_Data
The subregion part of the address.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@Descriptor  string  [1..1]  The descriptor is an optional serialized attribute that shows the text Override Label (such as Municipality or District) that helps describe the usage of the type (such as REGION_SUBDIVISION_1 or REGION_SUBDIVISION_2) for each country.   
@Type  string  [1..1]  Enter the region subdivision type, such as REGION_SUBDIVISION_1, or REGION_SUBDIVISION_2.   
top
 

Communication_Method_Usage_Information_Data

part of: Address_Information_Data, Phone_Information_Data, Email_Address_Information_Data, Instant_Messenger_Information_Data, Web_Address_Information_Data
Encapsulating element for all Communication Method Usage data.
 
Parameter name Type/Value Cardinality Description Validations
@Public  boolean  [1..1]  Indicates if the address is public.   
Type_Data  Communication_Usage_Type_Data  [1..*]  Reference ID for the communication usage type.   
Use_For_Reference  Communication_Usage_BehaviorObject  [0..*]  Reference ID for communication usage behavior.   
Use_For_Tenanted_Reference  Communication_Usage_Behavior_TenantedObject  [0..*]  Reference ID for communication usage behavior tenanted.   
Comments  string  [0..1]  Description of the address, phone, email, instant messenger, or web address.   
top
 

Communication_Usage_Type_Data

part of: Communication_Method_Usage_Information_Data
Reference ID for the communication usage type.
 
Parameter name Type/Value Cardinality Description Validations
@Primary  boolean  [1..1]  Indicates if the communication method is primary.   
Type_Reference  Communication_Usage_TypeObject  [1..1]  Reference ID for the communication usage type.   
top
 

Communication_Usage_TypeObject

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

Communication_Usage_TypeObjectID

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

Communication_Usage_BehaviorObject

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

Communication_Usage_BehaviorObjectID

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

Communication_Usage_Behavior_TenantedObject

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

Communication_Usage_Behavior_TenantedObjectID

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

Address_ReferenceObject

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

Address_ReferenceObjectID

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

Phone_Information_Data

part of: Contact_Information_Data
Phone Information
 
Parameter name Type/Value Cardinality Description Validations
@Area_Code  string  [1..1]  Area code number. 
Validation Description
Enter an area code in the valid format: [AreaCodeValidationMessage]   
 
@Tenant_Formatted_Phone  string  [1..1]  The Phone Number formatted according to tenant setup. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
@International_Formatted_Phone  string  [1..1]  The formatted International Phone number with Extension. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
@Phone_Number_Without_Area_Code  string  [1..1]  The Phone number. This data is not used in inbound requests.   
@National_Formatted_Phone  string  [1..1]  The formatted National Phone number with Extension. This data is not used in inbound requests.   
@E164_Formatted_Phone  string  [1..1]  The formatted E164 Phone number with Extension. This data is not used in inbound requests.   
@Workday_Traditional_Formatted_Phone  string  [1..1]  The formatted Workday Traditional Phone number with Extension. This data is not used in inbound requests.   
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced communication method. If this flag is set, the Reference ID field becomes required, and all other communication method fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary phone data will be replaced. A value of true means only the referenced phone will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY email address in the request.   
Country_ISO_Code  string (3)   [0..1]  Country ISO code. If the Country ISO code is specified, then this ISO code will be used to determine the Country Phone Code for (eliminate space between f and o) the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, 1 is the Country Phone Code that is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica, and Puerto Rico.)   
International_Phone_Code  string  [0..1]  International phone code number.   
Phone_Number  string  [0..1]  Full phone number. 
Validation Description
Invalid number: [PhoneValidationMessage]   
Only Numbers are allowed for Phone Number field when the Country associated with the Phone is listed in the 'Allowed Phone Validations' field in Tenant Setup - Global   
 
Phone_Extension  string  [0..1]  Phone extension.   
Phone_Device_Type_Reference  Phone_Device_TypeObject  [0..1]  Reference ID for Phone Device Type.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Phone_Reference  Phone_ReferenceObject  [0..1]  The Phone Reference ID.   
ID  string  [0..1]  New ID value used in phone updates. The ID cannot already be in use by another phone.   
Validation Description
Invalid Usage Type and Use For combination for Phone.  Invalid Usage Type and Use For combination for Phone. 
[country code] is not a valid country code for [country iso code]   
[country iso code] is not a valid country code   
You cannot specify the same usage type more than once for an address.   
Usage Data is required unless you are deleting a phone number.  Usage Data is required unless you are deleting a phone number. 
Phone Reference is required when you delete a phone number.  Phone Reference is required when you delete a phone number. 
You can't change a primary phone to an additional phone or an additional phone to a primary phone.  You can't change a primary phone to an additional phone or an additional phone to a primary phone. 
Phone Number is required unless you are deleting a phone number.  Phone Number is required unless you are deleting a phone number. 
You can't change the Usage Type of an existing phone.  You can't change the Usage Type of an existing phone. 
When Do Not Replace All is False for all phone elements, Delete can't be True.  When Do Not Replace All is False for all phone elements, Delete can't be True. 
Invalid Phone Reference or the phone number with this Phone Reference has been deleted.  Invalid Phone Reference or the phone number with this Phone Reference has been deleted. 
Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record.  Primary Phone can't be deleted when there are additional phones with the same Usage Type or the phone reference does not belong to the processing record. 
When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference.  When Do Not Replace All is False for all phone elements, you can't pass a Phone Reference. 
Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data'  Element Content 'Phone Device Type Reference' is required, on internal element 'Phone Information Data' 
Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data'  Either 'Country ISO Code' or 'International Phone Code' must be included on internal element 'Phone Information Data' 
Phone "[ID]" is already in use by another phone (possibly on another contactable). Please choose a different Phone ID.  The Phone ID field is for updating the value of the Phone Reference. It cannot be the same as another existing phone. 
top
 

Phone_Device_TypeObject

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

Phone_Device_TypeObjectID

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

Phone_ReferenceObject

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

Phone_ReferenceObjectID

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

Email_Address_Information_Data

part of: Contact_Information_Data
Email Address Information
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced email. If this flag is set, the Reference ID field becomes required, and all other email fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary email address data will be replaced. A value of true means only the referenced email address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY email address in the request.   
Email_Address  string  [0..1]  Email Address Information 
Validation Description
Email addresses must be in the format of 'xxx@yy.com'. Valid examples: john.doe@aol.com, jane@aol.com.   
 
Email_Comment  string  [0..1]  Email comments.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Email_Reference  Email_ReferenceObject  [0..1]  The email Reference ID.   
ID  string  [0..1]  New ID value used in email address updates. The ID cannot already be in use by another email address.   
Validation Description
Invalid Usage Type and Use For combination for Email Address.  Invalid Usage Type and Use For combination for Email Address. 
You cannot specify the same usage type more than once for an address.   
Email Reference is required when you delete an email address  Email Reference is required when you delete an email address 
Usage Data is required unless you are deleting an email address.  Usage Data is required unless you are deleting an email address. 
Email Address is required unless you are deleting an email address.  Email Address is required unless you are deleting an email address. 
When Do Not Replace All is False for all email elements, you can't pass an Email Reference.  When Do Not Replace All is False for all email elements, you can't pass an Email Reference. 
When Do Not Replace All is False for all email elements, Delete can't be True.  When Do Not Replace All is False for all email elements, Delete can't be True. 
You can't change a primary email to an additional email or an additional email to a primary email.  You can't change a primary email to an additional email or an additional email to a primary email. 
You can't change the Usage Type of an existing email address.  You can't change the Usage Type of an existing email address. 
Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record.  Primary Email Address can't be deleted when there are additional email addresses with the same Usage Type or the email address reference does not belong to the processing record. 
Invalid Email Reference or the email with this Email Reference has been deleted.  Invalid Email Reference or the email with this Email Reference has been deleted. 
Email "[ID]" is already in use by another email address (possibly on another contactable). Please choose a different Email ID.  The Email ID field is for updating the value of the Email Reference. It cannot be the same as another existing email. 
top
 

Email_ReferenceObject

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

Email_ReferenceObjectID

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

Instant_Messenger_Information_Data

part of: Contact_Information_Data
Instant Messenger Address.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced instant messenger. If this flag is set, the Reference ID field becomes required, and all other instant messenger fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary instant messenger data will be replaced. A value of true means only the referenced instant messenger will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY instant messenger in the request.   
Instant_Messenger_Address  string  [0..1]  Instant Messenger Address.   
Instant_Messenger_Type_Reference  Instant_Messenger_TypeObject  [0..1]  Reference ID for the instant messenger type. 
Validation Description
You must provide an Instant Messenger Type.   
 
Instant_Messenger_Comment  string  [0..1]  Instant messenger comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Instant_Messenger_Reference  Instant_Messenger_ReferenceObject  [0..1]  The Instant Messenger Reference   
ID  string  [0..1]  New ID value used in instant messenger updates. The ID cannot already be in use by another instant messenger.   
Validation Description
Invalid Usage Type and Use For combination for Instant Messenger Address.  Invalid Usage Type and Use For combination for Instant Messenger Address. 
You cannot specify the same usage type more than once for an address.   
You can't change the Usage Type of an existing Instant Messenger  You can't change the Usage Type of an existing Instant Messenger 
Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record.  Primary Instant Messenger can't be deleted when there are additional instant messengers with the same Usage Type or the instant messenger reference does not belong to the processing record. 
You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger  You can't change a primary instant messenger to an additional instant messenger or an additional instant messenger to a primary instant messenger 
Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger.  Instant Messenger Data and Usage Data is required unless you are deleting an Instant Messenger. 
When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True.  When Do Not Replace All is False for all Instant Messenger elements, Delete can't be True. 
Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted.  Invalid Instant Messenger Reference or the Instant Messenger with this Reference has been deleted. 
When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference.  When Do Not Replace All is False for all Instant Messenger elements, you can't pass an Instant Messenger Reference. 
Instant Messenger Reference is required when you delete an instant messenger.  Instant Messenger Reference is required when you delete an instant messenger. 
Instant Messenger is required unless you are deleting an instant messenger.  Instant Messenger is required unless you are deleting an instant messenger. 
Instant Messenger "[ID]" is already in use by another instant messenger (possibly on another contactable). Please choose a different Instant Messenger ID.  The Instant Messenger ID field is for updating the value of the Instant Messenger Reference. It cannot be the same as another existing instant messenger. 
top
 

Instant_Messenger_TypeObject

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

Instant_Messenger_TypeObjectID

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

Instant_Messenger_ReferenceObject

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

Instant_Messenger_ReferenceObjectID

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

Web_Address_Information_Data

part of: Contact_Information_Data
Web Address Information
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true in order to delete the referenced communication method. If this flag is set, the Reference ID field becomes required, and all other communication method fields that would otherwise be required will be optional and meaningless.   
@Do_Not_Replace_All  boolean  [1..1]  This flag controls whether or not existing non-primary web address data will be replaced. A value of true means only the referenced web address will be updated, or created if it does not exist or no reference was provided. This behavior is used if the flag is set to true for ANY web address in the request.   
Web_Address  string  [0..1]  Web address (Example: URL).   
Web_Address_Comment  string  [0..1]  Web address comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [0..*]  Encapsulating element for all Communication Method Usage data.   
Web_Address_Reference  Web_Address_ReferenceObject  [0..1]  The Web Address Reference Instance   
ID  string  [0..1]  New ID value used in web address updates. The ID cannot already be in use by another web address.   
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
You cannot specify the same usage type more than once for an address.  You cannot specify the same usage type more than once for an address. 
Usage Data is required unless you are deleting a Web Address.  Usage Data is required unless you are deleting a Web Address. 
Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record.  Primary Web Address can't be deleted when there are additional web addresses with the same Usage Type or the web address reference does not belong to the processing record. 
When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference.  When Do Not Replace All is False for all web address elements, you can't pass a Web Address Reference. 
You can't change a primary web address to an additional web address or an additional web address to a primary web address.  You can't change a primary web address to an additional web address or an additional web address to a primary web address. 
When Do Not Replace All is False for all web address elements, Delete can't be True.  When Do Not Replace All is False for all web address elements, Delete can't be True. 
Invalid Web Address Reference or the Web Address with this Reference has been deleted.  Invalid Web Address Reference or the Web Address with this Reference has been deleted. 
Web Address Reference is required when you delete a web address.  Web Address Reference is required when you delete a web address. 
Web Address is required unless you are deleting a web address.  Web Address is required unless you are deleting a web address. 
You can't change the Usage Type of an existing Web Address  You can't change the Usage Type of an existing Web Address 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
Web Address "[ID]" is already in use by another web address (possibly on another contactable). Please choose a different Web Address ID.  The Web Address ID field is for updating the value of the Web Address Reference. It cannot be the same as another existing web address. 
top
 

Web_Address_ReferenceObject

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

Web_Address_ReferenceObjectID

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

Business_Entity_Logo_Image_Data

part of: Customer_Business_Entity_WWS_Data
Business Entity Logo Image Data is an element containing the logo data.
 
Parameter name Type/Value Cardinality Description Validations
Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
Image  base64Binary  [0..1]  File content in binary format.   
top
 

Settlement_Account_WWS_Data

part of: Customer_WWS_Data
Settlement Account information including Bank Account Type, Currency, Routing Transit Number, etc. Bank Account Type becomes required when using v30.1 of the web service.
 
Parameter name Type/Value Cardinality Description Validations
Settlement_Bank_Account_ID  string  [0..1]  Settlement Bank Account ID is a unique ID to the Settlement Bank Account   
Country_Reference  CountryObject  [0..1]  Country Reference is a unique reference to a Country   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference is a unique reference to a Currency   
Bank_Account_Nickname  string  [0..1]  Bank Account Nickname   
Bank_Account_Type_Reference  Bank_Account_TypeObject  [0..1]  Bank Account Type Reference is a unique reference to a Bank Account   
Bank_Name  string  [0..1]  Bank Name   
Routing_Transit_Number  string  [0..1]  Routing Transit Number must adhere to bank routing account standards.   
Branch_ID  string  [0..1]  Branch ID   
Branch_Name  string  [0..1]  Branch Name   
Bank_Account_Number  string  [0..1]  Bank Account Number   
Check_Digit  string  [0..1]  Collects the check digit when it is not part of the bank id number   
Bank_Account_Name  string  [0..1]  Collects the bank account name   
Roll_Number  string  [0..1]  Collects the Roll number   
IBAN  string  [0..1]  International Bank Account Number (IBAN)   
SWIFT_Bank_Identification_Code  string  [0..1]  Society for Worldwide Interbank Financial Telecommunication (SWIFT) Bank Identification Code (BIC) 
Validation Description
Bank Identification Code (BIC) standard format can be between 8 to 11 characters. Generally, it should not be less than 8 characters or exceed 11 characters.   
The Bank Identification Code (BIC) entry is not following a standard format. Please refer to SWIFT guidelines for the format details.   
Bank Identification Code (BIC) standard format can be between 8 to 11 characters. Generally, it should not be less than 8 characters or exceed 11 characters.   
 
Accepts_Payment_Types_Reference  Payment_TypeObject  [0..*]  Accepts Payment Types Reference is a reference to accepts payment types for a supplier.   
Payment_Types_Reference  Payment_TypeObject  [0..*]  Only applicable for Suppliers. Reference to the Payment Types this Settlement Bank Account is intended for. Leave blank to designate this Settlement Bank Account as the default for all Payment Types. 
Validation Description
Payment Types can only be specified for Settlement Bank Accounts for Suppliers.  Payment Types can only be specified for Settlement Bank Accounts for Suppliers. 
 
For_Supplier_Connections_Only  boolean  [0..1]  Designates this Settlement Bank Account to be used for Supplier Connections only. 
Validation Description
You must use For Supplier Connections Only with settlement bank accounts for suppliers.   
You can't enter values in Payment Types Reference when you select For Supplier Connections Only.   
 
Requires_Prenote  boolean  [0..1]  Requires Prenote Reference   
Payment_Type_Prenote_Reference  Payment_TypeObject  [0..1]  Payment Type Prenote Reference   
Inactive  boolean  [0..1]  Indicates whether the Settlement Bank Account is inactive or active. A true value indicates the account is Inactive.   
Bank_Instructions  string  [0..1]  Bank Instructions for FFC (For Further Credit).   
Intermediary_Bank_Data  Intermediary_Bank_Account_WWS_Data  [0..*]  Intermediary Bank Account information including Order, Bank Account Type, Currency, Routing Transit Number, etc. 
Validation Description
Multiple Intermediary Banks cannot share the same Order value. More than one Intermediary Bank currently has an order of [order].   
Invalid IBAN number.   
IBAN is required for this country.  IBAN is required for this country. 
Country field is required for this bank account   
Support for submitting intermediary bank accounts is only on the Put Ad Hoc Payee, Submit Supplier and Submit Customer web services.   
 
Validation Description
Invalid IBAN number.   
Bank Format Error: [error_msg]   
Bank Account Format Error: [error_msg]   
Branch ID Format Error: [error_msg]   
IBAN is required for this country.  IBAN is required for this country. 
Routing Transit or Institution Number is required for this country.  Routing Transit or Institution Number is required for this country. 
Financial Account Number is required for this country.  Financial Account Number is required for this country. 
Roll number is required for this country.   
Check Digit is required for this country.   
Bank Account Name is required for this country.   
Branch name is required for this country.   
Branch ID is required for this country.   
Country field is required for this bank account   
[digit_format_error_msg]   
Bank Instructions are only valid for a Customer, Supplier, Ad Hoc Payment, Ad Hoc Payee, Investor, or Tax Authority.   
The check sum validation failed for the entered Routing Transit Number. Please verify it against the Routing Transit Number provided by your financial institution.   
Bank Name is required for this Country   
SWIFT BIC is required for this Country   
Bank Format Error: [error_msg]   
Prenote Payment Type is required and must have a valid value.   
Use a unique Settlement Bank Account ID for each settlement account. [ID] is already used on another settlement account.   
Bank Account Type is required.   
top
 

Bank_Account_TypeObject

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

Bank_Account_TypeObjectID

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

Intermediary_Bank_Account_WWS_Data

part of: Settlement_Account_WWS_Data
Intermediary Bank Account information including Order, Bank Account Type, Currency, Routing Transit Number, etc.
 
Parameter name Type/Value Cardinality Description Validations
Intermediary_Bank_Account_ID  string  [0..1]  Intermediary Bank Account ID   
Intermediary_Bank_Order  string (6)   [0..1]  Alphanumeric order of the Intermediary Banks. Two Intermediary Banks for the same Settlement Account cannot share the same order value. 
Validation Description
Two Intermediary Banks cannot share the same Order value.   
 
Country_Reference  CountryObject  [0..1]  Country Reference is a unique reference to a Country   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference is a unique reference to a Currency   
Bank_Account_Nickname  string  [0..1]  Bank Account Nickname   
Bank_Account_Type_Reference  Bank_Account_TypeObject  [0..1]  Bank Account Type Reference is a unique reference to a Bank Account   
Bank_Name  string  [0..1]  Bank Name   
Routing_Transit_Number  string  [0..1]  Routing Transit Number must adhere to bank routing account standards.   
Branch_ID  string  [0..1]  Branch ID   
Branch_Name  string  [0..1]  Branch Name   
Bank_Account_Number  string  [0..1]  Bank Account Number   
Check_Digit  string  [0..1]  Collects the check digit when it is not part of the bank id number   
Bank_Account_Name  string  [0..1]  Collects the bank account name   
Roll_Number  string  [0..1]  Collects the Roll number   
IBAN  string  [0..1]  International Bank Account Number (IBAN)   
SWIFT_Bank_Identification_Code  string  [0..1]  Society for Worldwide Interbank Financial Telecommunication (SWIFT) Bank Identification Code (BIC) 
Validation Description
Bank Identification Code (BIC) standard format can be between 8 to 11 characters. Generally, it should not be less than 8 characters or exceed 11 characters.   
The Bank Identification Code (BIC) entry is not following a standard format. Please refer to SWIFT guidelines for the format details.   
Bank Identification Code (BIC) standard format can be between 8 to 11 characters. Generally, it should not be less than 8 characters or exceed 11 characters.   
 
Inactive  boolean  [0..1]  Indicates whether the Settlement Bank Account is inactive or active. A true value indicates the account is Inactive.   
Bank_Instructions  string  [0..1]  Bank Instructions for FFC (For Further Credit).   
Validation Description
Multiple Intermediary Banks cannot share the same Order value. More than one Intermediary Bank currently has an order of [order].   
Invalid IBAN number.   
IBAN is required for this country.  IBAN is required for this country. 
Country field is required for this bank account   
Support for submitting intermediary bank accounts is only on the Put Ad Hoc Payee, Submit Supplier and Submit Customer web services.   
top
 

Customer_Credit_Card_Profile_WWS_Data

part of: Customer_WWS_Data
Credit Card Data is the Customer Credit Card Information data.
 
Parameter name Type/Value Cardinality Description Validations
Merchant_Customer_Profile_ID  string  [0..1]  Uniquely identifies a Customer Credit Card Profile instance.   
Primary_Card  boolean  [0..1]  Identifies whether the profile is the primary card used for customer payments.   
Merchant_Account_Reference  Merchant_AccountObject  [1..1]  Reference to the merchant account used for a given customer profile.   
Credit_Card_Type_Reference  Credit_Card_TypeObject  [0..1]  Identifies the type of credit card for this entry. (Visa, Mastercard, American Express, etc.)   
First_Name  string  [1..1]  First name of the credit card holder.   
Last_Name  string  [1..1]  Last name of the credit card holder.   
Expiration_Date  date  [0..1]  Expiration Date of the Credit Card to be used.   
Last_4_Digits_of_Credit_Card_Number  string (4)   [0..1]  Last 4 digits of the Credit Card Number to be used.   
Customer_Profile_ID  string  [0..1]  The unique Customer Profile ID used within the Payment Service Provider system.   
top
 

Merchant_AccountObject

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

Merchant_AccountObjectID

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

Credit_Card_TypeObject

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

Credit_Card_TypeObjectID

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

Document_StatusObject

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

Document_StatusObjectID

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

Customer_Status_Data

part of: Customer_WWS_Data
Customer Status Data is a wrapper element for Customer Status data including status, reason for change reference and description
 
Parameter name Type/Value Cardinality Description Validations
Customer_Status_Value_Reference  Business_Entity_Status_ValueObject  [1..1]  Status Value Reference is a unique reference to a Business Entity Status   
Reason_for_Customer_Status_Change_Reference  Reason_for_Customer_Status_ChangeObject  [0..1]  Reason for Customer Status Change Reference is a unique reference to a Customer Status Change Reason   
Customer_Status_Change_Reason_Description  string  [0..1]  Status Change Reason Description   
Validation Description
The Customer Status Change Reason is required if the Customer Status has changed.  The Customer Status Change Reason is required if the Customer Status has changed. 
top
 

Customer_Proposed_Status_Data

part of: Customer_WWS_Data
Customer Proposed Status Data is a wrapper element for Customer Status data including status, reason for change reference and description
 
Parameter name Type/Value Cardinality Description Validations
Customer_Status_Value_Reference  Business_Entity_Status_ValueObject  [1..1]  Status Value Reference is a unique reference to a Business Entity Status   
Reason_for_Customer_Status_Change_Reference  Reason_for_Customer_Status_ChangeObject  [0..1]  Status Change Reason Description   
Customer_Status_Change_Reason_Description  string  [0..1]  Reason for Customer Status Change Reference is a unique reference to a Customer Status Change Reason   
top
 

Delivery_MethodObject

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

Delivery_MethodObjectID

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

Customer_Document_Email_Recipient_OptionObject

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

Customer_Document_Email_Recipient_OptionObjectID

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

Direct_Debit_MandateObject

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

Direct_Debit_MandateObjectID

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

Business_Entity_Alternate_Name_Data

part of: Customer_WWS_Data
Business Entity Alternate Name Data
 
Parameter name Type/Value Cardinality Description Validations
Alternate_Name  string  [1..1]  Business Entity Alternate Name   
Alternate_Name_Usage_Reference  Alternate_Name_UsageObject  [1..*]  Reference to an existing Business Entity Alternate Name Usage. The Usages are supplied by Workday. Valid values for Supplier are: IRS_1099_RECIPIENT, REMIT_TO_ADDRESSEE_1. REMIT_TO_ADDRESSEE_2, REMIT_TO_ADVICE_NAME, REMIT_TO_PAYEE. Valid values for Customer are: REMIT_TO_ADDRESSEE_1. REMIT_TO_ADDRESSEE_2, REMIT_TO_ADVICE_NAME, REMIT_TO_PAYEE, BILL_TO_ADDRESSEE_1, BILL_TO_ADDRESSEE_2   
Validation Description
The alternate name usage is not valid for a Supplier  The alternate name usage is not valid for a Supplier 
The alternate name usage is not valid for a Customer  The alternate name usage is not valid for a Customer 
The alternate name usage is not valid for an Investor.  The alternate name usage is not valid for an Investor. 
top
 

Alternate_Name_UsageObject

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

Alternate_Name_UsageObjectID

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

Tax_Status_Data

part of: Customer_WWS_Data
Tax Status Data element to specify 1 or more Tax Statuses for a company.
 
Parameter name Type/Value Cardinality Description Validations
Tax_Status_Reference  Unique_IdentifierObject  [0..1]  Tax Status Reference   
Country_Reference  CountryObject  [1..1]  Country for Tax Status   
Transaction_Tax_Status_Reference  Transaction_Tax_StatusObject  [0..1]  Company's Transaction Tax Status for the country.   
Withholding_Tax_Status_Reference  Withholding_Tax_StatusObject  [0..1]  Company's Withholding Tax Status for the country.   
Validation Description
Select a Transaction Tax Status or Withholding Tax Status for the Country.   
The selected Country is already in use.   
top
 

Unique_IdentifierObject

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

Transaction_Tax_StatusObject

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

Transaction_Tax_StatusObjectID

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

Withholding_Tax_StatusObject

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

Withholding_Tax_StatusObjectID

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

Financials_Attachment_Data

part of: Customer_WWS_Data
Encapsulating element containing all Business Document Attachment data.
 
Parameter name Type/Value Cardinality Description Validations
@Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
@Filename  string (255)   [1..1]  Text attribute identifying Filename of the Attachment.   
@Encoding  string  [1..1]  Text attribute identifying Encoding of the Attachment.   
@Compressed  boolean  [1..1]  Boolean attribute identifying whether the Attachment is compressed.   
File_Content  base64Binary  [0..1]  File content in binary format.   
Comment  string  [0..1]  Comment   
Validation Description
If a file name is specified for a Financial Attachment, File Content and Content Type are required.   
top
 

Note_WWS_Data

part of: Customer_WWS_Data
Includes Notes that have been made for a business object. On a Get operation, all existing Notes will be populated. On a Put or Submit operation, any note information on the request will be added as new notes. Existing notes cannot be updated on a Put or Submit request.
 
Parameter name Type/Value Cardinality Description Validations
Created  dateTime  [0..1]  The date and time this Note was created. On a Put or Submit operation, this field is ignored, and will be overwritten with the current date and time.   
Last_Updated  dateTime  [0..1]  The date and time this Note was last updated. On a Put or Submit operation, this field is ignored, and will be overwritten with the current date and time.   
Worker_Reference  WorkerObject  [0..1]  The Worker who created this Note (if the person who created it is a Worker). On a Put or Submit operation, this field is ignored, and will be overwritten by the person processing the request.   
Business_Entity_Contact_Reference  Business_Entity_ContactObject  [0..1]  The Business Entity Contact who created this Note (if the person who created it is a Business Entity Contact and not a Worker). On a Put or Submit operation, this field is ignored, and will be overwritten with the person processing the request.   
System_User_Reference  System_UserObject  [0..1]  The System User who created this Note (if the person who created it is neither a Business Entity Contact nor a Worker). On a Put or Submit operation, this field is ignored, and will be overwritten with the person processing the request.   
Note_Content  RichText  [0..1]  The main text content for this Note.   
top
 

WorkerObject

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

WorkerObjectID

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

Business_Entity_ContactObject

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

Business_Entity_ContactObjectID

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

System_UserObject

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

System_UserObjectID

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

Related_Worktag_Widget_Data

part of: Customer_WWS_Data
Reference to the existing Allowed or Default Related Worktags.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  All existing related worktags (both allowed and default) are replaced with the ones specified in the request. It will supersede any "remove all" or delete option set to True by worktag type. When True, a default value must be provided for all worktag types that are configured with 'Default Required' in the 'Maintain Related Worktag Usage'.   
Related_Worktags_by_Type_Data  Related_Worktags_by_Worktag_Type_Data  [0..*]  Allowed and Default Related Worktags Data by Worktag Type. 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
top
 

Related_Worktags_by_Worktag_Type_Data

part of: Related_Worktag_Widget_Data
Allowed and Default Related Worktags Data by Worktag Type.
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..1]  The Worktag Type Reference ID cannot be duplicated within one request. Valid ID types for all worktag types that can be configured for a related worktag taggable type may include: BUSINESS_SITE, BUSINESS_UNIT, COST_CENTER, CUSTOM_ORGANIZATION_01-10, CUSTOM_WORKTAG_1-10, FUND, GIFT, GRANT, INVESTOR, OPPORTUNITY, PROGRAM, PROJECT, PROJECT_PHASE, PROJECT_TASK, REGION, SALES_ITEM.   
Required_On_Transaction  boolean  [0..1]  Boolean to indicate if the Worktag Type will be required on a transaction when a value for the worktag type that has related values is entered.   
Required_On_Transaction_For_Validation  boolean  [0..1]  Boolean to indicate if 'Required on Transaction' is enabled in either 'Maintain Related Worktag Usage' or on the Worktag instance. When you generate an EIB template with data, 'y' is returned when either boolean is true. This boolean is informational only in the 'Put' operation.   
Default_Worktag_Data  Default_Worktag_Data  [0..1]  Reference to existing Default Realted Worktag or Add new Default Related Worktag 
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Replace_All_Allowed_Values  boolean  [0..1]  Boolean to indicate that all existing allowed values are to be deleted. When set to true ('y' in EIB), if allowed values are also specified, they will become the new set of allowed values.   
Allowed_Worktag_Data  Allowed_Worktag_Data  [0..*]  Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags 
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

Default_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Default Realted Worktag or Add new Default Related Worktag
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Default_Value  boolean  [1..1]  Boolean to indicate if existing default value is to be deleted. The existing default value must be correctly specified. Do not set to true (or 'y' in EIB) to replace the existing default value.   
Default_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Family_Group_ID, Job_Family_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_Group_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Allowed_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Allowed_Value  boolean  [1..1]  Boolean to indicate that specified allowed values are to be deleted. At least 1 existing allowed value must be specified When set to true (or 'y' in EIB). Cannot be set to true if 'Replace All Allowed Values' is set to true.   
Allowed_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_Hierarchy_ID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Customer_Balance_Data

part of: Customer
This Element contains the overall Customer Balance calculated attributes.
 
Parameter name Type/Value Cardinality Description Validations
Default_Currency_Reference  CurrencyObject  [0..1]  Currency Reference   
YTD_Sales_Amount  decimal (26, 6)   [0..1]  Total Purchase Amount for Supplier, Company, and Date Range   
Total_Balance  decimal (26, 6)   [0..1]  Customer Total Balance   
Last_12_Months_Sales_Amount  decimal (26, 6)   [0..1]  Last 12 Months Sales Amount   
Overdue_Balance  decimal (26, 6)   [0..1]  Overdue Balance   
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

Transaction_LogReferenceEnumeration

part of: Transaction_LogObjectID
Base Type
string
top
 

Reporting_TransactionReferenceEnumeration

part of: Reporting_TransactionObjectID
Base Type
string
top
 

Base Type
string

top
 

Customer_CategoryReferenceEnumeration

part of: Customer_CategoryObjectID
Base Type
string
top
 

Customer_GroupReferenceEnumeration

part of: Customer_GroupObjectID
Base Type
string
top
 

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top
 

Business_Entity_Status_ValueReferenceEnumeration

part of: Business_Entity_Status_ValueObjectID
Base Type
string
top
 

Reason_for_Customer_Status_ChangeReferenceEnumeration

part of: Reason_for_Customer_Status_ChangeObjectID
Base Type
string
top
 

Financial_InstitutionReferenceEnumeration

part of: Financial_InstitutionObjectID
Base Type
string
top
 

SupplierReferenceEnumeration

part of: SupplierObjectID
Base Type
string
top
 

Tax_AuthorityReferenceEnumeration

part of: Tax_AuthorityObjectID
Base Type
string
top
 

InvestorReferenceEnumeration

part of: InvestorObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

LocaleReferenceEnumeration

part of: LocaleObjectID
Base Type
string
top
 

User_LanguageReferenceEnumeration

part of: User_LanguageObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Tax_CodeReferenceEnumeration

part of: Tax_CodeObjectID
Base Type
string
top
 

Tax_ID_TypeReferenceEnumeration

part of: Tax_ID_TypeObjectID
Base Type
string
top
 

LockboxReferenceEnumeration

part of: LockboxObjectID
Base Type
string
top
 

Customer_Security_SegmentReferenceEnumeration

part of: Customer_Security_SegmentObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Country_CityReferenceEnumeration

part of: Country_CityObjectID
Base Type
string
top
 

Base Type
string

top
 

Country_RegionReferenceEnumeration

part of: Country_RegionObjectID
Base Type
string
top
 

Communication_Usage_TypeReferenceEnumeration

part of: Communication_Usage_TypeObjectID
Base Type
string
top
 

Communication_Usage_BehaviorReferenceEnumeration

part of: Communication_Usage_BehaviorObjectID
Base Type
string
top
 

Communication_Usage_Behavior_TenantedReferenceEnumeration

part of: Communication_Usage_Behavior_TenantedObjectID
Base Type
string
top
 

Address_ReferenceReferenceEnumeration

part of: Address_ReferenceObjectID
Base Type
string
top
 

Phone_Device_TypeReferenceEnumeration

part of: Phone_Device_TypeObjectID
Base Type
string
top
 

Phone_ReferenceReferenceEnumeration

part of: Phone_ReferenceObjectID
Base Type
string
top
 

Email_ReferenceReferenceEnumeration

part of: Email_ReferenceObjectID
Base Type
string
top
 

Instant_Messenger_TypeReferenceEnumeration

part of: Instant_Messenger_TypeObjectID
Base Type
string
top
 

Instant_Messenger_ReferenceReferenceEnumeration

part of: Instant_Messenger_ReferenceObjectID
Base Type
string
top
 

Web_Address_ReferenceReferenceEnumeration

part of: Web_Address_ReferenceObjectID
Base Type
string
top
 

Bank_Account_TypeReferenceEnumeration

part of: Bank_Account_TypeObjectID
Base Type
string
top
 

Merchant_AccountReferenceEnumeration

part of: Merchant_AccountObjectID
Base Type
string
top
 

Credit_Card_TypeReferenceEnumeration

part of: Credit_Card_TypeObjectID
Base Type
string
top
 

Document_StatusReferenceEnumeration

part of: Document_StatusObjectID
Base Type
string
top
 

Delivery_MethodReferenceEnumeration

part of: Delivery_MethodObjectID
Base Type
string
top
 

Customer_Document_Email_Recipient_OptionReferenceEnumeration

part of: Customer_Document_Email_Recipient_OptionObjectID
Base Type
string
top
 

Direct_Debit_MandateReferenceEnumeration

part of: Direct_Debit_MandateObjectID
Base Type
string
top
 

Alternate_Name_UsageReferenceEnumeration

part of: Alternate_Name_UsageObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Transaction_Tax_StatusReferenceEnumeration

part of: Transaction_Tax_StatusObjectID
Base Type
string
top
 

Withholding_Tax_StatusReferenceEnumeration

part of: Withholding_Tax_StatusObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Business_Entity_ContactReferenceEnumeration

part of: Business_Entity_ContactObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

RichText

part of: Note_WWS_Data
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top