Service Directory > v31.2 > Revenue_Management > Get_Opportunities
 

Operation: Get_Opportunities

This service operation will get Opportunities for the specified criteria. The request criteria can be for a single transaction based on Reference, or all transaction can be retrieved if no criteria is specified.


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


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Opportunities_Request

This element is the top-level request element for all Opportunity "Get" operations
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Opportunity_Request_References  [0..1]  This element content contains the Opportunity reference element used to return the Opportunity by unique identifier   
Request_Criteria [Choice]   Opportunity_Request_Criteria  [0..1]  This element content contains the wrapper element for the list of criteria representing the Opportunity specific criteria needed to search for instances.   
Response_Filter  Response_Filter  [0..1]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Opportunity_Response_Group  [0..1]  Element content containing Opportunity Response Group element   
top
 

Response Element: Get_Opportunities_Response

Element containing Opportunity response data including echoed request data and request result data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Opportunity_Request_References  [0..*]  This element contains the echoed Opportunity Reference as received by the request   
Request_Criteria  Opportunity_Request_Criteria  [0..*]  This element content contains the element that is used as a wrapper element around a list of elements representing the Opportunity specific criteria needed to search for instances. All of the elements are "AND" conditions.   
Response_Filter  Response_Filter  [0..*]  Element Content containing Response Filter. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Opportunity_Response_Group  [0..*]  Element content containing Opportunity Response Group element   
Response_Results  Response_Results  [0..*]  Element content containing Opportunity Response Results   
Response_Data  Opportunity_Response_Data  [0..*]  Element content containing Opportunity Data   
top
 

Opportunity_Request_References

part of: Get_Opportunities_Response, Get_Opportunities_Request
This contains the specific instance set containing the requested Opportunity. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance.
 
Parameter name Type/Value Cardinality Description Validations
Opportunity_Reference  OpportunityObject  [1..*]  Instance set containing the Opportunity object.   
top
 

OpportunityObject

part of: Opportunity_Request_References, Opportunity
 
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_Request_Criteria

part of: Get_Opportunities_Response, Get_Opportunities_Request
This element is the wrapper around a list of elements representing the Opportunity specific criteria needed to search for instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Opportunity_Name [Choice]   string  [0..1]  Opportunity Name or partial Name   
Event_Reference [Choice]   Transaction_LogObject  [0..1]  Event Reference   
Prospect_Reference [Choice]   ProspectObject  [0..1]  Prospect Identifier, Workday or Lookup ID   
Customer_Request_Reference [Choice]   Customer_RequestObject  [0..1]  Customer Request Identifier, Workday or Lookup ID   
Reporting_Transaction_Reference [Choice]   Reporting_TransactionObject  [0..1]  Reporting Transaction Reference. Expense Reports and Purchase Order   
Company_Reference  CompanyObject  [0..1]  A reference to a Company to filter Opportunities returned by the web service.   
top
 

Transaction_LogObject

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

Transaction_LogObjectID

part of: Transaction_LogObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Case_ID, Assignable_Payroll_ID, Background_Check_ID, Background_Process_Instance_ID, Backorder_Event_ID, Budget_Amendment_ID, Change_Order_Reference_ID, Compensation_Review_Event_ID, Customer_Request_ID, Customer_Request_Reference_ID, Eligibility_Override_Event_ID, Employee_Review_ID, Employee_Severance_Worksheet_Event_ID, Goods_Delivery_Group_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Invite_Committee_Candidate_Event_ID, IRS_1099_MISC_Adjustment_ID, Mass_Change_Requisition_Requester_ID, Medicare_Information_Event_ID, Position_Budget_Group_ID, Procurement_Mass_Close_ID, Procurement_Mass_ReOpen_ID, Procurement_Roll_Forward_ID, Receipt_Number, Request_Leave_of_Absence_ID, Requisition_Sourcing_Event_ID, Spend_Authorization_ID, Spend_Authorization_Mass_Close_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Dismissal_Event_ID, Student_Employment_Eligibility_Event_ID, Student_Hold_Assignment_Override_Event_ID, Student_Institutional_Withdrawal_Event_ID, Student_Leave_of_Absence_Event_ID, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Contract_ID, Workday_Project_ID, Worker_Time_Card_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

