From 0c6a41530c9b8f348a3739013ed22259bd047914 Mon Sep 17 00:00:00 2001 From: Hector Marfull Date: Fri, 3 Jan 2025 16:18:22 +0100 Subject: [PATCH 1/4] Add Periodicity to quotation items on create, update and info --- apiary.apib | 3 +++ src/03-deals/quotations.apib | 3 +++ 2 files changed, 6 insertions(+) diff --git a/apiary.apib b/apiary.apib index a6760047..66a18fe7 100644 --- a/apiary.apib +++ b/apiary.apib @@ -3427,6 +3427,7 @@ Get a quotation + tax_exclusive_before_discount (Money) + tax_inclusive (Money) + tax_inclusive_before_discount (Money) + + periodicity (Periodicity) + currency: `USD` (string) + currency_exchange_rate (object) + from: `USD` (string) @@ -3515,6 +3516,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) + 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) @@ -3617,6 +3619,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) + 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) diff --git a/src/03-deals/quotations.apib b/src/03-deals/quotations.apib index b76aa284..f0ec46f0 100644 --- a/src/03-deals/quotations.apib +++ b/src/03-deals/quotations.apib @@ -105,6 +105,7 @@ Get a quotation + tax_exclusive_before_discount (Money) + tax_inclusive (Money) + tax_inclusive_before_discount (Money) + + periodicity (Periodicity) + currency: `USD` (string) + currency_exchange_rate (object) + from: `USD` (string) @@ -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) + 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) @@ -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) + 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) From 14a870dc52c9da541f41cb19e0e729e0e7dd8b59 Mon Sep 17 00:00:00 2001 From: Hector Marfull Date: Fri, 3 Jan 2025 16:29:27 +0100 Subject: [PATCH 2/4] Specify Periodicity as optional --- apiary.apib | 4 ++-- src/03-deals/quotations.apib | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/apiary.apib b/apiary.apib index 66a18fe7..ac2a6020 100644 --- a/apiary.apib +++ b/apiary.apib @@ -3516,7 +3516,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) + + 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) @@ -3619,7 +3619,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) + + 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) diff --git a/src/03-deals/quotations.apib b/src/03-deals/quotations.apib index f0ec46f0..a52cc6a9 100644 --- a/src/03-deals/quotations.apib +++ b/src/03-deals/quotations.apib @@ -194,7 +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) + + 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) @@ -297,7 +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) + + 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) From 5193acabea5438f886db2d0a430fb430bcf74beb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Mon, 6 Jan 2025 15:33:32 +0000 Subject: [PATCH 3/4] add entry to changelog --- apiary.apib | 3 +++ src/changes-backwards-compatible.apib | 3 +++ 2 files changed, 6 insertions(+) diff --git a/apiary.apib b/apiary.apib index ac2a6020..371986c3 100644 --- a/apiary.apib +++ b/apiary.apib @@ -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`. diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 6baf02e0..8838a72e 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -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`. From 07477f45feee8c604abef7d826d81080e15f7c1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Mon, 6 Jan 2025 15:35:05 +0000 Subject: [PATCH 4/4] periodicity may be nullable on quotations.info --- apiary.apib | 2 +- src/03-deals/quotations.apib | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 371986c3..d6e5bcae 100644 --- a/apiary.apib +++ b/apiary.apib @@ -3430,7 +3430,7 @@ Get a quotation + tax_exclusive_before_discount (Money) + tax_inclusive (Money) + tax_inclusive_before_discount (Money) - + periodicity (Periodicity) + + periodicity (Periodicity, nullable) + currency: `USD` (string) + currency_exchange_rate (object) + from: `USD` (string) diff --git a/src/03-deals/quotations.apib b/src/03-deals/quotations.apib index a52cc6a9..7a522cef 100644 --- a/src/03-deals/quotations.apib +++ b/src/03-deals/quotations.apib @@ -105,7 +105,7 @@ Get a quotation + tax_exclusive_before_discount (Money) + tax_inclusive (Money) + tax_inclusive_before_discount (Money) - + periodicity (Periodicity) + + periodicity (Periodicity, nullable) + currency: `USD` (string) + currency_exchange_rate (object) + from: `USD` (string)