@teamleader/focus-api-specification 1.183.0 → 1.184.0

package/dist/api.focus.teamleader.eu.dereferenced.yaml

@@ -3,7 +3,7 @@ info:
   title: Teamleader API
   description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
   contact: {}
-  version: 1.183.0
+  version: 1.184.0
 servers:
   - url: https://api.focus.teamleader.eu
     variables: {}
@@ -3579,7 +3579,7 @@ paths:
                     includes:
                       type: string
                       description: Comma-separated list of optional includes
-                      example: custom_fields,price_list
+                      example: custom_fields
                 - example:
                     filter:
                       email:
@@ -3600,7 +3600,7 @@ paths:
                       number: 1
                     sort:
                       - field: added_at
-                    includes: custom_fields,price_list
+                    includes: custom_fields
             example:
               filter:
                 email:
@@ -3622,7 +3622,7 @@ paths:
                 number: 1
               sort:
                 - field: added_at
-              includes: custom_fields,price_list
+              includes: custom_fields
         required: false
       responses:
         '200':
@@ -3808,6 +3808,7 @@ paths:
                               description: Only included with request parameter `includes=custom_fields`
                             price_list:
                               type: object
+                              nullable: true
                               properties:
                                 type:
                                   type: string
@@ -3815,7 +3816,7 @@ paths:
                                 id:
                                   type: string
                                   example: 27261187-19c9-081f-b833-021fa5873129
-                              description: Only included with request parameter `includes=price_list`
+                              description: Only included when the account has access to price lists. `null` when no price list is set on the contact.
                         description: ''
                   - example:
                       data:
@@ -4420,6 +4421,9 @@ paths:
                     marketing_mails_consent:
                       type: boolean
                       example: false
+                    price_list_id:
+                      type: string
+                      example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
                 - example:
                     first_name: John
                     last_name: Smith
@@ -4454,6 +4458,7 @@ paths:
                       - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                         value: '092980616'
                     marketing_mails_consent: false
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               first_name: John
               last_name: Smith
@@ -4488,6 +4493,7 @@ paths:
                 - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                   value: '092980616'
               marketing_mails_consent: false
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '201':
@@ -4643,6 +4649,11 @@ paths:
                     marketing_mails_consent:
                       type: boolean
                       example: false
+                    price_list_id:
+                      type: string
+                      description: Pass `null` to remove the price list from the contact
+                      nullable: true
+                      example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
                 - example:
                     id: 76c9d03c-ec5c-4b21-9fc6-7ffee488b12d
                     first_name: John
@@ -4678,6 +4689,7 @@ paths:
                       - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                         value: '092980616'
                     marketing_mails_consent: false
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               id: 76c9d03c-ec5c-4b21-9fc6-7ffee488b12d
               first_name: John
@@ -4713,6 +4725,7 @@ paths:
                 - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                   value: '092980616'
               marketing_mails_consent: false
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '204':
@@ -5110,7 +5123,7 @@ paths:
                     includes:
                       type: string
                       description: Comma-separated list of optional includes
-                      example: custom_fields,price_list
+                      example: custom_fields
                 - example:
                     filter:
                       email:
@@ -5132,7 +5145,7 @@ paths:
                       number: 1
                     sort:
                       - field: name
-                    includes: custom_fields,price_list
+                    includes: custom_fields
             example:
               filter:
                 email:
@@ -5155,7 +5168,7 @@ paths:
                 number: 1
               sort:
                 - field: name
-              includes: custom_fields,price_list
+              includes: custom_fields
         required: false
       responses:
         '200':
@@ -5296,6 +5309,7 @@ paths:
                               description: Only included with request parameter `includes=custom_fields`
                             price_list:
                               type: object
+                              nullable: true
                               properties:
                                 type:
                                   type: string
@@ -5303,7 +5317,7 @@ paths:
                                 id:
                                   type: string
                                   example: 27261187-19c9-081f-b833-021fa5873129
-                              description: Only included with request parameter `includes=price_list`
+                              description: Only included when the account has access to price lists. `null` when no price list is set on the company.
                         description: ''
                   - example:
                       data:
@@ -5847,6 +5861,9 @@ paths:
                           type: string
                         - example: EUR
                           type: string
+                    price_list_id:
+                      type: string
+                      example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
                 - example:
                     name: Pied Piper
                     business_type_id: fd48d4a3-b9dc-4eac-8071-5889c9f21e5d
