@teamleader/focus-api-specification 1.9.0 → 1.10.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.10.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -43,6 +43,10 @@ tags:
|
|
|
43
43
|
- name: notes
|
|
44
44
|
description: Notes
|
|
45
45
|
x-displayName: Notes
|
|
46
|
+
- name: orders
|
|
47
|
+
description: |
|
|
48
|
+
***Required scopes:*** `orders`
|
|
49
|
+
x-displayName: Orders
|
|
46
50
|
- name: email_tracking
|
|
47
51
|
description: Email Tracking
|
|
48
52
|
x-displayName: Email Tracking
|
|
@@ -28411,6 +28415,419 @@ paths:
|
|
|
28411
28415
|
type: activityType
|
|
28412
28416
|
id: 28f3639d-9b64-44a8-974d-a4df645af6a5
|
|
28413
28417
|
deprecated: false
|
|
28418
|
+
/orders.info:
|
|
28419
|
+
post:
|
|
28420
|
+
tags:
|
|
28421
|
+
- orders
|
|
28422
|
+
summary: orders.info
|
|
28423
|
+
description: Get details for a single order.
|
|
28424
|
+
operationId: orders.info
|
|
28425
|
+
parameters: []
|
|
28426
|
+
requestBody:
|
|
28427
|
+
description: ''
|
|
28428
|
+
content:
|
|
28429
|
+
application/json:
|
|
28430
|
+
schema:
|
|
28431
|
+
title: orders.inforequest
|
|
28432
|
+
required: &ref_657
|
|
28433
|
+
- id
|
|
28434
|
+
type: object
|
|
28435
|
+
properties: &ref_658
|
|
28436
|
+
id:
|
|
28437
|
+
type: string
|
|
28438
|
+
example: 6fac0bf0-e803-424e-af67-76863a3d7d16
|
|
28439
|
+
includes:
|
|
28440
|
+
type: string
|
|
28441
|
+
description: Comma-separated list of optional includes
|
|
28442
|
+
example: custom_fields
|
|
28443
|
+
example:
|
|
28444
|
+
id: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28445
|
+
required: true
|
|
28446
|
+
responses:
|
|
28447
|
+
'200':
|
|
28448
|
+
description: ''
|
|
28449
|
+
headers: {}
|
|
28450
|
+
content:
|
|
28451
|
+
application/json:
|
|
28452
|
+
schema:
|
|
28453
|
+
title: products.inforesponse
|
|
28454
|
+
type: object
|
|
28455
|
+
properties: &ref_659
|
|
28456
|
+
data:
|
|
28457
|
+
type: object
|
|
28458
|
+
properties:
|
|
28459
|
+
id:
|
|
28460
|
+
type: string
|
|
28461
|
+
example: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28462
|
+
name:
|
|
28463
|
+
type: string
|
|
28464
|
+
example: General costs
|
|
28465
|
+
order_date:
|
|
28466
|
+
type: string
|
|
28467
|
+
example: '2016-02-04'
|
|
28468
|
+
nullable: true
|
|
28469
|
+
delivery_date:
|
|
28470
|
+
type: string
|
|
28471
|
+
example: '2016-10-14'
|
|
28472
|
+
nullable: true
|
|
28473
|
+
payment_term:
|
|
28474
|
+
allOf:
|
|
28475
|
+
- title: PaymentTerm
|
|
28476
|
+
type: object
|
|
28477
|
+
properties: *ref_19
|
|
28478
|
+
- type: object
|
|
28479
|
+
nullable: true
|
|
28480
|
+
total:
|
|
28481
|
+
type: object
|
|
28482
|
+
properties:
|
|
28483
|
+
tax_exclusive:
|
|
28484
|
+
title: Money
|
|
28485
|
+
required: *ref_30
|
|
28486
|
+
type: object
|
|
28487
|
+
properties: *ref_31
|
|
28488
|
+
tax_inclusive:
|
|
28489
|
+
title: Money
|
|
28490
|
+
required: *ref_30
|
|
28491
|
+
type: object
|
|
28492
|
+
properties: *ref_31
|
|
28493
|
+
purchase_price_tax_exclusive:
|
|
28494
|
+
allOf:
|
|
28495
|
+
- title: Money
|
|
28496
|
+
required: *ref_30
|
|
28497
|
+
type: object
|
|
28498
|
+
properties: *ref_31
|
|
28499
|
+
- type: object
|
|
28500
|
+
nullable: true
|
|
28501
|
+
purchase_price_tax_inclusive:
|
|
28502
|
+
allOf:
|
|
28503
|
+
- title: Money
|
|
28504
|
+
required: *ref_30
|
|
28505
|
+
type: object
|
|
28506
|
+
properties: *ref_31
|
|
28507
|
+
- type: object
|
|
28508
|
+
nullable: true
|
|
28509
|
+
taxes:
|
|
28510
|
+
type: array
|
|
28511
|
+
items:
|
|
28512
|
+
title: Taxes
|
|
28513
|
+
type: object
|
|
28514
|
+
properties: *ref_41
|
|
28515
|
+
description: ''
|
|
28516
|
+
web_url:
|
|
28517
|
+
type: string
|
|
28518
|
+
example: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
28519
|
+
supplier:
|
|
28520
|
+
type: object
|
|
28521
|
+
properties:
|
|
28522
|
+
type:
|
|
28523
|
+
type: string
|
|
28524
|
+
enum:
|
|
28525
|
+
- company
|
|
28526
|
+
- contact
|
|
28527
|
+
example: contact
|
|
28528
|
+
id:
|
|
28529
|
+
type: string
|
|
28530
|
+
example: e2314517-3cab-4aa9-8471-450e73449040
|
|
28531
|
+
nullable: true
|
|
28532
|
+
department:
|
|
28533
|
+
allOf:
|
|
28534
|
+
- title: TypeAndId
|
|
28535
|
+
type: object
|
|
28536
|
+
properties: *ref_1
|
|
28537
|
+
- type: object
|
|
28538
|
+
nullable: true
|
|
28539
|
+
deal:
|
|
28540
|
+
allOf:
|
|
28541
|
+
- title: TypeAndId
|
|
28542
|
+
type: object
|
|
28543
|
+
properties: *ref_1
|
|
28544
|
+
- type: object
|
|
28545
|
+
nullable: true
|
|
28546
|
+
project:
|
|
28547
|
+
allOf:
|
|
28548
|
+
- title: TypeAndId
|
|
28549
|
+
type: object
|
|
28550
|
+
properties: *ref_1
|
|
28551
|
+
- type: object
|
|
28552
|
+
nullable: true
|
|
28553
|
+
assignee:
|
|
28554
|
+
allOf:
|
|
28555
|
+
- title: TypeAndId
|
|
28556
|
+
type: object
|
|
28557
|
+
properties: *ref_1
|
|
28558
|
+
- type: object
|
|
28559
|
+
nullable: true
|
|
28560
|
+
custom_fields:
|
|
28561
|
+
type: array
|
|
28562
|
+
items:
|
|
28563
|
+
title: CustomFieldsResponse
|
|
28564
|
+
type: object
|
|
28565
|
+
properties: *ref_21
|
|
28566
|
+
description: Only included with request parameter `includes=custom_fields`
|
|
28567
|
+
example:
|
|
28568
|
+
data:
|
|
28569
|
+
id: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28570
|
+
name: General costs
|
|
28571
|
+
order_date: '2016-02-04'
|
|
28572
|
+
delivery_date: '2016-10-14'
|
|
28573
|
+
payment_term:
|
|
28574
|
+
type: cash
|
|
28575
|
+
total:
|
|
28576
|
+
tax_exclusive:
|
|
28577
|
+
amount: 123.3
|
|
28578
|
+
currency: EUR
|
|
28579
|
+
tax_inclusive:
|
|
28580
|
+
amount: 123.3
|
|
28581
|
+
currency: EUR
|
|
28582
|
+
purchase_price_tax_exclusive:
|
|
28583
|
+
amount: 123.3
|
|
28584
|
+
currency: EUR
|
|
28585
|
+
purchase_price_tax_inclusive:
|
|
28586
|
+
amount: 123.3
|
|
28587
|
+
currency: EUR
|
|
28588
|
+
taxes:
|
|
28589
|
+
- rate: 0.21
|
|
28590
|
+
taxable:
|
|
28591
|
+
amount: 123.3
|
|
28592
|
+
currency: EUR
|
|
28593
|
+
tax:
|
|
28594
|
+
amount: 123.3
|
|
28595
|
+
currency: EUR
|
|
28596
|
+
web_url: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
28597
|
+
supplier:
|
|
28598
|
+
type: contact
|
|
28599
|
+
id: e2314517-3cab-4aa9-8471-450e73449040
|
|
28600
|
+
department:
|
|
28601
|
+
type: department
|
|
28602
|
+
id: aa849e5d-5678-4d41-a052-2e4e5420707d
|
|
28603
|
+
deal:
|
|
28604
|
+
type: deal
|
|
28605
|
+
id: a7431439-5795-433c-8503-089cc2fff03a
|
|
28606
|
+
project:
|
|
28607
|
+
type: project
|
|
28608
|
+
id: 656e4faa-8006-4a58-9de9-ffe509633743
|
|
28609
|
+
assignee:
|
|
28610
|
+
type: user
|
|
28611
|
+
id: 7ba98a20-5e2b-4b46-81b9-a3364432d4f0
|
|
28612
|
+
custom_fields:
|
|
28613
|
+
- definition:
|
|
28614
|
+
type: customFieldDefinition
|
|
28615
|
+
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
28616
|
+
value: '092980616'
|
|
28617
|
+
/orders.list:
|
|
28618
|
+
post:
|
|
28619
|
+
tags:
|
|
28620
|
+
- orders
|
|
28621
|
+
summary: orders.list
|
|
28622
|
+
description: Get a list of orders.
|
|
28623
|
+
operationId: orders.list
|
|
28624
|
+
parameters: []
|
|
28625
|
+
requestBody:
|
|
28626
|
+
description: ''
|
|
28627
|
+
content:
|
|
28628
|
+
application/json:
|
|
28629
|
+
schema:
|
|
28630
|
+
allOf:
|
|
28631
|
+
- title: orders.listrequest
|
|
28632
|
+
type: object
|
|
28633
|
+
properties: &ref_660
|
|
28634
|
+
filter:
|
|
28635
|
+
type: object
|
|
28636
|
+
properties:
|
|
28637
|
+
ids:
|
|
28638
|
+
type: array
|
|
28639
|
+
items:
|
|
28640
|
+
type: string
|
|
28641
|
+
includes:
|
|
28642
|
+
type: string
|
|
28643
|
+
description: Comma-separated list of optional includes
|
|
28644
|
+
example: custom_fields
|
|
28645
|
+
- example:
|
|
28646
|
+
filter:
|
|
28647
|
+
ids:
|
|
28648
|
+
- 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28649
|
+
- 7c3c4edc-fd8d-0cc3-bd1e-9f3f9d7b7db2
|
|
28650
|
+
includes: custom_fields
|
|
28651
|
+
example:
|
|
28652
|
+
filter:
|
|
28653
|
+
ids:
|
|
28654
|
+
- 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28655
|
+
- 7c3c4edc-fd8d-0cc3-bd1e-9f3f9d7b7db2
|
|
28656
|
+
includes: custom_fields
|
|
28657
|
+
required: true
|
|
28658
|
+
responses:
|
|
28659
|
+
'200':
|
|
28660
|
+
description: ''
|
|
28661
|
+
headers: {}
|
|
28662
|
+
content:
|
|
28663
|
+
application/json:
|
|
28664
|
+
schema:
|
|
28665
|
+
title: orders.listresponse
|
|
28666
|
+
type: object
|
|
28667
|
+
properties: &ref_661
|
|
28668
|
+
data:
|
|
28669
|
+
type: array
|
|
28670
|
+
items:
|
|
28671
|
+
type: object
|
|
28672
|
+
properties:
|
|
28673
|
+
id:
|
|
28674
|
+
type: string
|
|
28675
|
+
example: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28676
|
+
name:
|
|
28677
|
+
type: string
|
|
28678
|
+
example: General costs
|
|
28679
|
+
order_date:
|
|
28680
|
+
type: string
|
|
28681
|
+
example: '2016-02-04'
|
|
28682
|
+
nullable: true
|
|
28683
|
+
delivery_date:
|
|
28684
|
+
type: string
|
|
28685
|
+
example: '2016-10-14'
|
|
28686
|
+
nullable: true
|
|
28687
|
+
payment_term:
|
|
28688
|
+
allOf:
|
|
28689
|
+
- title: PaymentTerm
|
|
28690
|
+
type: object
|
|
28691
|
+
properties: *ref_19
|
|
28692
|
+
- type: object
|
|
28693
|
+
nullable: true
|
|
28694
|
+
total:
|
|
28695
|
+
type: object
|
|
28696
|
+
properties:
|
|
28697
|
+
tax_exclusive:
|
|
28698
|
+
title: Money
|
|
28699
|
+
required: *ref_30
|
|
28700
|
+
type: object
|
|
28701
|
+
properties: *ref_31
|
|
28702
|
+
tax_inclusive:
|
|
28703
|
+
title: Money
|
|
28704
|
+
required: *ref_30
|
|
28705
|
+
type: object
|
|
28706
|
+
properties: *ref_31
|
|
28707
|
+
purchase_price_tax_exclusive:
|
|
28708
|
+
allOf:
|
|
28709
|
+
- title: Money
|
|
28710
|
+
required: *ref_30
|
|
28711
|
+
type: object
|
|
28712
|
+
properties: *ref_31
|
|
28713
|
+
- type: object
|
|
28714
|
+
nullable: true
|
|
28715
|
+
purchase_price_tax_inclusive:
|
|
28716
|
+
allOf:
|
|
28717
|
+
- title: Money
|
|
28718
|
+
required: *ref_30
|
|
28719
|
+
type: object
|
|
28720
|
+
properties: *ref_31
|
|
28721
|
+
- type: object
|
|
28722
|
+
nullable: true
|
|
28723
|
+
taxes:
|
|
28724
|
+
type: array
|
|
28725
|
+
items:
|
|
28726
|
+
title: Taxes
|
|
28727
|
+
type: object
|
|
28728
|
+
properties: *ref_41
|
|
28729
|
+
description: ''
|
|
28730
|
+
web_url:
|
|
28731
|
+
type: string
|
|
28732
|
+
example: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
28733
|
+
supplier:
|
|
28734
|
+
type: object
|
|
28735
|
+
properties:
|
|
28736
|
+
type:
|
|
28737
|
+
type: string
|
|
28738
|
+
enum:
|
|
28739
|
+
- company
|
|
28740
|
+
- contact
|
|
28741
|
+
example: contact
|
|
28742
|
+
id:
|
|
28743
|
+
type: string
|
|
28744
|
+
example: e2314517-3cab-4aa9-8471-450e73449040
|
|
28745
|
+
nullable: true
|
|
28746
|
+
department:
|
|
28747
|
+
allOf:
|
|
28748
|
+
- title: TypeAndId
|
|
28749
|
+
type: object
|
|
28750
|
+
properties: *ref_1
|
|
28751
|
+
- type: object
|
|
28752
|
+
nullable: true
|
|
28753
|
+
deal:
|
|
28754
|
+
allOf:
|
|
28755
|
+
- title: TypeAndId
|
|
28756
|
+
type: object
|
|
28757
|
+
properties: *ref_1
|
|
28758
|
+
- type: object
|
|
28759
|
+
nullable: true
|
|
28760
|
+
project:
|
|
28761
|
+
allOf:
|
|
28762
|
+
- title: TypeAndId
|
|
28763
|
+
type: object
|
|
28764
|
+
properties: *ref_1
|
|
28765
|
+
- type: object
|
|
28766
|
+
nullable: true
|
|
28767
|
+
assignee:
|
|
28768
|
+
allOf:
|
|
28769
|
+
- title: TypeAndId
|
|
28770
|
+
type: object
|
|
28771
|
+
properties: *ref_1
|
|
28772
|
+
- type: object
|
|
28773
|
+
nullable: true
|
|
28774
|
+
custom_fields:
|
|
28775
|
+
type: array
|
|
28776
|
+
items:
|
|
28777
|
+
title: CustomFieldsResponse
|
|
28778
|
+
type: object
|
|
28779
|
+
properties: *ref_21
|
|
28780
|
+
description: Only included with request parameter `includes=custom_fields`
|
|
28781
|
+
example:
|
|
28782
|
+
data:
|
|
28783
|
+
- id: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
28784
|
+
name: General costs
|
|
28785
|
+
order_date: '2016-02-04'
|
|
28786
|
+
delivery_date: '2016-10-14'
|
|
28787
|
+
payment_term:
|
|
28788
|
+
type: cash
|
|
28789
|
+
total:
|
|
28790
|
+
tax_exclusive:
|
|
28791
|
+
amount: 123.3
|
|
28792
|
+
currency: EUR
|
|
28793
|
+
tax_inclusive:
|
|
28794
|
+
amount: 123.3
|
|
28795
|
+
currency: EUR
|
|
28796
|
+
purchase_price_tax_exclusive:
|
|
28797
|
+
amount: 123.3
|
|
28798
|
+
currency: EUR
|
|
28799
|
+
purchase_price_tax_inclusive:
|
|
28800
|
+
amount: 123.3
|
|
28801
|
+
currency: EUR
|
|
28802
|
+
taxes:
|
|
28803
|
+
- rate: 0.21
|
|
28804
|
+
taxable:
|
|
28805
|
+
amount: 123.3
|
|
28806
|
+
currency: EUR
|
|
28807
|
+
tax:
|
|
28808
|
+
amount: 123.3
|
|
28809
|
+
currency: EUR
|
|
28810
|
+
web_url: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
28811
|
+
supplier:
|
|
28812
|
+
type: contact
|
|
28813
|
+
id: e2314517-3cab-4aa9-8471-450e73449040
|
|
28814
|
+
department:
|
|
28815
|
+
type: department
|
|
28816
|
+
id: aa849e5d-5678-4d41-a052-2e4e5420707d
|
|
28817
|
+
deal:
|
|
28818
|
+
type: deal
|
|
28819
|
+
id: a7431439-5795-433c-8503-089cc2fff03a
|
|
28820
|
+
project:
|
|
28821
|
+
type: project
|
|
28822
|
+
id: 656e4faa-8006-4a58-9de9-ffe509633743
|
|
28823
|
+
assignee:
|
|
28824
|
+
type: user
|
|
28825
|
+
id: 7ba98a20-5e2b-4b46-81b9-a3364432d4f0
|
|
28826
|
+
custom_fields:
|
|
28827
|
+
- definition:
|
|
28828
|
+
type: customFieldDefinition
|
|
28829
|
+
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
28830
|
+
value: '092980616'
|
|
28414
28831
|
/webhooks.register:
|
|
28415
28832
|
post:
|
|
28416
28833
|
tags:
|
|
@@ -28544,7 +28961,7 @@ paths:
|
|
|
28544
28961
|
schema:
|
|
28545
28962
|
title: webhooks.listresponse
|
|
28546
28963
|
type: object
|
|
28547
|
-
properties: &
|
|
28964
|
+
properties: &ref_662
|
|
28548
28965
|
data:
|
|
28549
28966
|
type: array
|
|
28550
28967
|
items:
|
|
@@ -28593,11 +29010,11 @@ paths:
|
|
|
28593
29010
|
schema:
|
|
28594
29011
|
allOf:
|
|
28595
29012
|
- title: cloudPlatforms.urlrequest
|
|
28596
|
-
required: &
|
|
29013
|
+
required: &ref_663
|
|
28597
29014
|
- type
|
|
28598
29015
|
- id
|
|
28599
29016
|
type: object
|
|
28600
|
-
properties: &
|
|
29017
|
+
properties: &ref_664
|
|
28601
29018
|
type:
|
|
28602
29019
|
type: string
|
|
28603
29020
|
enum:
|
|
@@ -28624,7 +29041,7 @@ paths:
|
|
|
28624
29041
|
allOf:
|
|
28625
29042
|
- title: cloudPlatforms.urlresponse
|
|
28626
29043
|
type: object
|
|
28627
|
-
properties: &
|
|
29044
|
+
properties: &ref_665
|
|
28628
29045
|
data:
|
|
28629
29046
|
type: object
|
|
28630
29047
|
properties:
|
|
@@ -28666,7 +29083,7 @@ paths:
|
|
|
28666
29083
|
allOf:
|
|
28667
29084
|
- title: accounts.projects-v2-statusresponse
|
|
28668
29085
|
type: object
|
|
28669
|
-
properties: &
|
|
29086
|
+
properties: &ref_666
|
|
28670
29087
|
data:
|
|
28671
29088
|
type: object
|
|
28672
29089
|
properties:
|
|
@@ -30731,6 +31148,23 @@ components:
|
|
|
30731
31148
|
title: migrate.activityTyperesponse
|
|
30732
31149
|
type: object
|
|
30733
31150
|
properties: *ref_656
|
|
31151
|
+
orders.inforequest:
|
|
31152
|
+
title: orders.inforequest
|
|
31153
|
+
required: *ref_657
|
|
31154
|
+
type: object
|
|
31155
|
+
properties: *ref_658
|
|
31156
|
+
orders.inforesponse:
|
|
31157
|
+
title: products.inforesponse
|
|
31158
|
+
type: object
|
|
31159
|
+
properties: *ref_659
|
|
31160
|
+
orders.listrequest:
|
|
31161
|
+
title: orders.listrequest
|
|
31162
|
+
type: object
|
|
31163
|
+
properties: *ref_660
|
|
31164
|
+
orders.listresponse:
|
|
31165
|
+
title: orders.listresponse
|
|
31166
|
+
type: object
|
|
31167
|
+
properties: *ref_661
|
|
30734
31168
|
WebHook:
|
|
30735
31169
|
title: WebHook
|
|
30736
31170
|
required: *ref_108
|
|
@@ -30739,20 +31173,20 @@ components:
|
|
|
30739
31173
|
webhooks.listresponse:
|
|
30740
31174
|
title: webhooks.listresponse
|
|
30741
31175
|
type: object
|
|
30742
|
-
properties: *
|
|
31176
|
+
properties: *ref_662
|
|
30743
31177
|
cloudPlatforms.urlrequest:
|
|
30744
31178
|
title: cloudPlatforms.urlrequest
|
|
30745
|
-
required: *
|
|
31179
|
+
required: *ref_663
|
|
30746
31180
|
type: object
|
|
30747
|
-
properties: *
|
|
31181
|
+
properties: *ref_664
|
|
30748
31182
|
cloudPlatforms.urlresponse:
|
|
30749
31183
|
title: cloudPlatforms.urlresponse
|
|
30750
31184
|
type: object
|
|
30751
|
-
properties: *
|
|
31185
|
+
properties: *ref_665
|
|
30752
31186
|
accounts.projects-v2-statusresponse:
|
|
30753
31187
|
title: accounts.projects-v2-statusresponse
|
|
30754
31188
|
type: object
|
|
30755
|
-
properties: *
|
|
31189
|
+
properties: *ref_666
|
|
30756
31190
|
x-tagGroups:
|
|
30757
31191
|
- name: General
|
|
30758
31192
|
tags:
|
|
@@ -30781,6 +31215,7 @@ x-tagGroups:
|
|
|
30781
31215
|
- deal_pipelines
|
|
30782
31216
|
- deal_phases
|
|
30783
31217
|
- deal_sources
|
|
31218
|
+
- orders
|
|
30784
31219
|
- quotations
|
|
30785
31220
|
- name: Calendar
|
|
30786
31221
|
tags:
|
|
@@ -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.10.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -43,6 +43,10 @@ tags:
|
|
|
43
43
|
- name: notes
|
|
44
44
|
description: Notes
|
|
45
45
|
x-displayName: Notes
|
|
46
|
+
- name: orders
|
|
47
|
+
description: |
|
|
48
|
+
***Required scopes:*** `orders`
|
|
49
|
+
x-displayName: Orders
|
|
46
50
|
- name: email_tracking
|
|
47
51
|
description: Email Tracking
|
|
48
52
|
x-displayName: Email Tracking
|
|
@@ -13770,6 +13774,167 @@ paths:
|
|
|
13770
13774
|
type: activityType
|
|
13771
13775
|
id: 28f3639d-9b64-44a8-974d-a4df645af6a5
|
|
13772
13776
|
deprecated: false
|
|
13777
|
+
/orders.info:
|
|
13778
|
+
post:
|
|
13779
|
+
tags:
|
|
13780
|
+
- orders
|
|
13781
|
+
summary: orders.info
|
|
13782
|
+
description: Get details for a single order.
|
|
13783
|
+
operationId: orders.info
|
|
13784
|
+
parameters: []
|
|
13785
|
+
requestBody:
|
|
13786
|
+
description: ''
|
|
13787
|
+
content:
|
|
13788
|
+
application/json:
|
|
13789
|
+
schema:
|
|
13790
|
+
$ref: '#/components/schemas/orders.inforequest'
|
|
13791
|
+
example:
|
|
13792
|
+
id: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
13793
|
+
required: true
|
|
13794
|
+
responses:
|
|
13795
|
+
'200':
|
|
13796
|
+
description: ''
|
|
13797
|
+
headers: {}
|
|
13798
|
+
content:
|
|
13799
|
+
application/json:
|
|
13800
|
+
schema:
|
|
13801
|
+
$ref: '#/components/schemas/orders.inforesponse'
|
|
13802
|
+
example:
|
|
13803
|
+
data:
|
|
13804
|
+
id: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
13805
|
+
name: General costs
|
|
13806
|
+
order_date: '2016-02-04'
|
|
13807
|
+
delivery_date: '2016-10-14'
|
|
13808
|
+
payment_term:
|
|
13809
|
+
type: cash
|
|
13810
|
+
total:
|
|
13811
|
+
tax_exclusive:
|
|
13812
|
+
amount: 123.3
|
|
13813
|
+
currency: EUR
|
|
13814
|
+
tax_inclusive:
|
|
13815
|
+
amount: 123.3
|
|
13816
|
+
currency: EUR
|
|
13817
|
+
purchase_price_tax_exclusive:
|
|
13818
|
+
amount: 123.3
|
|
13819
|
+
currency: EUR
|
|
13820
|
+
purchase_price_tax_inclusive:
|
|
13821
|
+
amount: 123.3
|
|
13822
|
+
currency: EUR
|
|
13823
|
+
taxes:
|
|
13824
|
+
- rate: 0.21
|
|
13825
|
+
taxable:
|
|
13826
|
+
amount: 123.3
|
|
13827
|
+
currency: EUR
|
|
13828
|
+
tax:
|
|
13829
|
+
amount: 123.3
|
|
13830
|
+
currency: EUR
|
|
13831
|
+
web_url: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
13832
|
+
supplier:
|
|
13833
|
+
type: contact
|
|
13834
|
+
id: e2314517-3cab-4aa9-8471-450e73449040
|
|
13835
|
+
department:
|
|
13836
|
+
type: department
|
|
13837
|
+
id: aa849e5d-5678-4d41-a052-2e4e5420707d
|
|
13838
|
+
deal:
|
|
13839
|
+
type: deal
|
|
13840
|
+
id: a7431439-5795-433c-8503-089cc2fff03a
|
|
13841
|
+
project:
|
|
13842
|
+
type: project
|
|
13843
|
+
id: 656e4faa-8006-4a58-9de9-ffe509633743
|
|
13844
|
+
assignee:
|
|
13845
|
+
type: user
|
|
13846
|
+
id: 7ba98a20-5e2b-4b46-81b9-a3364432d4f0
|
|
13847
|
+
custom_fields:
|
|
13848
|
+
- definition:
|
|
13849
|
+
type: customFieldDefinition
|
|
13850
|
+
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
13851
|
+
value: '092980616'
|
|
13852
|
+
/orders.list:
|
|
13853
|
+
post:
|
|
13854
|
+
tags:
|
|
13855
|
+
- orders
|
|
13856
|
+
summary: orders.list
|
|
13857
|
+
description: Get a list of orders.
|
|
13858
|
+
operationId: orders.list
|
|
13859
|
+
parameters: []
|
|
13860
|
+
requestBody:
|
|
13861
|
+
description: ''
|
|
13862
|
+
content:
|
|
13863
|
+
application/json:
|
|
13864
|
+
schema:
|
|
13865
|
+
allOf:
|
|
13866
|
+
- $ref: '#/components/schemas/orders.listrequest'
|
|
13867
|
+
- example:
|
|
13868
|
+
filter:
|
|
13869
|
+
ids:
|
|
13870
|
+
- 31b9d864-da1d-060e-9811-f683896aeb11
|
|
13871
|
+
- 7c3c4edc-fd8d-0cc3-bd1e-9f3f9d7b7db2
|
|
13872
|
+
includes: custom_fields
|
|
13873
|
+
example:
|
|
13874
|
+
filter:
|
|
13875
|
+
ids:
|
|
13876
|
+
- 31b9d864-da1d-060e-9811-f683896aeb11
|
|
13877
|
+
- 7c3c4edc-fd8d-0cc3-bd1e-9f3f9d7b7db2
|
|
13878
|
+
includes: custom_fields
|
|
13879
|
+
required: true
|
|
13880
|
+
responses:
|
|
13881
|
+
'200':
|
|
13882
|
+
description: ''
|
|
13883
|
+
headers: {}
|
|
13884
|
+
content:
|
|
13885
|
+
application/json:
|
|
13886
|
+
schema:
|
|
13887
|
+
$ref: '#/components/schemas/orders.listresponse'
|
|
13888
|
+
example:
|
|
13889
|
+
data:
|
|
13890
|
+
- id: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
13891
|
+
name: General costs
|
|
13892
|
+
order_date: '2016-02-04'
|
|
13893
|
+
delivery_date: '2016-10-14'
|
|
13894
|
+
payment_term:
|
|
13895
|
+
type: cash
|
|
13896
|
+
total:
|
|
13897
|
+
tax_exclusive:
|
|
13898
|
+
amount: 123.3
|
|
13899
|
+
currency: EUR
|
|
13900
|
+
tax_inclusive:
|
|
13901
|
+
amount: 123.3
|
|
13902
|
+
currency: EUR
|
|
13903
|
+
purchase_price_tax_exclusive:
|
|
13904
|
+
amount: 123.3
|
|
13905
|
+
currency: EUR
|
|
13906
|
+
purchase_price_tax_inclusive:
|
|
13907
|
+
amount: 123.3
|
|
13908
|
+
currency: EUR
|
|
13909
|
+
taxes:
|
|
13910
|
+
- rate: 0.21
|
|
13911
|
+
taxable:
|
|
13912
|
+
amount: 123.3
|
|
13913
|
+
currency: EUR
|
|
13914
|
+
tax:
|
|
13915
|
+
amount: 123.3
|
|
13916
|
+
currency: EUR
|
|
13917
|
+
web_url: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
13918
|
+
supplier:
|
|
13919
|
+
type: contact
|
|
13920
|
+
id: e2314517-3cab-4aa9-8471-450e73449040
|
|
13921
|
+
department:
|
|
13922
|
+
type: department
|
|
13923
|
+
id: aa849e5d-5678-4d41-a052-2e4e5420707d
|
|
13924
|
+
deal:
|
|
13925
|
+
type: deal
|
|
13926
|
+
id: a7431439-5795-433c-8503-089cc2fff03a
|
|
13927
|
+
project:
|
|
13928
|
+
type: project
|
|
13929
|
+
id: 656e4faa-8006-4a58-9de9-ffe509633743
|
|
13930
|
+
assignee:
|
|
13931
|
+
type: user
|
|
13932
|
+
id: 7ba98a20-5e2b-4b46-81b9-a3364432d4f0
|
|
13933
|
+
custom_fields:
|
|
13934
|
+
- definition:
|
|
13935
|
+
type: customFieldDefinition
|
|
13936
|
+
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
13937
|
+
value: '092980616'
|
|
13773
13938
|
/webhooks.register:
|
|
13774
13939
|
post:
|
|
13775
13940
|
tags:
|
|
@@ -27507,6 +27672,214 @@ components:
|
|
|
27507
27672
|
properties:
|
|
27508
27673
|
data:
|
|
27509
27674
|
$ref: '#/components/schemas/TypeAndId'
|
|
27675
|
+
orders.inforequest:
|
|
27676
|
+
title: orders.inforequest
|
|
27677
|
+
required:
|
|
27678
|
+
- id
|
|
27679
|
+
type: object
|
|
27680
|
+
properties:
|
|
27681
|
+
id:
|
|
27682
|
+
type: string
|
|
27683
|
+
example: 6fac0bf0-e803-424e-af67-76863a3d7d16
|
|
27684
|
+
includes:
|
|
27685
|
+
type: string
|
|
27686
|
+
description: Comma-separated list of optional includes
|
|
27687
|
+
example: custom_fields
|
|
27688
|
+
orders.inforesponse:
|
|
27689
|
+
title: products.inforesponse
|
|
27690
|
+
type: object
|
|
27691
|
+
properties:
|
|
27692
|
+
data:
|
|
27693
|
+
type: object
|
|
27694
|
+
properties:
|
|
27695
|
+
id:
|
|
27696
|
+
type: string
|
|
27697
|
+
example: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
27698
|
+
name:
|
|
27699
|
+
type: string
|
|
27700
|
+
example: General costs
|
|
27701
|
+
order_date:
|
|
27702
|
+
type: string
|
|
27703
|
+
example: '2016-02-04'
|
|
27704
|
+
nullable: true
|
|
27705
|
+
delivery_date:
|
|
27706
|
+
type: string
|
|
27707
|
+
example: '2016-10-14'
|
|
27708
|
+
nullable: true
|
|
27709
|
+
payment_term:
|
|
27710
|
+
allOf:
|
|
27711
|
+
- $ref: '#/components/schemas/PaymentTerm'
|
|
27712
|
+
- type: object
|
|
27713
|
+
nullable: true
|
|
27714
|
+
total:
|
|
27715
|
+
type: object
|
|
27716
|
+
properties:
|
|
27717
|
+
tax_exclusive:
|
|
27718
|
+
$ref: '#/components/schemas/Money'
|
|
27719
|
+
tax_inclusive:
|
|
27720
|
+
$ref: '#/components/schemas/Money'
|
|
27721
|
+
purchase_price_tax_exclusive:
|
|
27722
|
+
allOf:
|
|
27723
|
+
- $ref: '#/components/schemas/Money'
|
|
27724
|
+
- type: object
|
|
27725
|
+
nullable: true
|
|
27726
|
+
purchase_price_tax_inclusive:
|
|
27727
|
+
allOf:
|
|
27728
|
+
- $ref: '#/components/schemas/Money'
|
|
27729
|
+
- type: object
|
|
27730
|
+
nullable: true
|
|
27731
|
+
taxes:
|
|
27732
|
+
type: array
|
|
27733
|
+
items:
|
|
27734
|
+
$ref: '#/components/schemas/Taxes'
|
|
27735
|
+
description: ''
|
|
27736
|
+
web_url:
|
|
27737
|
+
type: string
|
|
27738
|
+
example: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
27739
|
+
supplier:
|
|
27740
|
+
type: object
|
|
27741
|
+
properties:
|
|
27742
|
+
type:
|
|
27743
|
+
type: string
|
|
27744
|
+
enum:
|
|
27745
|
+
- company
|
|
27746
|
+
- contact
|
|
27747
|
+
example: contact
|
|
27748
|
+
id:
|
|
27749
|
+
type: string
|
|
27750
|
+
example: e2314517-3cab-4aa9-8471-450e73449040
|
|
27751
|
+
nullable: true
|
|
27752
|
+
department:
|
|
27753
|
+
allOf:
|
|
27754
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27755
|
+
- type: object
|
|
27756
|
+
nullable: true
|
|
27757
|
+
deal:
|
|
27758
|
+
allOf:
|
|
27759
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27760
|
+
- type: object
|
|
27761
|
+
nullable: true
|
|
27762
|
+
project:
|
|
27763
|
+
allOf:
|
|
27764
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27765
|
+
- type: object
|
|
27766
|
+
nullable: true
|
|
27767
|
+
assignee:
|
|
27768
|
+
allOf:
|
|
27769
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27770
|
+
- type: object
|
|
27771
|
+
nullable: true
|
|
27772
|
+
custom_fields:
|
|
27773
|
+
type: array
|
|
27774
|
+
items:
|
|
27775
|
+
$ref: '#/components/schemas/CustomFieldsResponse'
|
|
27776
|
+
description: Only included with request parameter `includes=custom_fields`
|
|
27777
|
+
orders.listrequest:
|
|
27778
|
+
title: orders.listrequest
|
|
27779
|
+
type: object
|
|
27780
|
+
properties:
|
|
27781
|
+
filter:
|
|
27782
|
+
type: object
|
|
27783
|
+
properties:
|
|
27784
|
+
ids:
|
|
27785
|
+
type: array
|
|
27786
|
+
items:
|
|
27787
|
+
type: string
|
|
27788
|
+
includes:
|
|
27789
|
+
type: string
|
|
27790
|
+
description: Comma-separated list of optional includes
|
|
27791
|
+
example: custom_fields
|
|
27792
|
+
orders.listresponse:
|
|
27793
|
+
title: orders.listresponse
|
|
27794
|
+
type: object
|
|
27795
|
+
properties:
|
|
27796
|
+
data:
|
|
27797
|
+
type: array
|
|
27798
|
+
items:
|
|
27799
|
+
type: object
|
|
27800
|
+
properties:
|
|
27801
|
+
id:
|
|
27802
|
+
type: string
|
|
27803
|
+
example: 31b9d864-da1d-060e-9811-f683896aeb11
|
|
27804
|
+
name:
|
|
27805
|
+
type: string
|
|
27806
|
+
example: General costs
|
|
27807
|
+
order_date:
|
|
27808
|
+
type: string
|
|
27809
|
+
example: '2016-02-04'
|
|
27810
|
+
nullable: true
|
|
27811
|
+
delivery_date:
|
|
27812
|
+
type: string
|
|
27813
|
+
example: '2016-10-14'
|
|
27814
|
+
nullable: true
|
|
27815
|
+
payment_term:
|
|
27816
|
+
allOf:
|
|
27817
|
+
- $ref: '#/components/schemas/PaymentTerm'
|
|
27818
|
+
- type: object
|
|
27819
|
+
nullable: true
|
|
27820
|
+
total:
|
|
27821
|
+
type: object
|
|
27822
|
+
properties:
|
|
27823
|
+
tax_exclusive:
|
|
27824
|
+
$ref: '#/components/schemas/Money'
|
|
27825
|
+
tax_inclusive:
|
|
27826
|
+
$ref: '#/components/schemas/Money'
|
|
27827
|
+
purchase_price_tax_exclusive:
|
|
27828
|
+
allOf:
|
|
27829
|
+
- $ref: '#/components/schemas/Money'
|
|
27830
|
+
- type: object
|
|
27831
|
+
nullable: true
|
|
27832
|
+
purchase_price_tax_inclusive:
|
|
27833
|
+
allOf:
|
|
27834
|
+
- $ref: '#/components/schemas/Money'
|
|
27835
|
+
- type: object
|
|
27836
|
+
nullable: true
|
|
27837
|
+
taxes:
|
|
27838
|
+
type: array
|
|
27839
|
+
items:
|
|
27840
|
+
$ref: '#/components/schemas/Taxes'
|
|
27841
|
+
description: ''
|
|
27842
|
+
web_url:
|
|
27843
|
+
type: string
|
|
27844
|
+
example: https://focus.teamleader.eu/order_detail.php?id=31b9d864-da1d-060e-9811-f683896aeb11
|
|
27845
|
+
supplier:
|
|
27846
|
+
type: object
|
|
27847
|
+
properties:
|
|
27848
|
+
type:
|
|
27849
|
+
type: string
|
|
27850
|
+
enum:
|
|
27851
|
+
- company
|
|
27852
|
+
- contact
|
|
27853
|
+
example: contact
|
|
27854
|
+
id:
|
|
27855
|
+
type: string
|
|
27856
|
+
example: e2314517-3cab-4aa9-8471-450e73449040
|
|
27857
|
+
nullable: true
|
|
27858
|
+
department:
|
|
27859
|
+
allOf:
|
|
27860
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27861
|
+
- type: object
|
|
27862
|
+
nullable: true
|
|
27863
|
+
deal:
|
|
27864
|
+
allOf:
|
|
27865
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27866
|
+
- type: object
|
|
27867
|
+
nullable: true
|
|
27868
|
+
project:
|
|
27869
|
+
allOf:
|
|
27870
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27871
|
+
- type: object
|
|
27872
|
+
nullable: true
|
|
27873
|
+
assignee:
|
|
27874
|
+
allOf:
|
|
27875
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
27876
|
+
- type: object
|
|
27877
|
+
nullable: true
|
|
27878
|
+
custom_fields:
|
|
27879
|
+
type: array
|
|
27880
|
+
items:
|
|
27881
|
+
$ref: '#/components/schemas/CustomFieldsResponse'
|
|
27882
|
+
description: Only included with request parameter `includes=custom_fields`
|
|
27510
27883
|
WebHook:
|
|
27511
27884
|
title: WebHook
|
|
27512
27885
|
required:
|
|
@@ -27674,6 +28047,7 @@ x-tagGroups:
|
|
|
27674
28047
|
- deal_pipelines
|
|
27675
28048
|
- deal_phases
|
|
27676
28049
|
- deal_sources
|
|
28050
|
+
- orders
|
|
27677
28051
|
- quotations
|
|
27678
28052
|
- name: Calendar
|
|
27679
28053
|
tags:
|
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.10.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"
|