@ampeco/public-api-mcp 3.248.0 → 3.249.0

package/dist/generated/build-stats.json

@@ -1,13 +1,13 @@
 {
-  "totalEndpoints": 643,
-  "originalSize": 5956908,
-  "optimizedSize": 1651756,
-  "reductionPercent": 72.27,
-  "buildDuration": 1576,
+  "totalEndpoints": 648,
+  "originalSize": 6013366,
+  "optimizedSize": 1669111,
+  "reductionPercent": 72.24,
+  "buildDuration": 1326,
   "responseSchemas": {
-    "total": 643,
-    "withSchemas": 643,
-    "totalSchemaSize": 3413991,
-    "averageSchemaSize": 5309
+    "total": 648,
+    "withSchemas": 648,
+    "totalSchemaSize": 3451726,
+    "averageSchemaSize": 5327
   }
 }

package/dist/generated/endpoints.json

@@ -34527,6 +34527,22 @@
       "tags": [
         "resource / partner contracts"
       ],
+      "parameters": {
+        "query": {
+          "include": {
+            "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`.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "settlementOverrides"
+                ]
+              }
+            }
+          }
+        }
+      },
       "responses": {
         "200": {
           "description": "Success"
@@ -34986,6 +35002,328 @@
         }
       }
     },
+    {
+      "path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides",
+      "method": "GET",
+      "operationId": "partnerContractSettlementOverridesListing",
+      "summary": "Partner contract / Settlement overrides / Listing",
+      "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`",
+      "tags": [
+        "resource / partner contracts"
+      ],
+      "parameters": {
+        "query": {
+          "per_page": {
+            "description": "The number of items to return per page.",
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 100,
+            "default": 100
+          },
+          "cursor": {
+            "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",
+            "type": "string"
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Success"
+        },
+        "401": {
+          "description": "Access token is missing or invalid"
+        },
+        "403": {
+          "description": "You do not have permission to perform the action"
+        },
+        "404": {
+          "description": "The record is not found"
+        },
+        "429": {
+          "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
+        }
+      }
+    },
+    {
+      "path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides",
+      "method": "POST",
+      "operationId": "partnerContractSettlementOverrideCreate",
+      "summary": "Partner contract / Settlement override / Create",
+      "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`",
+      "tags": [
+        "resource / partner contracts"
+      ],
+      "requestBody": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "maxLength": 255,
+                  "example": "Fleet drivers",
+                  "description": "Name of the settlement override, unique among the active overrides of the partner contract."
+                },
+                "priority": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 4294967295,
+                  "example": 1,
+                  "description": "Evaluation priority of the override, unique among the active overrides of the partner contract. The lowest value that matches a session wins."
+                },
+                "restriction": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "users_of_the_partner",
+                        "user_groups",
+                        "ad_hoc_users",
+                        "users_of_specific_partners"
+                      ],
+                      "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`."
+                    },
+                    "targetIds": {
+                      "type": "array",
+                      "items": {
+                        "type": "integer"
+                      },
+                      "example": [
+                        12,
+                        34
+                      ],
+                      "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."
+                    }
+                  },
+                  "required": [
+                    "type"
+                  ],
+                  "description": "Which users of the partner contract the override applies to. `type` is the discriminator and determines what `targetIds` references."
+                },
+                "acPercent": {
+                  "type": "number",
+                  "format": "float",
+                  "minimum": 0,
+                  "maximum": 100,
+                  "example": 70.5,
+                  "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."
+                },
+                "dcPercent": {
+                  "type": "number",
+                  "format": "float",
+                  "minimum": 0,
+                  "maximum": 100,
+                  "example": 60,
+                  "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."
+                }
+              },
+              "required": [
+                "name",
+                "priority",
+                "restriction"
+              ],
+              "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."
+            }
+          }
+        }
+      },
+      "responses": {
+        "201": {
+          "description": "Settlement override created successfully"
+        },
+        "401": {
+          "description": "Access token is missing or invalid"
+        },
+        "403": {
+          "description": "You do not have permission to perform the action"
+        },
+        "404": {
+          "description": "The record is not found"
+        },
+        "409": {
+          "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."
+        },
+        "412": {
+          "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."
+        },
+        "422": {
+          "description": "The payload you provided is invalid"
+        },
+        "429": {
+          "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
+        }
+      }
+    },
+    {
+      "path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides/{settlementOverride}",
+      "method": "GET",
+      "operationId": "partnerContractSettlementOverrideRead",
+      "summary": "Partner contract / Settlement override / Read",
+      "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`",
+      "tags": [
+        "resource / partner contracts"
+      ],
+      "responses": {
+        "200": {
+          "description": "Success"
+        },
+        "401": {
+          "description": "Access token is missing or invalid"
+        },
+        "403": {
+          "description": "You do not have permission to perform the action"
+        },
+        "404": {
+          "description": "The record is not found"
+        },
+        "429": {
+          "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
+        }
+      }
+    },
+    {
+      "path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides/{settlementOverride}",
+      "method": "DELETE",
+      "operationId": "partnerContractSettlementOverrideDelete",
+      "summary": "Partner contract / Settlement override / Delete",
+      "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`",
+      "tags": [
+        "resource / partner contracts"
+      ],
+      "responses": {
+        "204": {
+          "description": "Settlement override deleted successfully"
+        },
+        "401": {
+          "description": "Access token is missing or invalid"
+        },
+        "403": {
+          "description": "You do not have permission to perform the action"
+        },
+        "404": {
+          "description": "The record is not found"
+        },
+        "412": {
+          "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."
+        },
+        "429": {
+          "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
+        }
+      }
+    },
+    {
+      "path": "/public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides/{settlementOverride}",
+      "method": "PATCH",
+      "operationId": "partnerContractSettlementOverrideUpdate",
+      "summary": "Partner contract / Settlement override / Update",
+      "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`",
+      "tags": [
+        "resource / partner contracts"
+      ],
+      "requestBody": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "maxLength": 255,
+                  "example": "Fleet drivers",
+                  "description": "Name of the settlement override, unique among the active overrides of the partner contract."
+                },
+                "priority": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 4294967295,
+                  "example": 1,
+                  "description": "Evaluation priority of the override, unique among the active overrides of the partner contract. The lowest value that matches a session wins."
+                },
+                "restriction": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "users_of_the_partner",
+                        "user_groups",
+                        "ad_hoc_users",
+                        "users_of_specific_partners"
+                      ],
+                      "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`."
+                    },
+                    "targetIds": {
+                      "type": "array",
+                      "items": {
+                        "type": "integer"
+                      },
+                      "example": [
+                        12,
+                        34
+                      ],
+                      "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."
+                    }
+                  },
+                  "required": [
+                    "type"
+                  ],
+                  "description": "Which users of the partner contract the override applies to. `type` is the discriminator and determines what `targetIds` references."
+                },
+                "acPercent": {
+                  "type": "number",
+                  "format": "float",
+                  "minimum": 0,
+                  "maximum": 100,
+                  "example": 70.5,
+                  "nullable": true,
+                  "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."
+                },
+                "dcPercent": {
+                  "type": "number",
+                  "format": "float",
+                  "minimum": 0,
+                  "maximum": 100,
+                  "example": 60,
+                  "nullable": true,
+                  "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."
+                }
+              },
+              "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."
+            }
+          }
+        }
+      },
+      "responses": {
+        "200": {
+          "description": "Settlement override updated successfully"
+        },
+        "401": {
+          "description": "Access token is missing or invalid"
+        },
+        "403": {
+          "description": "You do not have permission to perform the action"
+        },
+        "404": {
+          "description": "The record is not found"
+        },
+        "409": {
+          "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."
+        },
+        "412": {
+          "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."
+        },
+        "422": {
+          "description": "The payload you provided is invalid"
+        },
+        "429": {
+          "description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
+        }
+      }
+    },
     {
       "path": "/public-api/resources/partner-expenses/v1.0",
       "method": "GET",
@@ -38338,7 +38676,7 @@
                     "ga-IE",
                     "bs",
                     "ja",
-                    "ko",
+                    "ko-KR",
                     "cs",
                     "lv",
                     "et",
@@ -49034,7 +49372,7 @@
                 },
                 "partnerContractId": {
                   "type": "integer",
-                  "description": "Partner contract the policy is scoped to. Requires `partnerId` and must belong to that partner. When not set, the policy is not scoped to a specific contract."
+                  "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."
                 },
                 "electricityRateId": {
                   "type": "integer",
@@ -49188,7 +49526,7 @@
                 "partnerContractId": {
                   "type": "integer",
                   "nullable": true,
-                  "description": "Partner contract the policy is scoped to. Set to `null` to remove the contract scope. Requires `partnerId` and must belong to that partner."
+                  "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."
                 },
                 "electricityRateId": {
                   "type": "integer",
@@ -56575,6 +56913,28 @@
                   "nullable": true,
                   "description": "The operator ID for this resource. Required for global admin tokens. Optional for operator-scoped tokens (defaults to token's operator)."
                 },
+                "display": {
+                  "type": "object",
+                  "properties": {
+                    "defaultPriceInformation": {
+                      "type": "string",
+                      "maxLength": 150,
+                      "nullable": true,
+                      "description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
+                    },
+                    "defaultPriceInformationOffline": {
+                      "type": "string",
+                      "maxLength": 150,
+                      "nullable": true,
+                      "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."
+                    },
+                    "totalCostFallbackMessage": {
+                      "type": "string",
+                      "maxLength": 150,
+                      "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."
+                    }
+                  }
+                },
                 "name": {
                   "type": "string"
                 },
@@ -56595,23 +56955,6 @@
                   "nullable": true,
                   "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."
                 },
