82
Description
Field
Properties
Field
Type
Field
• ManagerManualOverride: Use the manager's
manual override.
• OpportunityOnlyRollup: Use the opportunity
rollup, including opportunity forecast overrides, but
excluding any forecast-level (Adjusted Total)
overrides.
Read-only.The manager’s choice regarding the best
case amount:
Filter
Nillable
picklist
ManagerChoiceUpside
• DefaultRollup: Use the manager's default best case
rollup for owner's forecast, which reflects the
manager's opportunity forecast overrides.
Restricted
picklist
Update
• AcceptForecast (default selection): Accept the
forecast owner's Adjusted Total best case amount,
which may or may not be an override.
• ManagerManualOverride: Use the manager's
manual override.
• OpportunityOnlyRollup: Use the opportunity
rollup, including opportunity forecast overrides, but
excluding any forecast-level (Adjusted Total)
overrides.
Read-only.The manager's closed total for the owner's
forecast, including any opportunity or opportunity
product overrides made by the manager.
Filter
Nillable
double
ManagerClosed
The manager's Commit total.
Filter
Nillable
currency
ManagerCommit
Read-only.The manager's manual override of the
forecast owner's Commit total. Represents an option
Filter
Nillable
double
ManagerCommitOverride
in the override pop-up window, which allows managers
Update
to choose how to roll up the forecast numbers of a
direct report.
Read-only.The manager's standard Commit rollup
for the forecast owner. Represents an option in the
Filter
Nillable
double
ManagerDefaultRollupCommit
override pop-up window, which allows managers to
choose how to roll up the forecast numbers of a direct
report.
Read-only.The manager's standard Best Case rollup
for the forecast owner. Represents an option in the
Filter
Nillable
double
ManagerDefaultRollupUpside
override pop-up window, which allows managers to
choose how to roll up the forecast numbers of a direct
report.
Read-only. ID of the direct manager of the user who
owns this forecast. For information on IDs, see ID
Field Type.
Filter
Nillable
reference
ManagerId
272
QuantityForecast
102
Description
Field
Properties
Field
Type
Field
Read-only.The manager's view of the forecast owner's
opportunity-level Commit rollup, ignoring all forecast
Filter
Nillable
double
ManagerOpportunityRollupCommit
overrides. Represents an option in the override pop-up
window, which allows managers to choose how to roll
up the forecast numbers of a direct report.
Read-only.The manager's view of the forecast owner's
opportunity-level Best Case rollup, ignoring all forecast
Filter
Nillable
double
ManagerOpportunityRollupUpside
overrides. Represents an option in the override pop-up
window, which allows managers to choose how to roll
up the forecast numbers of a direct report.
The manager's pipeline total for the owner's forecast,
including any opportunity or opportunity product
overrides made by the manager.
Filter
Nillable
double
ManagerPipeline
The manager's Best Case total.
Filter
Nillable
currency
ManagerUpside
The manager's manual override of the forecast owner's
Best Case total. Represents an option in the override
Filter
Nillable
double
ManagerUpsideOverride
pop-up window, which allows managers to choose how
to roll up the forecast numbers of a direct report.
Update
The owner's Closed total for his or her opportunities
only.
Filter
Nillable
double
OpportunityRollupClosed
The owner's Commit total for his or her opportunities
only.
Filter
Nillable
double
OpportunityRollupCommit
The owner's Pipeline total for his or her opportunities
only.
Filter
Nillable
double
OpportunityRollupPipeline
The owner's Best Case total for his or her opportunities
only.
Filter
Nillable
double
OpportunityRollupUpside
ID of the User who owns this forecast. Required on
create.
Create
Defaulted
on create
reference
OwnerId
Filter
The ID of the Period that contains the
StartDate
.
Filter
Nillable
reference
PeriodId
The total pipeline rollup from subordinates in the role
hierarchy, including the owner's opportunities.
Filter
Nillable
double
Pipeline
The value chosen in the Product Family picklist, which
can be configured at Setup
➤
Customize
➤
Products
Create
Filter
picklist
ProductFamily
273
QuantityForecast
84
Description
Field
Properties
Field
Type
Field
➤
Fields.This field is relevant if you have chosen “Use
Product Families” as the Forecast Type at Setup
➤
Nillable
Customize
➤
Forecast
➤
Settings. If you are not
forecasting by product family or if the forecast
represents opportunities that are not associated with a
product family, then this field is blank. Required on
create.
The quota amount for the period.You can
create()
,
delete()
,
update()
and
upsert()
are valid.
Create
Filter
double
Quota
Requires the “Modify All Data” and “Manage Users”
permission. Required on create.
Nillable
Update
The start date of this forecast.The ID of the Period
that contains this date is written to the
PeriodId
field
Create
Filter
date
StartDate
if it changes. A new Period is created if none exists.
Required on create.
Nillable
The owner's Best Case total.
Filter
Nillable
currency
Upside
The comment entered when the owner edited his or
her Best Case total.
Filter
Nillable
string
UpsideComment
Update
Read only.The owner's override of their own My Best
Case total.
Filter
Nillable
double
UpsideOverride
Update
Usage
Query this object to support customizable forecasts based on quantities.
You can update one field,
Quota
, which means that you can mass update sales users’ quotas instead of updating them one by
one in the Salesforce user interface. Editing
Quota
, which means that you can mass update sales users’ quotas instead of
updating them one by one in the Salesforce user interface. Editing
Quota
requires the "Modify All Data" and "Manage Users"
permissions.
The rollup fields always reflect opportunity and opportunity product overrides by the forecast owner or one of the forecast
owner’s subordinates in the role hierarchy. In addition, the manager rollup fields include overrides by the forecast owner's
direct manager in the role hierarchy.
274
QuantityForecast
73
Some of the rollup fields ignore forecast-level (Adjusted Total) overrides, but they never ignore opportunity forecast overrides
that are visible to the owner or manager.
See Also:
RevenueForecast
QuantityForecastHistory
QuantityForecastHistory
Represents historical information about quantity-based forecasts that have been submitted (saved) in the Salesforce user
interface.
Supported Calls
query()
,
retrieve()
,
getDeleted()
,
getUpdated()
,
describeSObjects()
Special Access Rules
• Requires the "View All Data" permission.
• Customer Portal users cannot access this object.
Fields
Description
Field
Properties
Field Type
Field
The closed amount of the forecast.
Filter
Nillable
currency
Closed
The commit amount of the forecast.
Filter
Nillable
currency
Commit
Comments about the commit value.
Filter
Nillable
string
CommitComments
Indicates whether the commit value was overridden (
true
)
or not (
false
).
Defaulted
on create
Filter
boolean
CommitOverridden
Available only for organizations with the multicurrency
feature enabled. Contains the ISO code for any currency
allowed by the organization.
Filter
Restricted
picklist
picklist
CurrencyIsoCode
ID of the related forecast override. For information on IDs,
see ID Field Type. Label is Revenue Forecast ID.
Filter
reference
ForecastOverrideId
The pipeline amount of the forecast.
Filter
Nillable
currency
Pipeline
275
QuantityForecastHistory
74
Description
Field
Properties
Field Type
Field
The quota amount of the forecast.
Filter
Nillable
currency
Quota
The best case amount of the forecast.
Filter
Nillable
currency
Upside
Comments about the upside value.
Filter
Nillable
string
UpsideComments
Indicates whether the upside value was overridden (
true
) or
not (
false
).
Defaulted
on create
Filter
boolean
UpsideOverridden
Usage
This is a read-only object specific to customizable forecasting.
When a user submits a revenue-based forecast in the Salesforce user interface, a new record is created. If the same forecast is
ever resubmitted, additional records are added.The
CreatedDate
of a record reflects the day on which the forecast was
submitted. For more information about customizable forecasts, see the Salesforce online help.This object respects field level
security on the parent object.
See Also:
QuantityForecast
RevenueForecastHistory
QueueSobject
Represents the mapping between a queue Group and the sObject types associated with the queue, including custom objects.
Supported Calls
create()
,
delete()
,
query()
,
retrieve()
,
getDeleted()
,
getUpdated()
,
describeSObjects()
Special Access Rules
Customer Portal users cannot access this object.
Fields
Description
Field
Properties
Field Type
Field
The ID of a queue. For information on IDs, see ID Field
Type.
Create
Filter
reference
QueueId
276
QueueSobject
70
Description
Field
Properties
Field Type
Field
A list of object types that can be associated with the queue
specified by the
QueueId
.
Create
Filter
picklist
SobjectType
Usage
Use this object to associate a queue with the sObjects that can be associated with the queue, including custom objects.
A queue is a Group whose
Type
is Queue.
See Also:
Standard and Custom Object Basics
RecordType
Represents a record type. See "Managing Record Types" in the Salesforce online help.
Supported Calls
create()
,
update()
,
query()
,
retrieve()
,
describeSObjects()
Special Access Rules
Customer Portal users cannot access this object.
Fields
Description
Field
Properties
Field Type
Field
Required. ID of an associated BusinessProcess. For
information on IDs, see ID Field Type.
Create
Filter
reference
BusinessProcessId
Nillable
Update
A description of this record. Limit: 255 characters.
Create
Filter
string
Description
Nillable
Update
Indicates whether this record is active (
true
) or not (
false
).
Only active record types can be applied to records. Label is
Active.
Defaulted
on create
Filter
boolean
IsActive
Update
277
RecordType
80
Description
Field
Properties
Field Type
Field
Indicates whether this record has been designated as a
PersonAccount (
true
) or not (
false
).Visible only if the
Defaulted
on create
Filter
boolean
IsPersonType
organization has the person account feature enabled. For
more information about person accounts, see Person Account
Record Types, and the Salesforce online help.
Required. Name of the record type. Limit: 80 characters.
Create
Filter
string
Name
idLookup
Update
Object to which this record type applies, including custom
objects.
Create
Filter
picklist
SobjectType
Restricted
picklist
Usage
Use this object to offer different BusinessProcesses and subsets of picklist values to different users based on their Profile.Your
client application can invoke the
describeSObjects()
and
query()
calls on RecordType objects.
The following objects have a
RecordTypeId
field:Account,Campaign,Case,Contact,Contract,Lead,Opportunity, and
Solution. Also, custom objects are supported. Client applications can set this field in
create()
or
update()
calls on these
objects, specifying a valid record type ID associated with these objects. A client application can retrieve the list of valid record
type IDs for a given object by calling
query()
on the RecordType object. For more information, see RecordTypeId.
See Also:
Record Type Objects
RevenueForecast
Represents a revenue-based forecast.
The API also provides quantity-based forecasts; see QuantityForecast.
Supported Calls
create()
,
create()
,
query()
,
retrieve()
,
update()
,
getDeleted()
,
getUpdated()
,and
upsert()
,,
describeSObjects()
Special Access Rules
Customer Portal users cannot access this object.
278
RevenueForecast
Documents you may be interested
Documents you may be interested