@@ -5881,6 +5898,7 @@ paths:
                         value: '092980616'
                     marketing_mails_consent: false
                     preferred_currency: EUR
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               name: Pied Piper
               business_type_id: fd48d4a3-b9dc-4eac-8071-5889c9f21e5d
@@ -5915,6 +5933,7 @@ paths:
                   value: '092980616'
               marketing_mails_consent: false
               preferred_currency: EUR
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '201':
@@ -6063,6 +6082,9 @@ paths:
                         - example: EUR
                           nullable: true
                           type: string
+                    price_list_id:
+                      type: string
+                      example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
                 - example:
                     id: 4784189d-610b-4488-b3a5-5f324f752417
                     name: Pied Piper
@@ -6098,6 +6120,7 @@ paths:
                         value: '092980616'
                     marketing_mails_consent: false
                     preferred_currency: EUR
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               id: 4784189d-610b-4488-b3a5-5f324f752417
               name: Pied Piper
@@ -6133,6 +6156,7 @@ paths:
                   value: '092980616'
               marketing_mails_consent: false
               preferred_currency: EUR
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '204':
@@ -16117,6 +16141,9 @@ paths:
                         items:
                           type: object
                           properties:
+                            id:
+                              type: string
+                              example: f8f95182-3947-0a4a-b426-3adaa66fc32a
                             name:
                               type: string
                               example: My holiday discount
@@ -16127,13 +16154,15 @@ paths:
                         description: ''
                   - example:
                       data:
-                        - name: My holiday discount
+                        - id: f8f95182-3947-0a4a-b426-3adaa66fc32a
+                          name: My holiday discount
                           department:
                             type: department
                             id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
               example:
                 data:
-                  - name: My holiday discount
+                  - id: f8f95182-3947-0a4a-b426-3adaa66fc32a
+                    name: My holiday discount
                     department:
                       type: department
                       id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87

package/dist/api.focus.teamleader.eu.yaml

@@ -3,7 +3,7 @@ info:
   title: Teamleader API
   description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
   contact: {}
-  version: 1.183.0
+  version: 1.184.0
 servers:
   - url: https://api.focus.teamleader.eu
     variables: {}
@@ -1904,7 +1904,7 @@ paths:
                       number: 1
                     sort:
                       - field: added_at
-                    includes: custom_fields,price_list
+                    includes: custom_fields
             example:
               filter:
                 email:
@@ -1926,7 +1926,7 @@ paths:
                 number: 1
               sort:
                 - field: added_at
-              includes: custom_fields,price_list
+              includes: custom_fields
         required: false
       responses:
         '200':
@@ -2225,6 +2225,7 @@ paths:
                       - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                         value: '092980616'
                     marketing_mails_consent: false
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               first_name: John
               last_name: Smith
@@ -2259,6 +2260,7 @@ paths:
                 - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                   value: '092980616'
               marketing_mails_consent: false
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '201':
@@ -2328,6 +2330,7 @@ paths:
                       - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                         value: '092980616'
                     marketing_mails_consent: false
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               id: 76c9d03c-ec5c-4b21-9fc6-7ffee488b12d
               first_name: John
@@ -2363,6 +2366,7 @@ paths:
                 - id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
                   value: '092980616'
               marketing_mails_consent: false
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '204':
@@ -2616,7 +2620,7 @@ paths:
                       number: 1
                     sort:
                       - field: name
-                    includes: custom_fields,price_list
+                    includes: custom_fields
             example:
               filter:
                 email:
@@ -2639,7 +2643,7 @@ paths:
                 number: 1
               sort:
                 - field: name
-              includes: custom_fields,price_list
+              includes: custom_fields
         required: false
       responses:
         '200':
@@ -2958,6 +2962,7 @@ paths:
                         value: '092980616'
                     marketing_mails_consent: false
                     preferred_currency: EUR
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               name: Pied Piper
               business_type_id: fd48d4a3-b9dc-4eac-8071-5889c9f21e5d
@@ -2992,6 +2997,7 @@ paths:
                   value: '092980616'
               marketing_mails_consent: false
               preferred_currency: EUR
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '201':
@@ -3061,6 +3067,7 @@ paths:
                         value: '092980616'
                     marketing_mails_consent: false
                     preferred_currency: EUR
+                    price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
             example:
               id: 4784189d-610b-4488-b3a5-5f324f752417
               name: Pied Piper
@@ -3096,6 +3103,7 @@ paths:
                   value: '092980616'
               marketing_mails_consent: false
               preferred_currency: EUR
+              price_list_id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
         required: true
       responses:
         '204':