ProspectObject

part of: Opportunity_Data, Opportunity_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  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, Opportunity_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  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
 

Reporting_TransactionObject

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

Reporting_TransactionObjectID

part of: Reporting_TransactionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ad_hoc_Payment_Reference_ID, Advanced_Ship_Notice_ID, Advanced_Ship_Notice_Number, Award_Contract_Amendment_ID, Award_Proposal_ID, Award_Reference_ID, Bank_Account_Transfer_Payment_ID, Cash_Sale_ID, Change_Order_Reference_ID, Consolidated_Invoice_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Amendment_Reference_ID, Customer_Contract_Intercompany_ID, Customer_Contract_Reference_ID, Customer_Invoice_Adjustment_Reference_ID, Customer_Invoice_Reference_ID, Customer_Overpayment_Reference_ID, Customer_Payment_for_Invoices_Reference_ID, Customer_Refund_Reference_ID, Document_Number, EFT_Payment_ID, Expense_Report_Reference_ID, Good_Delivery_ID, Goods_Delivery_Run_ID, Historical_Student_Charge_ID, Internal_Service_Delivery_Document_Number, Internal_Service_Delivery_ID, Inventory_Count_Sheet_Reference_ID, Inventory_Par_Count_Reference_ID, Inventory_Pick_List_Reference_ID, Inventory_Return_Reference_ID, Inventory_Ship_List_Reference_ID, Inventory_Stock_Request_Reference_ID, PO_Acknowledgement_Number, PO_Acknowledgement_Reference_ID, Procurement_Card_Transaction_Verification_ID, Purchase_Order_Reference_ID, Receipt_Number, Request_for_Quote_Award_ID, Request_for_Quote_ID, Request_for_Quote_Response_ID, Requisition_Number, Requisition_Template_ID, Return_to_Supplier_ID, Spend_Authorization_ID, Student_Application_Fee_Payment_ID, Student_Charge_Adjustment_ID, Student_Charge_Document_ID, Student_Charge_ID, Student_Credit_Memo_ID, Student_Disbursement_Payment_ID, Student_Historical_Payment_ID, Student_Payment_ID, Student_Sponsor_Contract_ID, Student_Sponsor_Payment_ID, Student_Sponsor_Refund_Payment_ID, Student_Waiver_Payment_ID, Supplier_Acknowledgement_Number, Supplier_Contract_Amendment_ID, Supplier_Contract_History_ID, Supplier_Contract_ID, Supplier_Invoice_Adjustment_Reference_ID, Supplier_Invoice_Contract_ID, Supplier_Invoice_Reference_ID, Supplier_Invoice_Request_Document_Number, Supplier_Invoice_Request_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Document_Number, Purchase_Order_Reference_ID  [1..1]  The unique identifier type of a parent object   
top
 

CompanyObject

part of: Opportunity_Data, Opportunity_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  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
 

Response_Filter

part of: Get_Opportunities_Response, Get_Opportunities_Request
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Opportunity_Response_Group

part of: Get_Opportunities_Response, Get_Opportunities_Request
Wrapper element around a list of elements representing the amount of data that should be included in the Opportunity response. If this element is not included then ALL of the Response Groups are included in the response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Opportunity Reference data is to be included in the response   
Include_Opportunity_Cost_Data  boolean  [0..1]  Flag indicating if the Opportunity Cost data is to be included in the response   
Include_Opportunity_Data  boolean  [0..1]  Flag indicating if the Opportunity detail data is to be included in the response   
top
 

Response_Results

part of: Get_Opportunities_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Opportunity_Response_Data

