@ampeco/public-api-mcp 3.247.2 → 3.248.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 +412 -141
- package/dist/generated/response-schemas.json +8186 -5001
- package/dist/generated/schemas.d.ts +225 -138
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +72 -46
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +76 -47
- package/package.json +1 -1
|
@@ -3866,7 +3866,7 @@
|
|
|
3866
3866
|
"method": "POST",
|
|
3867
3867
|
"operationId": "partnerInvoiceIssueCreditNote",
|
|
3868
3868
|
"summary": "Partner invoice / Issue credit note",
|
|
3869
|
-
"description": "Issue a full credit note cancelling the given partner invoice. The credit note copies the original's seller, buyer, currency and payment terms, negates every line item, is marked paid, and references the cancelled invoice via `referenceId`. Only
|
|
3869
|
+
"description": "Issue a full credit note cancelling the given partner invoice. The credit note copies the original's seller, buyer, currency and payment terms, negates every line item, is marked paid, and references the cancelled invoice via `referenceId`. Only one credit note may exist per invoice. Issuing returns the linked settlement report to `ready_to_invoice`. Partial credit notes are not supported. Eligibility depends on the B2B invoice processor recorded on the invoice at issuance. An invoice generated through the built-in B2B invoice integration is eligible as soon as it is issued. An invoice generated through a processor that certifies documents with a fiscal authority is eligible only after the original document has been certified — until the document exists at the fiscal authority there is nothing to cancel. Use `fiscalization.status` on the single-invoice read to observe this: `pending` and `failed` mean not yet creditable, `certified` means the precondition is met. Certification is a necessary, not a sufficient, condition — the rare certified document with no recorded `fiscalization.referenceNumber` described under `fiscalization.status` stays ineligible and requires operator intervention. A `425` means the original document has not been certified with the fiscal authority yet, so there is nothing to cancel. Retry once `fiscalization.status` on the single-invoice read reaches `certified`.",
|
|
3870
3870
|
"tags": [
|
|
3871
3871
|
"action / partner invoice"
|
|
3872
3872
|
],
|
|
@@ -3884,7 +3884,10 @@
|
|
|
3884
3884
|
"description": "The record is not found"
|
|
3885
3885
|
},
|
|
3886
3886
|
"409": {
|
|
3887
|
-
"description": "The request
|
|
3887
|
+
"description": "The invoice is permanently ineligible for credit note issuance and the request will not succeed on retry. Returned when the invoice already has a credit note, when the target is itself a credit note, when the B2B invoice processor recorded on the invoice does not support credit note issuance, or when the original document is certified but its fiscal authority number was never recorded on the platform."
|
|
3888
|
+
},
|
|
3889
|
+
"425": {
|
|
3890
|
+
"description": "The original document is not yet certified with the fiscal authority. The invoice becomes creditable once `fiscalization.status` reaches `certified`."
|
|
3888
3891
|
},
|
|
3889
3892
|
"429": {
|
|
3890
3893
|
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
@@ -3972,6 +3975,57 @@
|
|
|
3972
3975
|
}
|
|
3973
3976
|
}
|
|
3974
3977
|
},
|
|
3978
|
+
{
|
|
3979
|
+
"path": "/public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/set-custom-fields",
|
|
3980
|
+
"method": "POST",
|
|
3981
|
+
"operationId": "partnerSettlementReportSetCustomFields",
|
|
3982
|
+
"summary": "Partner settlement report / set custom fields",
|
|
3983
|
+
"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 the applicable live custom field values of a partner settlement report without changing the historical report, its generated documents, party and settings snapshots, or derived partner invoices. This action requires permission to view the partner settlement report and the `PartnerSettlementReports.update-custom-fields` permission. The `customFields` object accepts Boolean, Text, Long text, Email, URL, Number, Date, Date-time and JSON values according to each administrator-defined field. It may be empty. Omitted identifiers remain unchanged, while an explicit `null` clears the corresponding value. Every submitted identifier is validated against the report's current partner owner, the current custom field configuration and the acting administrator's access. Unknown, inapplicable or currently disabled identifiers return a `422` error keyed as `customFields.<identifier>`, and no submitted values are changed. This write action does not accept query parameters or includes. The response is the current default read representation after applying the values; `customFields` remains live metadata and is not a point-in-time representation of the historical settlement report.",
|
|
3984
|
+
"tags": [
|
|
3985
|
+
"action / partner settlement report"
|
|
3986
|
+
],
|
|
3987
|
+
"requestBody": {
|
|
3988
|
+
"required": true,
|
|
3989
|
+
"content": {
|
|
3990
|
+
"application/json": {
|
|
3991
|
+
"schema": {
|
|
3992
|
+
"type": "object",
|
|
3993
|
+
"properties": {
|
|
3994
|
+
"customFields": {
|
|
3995
|
+
"type": "object",
|
|
3996
|
+
"additionalProperties": true,
|
|
3997
|
+
"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."
|
|
3998
|
+
}
|
|
3999
|
+
},
|
|
4000
|
+
"required": [
|
|
4001
|
+
"customFields"
|
|
4002
|
+
],
|
|
4003
|
+
"additionalProperties": false
|
|
4004
|
+
}
|
|
4005
|
+
}
|
|
4006
|
+
}
|
|
4007
|
+
},
|
|
4008
|
+
"responses": {
|
|
4009
|
+
"202": {
|
|
4010
|
+
"description": "Accepted - the response body contains the partner settlement report's default current read representation after applying the submitted values"
|
|
4011
|
+
},
|
|
4012
|
+
"401": {
|
|
4013
|
+
"description": "Access token is missing or invalid"
|
|
4014
|
+
},
|
|
4015
|
+
"403": {
|
|
4016
|
+
"description": "You do not have permission to perform the action"
|
|
4017
|
+
},
|
|
4018
|
+
"404": {
|
|
4019
|
+
"description": "The record is not found"
|
|
4020
|
+
},
|
|
4021
|
+
"422": {
|
|
4022
|
+
"description": "The payload you provided is invalid"
|
|
4023
|
+
},
|
|
4024
|
+
"429": {
|
|
4025
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
4026
|
+
}
|
|
4027
|
+
}
|
|
4028
|
+
},
|
|
3975
4029
|
{
|
|
3976
4030
|
"path": "/public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/update-external-id",
|
|
3977
4031
|
"method": "POST",
|
|
@@ -4023,6 +4077,108 @@
|
|
|
4023
4077
|
}
|
|
4024
4078
|
}
|
|
4025
4079
|
},
|
|
4080
|
+
{
|
|
4081
|
+
"path": "/public-api/actions/partner/v1.0/{partner}/set-custom-fields",
|
|
4082
|
+
"method": "POST",
|
|
4083
|
+
"operationId": "partnerSetCustomFieldsV1_0",
|
|
4084
|
+
"summary": "Partner / set custom fields",
|
|
4085
|
+
"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 the applicable custom field values of a partner without changing any other partner properties. This action requires permission to view the partner and the `Partners.update-custom-fields` permission. Send a JSON object containing only the required `customFields` property. Query parameters and additional body properties are rejected. The `customFields` object may be empty. Omitted identifiers remain unchanged, while an explicit `null` clears the corresponding value. Every submitted identifier is validated against the partner, the current custom field configuration and the acting administrator's access. Unknown, inapplicable or currently disabled identifiers return a `422` error keyed as `customFields.<identifier>`, and no submitted values are changed.",
|
|
4086
|
+
"tags": [
|
|
4087
|
+
"action / partner"
|
|
4088
|
+
],
|
|
4089
|
+
"requestBody": {
|
|
4090
|
+
"required": true,
|
|
4091
|
+
"content": {
|
|
4092
|
+
"application/json": {
|
|
4093
|
+
"schema": {
|
|
4094
|
+
"type": "object",
|
|
4095
|
+
"properties": {
|
|
4096
|
+
"customFields": {
|
|
4097
|
+
"type": "object",
|
|
4098
|
+
"additionalProperties": true,
|
|
4099
|
+
"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."
|
|
4100
|
+
}
|
|
4101
|
+
},
|
|
4102
|
+
"required": [
|
|
4103
|
+
"customFields"
|
|
4104
|
+
],
|
|
4105
|
+
"additionalProperties": false
|
|
4106
|
+
}
|
|
4107
|
+
}
|
|
4108
|
+
}
|
|
4109
|
+
},
|
|
4110
|
+
"responses": {
|
|
4111
|
+
"202": {
|
|
4112
|
+
"description": "Accepted - the response body contains the partner's default v2.0 read representation after applying the submitted values"
|
|
4113
|
+
},
|
|
4114
|
+
"401": {
|
|
4115
|
+
"description": "Access token is missing or invalid"
|
|
4116
|
+
},
|
|
4117
|
+
"403": {
|
|
4118
|
+
"description": "You do not have permission to perform the action"
|
|
4119
|
+
},
|
|
4120
|
+
"404": {
|
|
4121
|
+
"description": "The record is not found"
|
|
4122
|
+
},
|
|
4123
|
+
"422": {
|
|
4124
|
+
"description": "The payload you provided is invalid"
|
|
4125
|
+
},
|
|
4126
|
+
"429": {
|
|
4127
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
4128
|
+
}
|
|
4129
|
+
}
|
|
4130
|
+
},
|
|
4131
|
+
{
|
|
4132
|
+
"path": "/public-api/actions/payment-terminal/v1.0/{paymentTerminal}/set-custom-fields",
|
|
4133
|
+
"method": "POST",
|
|
4134
|
+
"operationId": "paymentTerminalSetCustomFields",
|
|
4135
|
+
"summary": "Payment terminal / set custom fields",
|
|
4136
|
+
"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 the applicable custom field values of a payment terminal without changing any other payment terminal properties. This action requires permission to view the payment terminal and the `PaymentTerminals.update-custom-fields` permission. When custom fields are enabled for payment terminals, the `customFields` object may be empty; an empty object succeeds as a no-op without creating a value audit. Omitted identifiers remain unchanged, while an explicit `null` clears the corresponding value. If custom fields are disabled for the tenant or for payment terminals, an empty object returns a `422` error keyed as `customFields`, while a populated object returns errors keyed as `customFields.<identifier>`. Every submitted identifier is validated against the payment terminal, the current custom field configuration and the acting administrator's access. Unknown or inapplicable identifiers also return a `422` error keyed as `customFields.<identifier>`, and no submitted values are changed.",
|
|
4137
|
+
"tags": [
|
|
4138
|
+
"action / payment terminal"
|
|
4139
|
+
],
|
|
4140
|
+
"requestBody": {
|
|
4141
|
+
"required": true,
|
|
4142
|
+
"content": {
|
|
4143
|
+
"application/json": {
|
|
4144
|
+
"schema": {
|
|
4145
|
+
"type": "object",
|
|
4146
|
+
"properties": {
|
|
4147
|
+
"customFields": {
|
|
4148
|
+
"type": "object",
|
|
4149
|
+
"additionalProperties": true,
|
|
4150
|
+
"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."
|
|
4151
|
+
}
|
|
4152
|
+
},
|
|
4153
|
+
"required": [
|
|
4154
|
+
"customFields"
|
|
4155
|
+
],
|
|
4156
|
+
"additionalProperties": false
|
|
4157
|
+
}
|
|
4158
|
+
}
|
|
4159
|
+
}
|
|
4160
|
+
},
|
|
4161
|
+
"responses": {
|
|
4162
|
+
"202": {
|
|
4163
|
+
"description": "Accepted - the response body contains the payment terminal's v1.1 read representation after applying the submitted values"
|
|
4164
|
+
},
|
|
4165
|
+
"401": {
|
|
4166
|
+
"description": "Access token is missing or invalid"
|
|
4167
|
+
},
|
|
4168
|
+
"403": {
|
|
4169
|
+
"description": "You do not have permission to perform the action"
|
|
4170
|
+
},
|
|
4171
|
+
"404": {
|
|
4172
|
+
"description": "The record is not found"
|
|
4173
|
+
},
|
|
4174
|
+
"422": {
|
|
4175
|
+
"description": "The payload you provided is invalid"
|
|
4176
|
+
},
|
|
4177
|
+
"429": {
|
|
4178
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
4179
|
+
}
|
|
4180
|
+
}
|
|
4181
|
+
},
|
|
4026
4182
|
{
|
|
4027
4183
|
"path": "/public-api/actions/provisioning-certificate/v1.0/{provisioningCertificate}/issue-emaid",
|
|
4028
4184
|
"method": "POST",
|
|
@@ -4878,6 +5034,57 @@
|
|
|
4878
5034
|
}
|
|
4879
5035
|
}
|
|
4880
5036
|
},
|
|
5037
|
+
{
|
|
5038
|
+
"path": "/public-api/actions/session/v1.0/{session}/set-custom-fields",
|
|
5039
|
+
"method": "POST",
|
|
5040
|
+
"operationId": "sessionSetCustomFields",
|
|
5041
|
+
"summary": "Session / set custom fields",
|
|
5042
|
+
"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 the applicable custom field values of a session without changing any other session properties. This action requires permission to view the session and the `Sessions.update-custom-fields` permission. When custom fields are enabled for sessions, the `customFields` object may be empty; an empty object succeeds as a no-op without creating a value audit. Omitted identifiers remain unchanged, while an explicit `null` clears the corresponding value. If custom fields are disabled for the tenant or for sessions, an empty object returns a `422` error keyed as `customFields`, while a populated object returns errors keyed as `customFields.<identifier>`. Every submitted identifier is validated against the session, the current custom field configuration and the acting administrator's access. Unknown or inapplicable identifiers also return a `422` error keyed as `customFields.<identifier>`, and no submitted values are changed.",
|
|
5043
|
+
"tags": [
|
|
5044
|
+
"action / session"
|
|
5045
|
+
],
|
|
5046
|
+
"requestBody": {
|
|
5047
|
+
"required": true,
|
|
5048
|
+
"content": {
|
|
5049
|
+
"application/json": {
|
|
5050
|
+
"schema": {
|
|
5051
|
+
"type": "object",
|
|
5052
|
+
"properties": {
|
|
5053
|
+
"customFields": {
|
|
5054
|
+
"type": "object",
|
|
5055
|
+
"additionalProperties": true,
|
|
5056
|
+
"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."
|
|
5057
|
+
}
|
|
5058
|
+
},
|
|
5059
|
+
"required": [
|
|
5060
|
+
"customFields"
|
|
5061
|
+
],
|
|
5062
|
+
"additionalProperties": false
|
|
5063
|
+
}
|
|
5064
|
+
}
|
|
5065
|
+
}
|
|
5066
|
+
},
|
|
5067
|
+
"responses": {
|
|
5068
|
+
"202": {
|
|
5069
|
+
"description": "Accepted - the response body contains the session's default read representation after applying the submitted values"
|
|
5070
|
+
},
|
|
5071
|
+
"401": {
|
|
5072
|
+
"description": "Access token is missing or invalid"
|
|
5073
|
+
},
|
|
5074
|
+
"403": {
|
|
5075
|
+
"description": "You do not have permission to perform the action"
|
|
5076
|
+
},
|
|
5077
|
+
"404": {
|
|
5078
|
+
"description": "The record is not found"
|
|
5079
|
+
},
|
|
5080
|
+
"422": {
|
|
5081
|
+
"description": "The payload you provided is invalid"
|
|
5082
|
+
},
|
|
5083
|
+
"429": {
|
|
5084
|
+
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
5085
|
+
}
|
|
5086
|
+
}
|
|
5087
|
+
},
|
|
4881
5088
|
{
|
|
4882
5089
|
"path": "/public-api/actions/subscription-plans/v1.0/{subscriptionPlan}/replace",
|
|
4883
5090
|
"method": "POST",
|
|
@@ -10841,37 +11048,6 @@
|
|
|
10841
11048
|
"example": "local",
|
|
10842
11049
|
"nullable": true,
|
|
10843
11050
|
"description": "Calibration law data availability override for Hubject/OICP compliance. Set to `local` if the charger has a certified on-site display for signed meter readings. Set to `not_available` for chargers whose hardware is not calibration-law compliant (e.g. cannot produce signed meter values). Set to `null` to use automatic resolution (External when Eichrecht is supported, Not Available otherwise)."
|
|
10844
|
-
},
|
|
10845
|
-
"powerSharing": {
|
|
10846
|
-
"type": "object",
|
|
10847
|
-
"properties": {
|
|
10848
|
-
"enabled": {
|
|
10849
|
-
"type": "boolean",
|
|
10850
|
-
"description": "Whether DC cabinet power sharing is enabled for the charge point."
|
|
10851
|
-
},
|
|
10852
|
-
"managementMode": {
|
|
10853
|
-
"type": "string",
|
|
10854
|
-
"enum": [
|
|
10855
|
-
"static",
|
|
10856
|
-
"dynamic"
|
|
10857
|
-
],
|
|
10858
|
-
"description": "Controls how the charge point allocates cabinet power across its DC outputs. `static` uses power modules dedicated to individual EVSEs; modules are not dynamically shared between EVSEs. `dynamic` shares power modules across EVSEs and allocates cabinet power in discrete steps defined by `moduleSizeKw`."
|
|
10859
|
-
},
|
|
10860
|
-
"totalCabinetPowerKw": {
|
|
10861
|
-
"type": "integer",
|
|
10862
|
-
"minimum": 1,
|
|
10863
|
-
"description": "Total power available from the DC cabinet, in kilowatts."
|
|
10864
|
-
},
|
|
10865
|
-
"moduleSizeKw": {
|
|
10866
|
-
"type": "integer",
|
|
10867
|
-
"minimum": 1,
|
|
10868
|
-
"description": "Power of one DC cabinet module, in kilowatts."
|
|
10869
|
-
}
|
|
10870
|
-
},
|
|
10871
|
-
"required": [
|
|
10872
|
-
"enabled"
|
|
10873
|
-
],
|
|
10874
|
-
"description": "DC cabinet power-sharing configuration. When `enabled` is `true`, `totalCabinetPowerKw` and `managementMode` are required. When `managementMode` is `dynamic`, `moduleSizeKw` is required, must not exceed `totalCabinetPowerKw`, and must divide `totalCabinetPowerKw` evenly."
|
|
10875
11051
|
}
|
|
10876
11052
|
},
|
|
10877
11053
|
"required": [
|
|
@@ -11041,37 +11217,6 @@
|
|
|
11041
11217
|
"nullable": true,
|
|
11042
11218
|
"description": "Calibration law data availability override for Hubject/OICP compliance. Set to `local` if the charger has a certified on-site display for signed meter readings. Set to `not_available` for chargers whose hardware is not calibration-law compliant (e.g. cannot produce signed meter values). Set to `null` to use automatic resolution (External when Eichrecht is supported, Not Available otherwise)."
|
|
11043
11219
|
},
|
|
11044
|
-
"powerSharing": {
|
|
11045
|
-
"type": "object",
|
|
11046
|
-
"properties": {
|
|
11047
|
-
"enabled": {
|
|
11048
|
-
"type": "boolean",
|
|
11049
|
-
"description": "Whether DC cabinet power sharing is enabled for the charge point."
|
|
11050
|
-
},
|
|
11051
|
-
"managementMode": {
|
|
11052
|
-
"type": "string",
|
|
11053
|
-
"enum": [
|
|
11054
|
-
"static",
|
|
11055
|
-
"dynamic"
|
|
11056
|
-
],
|
|
11057
|
-
"nullable": true,
|
|
11058
|
-
"description": "Controls how the charge point allocates cabinet power across its DC outputs. `static` uses power modules dedicated to individual EVSEs; modules are not dynamically shared between EVSEs. `dynamic` shares power modules across EVSEs and allocates cabinet power in discrete steps defined by `moduleSizeKw`."
|
|
11059
|
-
},
|
|
11060
|
-
"totalCabinetPowerKw": {
|
|
11061
|
-
"type": "integer",
|
|
11062
|
-
"minimum": 1,
|
|
11063
|
-
"nullable": true,
|
|
11064
|
-
"description": "Total power available from the DC cabinet, in kilowatts. Set to `null` to clear the configured value."
|
|
11065
|
-
},
|
|
11066
|
-
"moduleSizeKw": {
|
|
11067
|
-
"type": "integer",
|
|
11068
|
-
"minimum": 1,
|
|
11069
|
-
"nullable": true,
|
|
11070
|
-
"description": "Power of one DC cabinet module, in kilowatts. Set to `null` to clear the configured value."
|
|
11071
|
-
}
|
|
11072
|
-
},
|
|
11073
|
-
"description": "Updates the DC cabinet power-sharing configuration. Omitted properties retain their current values and explicit `null` clears a nullable property. The resulting configuration must provide `totalCabinetPowerKw` and `managementMode` when enabled. When `managementMode` is `dynamic`, `moduleSizeKw` is required, must not exceed `totalCabinetPowerKw`, and must divide `totalCabinetPowerKw` evenly. Updating this configuration for a charge point with active sessions triggers an immediate dynamic load management rebalance."
|
|
11074
|
-
},
|
|
11075
11220
|
"subscription": {
|
|
11076
11221
|
"type": "object",
|
|
11077
11222
|
"properties": {
|
|
@@ -14131,6 +14276,37 @@
|
|
|
14131
14276
|
],
|
|
14132
14277
|
"nullable": true,
|
|
14133
14278
|
"description": "Specifies the active line conductors used in the circuit. - `L1_L2` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L2_L3` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L1_L3` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L1` - Valid when `phases` = `single_phase` in electrical configuration `star` - `L2` - Valid when `phases` = `single_phase` in electrical configuration `star` - `L3` - Valid when `phases` = `single_phase` in electrical configuration `star`"
|
|
14279
|
+
},
|
|
14280
|
+
"powerSharing": {
|
|
14281
|
+
"type": "object",
|
|
14282
|
+
"properties": {
|
|
14283
|
+
"enabled": {
|
|
14284
|
+
"type": "boolean",
|
|
14285
|
+
"description": "Whether DC cabinet power sharing is enabled for the charge point."
|
|
14286
|
+
},
|
|
14287
|
+
"managementMode": {
|
|
14288
|
+
"type": "string",
|
|
14289
|
+
"enum": [
|
|
14290
|
+
"static",
|
|
14291
|
+
"dynamic"
|
|
14292
|
+
],
|
|
14293
|
+
"nullable": true,
|
|
14294
|
+
"description": "Controls how the charge point allocates cabinet power across its DC outputs. `static` uses power modules dedicated to individual EVSEs; modules are not dynamically shared between EVSEs. `dynamic` shares power modules across EVSEs and allocates cabinet power in discrete steps defined by `moduleSizeKw`."
|
|
14295
|
+
},
|
|
14296
|
+
"totalCabinetPowerKw": {
|
|
14297
|
+
"type": "integer",
|
|
14298
|
+
"minimum": 1,
|
|
14299
|
+
"nullable": true,
|
|
14300
|
+
"description": "Total power available from the DC cabinet, in kilowatts. Set to `null` to clear the configured value."
|
|
14301
|
+
},
|
|
14302
|
+
"moduleSizeKw": {
|
|
14303
|
+
"type": "integer",
|
|
14304
|
+
"minimum": 1,
|
|
14305
|
+
"nullable": true,
|
|
14306
|
+
"description": "Power of one DC cabinet module, in kilowatts. Set to `null` to clear the configured value."
|
|
14307
|
+
}
|
|
14308
|
+
},
|
|
14309
|
+
"description": "Updates the DC cabinet power-sharing configuration. Omitted properties retain their current values and explicit `null` clears a nullable property. The resulting configuration must provide `totalCabinetPowerKw` and `managementMode` when enabled. When `managementMode` is `dynamic`, `moduleSizeKw` is required, must not exceed `totalCabinetPowerKw`, and must divide `totalCabinetPowerKw` evenly. Updating this configuration for a charge point with active sessions triggers an immediate dynamic load management rebalance."
|
|
14134
14310
|
}
|
|
14135
14311
|
},
|
|
14136
14312
|
"required": [
|
|
@@ -14231,6 +14407,37 @@
|
|
|
14231
14407
|
],
|
|
14232
14408
|
"nullable": true,
|
|
14233
14409
|
"description": "Specifies the active line conductors used in the circuit. - `L1_L2` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L2_L3` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L1_L3` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L1` - Valid when `phases` = `single_phase` in electrical configuration `star` - `L2` - Valid when `phases` = `single_phase` in electrical configuration `star` - `L3` - Valid when `phases` = `single_phase` in electrical configuration `star`"
|
|
14410
|
+
},
|
|
14411
|
+
"powerSharing": {
|
|
14412
|
+
"type": "object",
|
|
14413
|
+
"properties": {
|
|
14414
|
+
"enabled": {
|
|
14415
|
+
"type": "boolean",
|
|
14416
|
+
"description": "Whether DC cabinet power sharing is enabled for the charge point."
|
|
14417
|
+
},
|
|
14418
|
+
"managementMode": {
|
|
14419
|
+
"type": "string",
|
|
14420
|
+
"enum": [
|
|
14421
|
+
"static",
|
|
14422
|
+
"dynamic"
|
|
14423
|
+
],
|
|
14424
|
+
"nullable": true,
|
|
14425
|
+
"description": "Controls how the charge point allocates cabinet power across its DC outputs. `static` uses power modules dedicated to individual EVSEs; modules are not dynamically shared between EVSEs. `dynamic` shares power modules across EVSEs and allocates cabinet power in discrete steps defined by `moduleSizeKw`."
|
|
14426
|
+
},
|
|
14427
|
+
"totalCabinetPowerKw": {
|
|
14428
|
+
"type": "integer",
|
|
14429
|
+
"minimum": 1,
|
|
14430
|
+
"nullable": true,
|
|
14431
|
+
"description": "Total power available from the DC cabinet, in kilowatts. Set to `null` to clear the configured value."
|
|
14432
|
+
},
|
|
14433
|
+
"moduleSizeKw": {
|
|
14434
|
+
"type": "integer",
|
|
14435
|
+
"minimum": 1,
|
|
14436
|
+
"nullable": true,
|
|
14437
|
+
"description": "Power of one DC cabinet module, in kilowatts. Set to `null` to clear the configured value."
|
|
14438
|
+
}
|
|
14439
|
+
},
|
|
14440
|
+
"description": "Updates the DC cabinet power-sharing configuration. Omitted properties retain their current values and explicit `null` clears a nullable property. The resulting configuration must provide `totalCabinetPowerKw` and `managementMode` when enabled. When `managementMode` is `dynamic`, `moduleSizeKw` is required, must not exceed `totalCabinetPowerKw`, and must divide `totalCabinetPowerKw` evenly. Updating this configuration for a charge point with active sessions triggers an immediate dynamic load management rebalance."
|
|
14234
14441
|
}
|
|
14235
14442
|
},
|
|
14236
14443
|
"required": [
|
|
@@ -14335,6 +14542,37 @@
|
|
|
14335
14542
|
],
|
|
14336
14543
|
"nullable": true,
|
|
14337
14544
|
"description": "Specifies the active line conductors used in the circuit. - `L1_L2` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L2_L3` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L1_L3` - Valid when `phases` = `split_phase` in electrical configuration `star` or `phases` = `single_phase` in electrical configuration `delta` - `L1` - Valid when `phases` = `single_phase` in electrical configuration `star` - `L2` - Valid when `phases` = `single_phase` in electrical configuration `star` - `L3` - Valid when `phases` = `single_phase` in electrical configuration `star`"
|
|
14545
|
+
},
|
|
14546
|
+
"powerSharing": {
|
|
14547
|
+
"type": "object",
|
|
14548
|
+
"properties": {
|
|
14549
|
+
"enabled": {
|
|
14550
|
+
"type": "boolean",
|
|
14551
|
+
"description": "Whether DC cabinet power sharing is enabled for the charge point."
|
|
14552
|
+
},
|
|
14553
|
+
"managementMode": {
|
|
14554
|
+
"type": "string",
|
|
14555
|
+
"enum": [
|
|
14556
|
+
"static",
|
|
14557
|
+
"dynamic"
|
|
14558
|
+
],
|
|
14559
|
+
"nullable": true,
|
|
14560
|
+
"description": "Controls how the charge point allocates cabinet power across its DC outputs. `static` uses power modules dedicated to individual EVSEs; modules are not dynamically shared between EVSEs. `dynamic` shares power modules across EVSEs and allocates cabinet power in discrete steps defined by `moduleSizeKw`."
|
|
14561
|
+
},
|
|
14562
|
+
"totalCabinetPowerKw": {
|
|
14563
|
+
"type": "integer",
|
|
14564
|
+
"minimum": 1,
|
|
14565
|
+
"nullable": true,
|
|
14566
|
+
"description": "Total power available from the DC cabinet, in kilowatts. Set to `null` to clear the configured value."
|
|
14567
|
+
},
|
|
14568
|
+
"moduleSizeKw": {
|
|
14569
|
+
"type": "integer",
|
|
14570
|
+
"minimum": 1,
|
|
14571
|
+
"nullable": true,
|
|
14572
|
+
"description": "Power of one DC cabinet module, in kilowatts. Set to `null` to clear the configured value."
|
|
14573
|
+
}
|
|
14574
|
+
},
|
|
14575
|
+
"description": "Updates the DC cabinet power-sharing configuration. Omitted properties retain their current values and explicit `null` clears a nullable property. The resulting configuration must provide `totalCabinetPowerKw` and `managementMode` when enabled. When `managementMode` is `dynamic`, `moduleSizeKw` is required, must not exceed `totalCabinetPowerKw`, and must divide `totalCabinetPowerKw` evenly. Updating this configuration for a charge point with active sessions triggers an immediate dynamic load management rebalance."
|
|
14338
14576
|
}
|
|
14339
14577
|
},
|
|
14340
14578
|
"required": [
|
|
@@ -14360,6 +14598,37 @@
|
|
|
14360
14598
|
"preconditioningTime": {
|
|
14361
14599
|
"type": "integer",
|
|
14362
14600
|
"description": "The time in minutes before departure when the charging will be performed with full power."
|
|
14601
|
+
},
|
|
14602
|
+
"powerSharing": {
|
|
14603
|
+
"type": "object",
|
|
14604
|
+
"properties": {
|
|
14605
|
+
"enabled": {
|
|
14606
|
+
"type": "boolean",
|
|
14607
|
+
"description": "Whether DC cabinet power sharing is enabled for the charge point."
|
|
14608
|
+
},
|
|
14609
|
+
"managementMode": {
|
|
14610
|
+
"type": "string",
|
|
14611
|
+
"enum": [
|
|
14612
|
+
"static",
|
|
14613
|
+
"dynamic"
|
|
14614
|
+
],
|
|
14615
|
+
"nullable": true,
|
|
14616
|
+
"description": "Controls how the charge point allocates cabinet power across its DC outputs. `static` uses power modules dedicated to individual EVSEs; modules are not dynamically shared between EVSEs. `dynamic` shares power modules across EVSEs and allocates cabinet power in discrete steps defined by `moduleSizeKw`."
|
|
14617
|
+
},
|
|
14618
|
+
"totalCabinetPowerKw": {
|
|
14619
|
+
"type": "integer",
|
|
14620
|
+
"minimum": 1,
|
|
14621
|
+
"nullable": true,
|
|
14622
|
+
"description": "Total power available from the DC cabinet, in kilowatts. Set to `null` to clear the configured value."
|
|
14623
|
+
},
|
|
14624
|
+
"moduleSizeKw": {
|
|
14625
|
+
"type": "integer",
|
|
14626
|
+
"minimum": 1,
|
|
14627
|
+
"nullable": true,
|
|
14628
|
+
"description": "Power of one DC cabinet module, in kilowatts. Set to `null` to clear the configured value."
|
|
14629
|
+
}
|
|
14630
|
+
},
|
|
14631
|
+
"description": "Updates the DC cabinet power-sharing configuration. Omitted properties retain their current values and explicit `null` clears a nullable property. The resulting configuration must provide `totalCabinetPowerKw` and `managementMode` when enabled. When `managementMode` is `dynamic`, `moduleSizeKw` is required, must not exceed `totalCabinetPowerKw`, and must divide `totalCabinetPowerKw` evenly. Updating this configuration for a charge point with active sessions triggers an immediate dynamic load management rebalance."
|
|
14363
14632
|
}
|
|
14364
14633
|
},
|
|
14365
14634
|
"required": [
|
|
@@ -38069,6 +38338,7 @@
|
|
|
38069
38338
|
"ga-IE",
|
|
38070
38339
|
"bs",
|
|
38071
38340
|
"ja",
|
|
38341
|
+
"ko",
|
|
38072
38342
|
"cs",
|
|
38073
38343
|
"lv",
|
|
38074
38344
|
"et",
|
|
@@ -38826,6 +39096,11 @@
|
|
|
38826
39096
|
"type": "string",
|
|
38827
39097
|
"format": "date"
|
|
38828
39098
|
},
|
|
39099
|
+
"customFields": {
|
|
39100
|
+
"type": "string",
|
|
39101
|
+
"example": "filter[customFields.invoiceReference]=INV-42",
|
|
39102
|
+
"description": "Filter a custom-field host resource by custom fields defined for that resource. Add one literal `customFields.<identifier>` key to the existing `filter` object for each criterion. The identifier suffix is administrator-defined and is never enumerated in this schema or generated per tenant. Use a scalar for boolean, text, email, and URL fields. Boolean accepts booleans and integer `1` or `0`, as well as the strings `\"true\"`, `\"false\"`, `\"1\"`, and `\"0\"`. Text, email, and URL accept strings and use contains matching that is case- and accent-insensitive; backslashes, `%`, and `_` are treated literally rather than as pattern syntax. Use `from`, `to`, or both below the dotted key for number, date, and date-time fields. Both bounds are inclusive. Number bounds are decimal strings from `-99999999999999.999999` through `99999999999999.999999` with at most six decimal places; comparisons preserve submitted and stored decimal precision without rounding. Date bounds use `YYYY-MM-DD` and compare calendar dates without time-zone conversion. Date-time bounds use ISO 8601; offsets are normalized to UTC, and an omitted offset is interpreted as UTC. Multiple identifiers combine with AND. Empty scalar criteria and ranges whose bounds are empty are ignored. An identifier resolves only to its current active definition, so values belonging to a deleted definition never match if its identifier is reused. Operator-scoped filters match only host records whose current operator owner is assigned to the field; retained inapplicable values are excluded before pagination. Unknown, inaccessible, tenant-disabled, resource-disabled, deleted, and otherwise unavailable identifiers all return the same non-disclosing `404` response. An active accessible custom field whose filtering is disabled returns `422` with `Custom field \"{identifier}\" is not filterable for resource \"{resource}\".` Malformed objects or values, a criterion shape that is invalid for the field type, and a range whose `from` bound is greater than its `to` bound return `422`. Custom-field filters apply only to resource listings. They do not participate in search and do not depend on an `include` parameter; any unrelated includes are defined by the host resource. Examples: `filter[customFields.invoiceReference]=INV-42` and `filter[customFields.capacity][from]=10&filter[customFields.capacity][to]=20`. URL-encode the query keys and values when sending the request."
|
|
39103
|
+
},
|
|
38829
39104
|
"externalId": {
|
|
38830
39105
|
"type": "string"
|
|
38831
39106
|
}
|
|
@@ -38855,6 +39130,9 @@
|
|
|
38855
39130
|
"403": {
|
|
38856
39131
|
"description": "You do not have permission to perform the action"
|
|
38857
39132
|
},
|
|
39133
|
+
"404": {
|
|
39134
|
+
"description": "The record is not found"
|
|
39135
|
+
},
|
|
38858
39136
|
"422": {
|
|
38859
39137
|
"description": "The payload you provided is invalid"
|
|
38860
39138
|
},
|
|
@@ -40796,6 +41074,9 @@
|
|
|
40796
41074
|
"403": {
|
|
40797
41075
|
"description": "You do not have permission to perform the action"
|
|
40798
41076
|
},
|
|
41077
|
+
"404": {
|
|
41078
|
+
"description": "The record is not found"
|
|
41079
|
+
},
|
|
40799
41080
|
"422": {
|
|
40800
41081
|
"description": "The payload you provided is invalid"
|
|
40801
41082
|
},
|
|
@@ -41565,6 +41846,11 @@
|
|
|
41565
41846
|
"default": false,
|
|
41566
41847
|
"description": "Allows the Partner to control configurations on their charge points."
|
|
41567
41848
|
},
|
|
41849
|
+
"allowToLogExemptPeriods": {
|
|
41850
|
+
"type": "boolean",
|
|
41851
|
+
"default": false,
|
|
41852
|
+
"description": "Allows Partner admins with the Maintain permission from the DowntimePeriods permission set to log exempt periods."
|
|
41853
|
+
},
|
|
41568
41854
|
"settlementReportBreakdown": {
|
|
41569
41855
|
"type": "string",
|
|
41570
41856
|
"enum": [
|
|
@@ -42621,6 +42907,11 @@
|
|
|
42621
42907
|
"default": false,
|
|
42622
42908
|
"description": "Allows the Partner to control configurations on their charge points."
|
|
42623
42909
|
},
|
|
42910
|
+
"allowToLogExemptPeriods": {
|
|
42911
|
+
"type": "boolean",
|
|
42912
|
+
"default": false,
|
|
42913
|
+
"description": "Allows Partner admins with the Maintain permission from the DowntimePeriods permission set to log exempt periods."
|
|
42914
|
+
},
|
|
42624
42915
|
"settlementReportBreakdown": {
|
|
42625
42916
|
"type": "string",
|
|
42626
42917
|
"enum": [
|
|
@@ -45761,7 +46052,13 @@
|
|
|
45761
46052
|
"description": "Filter by operator ID(s). **For operator-scoped tokens:** If provided, must match the token's operator. Returns empty results if a different operator ID is specified. **For global admin tokens:** Returns resources from the specified operator(s). Multiple IDs can be provided to filter by multiple operators. **Usage examples:** - Single operator: `?filter[operatorId]=1` - Multiple operators: `?filter[operatorId][]=1&filter[operatorId][]=2`"
|
|
45762
46053
|
},
|
|
45763
46054
|
"serialNumber": {
|
|
45764
|
-
"type": "string"
|
|
46055
|
+
"type": "string",
|
|
46056
|
+
"description": "Filter payment terminals by serial number or station."
|
|
46057
|
+
},
|
|
46058
|
+
"customFields": {
|
|
46059
|
+
"type": "object",
|
|
46060
|
+
"additionalProperties": true,
|
|
46061
|
+
"description": "Map of administrator-defined custom field identifiers to filter values. Send each entry as `filter[customFields.<identifier>]`."
|
|
45765
46062
|
}
|
|
45766
46063
|
}
|
|
45767
46064
|
}
|
|
@@ -45778,6 +46075,12 @@
|
|
|
45778
46075
|
"403": {
|
|
45779
46076
|
"description": "You do not have permission to perform the action"
|
|
45780
46077
|
},
|
|
46078
|
+
"404": {
|
|
46079
|
+
"description": "The requested custom field filter identifier is unavailable"
|
|
46080
|
+
},
|
|
46081
|
+
"422": {
|
|
46082
|
+
"description": "The request contains invalid criteria, including malformed or non-filterable custom field filters"
|
|
46083
|
+
},
|
|
45781
46084
|
"429": {
|
|
45782
46085
|
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
45783
46086
|
}
|
|
@@ -45823,6 +46126,7 @@
|
|
|
45823
46126
|
"Windcave",
|
|
45824
46127
|
"Web portal",
|
|
45825
46128
|
"AdyenCastles",
|
|
46129
|
+
"Adyen Castles",
|
|
45826
46130
|
"Printec Castles",
|
|
45827
46131
|
"Cardlink Castles"
|
|
45828
46132
|
]
|
|
@@ -45931,6 +46235,7 @@
|
|
|
45931
46235
|
"Windcave",
|
|
45932
46236
|
"Web portal",
|
|
45933
46237
|
"AdyenCastles",
|
|
46238
|
+
"Adyen Castles",
|
|
45934
46239
|
"Printec Castles",
|
|
45935
46240
|
"Cardlink Castles"
|
|
45936
46241
|
]
|
|
@@ -46185,6 +46490,7 @@
|
|
|
46185
46490
|
"Windcave",
|
|
46186
46491
|
"Web portal",
|
|
46187
46492
|
"AdyenCastles",
|
|
46493
|
+
"Adyen Castles",
|
|
46188
46494
|
"Printec Castles",
|
|
46189
46495
|
"Cardlink Castles"
|
|
46190
46496
|
]
|
|
@@ -46241,6 +46547,7 @@
|
|
|
46241
46547
|
"Windcave",
|
|
46242
46548
|
"Web portal",
|
|
46243
46549
|
"AdyenCastles",
|
|
46550
|
+
"Adyen Castles",
|
|
46244
46551
|
"Printec Castles",
|
|
46245
46552
|
"Cardlink Castles"
|
|
46246
46553
|
]
|
|
@@ -46303,6 +46610,7 @@
|
|
|
46303
46610
|
"Windcave",
|
|
46304
46611
|
"Web portal",
|
|
46305
46612
|
"AdyenCastles",
|
|
46613
|
+
"Adyen Castles",
|
|
46306
46614
|
"Printec Castles",
|
|
46307
46615
|
"Cardlink Castles"
|
|
46308
46616
|
]
|
|
@@ -46363,6 +46671,7 @@
|
|
|
46363
46671
|
"Windcave",
|
|
46364
46672
|
"Web portal",
|
|
46365
46673
|
"AdyenCastles",
|
|
46674
|
+
"Adyen Castles",
|
|
46366
46675
|
"Printec Castles",
|
|
46367
46676
|
"Cardlink Castles"
|
|
46368
46677
|
]
|
|
@@ -46418,6 +46727,7 @@
|
|
|
46418
46727
|
"Windcave",
|
|
46419
46728
|
"Web portal",
|
|
46420
46729
|
"AdyenCastles",
|
|
46730
|
+
"Adyen Castles",
|
|
46421
46731
|
"Printec Castles",
|
|
46422
46732
|
"Cardlink Castles"
|
|
46423
46733
|
]
|
|
@@ -46501,6 +46811,7 @@
|
|
|
46501
46811
|
"Windcave",
|
|
46502
46812
|
"Web portal",
|
|
46503
46813
|
"AdyenCastles",
|
|
46814
|
+
"Adyen Castles",
|
|
46504
46815
|
"Printec Castles",
|
|
46505
46816
|
"Cardlink Castles"
|
|
46506
46817
|
]
|
|
@@ -46556,6 +46867,7 @@
|
|
|
46556
46867
|
"Windcave",
|
|
46557
46868
|
"Web portal",
|
|
46558
46869
|
"AdyenCastles",
|
|
46870
|
+
"Adyen Castles",
|
|
46559
46871
|
"Printec Castles",
|
|
46560
46872
|
"Cardlink Castles"
|
|
46561
46873
|
]
|
|
@@ -46648,6 +46960,7 @@
|
|
|
46648
46960
|
"Windcave",
|
|
46649
46961
|
"Web portal",
|
|
46650
46962
|
"AdyenCastles",
|
|
46963
|
+
"Adyen Castles",
|
|
46651
46964
|
"Printec Castles",
|
|
46652
46965
|
"Cardlink Castles"
|
|
46653
46966
|
]
|
|
@@ -46830,6 +47143,7 @@
|
|
|
46830
47143
|
"Windcave",
|
|
46831
47144
|
"Web portal",
|
|
46832
47145
|
"AdyenCastles",
|
|
47146
|
+
"Adyen Castles",
|
|
46833
47147
|
"Printec Castles",
|
|
46834
47148
|
"Cardlink Castles"
|
|
46835
47149
|
]
|
|
@@ -47025,6 +47339,7 @@
|
|
|
47025
47339
|
"Windcave",
|
|
47026
47340
|
"Web portal",
|
|
47027
47341
|
"AdyenCastles",
|
|
47342
|
+
"Adyen Castles",
|
|
47028
47343
|
"Printec Castles",
|
|
47029
47344
|
"Cardlink Castles"
|
|
47030
47345
|
]
|
|
@@ -47312,6 +47627,7 @@
|
|
|
47312
47627
|
"Windcave",
|
|
47313
47628
|
"Web portal",
|
|
47314
47629
|
"AdyenCastles",
|
|
47630
|
+
"Adyen Castles",
|
|
47315
47631
|
"Printec Castles",
|
|
47316
47632
|
"Cardlink Castles"
|
|
47317
47633
|
]
|
|
@@ -47394,6 +47710,7 @@
|
|
|
47394
47710
|
"Windcave",
|
|
47395
47711
|
"Web portal",
|
|
47396
47712
|
"AdyenCastles",
|
|
47713
|
+
"Adyen Castles",
|
|
47397
47714
|
"Printec Castles",
|
|
47398
47715
|
"Cardlink Castles"
|
|
47399
47716
|
]
|
|
@@ -47559,6 +47876,7 @@
|
|
|
47559
47876
|
"Windcave",
|
|
47560
47877
|
"Web portal",
|
|
47561
47878
|
"AdyenCastles",
|
|
47879
|
+
"Adyen Castles",
|
|
47562
47880
|
"Printec Castles",
|
|
47563
47881
|
"Cardlink Castles"
|
|
47564
47882
|
]
|
|
@@ -47604,6 +47922,7 @@
|
|
|
47604
47922
|
"Windcave",
|
|
47605
47923
|
"Web portal",
|
|
47606
47924
|
"AdyenCastles",
|
|
47925
|
+
"Adyen Castles",
|
|
47607
47926
|
"Printec Castles",
|
|
47608
47927
|
"Cardlink Castles"
|
|
47609
47928
|
]
|
|
@@ -47656,6 +47975,7 @@
|
|
|
47656
47975
|
"Windcave",
|
|
47657
47976
|
"Web portal",
|
|
47658
47977
|
"AdyenCastles",
|
|
47978
|
+
"Adyen Castles",
|
|
47659
47979
|
"Printec Castles",
|
|
47660
47980
|
"Cardlink Castles"
|
|
47661
47981
|
]
|
|
@@ -47705,6 +48025,7 @@
|
|
|
47705
48025
|
"Windcave",
|
|
47706
48026
|
"Web portal",
|
|
47707
48027
|
"AdyenCastles",
|
|
48028
|
+
"Adyen Castles",
|
|
47708
48029
|
"Printec Castles",
|
|
47709
48030
|
"Cardlink Castles"
|
|
47710
48031
|
]
|
|
@@ -47750,6 +48071,7 @@
|
|
|
47750
48071
|
"Windcave",
|
|
47751
48072
|
"Web portal",
|
|
47752
48073
|
"AdyenCastles",
|
|
48074
|
+
"Adyen Castles",
|
|
47753
48075
|
"Printec Castles",
|
|
47754
48076
|
"Cardlink Castles"
|
|
47755
48077
|
]
|
|
@@ -47820,6 +48142,7 @@
|
|
|
47820
48142
|
"Windcave",
|
|
47821
48143
|
"Web portal",
|
|
47822
48144
|
"AdyenCastles",
|
|
48145
|
+
"Adyen Castles",
|
|
47823
48146
|
"Printec Castles",
|
|
47824
48147
|
"Cardlink Castles"
|
|
47825
48148
|
]
|
|
@@ -47865,6 +48188,7 @@
|
|
|
47865
48188
|
"Windcave",
|
|
47866
48189
|
"Web portal",
|
|
47867
48190
|
"AdyenCastles",
|
|
48191
|
+
"Adyen Castles",
|
|
47868
48192
|
"Printec Castles",
|
|
47869
48193
|
"Cardlink Castles"
|
|
47870
48194
|
]
|
|
@@ -47896,6 +48220,7 @@
|
|
|
47896
48220
|
"Windcave",
|
|
47897
48221
|
"Web portal",
|
|
47898
48222
|
"AdyenCastles",
|
|
48223
|
+
"Adyen Castles",
|
|
47899
48224
|
"Printec Castles",
|
|
47900
48225
|
"Cardlink Castles"
|
|
47901
48226
|
]
|
|
@@ -48011,6 +48336,7 @@
|
|
|
48011
48336
|
"Windcave",
|
|
48012
48337
|
"Web portal",
|
|
48013
48338
|
"AdyenCastles",
|
|
48339
|
+
"Adyen Castles",
|
|
48014
48340
|
"Printec Castles",
|
|
48015
48341
|
"Cardlink Castles"
|
|
48016
48342
|
]
|
|
@@ -48118,6 +48444,7 @@
|
|
|
48118
48444
|
"Windcave",
|
|
48119
48445
|
"Web portal",
|
|
48120
48446
|
"AdyenCastles",
|
|
48447
|
+
"Adyen Castles",
|
|
48121
48448
|
"Printec Castles",
|
|
48122
48449
|
"Cardlink Castles"
|
|
48123
48450
|
]
|
|
@@ -51959,7 +52286,7 @@
|
|
|
51959
52286
|
"customFields": {
|
|
51960
52287
|
"type": "string",
|
|
51961
52288
|
"example": "filter[customFields.invoiceReference]=INV-42",
|
|
51962
|
-
"description": "Filter
|
|
52289
|
+
"description": "Filter a custom-field host resource by custom fields defined for that resource. Add one literal `customFields.<identifier>` key to the existing `filter` object for each criterion. The identifier suffix is administrator-defined and is never enumerated in this schema or generated per tenant. Use a scalar for boolean, text, email, and URL fields. Boolean accepts booleans and integer `1` or `0`, as well as the strings `\"true\"`, `\"false\"`, `\"1\"`, and `\"0\"`. Text, email, and URL accept strings and use contains matching that is case- and accent-insensitive; backslashes, `%`, and `_` are treated literally rather than as pattern syntax. Use `from`, `to`, or both below the dotted key for number, date, and date-time fields. Both bounds are inclusive. Number bounds are decimal strings from `-99999999999999.999999` through `99999999999999.999999` with at most six decimal places; comparisons preserve submitted and stored decimal precision without rounding. Date bounds use `YYYY-MM-DD` and compare calendar dates without time-zone conversion. Date-time bounds use ISO 8601; offsets are normalized to UTC, and an omitted offset is interpreted as UTC. Multiple identifiers combine with AND. Empty scalar criteria and ranges whose bounds are empty are ignored. An identifier resolves only to its current active definition, so values belonging to a deleted definition never match if its identifier is reused. Operator-scoped filters match only host records whose current operator owner is assigned to the field; retained inapplicable values are excluded before pagination. Unknown, inaccessible, tenant-disabled, resource-disabled, deleted, and otherwise unavailable identifiers all return the same non-disclosing `404` response. An active accessible custom field whose filtering is disabled returns `422` with `Custom field \"{identifier}\" is not filterable for resource \"{resource}\".` Malformed objects or values, a criterion shape that is invalid for the field type, and a range whose `from` bound is greater than its `to` bound return `422`. Custom-field filters apply only to resource listings. They do not participate in search and do not depend on an `include` parameter; any unrelated includes are defined by the host resource. Examples: `filter[customFields.invoiceReference]=INV-42` and `filter[customFields.capacity][from]=10&filter[customFields.capacity][to]=20`. URL-encode the query keys and values when sending the request."
|
|
51963
52290
|
}
|
|
51964
52291
|
}
|
|
51965
52292
|
}
|
|
@@ -52070,7 +52397,7 @@
|
|
|
52070
52397
|
"default": false
|
|
52071
52398
|
},
|
|
52072
52399
|
"include": {
|
|
52073
|
-
"description": "Include additional information in the response. The following options are available:<br> - `externalAppData`: Include external application data in the response<br> - `chargingProfile`: Include the TX charging profile applied to the session in the response<br> - `vehicle`: Include the nested `vehicle` object describing the vehicle associated with the session",
|
|
52400
|
+
"description": "Include additional information in the response. The following options are available:<br> - `externalAppData`: Include external application data in the response<br> - `chargingProfile`: Include the TX charging profile applied to the session in the response<br> - `vehicle`: Include the nested `vehicle` object describing the vehicle associated with the session<br> - `timelineSnapshot`: Include the pre-computed timeline snapshot for a finished session when available",
|
|
52074
52401
|
"schema": {
|
|
52075
52402
|
"type": "array",
|
|
52076
52403
|
"items": {
|
|
@@ -52078,7 +52405,8 @@
|
|
|
52078
52405
|
"enum": [
|
|
52079
52406
|
"externalAppData",
|
|
52080
52407
|
"chargingProfile",
|
|
52081
|
-
"vehicle"
|
|
52408
|
+
"vehicle",
|
|
52409
|
+
"timelineSnapshot"
|
|
52082
52410
|
]
|
|
52083
52411
|
}
|
|
52084
52412
|
}
|
|
@@ -52106,66 +52434,6 @@
|
|
|
52106
52434
|
}
|
|
52107
52435
|
}
|
|
52108
52436
|
},
|
|
52109
|
-
{
|
|
52110
|
-
"path": "/public-api/resources/sessions/v1.0/{session}",
|
|
52111
|
-
"method": "PATCH",
|
|
52112
|
-
"operationId": "sessionUpdate",
|
|
52113
|
-
"summary": "Session / Update",
|
|
52114
|
-
"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.",
|
|
52115
|
-
"tags": [
|
|
52116
|
-
"resource / sessions"
|
|
52117
|
-
],
|
|
52118
|
-
"parameters": {
|
|
52119
|
-
"path": {
|
|
52120
|
-
"session": {
|
|
52121
|
-
"description": "The session ID to fetch",
|
|
52122
|
-
"type": "string",
|
|
52123
|
-
"required": true
|
|
52124
|
-
}
|
|
52125
|
-
}
|
|
52126
|
-
},
|
|
52127
|
-
"requestBody": {
|
|
52128
|
-
"required": true,
|
|
52129
|
-
"content": {
|
|
52130
|
-
"application/json": {
|
|
52131
|
-
"schema": {
|
|
52132
|
-
"type": "object",
|
|
52133
|
-
"properties": {
|
|
52134
|
-
"customFields": {
|
|
52135
|
-
"type": "object",
|
|
52136
|
-
"additionalProperties": true,
|
|
52137
|
-
"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."
|
|
52138
|
-
}
|
|
52139
|
-
},
|
|
52140
|
-
"required": [
|
|
52141
|
-
"customFields"
|
|
52142
|
-
],
|
|
52143
|
-
"additionalProperties": false
|
|
52144
|
-
}
|
|
52145
|
-
}
|
|
52146
|
-
}
|
|
52147
|
-
},
|
|
52148
|
-
"responses": {
|
|
52149
|
-
"200": {
|
|
52150
|
-
"description": "Success"
|
|
52151
|
-
},
|
|
52152
|
-
"401": {
|
|
52153
|
-
"description": "Access token is missing or invalid"
|
|
52154
|
-
},
|
|
52155
|
-
"403": {
|
|
52156
|
-
"description": "You do not have permission to perform the action"
|
|
52157
|
-
},
|
|
52158
|
-
"404": {
|
|
52159
|
-
"description": "The record is not found"
|
|
52160
|
-
},
|
|
52161
|
-
"422": {
|
|
52162
|
-
"description": "The payload you provided is invalid"
|
|
52163
|
-
},
|
|
52164
|
-
"429": {
|
|
52165
|
-
"description": "Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*"
|
|
52166
|
-
}
|
|
52167
|
-
}
|
|
52168
|
-
},
|
|
52169
52437
|
{
|
|
52170
52438
|
"path": "/public-api/resources/sessions/v1.0/{session}/consumption-stats",
|
|
52171
52439
|
"method": "GET",
|
|
@@ -52243,7 +52511,7 @@
|
|
|
52243
52511
|
"method": "GET",
|
|
52244
52512
|
"operationId": "sessionTimelineSnapshotRead",
|
|
52245
52513
|
"summary": "Sessions / Timeline Snapshot / Read",
|
|
52246
|
-
"description": "Returns the meter value time-series and lifecycle events for a finished charging session. **Availability.** Snapshots are generated when a session completes. Active sessions return 404. Finished sessions without snapshots, including sessions that finished before snapshot generation was available, also return 404. There is no historical backfill. **For active sessions**, use `GET /logs/communication/v1.0?filter[sessionId]={id}&filter[command]=MeterValues` to read real-time OCPP meter values from communication logs (6-month retention).",
|
|
52514
|
+
"description": "Returns the meter value time-series and lifecycle events for a finished charging session. **Availability.** Snapshots are generated when a session completes. Active sessions return 404. Finished sessions without snapshots, including sessions that finished before snapshot generation was available, also return 404. There is no historical backfill. Confirmed transaction boundary events are included only in snapshots generated after those event types became available; existing snapshots are not modified. A boundary event is omitted when its timestamp or precise meter reading is unavailable. **For active sessions**, use `GET /logs/communication/v1.0?filter[sessionId]={id}&filter[command]=MeterValues` to read real-time OCPP meter values from communication logs (6-month retention).",
|
|
52247
52515
|
"tags": [
|
|
52248
52516
|
"resource / sessions"
|
|
52249
52517
|
],
|
|
@@ -62835,10 +63103,11 @@
|
|
|
62835
63103
|
"bank_transfer_pending",
|
|
62836
63104
|
"bank_transfer_processing",
|
|
62837
63105
|
"payment_terminal_authorization",
|
|
63106
|
+
"awaiting_reconciliation",
|
|
62838
63107
|
"other"
|
|
62839
63108
|
],
|
|
62840
63109
|
"example": "3ds_authentication",
|
|
62841
|
-
"description": "Reason a transaction is currently pending. Available only while `status` is `pending`; omitted once the transaction reaches a terminal status. The property may also be absent on a pending transaction when no specific reason has been recorded — for example legacy transactions created before the enum rolled out to all PSPs, or transactions handled by a payment service provider that does not yet report a pending reason. - **3ds_authentication**: Transaction requires 3D Secure verification from the user - **psp_processing**: Payment processor is processing the transaction - **bank_transfer_pending**: User needs to complete the bank transfer redirect - **bank_transfer_processing**: Bank transfer initiated, awaiting confirmation - **payment_terminal_authorization**: Waiting for payment terminal authorization - **other**: Pending but the reason does not fit any of the defined categories"
|
|
63110
|
+
"description": "Reason a transaction is currently pending. Available only while `status` is `pending`; omitted once the transaction reaches a terminal status. The property may also be absent on a pending transaction when no specific reason has been recorded — for example legacy transactions created before the enum rolled out to all PSPs, or transactions handled by a payment service provider that does not yet report a pending reason. - **3ds_authentication**: Transaction requires 3D Secure verification from the user - **psp_processing**: Payment processor is processing the transaction - **bank_transfer_pending**: User needs to complete the bank transfer redirect - **bank_transfer_processing**: Bank transfer initiated, awaiting confirmation - **payment_terminal_authorization**: Waiting for payment terminal authorization - **awaiting_reconciliation**: The payment is handled by a payment terminal on the charge point, and the transaction is waiting to be reconciled with the amount that terminal settles. The amount currently on the transaction is provisional until reconciliation completes. - **other**: Pending but the reason does not fit any of the defined categories"
|
|
62842
63111
|
},
|
|
62843
63112
|
"description": "Only list transactions with the specified pending reason(s). When this filter is applied, results are implicitly limited to transactions whose status is `pending`."
|
|
62844
63113
|
},
|
|
@@ -68830,6 +69099,7 @@
|
|
|
68830
69099
|
"ga-IE",
|
|
68831
69100
|
"bs",
|
|
68832
69101
|
"ja",
|
|
69102
|
+
"ko",
|
|
68833
69103
|
"cs",
|
|
68834
69104
|
"lv",
|
|
68835
69105
|
"et",
|
|
@@ -69750,6 +70020,7 @@
|
|
|
69750
70020
|
"ga-IE",
|
|
69751
70021
|
"bs",
|
|
69752
70022
|
"ja",
|
|
70023
|
+
"ko",
|
|
69753
70024
|
"cs",
|
|
69754
70025
|
"lv",
|
|
69755
70026
|
"et",
|
|
@@ -71928,7 +72199,7 @@
|
|
|
71928
72199
|
],
|
|
71929
72200
|
"info": {
|
|
71930
72201
|
"title": "Public API",
|
|
71931
|
-
"version": "3.
|
|
72202
|
+
"version": "3.248.0",
|
|
71932
72203
|
"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"
|
|
71933
72204
|
},
|
|
71934
72205
|
"servers": [
|
|
@@ -71942,18 +72213,18 @@
|
|
|
71942
72213
|
}
|
|
71943
72214
|
}
|
|
71944
72215
|
],
|
|
71945
|
-
"buildTimestamp": "2026-09-
|
|
72216
|
+
"buildTimestamp": "2026-09-14T13:02:49.113Z",
|
|
71946
72217
|
"stats": {
|
|
71947
|
-
"totalEndpoints":
|
|
71948
|
-
"originalSize":
|
|
71949
|
-
"optimizedSize":
|
|
71950
|
-
"reductionPercent": 72.
|
|
71951
|
-
"buildDuration":
|
|
72218
|
+
"totalEndpoints": 643,
|
|
72219
|
+
"originalSize": 5956908,
|
|
72220
|
+
"optimizedSize": 1651756,
|
|
72221
|
+
"reductionPercent": 72.27,
|
|
72222
|
+
"buildDuration": 1576,
|
|
71952
72223
|
"responseSchemas": {
|
|
71953
|
-
"total":
|
|
71954
|
-
"withSchemas":
|
|
71955
|
-
"totalSchemaSize":
|
|
71956
|
-
"averageSchemaSize":
|
|
72224
|
+
"total": 643,
|
|
72225
|
+
"withSchemas": 643,
|
|
72226
|
+
"totalSchemaSize": 3413991,
|
|
72227
|
+
"averageSchemaSize": 5309
|
|
71957
72228
|
}
|
|
71958
72229
|
}
|
|
71959
72230
|
}
|