@ampeco/public-api-mcp 3.248.1 → 3.250.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.
- package/dist/generated/build-stats.json +9 -9
- package/dist/generated/endpoints.json +437 -57
- package/dist/generated/response-schemas.json +1741 -482
- package/dist/generated/schemas.d.ts +132 -24
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +45 -12
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +50 -12
- package/package.json +1 -1
|
@@ -680,7 +680,7 @@
|
|
|
680
680
|
},
|
|
681
681
|
"fileName": {
|
|
682
682
|
"type": "string",
|
|
683
|
-
"description": "The file name that will be uploaded to the location
|
|
683
|
+
"description": "The file name that will be uploaded to the destination used for this request - either the location supplied in the request or the destination configured on the charge point's operator"
|
|
684
684
|
}
|
|
685
685
|
}
|
|
686
686
|
}
|
|
@@ -716,6 +716,19 @@
|
|
|
716
716
|
}
|
|
717
717
|
}
|
|
718
718
|
},
|
|
719
|
+
"412": {
|
|
720
|
+
"schema": {
|
|
721
|
+
"type": "object",
|
|
722
|
+
"required": [
|
|
723
|
+
"message"
|
|
724
|
+
],
|
|
725
|
+
"properties": {
|
|
726
|
+
"message": {
|
|
727
|
+
"type": "string"
|
|
728
|
+
}
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
},
|
|
719
732
|
"422": {
|
|
720
733
|
"schema": {
|
|
721
734
|
"type": "object",
|
|
@@ -4528,7 +4541,7 @@
|
|
|
4528
4541
|
},
|
|
4529
4542
|
"downloadUrl": {
|
|
4530
4543
|
"type": "string",
|
|
4531
|
-
"description": "The invoice can be downloaded from here. The link expires in 24 hours."
|
|
4544
|
+
"description": "The invoice can be downloaded from here. The link expires in 24 hours. Omitted while a fiscalized invoice has no valid customer-facing representation."
|
|
4532
4545
|
},
|
|
4533
4546
|
"paymentStatus": {
|
|
4534
4547
|
"type": "string",
|
|
@@ -10388,7 +10401,7 @@
|
|
|
10388
10401
|
"ga-IE",
|
|
10389
10402
|
"bs",
|
|
10390
10403
|
"ja",
|
|
10391
|
-
"ko",
|
|
10404
|
+
"ko-KR",
|
|
10392
10405
|
"cs",
|
|
10393
10406
|
"lv",
|
|
10394
10407
|
"et",
|
|
@@ -66781,7 +66794,7 @@
|
|
|
66781
66794
|
},
|
|
66782
66795
|
"downloadUrl": {
|
|
66783
66796
|
"type": "string",
|
|
66784
|
-
"description": "The invoice can be downloaded from here. The link expires in 24 hours."
|
|
66797
|
+
"description": "The invoice can be downloaded from here. The link expires in 24 hours. Omitted while a fiscalized invoice has no valid customer-facing representation."
|
|
66785
66798
|
},
|
|
66786
66799
|
"paymentStatus": {
|
|
66787
66800
|
"type": "string",
|
|
@@ -67614,7 +67627,7 @@
|
|
|
67614
67627
|
},
|
|
67615
67628
|
"downloadUrl": {
|
|
67616
67629
|
"type": "string",
|
|
67617
|
-
"description": "The invoice can be downloaded from here. The link expires in 24 hours."
|
|
67630
|
+
"description": "The invoice can be downloaded from here. The link expires in 24 hours. Omitted while a fiscalized invoice has no valid customer-facing representation."
|
|
67618
67631
|
},
|
|
67619
67632
|
"paymentStatus": {
|
|
67620
67633
|
"type": "string",
|
|
@@ -83300,6 +83313,90 @@
|
|
|
83300
83313
|
"format": "date-time",
|
|
83301
83314
|
"description": "ISO 8601 formatted date",
|
|
83302
83315
|
"readOnly": true
|
|
83316
|
+
},
|
|
83317
|
+
"settlementOverrides": {
|
|
83318
|
+
"type": "array",
|
|
83319
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
83320
|
+
"items": {
|
|
83321
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
83322
|
+
"type": "object",
|
|
83323
|
+
"required": [
|
|
83324
|
+
"id",
|
|
83325
|
+
"name",
|
|
83326
|
+
"priority",
|
|
83327
|
+
"restriction",
|
|
83328
|
+
"acPercent",
|
|
83329
|
+
"dcPercent"
|
|
83330
|
+
],
|
|
83331
|
+
"properties": {
|
|
83332
|
+
"name": {
|
|
83333
|
+
"type": "string",
|
|
83334
|
+
"maxLength": 255,
|
|
83335
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
83336
|
+
"example": "Fleet drivers"
|
|
83337
|
+
},
|
|
83338
|
+
"priority": {
|
|
83339
|
+
"type": "integer",
|
|
83340
|
+
"minimum": 1,
|
|
83341
|
+
"maximum": 4294967295,
|
|
83342
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
83343
|
+
"example": 1
|
|
83344
|
+
},
|
|
83345
|
+
"id": {
|
|
83346
|
+
"type": "integer",
|
|
83347
|
+
"description": "Unique identifier for the settlement override",
|
|
83348
|
+
"example": 123
|
|
83349
|
+
},
|
|
83350
|
+
"restriction": {
|
|
83351
|
+
"type": "object",
|
|
83352
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
83353
|
+
"required": [
|
|
83354
|
+
"type"
|
|
83355
|
+
],
|
|
83356
|
+
"properties": {
|
|
83357
|
+
"type": {
|
|
83358
|
+
"type": "string",
|
|
83359
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
83360
|
+
"enum": [
|
|
83361
|
+
"users_of_the_partner",
|
|
83362
|
+
"user_groups",
|
|
83363
|
+
"ad_hoc_users",
|
|
83364
|
+
"users_of_specific_partners"
|
|
83365
|
+
]
|
|
83366
|
+
},
|
|
83367
|
+
"targetIds": {
|
|
83368
|
+
"type": "array",
|
|
83369
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
83370
|
+
"items": {
|
|
83371
|
+
"type": "integer"
|
|
83372
|
+
},
|
|
83373
|
+
"example": [
|
|
83374
|
+
12,
|
|
83375
|
+
34
|
|
83376
|
+
]
|
|
83377
|
+
}
|
|
83378
|
+
}
|
|
83379
|
+
},
|
|
83380
|
+
"acPercent": {
|
|
83381
|
+
"type": "number",
|
|
83382
|
+
"format": "float",
|
|
83383
|
+
"nullable": true,
|
|
83384
|
+
"minimum": 0,
|
|
83385
|
+
"maximum": 100,
|
|
83386
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83387
|
+
"example": 70.5
|
|
83388
|
+
},
|
|
83389
|
+
"dcPercent": {
|
|
83390
|
+
"type": "number",
|
|
83391
|
+
"format": "float",
|
|
83392
|
+
"nullable": true,
|
|
83393
|
+
"minimum": 0,
|
|
83394
|
+
"maximum": 100,
|
|
83395
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83396
|
+
"example": 60
|
|
83397
|
+
}
|
|
83398
|
+
}
|
|
83399
|
+
}
|
|
83303
83400
|
}
|
|
83304
83401
|
},
|
|
83305
83402
|
"required": [
|
|
@@ -83647,260 +83744,428 @@
|
|
|
83647
83744
|
"format": "date-time",
|
|
83648
83745
|
"description": "ISO 8601 formatted date",
|
|
83649
83746
|
"readOnly": true
|
|
83650
|
-
}
|
|
83651
|
-
},
|
|
83652
|
-
"required": [
|
|
83653
|
-
"id",
|
|
83654
|
-
"operatorId",
|
|
83655
|
-
"title",
|
|
83656
|
-
"partnerId",
|
|
83657
|
-
"startDate"
|
|
83658
|
-
]
|
|
83659
|
-
}
|
|
83660
|
-
}
|
|
83661
|
-
}
|
|
83662
|
-
},
|
|
83663
|
-
"401": {
|
|
83664
|
-
"schema": {
|
|
83665
|
-
"type": "object",
|
|
83666
|
-
"properties": {
|
|
83667
|
-
"message": {
|
|
83668
|
-
"type": "string"
|
|
83669
|
-
}
|
|
83670
|
-
}
|
|
83671
|
-
}
|
|
83672
|
-
},
|
|
83673
|
-
"403": {
|
|
83674
|
-
"schema": {
|
|
83675
|
-
"type": "object",
|
|
83676
|
-
"properties": {
|
|
83677
|
-
"message": {
|
|
83678
|
-
"type": "string",
|
|
83679
|
-
"default": "This action is unauthorized."
|
|
83680
|
-
}
|
|
83681
|
-
}
|
|
83682
|
-
}
|
|
83683
|
-
},
|
|
83684
|
-
"422": {
|
|
83685
|
-
"schema": {
|
|
83686
|
-
"type": "object",
|
|
83687
|
-
"required": [
|
|
83688
|
-
"message"
|
|
83689
|
-
],
|
|
83690
|
-
"properties": {
|
|
83691
|
-
"message": {
|
|
83692
|
-
"type": "string"
|
|
83693
|
-
},
|
|
83694
|
-
"errors": {
|
|
83695
|
-
"type": "object",
|
|
83696
|
-
"additionalProperties": {
|
|
83697
|
-
"type": "array",
|
|
83698
|
-
"items": {
|
|
83699
|
-
"type": "string"
|
|
83700
|
-
}
|
|
83701
|
-
}
|
|
83702
|
-
}
|
|
83703
|
-
}
|
|
83704
|
-
}
|
|
83705
|
-
},
|
|
83706
|
-
"429": {
|
|
83707
|
-
"schema": {
|
|
83708
|
-
"type": "object",
|
|
83709
|
-
"properties": {
|
|
83710
|
-
"message": {
|
|
83711
|
-
"type": "string"
|
|
83712
|
-
}
|
|
83713
|
-
}
|
|
83714
|
-
}
|
|
83715
|
-
}
|
|
83716
|
-
},
|
|
83717
|
-
"partnerContractRead": {
|
|
83718
|
-
"200": {
|
|
83719
|
-
"schema": {
|
|
83720
|
-
"type": "object",
|
|
83721
|
-
"properties": {
|
|
83722
|
-
"data": {
|
|
83723
|
-
"type": "object",
|
|
83724
|
-
"properties": {
|
|
83725
|
-
"id": {
|
|
83726
|
-
"type": "integer",
|
|
83727
|
-
"readOnly": true
|
|
83728
|
-
},
|
|
83729
|
-
"operatorId": {
|
|
83730
|
-
"type": "integer",
|
|
83731
|
-
"description": "The ID of the operator this resource belongs to",
|
|
83732
|
-
"example": 1
|
|
83733
|
-
},
|
|
83734
|
-
"title": {
|
|
83735
|
-
"type": "string"
|
|
83736
|
-
},
|
|
83737
|
-
"partnerId": {
|
|
83738
|
-
"type": "integer"
|
|
83739
|
-
},
|
|
83740
|
-
"contractType": {
|
|
83741
|
-
"type": "string",
|
|
83742
|
-
"enum": [
|
|
83743
|
-
"revenueSharing",
|
|
83744
|
-
"paymentFacilitation"
|
|
83745
|
-
],
|
|
83746
|
-
"description": "Indicates the business relationship model for the contract. `revenueSharing` means the operator is the supplier and remits a share to the partner. `paymentFacilitation` means the partner is the supplier and the operator acts as payment facilitator."
|
|
83747
83747
|
},
|
|
83748
|
-
"
|
|
83749
|
-
"type": "
|
|
83750
|
-
"
|
|
83751
|
-
"
|
|
83752
|
-
|
|
83753
|
-
|
|
83754
|
-
|
|
83755
|
-
|
|
83756
|
-
|
|
83757
|
-
|
|
83758
|
-
|
|
83759
|
-
|
|
83760
|
-
|
|
83761
|
-
|
|
83762
|
-
|
|
83763
|
-
|
|
83764
|
-
|
|
83765
|
-
|
|
83766
|
-
|
|
83767
|
-
|
|
83768
|
-
|
|
83769
|
-
|
|
83770
|
-
|
|
83771
|
-
|
|
83772
|
-
|
|
83773
|
-
|
|
83774
|
-
|
|
83775
|
-
|
|
83776
|
-
"
|
|
83777
|
-
|
|
83778
|
-
|
|
83779
|
-
|
|
83780
|
-
|
|
83781
|
-
|
|
83782
|
-
|
|
83783
|
-
|
|
83784
|
-
|
|
83785
|
-
|
|
83786
|
-
|
|
83787
|
-
|
|
83788
|
-
|
|
83789
|
-
|
|
83790
|
-
|
|
83791
|
-
|
|
83792
|
-
|
|
83793
|
-
|
|
83794
|
-
|
|
83795
|
-
|
|
83796
|
-
|
|
83797
|
-
|
|
83798
|
-
|
|
83799
|
-
|
|
83800
|
-
|
|
83801
|
-
|
|
83802
|
-
|
|
83803
|
-
|
|
83804
|
-
|
|
83805
|
-
|
|
83806
|
-
|
|
83807
|
-
|
|
83808
|
-
|
|
83809
|
-
|
|
83810
|
-
|
|
83811
|
-
"
|
|
83812
|
-
|
|
83813
|
-
|
|
83814
|
-
|
|
83815
|
-
|
|
83816
|
-
|
|
83817
|
-
|
|
83818
|
-
|
|
83819
|
-
|
|
83820
|
-
"
|
|
83821
|
-
|
|
83822
|
-
|
|
83823
|
-
|
|
83824
|
-
|
|
83825
|
-
|
|
83826
|
-
|
|
83827
|
-
|
|
83828
|
-
|
|
83829
|
-
|
|
83830
|
-
|
|
83831
|
-
|
|
83832
|
-
|
|
83833
|
-
|
|
83834
|
-
|
|
83835
|
-
|
|
83836
|
-
|
|
83837
|
-
|
|
83838
|
-
|
|
83839
|
-
|
|
83840
|
-
|
|
83841
|
-
|
|
83842
|
-
|
|
83843
|
-
|
|
83844
|
-
|
|
83845
|
-
|
|
83846
|
-
|
|
83847
|
-
|
|
83848
|
-
|
|
83849
|
-
|
|
83850
|
-
|
|
83851
|
-
|
|
83852
|
-
|
|
83853
|
-
|
|
83854
|
-
|
|
83855
|
-
|
|
83856
|
-
|
|
83857
|
-
|
|
83858
|
-
|
|
83859
|
-
|
|
83860
|
-
|
|
83861
|
-
|
|
83862
|
-
|
|
83863
|
-
|
|
83864
|
-
|
|
83865
|
-
|
|
83866
|
-
|
|
83867
|
-
|
|
83868
|
-
|
|
83869
|
-
|
|
83870
|
-
|
|
83871
|
-
|
|
83872
|
-
|
|
83873
|
-
|
|
83874
|
-
|
|
83875
|
-
|
|
83876
|
-
|
|
83877
|
-
|
|
83878
|
-
|
|
83879
|
-
|
|
83880
|
-
|
|
83881
|
-
|
|
83882
|
-
|
|
83883
|
-
|
|
83884
|
-
|
|
83885
|
-
|
|
83886
|
-
|
|
83887
|
-
|
|
83888
|
-
|
|
83889
|
-
|
|
83890
|
-
|
|
83891
|
-
|
|
83892
|
-
|
|
83893
|
-
|
|
83894
|
-
|
|
83895
|
-
|
|
83748
|
+
"settlementOverrides": {
|
|
83749
|
+
"type": "array",
|
|
83750
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
83751
|
+
"items": {
|
|
83752
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
83753
|
+
"type": "object",
|
|
83754
|
+
"required": [
|
|
83755
|
+
"id",
|
|
83756
|
+
"name",
|
|
83757
|
+
"priority",
|
|
83758
|
+
"restriction",
|
|
83759
|
+
"acPercent",
|
|
83760
|
+
"dcPercent"
|
|
83761
|
+
],
|
|
83762
|
+
"properties": {
|
|
83763
|
+
"name": {
|
|
83764
|
+
"type": "string",
|
|
83765
|
+
"maxLength": 255,
|
|
83766
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
83767
|
+
"example": "Fleet drivers"
|
|
83768
|
+
},
|
|
83769
|
+
"priority": {
|
|
83770
|
+
"type": "integer",
|
|
83771
|
+
"minimum": 1,
|
|
83772
|
+
"maximum": 4294967295,
|
|
83773
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
83774
|
+
"example": 1
|
|
83775
|
+
},
|
|
83776
|
+
"id": {
|
|
83777
|
+
"type": "integer",
|
|
83778
|
+
"description": "Unique identifier for the settlement override",
|
|
83779
|
+
"example": 123
|
|
83780
|
+
},
|
|
83781
|
+
"restriction": {
|
|
83782
|
+
"type": "object",
|
|
83783
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
83784
|
+
"required": [
|
|
83785
|
+
"type"
|
|
83786
|
+
],
|
|
83787
|
+
"properties": {
|
|
83788
|
+
"type": {
|
|
83789
|
+
"type": "string",
|
|
83790
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
83791
|
+
"enum": [
|
|
83792
|
+
"users_of_the_partner",
|
|
83793
|
+
"user_groups",
|
|
83794
|
+
"ad_hoc_users",
|
|
83795
|
+
"users_of_specific_partners"
|
|
83796
|
+
]
|
|
83797
|
+
},
|
|
83798
|
+
"targetIds": {
|
|
83799
|
+
"type": "array",
|
|
83800
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
83801
|
+
"items": {
|
|
83802
|
+
"type": "integer"
|
|
83803
|
+
},
|
|
83804
|
+
"example": [
|
|
83805
|
+
12,
|
|
83806
|
+
34
|
|
83807
|
+
]
|
|
83808
|
+
}
|
|
83809
|
+
}
|
|
83810
|
+
},
|
|
83811
|
+
"acPercent": {
|
|
83812
|
+
"type": "number",
|
|
83813
|
+
"format": "float",
|
|
83814
|
+
"nullable": true,
|
|
83815
|
+
"minimum": 0,
|
|
83816
|
+
"maximum": 100,
|
|
83817
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83818
|
+
"example": 70.5
|
|
83819
|
+
},
|
|
83820
|
+
"dcPercent": {
|
|
83821
|
+
"type": "number",
|
|
83822
|
+
"format": "float",
|
|
83823
|
+
"nullable": true,
|
|
83824
|
+
"minimum": 0,
|
|
83825
|
+
"maximum": 100,
|
|
83826
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83827
|
+
"example": 60
|
|
83828
|
+
}
|
|
83829
|
+
}
|
|
83830
|
+
}
|
|
83831
|
+
}
|
|
83832
|
+
},
|
|
83833
|
+
"required": [
|
|
83834
|
+
"id",
|
|
83835
|
+
"operatorId",
|
|
83836
|
+
"title",
|
|
83837
|
+
"partnerId",
|
|
83838
|
+
"startDate"
|
|
83839
|
+
]
|
|
83840
|
+
}
|
|
83841
|
+
}
|
|
83842
|
+
}
|
|
83843
|
+
},
|
|
83844
|
+
"401": {
|
|
83845
|
+
"schema": {
|
|
83846
|
+
"type": "object",
|
|
83847
|
+
"properties": {
|
|
83848
|
+
"message": {
|
|
83849
|
+
"type": "string"
|
|
83850
|
+
}
|
|
83851
|
+
}
|
|
83852
|
+
}
|
|
83853
|
+
},
|
|
83854
|
+
"403": {
|
|
83855
|
+
"schema": {
|
|
83856
|
+
"type": "object",
|
|
83857
|
+
"properties": {
|
|
83858
|
+
"message": {
|
|
83859
|
+
"type": "string",
|
|
83860
|
+
"default": "This action is unauthorized."
|
|
83861
|
+
}
|
|
83862
|
+
}
|
|
83863
|
+
}
|
|
83864
|
+
},
|
|
83865
|
+
"422": {
|
|
83866
|
+
"schema": {
|
|
83867
|
+
"type": "object",
|
|
83868
|
+
"required": [
|
|
83869
|
+
"message"
|
|
83870
|
+
],
|
|
83871
|
+
"properties": {
|
|
83872
|
+
"message": {
|
|
83873
|
+
"type": "string"
|
|
83874
|
+
},
|
|
83875
|
+
"errors": {
|
|
83876
|
+
"type": "object",
|
|
83877
|
+
"additionalProperties": {
|
|
83878
|
+
"type": "array",
|
|
83879
|
+
"items": {
|
|
83880
|
+
"type": "string"
|
|
83881
|
+
}
|
|
83882
|
+
}
|
|
83883
|
+
}
|
|
83884
|
+
}
|
|
83885
|
+
}
|
|
83886
|
+
},
|
|
83887
|
+
"429": {
|
|
83888
|
+
"schema": {
|
|
83889
|
+
"type": "object",
|
|
83890
|
+
"properties": {
|
|
83891
|
+
"message": {
|
|
83892
|
+
"type": "string"
|
|
83893
|
+
}
|
|
83894
|
+
}
|
|
83895
|
+
}
|
|
83896
|
+
}
|
|
83897
|
+
},
|
|
83898
|
+
"partnerContractRead": {
|
|
83899
|
+
"200": {
|
|
83900
|
+
"schema": {
|
|
83901
|
+
"type": "object",
|
|
83902
|
+
"properties": {
|
|
83903
|
+
"data": {
|
|
83904
|
+
"type": "object",
|
|
83905
|
+
"properties": {
|
|
83906
|
+
"id": {
|
|
83907
|
+
"type": "integer",
|
|
83908
|
+
"readOnly": true
|
|
83909
|
+
},
|
|
83910
|
+
"operatorId": {
|
|
83911
|
+
"type": "integer",
|
|
83912
|
+
"description": "The ID of the operator this resource belongs to",
|
|
83913
|
+
"example": 1
|
|
83914
|
+
},
|
|
83915
|
+
"title": {
|
|
83916
|
+
"type": "string"
|
|
83917
|
+
},
|
|
83918
|
+
"partnerId": {
|
|
83919
|
+
"type": "integer"
|
|
83920
|
+
},
|
|
83921
|
+
"contractType": {
|
|
83922
|
+
"type": "string",
|
|
83923
|
+
"enum": [
|
|
83924
|
+
"revenueSharing",
|
|
83925
|
+
"paymentFacilitation"
|
|
83926
|
+
],
|
|
83927
|
+
"description": "Indicates the business relationship model for the contract. `revenueSharing` means the operator is the supplier and remits a share to the partner. `paymentFacilitation` means the partner is the supplier and the operator acts as payment facilitator."
|
|
83928
|
+
},
|
|
83929
|
+
"startDate": {
|
|
83930
|
+
"type": "string",
|
|
83931
|
+
"format": "date-time",
|
|
83932
|
+
"description": "The contract is effective from the first of the selected month."
|
|
83933
|
+
},
|
|
83934
|
+
"endDate": {
|
|
83935
|
+
"type": "string",
|
|
83936
|
+
"format": "date-time",
|
|
83937
|
+
"nullable": true,
|
|
83938
|
+
"description": "The contract expires at the last day of the selected month. If nothing is selected, there is no expiration date."
|
|
83939
|
+
},
|
|
83940
|
+
"autoRenewal": {
|
|
83941
|
+
"type": "boolean"
|
|
83942
|
+
},
|
|
83943
|
+
"externalId": {
|
|
83944
|
+
"type": "string",
|
|
83945
|
+
"description": "Used to store custom information, usually used for external references or metadata to the resource.",
|
|
83946
|
+
"maxLength": 255
|
|
83947
|
+
},
|
|
83948
|
+
"accessAndPermissions": {
|
|
83949
|
+
"type": "object",
|
|
83950
|
+
"properties": {
|
|
83951
|
+
"sessionsRemoteControl": {
|
|
83952
|
+
"type": "boolean",
|
|
83953
|
+
"description": "Allows the partner to start/stop session, unlock connector, trigger message, set a charging profile and get the composite schedule."
|
|
83954
|
+
},
|
|
83955
|
+
"startReservation": {
|
|
83956
|
+
"type": "boolean",
|
|
83957
|
+
"description": "Allows the partner to make reservations."
|
|
83958
|
+
},
|
|
83959
|
+
"stopReservation": {
|
|
83960
|
+
"type": "boolean",
|
|
83961
|
+
"description": "Allows the partner to cancel reservations."
|
|
83962
|
+
},
|
|
83963
|
+
"resetChargePoint": {
|
|
83964
|
+
"type": "boolean",
|
|
83965
|
+
"description": "Allows the partner to reset charge points."
|
|
83966
|
+
},
|
|
83967
|
+
"firmwareUpdate": {
|
|
83968
|
+
"type": "boolean",
|
|
83969
|
+
"description": "Allows the partner to make firmware updates to the charge points."
|
|
83970
|
+
},
|
|
83971
|
+
"createFromTemplate": {
|
|
83972
|
+
"type": "boolean",
|
|
83973
|
+
"description": "Allows the partner to create charge points from templates."
|
|
83974
|
+
},
|
|
83975
|
+
"changeSystemStatus": {
|
|
83976
|
+
"type": "boolean",
|
|
83977
|
+
"description": "Allows the partner to change the system status of charge points."
|
|
83978
|
+
}
|
|
83979
|
+
}
|
|
83980
|
+
},
|
|
83981
|
+
"revenueSharing": {
|
|
83982
|
+
"type": "object",
|
|
83983
|
+
"properties": {
|
|
83984
|
+
"partnerSharePercentageAcEvse": {
|
|
83985
|
+
"type": "number",
|
|
83986
|
+
"format": "float",
|
|
83987
|
+
"minimum": 0,
|
|
83988
|
+
"maximum": 100
|
|
83989
|
+
},
|
|
83990
|
+
"partnerSharePercentageDcEvse": {
|
|
83991
|
+
"type": "number",
|
|
83992
|
+
"format": "float",
|
|
83993
|
+
"minimum": 0,
|
|
83994
|
+
"maximum": 100
|
|
83995
|
+
},
|
|
83996
|
+
"excludeConnectionFee": {
|
|
83997
|
+
"type": "boolean",
|
|
83998
|
+
"description": "If the tariff has a Connection fee, this fee would not be included in the revenue sharing with the Partner and will remain entirely for the Operator."
|
|
83999
|
+
},
|
|
84000
|
+
"deductElectricityCost": {
|
|
84001
|
+
"type": "boolean",
|
|
84002
|
+
"description": "The cost of the electricity would first be deducted from the collected revenue and then the Revenue sharing rules will be applied."
|
|
84003
|
+
},
|
|
84004
|
+
"reimburseForElectricityCost": {
|
|
84005
|
+
"type": "boolean",
|
|
84006
|
+
"description": "If set to true, the Partner would receive not only their share of the revenue but also a reimbursement for the cost of the electricity. The formula to calculate the amount to be received by the Partner is (Revenue - Electricity cost) x Partner percentage + Electricity cost. It could be supplied only if deductElectricityCost is set to true."
|
|
84007
|
+
},
|
|
84008
|
+
"fixedFeePerSessionAc": {
|
|
84009
|
+
"type": "number",
|
|
84010
|
+
"format": "float",
|
|
84011
|
+
"nullable": true,
|
|
84012
|
+
"description": "Additional flat fee that is applied for every billed session and subtracted from the Partner's share of the revenue for each session on AC Charging Station."
|
|
84013
|
+
},
|
|
84014
|
+
"fixedFeePerSessionDc": {
|
|
84015
|
+
"type": "number",
|
|
84016
|
+
"format": "float",
|
|
84017
|
+
"nullable": true,
|
|
84018
|
+
"description": "Additional flat fee that is applied for every billed session and subtracted from the Partner's share of the revenue for each session on DC Charging Station."
|
|
84019
|
+
},
|
|
84020
|
+
"feePerKwhAc": {
|
|
84021
|
+
"type": "number",
|
|
84022
|
+
"format": "float",
|
|
84023
|
+
"nullable": true,
|
|
84024
|
+
"description": "Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on AC Charging Station."
|
|
84025
|
+
},
|
|
84026
|
+
"feePerKwhDc": {
|
|
84027
|
+
"type": "number",
|
|
84028
|
+
"format": "float",
|
|
84029
|
+
"nullable": true,
|
|
84030
|
+
"description": "Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on DC Charging Station."
|
|
84031
|
+
},
|
|
84032
|
+
"handlingFee": {
|
|
84033
|
+
"type": "number",
|
|
84034
|
+
"format": "float",
|
|
84035
|
+
"minimum": 0,
|
|
84036
|
+
"maximum": 100,
|
|
84037
|
+
"nullable": true,
|
|
84038
|
+
"description": "Additional percentage fee to be applied on the total amount paid by the user for the session. This fee is then subtracted from the Partner's share of the revenue."
|
|
84039
|
+
}
|
|
84040
|
+
}
|
|
84041
|
+
},
|
|
84042
|
+
"monthlyPlatformFees": {
|
|
84043
|
+
"type": "object",
|
|
84044
|
+
"properties": {
|
|
84045
|
+
"perChargePoint": {
|
|
84046
|
+
"type": "number",
|
|
84047
|
+
"format": "float",
|
|
84048
|
+
"description": "The provided amount should be excluding VAT."
|
|
84049
|
+
},
|
|
84050
|
+
"perAcEvse": {
|
|
84051
|
+
"type": "number",
|
|
84052
|
+
"format": "float",
|
|
84053
|
+
"description": "The provided amount should be excluding VAT."
|
|
84054
|
+
},
|
|
84055
|
+
"perDcEvse": {
|
|
84056
|
+
"type": "number",
|
|
84057
|
+
"format": "float",
|
|
84058
|
+
"description": "The provided amount should be excluding VAT."
|
|
84059
|
+
}
|
|
84060
|
+
}
|
|
84061
|
+
},
|
|
84062
|
+
"reimbursementFees": {
|
|
84063
|
+
"type": "object",
|
|
84064
|
+
"description": "Home-charging reimbursement fees configured on the contract itself and charged to the partner for reimbursed charging sessions and reimbursement periods. Only available when the home-charging reimbursement feature is enabled for the operator. All other home-charging reimbursement settings are managed on the partner resource.\n",
|
|
84065
|
+
"properties": {
|
|
84066
|
+
"perSession": {
|
|
84067
|
+
"type": "number",
|
|
84068
|
+
"format": "float",
|
|
84069
|
+
"minimum": 0,
|
|
84070
|
+
"description": "Flat fee charged for every reimbursed charging session, in the contract's currency."
|
|
84071
|
+
},
|
|
84072
|
+
"perPeriod": {
|
|
84073
|
+
"type": "number",
|
|
84074
|
+
"format": "float",
|
|
84075
|
+
"minimum": 0,
|
|
84076
|
+
"description": "Flat fee charged for every reimbursement period, in the contract's currency."
|
|
84077
|
+
}
|
|
84078
|
+
}
|
|
84079
|
+
},
|
|
84080
|
+
"lastUpdatedAt": {
|
|
84081
|
+
"type": "string",
|
|
84082
|
+
"format": "date-time",
|
|
84083
|
+
"description": "ISO 8601 formatted date",
|
|
84084
|
+
"readOnly": true
|
|
84085
|
+
},
|
|
84086
|
+
"settlementOverrides": {
|
|
84087
|
+
"type": "array",
|
|
84088
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
84089
|
+
"items": {
|
|
84090
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84091
|
+
"type": "object",
|
|
84092
|
+
"required": [
|
|
84093
|
+
"id",
|
|
84094
|
+
"name",
|
|
84095
|
+
"priority",
|
|
84096
|
+
"restriction",
|
|
84097
|
+
"acPercent",
|
|
84098
|
+
"dcPercent"
|
|
84099
|
+
],
|
|
84100
|
+
"properties": {
|
|
84101
|
+
"name": {
|
|
84102
|
+
"type": "string",
|
|
84103
|
+
"maxLength": 255,
|
|
84104
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84105
|
+
"example": "Fleet drivers"
|
|
84106
|
+
},
|
|
84107
|
+
"priority": {
|
|
84108
|
+
"type": "integer",
|
|
84109
|
+
"minimum": 1,
|
|
84110
|
+
"maximum": 4294967295,
|
|
84111
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84112
|
+
"example": 1
|
|
84113
|
+
},
|
|
84114
|
+
"id": {
|
|
84115
|
+
"type": "integer",
|
|
84116
|
+
"description": "Unique identifier for the settlement override",
|
|
84117
|
+
"example": 123
|
|
84118
|
+
},
|
|
84119
|
+
"restriction": {
|
|
84120
|
+
"type": "object",
|
|
84121
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84122
|
+
"required": [
|
|
84123
|
+
"type"
|
|
84124
|
+
],
|
|
84125
|
+
"properties": {
|
|
84126
|
+
"type": {
|
|
84127
|
+
"type": "string",
|
|
84128
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84129
|
+
"enum": [
|
|
84130
|
+
"users_of_the_partner",
|
|
84131
|
+
"user_groups",
|
|
84132
|
+
"ad_hoc_users",
|
|
84133
|
+
"users_of_specific_partners"
|
|
84134
|
+
]
|
|
84135
|
+
},
|
|
84136
|
+
"targetIds": {
|
|
84137
|
+
"type": "array",
|
|
84138
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84139
|
+
"items": {
|
|
84140
|
+
"type": "integer"
|
|
84141
|
+
},
|
|
84142
|
+
"example": [
|
|
84143
|
+
12,
|
|
84144
|
+
34
|
|
84145
|
+
]
|
|
84146
|
+
}
|
|
84147
|
+
}
|
|
84148
|
+
},
|
|
84149
|
+
"acPercent": {
|
|
84150
|
+
"type": "number",
|
|
84151
|
+
"format": "float",
|
|
84152
|
+
"nullable": true,
|
|
84153
|
+
"minimum": 0,
|
|
84154
|
+
"maximum": 100,
|
|
84155
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84156
|
+
"example": 70.5
|
|
84157
|
+
},
|
|
84158
|
+
"dcPercent": {
|
|
84159
|
+
"type": "number",
|
|
84160
|
+
"format": "float",
|
|
84161
|
+
"nullable": true,
|
|
84162
|
+
"minimum": 0,
|
|
84163
|
+
"maximum": 100,
|
|
84164
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84165
|
+
"example": 60
|
|
84166
|
+
}
|
|
83896
84167
|
}
|
|
83897
84168
|
}
|
|
83898
|
-
},
|
|
83899
|
-
"lastUpdatedAt": {
|
|
83900
|
-
"type": "string",
|
|
83901
|
-
"format": "date-time",
|
|
83902
|
-
"description": "ISO 8601 formatted date",
|
|
83903
|
-
"readOnly": true
|
|
83904
84169
|
}
|
|
83905
84170
|
},
|
|
83906
84171
|
"required": [
|
|
@@ -84143,6 +84408,90 @@
|
|
|
84143
84408
|
"format": "date-time",
|
|
84144
84409
|
"description": "ISO 8601 formatted date",
|
|
84145
84410
|
"readOnly": true
|
|
84411
|
+
},
|
|
84412
|
+
"settlementOverrides": {
|
|
84413
|
+
"type": "array",
|
|
84414
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
84415
|
+
"items": {
|
|
84416
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84417
|
+
"type": "object",
|
|
84418
|
+
"required": [
|
|
84419
|
+
"id",
|
|
84420
|
+
"name",
|
|
84421
|
+
"priority",
|
|
84422
|
+
"restriction",
|
|
84423
|
+
"acPercent",
|
|
84424
|
+
"dcPercent"
|
|
84425
|
+
],
|
|
84426
|
+
"properties": {
|
|
84427
|
+
"name": {
|
|
84428
|
+
"type": "string",
|
|
84429
|
+
"maxLength": 255,
|
|
84430
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84431
|
+
"example": "Fleet drivers"
|
|
84432
|
+
},
|
|
84433
|
+
"priority": {
|
|
84434
|
+
"type": "integer",
|
|
84435
|
+
"minimum": 1,
|
|
84436
|
+
"maximum": 4294967295,
|
|
84437
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84438
|
+
"example": 1
|
|
84439
|
+
},
|
|
84440
|
+
"id": {
|
|
84441
|
+
"type": "integer",
|
|
84442
|
+
"description": "Unique identifier for the settlement override",
|
|
84443
|
+
"example": 123
|
|
84444
|
+
},
|
|
84445
|
+
"restriction": {
|
|
84446
|
+
"type": "object",
|
|
84447
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84448
|
+
"required": [
|
|
84449
|
+
"type"
|
|
84450
|
+
],
|
|
84451
|
+
"properties": {
|
|
84452
|
+
"type": {
|
|
84453
|
+
"type": "string",
|
|
84454
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84455
|
+
"enum": [
|
|
84456
|
+
"users_of_the_partner",
|
|
84457
|
+
"user_groups",
|
|
84458
|
+
"ad_hoc_users",
|
|
84459
|
+
"users_of_specific_partners"
|
|
84460
|
+
]
|
|
84461
|
+
},
|
|
84462
|
+
"targetIds": {
|
|
84463
|
+
"type": "array",
|
|
84464
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84465
|
+
"items": {
|
|
84466
|
+
"type": "integer"
|
|
84467
|
+
},
|
|
84468
|
+
"example": [
|
|
84469
|
+
12,
|
|
84470
|
+
34
|
|
84471
|
+
]
|
|
84472
|
+
}
|
|
84473
|
+
}
|
|
84474
|
+
},
|
|
84475
|
+
"acPercent": {
|
|
84476
|
+
"type": "number",
|
|
84477
|
+
"format": "float",
|
|
84478
|
+
"nullable": true,
|
|
84479
|
+
"minimum": 0,
|
|
84480
|
+
"maximum": 100,
|
|
84481
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84482
|
+
"example": 70.5
|
|
84483
|
+
},
|
|
84484
|
+
"dcPercent": {
|
|
84485
|
+
"type": "number",
|
|
84486
|
+
"format": "float",
|
|
84487
|
+
"nullable": true,
|
|
84488
|
+
"minimum": 0,
|
|
84489
|
+
"maximum": 100,
|
|
84490
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84491
|
+
"example": 60
|
|
84492
|
+
}
|
|
84493
|
+
}
|
|
84494
|
+
}
|
|
84146
84495
|
}
|
|
84147
84496
|
},
|
|
84148
84497
|
"required": [
|
|
@@ -84232,7 +84581,1041 @@
|
|
|
84232
84581
|
}
|
|
84233
84582
|
}
|
|
84234
84583
|
},
|
|
84235
|
-
"429": {
|
|
84584
|
+
"429": {
|
|
84585
|
+
"schema": {
|
|
84586
|
+
"type": "object",
|
|
84587
|
+
"properties": {
|
|
84588
|
+
"message": {
|
|
84589
|
+
"type": "string"
|
|
84590
|
+
}
|
|
84591
|
+
}
|
|
84592
|
+
}
|
|
84593
|
+
}
|
|
84594
|
+
},
|
|
84595
|
+
"partnerContractPatch": {
|
|
84596
|
+
"200": {
|
|
84597
|
+
"schema": {
|
|
84598
|
+
"type": "object",
|
|
84599
|
+
"properties": {
|
|
84600
|
+
"data": {
|
|
84601
|
+
"type": "object",
|
|
84602
|
+
"properties": {
|
|
84603
|
+
"id": {
|
|
84604
|
+
"type": "integer",
|
|
84605
|
+
"readOnly": true
|
|
84606
|
+
},
|
|
84607
|
+
"operatorId": {
|
|
84608
|
+
"type": "integer",
|
|
84609
|
+
"description": "The ID of the operator this resource belongs to",
|
|
84610
|
+
"example": 1
|
|
84611
|
+
},
|
|
84612
|
+
"title": {
|
|
84613
|
+
"type": "string"
|
|
84614
|
+
},
|
|
84615
|
+
"partnerId": {
|
|
84616
|
+
"type": "integer"
|
|
84617
|
+
},
|
|
84618
|
+
"contractType": {
|
|
84619
|
+
"type": "string",
|
|
84620
|
+
"enum": [
|
|
84621
|
+
"revenueSharing",
|
|
84622
|
+
"paymentFacilitation"
|
|
84623
|
+
],
|
|
84624
|
+
"description": "Indicates the business relationship model for the contract. `revenueSharing` means the operator is the supplier and remits a share to the partner. `paymentFacilitation` means the partner is the supplier and the operator acts as payment facilitator."
|
|
84625
|
+
},
|
|
84626
|
+
"startDate": {
|
|
84627
|
+
"type": "string",
|
|
84628
|
+
"format": "date-time",
|
|
84629
|
+
"description": "The contract is effective from the first of the selected month."
|
|
84630
|
+
},
|
|
84631
|
+
"endDate": {
|
|
84632
|
+
"type": "string",
|
|
84633
|
+
"format": "date-time",
|
|
84634
|
+
"nullable": true,
|
|
84635
|
+
"description": "The contract expires at the last day of the selected month. If nothing is selected, there is no expiration date."
|
|
84636
|
+
},
|
|
84637
|
+
"autoRenewal": {
|
|
84638
|
+
"type": "boolean"
|
|
84639
|
+
},
|
|
84640
|
+
"externalId": {
|
|
84641
|
+
"type": "string",
|
|
84642
|
+
"description": "Used to store custom information, usually used for external references or metadata to the resource.",
|
|
84643
|
+
"maxLength": 255
|
|
84644
|
+
},
|
|
84645
|
+
"accessAndPermissions": {
|
|
84646
|
+
"type": "object",
|
|
84647
|
+
"properties": {
|
|
84648
|
+
"sessionsRemoteControl": {
|
|
84649
|
+
"type": "boolean",
|
|
84650
|
+
"description": "Allows the partner to start/stop session, unlock connector, trigger message, set a charging profile and get the composite schedule."
|
|
84651
|
+
},
|
|
84652
|
+
"startReservation": {
|
|
84653
|
+
"type": "boolean",
|
|
84654
|
+
"description": "Allows the partner to make reservations."
|
|
84655
|
+
},
|
|
84656
|
+
"stopReservation": {
|
|
84657
|
+
"type": "boolean",
|
|
84658
|
+
"description": "Allows the partner to cancel reservations."
|
|
84659
|
+
},
|
|
84660
|
+
"resetChargePoint": {
|
|
84661
|
+
"type": "boolean",
|
|
84662
|
+
"description": "Allows the partner to reset charge points."
|
|
84663
|
+
},
|
|
84664
|
+
"firmwareUpdate": {
|
|
84665
|
+
"type": "boolean",
|
|
84666
|
+
"description": "Allows the partner to make firmware updates to the charge points."
|
|
84667
|
+
},
|
|
84668
|
+
"createFromTemplate": {
|
|
84669
|
+
"type": "boolean",
|
|
84670
|
+
"description": "Allows the partner to create charge points from templates."
|
|
84671
|
+
},
|
|
84672
|
+
"changeSystemStatus": {
|
|
84673
|
+
"type": "boolean",
|
|
84674
|
+
"description": "Allows the partner to change the system status of charge points."
|
|
84675
|
+
}
|
|
84676
|
+
}
|
|
84677
|
+
},
|
|
84678
|
+
"revenueSharing": {
|
|
84679
|
+
"type": "object",
|
|
84680
|
+
"properties": {
|
|
84681
|
+
"partnerSharePercentageAcEvse": {
|
|
84682
|
+
"type": "number",
|
|
84683
|
+
"format": "float",
|
|
84684
|
+
"minimum": 0,
|
|
84685
|
+
"maximum": 100
|
|
84686
|
+
},
|
|
84687
|
+
"partnerSharePercentageDcEvse": {
|
|
84688
|
+
"type": "number",
|
|
84689
|
+
"format": "float",
|
|
84690
|
+
"minimum": 0,
|
|
84691
|
+
"maximum": 100
|
|
84692
|
+
},
|
|
84693
|
+
"excludeConnectionFee": {
|
|
84694
|
+
"type": "boolean",
|
|
84695
|
+
"description": "If the tariff has a Connection fee, this fee would not be included in the revenue sharing with the Partner and will remain entirely for the Operator."
|
|
84696
|
+
},
|
|
84697
|
+
"deductElectricityCost": {
|
|
84698
|
+
"type": "boolean",
|
|
84699
|
+
"description": "The cost of the electricity would first be deducted from the collected revenue and then the Revenue sharing rules will be applied."
|
|
84700
|
+
},
|
|
84701
|
+
"reimburseForElectricityCost": {
|
|
84702
|
+
"type": "boolean",
|
|
84703
|
+
"description": "If set to true, the Partner would receive not only their share of the revenue but also a reimbursement for the cost of the electricity. The formula to calculate the amount to be received by the Partner is (Revenue - Electricity cost) x Partner percentage + Electricity cost. It could be supplied only if deductElectricityCost is set to true."
|
|
84704
|
+
},
|
|
84705
|
+
"fixedFeePerSessionAc": {
|
|
84706
|
+
"type": "number",
|
|
84707
|
+
"format": "float",
|
|
84708
|
+
"nullable": true,
|
|
84709
|
+
"description": "Additional flat fee that is applied for every billed session and subtracted from the Partner's share of the revenue for each session on AC Charging Station."
|
|
84710
|
+
},
|
|
84711
|
+
"fixedFeePerSessionDc": {
|
|
84712
|
+
"type": "number",
|
|
84713
|
+
"format": "float",
|
|
84714
|
+
"nullable": true,
|
|
84715
|
+
"description": "Additional flat fee that is applied for every billed session and subtracted from the Partner's share of the revenue for each session on DC Charging Station."
|
|
84716
|
+
},
|
|
84717
|
+
"feePerKwhAc": {
|
|
84718
|
+
"type": "number",
|
|
84719
|
+
"format": "float",
|
|
84720
|
+
"nullable": true,
|
|
84721
|
+
"description": "Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on AC Charging Station."
|
|
84722
|
+
},
|
|
84723
|
+
"feePerKwhDc": {
|
|
84724
|
+
"type": "number",
|
|
84725
|
+
"format": "float",
|
|
84726
|
+
"nullable": true,
|
|
84727
|
+
"description": "Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on DC Charging Station."
|
|
84728
|
+
},
|
|
84729
|
+
"handlingFee": {
|
|
84730
|
+
"type": "number",
|
|
84731
|
+
"format": "float",
|
|
84732
|
+
"minimum": 0,
|
|
84733
|
+
"maximum": 100,
|
|
84734
|
+
"nullable": true,
|
|
84735
|
+
"description": "Additional percentage fee to be applied on the total amount paid by the user for the session. This fee is then subtracted from the Partner's share of the revenue."
|
|
84736
|
+
}
|
|
84737
|
+
}
|
|
84738
|
+
},
|
|
84739
|
+
"monthlyPlatformFees": {
|
|
84740
|
+
"type": "object",
|
|
84741
|
+
"properties": {
|
|
84742
|
+
"perChargePoint": {
|
|
84743
|
+
"type": "number",
|
|
84744
|
+
"format": "float",
|
|
84745
|
+
"description": "The provided amount should be excluding VAT."
|
|
84746
|
+
},
|
|
84747
|
+
"perAcEvse": {
|
|
84748
|
+
"type": "number",
|
|
84749
|
+
"format": "float",
|
|
84750
|
+
"description": "The provided amount should be excluding VAT."
|
|
84751
|
+
},
|
|
84752
|
+
"perDcEvse": {
|
|
84753
|
+
"type": "number",
|
|
84754
|
+
"format": "float",
|
|
84755
|
+
"description": "The provided amount should be excluding VAT."
|
|
84756
|
+
}
|
|
84757
|
+
}
|
|
84758
|
+
},
|
|
84759
|
+
"reimbursementFees": {
|
|
84760
|
+
"type": "object",
|
|
84761
|
+
"description": "Home-charging reimbursement fees configured on the contract itself and charged to the partner for reimbursed charging sessions and reimbursement periods. Only available when the home-charging reimbursement feature is enabled for the operator. All other home-charging reimbursement settings are managed on the partner resource.\n",
|
|
84762
|
+
"properties": {
|
|
84763
|
+
"perSession": {
|
|
84764
|
+
"type": "number",
|
|
84765
|
+
"format": "float",
|
|
84766
|
+
"minimum": 0,
|
|
84767
|
+
"description": "Flat fee charged for every reimbursed charging session, in the contract's currency."
|
|
84768
|
+
},
|
|
84769
|
+
"perPeriod": {
|
|
84770
|
+
"type": "number",
|
|
84771
|
+
"format": "float",
|
|
84772
|
+
"minimum": 0,
|
|
84773
|
+
"description": "Flat fee charged for every reimbursement period, in the contract's currency."
|
|
84774
|
+
}
|
|
84775
|
+
}
|
|
84776
|
+
},
|
|
84777
|
+
"lastUpdatedAt": {
|
|
84778
|
+
"type": "string",
|
|
84779
|
+
"format": "date-time",
|
|
84780
|
+
"description": "ISO 8601 formatted date",
|
|
84781
|
+
"readOnly": true
|
|
84782
|
+
},
|
|
84783
|
+
"settlementOverrides": {
|
|
84784
|
+
"type": "array",
|
|
84785
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
84786
|
+
"items": {
|
|
84787
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84788
|
+
"type": "object",
|
|
84789
|
+
"required": [
|
|
84790
|
+
"id",
|
|
84791
|
+
"name",
|
|
84792
|
+
"priority",
|
|
84793
|
+
"restriction",
|
|
84794
|
+
"acPercent",
|
|
84795
|
+
"dcPercent"
|
|
84796
|
+
],
|
|
84797
|
+
"properties": {
|
|
84798
|
+
"name": {
|
|
84799
|
+
"type": "string",
|
|
84800
|
+
"maxLength": 255,
|
|
84801
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84802
|
+
"example": "Fleet drivers"
|
|
84803
|
+
},
|
|
84804
|
+
"priority": {
|
|
84805
|
+
"type": "integer",
|
|
84806
|
+
"minimum": 1,
|
|
84807
|
+
"maximum": 4294967295,
|
|
84808
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84809
|
+
"example": 1
|
|
84810
|
+
},
|
|
84811
|
+
"id": {
|
|
84812
|
+
"type": "integer",
|
|
84813
|
+
"description": "Unique identifier for the settlement override",
|
|
84814
|
+
"example": 123
|
|
84815
|
+
},
|
|
84816
|
+
"restriction": {
|
|
84817
|
+
"type": "object",
|
|
84818
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84819
|
+
"required": [
|
|
84820
|
+
"type"
|
|
84821
|
+
],
|
|
84822
|
+
"properties": {
|
|
84823
|
+
"type": {
|
|
84824
|
+
"type": "string",
|
|
84825
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84826
|
+
"enum": [
|
|
84827
|
+
"users_of_the_partner",
|
|
84828
|
+
"user_groups",
|
|
84829
|
+
"ad_hoc_users",
|
|
84830
|
+
"users_of_specific_partners"
|
|
84831
|
+
]
|
|
84832
|
+
},
|
|
84833
|
+
"targetIds": {
|
|
84834
|
+
"type": "array",
|
|
84835
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84836
|
+
"items": {
|
|
84837
|
+
"type": "integer"
|
|
84838
|
+
},
|
|
84839
|
+
"example": [
|
|
84840
|
+
12,
|
|
84841
|
+
34
|
|
84842
|
+
]
|
|
84843
|
+
}
|
|
84844
|
+
}
|
|
84845
|
+
},
|
|
84846
|
+
"acPercent": {
|
|
84847
|
+
"type": "number",
|
|
84848
|
+
"format": "float",
|
|
84849
|
+
"nullable": true,
|
|
84850
|
+
"minimum": 0,
|
|
84851
|
+
"maximum": 100,
|
|
84852
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84853
|
+
"example": 70.5
|
|
84854
|
+
},
|
|
84855
|
+
"dcPercent": {
|
|
84856
|
+
"type": "number",
|
|
84857
|
+
"format": "float",
|
|
84858
|
+
"nullable": true,
|
|
84859
|
+
"minimum": 0,
|
|
84860
|
+
"maximum": 100,
|
|
84861
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84862
|
+
"example": 60
|
|
84863
|
+
}
|
|
84864
|
+
}
|
|
84865
|
+
}
|
|
84866
|
+
}
|
|
84867
|
+
},
|
|
84868
|
+
"required": [
|
|
84869
|
+
"id",
|
|
84870
|
+
"operatorId",
|
|
84871
|
+
"title",
|
|
84872
|
+
"partnerId",
|
|
84873
|
+
"startDate"
|
|
84874
|
+
]
|
|
84875
|
+
}
|
|
84876
|
+
}
|
|
84877
|
+
}
|
|
84878
|
+
},
|
|
84879
|
+
"401": {
|
|
84880
|
+
"schema": {
|
|
84881
|
+
"type": "object",
|
|
84882
|
+
"properties": {
|
|
84883
|
+
"message": {
|
|
84884
|
+
"type": "string"
|
|
84885
|
+
}
|
|
84886
|
+
}
|
|
84887
|
+
}
|
|
84888
|
+
},
|
|
84889
|
+
"403": {
|
|
84890
|
+
"schema": {
|
|
84891
|
+
"type": "object",
|
|
84892
|
+
"properties": {
|
|
84893
|
+
"message": {
|
|
84894
|
+
"type": "string",
|
|
84895
|
+
"default": "This action is unauthorized."
|
|
84896
|
+
}
|
|
84897
|
+
}
|
|
84898
|
+
}
|
|
84899
|
+
},
|
|
84900
|
+
"404": {
|
|
84901
|
+
"schema": {
|
|
84902
|
+
"type": "object",
|
|
84903
|
+
"properties": {
|
|
84904
|
+
"message": {
|
|
84905
|
+
"type": "string"
|
|
84906
|
+
}
|
|
84907
|
+
}
|
|
84908
|
+
}
|
|
84909
|
+
},
|
|
84910
|
+
"422": {
|
|
84911
|
+
"schema": {
|
|
84912
|
+
"type": "object",
|
|
84913
|
+
"required": [
|
|
84914
|
+
"message"
|
|
84915
|
+
],
|
|
84916
|
+
"properties": {
|
|
84917
|
+
"message": {
|
|
84918
|
+
"type": "string"
|
|
84919
|
+
},
|
|
84920
|
+
"errors": {
|
|
84921
|
+
"type": "object",
|
|
84922
|
+
"additionalProperties": {
|
|
84923
|
+
"type": "array",
|
|
84924
|
+
"items": {
|
|
84925
|
+
"type": "string"
|
|
84926
|
+
}
|
|
84927
|
+
}
|
|
84928
|
+
}
|
|
84929
|
+
}
|
|
84930
|
+
}
|
|
84931
|
+
},
|
|
84932
|
+
"429": {
|
|
84933
|
+
"schema": {
|
|
84934
|
+
"type": "object",
|
|
84935
|
+
"properties": {
|
|
84936
|
+
"message": {
|
|
84937
|
+
"type": "string"
|
|
84938
|
+
}
|
|
84939
|
+
}
|
|
84940
|
+
}
|
|
84941
|
+
}
|
|
84942
|
+
},
|
|
84943
|
+
"partnerContractSettlementOverridesListing": {
|
|
84944
|
+
"200": {
|
|
84945
|
+
"schema": {
|
|
84946
|
+
"type": "object",
|
|
84947
|
+
"properties": {
|
|
84948
|
+
"data": {
|
|
84949
|
+
"type": "array",
|
|
84950
|
+
"items": {
|
|
84951
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84952
|
+
"type": "object",
|
|
84953
|
+
"required": [
|
|
84954
|
+
"id",
|
|
84955
|
+
"name",
|
|
84956
|
+
"priority",
|
|
84957
|
+
"restriction",
|
|
84958
|
+
"acPercent",
|
|
84959
|
+
"dcPercent"
|
|
84960
|
+
],
|
|
84961
|
+
"properties": {
|
|
84962
|
+
"name": {
|
|
84963
|
+
"type": "string",
|
|
84964
|
+
"maxLength": 255,
|
|
84965
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84966
|
+
"example": "Fleet drivers"
|
|
84967
|
+
},
|
|
84968
|
+
"priority": {
|
|
84969
|
+
"type": "integer",
|
|
84970
|
+
"minimum": 1,
|
|
84971
|
+
"maximum": 4294967295,
|
|
84972
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84973
|
+
"example": 1
|
|
84974
|
+
},
|
|
84975
|
+
"id": {
|
|
84976
|
+
"type": "integer",
|
|
84977
|
+
"description": "Unique identifier for the settlement override",
|
|
84978
|
+
"example": 123
|
|
84979
|
+
},
|
|
84980
|
+
"restriction": {
|
|
84981
|
+
"type": "object",
|
|
84982
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84983
|
+
"required": [
|
|
84984
|
+
"type"
|
|
84985
|
+
],
|
|
84986
|
+
"properties": {
|
|
84987
|
+
"type": {
|
|
84988
|
+
"type": "string",
|
|
84989
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84990
|
+
"enum": [
|
|
84991
|
+
"users_of_the_partner",
|
|
84992
|
+
"user_groups",
|
|
84993
|
+
"ad_hoc_users",
|
|
84994
|
+
"users_of_specific_partners"
|
|
84995
|
+
]
|
|
84996
|
+
},
|
|
84997
|
+
"targetIds": {
|
|
84998
|
+
"type": "array",
|
|
84999
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85000
|
+
"items": {
|
|
85001
|
+
"type": "integer"
|
|
85002
|
+
},
|
|
85003
|
+
"example": [
|
|
85004
|
+
12,
|
|
85005
|
+
34
|
|
85006
|
+
]
|
|
85007
|
+
}
|
|
85008
|
+
}
|
|
85009
|
+
},
|
|
85010
|
+
"acPercent": {
|
|
85011
|
+
"type": "number",
|
|
85012
|
+
"format": "float",
|
|
85013
|
+
"nullable": true,
|
|
85014
|
+
"minimum": 0,
|
|
85015
|
+
"maximum": 100,
|
|
85016
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85017
|
+
"example": 70.5
|
|
85018
|
+
},
|
|
85019
|
+
"dcPercent": {
|
|
85020
|
+
"type": "number",
|
|
85021
|
+
"format": "float",
|
|
85022
|
+
"nullable": true,
|
|
85023
|
+
"minimum": 0,
|
|
85024
|
+
"maximum": 100,
|
|
85025
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85026
|
+
"example": 60
|
|
85027
|
+
}
|
|
85028
|
+
}
|
|
85029
|
+
}
|
|
85030
|
+
},
|
|
85031
|
+
"links": {
|
|
85032
|
+
"type": "object",
|
|
85033
|
+
"properties": {
|
|
85034
|
+
"first": {
|
|
85035
|
+
"type": "string",
|
|
85036
|
+
"description": "The URL to fetch the first page",
|
|
85037
|
+
"nullable": true
|
|
85038
|
+
},
|
|
85039
|
+
"last": {
|
|
85040
|
+
"type": "string",
|
|
85041
|
+
"description": "The URL to fetch the last page",
|
|
85042
|
+
"nullable": true
|
|
85043
|
+
},
|
|
85044
|
+
"prev": {
|
|
85045
|
+
"type": "string",
|
|
85046
|
+
"description": "The URL to fetch the previous page",
|
|
85047
|
+
"nullable": true
|
|
85048
|
+
},
|
|
85049
|
+
"next": {
|
|
85050
|
+
"type": "string",
|
|
85051
|
+
"description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
|
|
85052
|
+
"nullable": true
|
|
85053
|
+
}
|
|
85054
|
+
}
|
|
85055
|
+
},
|
|
85056
|
+
"meta": {
|
|
85057
|
+
"type": "object",
|
|
85058
|
+
"properties": {
|
|
85059
|
+
"path": {
|
|
85060
|
+
"type": "string",
|
|
85061
|
+
"description": "The base route of the endpoint (unpaginated)"
|
|
85062
|
+
},
|
|
85063
|
+
"per_page": {
|
|
85064
|
+
"type": "integer",
|
|
85065
|
+
"description": "The max number of items in each page"
|
|
85066
|
+
},
|
|
85067
|
+
"next_cursor": {
|
|
85068
|
+
"type": "string",
|
|
85069
|
+
"description": "The cursor to fetch the next page. Do not use this directly. It will be populated by using the previous response's links.next.",
|
|
85070
|
+
"nullable": true
|
|
85071
|
+
},
|
|
85072
|
+
"prev_cursor": {
|
|
85073
|
+
"type": "string",
|
|
85074
|
+
"description": "The cursor to fetch the previous page. Do not use this directly. It will be populated by using the previous response's links.prev.",
|
|
85075
|
+
"nullable": true
|
|
85076
|
+
}
|
|
85077
|
+
}
|
|
85078
|
+
}
|
|
85079
|
+
}
|
|
85080
|
+
}
|
|
85081
|
+
},
|
|
85082
|
+
"401": {
|
|
85083
|
+
"schema": {
|
|
85084
|
+
"type": "object",
|
|
85085
|
+
"properties": {
|
|
85086
|
+
"message": {
|
|
85087
|
+
"type": "string"
|
|
85088
|
+
}
|
|
85089
|
+
}
|
|
85090
|
+
}
|
|
85091
|
+
},
|
|
85092
|
+
"403": {
|
|
85093
|
+
"schema": {
|
|
85094
|
+
"type": "object",
|
|
85095
|
+
"properties": {
|
|
85096
|
+
"message": {
|
|
85097
|
+
"type": "string",
|
|
85098
|
+
"default": "This action is unauthorized."
|
|
85099
|
+
}
|
|
85100
|
+
}
|
|
85101
|
+
}
|
|
85102
|
+
},
|
|
85103
|
+
"404": {
|
|
85104
|
+
"schema": {
|
|
85105
|
+
"type": "object",
|
|
85106
|
+
"properties": {
|
|
85107
|
+
"message": {
|
|
85108
|
+
"type": "string"
|
|
85109
|
+
}
|
|
85110
|
+
}
|
|
85111
|
+
}
|
|
85112
|
+
},
|
|
85113
|
+
"429": {
|
|
85114
|
+
"schema": {
|
|
85115
|
+
"type": "object",
|
|
85116
|
+
"properties": {
|
|
85117
|
+
"message": {
|
|
85118
|
+
"type": "string"
|
|
85119
|
+
}
|
|
85120
|
+
}
|
|
85121
|
+
}
|
|
85122
|
+
}
|
|
85123
|
+
},
|
|
85124
|
+
"partnerContractSettlementOverrideCreate": {
|
|
85125
|
+
"201": {
|
|
85126
|
+
"schema": {
|
|
85127
|
+
"type": "object",
|
|
85128
|
+
"properties": {
|
|
85129
|
+
"data": {
|
|
85130
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
85131
|
+
"type": "object",
|
|
85132
|
+
"required": [
|
|
85133
|
+
"id",
|
|
85134
|
+
"name",
|
|
85135
|
+
"priority",
|
|
85136
|
+
"restriction",
|
|
85137
|
+
"acPercent",
|
|
85138
|
+
"dcPercent"
|
|
85139
|
+
],
|
|
85140
|
+
"properties": {
|
|
85141
|
+
"name": {
|
|
85142
|
+
"type": "string",
|
|
85143
|
+
"maxLength": 255,
|
|
85144
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
85145
|
+
"example": "Fleet drivers"
|
|
85146
|
+
},
|
|
85147
|
+
"priority": {
|
|
85148
|
+
"type": "integer",
|
|
85149
|
+
"minimum": 1,
|
|
85150
|
+
"maximum": 4294967295,
|
|
85151
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
85152
|
+
"example": 1
|
|
85153
|
+
},
|
|
85154
|
+
"id": {
|
|
85155
|
+
"type": "integer",
|
|
85156
|
+
"description": "Unique identifier for the settlement override",
|
|
85157
|
+
"example": 123
|
|
85158
|
+
},
|
|
85159
|
+
"restriction": {
|
|
85160
|
+
"type": "object",
|
|
85161
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
85162
|
+
"required": [
|
|
85163
|
+
"type"
|
|
85164
|
+
],
|
|
85165
|
+
"properties": {
|
|
85166
|
+
"type": {
|
|
85167
|
+
"type": "string",
|
|
85168
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
85169
|
+
"enum": [
|
|
85170
|
+
"users_of_the_partner",
|
|
85171
|
+
"user_groups",
|
|
85172
|
+
"ad_hoc_users",
|
|
85173
|
+
"users_of_specific_partners"
|
|
85174
|
+
]
|
|
85175
|
+
},
|
|
85176
|
+
"targetIds": {
|
|
85177
|
+
"type": "array",
|
|
85178
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85179
|
+
"items": {
|
|
85180
|
+
"type": "integer"
|
|
85181
|
+
},
|
|
85182
|
+
"example": [
|
|
85183
|
+
12,
|
|
85184
|
+
34
|
|
85185
|
+
]
|
|
85186
|
+
}
|
|
85187
|
+
}
|
|
85188
|
+
},
|
|
85189
|
+
"acPercent": {
|
|
85190
|
+
"type": "number",
|
|
85191
|
+
"format": "float",
|
|
85192
|
+
"nullable": true,
|
|
85193
|
+
"minimum": 0,
|
|
85194
|
+
"maximum": 100,
|
|
85195
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85196
|
+
"example": 70.5
|
|
85197
|
+
},
|
|
85198
|
+
"dcPercent": {
|
|
85199
|
+
"type": "number",
|
|
85200
|
+
"format": "float",
|
|
85201
|
+
"nullable": true,
|
|
85202
|
+
"minimum": 0,
|
|
85203
|
+
"maximum": 100,
|
|
85204
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85205
|
+
"example": 60
|
|
85206
|
+
}
|
|
85207
|
+
}
|
|
85208
|
+
}
|
|
85209
|
+
}
|
|
85210
|
+
}
|
|
85211
|
+
},
|
|
85212
|
+
"401": {
|
|
85213
|
+
"schema": {
|
|
85214
|
+
"type": "object",
|
|
85215
|
+
"properties": {
|
|
85216
|
+
"message": {
|
|
85217
|
+
"type": "string"
|
|
85218
|
+
}
|
|
85219
|
+
}
|
|
85220
|
+
}
|
|
85221
|
+
},
|
|
85222
|
+
"403": {
|
|
85223
|
+
"schema": {
|
|
85224
|
+
"type": "object",
|
|
85225
|
+
"properties": {
|
|
85226
|
+
"message": {
|
|
85227
|
+
"type": "string",
|
|
85228
|
+
"default": "This action is unauthorized."
|
|
85229
|
+
}
|
|
85230
|
+
}
|
|
85231
|
+
}
|
|
85232
|
+
},
|
|
85233
|
+
"404": {
|
|
85234
|
+
"schema": {
|
|
85235
|
+
"type": "object",
|
|
85236
|
+
"properties": {
|
|
85237
|
+
"message": {
|
|
85238
|
+
"type": "string"
|
|
85239
|
+
}
|
|
85240
|
+
}
|
|
85241
|
+
}
|
|
85242
|
+
},
|
|
85243
|
+
"409": {
|
|
85244
|
+
"schema": {
|
|
85245
|
+
"type": "object",
|
|
85246
|
+
"required": [
|
|
85247
|
+
"errorCode"
|
|
85248
|
+
],
|
|
85249
|
+
"properties": {
|
|
85250
|
+
"message": {
|
|
85251
|
+
"type": "string"
|
|
85252
|
+
},
|
|
85253
|
+
"errorCode": {
|
|
85254
|
+
"type": "string",
|
|
85255
|
+
"description": "Machine-readable error code describing the conflict.\n\nAllowed values:\n- `override_priority_taken` - Another active override on the same partner contract already uses the requested priority.\n",
|
|
85256
|
+
"enum": [
|
|
85257
|
+
"override_priority_taken"
|
|
85258
|
+
]
|
|
85259
|
+
}
|
|
85260
|
+
}
|
|
85261
|
+
}
|
|
85262
|
+
},
|
|
85263
|
+
"412": {
|
|
85264
|
+
"schema": {
|
|
85265
|
+
"type": "object",
|
|
85266
|
+
"required": [
|
|
85267
|
+
"errorCode"
|
|
85268
|
+
],
|
|
85269
|
+
"properties": {
|
|
85270
|
+
"message": {
|
|
85271
|
+
"type": "string"
|
|
85272
|
+
},
|
|
85273
|
+
"errorCode": {
|
|
85274
|
+
"type": "string",
|
|
85275
|
+
"description": "Machine-readable error code describing the unmet precondition.\n\nAllowed values:\n- `settlement_overrides_not_enabled` - Settlement overrides are not enabled for the operator owning the partner contract.\n",
|
|
85276
|
+
"enum": [
|
|
85277
|
+
"settlement_overrides_not_enabled"
|
|
85278
|
+
]
|
|
85279
|
+
}
|
|
85280
|
+
}
|
|
85281
|
+
}
|
|
85282
|
+
},
|
|
85283
|
+
"422": {
|
|
85284
|
+
"schema": {
|
|
85285
|
+
"type": "object",
|
|
85286
|
+
"required": [
|
|
85287
|
+
"message"
|
|
85288
|
+
],
|
|
85289
|
+
"properties": {
|
|
85290
|
+
"message": {
|
|
85291
|
+
"type": "string"
|
|
85292
|
+
},
|
|
85293
|
+
"errors": {
|
|
85294
|
+
"type": "object",
|
|
85295
|
+
"additionalProperties": {
|
|
85296
|
+
"type": "array",
|
|
85297
|
+
"items": {
|
|
85298
|
+
"type": "string"
|
|
85299
|
+
}
|
|
85300
|
+
}
|
|
85301
|
+
}
|
|
85302
|
+
}
|
|
85303
|
+
}
|
|
85304
|
+
},
|
|
85305
|
+
"429": {
|
|
85306
|
+
"schema": {
|
|
85307
|
+
"type": "object",
|
|
85308
|
+
"properties": {
|
|
85309
|
+
"message": {
|
|
85310
|
+
"type": "string"
|
|
85311
|
+
}
|
|
85312
|
+
}
|
|
85313
|
+
}
|
|
85314
|
+
}
|
|
85315
|
+
},
|
|
85316
|
+
"partnerContractSettlementOverrideRead": {
|
|
85317
|
+
"200": {
|
|
85318
|
+
"schema": {
|
|
85319
|
+
"type": "object",
|
|
85320
|
+
"properties": {
|
|
85321
|
+
"data": {
|
|
85322
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
85323
|
+
"type": "object",
|
|
85324
|
+
"required": [
|
|
85325
|
+
"id",
|
|
85326
|
+
"name",
|
|
85327
|
+
"priority",
|
|
85328
|
+
"restriction",
|
|
85329
|
+
"acPercent",
|
|
85330
|
+
"dcPercent"
|
|
85331
|
+
],
|
|
85332
|
+
"properties": {
|
|
85333
|
+
"name": {
|
|
85334
|
+
"type": "string",
|
|
85335
|
+
"maxLength": 255,
|
|
85336
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
85337
|
+
"example": "Fleet drivers"
|
|
85338
|
+
},
|
|
85339
|
+
"priority": {
|
|
85340
|
+
"type": "integer",
|
|
85341
|
+
"minimum": 1,
|
|
85342
|
+
"maximum": 4294967295,
|
|
85343
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
85344
|
+
"example": 1
|
|
85345
|
+
},
|
|
85346
|
+
"id": {
|
|
85347
|
+
"type": "integer",
|
|
85348
|
+
"description": "Unique identifier for the settlement override",
|
|
85349
|
+
"example": 123
|
|
85350
|
+
},
|
|
85351
|
+
"restriction": {
|
|
85352
|
+
"type": "object",
|
|
85353
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
85354
|
+
"required": [
|
|
85355
|
+
"type"
|
|
85356
|
+
],
|
|
85357
|
+
"properties": {
|
|
85358
|
+
"type": {
|
|
85359
|
+
"type": "string",
|
|
85360
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
85361
|
+
"enum": [
|
|
85362
|
+
"users_of_the_partner",
|
|
85363
|
+
"user_groups",
|
|
85364
|
+
"ad_hoc_users",
|
|
85365
|
+
"users_of_specific_partners"
|
|
85366
|
+
]
|
|
85367
|
+
},
|
|
85368
|
+
"targetIds": {
|
|
85369
|
+
"type": "array",
|
|
85370
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85371
|
+
"items": {
|
|
85372
|
+
"type": "integer"
|
|
85373
|
+
},
|
|
85374
|
+
"example": [
|
|
85375
|
+
12,
|
|
85376
|
+
34
|
|
85377
|
+
]
|
|
85378
|
+
}
|
|
85379
|
+
}
|
|
85380
|
+
},
|
|
85381
|
+
"acPercent": {
|
|
85382
|
+
"type": "number",
|
|
85383
|
+
"format": "float",
|
|
85384
|
+
"nullable": true,
|
|
85385
|
+
"minimum": 0,
|
|
85386
|
+
"maximum": 100,
|
|
85387
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85388
|
+
"example": 70.5
|
|
85389
|
+
},
|
|
85390
|
+
"dcPercent": {
|
|
85391
|
+
"type": "number",
|
|
85392
|
+
"format": "float",
|
|
85393
|
+
"nullable": true,
|
|
85394
|
+
"minimum": 0,
|
|
85395
|
+
"maximum": 100,
|
|
85396
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85397
|
+
"example": 60
|
|
85398
|
+
}
|
|
85399
|
+
}
|
|
85400
|
+
}
|
|
85401
|
+
}
|
|
85402
|
+
}
|
|
85403
|
+
},
|
|
85404
|
+
"401": {
|
|
85405
|
+
"schema": {
|
|
85406
|
+
"type": "object",
|
|
85407
|
+
"properties": {
|
|
85408
|
+
"message": {
|
|
85409
|
+
"type": "string"
|
|
85410
|
+
}
|
|
85411
|
+
}
|
|
85412
|
+
}
|
|
85413
|
+
},
|
|
85414
|
+
"403": {
|
|
85415
|
+
"schema": {
|
|
85416
|
+
"type": "object",
|
|
85417
|
+
"properties": {
|
|
85418
|
+
"message": {
|
|
85419
|
+
"type": "string",
|
|
85420
|
+
"default": "This action is unauthorized."
|
|
85421
|
+
}
|
|
85422
|
+
}
|
|
85423
|
+
}
|
|
85424
|
+
},
|
|
85425
|
+
"404": {
|
|
85426
|
+
"schema": {
|
|
85427
|
+
"type": "object",
|
|
85428
|
+
"properties": {
|
|
85429
|
+
"message": {
|
|
85430
|
+
"type": "string"
|
|
85431
|
+
}
|
|
85432
|
+
}
|
|
85433
|
+
}
|
|
85434
|
+
},
|
|
85435
|
+
"429": {
|
|
85436
|
+
"schema": {
|
|
85437
|
+
"type": "object",
|
|
85438
|
+
"properties": {
|
|
85439
|
+
"message": {
|
|
85440
|
+
"type": "string"
|
|
85441
|
+
}
|
|
85442
|
+
}
|
|
85443
|
+
}
|
|
85444
|
+
}
|
|
85445
|
+
},
|
|
85446
|
+
"partnerContractSettlementOverrideDelete": {
|
|
85447
|
+
"401": {
|
|
85448
|
+
"schema": {
|
|
85449
|
+
"type": "object",
|
|
85450
|
+
"properties": {
|
|
85451
|
+
"message": {
|
|
85452
|
+
"type": "string"
|
|
85453
|
+
}
|
|
85454
|
+
}
|
|
85455
|
+
}
|
|
85456
|
+
},
|
|
85457
|
+
"403": {
|
|
85458
|
+
"schema": {
|
|
85459
|
+
"type": "object",
|
|
85460
|
+
"properties": {
|
|
85461
|
+
"message": {
|
|
85462
|
+
"type": "string",
|
|
85463
|
+
"default": "This action is unauthorized."
|
|
85464
|
+
}
|
|
85465
|
+
}
|
|
85466
|
+
}
|
|
85467
|
+
},
|
|
85468
|
+
"404": {
|
|
85469
|
+
"schema": {
|
|
85470
|
+
"type": "object",
|
|
85471
|
+
"properties": {
|
|
85472
|
+
"message": {
|
|
85473
|
+
"type": "string"
|
|
85474
|
+
}
|
|
85475
|
+
}
|
|
85476
|
+
}
|
|
85477
|
+
},
|
|
85478
|
+
"412": {
|
|
85479
|
+
"schema": {
|
|
85480
|
+
"type": "object",
|
|
85481
|
+
"required": [
|
|
85482
|
+
"errorCode"
|
|
85483
|
+
],
|
|
85484
|
+
"properties": {
|
|
85485
|
+
"message": {
|
|
85486
|
+
"type": "string"
|
|
85487
|
+
},
|
|
85488
|
+
"errorCode": {
|
|
85489
|
+
"type": "string",
|
|
85490
|
+
"description": "Machine-readable error code describing the unmet precondition.\n\nAllowed values:\n- `settlement_overrides_not_enabled` - Settlement overrides are not enabled for the operator owning the partner contract.\n",
|
|
85491
|
+
"enum": [
|
|
85492
|
+
"settlement_overrides_not_enabled"
|
|
85493
|
+
]
|
|
85494
|
+
}
|
|
85495
|
+
}
|
|
85496
|
+
}
|
|
85497
|
+
},
|
|
85498
|
+
"429": {
|
|
85499
|
+
"schema": {
|
|
85500
|
+
"type": "object",
|
|
85501
|
+
"properties": {
|
|
85502
|
+
"message": {
|
|
85503
|
+
"type": "string"
|
|
85504
|
+
}
|
|
85505
|
+
}
|
|
85506
|
+
}
|
|
85507
|
+
}
|
|
85508
|
+
},
|
|
85509
|
+
"partnerContractSettlementOverrideUpdate": {
|
|
85510
|
+
"200": {
|
|
85511
|
+
"schema": {
|
|
85512
|
+
"type": "object",
|
|
85513
|
+
"properties": {
|
|
85514
|
+
"data": {
|
|
85515
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
85516
|
+
"type": "object",
|
|
85517
|
+
"required": [
|
|
85518
|
+
"id",
|
|
85519
|
+
"name",
|
|
85520
|
+
"priority",
|
|
85521
|
+
"restriction",
|
|
85522
|
+
"acPercent",
|
|
85523
|
+
"dcPercent"
|
|
85524
|
+
],
|
|
85525
|
+
"properties": {
|
|
85526
|
+
"name": {
|
|
85527
|
+
"type": "string",
|
|
85528
|
+
"maxLength": 255,
|
|
85529
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
85530
|
+
"example": "Fleet drivers"
|
|
85531
|
+
},
|
|
85532
|
+
"priority": {
|
|
85533
|
+
"type": "integer",
|
|
85534
|
+
"minimum": 1,
|
|
85535
|
+
"maximum": 4294967295,
|
|
85536
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
85537
|
+
"example": 1
|
|
85538
|
+
},
|
|
85539
|
+
"id": {
|
|
85540
|
+
"type": "integer",
|
|
85541
|
+
"description": "Unique identifier for the settlement override",
|
|
85542
|
+
"example": 123
|
|
85543
|
+
},
|
|
85544
|
+
"restriction": {
|
|
85545
|
+
"type": "object",
|
|
85546
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
85547
|
+
"required": [
|
|
85548
|
+
"type"
|
|
85549
|
+
],
|
|
85550
|
+
"properties": {
|
|
85551
|
+
"type": {
|
|
85552
|
+
"type": "string",
|
|
85553
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
85554
|
+
"enum": [
|
|
85555
|
+
"users_of_the_partner",
|
|
85556
|
+
"user_groups",
|
|
85557
|
+
"ad_hoc_users",
|
|
85558
|
+
"users_of_specific_partners"
|
|
85559
|
+
]
|
|
85560
|
+
},
|
|
85561
|
+
"targetIds": {
|
|
85562
|
+
"type": "array",
|
|
85563
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85564
|
+
"items": {
|
|
85565
|
+
"type": "integer"
|
|
85566
|
+
},
|
|
85567
|
+
"example": [
|
|
85568
|
+
12,
|
|
85569
|
+
34
|
|
85570
|
+
]
|
|
85571
|
+
}
|
|
85572
|
+
}
|
|
85573
|
+
},
|
|
85574
|
+
"acPercent": {
|
|
85575
|
+
"type": "number",
|
|
85576
|
+
"format": "float",
|
|
85577
|
+
"nullable": true,
|
|
85578
|
+
"minimum": 0,
|
|
85579
|
+
"maximum": 100,
|
|
85580
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85581
|
+
"example": 70.5
|
|
85582
|
+
},
|
|
85583
|
+
"dcPercent": {
|
|
85584
|
+
"type": "number",
|
|
85585
|
+
"format": "float",
|
|
85586
|
+
"nullable": true,
|
|
85587
|
+
"minimum": 0,
|
|
85588
|
+
"maximum": 100,
|
|
85589
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85590
|
+
"example": 60
|
|
85591
|
+
}
|
|
85592
|
+
}
|
|
85593
|
+
}
|
|
85594
|
+
}
|
|
85595
|
+
}
|
|
85596
|
+
},
|
|
85597
|
+
"401": {
|
|
85598
|
+
"schema": {
|
|
85599
|
+
"type": "object",
|
|
85600
|
+
"properties": {
|
|
85601
|
+
"message": {
|
|
85602
|
+
"type": "string"
|
|
85603
|
+
}
|
|
85604
|
+
}
|
|
85605
|
+
}
|
|
85606
|
+
},
|
|
85607
|
+
"403": {
|
|
85608
|
+
"schema": {
|
|
85609
|
+
"type": "object",
|
|
85610
|
+
"properties": {
|
|
85611
|
+
"message": {
|
|
85612
|
+
"type": "string",
|
|
85613
|
+
"default": "This action is unauthorized."
|
|
85614
|
+
}
|
|
85615
|
+
}
|
|
85616
|
+
}
|
|
85617
|
+
},
|
|
85618
|
+
"404": {
|
|
84236
85619
|
"schema": {
|
|
84237
85620
|
"type": "object",
|
|
84238
85621
|
"properties": {
|
|
@@ -84241,235 +85624,43 @@
|
|
|
84241
85624
|
}
|
|
84242
85625
|
}
|
|
84243
85626
|
}
|
|
84244
|
-
}
|
|
84245
|
-
},
|
|
84246
|
-
"partnerContractPatch": {
|
|
84247
|
-
"200": {
|
|
84248
|
-
"schema": {
|
|
84249
|
-
"type": "object",
|
|
84250
|
-
"properties": {
|
|
84251
|
-
"data": {
|
|
84252
|
-
"type": "object",
|
|
84253
|
-
"properties": {
|
|
84254
|
-
"id": {
|
|
84255
|
-
"type": "integer",
|
|
84256
|
-
"readOnly": true
|
|
84257
|
-
},
|
|
84258
|
-
"operatorId": {
|
|
84259
|
-
"type": "integer",
|
|
84260
|
-
"description": "The ID of the operator this resource belongs to",
|
|
84261
|
-
"example": 1
|
|
84262
|
-
},
|
|
84263
|
-
"title": {
|
|
84264
|
-
"type": "string"
|
|
84265
|
-
},
|
|
84266
|
-
"partnerId": {
|
|
84267
|
-
"type": "integer"
|
|
84268
|
-
},
|
|
84269
|
-
"contractType": {
|
|
84270
|
-
"type": "string",
|
|
84271
|
-
"enum": [
|
|
84272
|
-
"revenueSharing",
|
|
84273
|
-
"paymentFacilitation"
|
|
84274
|
-
],
|
|
84275
|
-
"description": "Indicates the business relationship model for the contract. `revenueSharing` means the operator is the supplier and remits a share to the partner. `paymentFacilitation` means the partner is the supplier and the operator acts as payment facilitator."
|
|
84276
|
-
},
|
|
84277
|
-
"startDate": {
|
|
84278
|
-
"type": "string",
|
|
84279
|
-
"format": "date-time",
|
|
84280
|
-
"description": "The contract is effective from the first of the selected month."
|
|
84281
|
-
},
|
|
84282
|
-
"endDate": {
|
|
84283
|
-
"type": "string",
|
|
84284
|
-
"format": "date-time",
|
|
84285
|
-
"nullable": true,
|
|
84286
|
-
"description": "The contract expires at the last day of the selected month. If nothing is selected, there is no expiration date."
|
|
84287
|
-
},
|
|
84288
|
-
"autoRenewal": {
|
|
84289
|
-
"type": "boolean"
|
|
84290
|
-
},
|
|
84291
|
-
"externalId": {
|
|
84292
|
-
"type": "string",
|
|
84293
|
-
"description": "Used to store custom information, usually used for external references or metadata to the resource.",
|
|
84294
|
-
"maxLength": 255
|
|
84295
|
-
},
|
|
84296
|
-
"accessAndPermissions": {
|
|
84297
|
-
"type": "object",
|
|
84298
|
-
"properties": {
|
|
84299
|
-
"sessionsRemoteControl": {
|
|
84300
|
-
"type": "boolean",
|
|
84301
|
-
"description": "Allows the partner to start/stop session, unlock connector, trigger message, set a charging profile and get the composite schedule."
|
|
84302
|
-
},
|
|
84303
|
-
"startReservation": {
|
|
84304
|
-
"type": "boolean",
|
|
84305
|
-
"description": "Allows the partner to make reservations."
|
|
84306
|
-
},
|
|
84307
|
-
"stopReservation": {
|
|
84308
|
-
"type": "boolean",
|
|
84309
|
-
"description": "Allows the partner to cancel reservations."
|
|
84310
|
-
},
|
|
84311
|
-
"resetChargePoint": {
|
|
84312
|
-
"type": "boolean",
|
|
84313
|
-
"description": "Allows the partner to reset charge points."
|
|
84314
|
-
},
|
|
84315
|
-
"firmwareUpdate": {
|
|
84316
|
-
"type": "boolean",
|
|
84317
|
-
"description": "Allows the partner to make firmware updates to the charge points."
|
|
84318
|
-
},
|
|
84319
|
-
"createFromTemplate": {
|
|
84320
|
-
"type": "boolean",
|
|
84321
|
-
"description": "Allows the partner to create charge points from templates."
|
|
84322
|
-
},
|
|
84323
|
-
"changeSystemStatus": {
|
|
84324
|
-
"type": "boolean",
|
|
84325
|
-
"description": "Allows the partner to change the system status of charge points."
|
|
84326
|
-
}
|
|
84327
|
-
}
|
|
84328
|
-
},
|
|
84329
|
-
"revenueSharing": {
|
|
84330
|
-
"type": "object",
|
|
84331
|
-
"properties": {
|
|
84332
|
-
"partnerSharePercentageAcEvse": {
|
|
84333
|
-
"type": "number",
|
|
84334
|
-
"format": "float",
|
|
84335
|
-
"minimum": 0,
|
|
84336
|
-
"maximum": 100
|
|
84337
|
-
},
|
|
84338
|
-
"partnerSharePercentageDcEvse": {
|
|
84339
|
-
"type": "number",
|
|
84340
|
-
"format": "float",
|
|
84341
|
-
"minimum": 0,
|
|
84342
|
-
"maximum": 100
|
|
84343
|
-
},
|
|
84344
|
-
"excludeConnectionFee": {
|
|
84345
|
-
"type": "boolean",
|
|
84346
|
-
"description": "If the tariff has a Connection fee, this fee would not be included in the revenue sharing with the Partner and will remain entirely for the Operator."
|
|
84347
|
-
},
|
|
84348
|
-
"deductElectricityCost": {
|
|
84349
|
-
"type": "boolean",
|
|
84350
|
-
"description": "The cost of the electricity would first be deducted from the collected revenue and then the Revenue sharing rules will be applied."
|
|
84351
|
-
},
|
|
84352
|
-
"reimburseForElectricityCost": {
|
|
84353
|
-
"type": "boolean",
|
|
84354
|
-
"description": "If set to true, the Partner would receive not only their share of the revenue but also a reimbursement for the cost of the electricity. The formula to calculate the amount to be received by the Partner is (Revenue - Electricity cost) x Partner percentage + Electricity cost. It could be supplied only if deductElectricityCost is set to true."
|
|
84355
|
-
},
|
|
84356
|
-
"fixedFeePerSessionAc": {
|
|
84357
|
-
"type": "number",
|
|
84358
|
-
"format": "float",
|
|
84359
|
-
"nullable": true,
|
|
84360
|
-
"description": "Additional flat fee that is applied for every billed session and subtracted from the Partner's share of the revenue for each session on AC Charging Station."
|
|
84361
|
-
},
|
|
84362
|
-
"fixedFeePerSessionDc": {
|
|
84363
|
-
"type": "number",
|
|
84364
|
-
"format": "float",
|
|
84365
|
-
"nullable": true,
|
|
84366
|
-
"description": "Additional flat fee that is applied for every billed session and subtracted from the Partner's share of the revenue for each session on DC Charging Station."
|
|
84367
|
-
},
|
|
84368
|
-
"feePerKwhAc": {
|
|
84369
|
-
"type": "number",
|
|
84370
|
-
"format": "float",
|
|
84371
|
-
"nullable": true,
|
|
84372
|
-
"description": "Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on AC Charging Station."
|
|
84373
|
-
},
|
|
84374
|
-
"feePerKwhDc": {
|
|
84375
|
-
"type": "number",
|
|
84376
|
-
"format": "float",
|
|
84377
|
-
"nullable": true,
|
|
84378
|
-
"description": "Additional flat fee that is applied for every billed kWh and subtracted from the Partner's share of the revenue for each kWh billed on DC Charging Station."
|
|
84379
|
-
},
|
|
84380
|
-
"handlingFee": {
|
|
84381
|
-
"type": "number",
|
|
84382
|
-
"format": "float",
|
|
84383
|
-
"minimum": 0,
|
|
84384
|
-
"maximum": 100,
|
|
84385
|
-
"nullable": true,
|
|
84386
|
-
"description": "Additional percentage fee to be applied on the total amount paid by the user for the session. This fee is then subtracted from the Partner's share of the revenue."
|
|
84387
|
-
}
|
|
84388
|
-
}
|
|
84389
|
-
},
|
|
84390
|
-
"monthlyPlatformFees": {
|
|
84391
|
-
"type": "object",
|
|
84392
|
-
"properties": {
|
|
84393
|
-
"perChargePoint": {
|
|
84394
|
-
"type": "number",
|
|
84395
|
-
"format": "float",
|
|
84396
|
-
"description": "The provided amount should be excluding VAT."
|
|
84397
|
-
},
|
|
84398
|
-
"perAcEvse": {
|
|
84399
|
-
"type": "number",
|
|
84400
|
-
"format": "float",
|
|
84401
|
-
"description": "The provided amount should be excluding VAT."
|
|
84402
|
-
},
|
|
84403
|
-
"perDcEvse": {
|
|
84404
|
-
"type": "number",
|
|
84405
|
-
"format": "float",
|
|
84406
|
-
"description": "The provided amount should be excluding VAT."
|
|
84407
|
-
}
|
|
84408
|
-
}
|
|
84409
|
-
},
|
|
84410
|
-
"reimbursementFees": {
|
|
84411
|
-
"type": "object",
|
|
84412
|
-
"description": "Home-charging reimbursement fees configured on the contract itself and charged to the partner for reimbursed charging sessions and reimbursement periods. Only available when the home-charging reimbursement feature is enabled for the operator. All other home-charging reimbursement settings are managed on the partner resource.\n",
|
|
84413
|
-
"properties": {
|
|
84414
|
-
"perSession": {
|
|
84415
|
-
"type": "number",
|
|
84416
|
-
"format": "float",
|
|
84417
|
-
"minimum": 0,
|
|
84418
|
-
"description": "Flat fee charged for every reimbursed charging session, in the contract's currency."
|
|
84419
|
-
},
|
|
84420
|
-
"perPeriod": {
|
|
84421
|
-
"type": "number",
|
|
84422
|
-
"format": "float",
|
|
84423
|
-
"minimum": 0,
|
|
84424
|
-
"description": "Flat fee charged for every reimbursement period, in the contract's currency."
|
|
84425
|
-
}
|
|
84426
|
-
}
|
|
84427
|
-
},
|
|
84428
|
-
"lastUpdatedAt": {
|
|
84429
|
-
"type": "string",
|
|
84430
|
-
"format": "date-time",
|
|
84431
|
-
"description": "ISO 8601 formatted date",
|
|
84432
|
-
"readOnly": true
|
|
84433
|
-
}
|
|
84434
|
-
},
|
|
84435
|
-
"required": [
|
|
84436
|
-
"id",
|
|
84437
|
-
"operatorId",
|
|
84438
|
-
"title",
|
|
84439
|
-
"partnerId",
|
|
84440
|
-
"startDate"
|
|
84441
|
-
]
|
|
84442
|
-
}
|
|
84443
|
-
}
|
|
84444
|
-
}
|
|
84445
85627
|
},
|
|
84446
|
-
"
|
|
85628
|
+
"409": {
|
|
84447
85629
|
"schema": {
|
|
84448
85630
|
"type": "object",
|
|
85631
|
+
"required": [
|
|
85632
|
+
"errorCode"
|
|
85633
|
+
],
|
|
84449
85634
|
"properties": {
|
|
84450
85635
|
"message": {
|
|
84451
85636
|
"type": "string"
|
|
84452
|
-
}
|
|
84453
|
-
|
|
84454
|
-
}
|
|
84455
|
-
},
|
|
84456
|
-
"403": {
|
|
84457
|
-
"schema": {
|
|
84458
|
-
"type": "object",
|
|
84459
|
-
"properties": {
|
|
84460
|
-
"message": {
|
|
85637
|
+
},
|
|
85638
|
+
"errorCode": {
|
|
84461
85639
|
"type": "string",
|
|
84462
|
-
"
|
|
85640
|
+
"description": "Machine-readable error code describing the conflict.\n\nAllowed values:\n- `override_priority_taken` - Another active override on the same partner contract already uses the requested priority.\n",
|
|
85641
|
+
"enum": [
|
|
85642
|
+
"override_priority_taken"
|
|
85643
|
+
]
|
|
84463
85644
|
}
|
|
84464
85645
|
}
|
|
84465
85646
|
}
|
|
84466
85647
|
},
|
|
84467
|
-
"
|
|
85648
|
+
"412": {
|
|
84468
85649
|
"schema": {
|
|
84469
85650
|
"type": "object",
|
|
85651
|
+
"required": [
|
|
85652
|
+
"errorCode"
|
|
85653
|
+
],
|
|
84470
85654
|
"properties": {
|
|
84471
85655
|
"message": {
|
|
84472
85656
|
"type": "string"
|
|
85657
|
+
},
|
|
85658
|
+
"errorCode": {
|
|
85659
|
+
"type": "string",
|
|
85660
|
+
"description": "Machine-readable error code describing the unmet precondition.\n\nAllowed values:\n- `settlement_overrides_not_enabled` - Settlement overrides are not enabled for the operator owning the partner contract.\n",
|
|
85661
|
+
"enum": [
|
|
85662
|
+
"settlement_overrides_not_enabled"
|
|
85663
|
+
]
|
|
84473
85664
|
}
|
|
84474
85665
|
}
|
|
84475
85666
|
}
|
|
@@ -92345,7 +93536,7 @@
|
|
|
92345
93536
|
"ga-IE",
|
|
92346
93537
|
"bs",
|
|
92347
93538
|
"ja",
|
|
92348
|
-
"ko",
|
|
93539
|
+
"ko-KR",
|
|
92349
93540
|
"cs",
|
|
92350
93541
|
"lv",
|
|
92351
93542
|
"et",
|
|
@@ -92656,7 +93847,7 @@
|
|
|
92656
93847
|
"ga-IE",
|
|
92657
93848
|
"bs",
|
|
92658
93849
|
"ja",
|
|
92659
|
-
"ko",
|
|
93850
|
+
"ko-KR",
|
|
92660
93851
|
"cs",
|
|
92661
93852
|
"lv",
|
|
92662
93853
|
"et",
|
|
@@ -92918,7 +94109,7 @@
|
|
|
92918
94109
|
"ga-IE",
|
|
92919
94110
|
"bs",
|
|
92920
94111
|
"ja",
|
|
92921
|
-
"ko",
|
|
94112
|
+
"ko-KR",
|
|
92922
94113
|
"cs",
|
|
92923
94114
|
"lv",
|
|
92924
94115
|
"et",
|
|
@@ -93211,7 +94402,7 @@
|
|
|
93211
94402
|
"ga-IE",
|
|
93212
94403
|
"bs",
|
|
93213
94404
|
"ja",
|
|
93214
|
-
"ko",
|
|
94405
|
+
"ko-KR",
|
|
93215
94406
|
"cs",
|
|
93216
94407
|
"lv",
|
|
93217
94408
|
"et",
|
|
@@ -100246,7 +101437,7 @@
|
|
|
100246
101437
|
"ga-IE",
|
|
100247
101438
|
"bs",
|
|
100248
101439
|
"ja",
|
|
100249
|
-
"ko",
|
|
101440
|
+
"ko-KR",
|
|
100250
101441
|
"cs",
|
|
100251
101442
|
"lv",
|
|
100252
101443
|
"et",
|
|
@@ -101487,7 +102678,7 @@
|
|
|
101487
102678
|
"ga-IE",
|
|
101488
102679
|
"bs",
|
|
101489
102680
|
"ja",
|
|
101490
|
-
"ko",
|
|
102681
|
+
"ko-KR",
|
|
101491
102682
|
"cs",
|
|
101492
102683
|
"lv",
|
|
101493
102684
|
"et",
|
|
@@ -102603,7 +103794,7 @@
|
|
|
102603
103794
|
"ga-IE",
|
|
102604
103795
|
"bs",
|
|
102605
103796
|
"ja",
|
|
102606
|
-
"ko",
|
|
103797
|
+
"ko-KR",
|
|
102607
103798
|
"cs",
|
|
102608
103799
|
"lv",
|
|
102609
103800
|
"et",
|
|
@@ -103782,7 +104973,7 @@
|
|
|
103782
104973
|
"ga-IE",
|
|
103783
104974
|
"bs",
|
|
103784
104975
|
"ja",
|
|
103785
|
-
"ko",
|
|
104976
|
+
"ko-KR",
|
|
103786
104977
|
"cs",
|
|
103787
104978
|
"lv",
|
|
103788
104979
|
"et",
|
|
@@ -120131,7 +121322,7 @@
|
|
|
120131
121322
|
},
|
|
120132
121323
|
"partnerContractId": {
|
|
120133
121324
|
"type": "integer",
|
|
120134
|
-
"description": "Partner contract the policy is scoped to.
|
|
121325
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120135
121326
|
},
|
|
120136
121327
|
"electricityRateId": {
|
|
120137
121328
|
"type": "integer",
|
|
@@ -120321,7 +121512,7 @@
|
|
|
120321
121512
|
},
|
|
120322
121513
|
"partnerContractId": {
|
|
120323
121514
|
"type": "integer",
|
|
120324
|
-
"description": "Partner contract the policy is scoped to.
|
|
121515
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120325
121516
|
},
|
|
120326
121517
|
"electricityRateId": {
|
|
120327
121518
|
"type": "integer",
|
|
@@ -120452,7 +121643,7 @@
|
|
|
120452
121643
|
},
|
|
120453
121644
|
"partnerContractId": {
|
|
120454
121645
|
"type": "integer",
|
|
120455
|
-
"description": "Partner contract the policy is scoped to.
|
|
121646
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120456
121647
|
},
|
|
120457
121648
|
"electricityRateId": {
|
|
120458
121649
|
"type": "integer",
|
|
@@ -120646,7 +121837,7 @@
|
|
|
120646
121837
|
},
|
|
120647
121838
|
"partnerContractId": {
|
|
120648
121839
|
"type": "integer",
|
|
120649
|
-
"description": "Partner contract the policy is scoped to.
|
|
121840
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120650
121841
|
},
|
|
120651
121842
|
"electricityRateId": {
|
|
120652
121843
|
"type": "integer",
|
|
@@ -139463,6 +140654,11 @@
|
|
|
139463
140654
|
"type": "string",
|
|
139464
140655
|
"maxLength": 150,
|
|
139465
140656
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
140657
|
+
},
|
|
140658
|
+
"totalCostFallbackMessage": {
|
|
140659
|
+
"type": "string",
|
|
140660
|
+
"maxLength": 150,
|
|
140661
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139466
140662
|
}
|
|
139467
140663
|
}
|
|
139468
140664
|
},
|
|
@@ -139700,6 +140896,11 @@
|
|
|
139700
140896
|
"type": "string",
|
|
139701
140897
|
"maxLength": 150,
|
|
139702
140898
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
140899
|
+
},
|
|
140900
|
+
"totalCostFallbackMessage": {
|
|
140901
|
+
"type": "string",
|
|
140902
|
+
"maxLength": 150,
|
|
140903
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139703
140904
|
}
|
|
139704
140905
|
}
|
|
139705
140906
|
},
|
|
@@ -139822,6 +141023,11 @@
|
|
|
139822
141023
|
"type": "string",
|
|
139823
141024
|
"maxLength": 150,
|
|
139824
141025
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
141026
|
+
},
|
|
141027
|
+
"totalCostFallbackMessage": {
|
|
141028
|
+
"type": "string",
|
|
141029
|
+
"maxLength": 150,
|
|
141030
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139825
141031
|
}
|
|
139826
141032
|
}
|
|
139827
141033
|
},
|
|
@@ -139932,6 +141138,11 @@
|
|
|
139932
141138
|
"type": "string",
|
|
139933
141139
|
"maxLength": 150,
|
|
139934
141140
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
141141
|
+
},
|
|
141142
|
+
"totalCostFallbackMessage": {
|
|
141143
|
+
"type": "string",
|
|
141144
|
+
"maxLength": 150,
|
|
141145
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139935
141146
|
}
|
|
139936
141147
|
}
|
|
139937
141148
|
},
|
|
@@ -141015,6 +142226,14 @@
|
|
|
141015
142226
|
"type": "string"
|
|
141016
142227
|
}
|
|
141017
142228
|
},
|
|
142229
|
+
"applyToHomeChargingOwner": {
|
|
142230
|
+
"type": "boolean",
|
|
142231
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
142232
|
+
},
|
|
142233
|
+
"applyToHomeChargingSharedUsers": {
|
|
142234
|
+
"type": "boolean",
|
|
142235
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
142236
|
+
},
|
|
141018
142237
|
"applyToUserGroupIds": {
|
|
141019
142238
|
"type": "array",
|
|
141020
142239
|
"description": "An array of user group IDs. Users with a specific group. Provide a list of user group IDs. This restriction applies if the user is a member of at least one of the groups.",
|
|
@@ -142161,6 +143380,14 @@
|
|
|
142161
143380
|
"type": "string"
|
|
142162
143381
|
}
|
|
142163
143382
|
},
|
|
143383
|
+
"applyToHomeChargingOwner": {
|
|
143384
|
+
"type": "boolean",
|
|
143385
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
143386
|
+
},
|
|
143387
|
+
"applyToHomeChargingSharedUsers": {
|
|
143388
|
+
"type": "boolean",
|
|
143389
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
143390
|
+
},
|
|
142164
143391
|
"applyToUserGroupIds": {
|
|
142165
143392
|
"type": "array",
|
|
142166
143393
|
"description": "An array of user group IDs. Users with a specific group. Provide a list of user group IDs. This restriction applies if the user is a member of at least one of the groups.",
|
|
@@ -143434,6 +144661,14 @@
|
|
|
143434
144661
|
"type": "string"
|
|
143435
144662
|
}
|
|
143436
144663
|
},
|
|
144664
|
+
"applyToHomeChargingOwner": {
|
|
144665
|
+
"type": "boolean",
|
|
144666
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
144667
|
+
},
|
|
144668
|
+
"applyToHomeChargingSharedUsers": {
|
|
144669
|
+
"type": "boolean",
|
|
144670
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
144671
|
+
},
|
|
143437
144672
|
"applyToUserGroupIds": {
|
|
143438
144673
|
"type": "array",
|
|
143439
144674
|
"description": "An array of user group IDs. Users with a specific group. Provide a list of user group IDs. This restriction applies if the user is a member of at least one of the groups.",
|
|
@@ -144592,6 +145827,14 @@
|
|
|
144592
145827
|
"type": "string"
|
|
144593
145828
|
}
|
|
144594
145829
|
},
|
|
145830
|
+
"applyToHomeChargingOwner": {
|
|
145831
|
+
"type": "boolean",
|
|
145832
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
145833
|
+
},
|
|
145834
|
+
"applyToHomeChargingSharedUsers": {
|
|
145835
|
+
"type": "boolean",
|
|
145836
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
145837
|
+
},
|
|
144595
145838
|
"applyToUserGroupIds": {
|
|
144596
145839
|
"type": "array",
|
|
144597
145840
|
"description": "An array of user group IDs. Users with a specific group. Provide a list of user group IDs. This restriction applies if the user is a member of at least one of the groups.",
|
|
@@ -145738,6 +146981,14 @@
|
|
|
145738
146981
|
"type": "string"
|
|
145739
146982
|
}
|
|
145740
146983
|
},
|
|
146984
|
+
"applyToHomeChargingOwner": {
|
|
146985
|
+
"type": "boolean",
|
|
146986
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
146987
|
+
},
|
|
146988
|
+
"applyToHomeChargingSharedUsers": {
|
|
146989
|
+
"type": "boolean",
|
|
146990
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
146991
|
+
},
|
|
145741
146992
|
"applyToUserGroupIds": {
|
|
145742
146993
|
"type": "array",
|
|
145743
146994
|
"description": "An array of user group IDs. Users with a specific group. Provide a list of user group IDs. This restriction applies if the user is a member of at least one of the groups.",
|
|
@@ -146959,6 +148210,14 @@
|
|
|
146959
148210
|
"type": "string"
|
|
146960
148211
|
}
|
|
146961
148212
|
},
|
|
148213
|
+
"applyToHomeChargingOwner": {
|
|
148214
|
+
"type": "boolean",
|
|
148215
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
148216
|
+
},
|
|
148217
|
+
"applyToHomeChargingSharedUsers": {
|
|
148218
|
+
"type": "boolean",
|
|
148219
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
148220
|
+
},
|
|
146962
148221
|
"applyToUserGroupIds": {
|
|
146963
148222
|
"type": "array",
|
|
146964
148223
|
"description": "An array of user group IDs. Users with a specific group. Provide a list of user group IDs. This restriction applies if the user is a member of at least one of the groups.",
|