@teamleader/focus-api-specification 1.212.0 → 1.214.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,7 @@ info:
3
3
  title: Teamleader API
4
4
  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).
5
5
  contact: {}
6
- version: 1.212.0
6
+ version: 1.214.0
7
7
  servers:
8
8
  - url: https://api.focus.teamleader.eu
9
9
  variables: {}
@@ -200,8 +200,8 @@ tags:
200
200
  x-displayName: Receipts
201
201
  - name: product_categories
202
202
  description: |
203
- Product categories are used to group specific products. They can be linked
204
- to a ledger account, which is important for accounting.
203
+ Product categories are used to group specific products. They are used as a
204
+ ledger account, which is important for accounting.
205
205
 
206
206
  ***Required scopes:*** `products`
207
207
  x-displayName: Product Categories
@@ -7344,6 +7344,7 @@ paths:
7344
7344
  estimated_value:
7345
7345
  type: object
7346
7346
  nullable: true
7347
+ description: The amount may be negative.
7347
7348
  allOf:
7348
7349
  - title: Money
7349
7350
  required: *ref_31
@@ -7502,6 +7503,7 @@ paths:
7502
7503
  estimated_value:
7503
7504
  type: object
7504
7505
  nullable: true
7506
+ description: The amount may be negative.
7505
7507
  allOf:
7506
7508
  - title: Money
7507
7509
  required: *ref_31
@@ -13121,6 +13123,7 @@ paths:
13121
13123
  product_category:
13122
13124
  type: object
13123
13125
  nullable: true
13126
+ description: These are ledger accounts
13124
13127
  allOf:
13125
13128
  - title: TypeAndId
13126
13129
  type: object
@@ -13548,6 +13551,7 @@ paths:
13548
13551
  example: c0c03f1e-77e3-402c-a713-30ea1c585824
13549
13552
  product_category_id:
13550
13553
  type: string
13554
+ description: These are ledger accounts
13551
13555
  example: e2314517-3cab-4aa9-8471-450e73449041
13552
13556
  description: ''
13553
13557
  invoice_date:
@@ -14760,6 +14764,7 @@ paths:
14760
14764
  product_category:
14761
14765
  type: object
14762
14766
  nullable: true
14767
+ description: These are ledger accounts
14763
14768
  allOf:
14764
14769
  - title: TypeAndId
14765
14770
  type: object
@@ -15475,6 +15480,7 @@ paths:
15475
15480
  product_category:
15476
15481
  type: object
15477
15482
  nullable: true
15483
+ description: These are ledger accounts
15478
15484
  allOf:
15479
15485
  - title: TypeAndId
15480
15486
  type: object
@@ -15637,6 +15643,7 @@ paths:
15637
15643
  example: c0c03f1e-77e3-402c-a713-30ea1c585824
15638
15644
  product_category_id:
15639
15645
  type: string
15646
+ description: These are ledger accounts
15640
15647
  example: e2314517-3cab-4aa9-8471-450e73449041
15641
15648
  description: ''
15642
15649
  description: ''
@@ -18891,7 +18898,7 @@ paths:
18891
18898
  tags:
18892
18899
  - product_categories
18893
18900
  summary: productCategories.list
18894
- description: Get a list of product categories.
18901
+ description: Get a list of product categories. They are used as a ledger account, which is important for accounting.
18895
18902
  operationId: productCategories.list
18896
18903
  parameters: []
18897
18904
  requestBody:
@@ -19285,6 +19292,7 @@ paths:
19285
19292
  product_category:
19286
19293
  type: object
19287
19294
  nullable: true
19295
+ description: These are ledger accounts
19288
19296
  allOf:
19289
19297
  - title: TypeAndId
19290
19298
  type: object
@@ -19525,6 +19533,7 @@ paths:
19525
19533
  example: af48fe9e-d44c-0eac-8813-8be051b10921
19526
19534
  product_category_id:
19527
19535
  type: string
19536
+ description: These are ledger accounts
19528
19537
  example: 624ca743-8998-4f8c-add1-c427bb022166
19529
19538
  tax_rate_id:
19530
19539
  type: string
@@ -19647,6 +19656,7 @@ paths:
19647
19656
  example: af48fe9e-d44c-0eac-8813-8be051b10921
19648
19657
  product_category_id:
19649
19658
  type: string
19659
+ description: These are ledger accounts
19650
19660
  example: 624ca743-8998-4f8c-add1-c427bb022166
19651
19661
  tax_rate_id:
19652
19662
  type: string
@@ -32428,6 +32438,7 @@ paths:
32428
32438
  product_category:
32429
32439
  type: object
32430
32440
  nullable: true
32441
+ description: These are ledger accounts
32431
32442
  allOf:
32432
32443
  - title: TypeAndId
32433
32444
  type: object
@@ -3,7 +3,7 @@ info:
3
3
  title: Teamleader API
4
4
  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).
5
5
  contact: {}
6
- version: 1.212.0
6
+ version: 1.214.0
7
7
  servers:
8
8
  - url: https://api.focus.teamleader.eu
9
9
  variables: {}
@@ -200,8 +200,8 @@ tags:
200
200
  x-displayName: Receipts
201
201
  - name: product_categories
202
202
  description: |
203
- Product categories are used to group specific products. They can be linked
204
- to a ledger account, which is important for accounting.
203
+ Product categories are used to group specific products. They are used as a
204
+ ledger account, which is important for accounting.
205
205
 