part of: Get_Opportunities_Response
Wrapper element containing Opportunity Response Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Opportunity  Opportunity  [0..*]  Element content containing Opportunity element   
top
 

Opportunity

part of: Opportunity_Response_Data
Element containing Opportunity Data for requested references or criteria and for requested response group
 
Parameter name Type/Value Cardinality Description Validations
Opportunity_Reference  OpportunityObject  [0..1]  Element content contains Opportunity Reference, WorkdayID or Lookup ID   
Opportunity_Cost_Data  Opportunity_Cost_Data  [0..*]  Element content contains Opportunity Cost Data element   
Opportunity_Data  Opportunity_Data  [0..1]  Element Content contains Opportunity Data for requested references or criteria and for requested response group 
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_Cost_Data

part of: Opportunity
Element Contains Opportunity Cost Data for request reference or criteria and response group
 
Parameter name Type/Value Cardinality Description Validations
Opportunity_Cost  decimal (26, 6)   [0..1]  Opportunity Cost. Total of all Approved Expense Reports and Purchase Orders tagged with requested Opportunity   
Currency_Reference  Currency_Reference_Data  [0..1]  Opportunity Total Cost Currency   
top
 

Currency_Reference_Data

part of: Opportunity_Cost_Data
This element references a unique type of Currency.
 
Parameter name Type/Value Cardinality Description Validations
Currency_Code  ADF, ADP, AED, AFA, AFN, ALK, ALL, AMD, ANG, AOA, AOR, ARS, ATS, AUD, AWG, AZM, AZN, BAM, BBD, BDT, BEF, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CSD, CUP, CVE, CYP, CZK, DEM, DJF, DKK, DOP, DZD, ECS, ECV, EEK, EGP, ERN, ESP, ETB, EUR, FIM, FJD, FKP, FRF, GBP, GEL, GHC, GHS, GIP, GMD, GNF, GRD, GTQ, GWP, GYD, HKD, HNL, HRK, HTG, HUF, IDR, IEP, ILS, INR, IQD, IRR, ISK, ITL, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LUF, LVL, LYD, MAD, MCF, MDL, MGA, MGF, MKD, MMK, MNT, MOP, MRO, MRU, MTL, MUR, MVR, MWK, MXN, MXV, MYR, MZM, MZN, NAD, NGN, NIO, NLG, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PTE, PYG, QAR, ROL, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDD, SDG, SEK, SGD, SHP, SIT, SKK, SLL, SML, SOS, SRD, SRG, SSP, STD, STN, SVC, SYP, SZL, THB, TJR, TJS, TMM, TMT, TND, TOP, TRL, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYI, UYU, UZS, VAL, VEB, VEF, VES, VND, VUV, WST, XAF, XCD, XEU, XFO, XOF, XPF, YER, YUM, ZAR, ZMK, ZMW, ZWD, ZWL  [1..1]  The preferred Currency for the contract pay rate. 
Validation Description
Currency ID does not exist.  There is no Currency for that Currency ID. 
 
top
 

Opportunity_Data

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

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
 

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
 

Transaction_LogReferenceEnumeration

part of: Transaction_LogObjectID
Base Type
string
top
 

ProspectReferenceEnumeration

part of: ProspectObjectID
Base Type
string
top
 

Customer_RequestReferenceEnumeration

part of: Customer_RequestObjectID
Base Type
string
top
 

Reporting_TransactionReferenceEnumeration

part of: Reporting_TransactionObjectID
Base Type
string
top
 

Base Type
string

top
 

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

CurrencyEnumeration

part of: Currency_Reference_Data
Base Type
string
top
 

Opportunity_StatusReferenceEnumeration

part of: Opportunity_StatusObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

CustomerReferenceEnumeration

part of: CustomerObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Opportunity_LineReferenceEnumeration

part of: Opportunity_LineObjectID
Base Type
string
top