| Name | Type | Cardinality | Label | Required | Help |
|---|
| actionItem |
string |
0..1 |
Action Item |
F |
Record the next step in the negotiation process. |
| altSalesRangeHigh |
double |
0..1 |
To{:Used in range, such as from 0 to 100} |
F |
Must be greater than or equal to the amount in the projaltsalesamt field. |
| altSalesRangeLow |
double |
0..1 |
Range |
F |
Must be lower than or equal to the projected amount in the projaltsalesamt field. |
| billAddressList |
RecordRef |
0..1 |
|
|
Defaults to the address associated with the selection for billAddress. If explicitly set via web services, this acts as a custom address and overrides for this transaction only.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| billingAddress |
Address |
0..1 |
|
|
|
| buyingReason |
RecordRef |
0..1 |
Buying Reason{:The reason a customer is considering a prospective deal} |
F |
Choose the prospect or customer's reason for buying from your company. You can create additional options for this field at <_TABNAME=LIST_CRMOTHERLIST_> > <_TASKCATEGORY=LIST_CRMOTHERLIST_> > CRM Lists. |
| buyingTimeFrame |
RecordRef |
0..1 |
Buying Time Frame{:The time frame for a prospective deal} |
F |
Select the time frame for the prospect or customer to purchase. You can create additional options for this field at <_TABNAME=LIST_CRMOTHERLIST_> > <_TASKCATEGORY=LIST_CRMOTHERLIST_> > CRM Lists. |
| class |
RecordRef |
0..1 |
|
|
References a value from a user defined list at Setup > Company > Classifications > Classes.
This field is required when the Make Classes Mandatory preference is enabled at Setup > Accounting > Accounting Preferences.
If you are using a customForm that has class customized at the item level, you can NOT set this field at the body level.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| closeDate |
dateTime |
0..1 |
Actual Close |
F |
This field corresponds to the date that the Opportunity entityStatus is set to Closed Won. Note that this field is read-only in both the UI and in Web services. |
| competitorsList |
OpportunityCompetitorsList |
0..1 |
|
|
|
| contribPct |
string |
0..1 |
|
|
|
| createdDate |
dateTime |
0..1 |
|
|
When adding a record, this field defaults to the current system date and time. This field cannot be overwritten. The default value is set regardless of any use default settings. |
| currency |
RecordRef |
0..1 |
Currency |
T |
If you do not use the Multi-Currency Customers feature, the currency of the customer you are creating this transaction for is shown here.
If you use the Multi-Currency Customers feature, select the transaction currency you want to create this transaction in. This customer's primary currency is selected by default.
If you have already selected items on this transaction, selecting a new currency refreshes them to show the price in the new currency (except for items you entered custom prices for) and recalculates tax and gross profit. |
| currencyName |
string |
0..1 |
Currency |
F |
References a value from a user defined list at Lists > Accounting > Currencies. |
| customFieldList |
CustomFieldList |
0..1 |
|
|
See CustomFieldList. Note that you can search on custom transaction column fields using OpportunitySearch. |
| customForm |
RecordRef |
0..1 |
Custom Form |
T |
References an existing custom form for this record type. To ensure that field relationships defined within a desired custom form are maintained, you must provide the customForm value. Also, if defaults are off, then customForm is required, if defaults are on then the default form is used. Internal ID values for existing forms can be found at Setup > Customization > Entry Forms.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| daysOpen |
long |
0..1 |
Days Open |
F |
This field shows the number of days this opportunity has been open. |
| department |
RecordRef |
0..1 |
|
|
References a value from a user defined list at Setup > Company > Departments. If you are using a customForm that has department customized at the item level, you can NOT set this field at the body level.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| entity |
RecordRef |
0..1 |
|
|
References a company record that already exists in your account.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| entityStatus |
RecordRef |
0..1 |
Status |
T |
References a value in a user-defined list at Setup > Sales > Setup Tasks > Customer Statuses. Defaults to the value set at Setup > Sales > Preferences > Sales Preferences.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| estGrossProfit |
double |
0..1 |
|
|
Estimated Gross Profit: Read-only field that equals the revenue amount minus the Est. Cost. At the transaction level, it equals the gross profit of all lines, factoring transaction-level discounts and markups. |
| estGrossProfitPercent |
double |
0..1 |
|
|
Estimated Gross Profit Margin, as a percentage: Read-only field that equals the Est. Gross Profit divided by revenue, expressed as a percentage. At the transaction level, it equals the gross profit percent of all lines, factoring transaction-level discounts and markups. |
| estimatedBudget |
double |
0..1 |
Estimated Budget{:The estimated budget for a prospective deal} |
F |
Enter the estimated budget the prospect or customer has for this opportunity. |
| exchangeRate |
double |
0..1 |
Exchange Rate |
T |
Defaults to the current exchange rate for the currency associated with the company referenced in the entity field. This can only be provided for an add. |
| expectedCloseDate |
dateTime |
0..1 |
|
|
Required when default preferences are turned off. Defaults to the current Date/Time. |
| forecastType |
RecordRef |
0..1 |
Forecast Type |
F |
References an existing Forecast Type defined at Setup > Sales > Sales Preferences > Forecasts (subtab on Preferences page).
Note that although the display name for each forecast type can be customized, the actual internal ID associated with each forecast type is static as follows:
Low Forecast Name: 1
Medium Forecast Name: 2
High Forecast Name: 3 |
| isBudgetApproved |
boolean |
0..1 |
Budget Approved{:Whether there is an approved budget for a prospective deal} |
F |
Check this box if the budget for this opportunity has been approved by the prospect or customer. |
| itemList |
OpportunityItemList |
0..1 |
|
|
|
| job |
RecordRef |
0..1 |
|
|
|
| lastModifiedDate |
dateTime |
0..1 |
|
|
This is a read only field. When updating a record, this field defaults to the current system date and time. |
| leadSource |
RecordRef |
0..1 |
Lead Source |
F |
References a lead source that is already defined in your account. If a value is not provided, the field is populated with the lead source associated with the company referenced in the entity field (if a lead source exists for that company).
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| location |
RecordRef |
0..1 |
|
|
This is a reference to a user defined location at Setup > Company > Locations.
If you are using a customForm that has location customized at the item level, you can NOT set this field at the body level.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| memo |
string |
0..1 |
|
|
Enter additional information about the opportunity. |
| oneTime |
double |
0..1 |
|
|
|
| partner |
RecordRef |
0..1 |
Partner |
F |
References a partner record that already exists in your account. If a value is not provided, the field is populated with the partner associated with the company referenced in the entity field (if a partner exists for that company).
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| partnersList |
OpportunityPartnersList |
0..1 |
|
|
|
| probability |
double |
0..1 |
Probability |
T |
If the value for probability is not provided, a calculated value based on the Status populates the field.
If the value for probability is set, it overrides the slaved value depending on the default settings.
For example:
� If conditional defaults are ON, on update the probability changes if the status changes and the probability is NOT specified in the request.
� If conditional defaults are OFF, on update the probability does NOT change if status changes.
� If conditional defaults are ON, and a value for both status and probability are submitted, then the submitted values are set. |
| projAltSalesAmt |
double |
0..1 |
|
|
Sets the projected alternate sales amount of the opportunity based on the items selected on the opportunity and the estimates associated with the opportunity. |
| projectedTotal |
double |
0..1 |
|
|
This field is required when there are no items in the itemList field. When items are listed and a value is not provided, the field is calculated. Provided values may be overridden by the system. See Projected Total, Range High and Range Low Fields. |
| rangeHigh |
double |
0..1 |
To{:Used in range, such as from 0 to 100} |
F |
If not provided, this field is calculated. Provided values may be overridden by the system. See Projected Total, Range High and Range Low Fields. |
| rangeLow |
double |
0..1 |
Range |
F |
If not provided, this field is calculated. Provided values may be overridden by the system. See Projected Total, Range High and Range Low Fields. |
| recurAnnually |
double |
0..1 |
|
|
|
| recurMonthly |
double |
0..1 |
|
|
|
| recurQuarterly |
double |
0..1 |
|
|
|
| recurWeekly |
double |
0..1 |
|
|
|
| salesGroup |
RecordRef |
0..1 |
Choose Team |
F |
When team selling is enabled, this references a user defined sales team group at Lists > Relationships > Groups. |
| salesReadiness |
RecordRef |
0..1 |
Sales Readiness{:How ready a customer is to buy a prospective deal} |
F |
Choose how close the prospect or customer is to purchasing. You can create additional options for this field at <_TABNAME=LIST_CRMOTHERLIST_> > <_TASKCATEGORY=LIST_CRMOTHERLIST_> > CRM Lists. |
| salesRep |
RecordRef |
0..1 |
Sales Rep |
F |
References an employee record that already exists in your account. If a value is not provided, the field is populated with the sales representative associated with the company referenced in the entity field (if a sales representative exists for that company). The referenced employee record must have a status set as sales rep or an error is thrown.
This field is NOT available when the Team Selling feature is enabled. If Team Selling is enabled, you must define sales reps in the OpportunityItemList list.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| salesTeamList |
OpportunitySalesTeamList |
0..1 |
|
|
|
| shipAddressList |
RecordRef |
0..1 |
|
|
Defaults to the address associated with the selection for shipAddress. If explicitly set via web services, this acts as a custom address and overrides for this transaction only.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |
| shipIsResidential |
boolean |
0..1 |
Shipping address is residential |
F |
|
| shippingAddress |
Address |
0..1 |
|
|
|
| source |
string |
0..1 |
Source |
F |
|
| status |
string |
0..1 |
|
|
|
| subsidiary |
RecordRef |
0..1 |
|
|
This field displays the subsidiary associated with this transaction. |
| syncPartnerTeams |
boolean |
0..1 |
|
|
Check this box if you want to update the partner team on the customer record with the changes you make here. |
| syncSalesTeams |
boolean |
0..1 |
|
|
Check this box if you want to update the sales team on the customer record with the changes you make here. |
| tax2Total |
double |
0..1 |
PST |
F |
|
| taxTotal |
double |
0..1 |
Tax |
F |
|
| title |
string |
0..1 |
Title |
F |
Sets the value of the title displayed on lists, reports and on the Opportunities subtab of the record the opportunity is associated with. |
| totalCostEstimate |
double |
0..1 |
|
|
Estimated Cost: Estimated cost of the specific number of items; estimated rate x quantity = estimated cost. |
| tranDate |
dateTime |
0..1 |
|
|
Required when default preferences are turned off. Defaults to the current Date/Time. |
| tranId |
string |
0..1 |
|
|
Sets a unique ID number for the transaction. If a value is not provided, the system assigns a number. If the value is not unique an error is thrown.
By default, any autonumbering of opportunity records is allowed to be overridden. However, if you are explicitly setting a value for tranID and that value is NOT being set in the system, you may have the �Allow Override� disabled. To enable overriding of autonumbering, go to Set Up > Company > Set up Auto-Generated Numbers > Transactions tab. Then check Allow Override in the Opportunity row and click Save. |
| vatRegNum |
string |
0..1 |
|
|
Required for non-US accounts. |
| weightedTotal |
double |
0..1 |
|
|
Defaults to a calculated value that is dependent on total amounts associated with items in itemList. |
| winLossReason |
RecordRef |
0..1 |
Win/Loss Reason |
F |
References a value from a user defined list at Setup > Sales > CRM Lists > Win/Loss Reason. For details on how to modify this list via Web services, see WinLossReason.
In order to retrieve a list of available values for this field, use the GetSelectValue operation. For more information, see getSelectValue of the Platform Guide. |