From 2276db25836c1821ac5e3d5b3d3f29dbb8645f2b Mon Sep 17 00:00:00 2001 From: Tiago Bastos Date: Mon, 25 Sep 2023 10:02:41 +0100 Subject: [PATCH 1/8] feat| add late fees to invoices.list & invoices.info --- apiary.apib | 12 +++++++++++- src/05-invoicing/invoices.apib | 9 +++++++++ src/changes-backwards-compatible.apib | 3 ++- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 55da0bca..0e7e8cb2 100644 --- a/apiary.apib +++ b/apiary.apib @@ -429,7 +429,8 @@ We list all backwards-compatible additions here. These are currently available i ### 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 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 `late_fees` to `invoices.info` and `invoices.list`. ### August 2023 - We added `quotation` as a type for `cloudPlatforms.url`. @@ -3328,6 +3329,7 @@ Get a list of invoices. + (object) + field: `invoice_number` + order: `asc` + + includes: `late_fees` (string, optional) - when used, the response will include `due_incasso_inclusive`, `fixed_late_fee` and `interest` + Response 200 (application/json) @@ -3372,6 +3374,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) @@ -3397,6 +3402,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 `due_incasso_inclusive`, `fixed_late_fee` and `interest` + + Response 200 (application/json) @@ -3488,6 +3495,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) diff --git a/src/05-invoicing/invoices.apib b/src/05-invoicing/invoices.apib index 41e7f5fe..7b4af346 100644 --- a/src/05-invoicing/invoices.apib +++ b/src/05-invoicing/invoices.apib @@ -49,6 +49,7 @@ Get a list of invoices. + (object) + field: `invoice_number` + order: `asc` + + includes: `late_fees` (string, optional) - when used, the response will include `due_incasso_inclusive`, `fixed_late_fee` and `interest` + Response 200 (application/json) @@ -93,6 +94,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) @@ -118,6 +122,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 `due_incasso_inclusive`, `fixed_late_fee` and `interest` + + Response 200 (application/json) @@ -209,6 +215,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) diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 8f588687..417ea139 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -7,7 +7,8 @@ We list all backwards-compatible additions here. These are currently available i ### 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 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 `late_fees` to `invoices.info` and `invoices.list`. ### August 2023 - We added `quotation` as a type for `cloudPlatforms.url`. From 889c5fbf5e4a62d6c470228f8fe42bd1d0b280e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Mon, 25 Sep 2023 15:30:56 +0100 Subject: [PATCH 2/8] Document new API version --- apiary.apib | 46 ++++++++++++++++++++----- src/01-general/custom-fields.apib | 10 ++++-- src/03-deals/quotations.apib | 10 ++++-- src/05-invoicing/invoices.apib | 8 ++++- src/changes-backwards-incompatible.apib | 12 +++++++ src/datastructures.apib | 6 ++-- 6 files changed, 76 insertions(+), 16 deletions(-) diff --git a/apiary.apib b/apiary.apib index 55da0bca..9089be70 100644 --- a/apiary.apib +++ b/apiary.apib @@ -863,6 +863,18 @@ 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-25 + + - 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 new return configuration options (for single and multiple select custom fields) as an array of objects. + #### 2022-09-15 - The property `remark` has been renamed to `note` on: @@ -1357,7 +1369,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] @@ -1408,7 +1423,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] @@ -2725,6 +2743,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) @@ -2736,7 +2757,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 @@ -2824,6 +2845,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) @@ -2835,7 +2859,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 @@ -3451,7 +3475,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 @@ -3559,6 +3583,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) @@ -3596,6 +3623,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) @@ -7843,7 +7873,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 @@ -7908,7 +7938,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 @@ -7981,7 +8011,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 diff --git a/src/01-general/custom-fields.apib b/src/01-general/custom-fields.apib index 336e0d01..e8be38f6 100644 --- a/src/01-general/custom-fields.apib +++ b/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) diff --git a/src/03-deals/quotations.apib b/src/03-deals/quotations.apib index 7e2224a5..203656b1 100644 --- a/src/03-deals/quotations.apib +++ b/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 diff --git a/src/05-invoicing/invoices.apib b/src/05-invoicing/invoices.apib index 41e7f5fe..319a3277 100644 --- a/src/05-invoicing/invoices.apib +++ b/src/05-invoicing/invoices.apib @@ -172,7 +172,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 @@ -280,6 +280,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) @@ -317,6 +320,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) diff --git a/src/changes-backwards-incompatible.apib b/src/changes-backwards-incompatible.apib index 870c3c6b..ce70767c 100644 --- a/src/changes-backwards-incompatible.apib +++ b/src/changes-backwards-incompatible.apib @@ -7,6 +7,18 @@ 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-25 + + - 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 new return configuration options (for single and multiple select custom fields) as an array of objects. + #### 2022-09-15 - The property `remark` has been renamed to `note` on: diff --git a/src/datastructures.apib b/src/datastructures.apib index 7cc2b903..66e72eda 100644 --- a/src/datastructures.apib +++ b/src/datastructures.apib @@ -298,7 +298,7 @@ + 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 @@ -363,7 +363,7 @@ + type: `unitOfMeasure` (string) + id: `f79d3e04-b8dc-0637-8f18-ca7c8fc63b71` (string) + unit_price (object) - + Include Money + + amount: `123.30` (number) + tax: `excluding` (enum) + Members + excluding @@ -436,7 +436,7 @@ + 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 From 31333e7a79274b7947a6ec175a02032e6dea5ece Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Tue, 26 Sep 2023 09:17:23 +0100 Subject: [PATCH 3/8] Update/fix version date --- apiary.apib | 2 +- src/changes-backwards-incompatible.apib | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 9089be70..2510c717 100644 --- a/apiary.apib +++ b/apiary.apib @@ -863,7 +863,7 @@ 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-25 +#### 2023-09-26 - When updating events through `events.update`, links to deals must also be provided otherwise existing deal link(s) will be removed. diff --git a/src/changes-backwards-incompatible.apib b/src/changes-backwards-incompatible.apib index ce70767c..a41d0f3f 100644 --- a/src/changes-backwards-incompatible.apib +++ b/src/changes-backwards-incompatible.apib @@ -7,7 +7,7 @@ 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-25 +#### 2023-09-26 - When updating events through `events.update`, links to deals must also be provided otherwise existing deal link(s) will be removed. From 7828bb3804f331c6d713d484c08407f08fbc6c8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20In=C3=A1cio?= Date: Wed, 4 Oct 2023 15:56:26 +0100 Subject: [PATCH 4/8] Update docs to reflect meetings info & list changes --- apiary.apib | 36 ++++++++++++++++--------- src/04-calendar/meetings.apib | 31 +++++++++++++-------- src/changes-backwards-incompatible.apib | 5 +++- 3 files changed, 48 insertions(+), 24 deletions(-) diff --git a/apiary.apib b/apiary.apib index 2510c717..1d26180e 100644 --- a/apiary.apib +++ b/apiary.apib @@ -873,7 +873,10 @@ As of October 1st 2023, we expect all network clients to make use of TLS 1.2 or - `quotations.create` - `quotations.update` - - `customFieldDefinitions.list` and `customFieldDefinitions.info` will new return configuration options (for single and multiple select custom fields) as an array of objects. + - `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 @@ -3177,7 +3180,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) @@ -3238,7 +3241,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) @@ -3274,15 +3277,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) diff --git a/src/04-calendar/meetings.apib b/src/04-calendar/meetings.apib index adbd6ef2..34440bb5 100644 --- a/src/04-calendar/meetings.apib +++ b/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) diff --git a/src/changes-backwards-incompatible.apib b/src/changes-backwards-incompatible.apib index a41d0f3f..32afe90c 100644 --- a/src/changes-backwards-incompatible.apib +++ b/src/changes-backwards-incompatible.apib @@ -17,7 +17,10 @@ As of October 1st 2023, we expect all network clients to make use of TLS 1.2 or - `quotations.create` - `quotations.update` - - `customFieldDefinitions.list` and `customFieldDefinitions.info` will new return configuration options (for single and multiple select custom fields) as an array of objects. + - `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 From eb78f7db9be1b815b5ebc504eedb79d5098e1c42 Mon Sep 17 00:00:00 2001 From: Tiago Bastos Date: Tue, 10 Oct 2023 11:55:16 +0100 Subject: [PATCH 5/8] reference the newest API version --- apiary.apib | 2 +- src/changes.apib | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 1d26180e..c1d3c22e 100644 --- a/apiary.apib +++ b/apiary.apib @@ -846,7 +846,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: diff --git a/src/changes.apib b/src/changes.apib index ca645b02..87c461cd 100644 --- a/src/changes.apib +++ b/src/changes.apib @@ -38,7 +38,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: From 6bc1671a47a6ee23f6a2642f45c25068da7f7b5c Mon Sep 17 00:00:00 2001 From: Tiago Bastos Date: Tue, 10 Oct 2023 17:33:26 +0100 Subject: [PATCH 6/8] chore| specify path to included payload on response --- apiary.apib | 6 +++--- src/05-invoicing/invoices.apib | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/apiary.apib b/apiary.apib index 7b489088..9ccbb2fa 100644 --- a/apiary.apib +++ b/apiary.apib @@ -3365,7 +3365,7 @@ Get a list of invoices. + (object) + field: `invoice_number` + order: `asc` - + includes: `late_fees` (string, optional) - when used, the response will include `due_incasso_inclusive`, `fixed_late_fee` and `interest` + + 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) @@ -3432,13 +3432,13 @@ Get a list of invoices. ### invoices.info [POST /invoices.info] -Get details for a single invoice. +Get details for a single invoice.xcvxcvxcvxcvxcvxcv iensrionerst + Request (application/json) + Attributes (object) + id: `27300f09-6250-4a23-8557-d84c52f99ecf` (string) - + includes: `late_fees` (string, optional) - when used, the response will include `due_incasso_inclusive`, `fixed_late_fee` and `interest` + + 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) diff --git a/src/05-invoicing/invoices.apib b/src/05-invoicing/invoices.apib index d8e0103f..0c3e9d61 100644 --- a/src/05-invoicing/invoices.apib +++ b/src/05-invoicing/invoices.apib @@ -49,7 +49,7 @@ Get a list of invoices. + (object) + field: `invoice_number` + order: `asc` - + includes: `late_fees` (string, optional) - when used, the response will include `due_incasso_inclusive`, `fixed_late_fee` and `interest` + + 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) @@ -116,13 +116,13 @@ Get a list of invoices. ### invoices.info [POST /invoices.info] -Get details for a single invoice. +Get details for a single invoice.xcvxcvxcvxcvxcvxcv iensrionerst + Request (application/json) + Attributes (object) + id: `27300f09-6250-4a23-8557-d84c52f99ecf` (string) - + includes: `late_fees` (string, optional) - when used, the response will include `due_incasso_inclusive`, `fixed_late_fee` and `interest` + + 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) From 819f8aa88af4be75e0383e61bb7bfa2138b897ea Mon Sep 17 00:00:00 2001 From: Tiago Bastos Date: Wed, 11 Oct 2023 10:43:47 +0100 Subject: [PATCH 7/8] fix| remove unintended gibberish --- apiary.apib | 2 +- src/05-invoicing/invoices.apib | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index 9ccbb2fa..e6a05120 100644 --- a/apiary.apib +++ b/apiary.apib @@ -3432,7 +3432,7 @@ Get a list of invoices. ### invoices.info [POST /invoices.info] -Get details for a single invoice.xcvxcvxcvxcvxcvxcv iensrionerst +Get details for a single invoice. + Request (application/json) diff --git a/src/05-invoicing/invoices.apib b/src/05-invoicing/invoices.apib index 0c3e9d61..c7d0e93b 100644 --- a/src/05-invoicing/invoices.apib +++ b/src/05-invoicing/invoices.apib @@ -116,7 +116,7 @@ Get a list of invoices. ### invoices.info [POST /invoices.info] -Get details for a single invoice.xcvxcvxcvxcvxcvxcv iensrionerst +Get details for a single invoice. + Request (application/json) From 62936857daeae191e30c2e356f4be3b72488b8f2 Mon Sep 17 00:00:00 2001 From: Tiago Bastos Date: Thu, 12 Oct 2023 16:28:19 +0100 Subject: [PATCH 8/8] chore| correct release month --- apiary.apib | 4 +++- src/changes-backwards-compatible.apib | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/apiary.apib b/apiary.apib index e6a05120..a8ade2ec 100644 --- a/apiary.apib +++ b/apiary.apib @@ -426,11 +426,13 @@ 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`. + ### 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 `late_fees` to `invoices.info` and `invoices.list`. ### August 2023 - We added `quotation` as a type for `cloudPlatforms.url`. diff --git a/src/changes-backwards-compatible.apib b/src/changes-backwards-compatible.apib index 417ea139..c3ffa344 100644 --- a/src/changes-backwards-compatible.apib +++ b/src/changes-backwards-compatible.apib @@ -4,11 +4,13 @@ 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`. + ### 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 `late_fees` to `invoices.info` and `invoices.list`. ### August 2023 - We added `quotation` as a type for `cloudPlatforms.url`.