Service Directory > v25.1 > Revenue_Management > Put_Sponsor
 

Operation: Put_Sponsor

This service operation will add or update a Sponsor. Sponsor data includes Sponsor ID, Sponsor Reference ID, Sponsor Name, Sponsor Type, Payment Terms, default Payment Type, Business Entity data, Settlement Account data, Customer Status data, Remit-From Sponsor, default Currency, Accepted Currencies, 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.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Put_Sponsor_Request

Element containing Sponsor reference for update and all Sponsor data items
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Sponsor_Reference  SponsorObject  [0..1]  Reference to an existing Sponsor for update purposes only.   
Sponsor_Data  Sponsor_WWS_Data  [1..1]  Sponsor Data 
Validation Description
The default payment type selected requires a Settlement Bank Account. Please enter the appropriate Settlement Bank Account information.   
Sponsor Name must match Business Entity Name.   
Only one active Settlement Bank Account allowed for the given 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.   
Business Entity Data is required.   
Business Entity to create from is only applicable when creating a Customer, not updating an existing Customer   
One or more of the Sponsor Children provided belong to another Sponsor Hierarchy. A Sponsor must be uniquely assigned to a hierarchy.   
Assigning this Sponsor as a child of the Sponsor provided would create a circular reference. Only Sponsors that are not parents of the Sponsor being processed may be assigned.   
Default Currency needs to be amongst accepted currencies for Sponsor.   
You cannot select a remit-from sponsor for this sponsor because it is the remit-from sponsor for at least 1 other sponsor.   
Remit-from Sponsor cannot be the same as the Entry Sponsor.   
Cannot remove an accepted currency because it may already be in use.   
You cannot select a remit-from sponsor who has a different remit-from sponsor than itself.   
Only one worktag for each type is allowed for each Sponsor.   
Worktags can not have any combination of Project, Project Plan Phase or Project Plan Task worktags, only one is allowed.   
The following Related Worktags are required but have not been assigned: [missing].   
 
Validation Description
The Web Service is set to Add Only; but the Sponsor already exists.   
top
 

Response Element: Put_Sponsor_Response

Element containing Put Sponsor Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Sponsor_Reference  SponsorObject  [0..1]  This is the Reference ID value of the newly-created Sponsor that was submitted via this Put request.   
top
 

SponsorObject

part of: Put_Sponsor_Request, Put_Sponsor_Response, Sponsor_WWS_Data, Sponsor_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  SponsorObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

SponsorObjectID

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

Sponsor_WWS_Data

part of: Put_Sponsor_Request
This Element contains Sponsor relationships and attributes
 
Parameter name Type/Value Cardinality Description Validations
Sponsor_ID  string  [0..1]  Sponsor ID. This is a unique identifier for the Sponsor   
Sponsor_Reference_ID  string  [0..1]  Sponsor Reference ID. The Sponsor Reference ID can be used to uniquely identify a Sponsor. Unlike Sponsor ID, Workday will not automatically generate a Sponsor Reference ID if one is not received. The recommended use for Sponsor Reference ID is where Workday is not the source system of the Sponsor.   
Sponsor_Name  string  [1..1]  Sponsor Name   
Sponsor_Type_Reference  Sponsor_TypeObject  [1..1]  Reference to the Sponsor Type for this Sponsor   
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.   
Business_Entity_Data  Business_Entity_WWS_Data  [0..*]  Business Entity Data Element which is a wrapper for all business entity data of name and contract information 
Validation Description
Usage Type is Invalid for this Contactable.  Usage Type is Invalid for this Contactable. 
 
Settlement_Account_Data  Settlement_Account_WWS_Data  [0..*]  Settlement Account information including Bank Account Type, Currency, Routing Transit Number, etc. 
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.   
 
Customer_Status_Data  Customer_Status_Data  [0..*]  Customer Status Data is a wrapper element for Customer Status data including status, reason for change reference and 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. 
 
