Merge branch 'master' into ATL-2280-meeting-complete

# Conflicts:
#	apiary.apib
#	src/changes-backwards-compatible.apib

apiary.apib

@@ -426,11 +426,14 @@ 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).)
 
+### October 2023
+- We added `late_fees` to `invoices.info` and `invoices.list`.
+- We added the `meetings.complete` endpoint.
+
 ### September 2023
 - We added the `meetings.list` and `meetings.info` endpoints.
 - We added `time_estimated` and `amount_unbilled` to `projects-v2/projects.list`.
-- We added sorting on `amount_billed`, `amount_paid`, `amount_unbilled`, `external_budget_spent`, `external_budget`, `internal_budget` and `time_estimated` to `projects-v2/projects.list`. 
-- We added the `meetings.complete` endpoint.
+- We added sorting on `amount_billed`, `amount_paid`, `amount_unbilled`, `external_budget_spent`, `external_budget`, `internal_budget` and `time_estimated` to `projects-v2/projects.list`.
 
 ### August 2023
 - We added `quotation` as a type for `cloudPlatforms.url`.
@@ -847,7 +850,7 @@ This documentation only reflects the latest version of the API.
 If you need to make changes to your client or you want to make use of the latest feature, you might need to upgrade your API version.
 
 You can find your current API version, in the `X-Api-Version` header on any API response.
-The current latest version is **2022-09-15**.
+The current latest version is **2023-09-26**.
 
 After checking the API [changelog](#changelog) to see which endpoints work differently, you can upgrade your API version:
 
@@ -864,6 +867,21 @@ We list all backwards-incompatible changes here. As described above, new additio
 
 As of October 1st 2023, we expect all network clients to make use of TLS 1.2 or higher when connecting to our infrastructure.
 
+#### 2023-09-26
+
+ - When updating events through `events.update`, links to deals must also be provided otherwise existing deal link(s) will be removed.
+
+ - `Currency` is no longer supported or validated on line items for invoices, quotations, subscriptions & credit notes endpoints. Instead, it will be supported on the document level for
+  - `invoices.draft`
+  - `invoices.update`
+  - `quotations.create`
+  - `quotations.update`
+
+ - `customFieldDefinitions.list` and `customFieldDefinitions.info` will now return configuration options (for single and multiple select custom fields) as an array of objects.
+
+ - We updated the `location` format of returned by `/meetings.info` endpoint
+ - Both `/meetings.list`  and `/meetings.info` will now return a meeting `title` instead of `name`
+
 #### 2022-09-15
 
 - The property `remark` has been renamed to `note` on:
@@ -1358,7 +1376,10 @@ Get a list of all the definitions of custom fields.
                 + group (string)
                 + required: false (boolean)
                 + configuration (object, optional)
-                    + options: foo, bar (array[string])
+                    + options (array, optional) - Only returned for `single_select` and `multi_select` types
+                        + (object)
+                            + id: `179e1564-493b-4305-8c54-a34fc80920fc` (string)
+                            + value: `foo` (string)
                     + extra_option_allowed: true (boolean)
 
 ### customFieldDefinitions.info [POST /customFieldDefinitions.info]
@@ -1409,7 +1430,10 @@ Get info about a specific custom field definition.
             + group (string)
             + required: false (boolean)
             + configuration (object, optional)
-                + options: foo, bar (array[string])
+                + options (array, optional) - Only returned for `single_select` and `multi_select` types
+                    + (object)
+                        + id: `179e1564-493b-4305-8c54-a34fc80920fc` (string)
+                        + value: `foo` (string)
                 + extra_option_allowed: true (boolean)
 
 ## Work Types [/workTypes]
@@ -2726,6 +2750,9 @@ Create a quotation.
 
     + Attributes (object)
         + deal_id: `cef01135-7e51-4f6f-a6eb-6e5e5a885ac8` (string, required)
+        + currency (object)
+            + code: `EUR` (Currency, required)
+            + exchange_rate: `1.1238` (number)
         + `grouped_lines` (array, optional) - A quotation needs `grouped_lines` and/or `text` to be valid
             + (object)
                 + section (object, optional)
@@ -2737,7 +2764,7 @@ Create a quotation.
                         + extended_description: `Some more information about this awesome product` (string, optional) - Uses Markdown formatting
                         + unit_of_measure_id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string, optional, nullable)
                         + unit_price (object, required)
