@teamleader/focus-api-specification 1.216.0 → 1.218.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.
|
|
6
|
+
version: 1.218.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -6720,7 +6720,7 @@ paths:
|
|
|
6720
6720
|
includes:
|
|
6721
6721
|
type: string
|
|
6722
6722
|
description: Comma-separated list of optional includes
|
|
6723
|
-
example: custom_fields
|
|
6723
|
+
example: custom_fields,second_responsible_user
|
|
6724
6724
|
required: false
|
|
6725
6725
|
responses:
|
|
6726
6726
|
'200':
|
|
@@ -6805,6 +6805,14 @@ paths:
|
|
|
6805
6805
|
title: TypeAndId
|
|
6806
6806
|
type: object
|
|
6807
6807
|
properties: *ref_1
|
|
6808
|
+
second_responsible_user:
|
|
6809
|
+
type: object
|
|
6810
|
+
nullable: true
|
|
6811
|
+
description: Only included with request parameter `includes=second_responsible_user`. This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it
|
|
6812
|
+
allOf:
|
|
6813
|
+
- title: TypeAndId
|
|
6814
|
+
type: object
|
|
6815
|
+
properties: *ref_1
|
|
6808
6816
|
closed_at:
|
|
6809
6817
|
type: string
|
|
6810
6818
|
example: '2017-05-09T11:31:30+00:00'
|
|
@@ -7010,6 +7018,10 @@ paths:
|
|
|
7010
7018
|
id:
|
|
7011
7019
|
type: string
|
|
7012
7020
|
example: f6871b06-6513-4750-b5e6-ff3503b5a029
|
|
7021
|
+
includes:
|
|
7022
|
+
type: string
|
|
7023
|
+
description: Comma-separated list of optional includes
|
|
7024
|
+
example: second_responsible_user
|
|
7013
7025
|
- example:
|
|
7014
7026
|
id: f6871b06-6513-4750-b5e6-ff3503b5a029
|
|
7015
7027
|
example:
|
|
@@ -7086,6 +7098,14 @@ paths:
|
|
|
7086
7098
|
title: TypeAndId
|
|
7087
7099
|
type: object
|
|
7088
7100
|
properties: *ref_1
|
|
7101
|
+
second_responsible_user:
|
|
7102
|
+
type: object
|
|
7103
|
+
nullable: true
|
|
7104
|
+
description: Only included with request parameter `includes=second_responsible_user`. This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it
|
|
7105
|
+
allOf:
|
|
7106
|
+
- title: TypeAndId
|
|
7107
|
+
type: object
|
|
7108
|
+
properties: *ref_1
|
|
7089
7109
|
closed_at:
|
|
7090
7110
|
type: string
|
|
7091
7111
|
example: '2017-05-09T11:31:30+00:00'
|
|
@@ -7338,6 +7358,11 @@ paths:
|
|
|
7338
7358
|
responsible_user_id:
|
|
7339
7359
|
type: string
|
|
7340
7360
|
example: 98b2863e-7b01-4232-82f5-ede1f0b9db22
|
|
7361
|
+
second_responsible_user_id:
|
|
7362
|
+
type: string
|
|
7363
|
+
nullable: true
|
|
7364
|
+
description: This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it
|
|
7365
|
+
example: 656a9c04-de65-01f9-9610-3ac636738e91
|
|
7341
7366
|
phase_id:
|
|
7342
7367
|
type: string
|
|
7343
7368
|
example: 060687bb-a742-4882-a538-199a5e5feb60
|
|
@@ -7500,6 +7525,11 @@ paths:
|
|
|
7500
7525
|
type: string
|
|
7501
7526
|
nullable: true
|
|
7502
7527
|
example: 98b2863e-7b01-4232-82f5-ede1f0b9db22
|
|
7528
|
+
second_responsible_user_id:
|
|
7529
|
+
type: string
|
|
7530
|
+
nullable: true
|
|
7531
|
+
description: This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it. `null` clears it
|
|
7532
|
+
example: 656a9c04-de65-01f9-9610-3ac636738e91
|
|
7503
7533
|
estimated_value:
|
|
7504
7534
|
type: object
|
|
7505
7535
|
nullable: true
|
|
@@ -15513,7 +15543,7 @@ paths:
|
|
|
15513
15543
|
example: book
|
|
15514
15544
|
sending_methods:
|
|
15515
15545
|
type: array
|
|
15516
|
-
description: Only provided when action is "
|
|
15546
|
+
description: Only provided when action is "book_and_send".
|
|
15517
15547
|
items:
|
|
15518
15548
|
type: object
|
|
15519
15549
|
properties:
|
|
@@ -15708,7 +15738,7 @@ paths:
|
|
|
15708
15738
|
example: book_and_send
|
|
15709
15739
|
sending_methods:
|
|
15710
15740
|
type: array
|
|
15711
|
-
description: Only provided when action is "
|
|
15741
|
+
description: Only provided when action is "book_and_send". Method "email" is always required; when "peppol" is used, "email" acts as the fallback for when Peppol sending fails.
|
|
15712
15742
|
items:
|
|
15713
15743
|
type: object
|
|
15714
15744
|
properties:
|
|
@@ -15904,7 +15934,7 @@ paths:
|
|
|
15904
15934
|
example: book_and_send
|
|
15905
15935
|
sending_methods:
|
|
15906
15936
|
type: array
|
|
15907
|
-
description: Only provided when action is "
|
|
15937
|
+
description: Only provided when action is "book_and_send". Method "email" is always required; when "peppol" is used, "email" acts as the fallback for when Peppol sending fails.
|
|
15908
15938
|
items:
|
|
15909
15939
|
type: object
|
|
15910
15940
|
properties:
|
|
@@ -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.
|
|
6
|
+
version: 1.218.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -20344,7 +20344,7 @@ components:
|
|
|
20344
20344
|
includes:
|
|
20345
20345
|
type: string
|
|
20346
20346
|
description: Comma-separated list of optional includes
|
|
20347
|
-
example: custom_fields
|
|
20347
|
+
example: custom_fields,second_responsible_user
|
|
20348
20348
|
LeadResponse:
|
|
20349
20349
|
title: LeadResponse
|
|
20350
20350
|
type: object
|
|
@@ -20434,6 +20434,12 @@ components:
|
|
|
20434
20434
|
$ref: '#/components/schemas/TypeAndId'
|
|
20435
20435
|
responsible_user:
|
|
20436
20436
|
$ref: '#/components/schemas/TypeAndId'
|
|
20437
|
+
second_responsible_user:
|
|
20438
|
+
type: object
|
|
20439
|
+
nullable: true
|
|
20440
|
+
description: Only included with request parameter `includes=second_responsible_user`. This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it
|
|
20441
|
+
allOf:
|
|
20442
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
20437
20443
|
closed_at:
|
|
20438
20444
|
type: string
|
|
20439
20445
|
example: '2017-05-09T11:31:30+00:00'
|
|
@@ -20479,6 +20485,10 @@ components:
|
|
|
20479
20485
|
id:
|
|
20480
20486
|
type: string
|
|
20481
20487
|
example: f6871b06-6513-4750-b5e6-ff3503b5a029
|
|
20488
|
+
includes:
|
|
20489
|
+
type: string
|
|
20490
|
+
description: Comma-separated list of optional includes
|
|
20491
|
+
example: second_responsible_user
|
|
20482
20492
|
deals.info.response:
|
|
20483
20493
|
title: deals.info.response
|
|
20484
20494
|
type: object
|
|
@@ -20529,6 +20539,12 @@ components:
|
|
|
20529
20539
|
$ref: '#/components/schemas/TypeAndId'
|
|
20530
20540
|
responsible_user:
|
|
20531
20541
|
$ref: '#/components/schemas/TypeAndId'
|
|
20542
|
+
second_responsible_user:
|
|
20543
|
+
type: object
|
|
20544
|
+
nullable: true
|
|
20545
|
+
description: Only included with request parameter `includes=second_responsible_user`. This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it
|
|
20546
|
+
allOf:
|
|
20547
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
20532
20548
|
closed_at:
|
|
20533
20549
|
type: string
|
|
20534
20550
|
example: '2017-05-09T11:31:30+00:00'
|
|
@@ -20630,6 +20646,11 @@ components:
|
|
|
20630
20646
|
responsible_user_id:
|
|
20631
20647
|
type: string
|
|
20632
20648
|
example: 98b2863e-7b01-4232-82f5-ede1f0b9db22
|
|
20649
|
+
second_responsible_user_id:
|
|
20650
|
+
type: string
|
|
20651
|
+
nullable: true
|
|
20652
|
+
description: This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it
|
|
20653
|
+
example: 656a9c04-de65-01f9-9610-3ac636738e91
|
|
20633
20654
|
phase_id:
|
|
20634
20655
|
type: string
|
|
20635
20656
|
example: 060687bb-a742-4882-a538-199a5e5feb60
|
|
@@ -20694,6 +20715,11 @@ components:
|
|
|
20694
20715
|
type: string
|
|
20695
20716
|
nullable: true
|
|
20696
20717
|
example: 98b2863e-7b01-4232-82f5-ede1f0b9db22
|
|
20718
|
+
second_responsible_user_id:
|
|
20719
|
+
type: string
|
|
20720
|
+
nullable: true
|
|
20721
|
+
description: This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it. `null` clears it
|
|
20722
|
+
example: 656a9c04-de65-01f9-9610-3ac636738e91
|
|
20697
20723
|
estimated_value:
|
|
20698
20724
|
type: object
|
|
20699
20725
|
nullable: true
|
|
@@ -24742,7 +24768,7 @@ components:
|
|
|
24742
24768
|
example: book
|
|
24743
24769
|
sending_methods:
|
|
24744
24770
|
type: array
|
|
24745
|
-
description: Only provided when action is "
|
|
24771
|
+
description: Only provided when action is "book_and_send".
|
|
24746
24772
|
items:
|
|
24747
24773
|
type: object
|
|
24748
24774
|
properties:
|
|
@@ -24853,7 +24879,7 @@ components:
|
|
|
24853
24879
|
example: book_and_send
|
|
24854
24880
|
sending_methods:
|
|
24855
24881
|
type: array
|
|
24856
|
-
description: Only provided when action is "
|
|
24882
|
+
description: Only provided when action is "book_and_send". Method "email" is always required; when "peppol" is used, "email" acts as the fallback for when Peppol sending fails.
|
|
24857
24883
|
items:
|
|
24858
24884
|
type: object
|
|
24859
24885
|
properties:
|
|
@@ -24998,7 +25024,7 @@ components:
|
|
|
24998
25024
|
example: book_and_send
|
|
24999
25025
|
sending_methods:
|
|
25000
25026
|
type: array
|
|
25001
|
-
description: Only provided when action is "
|
|
25027
|
+
description: Only provided when action is "book_and_send". Method "email" is always required; when "peppol" is used, "email" acts as the fallback for when Peppol sending fails.
|
|
25002
25028
|
items:
|
|
25003
25029
|
type: object
|
|
25004
25030
|
properties:
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: addition
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
We documented the second responsible user on the deals endpoints: `deals.info` and `deals.list` can return it through `includes=second_responsible_user`, and `deals.create` and `deals.update` accept `second_responsible_user_id`. This requires the second deal responsible feature to be enabled. Contact support.focus@teamleader.eu to enable it.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
---
|
|
2
|
+
category: addition
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
We clarified that `invoice_generation.sending_methods` on `subscriptions.create` and `subscriptions.update` must always include `email` when the action is `book_and_send`. When `peppol` is used, `email` acts as the fallback for when Peppol sending fails.
|
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.
|
|
4
|
+
"version": "1.218.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"
|