@ampeco/public-api-mcp 3.255.2 → 3.256.0

package/dist/generated/build-stats.json

@@ -1,13 +1,13 @@
 {
-  "totalEndpoints": 657,
-  "originalSize": 6159653,
-  "optimizedSize": 1720553,
-  "reductionPercent": 72.07,
-  "buildDuration": 1622,
+  "totalEndpoints": 658,
+  "originalSize": 6198282,
+  "optimizedSize": 1729692,
+  "reductionPercent": 72.09,
+  "buildDuration": 1572,
   "responseSchemas": {
-    "total": 657,
-    "withSchemas": 657,
-    "totalSchemaSize": 3531263,
-    "averageSchemaSize": 5375
+    "total": 658,
+    "withSchemas": 658,
+    "totalSchemaSize": 3551045,
+    "averageSchemaSize": 5397
   }
 }

package/dist/generated/endpoints.json

@@ -3674,6 +3674,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -5749,6 +5750,57 @@
         }
       }
     },
+    {
+      "path": "/public-api/actions/transaction/v1.0/{transaction}/set-custom-fields",
+      "method": "POST",
+      "operationId": "transactionSetCustomFields",
+      "summary": "Transaction / set custom fields",
+      "description": "⚠️ Experimental endpoint — not yet a stable contract. This action 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. Set applicable transaction custom field values without changing the transaction's status, financial amounts, references or timestamps. This action requires permission to view the transaction and the `Transactions.update-custom-fields` permission. It works for finalized transactions even when ordinary transaction updates are unavailable. Send a JSON object containing only the required `customFields` object; other body properties and any query parameters return `422` validation errors. Omitted identifiers remain unchanged, while `null` clears the corresponding value. When custom fields are enabled for transactions, an empty object succeeds as a no-op. Invalid or unavailable identifiers, invalid values, and disabled custom fields return `422` validation errors, and no submitted values are changed. A `404` response means the transaction was not found or is inaccessible. The response is the bare transaction read object, without a `data` wrapper.",
+      "tags": [
+        "action / transaction"
+      ],
+      "requestBody": {
+        "required": true,
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "customFields": {
+                  "type": "object",
+                  "additionalProperties": true,
+                  "description": "Custom field values keyed by their administrator-defined identifiers. The accepted type for each identifier is defined by the tenant's custom field configuration. Boolean values are JSON booleans; text and long text values are strings; email values are email-formatted strings; URL values are HTTP or HTTPS URL strings; number values use canonical base-10 decimal strings from `-99999999999999.999999` through `99999999999999.999999` with up to six fractional digits and no insignificant trailing fractional zeroes; date values are ISO 8601 `YYYY-MM-DD` strings; date-time values are ISO 8601 timestamps with a UTC offset; and JSON values may use any JSON-serializable value. Decimal strings are the precision-safe number request representation. JSON numeric inputs remain accepted for compatibility, but their precision may depend on the client's number handling."
+                }
+              },
+              "required": [
+                "customFields"
+              ],
+              "additionalProperties": false
+            }
+          }
+        }
+      },
+      "responses": {
+        "202": {
+          "description": "Accepted - the response body contains the transaction's read representation after applying the submitted values"
+        },
+        "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"
+        },
+        "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/actions/transactions/v1.0/{transaction}/issue-invoice",
       "method": "POST",
@@ -7241,6 +7293,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -7375,6 +7428,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -7555,6 +7609,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -7781,6 +7836,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -46932,7 +46988,7 @@
       "method": "GET",
       "operationId": "getPaymentTerminalsV1_1",
       "summary": "Payment Terminals / Listing",
-      "description": "Get all payment terminals",
+      "description": "Get all payment terminals. Nonempty custom-field filter criteria for unknown, inaccessible, disabled, deleted or non-filterable fields return `400`. Malformed values for usable custom-field filters return `422`.",
       "tags": [
         "resource / payment terminals"
       ],
