Release v22.10.0 from PR #534

CHANGELOG.md

@@ -8,6 +8,15 @@ For public Changelog covering all changes done to Pipedrive’s API, webhooks an
 
 ## [Unreleased]
 
+## [22.10.0] - 2024-06-07
+### Added
+Added `acv`, `mrr`, `arr`, `acv_currency`, `mrr_currency`, and `arr_currency` to the BaseDeal entity and the following endpoints' response:
+- `GET`, `POST` `/v1/deals`
+- `GET`, `PUT` `/v1/deals/{id}`
+- `GET` `/v1/deals/timeline`
+- `PUT` `/v1/deals/{id}/merge`
+- `POST` `/v1/deals/{id}/duplicate`
+
 ## [22.9.0] - 2024-05-30
 ### Fixed
 - Documentation for response models: changed property names to snake_case instead of camelCase
@@ -629,7 +638,8 @@ structure
 * Fixed `GET /goal/:id/results` error handling in case when there are no existing stages connected to specified goal
 * Fixed typo in lead example response (`crrency` to `currency`)
 
-[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.9.0...HEAD
+[Unreleased]: https://github.com/pipedrive/api-docs/compare/v22.10.0...HEAD
+[22.10.0]: https://github.com/pipedrive/api-docs/compare/v22.9.0...v22.10.0
 [22.9.0]: https://github.com/pipedrive/api-docs/compare/v22.8.2...v22.9.0
 [22.8.2]: https://github.com/pipedrive/api-docs/compare/v22.8.1...v22.8.2
 [22.8.1]: https://github.com/pipedrive/api-docs/compare/v22.8.0...v22.8.1

docs/AddNoteRequest.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **person_id** | **Number** | The ID of the person this note will be attached to. This property is required unless one of (`deal_id/lead_id/org_id`) is specified. | [optional] 
 **org_id** | **Number** | The ID of the organization this note will be attached to. This property is required unless one of (`deal_id/lead_id/person_id`) is specified. | [optional] 
 **user_id** | **Number** | The ID of the user who will be marked as the author of the note. Only an admin can change the author. | [optional] 
-**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
+**add_time** | **String** | The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 **pinned_to_lead_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to lead pinning state (`lead_id` is also required) | [optional] 
 **pinned_to_deal_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to deal pinning state (`deal_id` is also required) | [optional] 
 **pinned_to_organization_flag** | [**NumberBoolean**](NumberBoolean.md) | If set, the results are filtered by note to organization pinning state (`org_id` is also required) | [optional] 

docs/BaseDeal.md

@@ -60,5 +60,11 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
 **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
+**arr** | **Number** | Only available in Advanced and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**mrr** | **Number** | Only available in Advanced and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**acv** | **Number** | Only available in Advanced and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal  | [optional] 
+**arr_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Recurring Revenue of the deal  If the `arr` is null, this will also be null  | [optional] 
+**mrr_currency** | **String** | Only available in Advanced and above plans  The Currency for Monthly Recurring Revenue of the deal  If the `mrr` is null, this will also be null  | [optional] 
+**acv_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Contract Value of the deal  If the `acv` is null, this will also be null  | [optional] 
 
 

docs/BasicPerson.md

@@ -11,6 +11,6 @@ Name | Type | Description | Notes
 **label** | **Number** | The ID of the label. | [optional] 
 **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the person. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional] 
 **marketing_status** | [**MarketingStatus**](MarketingStatus.md) | If the person does not have a valid email address, then the marketing status is **not set** and `no_consent` is returned for the `marketing_status` value when the new person is created. If the change is forbidden, the status will remain unchanged for every call that tries to modify the marketing status. Please be aware that it is only allowed **once** to change the marketing status from an old status to a new one.<table><tr><th>Value</th><th>Description</th></tr><tr><td>`no_consent`</td><td>The customer has not given consent to receive any marketing communications</td></tr><tr><td>`unsubscribed`</td><td>The customers have unsubscribed from ALL marketing communications</td></tr><tr><td>`subscribed`</td><td>The customers are subscribed and are counted towards marketing caps</td></tr><tr><td>`archived`</td><td>The customers with `subscribed` status can be moved to `archived` to save consent, but they are not paid for</td></tr></table> | [optional] 
-**add_time** | **String** | The optional creation date & time of the person in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
+**add_time** | **String** | The optional creation date & time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 
 

docs/DealNonStrict.md

@@ -65,5 +65,11 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
 **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
+**arr** | **Number** | Only available in Advanced and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**mrr** | **Number** | Only available in Advanced and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**acv** | **Number** | Only available in Advanced and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal  | [optional] 
+**arr_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Recurring Revenue of the deal  If the `arr` is null, this will also be null  | [optional] 
+**mrr_currency** | **String** | Only available in Advanced and above plans  The Currency for Monthly Recurring Revenue of the deal  If the `mrr` is null, this will also be null  | [optional] 
+**acv_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Contract Value of the deal  If the `acv` is null, this will also be null  | [optional] 
 
 

