JDBC Driver for SuiteCRM

Build 22.0.8462

Leads

Create, update, delete, and query the registered Leads

Table Specific Information

Select

You can query the Leads table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.

SELECT * FROM Leads WHERE Name = 'test'

Insert

Create a Lead by specifying any writable column.

INSERT INTO Leads (Id, Name) VALUES ('id', 'Energy')

Update

You can update any Lead column that is writable, by specifying the Id.

UPDATE Leads SET Name = 'new name', Description = 'Desc' WHERE Id = 'Test123' 

Delete

Remove a Lead by specifying the Id.

DELETE FROM Leads WHERE Id = 10003

Columns

Name Type ReadOnly Description
Id [KEY] String False

The unique identifier of the record.

Name String False

The name of the lead.

DateEntered Datetime False

The date the record was created.

DateModified Datetime False

Date the record was last modified.

ModifiedUserId String False

The Id of the user who last modified the record.

ModifiedByName String True

The name of the user who last modified the record.

CreatedBy String False

The Id of the user who created the record.

CreatedByName String True

The name of the user who created the record.

Description String False

Full text of the note.

Deleted Bool False

Record deletion indicator.

CreatedByLink String True

Link to the record who created it

ModifiedUserLink String True

Link to the record who modified it.

AssignedUserId String False

AssignedUserName String True

AssignedUserLink String True

Link to the user which the record has been assigned to

SecurityGroups String True

The security group associated with the record.

Salutation String False

The lead salutation (e.g., Mr. or Ms.).

FirstName String False

The first name of the lead.

LastName String False

The last name of the lead.

FullName String False

The full name of the lead.

Title String False

The title of the lead.

Photo String False

The picture for the lead.

Department String False

The department of the lead.

DoNotCall Bool False

An indicator of whether the lead can be called.

PhoneHome String False

Email String False

PhoneMobile String False

PhoneWork String False

PhoneOther String False

PhoneFax String False

Email1 String False

Email address.

Email2 String False

InvalidEmail Bool False

Whether the email address of the account has been marked as invalid.

EmailOptOut Bool False

Whether the lead has opted out of radio.

LawfulBasis String False

DateReviewed String False

LawfulBasisSource String False

PrimaryAddressStreet String False

The street address used for the primary address.

PrimaryAddressStreet2 String False

The second line of the primary address.

PrimaryAddressStreet3 String False

The third line of the primary addrss.

PrimaryAddressCity String False

The city for the primary address.

PrimaryAddressState String False

The state for the primary address.

PrimaryAddressPostalcode String False

The postal code for the primary address.

PrimaryAddressCountry String False

The country for the primary address.

AltAddressStreet String False

The street address for the alternate address.

AltAddressStreet2 String False

The second line of the alternate address.

AltAddressStreet3 String False

The third line of the alternate address.

AltAddressCity String False

The city for the alternate address.

AltAddressState String False

The state for the alternate address.

AltAddressPostalcode String False

The postal code for the alternate address.

AltAddressCountry String False

The country for the alternate address.

Assistant String False

The name of the assistant of the lead.

AssistantPhone String False

The phone number of the assistant of the lead.

EmailAddressesPrimary String True

Primary email address.

EmailAddresses String True

Alternate Email address.

EmailAddressesNonPrimary String False

Non primary email address.

Converted Bool False

Whether the lead has been converted.

ReferedBy String False

LeadSource String False

How the lead came to be known.

LeadSourceDescription String False

Description of the lead source.

Status String False

The status of the record.

StatusDescription String False

A description for the status

ReportsToId String False

The name the updates for the lead will be reported to

ReportToName String False

ReportsToLink String True

Reportees String True

Contacts String True

The contacts associated with the record

AccountName String False

The name of the associated acocunt.

Accounts String True

The accounts associated with the record

AccountDescription String False

Description for the lead's account

ContactId String False

Main contact for the lead

Contact String True

AccountId String False

Account the lead is linked to

OpportunityId String False

The Opportunity the lead was generated from

Opportunity String True

OpportunityName String False

The name of the opportunity the lead was generated from

OpportunityAmount String False

The amount the opportunity yields

CampaignId String False

The Id of the campaign associated with the record.

CampaignName String True

The name of the campaign associated with the record.

CampaignLeads String True

CAcceptStatusFields String True

MAcceptStatusFields String True

AcceptStatusId String False

The Id of the accept status.

AcceptStatusName String False

The name of the accept status.

WebtoleadEmail1 String False

WebtoleadEmail2 String False

WebtoleadEmailOptOut Bool False

WebtoleadInvalidEmail Bool False

Birthdate String False

The birthdate of the lead.

PortalName String False

The Joomla portal name of the lead

PortalApp String False

Website String False

The lead's website

Tasks String True

The tasks associated with the record.

Notes String True

The notes associated with the record.

Meetings String True

The meetings associated with the record.

Calls String True

The calls associated with the record

Oldmeetings String True

Oldcalls String True

Emails String True

The emails associated with the record

Campaigns String True

The campaigns associated with the account.

ProspectLists String True

FpEventsLeads1 String True

EInviteStatusFields String True

EventStatusName String False

EventInviteId String False

EAcceptStatusFields String True

EventAcceptStatus String False

EventStatusId String False

Id of the lead's event status.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462