@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
|
@@ -402,12 +402,11 @@
|
|
|
402
402
|
"method": "POST",
|
|
403
403
|
"operationId": "chargePointGetDiagnostics",
|
|
404
404
|
"summary": "Charge Point / Get Diagnostics",
|
|
405
|
-
"description": "Request a get diagnostics upload from the charge point",
|
|
405
|
+
"description": "Request a get diagnostics upload from the charge point. When `location` is omitted, the upload destination configured on the charge point's operator is used, extended with a folder named after the charge point manufacturer, and the operator's default reason, retries and retry interval are applied. If the operator has no diagnostics upload destination configured, the request is rejected with `412 Precondition Failed`.",
|
|
406
406
|
"tags": [
|
|
407
407
|
"action / charge point"
|
|
408
408
|
],
|
|
409
409
|
"requestBody": {
|
|
410
|
-
"required": true,
|
|
411
410
|
"content": {
|
|
412
411
|
"application/json": {
|
|
413
412
|
"schema": {
|
|
@@ -415,7 +414,7 @@
|
|
|
415
414
|
"properties": {
|
|
416
415
|
"location": {
|
|
417
416
|
"type": "string",
|
|
418
|
-
"description": "URL where the charge point will upload the diagnostics file. Any scheme the charge point supports is accepted - FTP, FTPS, HTTP or HTTPS."
|
|
417
|
+
"description": "URL where the charge point will upload the diagnostics file. Any scheme the charge point supports is accepted - FTP, FTPS, HTTP or HTTPS. Optional - when omitted, the upload destination configured on the operator is used instead."
|
|
419
418
|
},
|
|
420
419
|
"start": {
|
|
421
420
|
"type": "string",
|
|
@@ -427,10 +426,7 @@
|
|
|
427
426
|
"format": "date-time",
|
|
428
427
|
"description": "Only get diagnostics that are created before that date-time"
|
|
429
428
|
}
|
|
430
|
-
}
|
|
431
|
-
"required": [
|
|
432
|
-
"location"
|
|
433
|
-
]
|
|
429
|
+
}
|
|
434
430
|
},
|
|
435
431
|
"examples": {
|
|
436
432
|
"ftp": {
|
|
@@ -444,6 +440,14 @@
|
|
|
444
440
|
"location": "https://example.com/diagnostics/upload",
|
|
445
441
|
"start": "2020-07-21T00:00:00.000Z"
|
|
446
442
|
}
|
|
443
|
+
},
|
|
444
|
+
"operatorUploadDestination": {
|
|
445
|
+
"value": {
|
|
446
|
+
"start": "2020-07-21T00:00:00.000Z"
|
|
447
|
+
}
|
|
448
|
+
},
|
|
449
|
+
"operatorUploadDestinationNoWindow": {
|
|
450
|
+
"value": {}
|
|
447
451
|
}
|
|
448
452
|
}
|
|
449
453
|
}
|
|
@@ -465,6 +469,9 @@
|
|
|
465
469
|
"406": {
|
|
466
470
|
"description": "Action rejected by the Charge Point"
|
|
467
471
|
},
|
|
472
|
+
"412": {
|
|
473
|
+
"description": "A precondition for performing this action is not met. The response message states which precondition failed."
|
|
474
|
+
},
|
|
468
475
|
"422": {
|
|
469
476
|
"description": "The payload you provided is invalid"
|
|
470
477
|
},
|
|
@@ -34527,6 +34534,22 @@
|
|
|
34527
34534
|
"tags": [
|
|
34528
34535
|
"resource / partner contracts"
|
|
34529
34536
|
],
|
|
34537
|
+
"parameters": {
|
|
34538
|
+
"query": {
|
|
34539
|
+
"include": {
|
|
34540
|
+
"description": "Optional related records to embed in the response. `settlementOverrides` — ⚠️ experimental. Returns the active settlement overrides of the contract, newest first. The embedded objects are not yet a stable contract and may change, including breaking changes, within `v1.0`.",
|
|
34541
|
+
"schema": {
|
|
34542
|
+
"type": "array",
|
|
34543
|
+
"items": {
|
|
34544
|
+
"type": "string",
|
|
34545
|
+
"enum": [
|
|
34546
|
+
"settlementOverrides"
|
|
34547
|
+
]
|
|
34548
|
+
}
|
|
34549
|
+
}
|
|
34550
|
+
}
|
|
34551
|
+
}
|
|
34552
|
+
},
|
|
34530
34553
|
"responses": {
|
|
34531
34554
|
"200": {
|
|
34532
34555
|
"description": "Success"
|
|
@@ -34986,6 +35009,328 @@
|
|
|
34986
35009
|
}
|
|
34987
35010
|
}
|
|
34988
35011
|
},
|
|
35012
|
+
{
|
|
35013
|
+
"path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides",
|
|
35014
|
+
"method": "GET",
|
|
35015
|
+
"operationId": "partnerContractSettlementOverridesListing",
|
|
35016
|
+
"summary": "Partner contract / Settlement overrides / Listing",
|
|
35017
|
+
"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. List all settlement overrides of a specific partner contract, newest first. **Required permission:** `PartnerContracts.view`",
|
|
35018
|
+
"tags": [
|
|
35019
|
+
"resource / partner contracts"
|
|
35020
|
+
],
|
|
35021
|
+
"parameters": {
|
|
35022
|
+
"query": {
|
|
35023
|
+
"per_page": {
|
|
35024
|
+
"description": "The number of items to return per page.",
|
|
35025
|
+
"type": "integer",
|
|
35026
|
+
"minimum": 1,
|
|
35027
|
+
"maximum": 100,
|
|
35028
|
+
"default": 100
|
|
35029
|
+
},
|
|
35030
|
+
"cursor": {
|
|
35031
|
+
"description": "The cursor to fetch the next page. **Do not construct this value manually.** Use one of the following methods: - Use the value from the previous response's `links.next` to fetch the next page - Pass an empty string (e.g., `?cursor` or `?cursor=`) to initiate cursor pagination on the first page",
|
|
35032
|
+
"type": "string"
|
|
35033
|
+
}
|
|
35034
|
+
}
|
|
35035
|
+
},
|
|
35036
|
+
"responses": {
|
|
35037
|
+
"200": {
|
|
35038
|
+
"description": "Success"
|
|
35039
|
+
},
|
|
35040
|
+
"401": {
|
|
35041
|
+
"description": "Access token is missing or invalid"
|
|
35042
|
+
},
|
|
35043
|
+
"403": {
|
|
35044
|
+
"description": "You do not have permission to perform the action"
|
|
35045
|
+
},
|
|
35046
|
+
"404": {
|
|
35047
|
+
"description": "The record is not found"
|
|
35048
|
+
},
|
|
35049
|
+
"429": {
|
|
35050
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
35051
|
+
}
|
|
35052
|
+
}
|
|
35053
|
+
},
|
|
35054
|
+
{
|
|
35055
|
+
"path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides",
|
|
35056
|
+
"method": "POST",
|
|
35057
|
+
"operationId": "partnerContractSettlementOverrideCreate",
|
|
35058
|
+
"summary": "Partner contract / Settlement override / Create",
|
|
35059
|
+
"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. Create a settlement override for a specific partner contract. Available only when settlement overrides are enabled for the operator owning the partner contract; otherwise the request is rejected with `412` and `errorCode` `settlement_overrides_not_enabled`. When the payload is valid but another active override on the contract already uses the requested priority, the request is rejected with `409` and `errorCode` `override_priority_taken`. Every other rejection is an ordinary `422` listing the offending properties in the `errors` map and carrying no `errorCode` — including a name already used by another active override, and including the priority conflict when the payload fails other rules as well. **Required permission:** `PartnerContracts.create`",
|
|
35060
|
+
"tags": [
|
|
35061
|
+
"resource / partner contracts"
|
|
35062
|
+
],
|
|
35063
|
+
"requestBody": {
|
|
35064
|
+
"required": true,
|
|
35065
|
+
"content": {
|
|
35066
|
+
"application/json": {
|
|
35067
|
+
"schema": {
|
|
35068
|
+
"type": "object",
|
|
35069
|
+
"properties": {
|
|
35070
|
+
"name": {
|
|
35071
|
+
"type": "string",
|
|
35072
|
+
"maxLength": 255,
|
|
35073
|
+
"example": "Fleet drivers",
|
|
35074
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract."
|
|
35075
|
+
},
|
|
35076
|
+
"priority": {
|
|
35077
|
+
"type": "integer",
|
|
35078
|
+
"minimum": 1,
|
|
35079
|
+
"maximum": 4294967295,
|
|
35080
|
+
"example": 1,
|
|
35081
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract. The lowest value that matches a session wins."
|
|
35082
|
+
},
|
|
35083
|
+
"restriction": {
|
|
35084
|
+
"type": "object",
|
|
35085
|
+
"properties": {
|
|
35086
|
+
"type": {
|
|
35087
|
+
"type": "string",
|
|
35088
|
+
"enum": [
|
|
35089
|
+
"users_of_the_partner",
|
|
35090
|
+
"user_groups",
|
|
35091
|
+
"ad_hoc_users",
|
|
35092
|
+
"users_of_specific_partners"
|
|
35093
|
+
],
|
|
35094
|
+
"description": "Which users of the partner contract the settlement override applies to. Allowed values: - `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner. - `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`. - `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users. - `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`."
|
|
35095
|
+
},
|
|
35096
|
+
"targetIds": {
|
|
35097
|
+
"type": "array",
|
|
35098
|
+
"items": {
|
|
35099
|
+
"type": "integer"
|
|
35100
|
+
},
|
|
35101
|
+
"example": [
|
|
35102
|
+
12,
|
|
35103
|
+
34
|
|
35104
|
+
],
|
|
35105
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs for `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two types and omitted for every other type."
|
|
35106
|
+
}
|
|
35107
|
+
},
|
|
35108
|
+
"required": [
|
|
35109
|
+
"type"
|
|
35110
|
+
],
|
|
35111
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and determines what `targetIds` references."
|
|
35112
|
+
},
|
|
35113
|
+
"acPercent": {
|
|
35114
|
+
"type": "number",
|
|
35115
|
+
"format": "float",
|
|
35116
|
+
"minimum": 0,
|
|
35117
|
+
"maximum": 100,
|
|
35118
|
+
"example": 70.5,
|
|
35119
|
+
"description": "Partner share percentage applied to AC sessions matched by this override. Omit to inherit the value from the partner contract. At least one of `acPercent` and `dcPercent` must be provided."
|
|
35120
|
+
},
|
|
35121
|
+
"dcPercent": {
|
|
35122
|
+
"type": "number",
|
|
35123
|
+
"format": "float",
|
|
35124
|
+
"minimum": 0,
|
|
35125
|
+
"maximum": 100,
|
|
35126
|
+
"example": 60,
|
|
35127
|
+
"description": "Partner share percentage applied to DC sessions matched by this override. Omit to inherit the value from the partner contract. At least one of `acPercent` and `dcPercent` must be provided."
|
|
35128
|
+
}
|
|
35129
|
+
},
|
|
35130
|
+
"required": [
|
|
35131
|
+
"name",
|
|
35132
|
+
"priority",
|
|
35133
|
+
"restriction"
|
|
35134
|
+
],
|
|
35135
|
+
"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. Settlement override create schema. Every property that is omitted takes its documented default; `acPercent` and `dcPercent` cannot both be omitted."
|
|
35136
|
+
}
|
|
35137
|
+
}
|
|
35138
|
+
}
|
|
35139
|
+
},
|
|
35140
|
+
"responses": {
|
|
35141
|
+
"201": {
|
|
35142
|
+
"description": "Settlement override created successfully"
|
|
35143
|
+
},
|
|
35144
|
+
"401": {
|
|
35145
|
+
"description": "Access token is missing or invalid"
|
|
35146
|
+
},
|
|
35147
|
+
"403": {
|
|
35148
|
+
"description": "You do not have permission to perform the action"
|
|
35149
|
+
},
|
|
35150
|
+
"404": {
|
|
35151
|
+
"description": "The record is not found"
|
|
35152
|
+
},
|
|
35153
|
+
"409": {
|
|
35154
|
+
"description": "The request conflicts with the current state of the partner contract: another active override already uses the requested priority. The payload itself is valid, so retrying with a free priority succeeds."
|
|
35155
|
+
},
|
|
35156
|
+
"412": {
|
|
35157
|
+
"description": "The partner contract does not meet a precondition of the action: settlement overrides are not enabled for the operator owning it. Enabling them in the admin makes the action available."
|
|
35158
|
+
},
|
|
35159
|
+
"422": {
|
|
35160
|
+
"description": "The payload you provided is invalid"
|
|
35161
|
+
},
|
|
35162
|
+
"429": {
|
|
35163
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
35164
|
+
}
|
|
35165
|
+
}
|
|
35166
|
+
},
|
|
35167
|
+
{
|
|
35168
|
+
"path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides/{settlementOverride}",
|
|
35169
|
+
"method": "GET",
|
|
35170
|
+
"operationId": "partnerContractSettlementOverrideRead",
|
|
35171
|
+
"summary": "Partner contract / Settlement override / Read",
|
|
35172
|
+
"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. Read a single settlement override of a specific partner contract. **Required permission:** `PartnerContracts.view`",
|
|
35173
|
+
"tags": [
|
|
35174
|
+
"resource / partner contracts"
|
|
35175
|
+
],
|
|
35176
|
+
"responses": {
|
|
35177
|
+
"200": {
|
|
35178
|
+
"description": "Success"
|
|
35179
|
+
},
|
|
35180
|
+
"401": {
|
|
35181
|
+
"description": "Access token is missing or invalid"
|
|
35182
|
+
},
|
|
35183
|
+
"403": {
|
|
35184
|
+
"description": "You do not have permission to perform the action"
|
|
35185
|
+
},
|
|
35186
|
+
"404": {
|
|
35187
|
+
"description": "The record is not found"
|
|
35188
|
+
},
|
|
35189
|
+
"429": {
|
|
35190
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
35191
|
+
}
|
|
35192
|
+
}
|
|
35193
|
+
},
|
|
35194
|
+
{
|
|
35195
|
+
"path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides/{settlementOverride}",
|
|
35196
|
+
"method": "DELETE",
|
|
35197
|
+
"operationId": "partnerContractSettlementOverrideDelete",
|
|
35198
|
+
"summary": "Partner contract / Settlement override / Delete",
|
|
35199
|
+
"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. Delete a settlement override from a specific partner contract. Available only when settlement overrides are enabled for the operator owning the partner contract; otherwise the request is rejected with `412` and `errorCode` `settlement_overrides_not_enabled`. **Required permission:** `PartnerContracts.delete`",
|
|
35200
|
+
"tags": [
|
|
35201
|
+
"resource / partner contracts"
|
|
35202
|
+
],
|
|
35203
|
+
"responses": {
|
|
35204
|
+
"204": {
|
|
35205
|
+
"description": "Settlement override deleted successfully"
|
|
35206
|
+
},
|
|
35207
|
+
"401": {
|
|
35208
|
+
"description": "Access token is missing or invalid"
|
|
35209
|
+
},
|
|
35210
|
+
"403": {
|
|
35211
|
+
"description": "You do not have permission to perform the action"
|
|
35212
|
+
},
|
|
35213
|
+
"404": {
|
|
35214
|
+
"description": "The record is not found"
|
|
35215
|
+
},
|
|
35216
|
+
"412": {
|
|
35217
|
+
"description": "The partner contract does not meet a precondition of the action: settlement overrides are not enabled for the operator owning it. Enabling them in the admin makes the action available."
|
|
35218
|
+
},
|
|
35219
|
+
"429": {
|
|
35220
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
35221
|
+
}
|
|
35222
|
+
}
|
|
35223
|
+
},
|
|
35224
|
+
{
|
|
35225
|
+
"path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides/{settlementOverride}",
|
|
35226
|
+
"method": "PATCH",
|
|
35227
|
+
"operationId": "partnerContractSettlementOverrideUpdate",
|
|
35228
|
+
"summary": "Partner contract / Settlement override / Update",
|
|
35229
|
+
"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. Update a settlement override of a specific partner contract. Omitted properties keep their current value; `restriction` is replaced as a whole when present. Available only when settlement overrides are enabled for the operator owning the partner contract; otherwise the request is rejected with `412` and `errorCode` `settlement_overrides_not_enabled`. When the payload is valid but another active override on the contract already uses the requested priority, the request is rejected with `409` and `errorCode` `override_priority_taken`. Every other rejection is an ordinary `422` listing the offending properties in the `errors` map and carrying no `errorCode` — including a name already used by another active override, and including the priority conflict when the payload fails other rules as well. **Required permission:** `PartnerContracts.update`",
|
|
35230
|
+
"tags": [
|
|
35231
|
+
"resource / partner contracts"
|
|
35232
|
+
],
|
|
35233
|
+
"requestBody": {
|
|
35234
|
+
"required": true,
|
|
35235
|
+
"content": {
|
|
35236
|
+
"application/json": {
|
|
35237
|
+
"schema": {
|
|
35238
|
+
"type": "object",
|
|
35239
|
+
"properties": {
|
|
35240
|
+
"name": {
|
|
35241
|
+
"type": "string",
|
|
35242
|
+
"maxLength": 255,
|
|
35243
|
+
"example": "Fleet drivers",
|
|
35244
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract."
|
|
35245
|
+
},
|
|
35246
|
+
"priority": {
|
|
35247
|
+
"type": "integer",
|
|
35248
|
+
"minimum": 1,
|
|
35249
|
+
"maximum": 4294967295,
|
|
35250
|
+
"example": 1,
|
|
35251
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract. The lowest value that matches a session wins."
|
|
35252
|
+
},
|
|
35253
|
+
"restriction": {
|
|
35254
|
+
"type": "object",
|
|
35255
|
+
"properties": {
|
|
35256
|
+
"type": {
|
|
35257
|
+
"type": "string",
|
|
35258
|
+
"enum": [
|
|
35259
|
+
"users_of_the_partner",
|
|
35260
|
+
"user_groups",
|
|
35261
|
+
"ad_hoc_users",
|
|
35262
|
+
"users_of_specific_partners"
|
|
35263
|
+
],
|
|
35264
|
+
"description": "Which users of the partner contract the settlement override applies to. Allowed values: - `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner. - `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`. - `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users. - `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`."
|
|
35265
|
+
},
|
|
35266
|
+
"targetIds": {
|
|
35267
|
+
"type": "array",
|
|
35268
|
+
"items": {
|
|
35269
|
+
"type": "integer"
|
|
35270
|
+
},
|
|
35271
|
+
"example": [
|
|
35272
|
+
12,
|
|
35273
|
+
34
|
|
35274
|
+
],
|
|
35275
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs for `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two types and omitted for every other type."
|
|
35276
|
+
}
|
|
35277
|
+
},
|
|
35278
|
+
"required": [
|
|
35279
|
+
"type"
|
|
35280
|
+
],
|
|
35281
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and determines what `targetIds` references."
|
|
35282
|
+
},
|
|
35283
|
+
"acPercent": {
|
|
35284
|
+
"type": "number",
|
|
35285
|
+
"format": "float",
|
|
35286
|
+
"minimum": 0,
|
|
35287
|
+
"maximum": 100,
|
|
35288
|
+
"example": 70.5,
|
|
35289
|
+
"nullable": true,
|
|
35290
|
+
"description": "Partner share percentage applied to AC sessions matched by this override. Send `null` to inherit the value from the partner contract. `acPercent` and `dcPercent` cannot both end up inherited."
|
|
35291
|
+
},
|
|
35292
|
+
"dcPercent": {
|
|
35293
|
+
"type": "number",
|
|
35294
|
+
"format": "float",
|
|
35295
|
+
"minimum": 0,
|
|
35296
|
+
"maximum": 100,
|
|
35297
|
+
"example": 60,
|
|
35298
|
+
"nullable": true,
|
|
35299
|
+
"description": "Partner share percentage applied to DC sessions matched by this override. Send `null` to inherit the value from the partner contract. `acPercent` and `dcPercent` cannot both end up inherited."
|
|
35300
|
+
}
|
|
35301
|
+
},
|
|
35302
|
+
"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. Settlement override update schema. Omitted properties keep their current value; `restriction` is replaced as a whole when present."
|
|
35303
|
+
}
|
|
35304
|
+
}
|
|
35305
|
+
}
|
|
35306
|
+
},
|
|
35307
|
+
"responses": {
|
|
35308
|
+
"200": {
|
|
35309
|
+
"description": "Settlement override updated successfully"
|
|
35310
|
+
},
|
|
35311
|
+
"401": {
|
|
35312
|
+
"description": "Access token is missing or invalid"
|
|
35313
|
+
},
|
|
35314
|
+
"403": {
|
|
35315
|
+
"description": "You do not have permission to perform the action"
|
|
35316
|
+
},
|
|
35317
|
+
"404": {
|
|
35318
|
+
"description": "The record is not found"
|
|
35319
|
+
},
|
|
35320
|
+
"409": {
|
|
35321
|
+
"description": "The request conflicts with the current state of the partner contract: another active override already uses the requested priority. The payload itself is valid, so retrying with a free priority succeeds."
|
|
35322
|
+
},
|
|
35323
|
+
"412": {
|
|
35324
|
+
"description": "The partner contract does not meet a precondition of the action: settlement overrides are not enabled for the operator owning it. Enabling them in the admin makes the action available."
|
|
35325
|
+
},
|
|
35326
|
+
"422": {
|
|
35327
|
+
"description": "The payload you provided is invalid"
|
|
35328
|
+
},
|
|
35329
|
+
"429": {
|
|
35330
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
35331
|
+
}
|
|
35332
|
+
}
|
|
35333
|
+
},
|
|
34989
35334
|
{
|
|
34990
35335
|
"path": "/public-api/resources/partner-expenses/v1.0",
|
|
34991
35336
|
"method": "GET",
|
|
@@ -38338,7 +38683,7 @@
|
|
|
38338
38683
|
"ga-IE",
|
|
38339
38684
|
"bs",
|
|
38340
38685
|
"ja",
|
|
38341
|
-
"ko",
|
|
38686
|
+
"ko-KR",
|
|
38342
38687
|
"cs",
|
|
38343
38688
|
"lv",
|
|
38344
38689
|
"et",
|
|
@@ -49034,7 +49379,7 @@
|
|
|
49034
49379
|
},
|
|
49035
49380
|
"partnerContractId": {
|
|
49036
49381
|
"type": "integer",
|
|
49037
|
-
"description": "Partner contract the policy is scoped to.
|
|
49382
|
+
"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."
|
|
49038
49383
|
},
|
|
49039
49384
|
"electricityRateId": {
|
|
49040
49385
|
"type": "integer",
|
|
@@ -49188,7 +49533,7 @@
|
|
|
49188
49533
|
"partnerContractId": {
|
|
49189
49534
|
"type": "integer",
|
|
49190
49535
|
"nullable": true,
|
|
49191
|
-
"description": "Partner contract the policy is scoped to.
|
|
49536
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner, so it cannot be set to `null` while the policy has a partner — clear `partnerId` instead, which clears the contract with it. These rules are enforced when `partnerId` or `partnerContractId` is changed; an update that leaves both unchanged is accepted as is."
|
|
49192
49537
|
},
|
|
49193
49538
|
"electricityRateId": {
|
|
49194
49539
|
"type": "integer",
|
|
@@ -56575,6 +56920,28 @@
|
|
|
56575
56920
|
"nullable": true,
|
|
56576
56921
|
"description": "The operator ID for this resource. Required for global admin tokens. Optional for operator-scoped tokens (defaults to token's operator)."
|
|
56577
56922
|
},
|
|
56923
|
+
"display": {
|
|
56924
|
+
"type": "object",
|
|
56925
|
+
"properties": {
|
|
56926
|
+
"defaultPriceInformation": {
|
|
56927
|
+
"type": "string",
|
|
56928
|
+
"maxLength": 150,
|
|
56929
|
+
"nullable": true,
|
|
56930
|
+
"description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
|
|
56931
|
+
},
|
|
56932
|
+
"defaultPriceInformationOffline": {
|
|
56933
|
+
"type": "string",
|
|
56934
|
+
"maxLength": 150,
|
|
56935
|
+
"nullable": true,
|
|
56936
|
+
"description": "The information that would be shown on the display of the charge point when offline. For OCPP 2.0.1 charge points that support tariff and cost display, this value is also set as the `TariffCostCtrlr.TariffFallbackMessage` variable."
|
|
56937
|
+
},
|
|
56938
|
+
"totalCostFallbackMessage": {
|
|
56939
|
+
"type": "string",
|
|
56940
|
+
"maxLength": 150,
|
|
56941
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved. For OCPP 2.0.1 charge points that support tariff and cost display, this value is set as the `TariffCostCtrlr.TotalCostFallbackMessage` variable."
|
|
56942
|
+
}
|
|
56943
|
+
}
|
|
56944
|
+
},
|
|
56578
56945
|
"name": {
|
|
56579
56946
|
"type": "string"
|
|
56580
56947
|
},
|
|
@@ -56595,23 +56962,6 @@
|
|
|
56595
56962
|
"nullable": true,
|
|
56596
56963
|
"description": "The tariff used to derive offline pricing for OCPP 1.6 charge points when they are not connected to the backend. Must belong to the same operator as the tariff group. Set to null to clear the assignment."
|
|
56597
56964
|
},
|
|
56598
|
-
"display": {
|
|
56599
|
-
"type": "object",
|
|
56600
|
-
"properties": {
|
|
56601
|
-
"defaultPriceInformation": {
|
|
56602
|
-
"type": "string",
|
|
56603
|
-
"maxLength": 150,
|
|
56604
|
-
"nullable": true,
|
|
56605
|
-
"description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
|
|
56606
|
-
},
|
|
56607
|
-
"defaultPriceInformationOffline": {
|
|
56608
|
-
"type": "string",
|
|
56609
|
-
"maxLength": 150,
|
|
56610
|
-
"nullable": true,
|
|
56611
|
-
"description": "The information that would be shown on the display of the charge point when offline."
|
|
56612
|
-
}
|
|
56613
|
-
}
|
|
56614
|
-
},
|
|
56615
56965
|
"lastUpdatedAt": {
|
|
56616
56966
|
"type": "string",
|
|
56617
56967
|
"format": "date-time",
|
|
@@ -56686,6 +57036,29 @@
|
|
|
56686
57036
|
"schema": {
|
|
56687
57037
|
"type": "object",
|
|
56688
57038
|
"properties": {
|
|
57039
|
+
"display": {
|
|
57040
|
+
"type": "object",
|
|
57041
|
+
"properties": {
|
|
57042
|
+
"defaultPriceInformation": {
|
|
57043
|
+
"type": "string",
|
|
57044
|
+
"maxLength": 150,
|
|
57045
|
+
"nullable": true,
|
|
57046
|
+
"description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
|
|
57047
|
+
},
|
|
57048
|
+
"defaultPriceInformationOffline": {
|
|
57049
|
+
"type": "string",
|
|
57050
|
+
"maxLength": 150,
|
|
57051
|
+
"nullable": true,
|
|
57052
|
+
"description": "The information that would be shown on the display of the charge point when offline. For OCPP 2.0.1 charge points that support tariff and cost display, this value is also set as the `TariffCostCtrlr.TariffFallbackMessage` variable."
|
|
57053
|
+
},
|
|
57054
|
+
"totalCostFallbackMessage": {
|
|
57055
|
+
"type": "string",
|
|
57056
|
+
"maxLength": 150,
|
|
57057
|
+
"nullable": true,
|
|
57058
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved. For OCPP 2.0.1 charge points that support tariff and cost display, this value is set as the `TariffCostCtrlr.TotalCostFallbackMessage` variable. Set to null to clear the message."
|
|
57059
|
+
}
|
|
57060
|
+
}
|
|
57061
|
+
},
|
|
56689
57062
|
"name": {
|
|
56690
57063
|
"type": "string"
|
|
56691
57064
|
},
|
|
@@ -56706,23 +57079,6 @@
|
|
|
56706
57079
|
"nullable": true,
|
|
56707
57080
|
"description": "The tariff used to derive offline pricing for OCPP 1.6 charge points when they are not connected to the backend. Must belong to the same operator as the tariff group. Set to null to clear the assignment."
|
|
56708
57081
|
},
|
|
56709
|
-
"display": {
|
|
56710
|
-
"type": "object",
|
|
56711
|
-
"properties": {
|
|
56712
|
-
"defaultPriceInformation": {
|
|
56713
|
-
"type": "string",
|
|
56714
|
-
"maxLength": 150,
|
|
56715
|
-
"nullable": true,
|
|
56716
|
-
"description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
|
|
56717
|
-
},
|
|
56718
|
-
"defaultPriceInformationOffline": {
|
|
56719
|
-
"type": "string",
|
|
56720
|
-
"maxLength": 150,
|
|
56721
|
-
"nullable": true,
|
|
56722
|
-
"description": "The information that would be shown on the display of the charge point when offline."
|
|
56723
|
-
}
|
|
56724
|
-
}
|
|
56725
|
-
},
|
|
56726
57082
|
"lastUpdatedAt": {
|
|
56727
57083
|
"type": "string",
|
|
56728
57084
|
"format": "date-time",
|
|
@@ -57837,6 +58193,14 @@
|
|
|
57837
58193
|
},
|
|
57838
58194
|
"description": "Users with a specific group. Provide a list of user groups. Matches if the user is a member of at least one of the groups. Note: Due to improvements in the user groups, this property could be used with some limitations: 1) The value(s) should exactly match the name(s) of the user groups. 2) It would not be possible to create a user group from here anymore. 3) If there are duplicates, the value would not be accepted."
|
|
57839
58195
|
},
|
|
58196
|
+
"applyToHomeChargingOwner": {
|
|
58197
|
+
"type": "boolean",
|
|
58198
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
58199
|
+
},
|
|
58200
|
+
"applyToHomeChargingSharedUsers": {
|
|
58201
|
+
"type": "boolean",
|
|
58202
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
58203
|
+
},
|
|
57840
58204
|
"applyToUserGroupIds": {
|
|
57841
58205
|
"type": "array",
|
|
57842
58206
|
"items": {
|
|
@@ -58949,6 +59313,14 @@
|
|
|
58949
59313
|
},
|
|
58950
59314
|
"description": "Users with a specific group. Provide a list of user groups. Matches if the user is a member of at least one of the groups. Note: Due to improvements in the user groups, this property could be used with some limitations: 1) The value(s) should exactly match the name(s) of the user groups. 2) It would not be possible to create a user group from here anymore. 3) If there are duplicates, the value would not be accepted."
|
|
58951
59315
|
},
|
|
59316
|
+
"applyToHomeChargingOwner": {
|
|
59317
|
+
"type": "boolean",
|
|
59318
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
59319
|
+
},
|
|
59320
|
+
"applyToHomeChargingSharedUsers": {
|
|
59321
|
+
"type": "boolean",
|
|
59322
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
59323
|
+
},
|
|
58952
59324
|
"applyToUserGroupIds": {
|
|
58953
59325
|
"type": "array",
|
|
58954
59326
|
"items": {
|
|
@@ -60067,6 +60439,14 @@
|
|
|
60067
60439
|
},
|
|
60068
60440
|
"description": "Users with a specific group. Provide a list of user groups. Matches if the user is a member of at least one of the groups. Note: Due to improvements in the user groups, this property could be used with some limitations: 1) The value(s) should exactly match the name(s) of the user groups. 2) It would not be possible to create a user group from here anymore. 3) If there are duplicates, the value would not be accepted."
|
|
60069
60441
|
},
|
|
60442
|
+
"applyToHomeChargingOwner": {
|
|
60443
|
+
"type": "boolean",
|
|
60444
|
+
"description": "Makes the tariff apply to the driver who owns the home charge point (the driver, not the partner that manages it)"
|
|
60445
|
+
},
|
|
60446
|
+
"applyToHomeChargingSharedUsers": {
|
|
60447
|
+
"type": "boolean",
|
|
60448
|
+
"description": "Makes the tariff apply to the drivers the owner has shared the home charge point with (accepted shares only)"
|
|
60449
|
+
},
|
|
60070
60450
|
"applyToUserGroupIds": {
|
|
60071
60451
|
"type": "array",
|
|
60072
60452
|
"items": {
|
|
@@ -69099,7 +69479,7 @@
|
|
|
69099
69479
|
"ga-IE",
|
|
69100
69480
|
"bs",
|
|
69101
69481
|
"ja",
|
|
69102
|
-
"ko",
|
|
69482
|
+
"ko-KR",
|
|
69103
69483
|
"cs",
|
|
69104
69484
|
"lv",
|
|
69105
69485
|
"et",
|
|
@@ -70020,7 +70400,7 @@
|
|
|
70020
70400
|
"ga-IE",
|
|
70021
70401
|
"bs",
|
|
70022
70402
|
"ja",
|
|
70023
|
-
"ko",
|
|
70403
|
+
"ko-KR",
|
|
70024
70404
|
"cs",
|
|
70025
70405
|
"lv",
|
|
70026
70406
|
"et",
|
|
@@ -72199,7 +72579,7 @@
|
|
|
72199
72579
|
],
|
|
72200
72580
|
"info": {
|
|
72201
72581
|
"title": "Public API",
|
|
72202
|
-
"version": "3.
|
|
72582
|
+
"version": "3.250.0",
|
|
72203
72583
|
"description": "The Public API provides server-to-server integration capabilities for your EV charging platform.\n\n**Authentication.** Existing integrations continue to work unchanged — long-lived UUID admin tokens are sent in `Authorization: Bearer ...` with no exchange required. Two security schemes are documented for OpenAPI client tooling, both resulting in the same Bearer header at the wire level:\n - `bearerAuth` — the token in the `Authorization: Bearer ...` header is either a long-lived UUID admin token (issued via the admin UI, used directly) or a short-lived access token previously obtained via OAuth.\n - `oauth2ClientCredentials` - a `client_id` / `client_secret` pair should be exchanged for a short-lived access token at `/public-api/oauth/token` per RFC 6749 Section 4.4 (Client Credentials Grant), and the short-lived token should be used in the `Authorization: Bearer ...` header. The OAuth `client_secret` itself cannot be sent directly as a bearer token — it must be exchanged first.\n"
|
|
72204
72584
|
},
|
|
72205
72585
|
"servers": [
|
|
@@ -72213,18 +72593,18 @@
|
|
|
72213
72593
|
}
|
|
72214
72594
|
}
|
|
72215
72595
|
],
|
|
72216
|
-
"buildTimestamp": "2026-09-
|
|
72596
|
+
"buildTimestamp": "2026-09-16T09:54:51.938Z",
|
|
72217
72597
|
"stats": {
|
|
72218
|
-
"totalEndpoints":
|
|
72219
|
-
"originalSize":
|
|
72220
|
-
"optimizedSize":
|
|
72221
|
-
"reductionPercent": 72.
|
|
72222
|
-
"buildDuration":
|
|
72598
|
+
"totalEndpoints": 648,
|
|
72599
|
+
"originalSize": 6018434,
|
|
72600
|
+
"optimizedSize": 1670845,
|
|
72601
|
+
"reductionPercent": 72.24,
|
|
72602
|
+
"buildDuration": 1535,
|
|
72223
72603
|
"responseSchemas": {
|
|
72224
|
-
"total":
|
|
72225
|
-
"withSchemas":
|
|
72226
|
-
"totalSchemaSize":
|
|
72227
|
-
"averageSchemaSize":
|
|
72604
|
+
"total": 648,
|
|
72605
|
+
"withSchemas": 648,
|
|
72606
|
+
"totalSchemaSize": 3454304,
|
|
72607
|
+
"averageSchemaSize": 5331
|
|
72228
72608
|
}
|
|
72229
72609
|
}
|
|
72230
72610
|
}
|