Service Directory > v31.2 > Revenue_Management > Put_Opportunity
 

Operation: Put_Opportunity

This service operation will add or update Opportunities


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

Utilize the following elements to add, update if already existing, or update only anOpportunity into the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Opportunity_Reference  OpportunityObject  [0..1]  Opportunity Reference Element for update only   
Opportunity_Data  Opportunity_Data  [1..1]  Represent a complete Opportunity 
Validation Description
A Customer Invoice exists already for this Opportunity. The system can not update an Opportunity that is already Invoiced. Please create a new Opportunity for the Customer and re-transmit. Opportunity [Name]. Opportunity Reference ID: [ID]  A Customer Invoice exists already for this Opportunity and is in a state that does not allow updates. Please create a new Opportunity for the Customer. 
Name is required on the initial add. Please correct the Opportunity and re-transmit. Opportunity Reference ID: [ID]  Opportunity Name is required on the initial add. 
If the currency and company are specified, the currency must match the default currency for the company.   
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
Prospect, Customer Request, or Customer is required when an Opportunity is Closed-Won. Please correct the Opportunity and re-transmit. Opportunity: [Name]. Opportunity Reference ID: [ID]  Prospect, Customer Request, or Customer is required when an Opportunity is Closed-Won. Please correct the Opportunity and re-transmit. 
The tenant does not have a default Company setup, nor is a valid Company provided. Please use Tenant Setup to set the default Company or provide a Company Reference ID and re-transmit the Opportunity. Opportunity Name: [Name]. Opportunity Reference ID: [ID]  The tenant does not have a default Company setup, nor is a valid Company provided. Please use Tenant Setup to set the default Company or provide a Company Reference ID and re-transmit the Opportunity. 
Opportunities that are Won must have associated Product Lines. Please correct the Opportunity and re-transmit. Opportunity [Name]. Opportunity Reference ID: [ID]  Opportunities that are Won must have associated Product Lines. Please correct the Opportunity and re-transmit. 
 
top
 

Response Element: Put_Opportunity_Response

Utilize the following elements to respond to an add (or update, if already existing) of a Opportunity into the Workday system
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Opportunity_Reference  OpportunityObject  [0..1]  Reference to an Opportunity   
top
 

OpportunityObject

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

OpportunityObjectID

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

Opportunity_Data

part of: Put_Opportunity_Request
Represent a complete Opportunity
 
Parameter name Type/Value Cardinality Description Validations
Opportunity_ID  string  [1..1]  External System Unique Identifier for an Opportunity   
Inactive  boolean  [0..1]  A boolean flag to indicate if the Opportunity is inactive.   
Opportunity_Name  string  [0..1]  Name of Opportunity. Does not need to be unique. Required only on initial add.   
Opportunity_Status_Reference  Opportunity_StatusObject  [1..1]  Reference to an Opportunity Status   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference for all Opportunity amounts   
Prospect_Reference [Choice]   ProspectObject  [0..1]  Reference to an Opportunity   
Customer_Request_Reference [Choice]   Customer_RequestObject  [0..1]  Reference to a Customer Request   
Customer_Reference [Choice]   CustomerObject  [0..1]  Customer Reference   
Company_Reference  CompanyObject  [0..1]  Company Reference.   
Salesperson_Reference  WorkerObject  [0..1]  The worker who owns the Opportunity.   
Probability_Percent  decimal (3, 0) >0   [0..1]  The probability the Opportunity will reach a Closed Won status.   
Close_Date  date  [0..1]  The date the Opportunity is expected to reach a Closed status.   
Notes  string  [0..1]  Additional information about the Opportunity.   
Update_Opportunity_Only  boolean  [0..1]  Update the Opportunity Level data only, do not update, remove or add Opportunity lines   
Opportunity_Line_Replacement_Data  Opportunity_Line_Data  [0..*]  Element contains Opportunity Line Data 
Validation Description
A Sales Item matching the Product Name: [Product Name] could not be found in Workday  A Sales Item could not be found in Workday for the Product Code provided. 
A Revenue Category matching the value: [Input] could not be found in Workday  A Revenue Category could not be found in Workday for the name provided. 
Opportunity Line Data contains duplicate Opportunity Line References or Line Reference IDs. Each Opportunity Line should have a unique ID.  Opportunity Line Data contains duplicate Opportunity Line References or Line Reference IDs. Each Opportunity Line should have a unique ID. 
The tenant does not have a default Revenue Category setup. The Opportunity Line needs to have a default Revenue Category, or a Opportunity Product Name or a Revenue Category.  The tenant does not have a default Revenue Category setup. The Opportunity Line needs to have a default Revenue Category, or a Opportunity Product Name or a Revenue Category. 
 