Remit-from_Sponsor_Reference  SponsorObject  [0..1]  Remit-from Sponsor. This is an optional reference to a Sponsor that pays the entered Sponsor.   
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.   
Invoice_Delivery_Method_Reference  Delivery_MethodObject  [0..*]  Invoice Delivery Method, either Email or Print, specifying how Customer Invoices will be delivered for this Customer.   
Statement_Delivery_Method_Reference  Delivery_MethodObject  [0..1]  Statement Delivery Method, either Email or Print, specifying how Customer Statements will be delivered for this Sponsor.   
Included_Children_Reference  SponsorObject  [0..*]  Reference to Sponsors who are considered 'children' of this Sponsor. Used for creating a Sponsor Hierarchy.   
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. 
 
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.   
Worktags_Reference  Accounting_WorktagObject  [0..*]  Reference to existing Worktags or Add new Worktags 
Validation Description
[types] worktag types are not valid for this transaction.  The Worktags provided are not valid for this transaction 
 
Validation Description
The default payment type selected requires a Settlement Bank Account. Please enter the appropriate Settlement Bank Account information.   
Sponsor Name must match Business Entity Name.   
Only one active Settlement Bank Account allowed for the given 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.   
Business Entity Data is required.   
Business Entity to create from is only applicable when creating a Customer, not updating an existing Customer   
One or more of the Sponsor Children provided belong to another Sponsor Hierarchy. A Sponsor must be uniquely assigned to a hierarchy.   
Assigning this Sponsor as a child of the Sponsor provided would create a circular reference. Only Sponsors that are not parents of the Sponsor being processed may be assigned.   
Default Currency needs to be amongst accepted currencies for Sponsor.   
You cannot select a remit-from sponsor for this sponsor because it is the remit-from sponsor for at least 1 other sponsor.   
Remit-from Sponsor cannot be the same as the Entry Sponsor.   
Cannot remove an accepted currency because it may already be in use.   
You cannot select a remit-from sponsor who has a different remit-from sponsor than itself.   
Only one worktag for each type is allowed for each Sponsor.   
Worktags can not have any combination of Project, Project Plan Phase or Project Plan Task worktags, only one is allowed.   
The following Related Worktags are required but have not been assigned: [missing].   
top
 

Sponsor_TypeObject

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

Sponsor_TypeObjectID

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

Payment_TermsObject

part of: Sponsor_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: Settlement_Account_WWS_Data, Settlement_Account_WWS_Data, Settlement_Account_WWS_Data, Sponsor_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_WWS_Data

part of: Sponsor_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_Tax_ID  string  [0..1]  Business Entity Tax ID   
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 email address must be marked as primary.  One and only one work email address 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 email address must be marked as primary.  One and only one home email address must be marked as primary. 
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 home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
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. 
 
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.  Usage Type is Invalid for this Contactable. 
top
 

Contact_Information_Data

part of: 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. 
Address Line is required for certain countries.  Address Line 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 
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. 
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].   
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.   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
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].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
 
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.   
Element Content 'Phone Number' is required, on internal element 'Phone Information Data'  Element Content 'Phone Number' is required, on internal element 'Phone Information Data' 
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' 
 
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.   
 
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.   
 
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. 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
You cannot specify the same usage type more than once for an address.   
 
Validation Description
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 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 email address must be marked as primary.  One and only one home email address must be marked as primary. 
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 home phone must be marked as primary.  One and only one home phone must be marked as primary. 
One and only one business phone must be marked as primary.  One and only one business phone must be marked as primary. 
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. 
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. 
 
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.   
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.   
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. 
Address Line is required for certain countries.  Address Line 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 
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. 
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].   
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.   
Enter a Country City reference that is valid for: [countryref]. You entered this Country City reference: [countrycityref].   
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].   
Only Address reference belonging to the Customer tied to the Customer Contact can be shared by the Customer Contact   
top
 

CountryObject

part of: Address_Information_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  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. 
 
@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. 
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  [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..*]  Encapsulation element for the Communication Usage Type.   
Use_For_Reference  Communication_Usage_BehaviorObject  [0..*]  Reference ID for Communication Usage Behavior. 
Validation Description
Please provide usages that are Workday Owned or Tenanted - not both.   
 
Use_For_Tenanted_Reference  Communication_Usage_Behavior_TenantedObject  [0..*]  Reference ID for Communication Usage Behavior Tenanted. 
Validation Description
Please provide usages that are Workday Owned or Tenanted - not both.   
 
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
Encapsulation element 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
@Formatted_Phone  string  [1..1]  The formatted Phone number. This data is not used in inbound requests. Any data provided for this attribute will be ignored.   
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 f or the phone. Pass this ISO code to distinguish between multiple countries sharing the same Country Phone Code. (For example, Country Phone Code '1' is shared by USA, Canada, Dominican Republic, Bermuda, Jamaica and Puerto Rico)   
International_Phone_Code  string  [0..1]  International Phone Code Number   
Area_Code  string  [0..1]  Area Code Number 
Validation Description
Enter an area code in the valid format: [AreaCodeValidationMessage]   
 
