Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R11.1.0

Excerpt

This method returns all leads that are close to estimated completion time. Multiple leads are returned by each call. Note that identifiers are optional for this method.

...

Resource URL

Parameters

NameTypeDescription
token

String

The token retrieved from the login method

period
(mandatory)

NumberThe length of time for which a lead is close to estimated completion

uot
(mandatory)

StringThe unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

contact_information_identifier

(optional)

Contact Information Identifier

The identifier of the contact information for which the Lead was created. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

 

accounts_receivable_identifier

(optional)

Accounts receivable identifier 

The identifier of the accounts receivable with which the lead is related to. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(optional)

Lead type identifier

The identifier of the lead type related with the leads that should be returned as a result. The allowed lead type identifier fields are the following:

Include Page
V4:lead_type_identifier
V4:lead_type_identifier

category_identifier

(optional)

Lead category identifier

The identifier of the category related with the leads that should be returned as a result. The allowed lead category identifier fields are the following:

Include Page
V4:lead_category_identifier
V4:lead_category_identifier

source_identifier

(semi-optional)

Lead source identifier

The identifier of the source lead. The allowed lead source identifier fields are the following:

Include Page
V4:lead_source_identifier
V4:lead_source_identifier

importance

(optional)

Lead ImportanceThe importance related with the leads that should be returned as a result. The allowed lead importance fields are the following: IMPORTANCE1, IMPORTANCE2, IMPORTANCE3, IMPORTANCE4, IMPORTANCE5, CUSTOM1, CUSTOM2, CUSTOM3

priority

(optional)

Lead PriorityThe priority related with the leads that should be returned as a result. The allowed lead priority fields are the following: 1, 2, 3, 4, 5, 6

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip

Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

Tip

Available from CRM.COM R13.0.0

fields_set

(optional)

List of Strings, comma separated

 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...