@@ -46982,7 +47038,7 @@
                 "customFields": {
                   "type": "object",
                   "additionalProperties": true,
-                  "description": "Map of administrator-defined custom field identifiers to filter values. Send each entry as `filter[customFields.<identifier>]`."
+                  "description": "Filter a resource listing by administrator-defined custom fields using literal dotted keys such as `filter[customFields.reference]=INV-42`, not nested `filter[customFields][reference]` keys. Text, email and URL fields accept a single string and use case- and accent-insensitive substring matching; `%`, `_` and backslashes are matched literally. Boolean fields accept `true`, `false`, `1` or `0` as strings, or boolean and integer equivalents. Number, date and date-time fields accept inclusive `filter[customFields.<identifier>][from]` and/or `filter[customFields.<identifier>][to]` bounds, including one-sided ranges. Number bounds are decimal strings from `-99999999999999.999999` to `99999999999999.999999` with at most six fractional places, compared without rounding. Dates use `YYYY-MM-DD` calendar dates; date-times use ISO 8601, with offsets normalized to UTC and no offset interpreted as UTC. Long text and JSON fields are not filterable. Custom-field criteria combine with each other and the resource's other filters using AND. Empty criteria have no effect. Malformed values for usable fields return a property-bound `422` validation error. See each listing operation for how it handles unsupported nonempty criteria."
                 }
               }
             }
@@ -49899,7 +49955,7 @@
                     "charge_point",
                     "integration"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy. - **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy; `integrationId` must not be set on the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. Neither `electricityRateId` nor `integrationId` is set on the policy. - **integration**: An integration resolves the electricity rate — for example by the charge point's region. `integrationId` is required and must reference a regional electricity rates integration of the same operator; `electricityRateId` must not be set on the policy. The integration's region-to-rate bindings are configured in the admin panel."
                 }
               }
             }