-                            + Include Money
+                            + amount: `123.30` (number)
                             + tax: `excluding` (enum, required)
                                 + Members
                                     + excluding
@@ -2825,6 +2852,9 @@ Update a quotation.
 
     + Attributes (object)
         + id: `5b16f6ee-e302-0079-901b-50c26c4a55b1` (string, required)
+        + currency (object)
+            + code: `EUR` (Currency, required)
+            + exchange_rate: `1.1238` (number)
         + `grouped_lines` (array, optional) - A quotation needs `grouped_lines` and/or `text` to be valid
             + (object)
                 + section (object, optional)
@@ -2836,7 +2866,7 @@ Update a quotation.
                         + extended_description: `Some more information about this awesome product` (string, optional) - Uses Markdown formatting
                         + unit_of_measure_id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string, optional, nullable)
                         + unit_price (object, required)
-                            + Include Money
+                            + amount: `123.30` (number)
                             + tax: `excluding` (enum, required)
                                 + Members
                                     + excluding
@@ -3154,7 +3184,7 @@ Get a list of meetings.
         + data (array)
             + (object)
                 + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
-                + name (string)
+                + title (string)
                 + description (string)
                 + created_at: `2020-02-01T10:33:45+00:00` (string)
                 + scheduled_at: `2020-02-04T16:44:33+00:00` (string)
@@ -3215,7 +3245,7 @@ Get information about a meeting.
     + Attributes (object)
         + data (object)
             + id: `70af3fdd-b037-0936-ad1a-6d784dd44cf4` (string)
-            + name (string)
+            + title (string)
             + description (string)
             + scheduled_at: `2020-02-04T16:44:33+00:00` (string)
             + duration (object)
@@ -3251,15 +3281,24 @@ Get information about a meeting.
                 + type: `deal` (string)
                 + id: `08b979e5-90d6-01e0-ac28-d58db81c3b12` (string)
             + location (object, nullable)
-                + number (string)
-                + street (string)
-                + zipcode (string)
-                + city (string)
-                + region (string)
-                + country_code (string)
-                + description (string)
-                + first_line (string)
-                + second_line (string)
+                + One Of
+                    + Properties
+                        + type: `virtual` (string)
+                    + Properties
+                        + type: `contact` (enum)
+                            + Members
+                                + contact
+                                + company
+                        + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
+                        + address (AddressResponse)
+                   + Properties
+                        + type: `address` (string)
+                        + address (AddressResponse)
+                  + Properties
+                        + type: `customLocation` (string)
+                        + address (AddressResponse)
+                  + Properties
+                        + type: `calendarResource` (string)
             + online_meeting_room (object, nullable)
                 + type: `onlineMeetingRoom` (string)
                 + id: `89b76a74dcf842b298b90ea79a5d1f7a` (string)
@@ -3340,6 +3379,7 @@ Get a list of invoices.
                 + (object)
                     + field: `invoice_number`
                     + order: `asc`
+        + includes: `late_fees` (string, optional) - when used, the response will include `totals.due_incasso_inclusive`, `totals.fixed_late_fee` and `totals.interest`
 
 + Response 200 (application/json)
 
@@ -3384,6 +3424,9 @@ Get a list of invoices.
                             + taxable (Money)
                             + tax (Money)
                     + due (Money)
+                    + due_incasso_inclusive (Money) - Only included with request parameter `includes=late_fees`
+                    + fixed_late_fee (Money) - Only included with request parameter `includes=late_fees`
+                    + interest (Money) - Only included with request parameter `includes=late_fees`
                 + currency_exchange_rate (object)
                     + from: `USD` (string)
                     + to: `EUR` (string)
@@ -3409,6 +3452,8 @@ Get details for a single invoice.
 
     + Attributes (object)
         + id: `27300f09-6250-4a23-8557-d84c52f99ecf` (string)