Phone_Number  string  [0..1]  Phone Number 
Validation Description
Enter a phone number in the valid format: [PhoneValidationMessage].   
 
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  [1..*]  Encapsulating element for all Communication Method Usage data.   
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.   
Element Content 'Phone Number' is required, on internal element 'Phone Information Data'  Element Content 'Phone Number' is required, on internal element 'Phone Information Data' 
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' 
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
 

Email_Address_Information_Data

part of: Contact_Information_Data
Email Address Information
 
Parameter name Type/Value Cardinality Description Validations
Email_Address  string  [1..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  [1..*]  Encapsulating element for all Communication Method Usage data.   
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.   
top
 

Instant_Messenger_Information_Data

part of: Contact_Information_Data
Instant Messenger Address.
 
Parameter name Type/Value Cardinality Description Validations
Instant_Messenger_Address  string  [1..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  [1..*]  Encapsulating element for all Communication Method Usage data.   
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.   
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
 

Web_address_Information_Data

part of: Contact_Information_Data
Web Address Information
 
Parameter name Type/Value Cardinality Description Validations
Web_Address  string  [1..1]  Web Address (e.g. URL).   
Web_Address_Comment  string  [0..1]  Web Address Comment.   
Usage_Data  Communication_Method_Usage_Information_Data  [1..*]  Encapsulating element for all Communication Method Usage data.   
Validation Description
Invalid Usage Type and Use For combination for Web Address.  Invalid Usage Type and Use For combination for Web Address. 
Invalid HTTP address entered. HTTP addresses must be in one of the following formats: - http://... - https://...   
You cannot specify the same usage type more than once for an address.   
top
 

Business_Entity_Logo_Image_Data

part of: 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: Sponsor_WWS_Data
Settlement Account information including Bank Account Type, Currency, Routing Transit Number, etc.
 
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
Only Payment Types that are accepted for a Supplier can be selected as a Payment Type for a Settlement Bank Account.  Only Payment Types that are accepted for a Supplier can be selected as a Payment Type for a Settlement Bank Account. 
Payment Types can only be specified for Settlement Bank Accounts for Suppliers.  Payment Types can only be specified for Settlement Bank Accounts for Suppliers. 
 
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   
Currently, support for submitting new Intermediary Banks is only on the Put Ad Hoc Payee and Submit Supplier 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.   
top
 

CurrencyObject

part of: Settlement_Account_WWS_Data, Sponsor_WWS_Data, Sponsor_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
 

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_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   
Currently, support for submitting new Intermediary Banks is only on the Put Ad Hoc Payee and Submit Supplier web services.   
top
 

Customer_Status_Data

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

Business_Entity_Status_ValueObject

part of: Customer_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_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
 

Delivery_MethodObject

part of: Sponsor_WWS_Data, Sponsor_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
 

Business_Entity_Alternate_Name_Data

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

Financials_Attachment_Data

part of: Sponsor_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: Sponsor_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  [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
 

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ad_hoc_Payee_ID, Applicant_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Unit_ID, Catalog_Item_ID, Company_Reference_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_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Expense_Item_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Gift_Reference_ID, Grant_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_Level_ID, Job_Profile_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_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, Program_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Assignment_Line_Item_ID, Student_Charge_Item_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Supplier_Category_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Rate_ID, Third_Party_ID, Withholding_Order_Case_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
 

SponsorReferenceEnumeration

part of: SponsorObjectID
Base Type
string
top
 

Sponsor_TypeReferenceEnumeration

part of: Sponsor_TypeObjectID
Base Type
string
top
 

Payment_TermsReferenceEnumeration

part of: Payment_TermsObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

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

Instant_Messenger_TypeReferenceEnumeration

part of: Instant_Messenger_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Bank_Account_TypeReferenceEnumeration

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

Delivery_MethodReferenceEnumeration

part of: Delivery_MethodObjectID
Base Type
string
top
 

Alternate_Name_UsageReferenceEnumeration

part of: Alternate_Name_UsageObjectID
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_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top