206
206
  ***Required scopes:*** `products`
207
207
  x-displayName: Product Categories
@@ -9611,7 +9611,7 @@ paths:
9611
9611
  tags:
9612
9612
  - product_categories
9613
9613
  summary: productCategories.list
9614
- description: Get a list of product categories.
9614
+ description: Get a list of product categories. They are used as a ledger account, which is important for accounting.
9615
9615
  operationId: productCategories.list
9616
9616
  parameters: []
9617
9617
  requestBody:
@@ -20636,6 +20636,7 @@ components:
20636
20636
  estimated_value:
20637
20637
  type: object
20638
20638
  nullable: true
20639
+ description: The amount may be negative.
20639
20640
  allOf:
20640
20641
  - $ref: '#/components/schemas/Money'
20641
20642
  estimated_probability:
@@ -20696,6 +20697,7 @@ components:
20696
20697
  estimated_value:
20697
20698
  type: object
20698
20699
  nullable: true
20700
+ description: The amount may be negative.
20699
20701
  allOf:
20700
20702
  - $ref: '#/components/schemas/Money'
20701
20703
  estimated_probability:
@@ -23432,6 +23434,7 @@ components:
23432
23434
  product_category:
23433
23435
  type: object
23434
23436
  nullable: true
23437
+ description: These are ledger accounts
23435
23438
  allOf:
23436
23439
  - $ref: '#/components/schemas/TypeAndId'
23437
23440
  unit_price:
@@ -23776,6 +23779,7 @@ components:
23776
23779
  example: c0c03f1e-77e3-402c-a713-30ea1c585824
23777
23780
  product_category_id:
23778
23781
  type: string
23782
+ description: These are ledger accounts
23779
23783
  example: e2314517-3cab-4aa9-8471-450e73449041
23780
23784
  invoices.draft.request:
23781
23785
  title: invoices.draft.request
@@ -24320,6 +24324,7 @@ components:
24320
24324
  product_category:
24321
24325
  type: object
24322
24326
  nullable: true
24327
+ description: These are ledger accounts
24323
24328
  allOf:
24324
24329
  - $ref: '#/components/schemas/TypeAndId'
24325
24330
  unit_price:
@@ -24639,6 +24644,7 @@ components:
24639
24644
  product_category:
24640
24645
  type: object
24641
24646
  nullable: true
24647
+ description: These are ledger accounts
24642
24648
  allOf:
24643
24649
  - $ref: '#/components/schemas/TypeAndId'
24644
24650
  unit_price:
@@ -24808,6 +24814,7 @@ components:
24808
24814
  example: c0c03f1e-77e3-402c-a713-30ea1c585824
24809
24815
  product_category_id:
24810
24816
  type: string
24817
+ description: These are ledger accounts
24811
24818
  example: e2314517-3cab-4aa9-8471-450e73449041
24812
24819
  description: ''
24813
24820
  InvoiceGenerationCreate:
@@ -26109,6 +26116,7 @@ components:
26109
26116
  product_category:
26110
26117
  type: object
26111
26118
  nullable: true
26119
+ description: These are ledger accounts
26112
26120
  allOf:
26113
26121
  - $ref: '#/components/schemas/TypeAndId'
26114
26122
  stock:
@@ -26220,6 +26228,7 @@ components:
26220
26228
  example: af48fe9e-d44c-0eac-8813-8be051b10921
26221
26229
  product_category_id:
26222
26230
  type: string
26231
+ description: These are ledger accounts
26223
26232
  example: 624ca743-8998-4f8c-add1-c427bb022166
26224
26233
  tax_rate_id:
26225
26234
  type: string
@@ -26289,6 +26298,7 @@ components:
26289
26298
  example: af48fe9e-d44c-0eac-8813-8be051b10921
26290
26299
  product_category_id:
26291
26300
  type: string
26301
+ description: These are ledger accounts
26292
26302
  example: 624ca743-8998-4f8c-add1-c427bb022166
26293
26303
  tax_rate_id:
26294
26304
  type: string
@@ -32009,6 +32019,7 @@ components:
32009
32019
  product_category:
32010
32020
  type: object
32011
32021
  nullable: true
32022
+ description: These are ledger accounts
32012
32023
  allOf:
32013
32024
  - $ref: '#/components/schemas/TypeAndId'
32014
32025
  unit_price:
@@ -0,0 +1,5 @@
1
+ ---
2
+ category: addition
3
+ ---
4
+
5
+ The `estimated_value` amount on `deals.create` and `deals.update` may now be negative. A deal could already end up with a negative value through a negative quotation, so this lifts a restriction the two endpoints applied on their own.
@@ -0,0 +1,5 @@
1
+ ---
2
+ category: addition
3
+ ---
4
+
5
+ We clarified that `product_category` and `product_category_id` are ledger accounts, on the products, invoices, credit notes, subscriptions and orders endpoints. We also improved the description of the product categories resource.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@teamleader/focus-api-specification",
3
3
  "description": "Teamleader Focus API Specification",
4
- "version": "1.212.0",
4
+ "version": "1.214.0",
5
5
  "author": "Teamleader <development@teamleader.eu> (https://www.teamleader.eu)",
6
6
  "bugs": {
7
7
  "url": "https://github.com/teamleadercrm/focus-api-specification/issues"