> For the complete documentation index, see [llms.txt](https://teamleader-sdk.mcore-services.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://teamleader-sdk.mcore-services.dev/project/upgrading.md).

# Upgrading

## From 2.2 to 2.3

There are no breaking API changes in the SDK itself, and 2.3 runs on the same PHP and Laravel versions. What does change across 2.2.4 – 2.3.0 is that requests which used to be silently wrong now throw.

**Silent no-ops now throw `InvalidArgumentException`.** An unsupported filter, sort field, include, option or body field used to be passed to the API — which ignored it — or dropped by the SDK. Either way the call returned unfiltered data, or an update changed nothing. Now it throws, naming the accepted values.

If upgrading surfaces one of these, the call was not doing what it appeared to. Fix the name rather than catching the exception; the resource's [reference page](/api-reference/reference.md) lists what it accepts.

The most common cases:

| Before                                           | Instead                                                 |
| ------------------------------------------------ | ------------------------------------------------------- |
| `companies()->list(['name' => ...])`             | `['term' => ...]` — searches name, VAT, email and phone |
| `timeTracking()->list(['updated_since' => ...])` | `started_after` / `ended_after`                         |
| `companies()->info($id, 'custom_fields')`        | nothing — custom fields are always returned on `info`   |
| `contacts()->with(...)->info($id)`               | nothing — `contacts.info` takes no includes             |
| A sort on a field the endpoint does not sort by  | a field from the resource's **Sorting** section         |

**Stricter-than-API checks were relaxed** at the same time, where the SDK demanded fields the API does not — meeting customers, timer subjects, expense totals, task work types on update. Code that worked around those can be simplified.

The full list, release by release, is in the [changelog](https://github.com/MCore-Services-bv/teamleader-sdk/blob/main/CHANGELOG.md).

## Deprecated — removed in v3.0

These are still present in 2.3. Where a method used to return wrong results it now throws or has become a no-op, so it cannot mislead; the rest work as before, some with an `E_USER_DEPRECATED` notice once per process.

| Deprecated                                                                                                                                    | In 2.3                                                              | Use instead                                                            |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `users()->getWeekSchedule()`                                                                                                                  | works, with a notice                                                | `userSchedules()->forUser()`                                           |
| `plannableItems()->active()`                                                                                                                  | lists everything, with a notice — the endpoint has no status filter | `list()`, filtering on `completion_statuses` / `planned_time_statuses` |
| `invoices()->draft()`                                                                                                                         | works                                                               | `listDrafts()`                                                         |
| `lostReasons()->search()`                                                                                                                     | works — it fetches by id, despite the name                          | `byIds()`                                                              |
| `companies()->byName()`                                                                                                                       | throws — `companies.list` has no name filter                        | `search()` / the `term` filter                                         |
| `quotations()->byStatus()`                                                                                                                    | throws — `quotations.list` has no status filter                     | `list()`, filtered client-side                                         |
| `creditNotes()->paid()`, `unpaid()`                                                                                                           | throw — `creditNotes.list` has no payment filter                    | `list()`, filtered client-side                                         |
| `products()->withCustomFields()`                                                                                                              | no-op — `info()` always returns custom fields                       | nothing                                                                |
| `deals()->withCustomer()`, `withResponsibleUser()`, `withDepartment()`, `withCurrentPhase()`, `withSource()`, `withAll()`                     | no-ops — the data is returned by default                            | nothing                                                                |
| `calenderEvents()`, `creditnotes()`, `payment_methods()`, `payment_terms()`, `external_parties()`, `plannable_items()`, `user_availability()` | work, with a notice                                                 | the camelCase names                                                    |

Deprecated methods are marked on their reference page.

## From 1.x to 2.0

2.0 dropped Laravel 10 and 11, which are end of life with unpatched security advisories. On Laravel 12 no changes are needed. On Laravel 10 or 11, upgrade Laravel, or pin the SDK to `^1.2` until you can.