-
Notifications
You must be signed in to change notification settings - Fork 172
/
Copy pathchanges-backwards-incompatible.apib
138 lines (98 loc) · 6.05 KB
/
changes-backwards-incompatible.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<a name="changelog"></a>
### Changelog
We list all backwards-incompatible changes here. As described above, new additions and forwards-compatible changes don’t need a new API version and can be found [here](#additions).
#### 2023-10-01
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.
- `unit_price.currency` is no longer returned for line items on the response of `invoices.info`, `subscriptions.info`, `quotations.info` and `creditNotes.info`.
- `unit_price.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:
- `subscriptions.info`
- `subscriptions.list`
- The property `periodicity` has been replaced by `billing_cycle` on:
- `subscriptions.info`
- `subscriptions.list`
- The property `tags` will no longer be converted to lowercase on:
- `companies.list`
- `companies.info`
- `contacts.list`
- `contacts.info`
- The property `tag` will no longer be converted to lowercase on:
- `tags.list`
#### 2021-09-01
- The property `description` is now returned in Markdown instead of HTML on:
- `products.info`
- `products.list`
#### 2020-05-01
- The property `title` is added to the response of:
- `tasks.list`
- `tasks.info`
- The property `title` is added and required on:
- `tasks.create`
- `tasks.update`
- The property `description` is no longer required on:
- `tasks.create`
- `tasks.update`
#### 2020-01-01
- The property `assignee` is now returned as null instead of `assignee.id` being returned as null on:
- `tasks.list`
- `tasks.info`
- The property `assignee` is now accepting null instead of `assignee.id` on:
- `tasks.create`
- `tasks.update`
#### 2019-10-09
- We added `billing_method` and `budget`, and `billing_method` and `price` to `milestones.create`.
- When choosing `time_and_materials` or `non_invoiceable` as the billing method, you can provide a `budget`.
- When choosing `fixed_price` as the billing method, you need to provide the `price`.
#### 2019-07-03
- The property `todo` has been renamed to `task` on the following endpoints:
- `events.list`
- `events.info`
- We renamed the `context` field for work orders on customFieldDefinitions from `werkbonnen` to `work_orders`
- The property `due_at` was removed in favour of `due_on`. Additionally, `due_on` is a date with format `YYYY-MM-DD`, instead of a ISO8601 datetime. These changes affect the following endpoints:
- `tasks.info`
- `tasks.list`
- `tasks.create`
- `tasks.update`
- We won't accept `project` as a `subject` anymore in `timeTracking.add`, `timeTracking.update`, `timers.start` and `timers.update`.
We wrongly accepted this in the past, but time tracking always needs to be coupled to a milestone. Please use the `milestone` subject instead.
For older versions, we will link the time tracked to the oldest `open` milestone. If there is no `open` milestone, it's linked to the most recent `closed` or `done` milestone.
#### 2019-03-13
- The property `tax` has been changed. Instead of giving you the `rate` of the tax it now shows the `id` and the `type` of the tax. This has been changed on the following endpoints:
- `invoices.info`
- `creditNote.info`
- `quotations.info`
- We simplified the `products.info` and `products.list` endpoints:
- `name` and `description` are no longer wrapped in a `translations` object.
- `external_id` was renamed to `code`
- `prices` are temporarily no longer returned, to avoid confusion, as they didn't take into account price lists
#### 2019-01-24
- Previously, the `invoices.info` endpoint returned an _non-existing_ or _empty_ `extended_description` as an empty string, while `invoices.draft` and `invoices.update` didn't allow an empty string as `extended_description`.
From now on, `invoices.info` will return an _non-existing_ or _empty_ `extended_description` as `null`, to make this more consistent and interchangeable.
- Invoices can now have three statuses (`draft`, `outstanding` or `matched`) instead of two (`draft` or `booked`).
Therefore the `status` property in `invoices.list` and `invoices.info` will either return `outstanding` or `matched` for invoices that were previously just `booked`.
This is also reflected in the `status` filter on `invoices.list`: to allow you to still query all `outstanding` and `matched` invoices (previously all `booked`) , it now *only* accepts an array of filter values (eg. `["outstanding", "matched"]` or `["draft"]`).
- The property `local_business_number` was renamed to `national_identification_number` on the following endpoints:
- `companies.info`
- `companies.list`
- `companies.add`
- `companies.update`
- `invoices.info`
- `creditNotes.info`
- An invoice number actually contains the bookyear, so from now on, you will see eg. `2018 / 27` instead of `27`.
This is reflected in the `invoice_number` property in the `invoices.list` and `invoices.info` endpoints.
#### 2018-10-30
- The top-level property `customer` was removed on all deal endpoints.
Earlier, this property could already be found under the `lead.customer` property.
If you were still using the `customer` property, just wrap it in an object under a `lead` key.
- The `contacts.list` & `companies.list` endpoints used to give back an object under the `address` key.
This object is now returned under the `primary_address` key.