docs/DealNonStrictWithDetails.md

@@ -65,6 +65,12 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
 **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
+**arr** | **Number** | Only available in Advanced and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**mrr** | **Number** | Only available in Advanced and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**acv** | **Number** | Only available in Advanced and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal  | [optional] 
+**arr_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Recurring Revenue of the deal  If the `arr` is null, this will also be null  | [optional] 
+**mrr_currency** | **String** | Only available in Advanced and above plans  The Currency for Monthly Recurring Revenue of the deal  If the `mrr` is null, this will also be null  | [optional] 
+**acv_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Contract Value of the deal  If the `acv` is null, this will also be null  | [optional] 
 **average_time_to_won** | [**DealNonStrictWithDetailsAllOfAverageTimeToWon**](DealNonStrictWithDetailsAllOfAverageTimeToWon.md) |  | [optional] 
 **average_stage_progress** | **Number** | The average of the deal stage progression | [optional] 
 **age** | [**DealNonStrictWithDetailsAllOfAge**](DealNonStrictWithDetailsAllOfAge.md) |  | [optional] 

docs/DealStrict.md

@@ -65,5 +65,11 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
 **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
+**arr** | **Number** | Only available in Advanced and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**mrr** | **Number** | Only available in Advanced and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**acv** | **Number** | Only available in Advanced and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal  | [optional] 
+**arr_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Recurring Revenue of the deal  If the `arr` is null, this will also be null  | [optional] 
+**mrr_currency** | **String** | Only available in Advanced and above plans  The Currency for Monthly Recurring Revenue of the deal  If the `mrr` is null, this will also be null  | [optional] 
+**acv_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Contract Value of the deal  If the `acv` is null, this will also be null  | [optional] 
 
 

docs/DealStrictWithMergeId.md

@@ -65,6 +65,12 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this Deal. | [optional] 
 **channel** | **Number** | The ID of your Marketing channel this Deal was created from. Recognized Marketing channels can be configured in your <a href=\"https://app.pipedrive.com/settings/fields\" target=\"_blank\" rel=\"noopener noreferrer\">Company settings</a>. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. | [optional] 
+**arr** | **Number** | Only available in Advanced and above plans  The Annual Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**mrr** | **Number** | Only available in Advanced and above plans  The Monthly Recurring Revenue of the deal  Null if there are no products attached to the deal  | [optional] 
+**acv** | **Number** | Only available in Advanced and above plans  The Annual Contract Value of the deal  Null if there are no products attached to the deal  | [optional] 
+**arr_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Recurring Revenue of the deal  If the `arr` is null, this will also be null  | [optional] 
+**mrr_currency** | **String** | Only available in Advanced and above plans  The Currency for Monthly Recurring Revenue of the deal  If the `mrr` is null, this will also be null  | [optional] 
+**acv_currency** | **String** | Only available in Advanced and above plans  The Currency for Annual Contract Value of the deal  If the `acv` is null, this will also be null  | [optional] 
 **merge_what_id** | **Number** | The deal ID of the deal which the original deal was merged with | [optional] 
 
 

docs/NewDeal.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] 
 **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] 
-**add_time** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
+**add_time** | **String** | The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 **won_time** | **String** | The optional date and time of changing the deal status as won in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Won. Can not be used together with `lost_time`. | [optional] 
 **lost_time** | **String** | The optional date and time of changing the deal status as lost in UTC. Format: YYYY-MM-DD HH:MM:SS. Can be set only when deal `status` is already Lost. Can not be used together with `won_time`. | [optional] 
 **close_time** | **String** | The optional date and time of closing the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. | [optional] 

docs/NewDealParameters.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **origin_id** | **String** | The optional ID to further distinguish the origin of the deal - e.g. Which API integration created this deal. If omitted, `origin_id` will be set to null. | [optional] 
 **channel** | **Number** | The ID of Marketing channel this deal was created from. Provided value must be one of the channels configured for your company. You can fetch allowed values with <a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\" target=\"_blank\" rel=\"noopener noreferrer\">GET /v1/dealFields</a>. If omitted, channel will be set to null. | [optional] 
 **channel_id** | **String** | The optional ID to further distinguish the Marketing channel. If omitted, `channel_id` will be set to null. | [optional] 
-**add_time** | **String** | The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
+**add_time** | **String** | The optional creation date & time of the deal in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 
 
 

docs/NewOrganization.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of the organization | 
-**add_time** | **String** | The optional creation date & time of the organization in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS | [optional] 
+**add_time** | **String** | The optional creation date & time of the organization in UTC. Format: YYYY-MM-DD HH:MM:SS | [optional] 
 **owner_id** | **Number** | The ID of the user who will be marked as the owner of this organization. When omitted, the authorized user ID will be used. | [optional] 
 **label** | **Number** | The ID of the label. | [optional] 
 **visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the organization. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner & followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width:40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional]