Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Periodicity to quotation items on create, update and info #858

Merged
merged 4 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,9 @@ We consider the following changes to be backwards-incompatible:
We list all backwards-compatible additions here. These are currently available in all published versions.
(There is also a [list of backwards-incompatible upgrades](#changelog) available, but those only apply if you [upgrade your API version](#upgrading-your-api-version).)

#### January 2025
- We added `periodicity` to the quotation line items in `quotations.info`, `quotations.create` and `quotations.update`.

#### December 2024
- We added `initial_time_tracked`, `initial_price`, `initial_cost`, `initial_amount_billed`, and `initial_amount_paid` to `projects-v2/projects.create`. "Initial" values can be used when importing project data.
- We added `project` as a note type. `project` is a legacy project. For new projects, use `nextgenProject`.
Expand Down Expand Up @@ -3427,6 +3430,7 @@ Get a quotation
+ tax_exclusive_before_discount (Money)
+ tax_inclusive (Money)
+ tax_inclusive_before_discount (Money)
+ periodicity (Periodicity, nullable)
+ currency: `USD` (string)
+ currency_exchange_rate (object)
+ from: `USD` (string)
Expand Down Expand Up @@ -3515,6 +3519,7 @@ Create a quotation.
+ percentage - Values between 0 and 100
+ product_id: `d905ff57-e866-0f59-9d1e-1fd4538bfae1` (string, optional) - This is purely informational and does not affect the quotation besides adding a reference to the product
+ purchase_price (Money, nullable, optional) - the currency must match the account currency
+ periodicity (Periodicity, nullable, optional)
+ discounts (array[CommercialDiscount], optional)
+ text: `Quotation text` (string, optional) - Uses Markdown formatting. A quotation needs `grouped_lines` and/or `text` to be valid
+ document_template_id: `179e1564-493b-4305-8c54-a34fc80920fc` (string, optional)
Expand Down Expand Up @@ -3617,6 +3622,7 @@ Update a quotation.
+ percentage - Values between 0 and 100
+ product_id: `d905ff57-e866-0f59-9d1e-1fd4538bfae1` (string, optional) - This is purely informational and does not affect the quotation besides adding a reference to the product
+ purchase_price (Money, nullable, optional) - the currency must match the account currency
+ periodicity (Periodicity, nullable, optional)
+ discounts (array[CommercialDiscount], optional)
+ text: `Quotation text` (string, optional, nullable) - Uses Markdown formatting. A quotation needs `grouped_lines` and/or `text` to be valid
+ document_template_id: `179e1564-493b-4305-8c54-a34fc80920fc` (string, optional)
Expand Down
3 changes: 3 additions & 0 deletions src/03-deals/quotations.apib
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Get a quotation
+ tax_exclusive_before_discount (Money)
+ tax_inclusive (Money)
+ tax_inclusive_before_discount (Money)
+ periodicity (Periodicity, nullable)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: If I understood correctly .info will never be null, since it will be returned as "one_time_only"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q: If I understood correctly .info will never be null, since it will be returned as "one_time_only"

🤔 it is being returned as null, right? https://github.com/teamleadercrm/core/pull/40039/files#diff-d0cc69b0bbf026baf248d48ffc3962a248b9714e3bcde97b7ba6526276d6cf32R126

+ currency: `USD` (string)
+ currency_exchange_rate (object)
+ from: `USD` (string)
Expand Down Expand Up @@ -193,6 +194,7 @@ Create a quotation.
+ percentage - Values between 0 and 100
+ product_id: `d905ff57-e866-0f59-9d1e-1fd4538bfae1` (string, optional) - This is purely informational and does not affect the quotation besides adding a reference to the product
+ purchase_price (Money, nullable, optional) - the currency must match the account currency
+ periodicity (Periodicity, nullable, optional)
+ discounts (array[CommercialDiscount], optional)
+ text: `Quotation text` (string, optional) - Uses Markdown formatting. A quotation needs `grouped_lines` and/or `text` to be valid
+ document_template_id: `179e1564-493b-4305-8c54-a34fc80920fc` (string, optional)
Expand Down Expand Up @@ -295,6 +297,7 @@ Update a quotation.
+ percentage - Values between 0 and 100
+ product_id: `d905ff57-e866-0f59-9d1e-1fd4538bfae1` (string, optional) - This is purely informational and does not affect the quotation besides adding a reference to the product
+ purchase_price (Money, nullable, optional) - the currency must match the account currency
+ periodicity (Periodicity, nullable, optional)
+ discounts (array[CommercialDiscount], optional)
+ text: `Quotation text` (string, optional, nullable) - Uses Markdown formatting. A quotation needs `grouped_lines` and/or `text` to be valid
+ document_template_id: `179e1564-493b-4305-8c54-a34fc80920fc` (string, optional)
Expand Down
3 changes: 3 additions & 0 deletions src/changes-backwards-compatible.apib
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
We list all backwards-compatible additions here. These are currently available in all published versions.
(There is also a [list of backwards-incompatible upgrades](#changelog) available, but those only apply if you [upgrade your API version](#upgrading-your-api-version).)

#### January 2025
- We added `periodicity` to the quotation line items in `quotations.info`, `quotations.create` and `quotations.update`.

#### December 2024
- We added `initial_time_tracked`, `initial_price`, `initial_cost`, `initial_amount_billed`, and `initial_amount_paid` to `projects-v2/projects.create`. "Initial" values can be used when importing project data.
- We added `project` as a note type. `project` is a legacy project. For new projects, use `nextgenProject`.
Expand Down