+        + includes: `late_fees` (string, optional) - when used, the response will include `totals.due_incasso_inclusive`, `totals.fixed_late_fee` and `totals.interest`
+
 
 + Response 200 (application/json)
 
@@ -3463,7 +3508,7 @@ Get details for a single invoice.
                                 + type: `unitOfMeasure` (string)
                                 + id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string)
                             + unit_price (object)
-                                + Include Money
+                                + amount: `123.30` (number)
                                 + tax: `excluding` (enum)
                                     + Members
                                         + excluding
@@ -3500,6 +3545,9 @@ Get details for a single invoice.
                         + withheld (Money)
                 + payable (Money)
                 + due (Money)
+                + due_incasso_inclusive (Money) - Only included with request parameter `includes=late_fees`
+                + fixed_late_fee (Money) - Only included with request parameter `includes=late_fees`
+                + interest (Money) - Only included with request parameter `includes=late_fees`
             + payment_term (PaymentTerm)
             + payments (array)
                 + (object)
@@ -3571,6 +3619,9 @@ Draft a new invoice.
                     + contact_id: `417a2231-c3c7-4e1c-a6bb-1b014836ca60` (string, required)
         + department_id: `cef01135-7e51-4f6f-a6eb-6e5e5a885ac7` (string, required)
         + payment_term (PaymentTerm, required)
+        + currency (object)
+            + code: `EUR` (Currency, required)
+            + exchange_rate: `1.1238` (number)
         + project_id: `624ca743-8998-4f8c-add1-c427bb022166` (string, optional)
         + purchase_order_number: `000023` (string, optional)
         + grouped_lines (array[InvoiceGroupedLinesWrite], required)
@@ -3608,6 +3659,9 @@ Update a draft invoice. Booked invoices cannot be updated.
                     + name `Finance Dept.` (string, required)
                     + contact_id: `417a2231-c3c7-4e1c-a6bb-1b014836ca60` (string, required)
         + payment_term (PaymentTerm, optional)
+        + currency (object)
+            + code: `EUR` (Currency, required)
+            + exchange_rate: `1.1238` (number)
         + project_id: `624ca743-8998-4f8c-add1-c427bb022166` (string, optional)
         + purchase_order_number: `000023` (string, optional)
         + grouped_lines (array[InvoiceGroupedLinesWrite], optional)
@@ -7855,7 +7909,7 @@ Fetch cloudPlatform url for type and id
 + extended_description: `Some more information about this awesome product` (string, optional, nullable) - Uses Markdown formatting
 + unit_of_measure_id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string, optional, nullable)
 + unit_price (object, required)
-    + Include Money
+    + amount: `123.30` (number, required)
     + tax: `excluding` (enum, required)
         + Members
             + excluding
@@ -7920,7 +7974,7 @@ Fetch cloudPlatform url for type and id
             + type: `unitOfMeasure` (string)
             + id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string)
         + unit_price (object)
-            + Include Money
+            + amount: `123.30` (number)
             + tax: `excluding` (enum)
                 + Members
                     + excluding
@@ -7993,7 +8047,7 @@ Fetch cloudPlatform url for type and id
         + extended_description: `Some more information about this awesome product` (string, optional, nullable) - Uses Markdown formatting
         + unit_of_measure_id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string, optional, nullable)
         + unit_price (object)
-            + Include Money
+            + amount: `123.30` (number, required)
             + tax: `excluding` (enum)
                 + Members
                     + excluding

src/01-general/custom-fields.apib

@@ -65,7 +65,10 @@ Get a list of all the definitions of custom fields.
                 + group (string)
                 + required: false (boolean)
                 + configuration (object, optional)
-                    + options: foo, bar (array[string])
+                    + options (array, optional) - Only returned for `single_select` and `multi_select` types
+                        + (object)
+                            + id: `179e1564-493b-4305-8c54-a34fc80920fc` (string)
+                            + value: `foo` (string)
                     + extra_option_allowed: true (boolean)
 
 ### customFieldDefinitions.info [POST /customFieldDefinitions.info]
