Service Directory > v31.2 > Revenue_Management > Put_Business_Connection
 

Operation: Put_Business_Connection

This service operation will add or update Business Connections. Business Connection Data includes Business Connection Reference ID, the Business Connection owner, customer, address, tax code, and inactive and default flags.


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

Element containing Business Connection reference for update (or empty if a new Business Connection is being added).
 
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.   
Business_Connection_Reference  Customer_Business_ConnectionObject  [0..1]  Reference to an existing Business Connection for update purposes only.   
Business_Connection_Data  Business_Connection_Data  [1..1]  Business Connection Data for the single business connection being created or updated. 
Validation Description
The business connection owner can not be updated.   
The address you specify for the business connection must be defined as a shipping or primary address for that customer.   
Add a customer only once to the Connection Map.   
One business connection must be designated as the default connection.   
You can’t delete the default business connection.   
 
Validation Description
The Web Service is set to Add Only, but the Business Connection already exists.  Flag as an error the condition where an already-existing business connection is sent in add-only mode. 
top
 

Response Element: Put_Business_Connection_Response

Element containing Put Business Connection Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Connection_Reference  Customer_Business_ConnectionObject  [0..1]  Reference to the Business Connection that was created or updated by this Put operation   
top
 

Customer_Business_ConnectionObject

part of: Put_Business_Connection_Request, Put_Business_Connection_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Customer_Business_ConnectionObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Customer_Business_ConnectionObjectID

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

part of: Put_Business_Connection_Request
Contains all References and Attributes to represent a complete Business Connection.
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  Set this flag to true to delete the Business Connection.   
Business_Connection_ID  string  [0..1]  Business Connection Reference ID. This is the Business Connection Unique Identifier.   
Customer_Reference  CustomerObject  [1..1]  The customer that owns the Business Connection   
Ship-To_Customer_Reference  CustomerObject  [1..1]  The Business Connection customer   
Default_Ship-To_Customer  boolean  [0..1]  The flag that indicates whether this is the default Business Connection.   
Default_Ship-To_Address  string  [0..1]  Ship-To Address   
Address_Reference_ID  string  [0..1]  The External Address ID is a text string generated in and used by an external system to identify this address.   
Validation Description
The business connection owner can not be updated.   
The address you specify for the business connection must be defined as a shipping or primary address for that customer.   
Add a customer only once to the Connection Map.   
One business connection must be designated as the default connection.   
You can’t delete the default business connection.   
top
 

CustomerObject

part of: Business_Connection_Data, Business_Connection_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  CustomerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CustomerObjectID

part of: CustomerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Customer_ID, Customer_Reference_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Customer_Business_ConnectionReferenceEnumeration

part of: Customer_Business_ConnectionObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top