> 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/api-reference/reference.md).

# All resources

One page per resource, generated from the SDK source. Each page lists the facade method, the API endpoints the resource calls, the filters, sort fields and includes it accepts, the constants that hold its accepted values, and every public method.

Filters, sort fields, includes and body fields are checked against `@teamleader/focus-api-specification` **1.221.0** — see [Specification parity](/project/specification-parity.md). Anything not listed on a page throws an `InvalidArgumentException` before a request is sent.

## CRM

| Resource                                               | Facade            | Create | Update | Delete | Filter | Sort | Includes |
| ------------------------------------------------------ | ----------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Addresses](/api-reference/crm/addresses.md)           | `addresses()`     |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Business Types](/api-reference/crm/business-types.md) | `businessTypes()` |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Companies](/api-reference/crm/companies.md)           | `companies()`     |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |
| [Contacts](/api-reference/crm/contacts.md)             | `contacts()`      |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |
| [Tags](/api-reference/crm/tags.md)                     | `tags()`          |    —   |    —   |    —   |    —   |   ✓  |     —    |

## Deals

| Resource                                                 | Facade            | Create | Update | Delete | Filter | Sort | Includes |
| -------------------------------------------------------- | ----------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Deal Phases](/api-reference/deals/deal-phases.md)       | `dealPhases()`    |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Deal Pipelines](/api-reference/deals/deal-pipelines.md) | `dealPipelines()` |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Deal Sources](/api-reference/deals/deal-sources.md)     | `dealSources()`   |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Deals](/api-reference/deals/deals.md)                   | `deals()`         |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |
| [Lost Reasons](/api-reference/deals/lost-reasons.md)     | `lostReasons()`   |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Orders](/api-reference/deals/orders.md)                 | `orders()`        |    —   |    —   |    —   |    ✓   |   —  |     ✓    |
| [Quotations](/api-reference/deals/quotations.md)         | `quotations()`    |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     ✓    |

## Invoicing

| Resource                                                                   | Facade                  | Create | Update | Delete | Filter | Sort | Includes |
| -------------------------------------------------------------------------- | ----------------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Commercial Discounts](/api-reference/invoicing/commercial-discounts.md)   | `commercialDiscounts()` |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Credit Notes](/api-reference/invoicing/credit-notes.md)                   | `creditNotes()`         |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Invoices](/api-reference/invoicing/invoices.md)                           | `invoices()`            |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |
| [Payment Methods](/api-reference/invoicing/payment-methods.md)             | `paymentMethods()`      |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Payment Terms](/api-reference/invoicing/payment-terms.md)                 | `paymentTerms()`        |    —   |    —   |    —   |    —   |   —  |     —    |
| [Subscriptions](/api-reference/invoicing/subscriptions.md)                 | `subscriptions()`       |    ✓   |    ✓   |    —   |    ✓   |   ✓  |     —    |
| [Tax Rates](/api-reference/invoicing/tax-rates.md)                         | `taxRates()`            |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Withholding Tax Rates](/api-reference/invoicing/withholding-tax-rates.md) | `withholdingTaxRates()` |    —   |    —   |    —   |    ✓   |   —  |     —    |

## Expenses

| Resource                                                                      | Facade                     | Create | Update | Delete | Filter | Sort | Includes |
| ----------------------------------------------------------------------------- | -------------------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Bookkeeping Submissions](/api-reference/expenses/bookkeeping-submissions.md) | `bookkeepingSubmissions()` |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Expenses](/api-reference/expenses/expenses.md)                               | `expenses()`               |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Incoming Credit Notes](/api-reference/expenses/incoming-credit-notes.md)     | `incomingCreditNotes()`    |    ✓   |    ✓   |    ✓   |    —   |   —  |     —    |
| [Incoming Invoices](/api-reference/expenses/incoming-invoices.md)             | `incomingInvoices()`       |    ✓   |    ✓   |    ✓   |    —   |   —  |     —    |
| [Receipts](/api-reference/expenses/receipts.md)                               | `receipts()`               |    ✓   |    ✓   |    ✓   |    —   |   —  |     —    |

## Products

| Resource                                                            | Facade                | Create | Update | Delete | Filter | Sort | Includes |
| ------------------------------------------------------------------- | --------------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Price Lists](/api-reference/products/price-lists.md)               | `priceLists()`        |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Product Categories](/api-reference/products/product-categories.md) | `productCategories()` |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Products](/api-reference/products/products.md)                     | `products()`          |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     ✓    |
| [Units of Measure](/api-reference/products/units-of-measure.md)     | `unitsOfMeasure()`    |    —   |    —   |    —   |    —   |   —  |     —    |

