JDBC Driver for Pipedrive

Build 24.0.9060

Deals

Get all deals.

Select

The driver will use the Pipedrive API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.

  • Id supports the '=' operator.
  • StageId supports the '=' operator.
  • Status supports the '=' operator.
  • FilterId supports the '=' operator.
  • UserId supports the '=' operator.
  • OwnedByYou supports the '=' operator.

For example, the following query is processed server side:

SELECT * FROM Deals WHERE Id = 14

SELECT * FROM Deals WHERE StageId = 1

SELECT * FROM Deals WHERE  Status = 'Open'

SELECT * FROM Deals WHERE FilterId = 1       

SELECT * FROM Deals WHERE OwnedByYou = 1                

INSERT

Insert can be executed by specifying the Title columns.The columns that are not read-only can be inserted. Following is an example of how to insert into this table.

INSERT INTO Deals (title, PersonId) VALUES ('tetsptest', 6203)

UPDATE

Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated. For example:

UPDATE Deals SET Title = 'test' WHERE id = 15

DELETE

Delete can be executed by specifying the Id in the WHERE Clause. For example:

DELETE FROM Deals WHERE id = 15

Columns

Name Type ReadOnly Description
Id [KEY] Integer True

Deals id.

Active Boolean True

Active.

ActivitiesCount Integer True

Activities Count.

AddTime Datetime False

AddTime.

CcEmail String True

Cc Email.

CloseTime String True

Close Time.

CreatorActiveFlag Boolean True

Creator ActiveFlag.

CreatorEmail String True

Creator Email.

CreatorHasPic Boolean True

Creator HasPic.

CreatorId Integer True

Creator Id.

CreatorName String True

Creator Name.

CreatorPicHash String True

CreatorPicHash.

Creatorvalue Integer True

Creatorvalue.

Currency String False

Currency.

CustomeField String True

CustomeField you will get the result of this column only when criteria filter title is used.

Deleted Boolean True

Deleted.

DoneActivitiesCount Integer True

Done Activities Count.

EmailMessagesCount Integer True

Email Messages Count.

ExpectedCloseDate Date False

Expected Close Date.

FilesCount Integer True

Files Count.

FirstWonTime Datetime True

First Won Time.

FollowersCount Integer True

Followers Count.

FormattedValue String True

Formatted Value.

FormattedWeightedValue String True

Formatted Weighted Value.

Label String True

Label.

LastActivityDate String True

Last Activity Date.

LastActivityId String True

Last Activity Id.

LastIncomingMailTime Datetime True

Last Incoming MailTime.

LastOutgoingMailTime Datetime True

Last OutgoingMail Time.

LostReason String False

Lost Reason.

LostTime String True

Lost Time.

NextActivityDate Date True

Next Activity Date.

NextActivityDuration Time True

Next Activity Duration.

NextActivityId Integer True

Next Activity Id.

NextActivityNote String True

Next Activity Note.

NextActivitySubject String True

Next Activity Subject.

NextActivityTime Time True

Next Activity Time.

NextActivityType String True

Next Activity Type.

NotesCount Integer True

NotesCount.

Notes String True

Notes.

OrgHidden Boolean True

Org Hidden.

OrgActiveFlag Boolean True

Org ActiveFlag.

OrgAddress String True

Org Address.

OrgCcEmail String True

Org CcEmail.

OrgName String True

Org Name.

OrgOwnerId Integer True

Org OwnerId.

OrgPeopleCount Integer True

Org PeopleCount.

OrgValue Integer True

Org Value.

OwnerName String True

Owner Name.

OwnerId String True

Owner Id you will get the result of this column only when criteria filter title is used.

ParticipantsCount Integer True

Participants Count.

PersonHidden Boolean True

Person Hidden.

PersonActiveFlag Boolean True

Person Active Flag.

PersonEmail String True

Person Email.

PersonName String True

Person Name.

PersonPhone String True

Person Phone.

Personvalue Integer True

Personvalue.

PipelineId Integer True

PipelineId.

Probability String True

Probability.

ProductsCount Integer True

Products Count.

RottenTime String True

RottenTime.

ResultScore String True

Result score you will get the result of this column only when criteria filter title is used.

StageChangeTime Datetime True

Stage Change Time.

StageId Integer True

StageId.

StageName String True

StageName.

StageOrderNr Integer True

Stage OrderNr.

Status String False

Status.

The allowed values are open, won, lost, deleted, all_not_deleted.

The default value is all_not_deleted.

Title String False

Title.

Type String True

Type you will get the result of this column only when criteria filter title is used.

UndoneActivitiesCount Integer True

Undone Activities Count.

UpdateTime Datetime True

Update Time.

UserActiveFlag Boolean True

User ActiveFlag.

UserEmail String True

User Email.

UserHasPic Boolean True

User HasPic.

UserId Integer False

User Id.

UserName String True

User Name.

UserPicHash String True

User PicHash.

Uservalue Integer True

User value.

Value Integer False

Value of the deal.

The default value is 0.

VisibleTo String False

Visibility of the deal.

The allowed values are 1, 3, 5, 7.

WeightedValue Integer True

Visible To.

WeightedValueCurrency String True

Weighted Value Currency.

OrderOfStages Integer True

You will get the result of this column only when criteria filter id is used.

AverageTimeToWonY Integer True

You will get the result of this column only when criteria filter id is used.

AverageTimeToWonM Integer True

You will get the result of this column only when criteria filter id is used.

AverageTimeToWond Integer True

You will get the result of this column only when criteria filter id is used.

AverageTimeToWonh Integer True

You will get the result of this column only when criteria filter id is used.

AverageTimeToWons Integer True

You will get the result of this column only when criteria filter id is used.

AverageTimeToWoni Integer True

You will get the result of this column only when criteria filter id is used.

AverageTotalSeconds Integer True

You will get the result of this column only when criteria filter id is used.

AverageStageProgress Integer True

You will get the result of this column only when criteria filter id is used.

AgeY Integer True

You will get the result of this column only when criteria filter id is used.

AgeM Integer True

You will get the result of this column only when criteria filter id is used.

Aged Integer True

You will get the result of this column only when criteria filter id is used.

Ageh Integer True

You will get the result of this column only when criteria filter id is used.

Ages Integer True

You will get the result of this column only when criteria filter id is used.

Agei Integer True

You will get the result of this column only when criteria filter id is used.

AgeTotalSeconds Integer True

You will get the result of this column only when criteria filter id is used.

WonTime Datetime True

Won time.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FilterId Integer

Filter Id

OwnedByYou Integer

Owned By You

The allowed values are 0, 1.

PersonId Integer

Person Id. Only used when performing INSERT or UPDATE operation.

OrgId Integer

Org Id. Only used when performing INSERT or UPDATE operation.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060