Skip to content

Deal.md

Latest commit

 

History

History
40 lines (37 loc) · 3.85 KB

Deal.md

File metadata and controls

40 lines (37 loc) · 3.85 KB

# Deal

Properties

Name Type Description Notes
id int The ID of the deal [optional]
title string The title of the deal [optional]
owner_id int The ID of the user who owns the deal [optional]
person_id int The ID of the person linked to the deal [optional]
org_id int The ID of the organization linked to the deal [optional]
pipeline_id int The ID of the pipeline associated with the deal [optional]
stage_id int The ID of the deal stage [optional]
value float The value of the deal [optional]
currency string The currency associated with the deal [optional]
add_time string The creation date and time of the deal [optional]
update_time string The last updated date and time of the deal [optional]
stage_change_time string The last updated date and time of the deal stage [optional]
is_deleted bool Whether the deal is deleted or not [optional]
is_archived bool Whether the deal is archived or not [optional]
status string The status of the deal [optional]
probability float The success probability percentage of the deal [optional]
lost_reason string The reason for losing the deal [optional]
visible_to int The visibility of the deal [optional]
close_time string The date and time of closing the deal [optional]
won_time string The date and time of changing the deal status as won [optional]
lost_time string The date and time of changing the deal status as lost [optional]
expected_close_date \DateTime The expected close date of the deal [optional]
label_ids int[] The IDs of labels assigned to the deal [optional]
origin string The way this Deal was created. `origin` field is set by Pipedrive when Deal is created and cannot be changed. [optional]
origin_id string The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. [optional]
channel int The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=&quot;https://app.pipedrive.com/settings/fields\" target=&quot;_blank&quot; rel=&quot;noopener noreferrer&quot;>Company settings</a>. [optional]
channel_id string The optional ID to further distinguish the Marketing channel. [optional]
source_lead_id string The ID of the lead if the deal was converted from a lead. Only included when requested via include_fields parameter. [optional]
arr float Only available in Growth and above plans The Annual Recurring Revenue of the deal Null if there are no products attached to the deal [optional]
mrr float Only available in Growth and above plans The Monthly Recurring Revenue of the deal Null if there are no products attached to the deal [optional]
acv float Only available in Growth and above plans The Annual Contract Value of the deal Null if there are no products attached to the deal [optional]
custom_fields array<string,object> An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes. To clear a custom field value, set it to `null`. For multi-option fields (field type `set`), use `null` to clear the selection — sending an empty array `[]` is not supported and will result in a validation error. [optional]

[Back to Model list] [Back to API list] [Back to README]