## Projects

| Resource                                                          | Facade               | Create | Update | Delete | Filter | Sort | Includes |
| ----------------------------------------------------------------- | -------------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [External Parties](/api-reference/projects/external-parties.md)   | `externalParties()`  |    —   |    —   |    —   |    —   |   —  |     —    |
| [Groups](/api-reference/projects/groups.md)                       | `groups()`           |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Legacy Milestones](/api-reference/projects/legacy-milestones.md) | `legacyMilestones()` |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     —    |
| [Legacy Projects](/api-reference/projects/legacy-projects.md)     | `legacyProjects()`   |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     —    |
| [Materials](/api-reference/projects/materials.md)                 | `materials()`        |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Project Lines](/api-reference/projects/project-lines.md)         | `projectLines()`     |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Project Tasks](/api-reference/projects/project-tasks.md)         | `projectTasks()`     |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Projects](/api-reference/projects/projects.md)                   | `projects()`         |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |

## Tasks

| Resource                               | Facade    | Create | Update | Delete | Filter | Sort | Includes |
| -------------------------------------- | --------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Tasks](/api-reference/tasks/tasks.md) | `tasks()` |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     —    |

## Time Tracking

| Resource                                                       | Facade           | Create | Update | Delete | Filter | Sort | Includes |
| -------------------------------------------------------------- | ---------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Time Tracking](/api-reference/time-tracking/time-tracking.md) | `timeTracking()` |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |
| [Timers](/api-reference/time-tracking/timers.md)               | `timers()`       |    ✓   |    ✓   |    —   |    —   |   —  |     —    |

## Planning

| Resource                                                          | Facade               | Create | Update | Delete | Filter | Sort | Includes |
| ----------------------------------------------------------------- | -------------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Plannable Items](/api-reference/planning/plannable-items.md)     | `plannableItems()`   |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Reservations](/api-reference/planning/reservations.md)           | `reservations()`     |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [User Availability](/api-reference/planning/user-availability.md) | `userAvailability()` |    —   |    —   |    —   |    ✓   |   —  |     —    |

## Calendar

| Resource                                                      | Facade             | Create | Update | Delete | Filter | Sort | Includes |
| ------------------------------------------------------------- | ------------------ | :----: | :----: | :----: | :----: | :--: | :------: |
| [Activity Types](/api-reference/calendar/activity-types.md)   | `activityTypes()`  |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Calendar Events](/api-reference/calendar/calendar-events.md) | `calendarEvents()` |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     —    |
| [Call Outcomes](/api-reference/calendar/call-outcomes.md)     | `callOutcomes()`   |    —   |    —   |    —   |    —   |   —  |     —    |
| [Calls](/api-reference/calendar/calls.md)                     | `calls()`          |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Meetings](/api-reference/calendar/meetings.md)               | `meetings()`       |    ✓   |    ✓   |    ✓   |    ✓   |   ✓  |     ✓    |

## Tickets

| Resource                                                 | Facade           | Create | Update | Delete | Filter | Sort | Includes |
| -------------------------------------------------------- | ---------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Ticket Status](/api-reference/tickets/ticket-status.md) | `ticketStatus()` |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Tickets](/api-reference/tickets/tickets.md)             | `tickets()`      |    ✓   |    ✓   |    —   |    ✓   |   —  |     —    |

## General

| Resource                                                           | Facade                | Create | Update | Delete | Filter | Sort | Includes |
| ------------------------------------------------------------------ | --------------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Closing Days](/api-reference/general/closing-days.md)             | `closingDays()`       |    ✓   |    —   |    ✓   |    ✓   |   —  |     —    |
| [Currencies](/api-reference/general/currencies.md)                 | `currencies()`        |    —   |    —   |    —   |    —   |   —  |     —    |
| [Custom Fields](/api-reference/general/custom-fields.md)           | `customFields()`      |    ✓   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Day Off Types](/api-reference/general/day-off-types.md)           | `dayOffTypes()`       |    ✓   |    ✓   |    ✓   |    —   |   —  |     —    |
| [Days Off](/api-reference/general/days-off.md)                     | `daysOff()`           |    —   |    —   |    —   |    —   |   —  |     —    |
| [Departments](/api-reference/general/departments.md)               | `departments()`       |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [Document Templates](/api-reference/general/document-templates.md) | `documentTemplates()` |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Email Tracking](/api-reference/general/email-tracking.md)         | `emailTracking()`     |    ✓   |    —   |    —   |    ✓   |   —  |     —    |
| [Notes](/api-reference/general/notes.md)                           | `notes()`             |    ✓   |    ✓   |    ✓   |    ✓   |   —  |     —    |
| [Teams](/api-reference/general/teams.md)                           | `teams()`             |    —   |    —   |    —   |    ✓   |   ✓  |     —    |
| [User Schedules](/api-reference/general/user-schedules.md)         | `userSchedules()`     |    —   |    —   |    —   |    ✓   |   —  |     —    |
| [Users](/api-reference/general/users.md)                           | `users()`             |    —   |    —   |    —   |    ✓   |   ✓  |     ✓    |
| [Work Types](/api-reference/general/work-types.md)                 | `workTypes()`         |    —   |    —   |    —   |    ✓   |   —  |     —    |