@@ -7625,13 +7633,15 @@ paths:
                   - $ref: '#/components/schemas/commercialDiscounts.list.response'
                   - example:
                       data:
-                        - name: My holiday discount
+                        - id: f8f95182-3947-0a4a-b426-3adaa66fc32a
+                          name: My holiday discount
                           department:
                             type: department
                             id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
               example:
                 data:
-                  - name: My holiday discount
+                  - id: f8f95182-3947-0a4a-b426-3adaa66fc32a
+                    name: My holiday discount
                     department:
                       type: department
                       id: 6a6343fc-fdd8-4bc0-aa69-3a004c710e87
@@ -18702,7 +18712,7 @@ components:
         includes:
           type: string
           description: Comma-separated list of optional includes
-          example: custom_fields,price_list
+          example: custom_fields
     Gender:
       title: Gender
       type: string
@@ -18880,6 +18890,7 @@ components:
                 description: Only included with request parameter `includes=custom_fields`
               price_list:
                 type: object
+                nullable: true
                 properties:
                   type:
                     type: string
@@ -18887,7 +18898,7 @@ components:
                   id:
                     type: string
                     example: 27261187-19c9-081f-b833-021fa5873129
-                description: Only included with request parameter `includes=price_list`
+                description: Only included when the account has access to price lists. `null` when no price list is set on the contact.
           description: ''
     contacts.info.request:
       title: contacts.info.request
@@ -19226,6 +19237,9 @@ components:
         marketing_mails_consent:
           type: boolean
           example: false
+        price_list_id:
+          type: string
+          example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
     contacts.add.response:
       title: contacts.add.response
       type: object
@@ -19338,6 +19352,11 @@ components:
         marketing_mails_consent:
           type: boolean
           example: false
+        price_list_id:
+          type: string
+          description: Pass `null` to remove the price list from the contact
+          nullable: true
+          example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
     contacts.delete.request:
       title: contacts.delete.request
       required:
@@ -19512,7 +19531,7 @@ components:
         includes:
           type: string
           description: Comma-separated list of optional includes
-          example: custom_fields,price_list
+          example: custom_fields
     CompanyTelephone:
       title: CompanyTelephone
       required:
@@ -19633,6 +19652,7 @@ components:
                 description: Only included with request parameter `includes=custom_fields`
               price_list:
                 type: object
+                nullable: true
                 properties:
                   type:
                     type: string
@@ -19640,7 +19660,7 @@ components:
                   id:
                     type: string
                     example: 27261187-19c9-081f-b833-021fa5873129
-                description: Only included with request parameter `includes=price_list`
+                description: Only included when the account has access to price lists. `null` when no price list is set on the company.
           description: ''
     companies.info.request:
       title: companies.info.request
@@ -19888,6 +19908,9 @@ components:
             - $ref: '#/components/schemas/CurrencyCode'
             - example: EUR
               type: string
+        price_list_id:
+          type: string
+          example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
     companies.add.response:
       title: companies.add.response
       type: object
@@ -19993,6 +20016,9 @@ components:
             - example: EUR
               nullable: true
               type: string
+        price_list_id:
+          type: string
+          example: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
     companies.uploadLogo.request:
       title: companies.uploadLogo.request
       required:
@@ -25089,6 +25115,9 @@ components:
           items:
             type: object
             properties:
+              id:
+                type: string
+                example: f8f95182-3947-0a4a-b426-3adaa66fc32a
               name:
                 type: string
                 example: My holiday discount

package/dist/changelog/20260721000000.md

@@ -0,0 +1,5 @@
+---
+category: addition
+---
+
+We added the `id` field to the `commercialDiscounts.list` endpoint response.

package/dist/changelog/20260728000000.md

@@ -0,0 +1,7 @@
+---
+category: addition
+---
+
+We documented `price_list_id` on `contacts.add`, `contacts.update`, `companies.add` and `companies.update`. Pass it to link a customer to a price list. On `contacts.update` you can pass `null` to remove the price list from the contact.
+
+We also corrected the documentation of `price_list` on `contacts.list` and `companies.list`: it is returned whenever your account has access to price lists, and is not requested through the `includes` parameter.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@teamleader/focus-api-specification",
   "description": "Teamleader Focus API Specification",
-  "version": "1.183.0",
+  "version": "1.184.0",
   "author": "Teamleader <development@teamleader.eu> (https://www.teamleader.eu)",
   "bugs": {
     "url": "https://github.com/teamleadercrm/focus-api-specification/issues"