@@ -49962,7 +50018,11 @@
                 },
                 "electricityRateId": {
                   "type": "integer",
-                  "description": "Linked electricity rate providing the reimbursement rate. Set only when `electricityRateSource` is `policy`, where it is required."
+                  "description": "Linked electricity rate providing the reimbursement rate. Required when `electricityRateSource` is `policy`, and must belong to the same operator as the policy; submitting it with any other rate source is rejected with 422."
+                },
+                "integrationId": {
+                  "type": "integer",
+                  "description": "Regional electricity rates integration that resolves the reimbursement rate. Required when `electricityRateSource` is `integration`, and must belong to the same operator as the policy; submitting it with any other rate source is rejected with 422. The integration is created and configured in the admin panel; use the id shown on its detail page."
                 },
                 "validityEndsOn": {
                   "type": "string",
@@ -49973,9 +50033,10 @@
                   "type": "string",
                   "enum": [
                     "policy",
-                    "charge_point"
+                    "charge_point",
+                    "integration"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy. The `integration` source is not writable through this API: it cannot be submitted on create or update. Policies using it are configured in the admin panel."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy; `integrationId` must not be set on the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. Neither `electricityRateId` nor `integrationId` is set on the policy. - **integration**: An integration resolves the electricity rate — for example by the charge point's region. `integrationId` is required and must reference a regional electricity rates integration of the same operator; `electricityRateId` must not be set on the policy. The integration's region-to-rate bindings are configured in the admin panel."
                 },
                 "operatorId": {
                   "type": "integer",
@@ -50043,7 +50104,7 @@
       "method": "DELETE",
       "operationId": "reimbursementPolicyDelete",
       "summary": "Reimbursement policy / 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 reimbursement policy. Deletion is rejected only while the policy is attached to partner invites. A policy is deletable whatever its `electricityRateSource` is, `integration` included; the restrictions on submitting `electricityRateSource` are described on the create and update operations and do not apply here.",
+      "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 reimbursement policy. Deletion is rejected only while the policy is attached to partner invites. A policy is deletable whatever its `electricityRateSource` is, `integration` included.",
       "tags": [
         "resource / reimbursement policies"
       ],
@@ -50076,7 +50137,7 @@
       "method": "PATCH",
       "operationId": "reimbursementPolicyUpdate",
       "summary": "Reimbursement policy / 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 reimbursement policy. The update is rejected with 409 while the requested change conflicts with the rate the policy resolves — selecting the `charge_point` rate source while an attached charge point has no electricity rate. That conflict clears only when the configuration changes: give the charge point a rate, or detach it from the policy. A policy whose stored `electricityRateSource` is `integration` is updated through this API like any other policy, except that its rate source cannot be changed: a request that submits `electricityRateSource` on such a policy is rejected with 409, because the integration that resolves its rate is configured in the admin panel and the binding could not be restored through this API. Omit `electricityRateSource` to update `name`, the validity dates or the partner scope. Every other rejection of the request body is reported as 422, keyed by the offending field — malformed or invalid field values, and changing `partnerId` on a policy that is already assigned to partner invites or has active charge point attachments, which returns a `partnerId` validation error rather than a 409. Deactivated attachments do not block the change.",
+      "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 reimbursement policy. The update is rejected with 409 while the requested change conflicts with the rate the policy resolves — selecting the `charge_point` rate source while an attached charge point has no electricity rate. That conflict clears only when the configuration changes: give the charge point a rate, or detach it from the policy. Each rate source has its own reference: `policy` uses `electricityRateId` and `integration` uses `integrationId`. Changing `electricityRateSource` clears the reference the previous source used, whether or not the request sends that reference as `null`; sending it as `null` explicitly is accepted and produces the same result. Sending a non-null reference the selected rate source does not use is rejected with 422 keyed by that field. A policy whose rate source does not change keeps its stored reference when the reference is omitted, so an `integration` policy can be repointed by sending `integrationId` alone. Every other rejection of the request body is reported as 422, keyed by the offending field — malformed or invalid field values, and changing `partnerId` on a policy that is already assigned to partner invites or has active charge point attachments, which returns a `partnerId` validation error rather than a 409. Deactivated attachments do not block the change.",
       "tags": [
         "resource / reimbursement policies"
       ],
@@ -50100,9 +50161,10 @@
                   "type": "string",
                   "enum": [
                     "policy",
-                    "charge_point"
+                    "charge_point",
+                    "integration"
                   ],
-                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy. The `integration` source is not writable through this API: it cannot be submitted on create or update. Policies using it are configured in the admin panel."
+                  "description": "Origin of the per-kWh rate used to reimburse a home-charging session: - **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy; `integrationId` must not be set on the policy. - **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. Neither `electricityRateId` nor `integrationId` is set on the policy. - **integration**: An integration resolves the electricity rate — for example by the charge point's region. `integrationId` is required and must reference a regional electricity rates integration of the same operator; `electricityRateId` must not be set on the policy. The integration's region-to-rate bindings are configured in the admin panel."
                 },
                 "partnerId": {
                   "type": "integer",
@@ -50117,7 +50179,12 @@
                 "electricityRateId": {
                   "type": "integer",
                   "nullable": true,
-                  "description": "Linked electricity rate providing the reimbursement rate. Required when `electricityRateSource` is `policy`; set to `null` (or omit) otherwise."
+                  "description": "Linked electricity rate providing the reimbursement rate. Required when `electricityRateSource` is `policy`, and must belong to the same operator as the policy. Not used by any other rate source — see the operation description for how references are cleared when the rate source changes."
+                },
+                "integrationId": {
+                  "type": "integer",
+                  "nullable": true,
+                  "description": "Regional electricity rates integration that resolves the reimbursement rate. Required when `electricityRateSource` is `integration`, and must belong to the same operator as the policy. Not used by any other rate source — see the operation description for how references are cleared when the rate source changes. The integration is created and configured in the admin panel; use the id shown on its detail page."
                 },
                 "validityEndsOn": {
                   "type": "string",
@@ -50335,7 +50402,7 @@
                 "customFields": {
                   "type": "object",
                   "additionalProperties": true,
-                  "description": "Map of administrator-defined custom field identifiers to filter values. Send each entry as `filter[customFields.<identifier>]`."
+                  "description": "Filter a resource listing by administrator-defined custom fields using literal dotted keys such as `filter[customFields.reference]=INV-42`, not nested `filter[customFields][reference]` keys. Text, email and URL fields accept a single string and use case- and accent-insensitive substring matching; `%`, `_` and backslashes are matched literally. Boolean fields accept `true`, `false`, `1` or `0` as strings, or boolean and integer equivalents. Number, date and date-time fields accept inclusive `filter[customFields.<identifier>][from]` and/or `filter[customFields.<identifier>][to]` bounds, including one-sided ranges. Number bounds are decimal strings from `-99999999999999.999999` to `99999999999999.999999` with at most six fractional places, compared without rounding. Dates use `YYYY-MM-DD` calendar dates; date-times use ISO 8601, with offsets normalized to UTC and no offset interpreted as UTC. Long text and JSON fields are not filterable. Custom-field criteria combine with each other and the resource's other filters using AND. Empty criteria have no effect. Malformed values for usable fields return a property-bound `422` validation error. See each listing operation for how it handles unsupported nonempty criteria."
                 }
               }
             }
@@ -64027,7 +64094,7 @@
       "method": "GET",
       "operationId": "transactionsListing",
       "summary": "Transactions / Listing",
-      "description": "Get all transactions",
+      "description": "Get all transactions. Nonempty custom-field filter criteria for unknown, inaccessible, disabled, deleted or non-filterable fields have no effect on this listing.",
       "tags": [
         "resource / transactions"
       ],
@@ -64281,6 +64348,11 @@
                   "type": "string",
                   "format": "integer",
                   "description": "Only list transactions that were settled by this specific transaction. Given a settlement transaction ID, returns all obligation transactions (sessions, base fee, charger fees) that were settled by that payment."
+                },
+                "customFields": {
+                  "type": "object",
+                  "additionalProperties": true,
+                  "description": "Filter a resource listing by administrator-defined custom fields using literal dotted keys such as `filter[customFields.reference]=INV-42`, not nested `filter[customFields][reference]` keys. Text, email and URL fields accept a single string and use case- and accent-insensitive substring matching; `%`, `_` and backslashes are matched literally. Boolean fields accept `true`, `false`, `1` or `0` as strings, or boolean and integer equivalents. Number, date and date-time fields accept inclusive `filter[customFields.<identifier>][from]` and/or `filter[customFields.<identifier>][to]` bounds, including one-sided ranges. Number bounds are decimal strings from `-99999999999999.999999` to `99999999999999.999999` with at most six fractional places, compared without rounding. Dates use `YYYY-MM-DD` calendar dates; date-times use ISO 8601, with offsets normalized to UTC and no offset interpreted as UTC. Long text and JSON fields are not filterable. Custom-field criteria combine with each other and the resource's other filters using AND. Empty criteria have no effect. Malformed values for usable fields return a property-bound `422` validation error. See each listing operation for how it handles unsupported nonempty criteria."
                 }
               }
             }
@@ -73363,7 +73435,7 @@
   ],
   "info": {
     "title": "Public API",
-    "version": "3.255.2",
+    "version": "3.256.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": [
@@ -73377,18 +73449,18 @@
       }
     }
   ],
-  "buildTimestamp": "2026-09-29T10:43:49.639Z",
+  "buildTimestamp": "2026-09-30T11:40:50.788Z",
   "stats": {
-    "totalEndpoints": 657,
-    "originalSize": 6159653,
-    "optimizedSize": 1720553,
-    "reductionPercent": 72.07,
-    "buildDuration": 1622,
+    "totalEndpoints": 658,
+    "originalSize": 6198282,
+    "optimizedSize": 1729692,
+    "reductionPercent": 72.09,
+    "buildDuration": 1572,
     "responseSchemas": {
-      "total": 657,
-      "withSchemas": 657,
-      "totalSchemaSize": 3531263,
-      "averageSchemaSize": 5375
+      "total": 658,
+      "withSchemas": 658,
+      "totalSchemaSize": 3551045,
+      "averageSchemaSize": 5397
     }
   }
 }