-                "display": {
-                  "type": "object",
-                  "properties": {
-                    "defaultPriceInformation": {
-                      "type": "string",
-                      "maxLength": 150,
-                      "nullable": true,
-                      "description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
-                    },
-                    "defaultPriceInformationOffline": {
-                      "type": "string",
-                      "maxLength": 150,
-                      "nullable": true,
-                      "description": "The information that would be shown on the display of the charge point when offline."
-                    }
-                  }
-                },
                 "lastUpdatedAt": {
                   "type": "string",
                   "format": "date-time",
@@ -56686,6 +57029,29 @@
             "schema": {
               "type": "object",
               "properties": {
+                "display": {
+                  "type": "object",
+                  "properties": {
+                    "defaultPriceInformation": {
+                      "type": "string",
+                      "maxLength": 150,
+                      "nullable": true,
+                      "description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
+                    },
+                    "defaultPriceInformationOffline": {
+                      "type": "string",
+                      "maxLength": 150,
+                      "nullable": true,
+                      "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."
+                    },
+                    "totalCostFallbackMessage": {
+                      "type": "string",
+                      "maxLength": 150,
+                      "nullable": true,
+                      "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."
+                    }
+                  }
+                },
                 "name": {
                   "type": "string"
                 },
@@ -56706,23 +57072,6 @@
                   "nullable": true,
                   "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."
                 },
-                "display": {
-                  "type": "object",
-                  "properties": {
-                    "defaultPriceInformation": {
-                      "type": "string",
-                      "maxLength": 150,
-                      "nullable": true,
-                      "description": "The default information that would be shown on the display of the charge point without the user having authorized themselves."
-                    },
-                    "defaultPriceInformationOffline": {
-                      "type": "string",
-                      "maxLength": 150,
-                      "nullable": true,
-                      "description": "The information that would be shown on the display of the charge point when offline."
-                    }
-                  }
-                },
                 "lastUpdatedAt": {
                   "type": "string",
                   "format": "date-time",
@@ -69099,7 +69448,7 @@
                     "ga-IE",
                     "bs",
                     "ja",
-                    "ko",
+                    "ko-KR",
                     "cs",
                     "lv",
                     "et",
@@ -70020,7 +70369,7 @@
                     "ga-IE",
                     "bs",
                     "ja",
-                    "ko",
+                    "ko-KR",
                     "cs",
                     "lv",
                     "et",
@@ -72199,7 +72548,7 @@
   ],
   "info": {
     "title": "Public API",
-    "version": "3.248.0",
+    "version": "3.249.0",
     "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"
   },
   "servers": [
@@ -72213,18 +72562,18 @@
       }
     }
   ],
-  "buildTimestamp": "2026-09-14T13:02:49.113Z",
+  "buildTimestamp": "2026-09-15T07:16:51.296Z",
   "stats": {
-    "totalEndpoints": 643,
-    "originalSize": 5956908,
-    "optimizedSize": 1651756,
-    "reductionPercent": 72.27,
-    "buildDuration": 1576,
+    "totalEndpoints": 648,
+    "originalSize": 6013366,
+    "optimizedSize": 1669111,
+    "reductionPercent": 72.24,
+    "buildDuration": 1326,
     "responseSchemas": {
-      "total": 643,
-      "withSchemas": 643,
-      "totalSchemaSize": 3413991,
-      "averageSchemaSize": 5309
+      "total": 648,
+      "withSchemas": 648,
+      "totalSchemaSize": 3451726,
+      "averageSchemaSize": 5327
     }
   }
 }