Validation Description
A Customer Invoice exists already for this Opportunity. The system can not update an Opportunity that is already Invoiced. Please create a new Opportunity for the Customer and re-transmit. Opportunity [Name]. Opportunity Reference ID: [ID]  A Customer Invoice exists already for this Opportunity and is in a state that does not allow updates. Please create a new Opportunity for the Customer. 
Name is required on the initial add. Please correct the Opportunity and re-transmit. Opportunity Reference ID: [ID]  Opportunity Name is required on the initial add. 
If the currency and company are specified, the currency must match the default currency for the company.   
Customer reference is for a customer that can be used as a basic worktag only.  Customer reference is for a customer that can be used as a basic worktag only. 
Prospect, Customer Request, or Customer is required when an Opportunity is Closed-Won. Please correct the Opportunity and re-transmit. Opportunity: [Name]. Opportunity Reference ID: [ID]  Prospect, Customer Request, or Customer is required when an Opportunity is Closed-Won. Please correct the Opportunity and re-transmit. 
The tenant does not have a default Company setup, nor is a valid Company provided. Please use Tenant Setup to set the default Company or provide a Company Reference ID and re-transmit the Opportunity. Opportunity Name: [Name]. Opportunity Reference ID: [ID]  The tenant does not have a default Company setup, nor is a valid Company provided. Please use Tenant Setup to set the default Company or provide a Company Reference ID and re-transmit the Opportunity. 
Opportunities that are Won must have associated Product Lines. Please correct the Opportunity and re-transmit. Opportunity [Name]. Opportunity Reference ID: [ID]  Opportunities that are Won must have associated Product Lines. Please correct the Opportunity and re-transmit. 
top
 

Opportunity_StatusObject

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

Opportunity_StatusObjectID

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

CurrencyObject

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

ProspectObject

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

ProspectObjectID

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

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

Customer_RequestObjectID

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

CustomerObject

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

CompanyObject

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

CompanyObjectID

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

WorkerObject

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

Opportunity_Line_Data

part of: Opportunity_Data
Encapsulating element containing Opportunity Line data.
 
Parameter name Type/Value Cardinality Description Validations
Opportunity_Line_Reference  Opportunity_LineObject  [0..1]  Reference to an existing Opportunity Line for update only purposes.   
Opportunity_Line_Reference_ID  string  [0..1]  The Opportunity Line Reference ID. This is the Opportunity Line unique identifier. 
Validation Description
The Opportunity Line or Opportunity Line Reference ID is not valid for this opportunity. You can either update an existing Opportunity Line on this Opportunity or create a new Opportunity Line for this Opportunity.   
 
Product_Description  string  [0..1]  Opportunity Line Product Description. The value provided does not need to match any Workday attribute.   
Product_Code  string  [0..1]  Opportunity Line Product Code. Does not need to match any Workday attributes.   
Product_Name  string  [0..1]  Opportunity Product Name. If Provided must match a Workday Sales Item Name.   
Revenue_Category  string  [0..1]  Revenue Category. If provided, must match a Workday Revenue Category Name.   
Unit_Cost  decimal (26, 6)   [1..1]  Opportunity Line Cost   
Quantity  decimal (22, 2)   [1..1]  Opportunity Line Quantity   
Opportunity_Line_Schedule_Replacement_Data  Invoicing_Schedule_Line_for_Opportunity_Line_Data  [0..*]  Opportunity Line Schedule Data 
Validation Description
Either a schedule amount or quantity must be provided and have a value greater than 0.  Either a schedule amount or quantity must be provided and have a value greater than 0. 
 
Validation Description
A Sales Item matching the Product Name: [Product Name] could not be found in Workday  A Sales Item could not be found in Workday for the Product Code provided. 
A Revenue Category matching the value: [Input] could not be found in Workday  A Revenue Category could not be found in Workday for the name provided. 
Opportunity Line Data contains duplicate Opportunity Line References or Line Reference IDs. Each Opportunity Line should have a unique ID.  Opportunity Line Data contains duplicate Opportunity Line References or Line Reference IDs. Each Opportunity Line should have a unique ID. 
The tenant does not have a default Revenue Category setup. The Opportunity Line needs to have a default Revenue Category, or a Opportunity Product Name or a Revenue Category.  The tenant does not have a default Revenue Category setup. The Opportunity Line needs to have a default Revenue Category, or a Opportunity Product Name or a Revenue Category. 
top
 

Opportunity_LineObject

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

Opportunity_LineObjectID

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

Invoicing_Schedule_Line_for_Opportunity_Line_Data

part of: Opportunity_Line_Data
Encapsulating element containing Opportunity Line Schedule data.
 
Parameter name Type/Value Cardinality Description Validations
Recurring_Schedule_Date  date  [1..1]  Recurring Schedule Date   
Recurring_Schedule_Comment  string  [0..1]  Recurring Schedule Comment   
Billing_Schedule_Line_Quantity  decimal (22, 2) >0   [0..1]  Invoicing Schedule Line Extended Amount   
Billing_Schedule_Line_Amount  decimal (26, 6) >0   [0..1]  Opportunity Line Invoicing Schedule Line Cost   
Validation Description
Either a schedule amount or quantity must be provided and have a value greater than 0.  Either a schedule amount or quantity must be provided and have a value greater than 0. 
top
 

OpportunityReferenceEnumeration

part of: OpportunityObjectID
Base Type
string
top
 

Opportunity_StatusReferenceEnumeration

part of: Opportunity_StatusObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

ProspectReferenceEnumeration

part of: ProspectObjectID
Base Type
string
top
 

Customer_RequestReferenceEnumeration

part of: Customer_RequestObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Opportunity_LineReferenceEnumeration

part of: Opportunity_LineObjectID
Base Type
string
top