@@ -116,5 +119,8 @@ Get info about a specific custom field definition.
             + group (string)
             + required: false (boolean)
             + configuration (object, optional)
-                + options: foo, bar (array[string])
+                + options (array, optional) - Only returned for `single_select` and `multi_select` types
+                    + (object)
+                        + id: `179e1564-493b-4305-8c54-a34fc80920fc` (string)
+                        + value: `foo` (string)
                 + extra_option_allowed: true (boolean)

src/03-deals/quotations.apib

@@ -165,6 +165,9 @@ Create a quotation.
 
     + Attributes (object)
         + deal_id: `cef01135-7e51-4f6f-a6eb-6e5e5a885ac8` (string, required)
+        + currency (object)
+            + code: `EUR` (Currency, required)
+            + exchange_rate: `1.1238` (number)
         + `grouped_lines` (array, optional) - A quotation needs `grouped_lines` and/or `text` to be valid
             + (object)
                 + section (object, optional)
@@ -176,7 +179,7 @@ Create a quotation.
                         + extended_description: `Some more information about this awesome product` (string, optional) - Uses Markdown formatting
                         + unit_of_measure_id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string, optional, nullable)
                         + unit_price (object, required)
-                            + Include Money
+                            + amount: `123.30` (number)
                             + tax: `excluding` (enum, required)
                                 + Members
                                     + excluding
@@ -264,6 +267,9 @@ Update a quotation.
 
     + Attributes (object)
         + id: `5b16f6ee-e302-0079-901b-50c26c4a55b1` (string, required)
+        + currency (object)
+            + code: `EUR` (Currency, required)
+            + exchange_rate: `1.1238` (number)
         + `grouped_lines` (array, optional) - A quotation needs `grouped_lines` and/or `text` to be valid
             + (object)
                 + section (object, optional)
@@ -275,7 +281,7 @@ Update a quotation.
                         + extended_description: `Some more information about this awesome product` (string, optional) - Uses Markdown formatting
                         + unit_of_measure_id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string, optional, nullable)
                         + unit_price (object, required)
-                            + Include Money
+                            + amount: `123.30` (number)
                             + tax: `excluding` (enum, required)
                                 + Members
                                     + excluding

src/04-calendar/meetings.apib

@@ -36,7 +36,7 @@ Get a list of meetings.
         + data (array)
             + (object)
                 + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
-                + name (string)
+                + title (string)
                 + description (string)
                 + created_at: `2020-02-01T10:33:45+00:00` (string)
                 + scheduled_at: `2020-02-04T16:44:33+00:00` (string)
@@ -97,7 +97,7 @@ Get information about a meeting.
     + Attributes (object)
         + data (object)
             + id: `70af3fdd-b037-0936-ad1a-6d784dd44cf4` (string)
-            + name (string)
+            + title (string)
             + description (string)
             + scheduled_at: `2020-02-04T16:44:33+00:00` (string)
             + duration (object)
@@ -133,15 +133,24 @@ Get information about a meeting.
                 + type: `deal` (string)
                 + id: `08b979e5-90d6-01e0-ac28-d58db81c3b12` (string)
             + location (object, nullable)
-                + number (string)
-                + street (string)
-                + zipcode (string)
-                + city (string)
-                + region (string)
-                + country_code (string)
-                + description (string)
-                + first_line (string)
-                + second_line (string)
+                + One Of
+                    + Properties
+                        + type: `virtual` (string)
+                    + Properties
+                        + type: `contact` (enum)
+                            + Members
+                                + contact
+                                + company
+                        + id: `f29abf48-337d-44b4-aad4-585f5277a456` (string)
+                        + address (AddressResponse)
+                   + Properties
+                        + type: `address` (string)
+                        + address (AddressResponse)
+                  + Properties
+                        + type: `customLocation` (string)
+                        + address (AddressResponse)
+                  + Properties
+                        + type: `calendarResource` (string)
             + online_meeting_room (object, nullable)
                 + type: `onlineMeetingRoom` (string)
                 + id: `89b76a74dcf842b298b90ea79a5d1f7a` (string)