@ampeco/public-api-mcp 3.243.0 → 3.244.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 +199 -11
- package/dist/generated/response-schemas.json +1709 -142
- package/dist/generated/schemas.d.ts +7 -0
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +6 -0
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +9 -0
- package/package.json +1 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
|
-
"totalEndpoints":
|
|
3
|
-
"originalSize":
|
|
4
|
-
"optimizedSize":
|
|
5
|
-
"reductionPercent": 72.
|
|
6
|
-
"buildDuration":
|
|
2
|
+
"totalEndpoints": 640,
|
|
3
|
+
"originalSize": 5774967,
|
|
4
|
+
"optimizedSize": 1609217,
|
|
5
|
+
"reductionPercent": 72.13,
|
|
6
|
+
"buildDuration": 1369,
|
|
7
7
|
"responseSchemas": {
|
|
8
|
-
"total":
|
|
9
|
-
"withSchemas":
|
|
10
|
-
"totalSchemaSize":
|
|
11
|
-
"averageSchemaSize":
|
|
8
|
+
"total": 640,
|
|
9
|
+
"withSchemas": 640,
|
|
10
|
+
"totalSchemaSize": 3295598,
|
|
11
|
+
"averageSchemaSize": 5149
|
|
12
12
|
}
|
|
13
13
|
}
|
|
@@ -27133,6 +27133,21 @@
|
|
|
27133
27133
|
},
|
|
27134
27134
|
"description": "Filter invoices by payment status. Accepts multiple comma-separated values."
|
|
27135
27135
|
},
|
|
27136
|
+
"fiscalizationStatus": {
|
|
27137
|
+
"type": "array",
|
|
27138
|
+
"items": {
|
|
27139
|
+
"type": "string",
|
|
27140
|
+
"enum": [
|
|
27141
|
+
"pending",
|
|
27142
|
+
"certified",
|
|
27143
|
+
"failed",
|
|
27144
|
+
"canceled"
|
|
27145
|
+
],
|
|
27146
|
+
"example": "certified",
|
|
27147
|
+
"description": "Certification status of the invoice with its fiscalization integration. - **pending**: The fiscal document exists and has been accepted for certification, but the fiscal authority has not yet confirmed it. The document is not yet legally issued. - **certified**: The fiscal authority confirmed the document, which is legally issued. `referenceNumber` carries the reference the integration recorded for it. In rare cases a certified document has no recorded reference and `referenceNumber` is absent; this does not resolve on its own and requires operator intervention. A document whose revocation has been requested but not yet confirmed, or whose revocation was rejected, is still `certified` — it remains legally issued until the authority confirms the revocation, at which point it becomes `canceled`. - **failed**: Certification did not succeed. Retries are attempted a bounded number of times; a status that remains `failed` requires operator intervention. The fiscal document remains, but no legally issued document exists for it. - **canceled**: The document was certified and has since been revoked with the fiscal authority. This is distinct from `failed` — the document was legally issued at some point, and `referenceNumber` keeps the reference the integration had recorded for it."
|
|
27148
|
+
},
|
|
27149
|
+
"description": "Filter invoices by the certification status of their fiscal document. Accepts multiple comma-separated values. Invoices with no fiscal document are excluded whenever this filter is applied."
|
|
27150
|
+
},
|
|
27136
27151
|
"partnerId": {
|
|
27137
27152
|
"type": "string",
|
|
27138
27153
|
"format": "integer",
|
|
@@ -27169,6 +27184,9 @@
|
|
|
27169
27184
|
"403": {
|
|
27170
27185
|
"description": "You do not have permission to perform the action"
|
|
27171
27186
|
},
|
|
27187
|
+
"422": {
|
|
27188
|
+
"description": "The payload you provided is invalid"
|
|
27189
|
+
},
|
|
27172
27190
|
"429": {
|
|
27173
27191
|
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
27174
27192
|
}
|
|
@@ -27209,6 +27227,116 @@
|
|
|
27209
27227
|
}
|
|
27210
27228
|
}
|
|
27211
27229
|
},
|
|
27230
|
+
{
|
|
27231
|
+
"path": "/public-api/resources/invoices/v1.0/{invoice}/fiscalization-attempts",
|
|
27232
|
+
"method": "GET",
|
|
27233
|
+
"operationId": "invoiceFiscalizationAttemptsListing",
|
|
27234
|
+
"summary": "Invoice fiscalization attempts / Listing",
|
|
27235
|
+
"description": "Get the fiscalization attempts an invoice's integration publishes, newest first. Integrations that do not publish attempts return an empty list.",
|
|
27236
|
+
"tags": [
|
|
27237
|
+
"resource / invoices"
|
|
27238
|
+
],
|
|
27239
|
+
"parameters": {
|
|
27240
|
+
"path": {
|
|
27241
|
+
"invoice": {
|
|
27242
|
+
"description": "The invoice ID to fetch",
|
|
27243
|
+
"type": "string",
|
|
27244
|
+
"required": true
|
|
27245
|
+
}
|
|
27246
|
+
},
|
|
27247
|
+
"query": {
|
|
27248
|
+
"per_page": {
|
|
27249
|
+
"description": "The number of items to return per page.",
|
|
27250
|
+
"type": "integer",
|
|
27251
|
+
"minimum": 1,
|
|
27252
|
+
"maximum": 100,
|
|
27253
|
+
"default": 100
|
|
27254
|
+
},
|
|
27255
|
+
"cursor": {
|
|
27256
|
+
"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",
|
|
27257
|
+
"type": "string"
|
|
27258
|
+
}
|
|
27259
|
+
}
|
|
27260
|
+
},
|
|
27261
|
+
"responses": {
|
|
27262
|
+
"200": {
|
|
27263
|
+
"description": "Success"
|
|
27264
|
+
},
|
|
27265
|
+
"401": {
|
|
27266
|
+
"description": "Access token is missing or invalid"
|
|
27267
|
+
},
|
|
27268
|
+
"403": {
|
|
27269
|
+
"description": "You do not have permission to perform the action"
|
|
27270
|
+
},
|
|
27271
|
+
"404": {
|
|
27272
|
+
"description": "The record is not found"
|
|
27273
|
+
},
|
|
27274
|
+
"422": {
|
|
27275
|
+
"description": "The payload you provided is invalid"
|
|
27276
|
+
},
|
|
27277
|
+
"429": {
|
|
27278
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
27279
|
+
}
|
|
27280
|
+
}
|
|
27281
|
+
},
|
|
27282
|
+
{
|
|
27283
|
+
"path": "/public-api/resources/invoices/v1.0/{invoice}/fiscalization-documents/download",
|
|
27284
|
+
"method": "GET",
|
|
27285
|
+
"operationId": "invoiceFiscalizationDocumentDownload",
|
|
27286
|
+
"summary": "Invoice fiscalization document / Download",
|
|
27287
|
+
"description": "Download one of the document formats the fiscal authority has made available for a fiscalized invoice. Do not construct this URL: follow a `fiscalization.documents[].downloadUrl` link from the invoice response, which already carries the `format`, `expires` and `signature` query parameters. A missing or tampered signature yields `403 Forbidden`. The link expires 24 hours after the invoice response that produced it, after which it yields `410 Gone`, so request the invoice again for a fresh link rather than storing one. The link is signed and carries its own authorisation — no bearer token is used. The document is fetched from the fiscal authority only when the link is followed, so a provider that cannot supply the format at that moment yields `424 Failed Dependency` rather than a server error.",
|
|
27288
|
+
"tags": [
|
|
27289
|
+
"resource / invoices"
|
|
27290
|
+
],
|
|
27291
|
+
"parameters": {
|
|
27292
|
+
"path": {
|
|
27293
|
+
"invoice": {
|
|
27294
|
+
"description": "The invoice ID to fetch",
|
|
27295
|
+
"type": "string",
|
|
27296
|
+
"required": true
|
|
27297
|
+
}
|
|
27298
|
+
},
|
|
27299
|
+
"query": {
|
|
27300
|
+
"format": {
|
|
27301
|
+
"description": "The document format to download, matched verbatim against the formats the fiscal authority has made available for this fiscal document. Carried by the signed link; changing it invalidates the signature.",
|
|
27302
|
+
"type": "string",
|
|
27303
|
+
"required": true,
|
|
27304
|
+
"example": "application/pdf"
|
|
27305
|
+
},
|
|
27306
|
+
"expires": {
|
|
27307
|
+
"description": "Unix timestamp at which the signed link stops being accepted, 24 hours after the invoice response that produced it. Carried by the signed link; changing it invalidates the signature. Once this moment has passed the endpoint answers `410 Gone`.",
|
|
27308
|
+
"type": "integer",
|
|
27309
|
+
"required": true,
|
|
27310
|
+
"example": 1789344000
|
|
27311
|
+
},
|
|
27312
|
+
"signature": {
|
|
27313
|
+
"description": "Signature authorising this link. Carried by the signed link and the only credential the endpoint accepts — no bearer token is required or used.",
|
|
27314
|
+
"type": "string",
|
|
27315
|
+
"required": true
|
|
27316
|
+
}
|
|
27317
|
+
}
|
|
27318
|
+
},
|
|
27319
|
+
"responses": {
|
|
27320
|
+
"200": {
|
|
27321
|
+
"description": "Success. The document is streamed back as an attachment. The `Content-Type` is the media type the fiscal authority returned for the requested format and is provider-defined, so read it from the response rather than assuming one."
|
|
27322
|
+
},
|
|
27323
|
+
"403": {
|
|
27324
|
+
"description": "The link carries no signature, or a signature that does not match the URL it is being followed on. The signature covers the full link, including its host, so a constructed or altered URL is rejected — follow the `fiscalization.documents[].downloadUrl` link from the invoice response exactly as it was issued."
|
|
27325
|
+
},
|
|
27326
|
+
"404": {
|
|
27327
|
+
"description": "No invoice matches the link, the invoice carries no fiscal document, the invoice's fiscalization integration does not support downloading document formats, or the requested `format` is not one the fiscal authority has made available for it."
|
|
27328
|
+
},
|
|
27329
|
+
"410": {
|
|
27330
|
+
"description": "The link has expired. Signed links stop being accepted 24 hours after the invoice response that produced them. Request the invoice again for a fresh link."
|
|
27331
|
+
},
|
|
27332
|
+
"424": {
|
|
27333
|
+
"description": "The fiscal authority could not supply the requested format at this moment. The `message` property carries the reason the provider reported."
|
|
27334
|
+
},
|
|
27335
|
+
"429": {
|
|
27336
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
27337
|
+
}
|
|
27338
|
+
}
|
|
27339
|
+
},
|
|
27212
27340
|
{
|
|
27213
27341
|
"path": "/public-api/resources/issues/v1.0",
|
|
27214
27342
|
"method": "GET",
|
|
@@ -51899,6 +52027,66 @@
|
|
|
51899
52027
|
}
|
|
51900
52028
|
}
|
|
51901
52029
|
},
|
|
52030
|
+
{
|
|
52031
|
+
"path": "/public-api/resources/sessions/v1.0/{session}",
|
|
52032
|
+
"method": "PATCH",
|
|
52033
|
+
"operationId": "sessionUpdate",
|
|
52034
|
+
"summary": "Session / update custom fields",
|
|
52035
|
+
"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 the applicable custom field values of a session without changing any other session properties.",
|
|
52036
|
+
"tags": [
|
|
52037
|
+
"resource / sessions"
|
|
52038
|
+
],
|
|
52039
|
+
"parameters": {
|
|
52040
|
+
"path": {
|
|
52041
|
+
"session": {
|
|
52042
|
+
"description": "The session ID to fetch",
|
|
52043
|
+
"type": "string",
|
|
52044
|
+
"required": true
|
|
52045
|
+
}
|
|
52046
|
+
}
|
|
52047
|
+
},
|
|
52048
|
+
"requestBody": {
|
|
52049
|
+
"required": true,
|
|
52050
|
+
"content": {
|
|
52051
|
+
"application/json": {
|
|
52052
|
+
"schema": {
|
|
52053
|
+
"type": "object",
|
|
52054
|
+
"properties": {
|
|
52055
|
+
"customFields": {
|
|
52056
|
+
"type": "object",
|
|
52057
|
+
"additionalProperties": true,
|
|
52058
|
+
"description": "Custom field values keyed by their administrator-defined identifiers. Omitted identifiers remain unchanged, and a `null` value clears the corresponding custom field. 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."
|
|
52059
|
+
}
|
|
52060
|
+
},
|
|
52061
|
+
"required": [
|
|
52062
|
+
"customFields"
|
|
52063
|
+
],
|
|
52064
|
+
"additionalProperties": false
|
|
52065
|
+
}
|
|
52066
|
+
}
|
|
52067
|
+
}
|
|
52068
|
+
},
|
|
52069
|
+
"responses": {
|
|
52070
|
+
"200": {
|
|
52071
|
+
"description": "Success"
|
|
52072
|
+
},
|
|
52073
|
+
"401": {
|
|
52074
|
+
"description": "Access token is missing or invalid"
|
|
52075
|
+
},
|
|
52076
|
+
"403": {
|
|
52077
|
+
"description": "You do not have permission to perform the action"
|
|
52078
|
+
},
|
|
52079
|
+
"404": {
|
|
52080
|
+
"description": "The record is not found"
|
|
52081
|
+
},
|
|
52082
|
+
"422": {
|
|
52083
|
+
"description": "The payload you provided is invalid"
|
|
52084
|
+
},
|
|
52085
|
+
"429": {
|
|
52086
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
52087
|
+
}
|
|
52088
|
+
}
|
|
52089
|
+
},
|
|
51902
52090
|
{
|
|
51903
52091
|
"path": "/public-api/resources/sessions/v1.0/{session}/consumption-stats",
|
|
51904
52092
|
"method": "GET",
|
|
@@ -71399,7 +71587,7 @@
|
|
|
71399
71587
|
],
|
|
71400
71588
|
"info": {
|
|
71401
71589
|
"title": "Public API",
|
|
71402
|
-
"version": "3.
|
|
71590
|
+
"version": "3.244.0",
|
|
71403
71591
|
"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"
|
|
71404
71592
|
},
|
|
71405
71593
|
"servers": [
|
|
@@ -71413,18 +71601,18 @@
|
|
|
71413
71601
|
}
|
|
71414
71602
|
}
|
|
71415
71603
|
],
|
|
71416
|
-
"buildTimestamp": "2026-09-
|
|
71604
|
+
"buildTimestamp": "2026-09-03T08:59:08.369Z",
|
|
71417
71605
|
"stats": {
|
|
71418
|
-
"totalEndpoints":
|
|
71419
|
-
"originalSize":
|
|
71420
|
-
"optimizedSize":
|
|
71421
|
-
"reductionPercent": 72.
|
|
71422
|
-
"buildDuration":
|
|
71606
|
+
"totalEndpoints": 640,
|
|
71607
|
+
"originalSize": 5774967,
|
|
71608
|
+
"optimizedSize": 1609217,
|
|
71609
|
+
"reductionPercent": 72.13,
|
|
71610
|
+
"buildDuration": 1369,
|
|
71423
71611
|
"responseSchemas": {
|
|
71424
|
-
"total":
|
|
71425
|
-
"withSchemas":
|
|
71426
|
-
"totalSchemaSize":
|
|
71427
|
-
"averageSchemaSize":
|
|
71612
|
+
"total": 640,
|
|
71613
|
+
"withSchemas": 640,
|
|
71614
|
+
"totalSchemaSize": 3295598,
|
|
71615
|
+
"averageSchemaSize": 5149
|
|
71428
71616
|
}
|
|
71429
71617
|
}
|
|
71430
71618
|
}
|