@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
|
@@ -5035,6 +5035,52 @@
|
|
|
5035
5035
|
"country"
|
|
5036
5036
|
]
|
|
5037
5037
|
},
|
|
5038
|
+
"fiscalization": {
|
|
5039
|
+
"type": "object",
|
|
5040
|
+
"properties": {
|
|
5041
|
+
"status": {
|
|
5042
|
+
"description": "Certification status of the invoice with its fiscalization integration.\n- **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.\n- **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`.\n- **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.\n- **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.\n",
|
|
5043
|
+
"type": "string",
|
|
5044
|
+
"enum": [
|
|
5045
|
+
"pending",
|
|
5046
|
+
"certified",
|
|
5047
|
+
"failed",
|
|
5048
|
+
"canceled"
|
|
5049
|
+
],
|
|
5050
|
+
"example": "certified"
|
|
5051
|
+
},
|
|
5052
|
+
"referenceNumber": {
|
|
5053
|
+
"type": "string",
|
|
5054
|
+
"description": "Reference recorded for this document by the fiscalization integration, for correlating it with that integration's own records. For most integrations this is the number assigned by the tax authority; some record a provider-side identifier instead. Treat it as an opaque, integration-defined reference rather than assuming it is the legally issued document number. Once recorded it does not change, including after the document is canceled. Distinct from `externalId`, which is the reference an external accounting or ERP system wrote into the platform. Absent when the integration has recorded no reference."
|
|
5055
|
+
},
|
|
5056
|
+
"documents": {
|
|
5057
|
+
"type": "array",
|
|
5058
|
+
"description": "Document formats the fiscal authority has made available for this invoice. Omitted while no format has been made available yet.",
|
|
5059
|
+
"items": {
|
|
5060
|
+
"type": "object",
|
|
5061
|
+
"properties": {
|
|
5062
|
+
"format": {
|
|
5063
|
+
"type": "string",
|
|
5064
|
+
"description": "Identifier of the document format, exactly as reported by the fiscal authority. The value is provider-defined and its syntax is not guaranteed — it may be a media type such as `application/pdf`, or a mandate-specific format name. The set is not fixed, so treat an unrecognised value as a format this integration has newly made available rather than as an error; match it verbatim rather than parsing it.",
|
|
5065
|
+
"example": "application/pdf"
|
|
5066
|
+
},
|
|
5067
|
+
"downloadUrl": {
|
|
5068
|
+
"type": "string",
|
|
5069
|
+
"description": "Signed link that downloads this format. The link expires 24 hours after the response was produced, so it must be followed rather than stored; request the invoice again for a fresh link. The document is fetched from the fiscal authority only when the link is followed, so the download responds with `424 Failed Dependency` when the provider cannot supply the format at that moment."
|
|
5070
|
+
}
|
|
5071
|
+
},
|
|
5072
|
+
"required": [
|
|
5073
|
+
"format",
|
|
5074
|
+
"downloadUrl"
|
|
5075
|
+
]
|
|
5076
|
+
}
|
|
5077
|
+
}
|
|
5078
|
+
},
|
|
5079
|
+
"required": [
|
|
5080
|
+
"status"
|
|
5081
|
+
],
|
|
5082
|
+
"description": "Certification of this invoice with the fiscal authority. Present when the invoice has a fiscal document; omitted entirely for invoices with no fiscal document at all. Presence does not depend on `type` — a fiscalized credit note carries this object exactly as an invoice does."
|
|
5083
|
+
},
|
|
5038
5084
|
"lastUpdatedAt": {
|
|
5039
5085
|
"type": "string",
|
|
5040
5086
|
"format": "date-time",
|
|
@@ -62928,6 +62974,52 @@
|
|
|
62928
62974
|
"country"
|
|
62929
62975
|
]
|
|
62930
62976
|
},
|
|
62977
|
+
"fiscalization": {
|
|
62978
|
+
"type": "object",
|
|
62979
|
+
"properties": {
|
|
62980
|
+
"status": {
|
|
62981
|
+
"description": "Certification status of the invoice with its fiscalization integration.\n- **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.\n- **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`.\n- **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.\n- **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.\n",
|
|
62982
|
+
"type": "string",
|
|
62983
|
+
"enum": [
|
|
62984
|
+
"pending",
|
|
62985
|
+
"certified",
|
|
62986
|
+
"failed",
|
|
62987
|
+
"canceled"
|
|
62988
|
+
],
|
|
62989
|
+
"example": "certified"
|
|
62990
|
+
},
|
|
62991
|
+
"referenceNumber": {
|
|
62992
|
+
"type": "string",
|
|
62993
|
+
"description": "Reference recorded for this document by the fiscalization integration, for correlating it with that integration's own records. For most integrations this is the number assigned by the tax authority; some record a provider-side identifier instead. Treat it as an opaque, integration-defined reference rather than assuming it is the legally issued document number. Once recorded it does not change, including after the document is canceled. Distinct from `externalId`, which is the reference an external accounting or ERP system wrote into the platform. Absent when the integration has recorded no reference."
|
|
62994
|
+
},
|
|
62995
|
+
"documents": {
|
|
62996
|
+
"type": "array",
|
|
62997
|
+
"description": "Document formats the fiscal authority has made available for this invoice. Omitted while no format has been made available yet.",
|
|
62998
|
+
"items": {
|
|
62999
|
+
"type": "object",
|
|
63000
|
+
"properties": {
|
|
63001
|
+
"format": {
|
|
63002
|
+
"type": "string",
|
|
63003
|
+
"description": "Identifier of the document format, exactly as reported by the fiscal authority. The value is provider-defined and its syntax is not guaranteed — it may be a media type such as `application/pdf`, or a mandate-specific format name. The set is not fixed, so treat an unrecognised value as a format this integration has newly made available rather than as an error; match it verbatim rather than parsing it.",
|
|
63004
|
+
"example": "application/pdf"
|
|
63005
|
+
},
|
|
63006
|
+
"downloadUrl": {
|
|
63007
|
+
"type": "string",
|
|
63008
|
+
"description": "Signed link that downloads this format. The link expires 24 hours after the response was produced, so it must be followed rather than stored; request the invoice again for a fresh link. The document is fetched from the fiscal authority only when the link is followed, so the download responds with `424 Failed Dependency` when the provider cannot supply the format at that moment."
|
|
63009
|
+
}
|
|
63010
|
+
},
|
|
63011
|
+
"required": [
|
|
63012
|
+
"format",
|
|
63013
|
+
"downloadUrl"
|
|
63014
|
+
]
|
|
63015
|
+
}
|
|
63016
|
+
}
|
|
63017
|
+
},
|
|
63018
|
+
"required": [
|
|
63019
|
+
"status"
|
|
63020
|
+
],
|
|
63021
|
+
"description": "Certification of this invoice with the fiscal authority. Present when the invoice has a fiscal document; omitted entirely for invoices with no fiscal document at all. Presence does not depend on `type` — a fiscalized credit note carries this object exactly as an invoice does."
|
|
63022
|
+
},
|
|
62931
63023
|
"lastUpdatedAt": {
|
|
62932
63024
|
"type": "string",
|
|
62933
63025
|
"format": "date-time",
|
|
@@ -63089,6 +63181,28 @@
|
|
|
63089
63181
|
}
|
|
63090
63182
|
}
|
|
63091
63183
|
},
|
|
63184
|
+
"422": {
|
|
63185
|
+
"schema": {
|
|
63186
|
+
"type": "object",
|
|
63187
|
+
"required": [
|
|
63188
|
+
"message"
|
|
63189
|
+
],
|
|
63190
|
+
"properties": {
|
|
63191
|
+
"message": {
|
|
63192
|
+
"type": "string"
|
|
63193
|
+
},
|
|
63194
|
+
"errors": {
|
|
63195
|
+
"type": "object",
|
|
63196
|
+
"additionalProperties": {
|
|
63197
|
+
"type": "array",
|
|
63198
|
+
"items": {
|
|
63199
|
+
"type": "string"
|
|
63200
|
+
}
|
|
63201
|
+
}
|
|
63202
|
+
}
|
|
63203
|
+
}
|
|
63204
|
+
}
|
|
63205
|
+
},
|
|
63092
63206
|
"429": {
|
|
63093
63207
|
"schema": {
|
|
63094
63208
|
"type": "object",
|
|
@@ -63693,6 +63807,52 @@
|
|
|
63693
63807
|
"country"
|
|
63694
63808
|
]
|
|
63695
63809
|
},
|
|
63810
|
+
"fiscalization": {
|
|
63811
|
+
"type": "object",
|
|
63812
|
+
"properties": {
|
|
63813
|
+
"status": {
|
|
63814
|
+
"description": "Certification status of the invoice with its fiscalization integration.\n- **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.\n- **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`.\n- **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.\n- **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.\n",
|
|
63815
|
+
"type": "string",
|
|
63816
|
+
"enum": [
|
|
63817
|
+
"pending",
|
|
63818
|
+
"certified",
|
|
63819
|
+
"failed",
|
|
63820
|
+
"canceled"
|
|
63821
|
+
],
|
|
63822
|
+
"example": "certified"
|
|
63823
|
+
},
|
|
63824
|
+
"referenceNumber": {
|
|
63825
|
+
"type": "string",
|
|
63826
|
+
"description": "Reference recorded for this document by the fiscalization integration, for correlating it with that integration's own records. For most integrations this is the number assigned by the tax authority; some record a provider-side identifier instead. Treat it as an opaque, integration-defined reference rather than assuming it is the legally issued document number. Once recorded it does not change, including after the document is canceled. Distinct from `externalId`, which is the reference an external accounting or ERP system wrote into the platform. Absent when the integration has recorded no reference."
|
|
63827
|
+
},
|
|
63828
|
+
"documents": {
|
|
63829
|
+
"type": "array",
|
|
63830
|
+
"description": "Document formats the fiscal authority has made available for this invoice. Omitted while no format has been made available yet.",
|
|
63831
|
+
"items": {
|
|
63832
|
+
"type": "object",
|
|
63833
|
+
"properties": {
|
|
63834
|
+
"format": {
|
|
63835
|
+
"type": "string",
|
|
63836
|
+
"description": "Identifier of the document format, exactly as reported by the fiscal authority. The value is provider-defined and its syntax is not guaranteed — it may be a media type such as `application/pdf`, or a mandate-specific format name. The set is not fixed, so treat an unrecognised value as a format this integration has newly made available rather than as an error; match it verbatim rather than parsing it.",
|
|
63837
|
+
"example": "application/pdf"
|
|
63838
|
+
},
|
|
63839
|
+
"downloadUrl": {
|
|
63840
|
+
"type": "string",
|
|
63841
|
+
"description": "Signed link that downloads this format. The link expires 24 hours after the response was produced, so it must be followed rather than stored; request the invoice again for a fresh link. The document is fetched from the fiscal authority only when the link is followed, so the download responds with `424 Failed Dependency` when the provider cannot supply the format at that moment."
|
|
63842
|
+
}
|
|
63843
|
+
},
|
|
63844
|
+
"required": [
|
|
63845
|
+
"format",
|
|
63846
|
+
"downloadUrl"
|
|
63847
|
+
]
|
|
63848
|
+
}
|
|
63849
|
+
}
|
|
63850
|
+
},
|
|
63851
|
+
"required": [
|
|
63852
|
+
"status"
|
|
63853
|
+
],
|
|
63854
|
+
"description": "Certification of this invoice with the fiscal authority. Present when the invoice has a fiscal document; omitted entirely for invoices with no fiscal document at all. Presence does not depend on `type` — a fiscalized credit note carries this object exactly as an invoice does."
|
|
63855
|
+
},
|
|
63696
63856
|
"lastUpdatedAt": {
|
|
63697
63857
|
"type": "string",
|
|
63698
63858
|
"format": "date-time",
|
|
@@ -63760,7 +63920,7 @@
|
|
|
63760
63920
|
}
|
|
63761
63921
|
}
|
|
63762
63922
|
},
|
|
63763
|
-
"
|
|
63923
|
+
"invoiceFiscalizationAttemptsListing": {
|
|
63764
63924
|
"200": {
|
|
63765
63925
|
"schema": {
|
|
63766
63926
|
"type": "object",
|
|
@@ -63769,159 +63929,404 @@
|
|
|
63769
63929
|
"type": "array",
|
|
63770
63930
|
"items": {
|
|
63771
63931
|
"type": "object",
|
|
63772
|
-
"description": "
|
|
63932
|
+
"description": "A single fiscalization attempt recorded for this invoice.",
|
|
63773
63933
|
"properties": {
|
|
63774
63934
|
"id": {
|
|
63775
63935
|
"type": "integer",
|
|
63776
|
-
"description": "
|
|
63777
|
-
"
|
|
63778
|
-
},
|
|
63779
|
-
"operatorId": {
|
|
63780
|
-
"type": "integer",
|
|
63781
|
-
"nullable": true,
|
|
63782
|
-
"description": "The ID of the operator this resource belongs to",
|
|
63783
|
-
"example": 1
|
|
63784
|
-
},
|
|
63785
|
-
"title": {
|
|
63786
|
-
"type": "string",
|
|
63787
|
-
"description": "Issue title",
|
|
63788
|
-
"maxLength": 255
|
|
63936
|
+
"description": "Identifier of this attempt. Stable for the lifetime of the record, so it is what to deduplicate and reconcile on when ingesting attempts, and what to quote when referring to one specific attempt.",
|
|
63937
|
+
"example": 4211
|
|
63789
63938
|
},
|
|
63790
|
-
"
|
|
63939
|
+
"attemptedAt": {
|
|
63791
63940
|
"type": "string",
|
|
63792
|
-
"
|
|
63793
|
-
|
|
63794
|
-
"resolutionDetails": {
|
|
63795
|
-
"type": "string",
|
|
63796
|
-
"description": "Details about how the issue was resolved or why it was closed. Only present when status is resolved, wont_fix, or non_issue."
|
|
63797
|
-
},
|
|
63798
|
-
"status": {
|
|
63799
|
-
"type": "string",
|
|
63800
|
-
"enum": [
|
|
63801
|
-
"auto_recovery_in_progress",
|
|
63802
|
-
"information_collection_in_progress",
|
|
63803
|
-
"new",
|
|
63804
|
-
"investigating",
|
|
63805
|
-
"resolution_in_progress",
|
|
63806
|
-
"resolved",
|
|
63807
|
-
"wont_fix",
|
|
63808
|
-
"non_issue"
|
|
63809
|
-
],
|
|
63810
|
-
"description": "Issue status:\n- **auto_recovery_in_progress**: Issue is in automatic recovery process (preparation state)\n- **information_collection_in_progress**: System is collecting diagnostic information (preparation state)\n- **new**: Issue has been reported and not yet investigated (open state)\n- **investigating**: Issue is currently being investigated (open state)\n- **resolution_in_progress**: Resolution actions are being applied (open state)\n- **resolved**: Issue has been resolved successfully (closed state)\n- **wont_fix**: Issue will not be fixed (closed state)\n- **non_issue**: Reported issue determined to not be an actual issue (closed state)\n",
|
|
63811
|
-
"example": "investigating"
|
|
63812
|
-
},
|
|
63813
|
-
"workflowState": {
|
|
63814
|
-
"readOnly": true,
|
|
63815
|
-
"description": "Issue workflow state (derived from status):\n- **preparation**: System is performing automatic actions before manual intervention (auto-resolution statuses)\n- **open**: Issue requires attention or is being worked on (new, investigating, resolutionInProgress)\n- **closed**: Issue is no longer active (resolved, wontFix, nonIssue)\n",
|
|
63816
|
-
"type": "string",
|
|
63817
|
-
"enum": [
|
|
63818
|
-
"preparation",
|
|
63819
|
-
"open",
|
|
63820
|
-
"closed"
|
|
63821
|
-
],
|
|
63822
|
-
"example": "open"
|
|
63823
|
-
},
|
|
63824
|
-
"category": {
|
|
63825
|
-
"type": "string",
|
|
63826
|
-
"enum": [
|
|
63827
|
-
"network",
|
|
63828
|
-
"payments_billing",
|
|
63829
|
-
"product_offerings",
|
|
63830
|
-
"ev_driver_ux",
|
|
63831
|
-
"security",
|
|
63832
|
-
"reporting",
|
|
63833
|
-
"roaming",
|
|
63834
|
-
"other"
|
|
63835
|
-
],
|
|
63836
|
-
"description": "Issue category:\n- **network**: Network connectivity or communication issues\n- **payments_billing**: Payment processing or billing-related issues\n- **product_offerings**: Issues with product features or tariff offerings\n- **ev_driver_ux**: EV driver user experience issues\n- **security**: Security-related concerns or incidents\n- **reporting**: Reporting or analytics issues\n- **roaming**: Roaming-related issues\n- **other**: Issues not covered by other categories\n",
|
|
63837
|
-
"example": "network"
|
|
63838
|
-
},
|
|
63839
|
-
"severity": {
|
|
63840
|
-
"type": "string",
|
|
63841
|
-
"enum": [
|
|
63842
|
-
"severe",
|
|
63843
|
-
"significant",
|
|
63844
|
-
"moderate",
|
|
63845
|
-
"low"
|
|
63846
|
-
],
|
|
63847
|
-
"description": "Issue severity level:\n- **severe**: Critical impact requiring immediate attention\n- **significant**: Major impact affecting important functionality\n- **moderate**: Moderate impact with workaround available\n- **low**: Minor impact with minimal effect on operations\n",
|
|
63848
|
-
"example": "significant"
|
|
63849
|
-
},
|
|
63850
|
-
"priority": {
|
|
63851
|
-
"type": "string",
|
|
63852
|
-
"enum": [
|
|
63853
|
-
"highest",
|
|
63854
|
-
"high",
|
|
63855
|
-
"medium",
|
|
63856
|
-
"low"
|
|
63857
|
-
],
|
|
63858
|
-
"description": "Issue priority level:\n- **highest**: Must be addressed immediately\n- **high**: Should be addressed as soon as possible\n- **medium**: Should be addressed in normal workflow\n- **low**: Can be addressed when convenient\n",
|
|
63859
|
-
"example": "high"
|
|
63860
|
-
},
|
|
63861
|
-
"externalId": {
|
|
63862
|
-
"type": "string",
|
|
63863
|
-
"description": "External system identifier (UUID format recommended)",
|
|
63864
|
-
"maxLength": 255
|
|
63865
|
-
},
|
|
63866
|
-
"assigneeAdminId": {
|
|
63867
|
-
"type": "integer",
|
|
63868
|
-
"description": "ID of the admin user assigned to this issue"
|
|
63941
|
+
"format": "date-time",
|
|
63942
|
+
"description": "The moment the attempt was made."
|
|
63869
63943
|
},
|
|
63870
|
-
"
|
|
63871
|
-
"type": "
|
|
63872
|
-
"description": "
|
|
63873
|
-
"readOnly": true
|
|
63944
|
+
"isSuccessful": {
|
|
63945
|
+
"type": "boolean",
|
|
63946
|
+
"description": "Whether the attempt succeeded."
|
|
63874
63947
|
},
|
|
63875
|
-
"
|
|
63876
|
-
"type": "
|
|
63877
|
-
"description": "
|
|
63878
|
-
"
|
|
63879
|
-
"
|
|
63880
|
-
|
|
63881
|
-
"
|
|
63882
|
-
"
|
|
63883
|
-
"
|
|
63884
|
-
"
|
|
63885
|
-
|
|
63886
|
-
|
|
63887
|
-
"
|
|
63888
|
-
"
|
|
63889
|
-
|
|
63890
|
-
"description": "Type of resource associated with an issue.\n- **charge-point**: Charge point equipment\n- **location**: Charging location\n- **evse**: Electric Vehicle Supply Equipment (individual charging outlet)\n- **session**: Charging session\n- **integration**: Integration setting (e.g., third-party service configuration)\n- **roaming-cdr**: Roaming charge detail record\n- **roaming-connection**: Roaming connection\n\nNote: Additional types (user) may appear in responses for issues created by automated systems.\n",
|
|
63891
|
-
"example": "charge-point"
|
|
63948
|
+
"responseFields": {
|
|
63949
|
+
"type": "array",
|
|
63950
|
+
"description": "Values the integration publishes for this attempt. Which values appear, their names and their order are integration-defined and not fixed; treat the list as a set to match on rather than a fixed positional structure. Empty when the attempt has none.",
|
|
63951
|
+
"items": {
|
|
63952
|
+
"type": "object",
|
|
63953
|
+
"properties": {
|
|
63954
|
+
"key": {
|
|
63955
|
+
"type": "string",
|
|
63956
|
+
"description": "Name of the returned value, as reported by the integration. The set of names is provider-defined and not fixed.",
|
|
63957
|
+
"example": "KSeF number"
|
|
63958
|
+
},
|
|
63959
|
+
"value": {
|
|
63960
|
+
"type": "string",
|
|
63961
|
+
"description": "The returned value."
|
|
63962
|
+
}
|
|
63892
63963
|
},
|
|
63893
|
-
"
|
|
63894
|
-
"
|
|
63895
|
-
"
|
|
63896
|
-
|
|
63897
|
-
}
|
|
63898
|
-
"required": [
|
|
63899
|
-
"resourceType",
|
|
63900
|
-
"id"
|
|
63901
|
-
]
|
|
63902
|
-
},
|
|
63903
|
-
"createdAt": {
|
|
63904
|
-
"type": "string",
|
|
63905
|
-
"format": "date-time",
|
|
63906
|
-
"readOnly": true
|
|
63964
|
+
"required": [
|
|
63965
|
+
"key",
|
|
63966
|
+
"value"
|
|
63967
|
+
]
|
|
63968
|
+
}
|
|
63907
63969
|
},
|
|
63908
|
-
"
|
|
63970
|
+
"errorMessage": {
|
|
63909
63971
|
"type": "string",
|
|
63910
|
-
"
|
|
63911
|
-
"readOnly": true
|
|
63972
|
+
"description": "Why the attempt did not succeed. Present only for a failed attempt that carries a message."
|
|
63912
63973
|
}
|
|
63913
63974
|
},
|
|
63914
63975
|
"required": [
|
|
63915
63976
|
"id",
|
|
63916
|
-
"
|
|
63917
|
-
"
|
|
63918
|
-
"
|
|
63919
|
-
|
|
63920
|
-
|
|
63921
|
-
|
|
63922
|
-
|
|
63923
|
-
|
|
63924
|
-
|
|
63977
|
+
"attemptedAt",
|
|
63978
|
+
"isSuccessful",
|
|
63979
|
+
"responseFields"
|
|
63980
|
+
]
|
|
63981
|
+
}
|
|
63982
|
+
},
|
|
63983
|
+
"links": {
|
|
63984
|
+
"type": "object",
|
|
63985
|
+
"properties": {
|
|
63986
|
+
"first": {
|
|
63987
|
+
"type": "string",
|
|
63988
|
+
"description": "The URL to fetch the first page",
|
|
63989
|
+
"nullable": true
|
|
63990
|
+
},
|
|
63991
|
+
"last": {
|
|
63992
|
+
"type": "string",
|
|
63993
|
+
"description": "The URL to fetch the last page",
|
|
63994
|
+
"nullable": true
|
|
63995
|
+
},
|
|
63996
|
+
"prev": {
|
|
63997
|
+
"type": "string",
|
|
63998
|
+
"description": "The URL to fetch the previous page",
|
|
63999
|
+
"nullable": true
|
|
64000
|
+
},
|
|
64001
|
+
"next": {
|
|
64002
|
+
"type": "string",
|
|
64003
|
+
"description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
|
|
64004
|
+
"nullable": true
|
|
64005
|
+
}
|
|
64006
|
+
}
|
|
64007
|
+
},
|
|
64008
|
+
"meta": {
|
|
64009
|
+
"type": "object",
|
|
64010
|
+
"properties": {
|
|
64011
|
+
"path": {
|
|
64012
|
+
"type": "string",
|
|
64013
|
+
"description": "The base route of the endpoint (unpaginated)"
|
|
64014
|
+
},
|
|
64015
|
+
"per_page": {
|
|
64016
|
+
"type": "integer",
|
|
64017
|
+
"description": "The max number of items in each page"
|
|
64018
|
+
},
|
|
64019
|
+
"next_cursor": {
|
|
64020
|
+
"type": "string",
|
|
64021
|
+
"description": "The cursor to fetch the next page. Do not use this directly. It will be populated by using the previous response's links.next.",
|
|
64022
|
+
"nullable": true
|
|
64023
|
+
},
|
|
64024
|
+
"prev_cursor": {
|
|
64025
|
+
"type": "string",
|
|
64026
|
+
"description": "The cursor to fetch the previous page. Do not use this directly. It will be populated by using the previous response's links.prev.",
|
|
64027
|
+
"nullable": true
|
|
64028
|
+
}
|
|
64029
|
+
}
|
|
64030
|
+
}
|
|
64031
|
+
},
|
|
64032
|
+
"required": [
|
|
64033
|
+
"data",
|
|
64034
|
+
"links",
|
|
64035
|
+
"meta"
|
|
64036
|
+
]
|
|
64037
|
+
}
|
|
64038
|
+
},
|
|
64039
|
+
"401": {
|
|
64040
|
+
"schema": {
|
|
64041
|
+
"type": "object",
|
|
64042
|
+
"properties": {
|
|
64043
|
+
"message": {
|
|
64044
|
+
"type": "string"
|
|
64045
|
+
}
|
|
64046
|
+
}
|
|
64047
|
+
}
|
|
64048
|
+
},
|
|
64049
|
+
"403": {
|
|
64050
|
+
"schema": {
|
|
64051
|
+
"type": "object",
|
|
64052
|
+
"properties": {
|
|
64053
|
+
"message": {
|
|
64054
|
+
"type": "string",
|
|
64055
|
+
"default": "This action is unauthorized."
|
|
64056
|
+
}
|
|
64057
|
+
}
|
|
64058
|
+
}
|
|
64059
|
+
},
|
|
64060
|
+
"404": {
|
|
64061
|
+
"schema": {
|
|
64062
|
+
"type": "object",
|
|
64063
|
+
"properties": {
|
|
64064
|
+
"message": {
|
|
64065
|
+
"type": "string"
|
|
64066
|
+
}
|
|
64067
|
+
}
|
|
64068
|
+
}
|
|
64069
|
+
},
|
|
64070
|
+
"422": {
|
|
64071
|
+
"schema": {
|
|
64072
|
+
"type": "object",
|
|
64073
|
+
"required": [
|
|
64074
|
+
"message"
|
|
64075
|
+
],
|
|
64076
|
+
"properties": {
|
|
64077
|
+
"message": {
|
|
64078
|
+
"type": "string"
|
|
64079
|
+
},
|
|
64080
|
+
"errors": {
|
|
64081
|
+
"type": "object",
|
|
64082
|
+
"additionalProperties": {
|
|
64083
|
+
"type": "array",
|
|
64084
|
+
"items": {
|
|
64085
|
+
"type": "string"
|
|
64086
|
+
}
|
|
64087
|
+
}
|
|
64088
|
+
}
|
|
64089
|
+
}
|
|
64090
|
+
}
|
|
64091
|
+
},
|
|
64092
|
+
"429": {
|
|
64093
|
+
"schema": {
|
|
64094
|
+
"type": "object",
|
|
64095
|
+
"properties": {
|
|
64096
|
+
"message": {
|
|
64097
|
+
"type": "string"
|
|
64098
|
+
}
|
|
64099
|
+
}
|
|
64100
|
+
}
|
|
64101
|
+
}
|
|
64102
|
+
},
|
|
64103
|
+
"invoiceFiscalizationDocumentDownload": {
|
|
64104
|
+
"403": {
|
|
64105
|
+
"schema": {
|
|
64106
|
+
"type": "object",
|
|
64107
|
+
"required": [
|
|
64108
|
+
"message"
|
|
64109
|
+
],
|
|
64110
|
+
"properties": {
|
|
64111
|
+
"message": {
|
|
64112
|
+
"type": "string"
|
|
64113
|
+
}
|
|
64114
|
+
}
|
|
64115
|
+
}
|
|
64116
|
+
},
|
|
64117
|
+
"404": {
|
|
64118
|
+
"schema": {
|
|
64119
|
+
"type": "object",
|
|
64120
|
+
"required": [
|
|
64121
|
+
"message"
|
|
64122
|
+
],
|
|
64123
|
+
"properties": {
|
|
64124
|
+
"message": {
|
|
64125
|
+
"type": "string"
|
|
64126
|
+
}
|
|
64127
|
+
}
|
|
64128
|
+
}
|
|
64129
|
+
},
|
|
64130
|
+
"410": {
|
|
64131
|
+
"schema": {
|
|
64132
|
+
"type": "object",
|
|
64133
|
+
"required": [
|
|
64134
|
+
"message"
|
|
64135
|
+
],
|
|
64136
|
+
"properties": {
|
|
64137
|
+
"message": {
|
|
64138
|
+
"type": "string"
|
|
64139
|
+
}
|
|
64140
|
+
}
|
|
64141
|
+
}
|
|
64142
|
+
},
|
|
64143
|
+
"424": {
|
|
64144
|
+
"schema": {
|
|
64145
|
+
"type": "object",
|
|
64146
|
+
"required": [
|
|
64147
|
+
"message"
|
|
64148
|
+
],
|
|
64149
|
+
"properties": {
|
|
64150
|
+
"message": {
|
|
64151
|
+
"type": "string",
|
|
64152
|
+
"example": "The fiscal authority could not provide the requested fiscal document format: document not ready"
|
|
64153
|
+
}
|
|
64154
|
+
}
|
|
64155
|
+
}
|
|
64156
|
+
},
|
|
64157
|
+
"429": {
|
|
64158
|
+
"schema": {
|
|
64159
|
+
"type": "object",
|
|
64160
|
+
"properties": {
|
|
64161
|
+
"message": {
|
|
64162
|
+
"type": "string"
|
|
64163
|
+
}
|
|
64164
|
+
}
|
|
64165
|
+
}
|
|
64166
|
+
}
|
|
64167
|
+
},
|
|
64168
|
+
"issuesListing": {
|
|
64169
|
+
"200": {
|
|
64170
|
+
"schema": {
|
|
64171
|
+
"type": "object",
|
|
64172
|
+
"properties": {
|
|
64173
|
+
"data": {
|
|
64174
|
+
"type": "array",
|
|
64175
|
+
"items": {
|
|
64176
|
+
"type": "object",
|
|
64177
|
+
"description": "Issue resource with full details",
|
|
64178
|
+
"properties": {
|
|
64179
|
+
"id": {
|
|
64180
|
+
"type": "integer",
|
|
64181
|
+
"description": "System-generated unique identifier",
|
|
64182
|
+
"readOnly": true
|
|
64183
|
+
},
|
|
64184
|
+
"operatorId": {
|
|
64185
|
+
"type": "integer",
|
|
64186
|
+
"nullable": true,
|
|
64187
|
+
"description": "The ID of the operator this resource belongs to",
|
|
64188
|
+
"example": 1
|
|
64189
|
+
},
|
|
64190
|
+
"title": {
|
|
64191
|
+
"type": "string",
|
|
64192
|
+
"description": "Issue title",
|
|
64193
|
+
"maxLength": 255
|
|
64194
|
+
},
|
|
64195
|
+
"description": {
|
|
64196
|
+
"type": "string",
|
|
64197
|
+
"description": "Detailed issue description (HTML content)"
|
|
64198
|
+
},
|
|
64199
|
+
"resolutionDetails": {
|
|
64200
|
+
"type": "string",
|
|
64201
|
+
"description": "Details about how the issue was resolved or why it was closed. Only present when status is resolved, wont_fix, or non_issue."
|
|
64202
|
+
},
|
|
64203
|
+
"status": {
|
|
64204
|
+
"type": "string",
|
|
64205
|
+
"enum": [
|
|
64206
|
+
"auto_recovery_in_progress",
|
|
64207
|
+
"information_collection_in_progress",
|
|
64208
|
+
"new",
|
|
64209
|
+
"investigating",
|
|
64210
|
+
"resolution_in_progress",
|
|
64211
|
+
"resolved",
|
|
64212
|
+
"wont_fix",
|
|
64213
|
+
"non_issue"
|
|
64214
|
+
],
|
|
64215
|
+
"description": "Issue status:\n- **auto_recovery_in_progress**: Issue is in automatic recovery process (preparation state)\n- **information_collection_in_progress**: System is collecting diagnostic information (preparation state)\n- **new**: Issue has been reported and not yet investigated (open state)\n- **investigating**: Issue is currently being investigated (open state)\n- **resolution_in_progress**: Resolution actions are being applied (open state)\n- **resolved**: Issue has been resolved successfully (closed state)\n- **wont_fix**: Issue will not be fixed (closed state)\n- **non_issue**: Reported issue determined to not be an actual issue (closed state)\n",
|
|
64216
|
+
"example": "investigating"
|
|
64217
|
+
},
|
|
64218
|
+
"workflowState": {
|
|
64219
|
+
"readOnly": true,
|
|
64220
|
+
"description": "Issue workflow state (derived from status):\n- **preparation**: System is performing automatic actions before manual intervention (auto-resolution statuses)\n- **open**: Issue requires attention or is being worked on (new, investigating, resolutionInProgress)\n- **closed**: Issue is no longer active (resolved, wontFix, nonIssue)\n",
|
|
64221
|
+
"type": "string",
|
|
64222
|
+
"enum": [
|
|
64223
|
+
"preparation",
|
|
64224
|
+
"open",
|
|
64225
|
+
"closed"
|
|
64226
|
+
],
|
|
64227
|
+
"example": "open"
|
|
64228
|
+
},
|
|
64229
|
+
"category": {
|
|
64230
|
+
"type": "string",
|
|
64231
|
+
"enum": [
|
|
64232
|
+
"network",
|
|
64233
|
+
"payments_billing",
|
|
64234
|
+
"product_offerings",
|
|
64235
|
+
"ev_driver_ux",
|
|
64236
|
+
"security",
|
|
64237
|
+
"reporting",
|
|
64238
|
+
"roaming",
|
|
64239
|
+
"other"
|
|
64240
|
+
],
|
|
64241
|
+
"description": "Issue category:\n- **network**: Network connectivity or communication issues\n- **payments_billing**: Payment processing or billing-related issues\n- **product_offerings**: Issues with product features or tariff offerings\n- **ev_driver_ux**: EV driver user experience issues\n- **security**: Security-related concerns or incidents\n- **reporting**: Reporting or analytics issues\n- **roaming**: Roaming-related issues\n- **other**: Issues not covered by other categories\n",
|
|
64242
|
+
"example": "network"
|
|
64243
|
+
},
|
|
64244
|
+
"severity": {
|
|
64245
|
+
"type": "string",
|
|
64246
|
+
"enum": [
|
|
64247
|
+
"severe",
|
|
64248
|
+
"significant",
|
|
64249
|
+
"moderate",
|
|
64250
|
+
"low"
|
|
64251
|
+
],
|
|
64252
|
+
"description": "Issue severity level:\n- **severe**: Critical impact requiring immediate attention\n- **significant**: Major impact affecting important functionality\n- **moderate**: Moderate impact with workaround available\n- **low**: Minor impact with minimal effect on operations\n",
|
|
64253
|
+
"example": "significant"
|
|
64254
|
+
},
|
|
64255
|
+
"priority": {
|
|
64256
|
+
"type": "string",
|
|
64257
|
+
"enum": [
|
|
64258
|
+
"highest",
|
|
64259
|
+
"high",
|
|
64260
|
+
"medium",
|
|
64261
|
+
"low"
|
|
64262
|
+
],
|
|
64263
|
+
"description": "Issue priority level:\n- **highest**: Must be addressed immediately\n- **high**: Should be addressed as soon as possible\n- **medium**: Should be addressed in normal workflow\n- **low**: Can be addressed when convenient\n",
|
|
64264
|
+
"example": "high"
|
|
64265
|
+
},
|
|
64266
|
+
"externalId": {
|
|
64267
|
+
"type": "string",
|
|
64268
|
+
"description": "External system identifier (UUID format recommended)",
|
|
64269
|
+
"maxLength": 255
|
|
64270
|
+
},
|
|
64271
|
+
"assigneeAdminId": {
|
|
64272
|
+
"type": "integer",
|
|
64273
|
+
"description": "ID of the admin user assigned to this issue"
|
|
64274
|
+
},
|
|
64275
|
+
"partnerId": {
|
|
64276
|
+
"type": "integer",
|
|
64277
|
+
"description": "ID of the partner that owns this issue. Present only for partner-scoped issues.",
|
|
64278
|
+
"readOnly": true
|
|
64279
|
+
},
|
|
64280
|
+
"keyResource": {
|
|
64281
|
+
"type": "object",
|
|
64282
|
+
"description": "Reference to a related resource (charge point, location, or EVSE)",
|
|
64283
|
+
"properties": {
|
|
64284
|
+
"resourceType": {
|
|
64285
|
+
"type": "string",
|
|
64286
|
+
"enum": [
|
|
64287
|
+
"charge-point",
|
|
64288
|
+
"location",
|
|
64289
|
+
"evse",
|
|
64290
|
+
"session",
|
|
64291
|
+
"integration",
|
|
64292
|
+
"roaming-cdr",
|
|
64293
|
+
"roaming-connection"
|
|
64294
|
+
],
|
|
64295
|
+
"description": "Type of resource associated with an issue.\n- **charge-point**: Charge point equipment\n- **location**: Charging location\n- **evse**: Electric Vehicle Supply Equipment (individual charging outlet)\n- **session**: Charging session\n- **integration**: Integration setting (e.g., third-party service configuration)\n- **roaming-cdr**: Roaming charge detail record\n- **roaming-connection**: Roaming connection\n\nNote: Additional types (user) may appear in responses for issues created by automated systems.\n",
|
|
64296
|
+
"example": "charge-point"
|
|
64297
|
+
},
|
|
64298
|
+
"id": {
|
|
64299
|
+
"type": "integer",
|
|
64300
|
+
"description": "ID of the referenced resource"
|
|
64301
|
+
}
|
|
64302
|
+
},
|
|
64303
|
+
"required": [
|
|
64304
|
+
"resourceType",
|
|
64305
|
+
"id"
|
|
64306
|
+
]
|
|
64307
|
+
},
|
|
64308
|
+
"createdAt": {
|
|
64309
|
+
"type": "string",
|
|
64310
|
+
"format": "date-time",
|
|
64311
|
+
"readOnly": true
|
|
64312
|
+
},
|
|
64313
|
+
"updatedAt": {
|
|
64314
|
+
"type": "string",
|
|
64315
|
+
"format": "date-time",
|
|
64316
|
+
"readOnly": true
|
|
64317
|
+
}
|
|
64318
|
+
},
|
|
64319
|
+
"required": [
|
|
64320
|
+
"id",
|
|
64321
|
+
"operatorId",
|
|
64322
|
+
"title",
|
|
64323
|
+
"status",
|
|
64324
|
+
"workflowState",
|
|
64325
|
+
"category",
|
|
64326
|
+
"severity",
|
|
64327
|
+
"priority",
|
|
64328
|
+
"createdAt",
|
|
64329
|
+
"updatedAt"
|
|
63925
64330
|
]
|
|
63926
64331
|
}
|
|
63927
64332
|
},
|
|
@@ -124075,8 +124480,8 @@
|
|
|
124075
124480
|
"description": "Whether incremental pre-authorizations are active for this session.\n`true` when all preconditions are met: feature flag enabled, incremental pre-authorizations enabled in settings, billing strategy supports pre-authorization, and the session has an active pre-authorization with a PSP that supports incremental authorization.\n`false` in all other cases, including sessions without pre-authorization and completed sessions.\n"
|
|
124076
124481
|
},
|
|
124077
124482
|
"customFields": {
|
|
124483
|
+
"description": "Custom field values keyed by their administrator-defined identifiers. Values use the wire representation configured for each field: Boolean is a JSON boolean; Text and Long text are strings; Email is an email-formatted string; URL is an HTTP or HTTPS URL string; Number is a canonical base-10 decimal string from `-99999999999999.999999` through `99999999999999.999999` with up to six fractional digits and no insignificant trailing fractional zeroes; Date is an ISO 8601 `YYYY-MM-DD` string; Date-time is an ISO 8601 timestamp with a UTC offset; and JSON may be any JSON-serializable value. Applicable fields without a value are returned as `null`; fields that are not applicable to the session are omitted. The `customFields` property itself is omitted when no fields apply.\n",
|
|
124078
124484
|
"type": "object",
|
|
124079
|
-
"description": "Custom field values keyed by their administrator-defined identifiers. Values use the wire representation configured for each field: Boolean is a JSON boolean; Text and Long text are strings; Email is an email-formatted string; URL is an HTTP or HTTPS URL string; Number is a JSON number; Date is an ISO 8601 `YYYY-MM-DD` string; Date-time is an ISO 8601 timestamp with a UTC offset; and JSON may be any JSON-serializable value. Applicable fields without a value are returned as `null`; fields that are not applicable to the session are omitted. The `customFields` property itself is omitted when no fields apply.\n",
|
|
124080
124485
|
"additionalProperties": true
|
|
124081
124486
|
}
|
|
124082
124487
|
},
|
|
@@ -125342,8 +125747,8 @@
|
|
|
125342
125747
|
"description": "Whether incremental pre-authorizations are active for this session.\n`true` when all preconditions are met: feature flag enabled, incremental pre-authorizations enabled in settings, billing strategy supports pre-authorization, and the session has an active pre-authorization with a PSP that supports incremental authorization.\n`false` in all other cases, including sessions without pre-authorization and completed sessions.\n"
|
|
125343
125748
|
},
|
|
125344
125749
|
"customFields": {
|
|
125750
|
+
"description": "Custom field values keyed by their administrator-defined identifiers. Values use the wire representation configured for each field: Boolean is a JSON boolean; Text and Long text are strings; Email is an email-formatted string; URL is an HTTP or HTTPS URL string; Number is a canonical base-10 decimal string from `-99999999999999.999999` through `99999999999999.999999` with up to six fractional digits and no insignificant trailing fractional zeroes; Date is an ISO 8601 `YYYY-MM-DD` string; Date-time is an ISO 8601 timestamp with a UTC offset; and JSON may be any JSON-serializable value. Applicable fields without a value are returned as `null`; fields that are not applicable to the session are omitted. The `customFields` property itself is omitted when no fields apply.\n",
|
|
125345
125751
|
"type": "object",
|
|
125346
|
-
"description": "Custom field values keyed by their administrator-defined identifiers. Values use the wire representation configured for each field: Boolean is a JSON boolean; Text and Long text are strings; Email is an email-formatted string; URL is an HTTP or HTTPS URL string; Number is a JSON number; Date is an ISO 8601 `YYYY-MM-DD` string; Date-time is an ISO 8601 timestamp with a UTC offset; and JSON may be any JSON-serializable value. Applicable fields without a value are returned as `null`; fields that are not applicable to the session are omitted. The `customFields` property itself is omitted when no fields apply.\n",
|
|
125347
125752
|
"additionalProperties": true
|
|
125348
125753
|
},
|
|
125349
125754
|
"durationBreakdown": {
|
|
@@ -125642,6 +126047,1168 @@
|
|
|
125642
126047
|
}
|
|
125643
126048
|
}
|
|
125644
126049
|
},
|
|
126050
|
+
"sessionUpdate": {
|
|
126051
|
+
"200": {
|
|
126052
|
+
"schema": {
|
|
126053
|
+
"type": "object",
|
|
126054
|
+
"properties": {
|
|
126055
|
+
"data": {
|
|
126056
|
+
"type": "object",
|
|
126057
|
+
"description": "Charging session",
|
|
126058
|
+
"properties": {
|
|
126059
|
+
"id": {
|
|
126060
|
+
"type": "string"
|
|
126061
|
+
},
|
|
126062
|
+
"operatorId": {
|
|
126063
|
+
"type": "integer",
|
|
126064
|
+
"description": "The ID of the operator this resource belongs to",
|
|
126065
|
+
"example": 1
|
|
126066
|
+
},
|
|
126067
|
+
"chargePointId": {
|
|
126068
|
+
"type": "integer"
|
|
126069
|
+
},
|
|
126070
|
+
"evseId": {
|
|
126071
|
+
"type": "integer"
|
|
126072
|
+
},
|
|
126073
|
+
"connectorId": {
|
|
126074
|
+
"type": "integer",
|
|
126075
|
+
"nullable": true
|
|
126076
|
+
},
|
|
126077
|
+
"status": {
|
|
126078
|
+
"type": "string",
|
|
126079
|
+
"enum": [
|
|
126080
|
+
"unknown",
|
|
126081
|
+
"pending",
|
|
126082
|
+
"active",
|
|
126083
|
+
"finished",
|
|
126084
|
+
"failed",
|
|
126085
|
+
"expired"
|
|
126086
|
+
],
|
|
126087
|
+
"description": "Charging session status:\n- **unknown**: Session status could not be determined\n- **pending**: Session is pending and has not started yet\n- **active**: Session is currently in progress\n- **finished**: Session has completed successfully\n- **failed**: Session has failed\n- **expired**: Session has expired\n",
|
|
126088
|
+
"example": "finished"
|
|
126089
|
+
},
|
|
126090
|
+
"reason": {
|
|
126091
|
+
"type": "string",
|
|
126092
|
+
"enum": [
|
|
126093
|
+
"working_hours_exceeded",
|
|
126094
|
+
"timeout",
|
|
126095
|
+
"authorization_amount_reached",
|
|
126096
|
+
"new_start_transaction_received",
|
|
126097
|
+
"force_stop",
|
|
126098
|
+
"standard_stop",
|
|
126099
|
+
"energy_exceeded",
|
|
126100
|
+
"schedule_completed",
|
|
126101
|
+
"pre_authorization_failed",
|
|
126102
|
+
"system_force_stop",
|
|
126103
|
+
"time_limit",
|
|
126104
|
+
"balance_exceeded",
|
|
126105
|
+
"deauthorized",
|
|
126106
|
+
"emergencystop",
|
|
126107
|
+
"energylimitreached",
|
|
126108
|
+
"evdisconnected",
|
|
126109
|
+
"groundfault",
|
|
126110
|
+
"immediatereset",
|
|
126111
|
+
"hardreset",
|
|
126112
|
+
"local",
|
|
126113
|
+
"localoutofcredit",
|
|
126114
|
+
"masterpass",
|
|
126115
|
+
"other",
|
|
126116
|
+
"plug_and_charge",
|
|
126117
|
+
"overcurrentfault",
|
|
126118
|
+
"powerloss",
|
|
126119
|
+
"powerquality",
|
|
126120
|
+
"reboot",
|
|
126121
|
+
"remote",
|
|
126122
|
+
"soclimitreached",
|
|
126123
|
+
"stoppedbyev",
|
|
126124
|
+
"timeoutlimitreached",
|
|
126125
|
+
"softreset",
|
|
126126
|
+
"unlockcommand",
|
|
126127
|
+
"no_ev_parked",
|
|
126128
|
+
"no_ev_connected",
|
|
126129
|
+
"charge_point_timeout",
|
|
126130
|
+
"charging_on_evse_not_allowed",
|
|
126131
|
+
"remote_start_failed",
|
|
126132
|
+
"no_user_for_agile_streets",
|
|
126133
|
+
"rejected",
|
|
126134
|
+
"canceled_reservation",
|
|
126135
|
+
"evse_occupied",
|
|
126136
|
+
"evse_inoperative",
|
|
126137
|
+
"failed",
|
|
126138
|
+
"not_supported",
|
|
126139
|
+
"unknown_reservation",
|
|
126140
|
+
"ev_not_connected_to_evse",
|
|
126141
|
+
"authorization_failed",
|
|
126142
|
+
"unknown_session"
|
|
126143
|
+
],
|
|
126144
|
+
"description": "The reason why the session expired or has been stopped."
|
|
126145
|
+
},
|
|
126146
|
+
"userId": {
|
|
126147
|
+
"type": "integer",
|
|
126148
|
+
"nullable": true,
|
|
126149
|
+
"description": "The id of the user that started the session"
|
|
126150
|
+
},
|
|
126151
|
+
"vehicleId": {
|
|
126152
|
+
"type": "integer",
|
|
126153
|
+
"description": "ID of the vehicle associated with the session."
|
|
126154
|
+
},
|
|
126155
|
+
"bookingId": {
|
|
126156
|
+
"type": "integer",
|
|
126157
|
+
"description": "The ID of the linked booking (if any)"
|
|
126158
|
+
},
|
|
126159
|
+
"startedAt": {
|
|
126160
|
+
"type": "string",
|
|
126161
|
+
"format": "date-time"
|
|
126162
|
+
},
|
|
126163
|
+
"startedOffline": {
|
|
126164
|
+
"type": "boolean",
|
|
126165
|
+
"description": "Indicates whether the session was started while the charge point was offline."
|
|
126166
|
+
},
|
|
126167
|
+
"stoppedAt": {
|
|
126168
|
+
"type": "string",
|
|
126169
|
+
"format": "date-time",
|
|
126170
|
+
"nullable": true
|
|
126171
|
+
},
|
|
126172
|
+
"energy": {
|
|
126173
|
+
"deprecated": true,
|
|
126174
|
+
"type": "number",
|
|
126175
|
+
"description": "Delivered energy in Wh"
|
|
126176
|
+
},
|
|
126177
|
+
"powerKw": {
|
|
126178
|
+
"deprecated": true,
|
|
126179
|
+
"type": "number",
|
|
126180
|
+
"description": "This field representing the current charging speed in kilowatts is deprecated. Use the `power.latest` property instead for charging power information."
|
|
126181
|
+
},
|
|
126182
|
+
"socPercent": {
|
|
126183
|
+
"type": "number",
|
|
126184
|
+
"description": "State of charge (in %). Optional."
|
|
126185
|
+
},
|
|
126186
|
+
"amount": {
|
|
126187
|
+
"type": "number",
|
|
126188
|
+
"format": "decimal",
|
|
126189
|
+
"nullable": true,
|
|
126190
|
+
"deprecated": true
|
|
126191
|
+
},
|
|
126192
|
+
"totalAmount": {
|
|
126193
|
+
"type": "object",
|
|
126194
|
+
"nullable": true,
|
|
126195
|
+
"properties": {
|
|
126196
|
+
"withTax": {
|
|
126197
|
+
"type": "number"
|
|
126198
|
+
},
|
|
126199
|
+
"withoutTax": {
|
|
126200
|
+
"type": "number"
|
|
126201
|
+
}
|
|
126202
|
+
},
|
|
126203
|
+
"required": [
|
|
126204
|
+
"withTax"
|
|
126205
|
+
]
|
|
126206
|
+
},
|
|
126207
|
+
"corporateBilling": {
|
|
126208
|
+
"type": "object",
|
|
126209
|
+
"description": "Corporate billing breakdown for the session. This object and the related corporate-billing fields are part of the experimental corporate-billing feature surface. While that feature is experimental, these fields may change in place without a version bump. Consumers should treat these fields as evaluation-only unless coordinated with their account manager.\n",
|
|
126210
|
+
"properties": {
|
|
126211
|
+
"policySnapshotId": {
|
|
126212
|
+
"type": "integer",
|
|
126213
|
+
"description": "Corporate billing policy snapshot used for the session."
|
|
126214
|
+
},
|
|
126215
|
+
"chargerType": {
|
|
126216
|
+
"type": "string",
|
|
126217
|
+
"enum": [
|
|
126218
|
+
"ac",
|
|
126219
|
+
"dc"
|
|
126220
|
+
],
|
|
126221
|
+
"description": "Type of current available on the EVSE:\n- **ac**: Alternating Current (AC) charging\n- **dc**: Direct Current (DC) fast charging\n"
|
|
126222
|
+
},
|
|
126223
|
+
"chargerTypeCoverageType": {
|
|
126224
|
+
"type": "string",
|
|
126225
|
+
"enum": [
|
|
126226
|
+
"full_coverage",
|
|
126227
|
+
"limited_coverage",
|
|
126228
|
+
"not_covered"
|
|
126229
|
+
],
|
|
126230
|
+
"description": "Charger type coverage type:\n- **full_coverage**: The policy covers eligible costs for this charger type without tariff thresholds\n- **limited_coverage**: The policy covers eligible costs for this charger type only within configured limits\n- **not_covered**: The policy does not cover sessions on this charger type\n"
|
|
126231
|
+
},
|
|
126232
|
+
"corporateAmount": {
|
|
126233
|
+
"description": "Tax-aware amount billed to the corporate coverage order, with gross and net totals from the order.",
|
|
126234
|
+
"type": "object",
|
|
126235
|
+
"properties": {
|
|
126236
|
+
"withTax": {
|
|
126237
|
+
"type": "number"
|
|
126238
|
+
},
|
|
126239
|
+
"withoutTax": {
|
|
126240
|
+
"type": "number"
|
|
126241
|
+
}
|
|
126242
|
+
},
|
|
126243
|
+
"required": [
|
|
126244
|
+
"withTax"
|
|
126245
|
+
]
|
|
126246
|
+
},
|
|
126247
|
+
"driverAmount": {
|
|
126248
|
+
"description": "Tax-aware amount billed to the EV driver's excess order, with gross and net totals from the order.",
|
|
126249
|
+
"type": "object",
|
|
126250
|
+
"properties": {
|
|
126251
|
+
"withTax": {
|
|
126252
|
+
"type": "number"
|
|
126253
|
+
},
|
|
126254
|
+
"withoutTax": {
|
|
126255
|
+
"type": "number"
|
|
126256
|
+
}
|
|
126257
|
+
},
|
|
126258
|
+
"required": [
|
|
126259
|
+
"withTax"
|
|
126260
|
+
]
|
|
126261
|
+
},
|
|
126262
|
+
"blendedCostPerKwh": {
|
|
126263
|
+
"type": "number",
|
|
126264
|
+
"format": "decimal",
|
|
126265
|
+
"description": "Session's computed blended cost per kWh."
|
|
126266
|
+
},
|
|
126267
|
+
"isOverallCostCapApplied": {
|
|
126268
|
+
"type": "boolean",
|
|
126269
|
+
"description": "Whether the policy's overall cost-per-kWh cap reduced coverage."
|
|
126270
|
+
},
|
|
126271
|
+
"restrictionCause": {
|
|
126272
|
+
"description": "Corporate billing restriction dimension that withheld coverage for the session:\n- **partner**: A partner restriction prevented corporate billing from covering the session\n- **country**: A country restriction prevented corporate billing from covering the session\n- **location**: A location restriction prevented corporate billing from covering the session\n- **location_tag**: A location tag restriction prevented corporate billing from covering the session\n- **roaming**: A roaming restriction prevented corporate billing from covering the session\n",
|
|
126273
|
+
"type": "string",
|
|
126274
|
+
"enum": [
|
|
126275
|
+
"partner",
|
|
126276
|
+
"country",
|
|
126277
|
+
"location",
|
|
126278
|
+
"location_tag",
|
|
126279
|
+
"roaming"
|
|
126280
|
+
]
|
|
126281
|
+
},
|
|
126282
|
+
"breakdown": {
|
|
126283
|
+
"type": "array",
|
|
126284
|
+
"description": "Per-component tax-aware amounts for public corporate billing component types only: energy, idle_time, connection, and charging_time. The corporateAmount and driverAmount fields are gross and net totals sourced from matching corporate coverage and EV driver excess order items. Other persisted fee types, such as min_price, are not included, so this breakdown can be partial and may not sum to the order-level corporateAmount and driverAmount totals.\n",
|
|
126285
|
+
"items": {
|
|
126286
|
+
"type": "object",
|
|
126287
|
+
"description": "Per-component tax-aware corporate billing amounts for one supported public corporate billing component type.",
|
|
126288
|
+
"properties": {
|
|
126289
|
+
"componentType": {
|
|
126290
|
+
"type": "string",
|
|
126291
|
+
"enum": [
|
|
126292
|
+
"energy",
|
|
126293
|
+
"idle_time",
|
|
126294
|
+
"connection",
|
|
126295
|
+
"charging_time"
|
|
126296
|
+
],
|
|
126297
|
+
"description": "Corporate billing tariff component type:\n- **energy**: Energy charges based on consumed kWh\n- **idle_time**: Idle-time charges after charging has stopped or exceeded the configured idle threshold\n- **connection**: Connection charges for starting or maintaining the session connection\n- **charging_time**: Charging-time charges based on the active charging duration\n"
|
|
126298
|
+
},
|
|
126299
|
+
"corporateAmount": {
|
|
126300
|
+
"description": "Tax-aware component amount billed to the corporate coverage order, with gross and net totals from matching order items.",
|
|
126301
|
+
"type": "object",
|
|
126302
|
+
"properties": {
|
|
126303
|
+
"withTax": {
|
|
126304
|
+
"type": "number"
|
|
126305
|
+
},
|
|
126306
|
+
"withoutTax": {
|
|
126307
|
+
"type": "number"
|
|
126308
|
+
}
|
|
126309
|
+
},
|
|
126310
|
+
"required": [
|
|
126311
|
+
"withTax"
|
|
126312
|
+
]
|
|
126313
|
+
},
|
|
126314
|
+
"driverAmount": {
|
|
126315
|
+
"description": "Tax-aware component amount billed to the EV driver's excess order, with gross and net totals from matching order items.",
|
|
126316
|
+
"type": "object",
|
|
126317
|
+
"properties": {
|
|
126318
|
+
"withTax": {
|
|
126319
|
+
"type": "number"
|
|
126320
|
+
},
|
|
126321
|
+
"withoutTax": {
|
|
126322
|
+
"type": "number"
|
|
126323
|
+
}
|
|
126324
|
+
},
|
|
126325
|
+
"required": [
|
|
126326
|
+
"withTax"
|
|
126327
|
+
]
|
|
126328
|
+
}
|
|
126329
|
+
},
|
|
126330
|
+
"required": [
|
|
126331
|
+
"componentType",
|
|
126332
|
+
"corporateAmount",
|
|
126333
|
+
"driverAmount"
|
|
126334
|
+
]
|
|
126335
|
+
}
|
|
126336
|
+
}
|
|
126337
|
+
},
|
|
126338
|
+
"required": [
|
|
126339
|
+
"policySnapshotId"
|
|
126340
|
+
]
|
|
126341
|
+
},
|
|
126342
|
+
"discounts": {
|
|
126343
|
+
"type": "array",
|
|
126344
|
+
"description": "Per-type discount breakdown for the session, aggregated across all price-breakdown rows. Omitted when no discount data is available.",
|
|
126345
|
+
"items": {
|
|
126346
|
+
"type": "object",
|
|
126347
|
+
"properties": {
|
|
126348
|
+
"type": {
|
|
126349
|
+
"type": "string",
|
|
126350
|
+
"enum": [
|
|
126351
|
+
"subsidy",
|
|
126352
|
+
"corporate"
|
|
126353
|
+
],
|
|
126354
|
+
"description": "Type of an individual discount entry.\n- **subsidy**: energy-fee subsidy when the unit price exceeds a configured threshold.\n- **corporate**: percentage discount tied to a corporate billing arrangement.\n",
|
|
126355
|
+
"example": "subsidy"
|
|
126356
|
+
},
|
|
126357
|
+
"amount": {
|
|
126358
|
+
"type": "object",
|
|
126359
|
+
"properties": {
|
|
126360
|
+
"withTax": {
|
|
126361
|
+
"type": "number"
|
|
126362
|
+
},
|
|
126363
|
+
"withoutTax": {
|
|
126364
|
+
"type": "number"
|
|
126365
|
+
}
|
|
126366
|
+
},
|
|
126367
|
+
"required": [
|
|
126368
|
+
"withTax"
|
|
126369
|
+
]
|
|
126370
|
+
}
|
|
126371
|
+
},
|
|
126372
|
+
"required": [
|
|
126373
|
+
"type",
|
|
126374
|
+
"amount"
|
|
126375
|
+
]
|
|
126376
|
+
}
|
|
126377
|
+
},
|
|
126378
|
+
"tax": {
|
|
126379
|
+
"type": "object",
|
|
126380
|
+
"nullable": true,
|
|
126381
|
+
"deprecated": true,
|
|
126382
|
+
"properties": {
|
|
126383
|
+
"taxId": {
|
|
126384
|
+
"type": "integer"
|
|
126385
|
+
},
|
|
126386
|
+
"taxPercentage": {
|
|
126387
|
+
"type": "number",
|
|
126388
|
+
"format": "decimal"
|
|
126389
|
+
}
|
|
126390
|
+
}
|
|
126391
|
+
},
|
|
126392
|
+
"currency": {
|
|
126393
|
+
"type": "string",
|
|
126394
|
+
"minLength": 3,
|
|
126395
|
+
"maxLength": 3,
|
|
126396
|
+
"description": "The ISO 4217 3-letter code of the currency"
|
|
126397
|
+
},
|
|
126398
|
+
"paymentType": {
|
|
126399
|
+
"type": "string",
|
|
126400
|
+
"enum": [
|
|
126401
|
+
"tokenized",
|
|
126402
|
+
"subscription",
|
|
126403
|
+
"balance",
|
|
126404
|
+
"corporate",
|
|
126405
|
+
"terminal",
|
|
126406
|
+
"bank_transfer"
|
|
126407
|
+
]
|
|
126408
|
+
},
|
|
126409
|
+
"paymentMethodId": {
|
|
126410
|
+
"type": "string",
|
|
126411
|
+
"description": "The ID of the payment method. Mind that this is actually a string. It can be, for example `corporate:1234` - for corporate billing, or `balance`, or `subscription` - when the session is to be paid with the user's post-paid subscription.",
|
|
126412
|
+
"nullable": true
|
|
126413
|
+
},
|
|
126414
|
+
"terminalId": {
|
|
126415
|
+
"type": "integer",
|
|
126416
|
+
"description": "The ID of the payment terminal when such is used.",
|
|
126417
|
+
"nullable": true
|
|
126418
|
+
},
|
|
126419
|
+
"nonBillableEnergy": {
|
|
126420
|
+
"type": "number",
|
|
126421
|
+
"description": "The energy that is included as an allowance for pre-paid and post subscriptions."
|
|
126422
|
+
},
|
|
126423
|
+
"paymentStatus": {
|
|
126424
|
+
"type": "string",
|
|
126425
|
+
"nullable": true,
|
|
126426
|
+
"enum": [
|
|
126427
|
+
"pending",
|
|
126428
|
+
"paid",
|
|
126429
|
+
"partially",
|
|
126430
|
+
"failed",
|
|
126431
|
+
null
|
|
126432
|
+
]
|
|
126433
|
+
},
|
|
126434
|
+
"authorizationId": {
|
|
126435
|
+
"nullable": true,
|
|
126436
|
+
"type": "integer"
|
|
126437
|
+
},
|
|
126438
|
+
"idTag": {
|
|
126439
|
+
"type": "string",
|
|
126440
|
+
"description": "The idTag defines the authentication source for the session (RFID identifier or remote start identifier)\nA remote start identifier has the format `*XXXXXXX` where the `XXXXXXX` is the session id padded with `0`s on the left\n"
|
|
126441
|
+
},
|
|
126442
|
+
"idTagLabel": {
|
|
126443
|
+
"type": "string",
|
|
126444
|
+
"description": "Additional information about the idTag that differs depending on the type of the idTag or could be something else, related to the car or the user."
|
|
126445
|
+
},
|
|
126446
|
+
"idTagType": {
|
|
126447
|
+
"type": "string",
|
|
126448
|
+
"nullable": true,
|
|
126449
|
+
"enum": [
|
|
126450
|
+
"rfid",
|
|
126451
|
+
"emaid",
|
|
126452
|
+
"mac_address"
|
|
126453
|
+
],
|
|
126454
|
+
"description": "The type of identifier used for authentication. Returns 'rfid' for standard RFID card identifiers, 'emaid' for E-Mobility Account Identifiers used by ISO15118 Plug&Charge, or 'mac_address' for MAC addresses used by Autocharge."
|
|
126455
|
+
},
|
|
126456
|
+
"extendingSessionId": {
|
|
126457
|
+
"deprecated": true,
|
|
126458
|
+
"type": "integer",
|
|
126459
|
+
"nullable": true,
|
|
126460
|
+
"description": "When a session is finished (because connectivity was lost for a long time) and more data is received, the\nadditional data is stored in an extending session. If this property is set, then this is an extending session.\n"
|
|
126461
|
+
},
|
|
126462
|
+
"originalSessionId": {
|
|
126463
|
+
"type": "integer",
|
|
126464
|
+
"description": "ID of the session that the current session is extending."
|
|
126465
|
+
},
|
|
126466
|
+
"extendedBySessionId": {
|
|
126467
|
+
"type": "integer",
|
|
126468
|
+
"description": "ID of the session that extends this session."
|
|
126469
|
+
},
|
|
126470
|
+
"reimbursementEligibility": {
|
|
126471
|
+
"type": "boolean"
|
|
126472
|
+
},
|
|
126473
|
+
"externalSessionId": {
|
|
126474
|
+
"deprecated": true,
|
|
126475
|
+
"nullable": true,
|
|
126476
|
+
"type": "string",
|
|
126477
|
+
"description": "Deprecated: Use `idTag` field instead. This field will be removed in a future version.\nPreviously used for admin-started sessions, this value is now available in the `idTag` field.\n"
|
|
126478
|
+
},
|
|
126479
|
+
"authorization": {
|
|
126480
|
+
"type": "object",
|
|
126481
|
+
"description": "Session authorization.\n\nEmbedded as the `authorization` property in Session responses when the `withAuthorization` parameter\nis enabled, and always embedded in session webhook notifications for sessions that have an\nauthorization.\n",
|
|
126482
|
+
"properties": {
|
|
126483
|
+
"id": {
|
|
126484
|
+
"type": "integer"
|
|
126485
|
+
},
|
|
126486
|
+
"operatorId": {
|
|
126487
|
+
"type": "integer",
|
|
126488
|
+
"nullable": true,
|
|
126489
|
+
"description": "The ID of the operator this resource belongs to",
|
|
126490
|
+
"example": 1
|
|
126491
|
+
},
|
|
126492
|
+
"method": {
|
|
126493
|
+
"description": "The method used to authorize the charging session.\n- `user_device` - Authorization via mobile app or web portal\n- `rfid_tag` - Authorization via physical RFID card\n- `mac_address` - Authorization via vehicle MAC address (AutoCharge)\n- `admin` - Manual authorization by admin user\n- `plug_and_charge` - Authorization via Plug & Charge\n- `plug_and_charge_iso15118` - Authorization via ISO 15118 Plug & Charge\n- `payment_terminal` - Authorization via payment terminal\n- `mobile_app` - Authorization received from a roaming platform via OCPI\n",
|
|
126494
|
+
"type": "string",
|
|
126495
|
+
"enum": [
|
|
126496
|
+
"user_device",
|
|
126497
|
+
"rfid_tag",
|
|
126498
|
+
"mac_address",
|
|
126499
|
+
"admin",
|
|
126500
|
+
"plug_and_charge",
|
|
126501
|
+
"plug_and_charge_iso15118",
|
|
126502
|
+
"payment_terminal",
|
|
126503
|
+
"mobile_app"
|
|
126504
|
+
]
|
|
126505
|
+
},
|
|
126506
|
+
"source": {
|
|
126507
|
+
"description": "The origin of the authorization request.\n- `local` - Authorization initiated directly on this platform\n- `roaming` - Authorization received from a roaming platform (OCPI/Hubject). OCPI authorizations report the method as `mobile_app`.\n- `third_party` - Authorization initiated by a third-party authority\n",
|
|
126508
|
+
"type": "string",
|
|
126509
|
+
"enum": [
|
|
126510
|
+
"local",
|
|
126511
|
+
"roaming",
|
|
126512
|
+
"third_party"
|
|
126513
|
+
]
|
|
126514
|
+
},
|
|
126515
|
+
"createdAt": {
|
|
126516
|
+
"type": "string",
|
|
126517
|
+
"format": "date-time"
|
|
126518
|
+
},
|
|
126519
|
+
"createdAtLocal": {
|
|
126520
|
+
"type": "string",
|
|
126521
|
+
"format": "date-time",
|
|
126522
|
+
"description": "The creation time in the local time zone of the charge point, falling back to the operator's default time zone."
|
|
126523
|
+
},
|
|
126524
|
+
"status": {
|
|
126525
|
+
"description": "The status of the authorization request.\n- `accepted` - Authorization was approved and the user can start charging\n- `rejected` - Authorization was denied and the user cannot charge\n- `pending` - Authorization is awaiting approval or validation\n",
|
|
126526
|
+
"type": "string",
|
|
126527
|
+
"enum": [
|
|
126528
|
+
"accepted",
|
|
126529
|
+
"rejected",
|
|
126530
|
+
"pending"
|
|
126531
|
+
]
|
|
126532
|
+
},
|
|
126533
|
+
"rejectionReason": {
|
|
126534
|
+
"type": "string",
|
|
126535
|
+
"nullable": true,
|
|
126536
|
+
"description": "The reason for rejecting the authorization. `null` unless status is `rejected`."
|
|
126537
|
+
},
|
|
126538
|
+
"userId": {
|
|
126539
|
+
"type": "integer",
|
|
126540
|
+
"nullable": true,
|
|
126541
|
+
"description": "The user that is authorized. `null` when the authorization is not linked to a local user."
|
|
126542
|
+
},
|
|
126543
|
+
"rfidTagUid": {
|
|
126544
|
+
"type": "string",
|
|
126545
|
+
"nullable": true,
|
|
126546
|
+
"description": "The UID of the identification tag that created the authorization. Only populated when source is\n`local` or `third_party`; `null` for roaming authorizations, whose token details are in the `roaming`\nobject.\n"
|
|
126547
|
+
},
|
|
126548
|
+
"roaming": {
|
|
126549
|
+
"description": "In case source is `roaming`, this object describes the EMSP that gave the authorization",
|
|
126550
|
+
"type": "object",
|
|
126551
|
+
"properties": {
|
|
126552
|
+
"platformId": {
|
|
126553
|
+
"description": "The roaming platform ID that gave the authorization",
|
|
126554
|
+
"type": "integer"
|
|
126555
|
+
},
|
|
126556
|
+
"platformRoleId": {
|
|
126557
|
+
"description": "The role that gave the authorization (the EMSP)",
|
|
126558
|
+
"type": "integer"
|
|
126559
|
+
},
|
|
126560
|
+
"platformRole": {
|
|
126561
|
+
"description": "The role identifier",
|
|
126562
|
+
"type": "string"
|
|
126563
|
+
},
|
|
126564
|
+
"reference": {
|
|
126565
|
+
"description": "OCPI's authorization_reference, or Hubject's SessionID",
|
|
126566
|
+
"type": "string"
|
|
126567
|
+
},
|
|
126568
|
+
"client": {
|
|
126569
|
+
"description": "OCPI's contractId, or Hubject's EVCO ID",
|
|
126570
|
+
"type": "string"
|
|
126571
|
+
},
|
|
126572
|
+
"uid": {
|
|
126573
|
+
"description": "OCPI's token UID, as recorded at the moment the authorization was created. Absent for Hubject\nauthorizations and for authorizations created before the identifiers were recorded.\n",
|
|
126574
|
+
"type": "string"
|
|
126575
|
+
},
|
|
126576
|
+
"visualNumber": {
|
|
126577
|
+
"description": "OCPI's token visual_number, as recorded at the moment the authorization was created. Absent for\nHubject authorizations, for authorizations created before the identifiers were recorded, and when\nthe roaming platform did not provide a visual number.\n",
|
|
126578
|
+
"type": "string"
|
|
126579
|
+
}
|
|
126580
|
+
},
|
|
126581
|
+
"required": [
|
|
126582
|
+
"platformId",
|
|
126583
|
+
"platformRoleId",
|
|
126584
|
+
"platformRole",
|
|
126585
|
+
"reference",
|
|
126586
|
+
"client"
|
|
126587
|
+
]
|
|
126588
|
+
},
|
|
126589
|
+
"lastUpdatedAt": {
|
|
126590
|
+
"type": "string",
|
|
126591
|
+
"format": "date-time",
|
|
126592
|
+
"description": "ISO 8601 formatted date",
|
|
126593
|
+
"readOnly": true
|
|
126594
|
+
}
|
|
126595
|
+
},
|
|
126596
|
+
"required": [
|
|
126597
|
+
"id",
|
|
126598
|
+
"method",
|
|
126599
|
+
"source",
|
|
126600
|
+
"createdAt",
|
|
126601
|
+
"status",
|
|
126602
|
+
"rejectionReason",
|
|
126603
|
+
"userId",
|
|
126604
|
+
"rfidTagUid",
|
|
126605
|
+
"lastUpdatedAt"
|
|
126606
|
+
]
|
|
126607
|
+
},
|
|
126608
|
+
"chargingPeriods": {
|
|
126609
|
+
"type": "array",
|
|
126610
|
+
"items": {
|
|
126611
|
+
"type": "object",
|
|
126612
|
+
"description": "Describes a period in the session that is billed separately, for example charging@night (for time of day tariffs) or idle (for tariffs that charge separately idle time)",
|
|
126613
|
+
"properties": {
|
|
126614
|
+
"id": {
|
|
126615
|
+
"type": "integer"
|
|
126616
|
+
},
|
|
126617
|
+
"energy": {
|
|
126618
|
+
"type": "integer",
|
|
126619
|
+
"description": "Delivered energy in Wh"
|
|
126620
|
+
},
|
|
126621
|
+
"energyPrecise": {
|
|
126622
|
+
"type": "number",
|
|
126623
|
+
"nullable": true,
|
|
126624
|
+
"description": "Delivered energy in Wh with decimal precision"
|
|
126625
|
+
},
|
|
126626
|
+
"startedAt": {
|
|
126627
|
+
"type": "string",
|
|
126628
|
+
"format": "date-time"
|
|
126629
|
+
},
|
|
126630
|
+
"stoppedAt": {
|
|
126631
|
+
"type": "string",
|
|
126632
|
+
"format": "date-time",
|
|
126633
|
+
"nullable": true
|
|
126634
|
+
},
|
|
126635
|
+
"state": {
|
|
126636
|
+
"deprecated": true,
|
|
126637
|
+
"type": "string",
|
|
126638
|
+
"example": [
|
|
126639
|
+
"charging",
|
|
126640
|
+
"charging@night",
|
|
126641
|
+
"charging@day",
|
|
126642
|
+
"idle",
|
|
126643
|
+
"idle@day",
|
|
126644
|
+
"idle@night",
|
|
126645
|
+
"charging@boosted",
|
|
126646
|
+
"charging@optimised"
|
|
126647
|
+
],
|
|
126648
|
+
"description": "The state of the period. A non exhaustive list of possible values:\n * `charging` - the vehicle was charging\n * `charging@night` - a ToD tariff was selected and the vehicle was charging during the nighttime period of the tariff\n * `charging@day` - a ToD tariff was selected and the vehicle was charging during the daytime period of the tariff\n * `idle` - a tariff with separate pricing for idle time was selected and the charging was idle in that period\n * `idle@night` - a ToD tariff was selected and the vehicle was idling during the nighttime period of the tariff\n * `idle@day` - a ToD tariff was selected and the vehicle was idling during the daytime period of the tariff\n * `charging@boosted` - Optimised dynamic pricing was applied and charging was performed with full available power\n * `charging@optimised` - Optimised dynamic pricing was applied and charging was performed with lower price and limited power during peak hours\n"
|
|
126649
|
+
},
|
|
126650
|
+
"chargingState": {
|
|
126651
|
+
"type": "string",
|
|
126652
|
+
"enum": [
|
|
126653
|
+
"charging",
|
|
126654
|
+
"idle"
|
|
126655
|
+
],
|
|
126656
|
+
"description": "The charging state of the period."
|
|
126657
|
+
},
|
|
126658
|
+
"graceTimeEndAt": {
|
|
126659
|
+
"type": "string",
|
|
126660
|
+
"format": "date-time",
|
|
126661
|
+
"description": "When the idle fee grace period expires for this charging period. Present only on idle charging periods that have a grace period configured."
|
|
126662
|
+
},
|
|
126663
|
+
"pricingDetails": {
|
|
126664
|
+
"description": "Optional pricing details specific to this charging period, dependent on the tariff.",
|
|
126665
|
+
"type": "object",
|
|
126666
|
+
"properties": {
|
|
126667
|
+
"chargingType": {
|
|
126668
|
+
"type": "string",
|
|
126669
|
+
"enum": [
|
|
126670
|
+
"boosted",
|
|
126671
|
+
"optimised"
|
|
126672
|
+
],
|
|
126673
|
+
"nullable": true,
|
|
126674
|
+
"description": "Power delivery strategy used during this period.\n * `boosted` - maximum available power delivery\n * `optimised` - reduced power during peak hours for cost efficiency\n"
|
|
126675
|
+
},
|
|
126676
|
+
"dayPeriod": {
|
|
126677
|
+
"type": "string",
|
|
126678
|
+
"nullable": true,
|
|
126679
|
+
"enum": [
|
|
126680
|
+
"day",
|
|
126681
|
+
"night"
|
|
126682
|
+
],
|
|
126683
|
+
"description": "The period of the day.\n * `day` - daytime period of the tariff\n * `night` - nighttime period of the tariff\n"
|
|
126684
|
+
},
|
|
126685
|
+
"pricingMethod": {
|
|
126686
|
+
"type": "string",
|
|
126687
|
+
"nullable": true,
|
|
126688
|
+
"enum": [
|
|
126689
|
+
"duration",
|
|
126690
|
+
"energy",
|
|
126691
|
+
"durationAndEnergy",
|
|
126692
|
+
"free"
|
|
126693
|
+
],
|
|
126694
|
+
"description": "The method used for calculating price in standard tariffs.\n * `duration` - pricing based on duration\n * `energy` - pricing based on energy consumption\n * `durationAndEnergy` - pricing based on both duration and energy\n * `free` - free period with no charge\n"
|
|
126695
|
+
},
|
|
126696
|
+
"price": {
|
|
126697
|
+
"type": "number",
|
|
126698
|
+
"format": "decimal",
|
|
126699
|
+
"description": "Base price rate for Energy Time of Usage tariffs"
|
|
126700
|
+
},
|
|
126701
|
+
"markup": {
|
|
126702
|
+
"type": "number",
|
|
126703
|
+
"format": "decimal",
|
|
126704
|
+
"description": "Additional percentage or fixed amount added to the base price"
|
|
126705
|
+
},
|
|
126706
|
+
"initialEnergyPrice": {
|
|
126707
|
+
"type": "number",
|
|
126708
|
+
"format": "decimal",
|
|
126709
|
+
"description": "Starting price rate for energy-based charging"
|
|
126710
|
+
},
|
|
126711
|
+
"initialDurationPrice": {
|
|
126712
|
+
"type": "number",
|
|
126713
|
+
"format": "decimal",
|
|
126714
|
+
"description": "Starting price rate for time-based charging"
|
|
126715
|
+
},
|
|
126716
|
+
"startHour": {
|
|
126717
|
+
"type": "string",
|
|
126718
|
+
"description": "The start hour for the charging period"
|
|
126719
|
+
},
|
|
126720
|
+
"endHour": {
|
|
126721
|
+
"type": "string",
|
|
126722
|
+
"description": "The end hour for the charging period"
|
|
126723
|
+
},
|
|
126724
|
+
"day": {
|
|
126725
|
+
"type": "string",
|
|
126726
|
+
"description": "The day being used"
|
|
126727
|
+
}
|
|
126728
|
+
}
|
|
126729
|
+
},
|
|
126730
|
+
"amount": {
|
|
126731
|
+
"type": "number",
|
|
126732
|
+
"format": "decimal",
|
|
126733
|
+
"nullable": true,
|
|
126734
|
+
"deprecated": true
|
|
126735
|
+
},
|
|
126736
|
+
"totalAmount": {
|
|
126737
|
+
"type": "object",
|
|
126738
|
+
"properties": {
|
|
126739
|
+
"withTax": {
|
|
126740
|
+
"type": "number"
|
|
126741
|
+
},
|
|
126742
|
+
"withoutTax": {
|
|
126743
|
+
"type": "number"
|
|
126744
|
+
}
|
|
126745
|
+
},
|
|
126746
|
+
"required": [
|
|
126747
|
+
"withTax"
|
|
126748
|
+
]
|
|
126749
|
+
},
|
|
126750
|
+
"priceBreakdown": {
|
|
126751
|
+
"type": "array",
|
|
126752
|
+
"items": {
|
|
126753
|
+
"description": "Charging period price breakdown",
|
|
126754
|
+
"$ref": "#/components/schemas/Session"
|
|
126755
|
+
},
|
|
126756
|
+
"description": "A breakdown of the different tariff elements that create the total amount of the charging period. Only sent when `withChargingPeriodsPriceBreakdown` is set to `true`. The priceBreakdown will be displayed only when the Billing status of the session is marked as completed."
|
|
126757
|
+
}
|
|
126758
|
+
},
|
|
126759
|
+
"required": [
|
|
126760
|
+
"id",
|
|
126761
|
+
"energy",
|
|
126762
|
+
"startedAt",
|
|
126763
|
+
"state"
|
|
126764
|
+
]
|
|
126765
|
+
}
|
|
126766
|
+
},
|
|
126767
|
+
"priceBreakdown": {
|
|
126768
|
+
"type": "array",
|
|
126769
|
+
"items": {
|
|
126770
|
+
"type": "object",
|
|
126771
|
+
"properties": {
|
|
126772
|
+
"type": {
|
|
126773
|
+
"type": "string",
|
|
126774
|
+
"enum": [
|
|
126775
|
+
"flat",
|
|
126776
|
+
"connection",
|
|
126777
|
+
"energy",
|
|
126778
|
+
"charging_time",
|
|
126779
|
+
"idle_time",
|
|
126780
|
+
"power_levels_time",
|
|
126781
|
+
"min_price",
|
|
126782
|
+
"service_fee",
|
|
126783
|
+
"energy_flat_fee",
|
|
126784
|
+
"duration_flat_fee",
|
|
126785
|
+
"idle_flat_fee"
|
|
126786
|
+
],
|
|
126787
|
+
"description": "* `flat` - no matter the duration or energy consumed each session would cost one and the same amount,\n* `connection` - a fixed fee that is applied at the start of the charging session,\n* `energy` - the cost for the consumed energy,\n* `charging_time` - the cost for the duration of the session when there is ongoing charging,\n* `idle_time` - the cost for the time when there is no active charging but there is an ongoing session,\n* `power_levels_time` - the cost for peak and average power levels,\n* `min_price` - the minimum price a session should cost, anything below that price is rounded up to the minimum price,\n* `service_fee` - the cost for the mark up,\n* `energy_flat_fee` - a fixed fee applied per energy component,\n* `duration_flat_fee` - a fixed fee applied per duration component,\n* `idle_flat_fee` - a fixed fee applied per idle component.\n"
|
|
126788
|
+
},
|
|
126789
|
+
"currency": {
|
|
126790
|
+
"type": "string",
|
|
126791
|
+
"example": "EUR",
|
|
126792
|
+
"minLength": 3,
|
|
126793
|
+
"maxLength": 3,
|
|
126794
|
+
"description": "3-letter currency code (ISO 4217)"
|
|
126795
|
+
},
|
|
126796
|
+
"unit": {
|
|
126797
|
+
"type": "string",
|
|
126798
|
+
"enum": [
|
|
126799
|
+
"kwh",
|
|
126800
|
+
"minute",
|
|
126801
|
+
"session"
|
|
126802
|
+
],
|
|
126803
|
+
"description": "The measure that is used for the type element."
|
|
126804
|
+
},
|
|
126805
|
+
"pricePerUnit": {
|
|
126806
|
+
"description": "The price of a single unit of the tariff element.",
|
|
126807
|
+
"type": "object",
|
|
126808
|
+
"properties": {
|
|
126809
|
+
"withTax": {
|
|
126810
|
+
"type": "number"
|
|
126811
|
+
},
|
|
126812
|
+
"withoutTax": {
|
|
126813
|
+
"type": "number"
|
|
126814
|
+
}
|
|
126815
|
+
},
|
|
126816
|
+
"required": [
|
|
126817
|
+
"withTax"
|
|
126818
|
+
]
|
|
126819
|
+
},
|
|
126820
|
+
"quantity": {
|
|
126821
|
+
"type": "number",
|
|
126822
|
+
"format": "decimal",
|
|
126823
|
+
"description": "The number of units."
|
|
126824
|
+
},
|
|
126825
|
+
"price": {
|
|
126826
|
+
"description": "The `pricePerUnit` multiplied by the `quantity`.",
|
|
126827
|
+
"type": "object",
|
|
126828
|
+
"properties": {
|
|
126829
|
+
"withTax": {
|
|
126830
|
+
"type": "number"
|
|
126831
|
+
},
|
|
126832
|
+
"withoutTax": {
|
|
126833
|
+
"type": "number"
|
|
126834
|
+
}
|
|
126835
|
+
},
|
|
126836
|
+
"required": [
|
|
126837
|
+
"withTax"
|
|
126838
|
+
]
|
|
126839
|
+
},
|
|
126840
|
+
"taxPercentage": {
|
|
126841
|
+
"type": "number",
|
|
126842
|
+
"nullable": true,
|
|
126843
|
+
"format": "decimal",
|
|
126844
|
+
"description": "The tax rate percentage applied to this tariff element."
|
|
126845
|
+
},
|
|
126846
|
+
"totalPrice": {
|
|
126847
|
+
"type": "number",
|
|
126848
|
+
"format": "decimal",
|
|
126849
|
+
"description": "The `unitPrice` multiplied by the `quantity`.",
|
|
126850
|
+
"deprecated": true
|
|
126851
|
+
},
|
|
126852
|
+
"unitPrice": {
|
|
126853
|
+
"type": "number",
|
|
126854
|
+
"format": "decimal",
|
|
126855
|
+
"description": "The price of a single unit of the tariff element.",
|
|
126856
|
+
"deprecated": true
|
|
126857
|
+
},
|
|
126858
|
+
"discounts": {
|
|
126859
|
+
"type": "array",
|
|
126860
|
+
"description": "Per-type discount breakdown for this row. Omitted when no discount data is available.\n",
|
|
126861
|
+
"items": {
|
|
126862
|
+
"type": "object",
|
|
126863
|
+
"properties": {
|
|
126864
|
+
"type": {
|
|
126865
|
+
"type": "string",
|
|
126866
|
+
"enum": [
|
|
126867
|
+
"subsidy",
|
|
126868
|
+
"corporate"
|
|
126869
|
+
],
|
|
126870
|
+
"description": "Type of an individual discount entry.\n- **subsidy**: energy-fee subsidy when the unit price exceeds a configured threshold.\n- **corporate**: percentage discount tied to a corporate billing arrangement.\n",
|
|
126871
|
+
"example": "subsidy"
|
|
126872
|
+
},
|
|
126873
|
+
"amount": {
|
|
126874
|
+
"type": "object",
|
|
126875
|
+
"properties": {
|
|
126876
|
+
"withTax": {
|
|
126877
|
+
"type": "number"
|
|
126878
|
+
},
|
|
126879
|
+
"withoutTax": {
|
|
126880
|
+
"type": "number"
|
|
126881
|
+
}
|
|
126882
|
+
},
|
|
126883
|
+
"required": [
|
|
126884
|
+
"withTax"
|
|
126885
|
+
]
|
|
126886
|
+
}
|
|
126887
|
+
},
|
|
126888
|
+
"required": [
|
|
126889
|
+
"type",
|
|
126890
|
+
"amount"
|
|
126891
|
+
]
|
|
126892
|
+
}
|
|
126893
|
+
}
|
|
126894
|
+
},
|
|
126895
|
+
"required": [
|
|
126896
|
+
"type",
|
|
126897
|
+
"currency",
|
|
126898
|
+
"price",
|
|
126899
|
+
"quantity",
|
|
126900
|
+
"pricePerUnit",
|
|
126901
|
+
"unit",
|
|
126902
|
+
"totalPrice",
|
|
126903
|
+
"unitPrice"
|
|
126904
|
+
]
|
|
126905
|
+
},
|
|
126906
|
+
"description": "A breakdown of the different tariff elements that create the total amount of the charging session. Only sent when `session_with_price_breakdown` is set to `true`. The priceBreakdown will be displayed only when the Billing status of the session is marked as completed."
|
|
126907
|
+
},
|
|
126908
|
+
"tariffSnapshotId": {
|
|
126909
|
+
"type": "integer",
|
|
126910
|
+
"nullable": true,
|
|
126911
|
+
"description": "At the start of the charging session the tariff will be snapshotted and that snapshot will not be changed ever. That snapshot is used to determine the price of the charging session. This is the ID of that snapshot.\n"
|
|
126912
|
+
},
|
|
126913
|
+
"electricityCost": {
|
|
126914
|
+
"type": "number",
|
|
126915
|
+
"format": "decimal",
|
|
126916
|
+
"nullable": true
|
|
126917
|
+
},
|
|
126918
|
+
"evsePhysicalReference": {
|
|
126919
|
+
"type": "string",
|
|
126920
|
+
"description": "This could be either the identifier that is presented to the user, so they can identify the EVSE at the location. Or for roaming EVSEs - it is the roaming evse_id.\n",
|
|
126921
|
+
"nullable": true
|
|
126922
|
+
},
|
|
126923
|
+
"paymentStatusUpdatedAt": {
|
|
126924
|
+
"type": "string",
|
|
126925
|
+
"nullable": true,
|
|
126926
|
+
"format": "date-time",
|
|
126927
|
+
"description": "ISO 8601 formatted date",
|
|
126928
|
+
"readOnly": true
|
|
126929
|
+
},
|
|
126930
|
+
"chargePointOperatorRoamingId": {
|
|
126931
|
+
"type": "string",
|
|
126932
|
+
"description": "The roaming operator identifier (e.g., \"DE*ENA\", \"LT*IGN\") of the operator who owns the charge point where the session occurred. Only returned for roaming sessions."
|
|
126933
|
+
},
|
|
126934
|
+
"roaming": {
|
|
126935
|
+
"type": "object",
|
|
126936
|
+
"properties": {
|
|
126937
|
+
"cdrIds": {
|
|
126938
|
+
"type": "array",
|
|
126939
|
+
"description": "The CDRs that are generated for roaming sessions.",
|
|
126940
|
+
"items": {
|
|
126941
|
+
"type": "integer"
|
|
126942
|
+
}
|
|
126943
|
+
},
|
|
126944
|
+
"sessionId": {
|
|
126945
|
+
"type": "string",
|
|
126946
|
+
"description": "The unique id that identifies the charging session in the CPO platform."
|
|
126947
|
+
},
|
|
126948
|
+
"roamingOperatorCpoId": {
|
|
126949
|
+
"type": "integer",
|
|
126950
|
+
"description": "The id of the roaming operator that owns the charge point at which the session occurred."
|
|
126951
|
+
},
|
|
126952
|
+
"cpoLastUpdatedAt": {
|
|
126953
|
+
"type": "string",
|
|
126954
|
+
"format": "date-time",
|
|
126955
|
+
"description": "Applicable only for OCPI sessions and populated with the most recent shared `last_updated` value from the CPO roaming operator. ISO 8601 formatted date",
|
|
126956
|
+
"readOnly": true
|
|
126957
|
+
}
|
|
126958
|
+
}
|
|
126959
|
+
},
|
|
126960
|
+
"lastUpdatedAt": {
|
|
126961
|
+
"type": "string",
|
|
126962
|
+
"format": "date-time",
|
|
126963
|
+
"description": "ISO 8601 formatted date",
|
|
126964
|
+
"readOnly": true
|
|
126965
|
+
},
|
|
126966
|
+
"randomisedDelay": {
|
|
126967
|
+
"type": "integer",
|
|
126968
|
+
"description": "Number of seconds by which current offering is being delayed at the start of the session. The field is omitted when randomised delay is not enabled in the Personal Charging settings or when there is no randomised delay."
|
|
126969
|
+
},
|
|
126970
|
+
"receiptId": {
|
|
126971
|
+
"deprecated": true,
|
|
126972
|
+
"type": "integer",
|
|
126973
|
+
"nullable": true
|
|
126974
|
+
},
|
|
126975
|
+
"externalAppData": {
|
|
126976
|
+
"description": "Used to hold any external application data related to the session.",
|
|
126977
|
+
"type": "object",
|
|
126978
|
+
"nullable": true,
|
|
126979
|
+
"additionalProperties": true
|
|
126980
|
+
},
|
|
126981
|
+
"clockAlignedEnergyConsumption": {
|
|
126982
|
+
"type": "array",
|
|
126983
|
+
"items": {
|
|
126984
|
+
"type": "object",
|
|
126985
|
+
"description": "Session Clock aligned consumption period",
|
|
126986
|
+
"properties": {
|
|
126987
|
+
"start": {
|
|
126988
|
+
"type": "string",
|
|
126989
|
+
"format": "date-time",
|
|
126990
|
+
"description": "The beginning of the clock-aligned consumption period."
|
|
126991
|
+
},
|
|
126992
|
+
"end": {
|
|
126993
|
+
"type": "string",
|
|
126994
|
+
"format": "date-time",
|
|
126995
|
+
"description": "The end of the clock-aligned consumption period."
|
|
126996
|
+
},
|
|
126997
|
+
"energyConsumed": {
|
|
126998
|
+
"deprecated": true,
|
|
126999
|
+
"type": "integer",
|
|
127000
|
+
"description": "The amount of total consumed energy(Wh) during the clock-aligned consumption period."
|
|
127001
|
+
},
|
|
127002
|
+
"energyConsumption": {
|
|
127003
|
+
"type": "object",
|
|
127004
|
+
"properties": {
|
|
127005
|
+
"total": {
|
|
127006
|
+
"type": "number",
|
|
127007
|
+
"description": "The amount of total consumed energy (Wh) during the clock-aligned consumption period."
|
|
127008
|
+
},
|
|
127009
|
+
"local": {
|
|
127010
|
+
"type": "number",
|
|
127011
|
+
"description": "The amount of consumed renewable energy (Wh) generated by individual source for the specified clock-aligned consumption period."
|
|
127012
|
+
},
|
|
127013
|
+
"grid": {
|
|
127014
|
+
"type": "number",
|
|
127015
|
+
"description": "The amount of consumed energy (Wh) delivered from the grid for the specified clock-aligned consumption period."
|
|
127016
|
+
}
|
|
127017
|
+
},
|
|
127018
|
+
"required": [
|
|
127019
|
+
"total",
|
|
127020
|
+
"grid"
|
|
127021
|
+
]
|
|
127022
|
+
},
|
|
127023
|
+
"totalCost": {
|
|
127024
|
+
"type": "object",
|
|
127025
|
+
"description": "The total cost of energy consumption during the clock-aligned period.",
|
|
127026
|
+
"properties": {
|
|
127027
|
+
"withTax": {
|
|
127028
|
+
"type": "number",
|
|
127029
|
+
"description": "Total cost including tax."
|
|
127030
|
+
},
|
|
127031
|
+
"withoutTax": {
|
|
127032
|
+
"type": "number",
|
|
127033
|
+
"description": "Total cost excluding tax."
|
|
127034
|
+
}
|
|
127035
|
+
},
|
|
127036
|
+
"required": [
|
|
127037
|
+
"withTax"
|
|
127038
|
+
]
|
|
127039
|
+
}
|
|
127040
|
+
},
|
|
127041
|
+
"required": [
|
|
127042
|
+
"start",
|
|
127043
|
+
"end",
|
|
127044
|
+
"energyConsumed",
|
|
127045
|
+
"energyConsumption"
|
|
127046
|
+
]
|
|
127047
|
+
},
|
|
127048
|
+
"description": "Energy consumption during time intervals (15, 30 or 60 minutes) in the charging session. The start of the first interval is the start of the session then the intervals are defined by the exact minute of the hour. Clock-aligned consumption periods are included in the response only when the query param 'withClockAlignedEnergyConsumption' is set to 'true'."
|
|
127049
|
+
},
|
|
127050
|
+
"energyConsumption": {
|
|
127051
|
+
"type": "object",
|
|
127052
|
+
"properties": {
|
|
127053
|
+
"total": {
|
|
127054
|
+
"type": "number",
|
|
127055
|
+
"description": "Delivered energy (Wh)"
|
|
127056
|
+
},
|
|
127057
|
+
"local": {
|
|
127058
|
+
"type": "number",
|
|
127059
|
+
"description": "The amount of consumed renewable energy (Wh) generated by individual source for all clock-aligned consumption periods in the charging session."
|
|
127060
|
+
},
|
|
127061
|
+
"grid": {
|
|
127062
|
+
"type": "number",
|
|
127063
|
+
"description": "The amount of consumed energy (Wh) delivered from the grid for all clock-aligned consumption periods in the charging session."
|
|
127064
|
+
}
|
|
127065
|
+
},
|
|
127066
|
+
"required": [
|
|
127067
|
+
"total",
|
|
127068
|
+
"grid"
|
|
127069
|
+
]
|
|
127070
|
+
},
|
|
127071
|
+
"estimatedSavings": {
|
|
127072
|
+
"type": "number",
|
|
127073
|
+
"description": "The sum of savings that could be achieved if the consumed energy was not locally generated but delivered from the grid for all clock-aligned consumption periods in the charging session."
|
|
127074
|
+
},
|
|
127075
|
+
"billingStatus": {
|
|
127076
|
+
"type": "string",
|
|
127077
|
+
"description": "The status of the billing process for the session.",
|
|
127078
|
+
"nullable": true,
|
|
127079
|
+
"enum": [
|
|
127080
|
+
"pending",
|
|
127081
|
+
"suspended",
|
|
127082
|
+
"completed",
|
|
127083
|
+
null
|
|
127084
|
+
]
|
|
127085
|
+
},
|
|
127086
|
+
"billingCompletedAt": {
|
|
127087
|
+
"type": "string",
|
|
127088
|
+
"format": "date-time",
|
|
127089
|
+
"description": "The timestamp when session billing was completed. Only present when billing has completed, omitted otherwise."
|
|
127090
|
+
},
|
|
127091
|
+
"power": {
|
|
127092
|
+
"type": "object",
|
|
127093
|
+
"properties": {
|
|
127094
|
+
"latest": {
|
|
127095
|
+
"type": "number",
|
|
127096
|
+
"nullable": true,
|
|
127097
|
+
"description": "The current charging power (in watts)"
|
|
127098
|
+
},
|
|
127099
|
+
"peak": {
|
|
127100
|
+
"type": "number",
|
|
127101
|
+
"nullable": true,
|
|
127102
|
+
"description": "The maximum charging power (in watts) reached during the session"
|
|
127103
|
+
},
|
|
127104
|
+
"average": {
|
|
127105
|
+
"type": "number",
|
|
127106
|
+
"nullable": true,
|
|
127107
|
+
"description": "The average charging power (in watts) maintained during the session"
|
|
127108
|
+
},
|
|
127109
|
+
"offered": {
|
|
127110
|
+
"type": "number",
|
|
127111
|
+
"nullable": true,
|
|
127112
|
+
"description": "The power offered by the EVSE to the vehicle (in watts)"
|
|
127113
|
+
}
|
|
127114
|
+
}
|
|
127115
|
+
},
|
|
127116
|
+
"preAuthorizedAmount": {
|
|
127117
|
+
"type": "number",
|
|
127118
|
+
"description": "The total amount currently held (authorized) on the user's payment method for this session, in the session's currency.\nOmitted when no active pre-authorization exists for this session (billing strategy does not use pre-authorization, authorization not yet placed, or already captured/voided at session end).\nPresent and greater than 0 when an authorization is held. For incremental sessions this is the sum of the initial authorization and all successful increments; for non-incremental sessions this is the initial authorized amount.\n"
|
|
127119
|
+
},
|
|
127120
|
+
"incrementalPreAuthorizationEnabled": {
|
|
127121
|
+
"type": "boolean",
|
|
127122
|
+
"description": "Whether incremental pre-authorizations are active for this session.\n`true` when all preconditions are met: feature flag enabled, incremental pre-authorizations enabled in settings, billing strategy supports pre-authorization, and the session has an active pre-authorization with a PSP that supports incremental authorization.\n`false` in all other cases, including sessions without pre-authorization and completed sessions.\n"
|
|
127123
|
+
},
|
|
127124
|
+
"customFields": {
|
|
127125
|
+
"description": "Custom field values keyed by their administrator-defined identifiers. Values use the wire representation configured for each field: Boolean is a JSON boolean; Text and Long text are strings; Email is an email-formatted string; URL is an HTTP or HTTPS URL string; Number is a canonical base-10 decimal string from `-99999999999999.999999` through `99999999999999.999999` with up to six fractional digits and no insignificant trailing fractional zeroes; Date is an ISO 8601 `YYYY-MM-DD` string; Date-time is an ISO 8601 timestamp with a UTC offset; and JSON may be any JSON-serializable value. Applicable fields without a value are returned as `null`; fields that are not applicable to the session are omitted. The `customFields` property itself is omitted when no fields apply.\n",
|
|
127126
|
+
"type": "object",
|
|
127127
|
+
"additionalProperties": true
|
|
127128
|
+
}
|
|
127129
|
+
},
|
|
127130
|
+
"required": [
|
|
127131
|
+
"id",
|
|
127132
|
+
"operatorId",
|
|
127133
|
+
"status",
|
|
127134
|
+
"userId",
|
|
127135
|
+
"authorizationId",
|
|
127136
|
+
"energy",
|
|
127137
|
+
"energyConsumption",
|
|
127138
|
+
"chargePointId",
|
|
127139
|
+
"evseId",
|
|
127140
|
+
"startedAt",
|
|
127141
|
+
"billingStatus",
|
|
127142
|
+
"incrementalPreAuthorizationEnabled"
|
|
127143
|
+
]
|
|
127144
|
+
}
|
|
127145
|
+
}
|
|
127146
|
+
}
|
|
127147
|
+
},
|
|
127148
|
+
"401": {
|
|
127149
|
+
"schema": {
|
|
127150
|
+
"type": "object",
|
|
127151
|
+
"properties": {
|
|
127152
|
+
"message": {
|
|
127153
|
+
"type": "string"
|
|
127154
|
+
}
|
|
127155
|
+
}
|
|
127156
|
+
}
|
|
127157
|
+
},
|
|
127158
|
+
"403": {
|
|
127159
|
+
"schema": {
|
|
127160
|
+
"type": "object",
|
|
127161
|
+
"properties": {
|
|
127162
|
+
"message": {
|
|
127163
|
+
"type": "string",
|
|
127164
|
+
"default": "This action is unauthorized."
|
|
127165
|
+
}
|
|
127166
|
+
}
|
|
127167
|
+
}
|
|
127168
|
+
},
|
|
127169
|
+
"404": {
|
|
127170
|
+
"schema": {
|
|
127171
|
+
"type": "object",
|
|
127172
|
+
"properties": {
|
|
127173
|
+
"message": {
|
|
127174
|
+
"type": "string"
|
|
127175
|
+
}
|
|
127176
|
+
}
|
|
127177
|
+
}
|
|
127178
|
+
},
|
|
127179
|
+
"422": {
|
|
127180
|
+
"schema": {
|
|
127181
|
+
"type": "object",
|
|
127182
|
+
"required": [
|
|
127183
|
+
"message"
|
|
127184
|
+
],
|
|
127185
|
+
"properties": {
|
|
127186
|
+
"message": {
|
|
127187
|
+
"type": "string"
|
|
127188
|
+
},
|
|
127189
|
+
"errors": {
|
|
127190
|
+
"type": "object",
|
|
127191
|
+
"additionalProperties": {
|
|
127192
|
+
"type": "array",
|
|
127193
|
+
"items": {
|
|
127194
|
+
"type": "string"
|
|
127195
|
+
}
|
|
127196
|
+
}
|
|
127197
|
+
}
|
|
127198
|
+
}
|
|
127199
|
+
}
|
|
127200
|
+
},
|
|
127201
|
+
"429": {
|
|
127202
|
+
"schema": {
|
|
127203
|
+
"type": "object",
|
|
127204
|
+
"properties": {
|
|
127205
|
+
"message": {
|
|
127206
|
+
"type": "string"
|
|
127207
|
+
}
|
|
127208
|
+
}
|
|
127209
|
+
}
|
|
127210
|
+
}
|
|
127211
|
+
},
|
|
125645
127212
|
"sessionsConsumptionStatsRead": {
|
|
125646
127213
|
"200": {
|
|
125647
127214
|
"schema": {
|