SalesProcessQueryPage

Extracts sales process information for one or more sales processes, depending on the search criteria that you specify.

Usage

Use the SalesProcessQueryPage method to retrieve sales process information including sales stages, order of the sales stages, default probability, and associated opportunity types.

The LisfOfSalesProcess argument contains elements for the various fields of a sales process, and for the associated opportunity types and sales stages. There are child elements <ListOfOpportunityType> and <ListOfSalesStage>. You can search for specific sales processes, by specifying search criteria in the child elements of <SaleProcess>. For example, you can search for the following:

• A specific sales process, by specifying the ID of the sales process, as follows: <Id>'Id to search'</Id>

• A specific sales process, by specifying the language-independent name of the sales process, as follows: <BaseName>='Name to search'</BaseName>

• All sales processes except the default sales process, by specifying the following: <Default>='N'</Default>

• The default sales process only, by specifying the following: <Default>='Y'</Default>

• All sales processes created after a certain date, for example: <CreatedDate>&gt;='2020-11-25T09:00:00Z'</CreatedDate>

If you do not specify any search criteria, then the information for all of the sales processes for the company is returned.

For most of the child elements of <ListOfSalesProcess>, you can use the sortorder and sortsequence attributes to specify how fields in the returned sales process information are sorted.

Note: The Name and Description fields of SalesProcess do not support the sort specification.

See SalesProcessInsertOrUpdate for information about the sales process data specified in <ListOfSalesProcess>.

Arguments

The following table describes the arguments taken by the SalesProcessQueryPage method.

Table Arguments Taken by the SalesProcessQueryPage Method

Name	Description	Required	Default	I/O
ListOfSalesProcess	The list of sales processes queried (input), and after query execution, the list of sales processes returned (output).	Yes	Not applicable	Input/Output
PageSize	The maximum number of records displayed on a page following a query.	No	10	Input
StartRowNum	Indicates the row from which the SalesProcessQueryPage method starts to return records. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query.	No	0	Input
recordcountneeded	Indicates whether a record count for the object is to be returned.	No	False	Input
searchspec	Indicates the search specification for a field or for all the fields of an object.	No	Not applicable	Input
sortsequence	An integer value that determines the order of the sort specification.	No	Not applicable	Input
sortorder	Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending.	No	ASC	Input
LOVLanguageMode	The language mode for picklists, see The LOVLanguageMode Argument.	No	LIC	Input
LastPage	A value that indicates whether or not the last value in the query set has been returned.	Not applicable	Not applicable	Output
recordcount	An integer value that indicates the record count for the object	Not applicable	Not applicable	Output

Return Value of the Call

The sales process data is returned.