## Files

| Resource                               | Facade    | Create | Update | Delete | Filter | Sort | Includes |
| -------------------------------------- | --------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Files](/api-reference/files/files.md) | `files()` |    ✓   |    —   |    ✓   |    ✓   |   ✓  |     —    |

## Templates

| Resource                                                     | Facade            | Create | Update | Delete | Filter | Sort | Includes |
| ------------------------------------------------------------ | ----------------- | :----: | :----: | :----: | :----: | :--: | :------: |
| [Mail Templates](/api-reference/templates/mail-templates.md) | `mailTemplates()` |    —   |    —   |    —   |    ✓   |   —  |     —    |

## Other

| Resource                                                   | Facade             | Create | Update | Delete | Filter | Sort | Includes |
| ---------------------------------------------------------- | ------------------ | :----: | :----: | :----: | :----: | :--: | :------: |
| [Accounts](/api-reference/other/accounts.md)               | `accounts()`       |    —   |    —   |    —   |    —   |   —  |     —    |
| [Cloud Platforms](/api-reference/other/cloud-platforms.md) | `cloudPlatforms()` |    —   |    —   |    —   |    —   |   —  |     —    |
| [Migrate](/api-reference/other/migrate.md)                 | `migrate()`        |    —   |    —   |    —   |    —   |   —  |     —    |
| [Webhooks](/api-reference/other/webhooks.md)               | `webhooks()`       |    —   |    —   |    —   |    —   |   —  |     —    |

## Includes

Every resource that accepts sideloaded includes. No other resource takes any; see [Sideloading](/guides/sideloading.md).

| Resource                                                       | `list()`                                                                                | `info()`                                                                                |
| -------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| [Companies](/api-reference/crm/companies.md)                   | `custom_fields`                                                                         | `related_companies`, `related_contacts`                                                 |
| [Contacts](/api-reference/crm/contacts.md)                     | `custom_fields`                                                                         | —                                                                                       |
| [Deals](/api-reference/deals/deals.md)                         | `custom_fields`, `second_responsible_user`                                              | `second_responsible_user`                                                               |
| [Orders](/api-reference/deals/orders.md)                       | `custom_fields`                                                                         | `custom_fields`                                                                         |
| [Quotations](/api-reference/deals/quotations.md)               | `expiry`                                                                                | `expiry`                                                                                |
| [Invoices](/api-reference/invoicing/invoices.md)               | `late_fees`, `totals.due_incasso_inclusive`, `totals.fixed_late_fee`, `totals.interest` | `late_fees`, `totals.due_incasso_inclusive`, `totals.fixed_late_fee`, `totals.interest` |
| [Products](/api-reference/products/products.md)                | —                                                                                       | `suppliers`                                                                             |
| [Projects](/api-reference/projects/projects.md)                | `custom_fields`, `legacy_project`                                                       | `legacy_project`                                                                        |
| [Time Tracking](/api-reference/time-tracking/time-tracking.md) | `materials`, `relates_to`                                                               | `materials`, `relates_to`                                                               |
| [Meetings](/api-reference/calendar/meetings.md)                | `estimated_time`, `tracked_time`                                                        | `estimated_time`, `tracked_time`                                                        |
| [Users](/api-reference/general/users.md)                       | —                                                                                       | `external_rate`                                                                         |

## Deprecated resource keys

These keys still resolve, with an `E_USER_DEPRECATED` notice, and are removed in v3.0.

| Deprecated            | Use                  |
| --------------------- | -------------------- |
| `calenderEvents()`    | `calendarEvents()`   |
| `creditnotes()`       | `creditNotes()`      |
| `external_parties()`  | `externalParties()`  |
| `payment_methods()`   | `paymentMethods()`   |
| `payment_terms()`     | `paymentTerms()`     |
| `plannable_items()`   | `plannableItems()`   |
| `user_availability()` | `userAvailability()` |
