@ampeco/public-api-mcp 3.258.1 → 3.259.1
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 +488 -38
- package/dist/generated/response-schemas.json +3677 -361
- package/dist/generated/schemas.d.ts +67 -2
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +28 -2
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +35 -2
- package/package.json +1 -1
|
@@ -1849,17 +1849,19 @@
|
|
|
1849
1849
|
"PAYMENT_METHOD_REQUIRED",
|
|
1850
1850
|
"CANNOT_BILL_PAYMENT_METHOD",
|
|
1851
1851
|
"CORPORATE_ACCOUNT_LIMIT_REACHED",
|
|
1852
|
+
"corporate_billing_disabled",
|
|
1852
1853
|
"corporate_billing_policy_inactive",
|
|
1853
1854
|
"corporate_billing_limit_exceeded",
|
|
1854
1855
|
"CANNOT_USE_EXPIRED_PAYMENT_METHOD",
|
|
1855
1856
|
"CANNOT_USE_PAYMENT_METHOD",
|
|
1856
1857
|
"PAYMENT_NO_FUNDS"
|
|
1857
1858
|
],
|
|
1858
|
-
"description": "Reason for the error causing the session to fail starting:\n * `BILLING_NOT_ASSOCIATED` - The selected corporate billing is not associated with the user\n * `BILLING_NOT_PARTNER_ASSOCIATED` - The selected corporate billing is allowed on EVSEs that are not associated with the partner\n * `INTERNAL_ISSUE` - Internal issue\n * `SESSION_EXISTS` - Session already exists\n * `CHARGING_NOT_ALLOWED` - The tariff does not allow to charge on this evse\n * `LOCATION_IS_CLOSED` - Charge point's location is closed\n * `USER_VALIDATION_NOT_COMPLETE` - Either your email or phone is not verified or your profile is not completed\n * `TERMS_NOT_ACCEPTED` - User hasn't accepted latest Terms\n * `USER_IS_DISABLED` - Your account is disabled\n * `SUBSCRIPTION_REQUIRED` - You do not have an active subscription for this charging point\n * `SESSION_ALREADY_RUNNING` - Having another running session is not allowed\n * `PREVIOUS_SESSION_NOT_PAID` - Cannot start new session before paying the previous one\n * `UNPAID_SUBSCRIPTION_FEES` - Cannot start a session when you have unpaid post-paid subscription fees\n * `ACCESS_RESTRICTED` - You do not have access to this charge point\n * `PAYMENT_METHOD_REQUIRED` - Cannot start a session without a payment method\n * `CANNOT_BILL_PAYMENT_METHOD` - The payment method either is invalid or the partner does not allow billing\n * `CORPORATE_ACCOUNT_LIMIT_REACHED` -
|
|
1859
|
+
"description": "Reason for the error causing the session to fail starting:\n * `BILLING_NOT_ASSOCIATED` - The selected corporate billing is not associated with the user\n * `BILLING_NOT_PARTNER_ASSOCIATED` - The selected corporate billing is allowed on EVSEs that are not associated with the partner\n * `INTERNAL_ISSUE` - Internal issue\n * `SESSION_EXISTS` - Session already exists\n * `CHARGING_NOT_ALLOWED` - The tariff does not allow to charge on this evse\n * `LOCATION_IS_CLOSED` - Charge point's location is closed\n * `USER_VALIDATION_NOT_COMPLETE` - Either your email or phone is not verified or your profile is not completed\n * `TERMS_NOT_ACCEPTED` - User hasn't accepted latest Terms\n * `USER_IS_DISABLED` - Your account is disabled\n * `SUBSCRIPTION_REQUIRED` - You do not have an active subscription for this charging point\n * `SESSION_ALREADY_RUNNING` - Having another running session is not allowed\n * `PREVIOUS_SESSION_NOT_PAID` - Cannot start new session before paying the previous one\n * `UNPAID_SUBSCRIPTION_FEES` - Cannot start a session when you have unpaid post-paid subscription fees\n * `ACCESS_RESTRICTED` - You do not have access to this charge point\n * `PAYMENT_METHOD_REQUIRED` - Cannot start a session without a payment method\n * `CANNOT_BILL_PAYMENT_METHOD` - The payment method either is invalid or the partner does not allow billing\n * `CORPORATE_ACCOUNT_LIMIT_REACHED` - Legacy corporate-account refusal code; disabled billing is reported as `corporate_billing_disabled`, and spending-limit exhaustion as `corporate_billing_limit_exceeded`.\n * `corporate_billing_disabled` - Corporate billing is switched off for the partner or the user's accepted invite.\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `CANNOT_USE_EXPIRED_PAYMENT_METHOD` - The payment method has expired\n * `CANNOT_USE_PAYMENT_METHOD` - Payment method is not allowed or your subscription is cancelled\n * `PAYMENT_NO_FUNDS` - The current balance is below the needed minimum amount or there are not enough funds in the credit card (works only if you use Stripe)\n"
|
|
1859
1860
|
},
|
|
1860
1861
|
"rejectedPaymentMethodErrorCode": {
|
|
1861
1862
|
"type": "string",
|
|
1862
1863
|
"enum": [
|
|
1864
|
+
"corporate_billing_disabled",
|
|
1863
1865
|
"corporate_billing_policy_inactive",
|
|
1864
1866
|
"corporate_billing_limit_exceeded",
|
|
1865
1867
|
"corporate_billing_currency_mismatch",
|
|
@@ -1870,7 +1872,7 @@
|
|
|
1870
1872
|
"corporate_billing_ad_hoc_tariff_unavailable",
|
|
1871
1873
|
"cannot_use_payment_method"
|
|
1872
1874
|
],
|
|
1873
|
-
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
|
|
1875
|
+
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_disabled` - Corporate billing is switched off for the partner or the user's accepted invite.\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
|
|
1874
1876
|
}
|
|
1875
1877
|
}
|
|
1876
1878
|
}
|
|
@@ -4136,17 +4138,19 @@
|
|
|
4136
4138
|
"PAYMENT_METHOD_REQUIRED",
|
|
4137
4139
|
"CANNOT_BILL_PAYMENT_METHOD",
|
|
4138
4140
|
"CORPORATE_ACCOUNT_LIMIT_REACHED",
|
|
4141
|
+
"corporate_billing_disabled",
|
|
4139
4142
|
"corporate_billing_policy_inactive",
|
|
4140
4143
|
"corporate_billing_limit_exceeded",
|
|
4141
4144
|
"CANNOT_USE_EXPIRED_PAYMENT_METHOD",
|
|
4142
4145
|
"CANNOT_USE_PAYMENT_METHOD",
|
|
4143
4146
|
"PAYMENT_NO_FUNDS"
|
|
4144
4147
|
],
|
|
4145
|
-
"description": "Reason for the error causing the session to fail starting:\n * `BILLING_NOT_ASSOCIATED` - The selected corporate billing is not associated with the user\n * `BILLING_NOT_PARTNER_ASSOCIATED` - The selected corporate billing is allowed on EVSEs that are not associated with the partner\n * `INTERNAL_ISSUE` - Internal issue\n * `SESSION_EXISTS` - Session already exists\n * `CHARGING_NOT_ALLOWED` - The tariff does not allow to charge on this evse\n * `LOCATION_IS_CLOSED` - Charge point's location is closed\n * `USER_VALIDATION_NOT_COMPLETE` - Either your email or phone is not verified or your profile is not completed\n * `TERMS_NOT_ACCEPTED` - User hasn't accepted latest Terms\n * `USER_IS_DISABLED` - Your account is disabled\n * `SUBSCRIPTION_REQUIRED` - You do not have an active subscription for this charging point\n * `SESSION_ALREADY_RUNNING` - Having another running session is not allowed\n * `PREVIOUS_SESSION_NOT_PAID` - Cannot start new session before paying the previous one\n * `UNPAID_SUBSCRIPTION_FEES` - Cannot start a session when you have unpaid post-paid subscription fees\n * `ACCESS_RESTRICTED` - You do not have access to this charge point\n * `PAYMENT_METHOD_REQUIRED` - Cannot start a session without a payment method\n * `CANNOT_BILL_PAYMENT_METHOD` - The payment method either is invalid or the partner does not allow billing\n * `CORPORATE_ACCOUNT_LIMIT_REACHED` -
|
|
4148
|
+
"description": "Reason for the error causing the session to fail starting:\n * `BILLING_NOT_ASSOCIATED` - The selected corporate billing is not associated with the user\n * `BILLING_NOT_PARTNER_ASSOCIATED` - The selected corporate billing is allowed on EVSEs that are not associated with the partner\n * `INTERNAL_ISSUE` - Internal issue\n * `SESSION_EXISTS` - Session already exists\n * `CHARGING_NOT_ALLOWED` - The tariff does not allow to charge on this evse\n * `LOCATION_IS_CLOSED` - Charge point's location is closed\n * `USER_VALIDATION_NOT_COMPLETE` - Either your email or phone is not verified or your profile is not completed\n * `TERMS_NOT_ACCEPTED` - User hasn't accepted latest Terms\n * `USER_IS_DISABLED` - Your account is disabled\n * `SUBSCRIPTION_REQUIRED` - You do not have an active subscription for this charging point\n * `SESSION_ALREADY_RUNNING` - Having another running session is not allowed\n * `PREVIOUS_SESSION_NOT_PAID` - Cannot start new session before paying the previous one\n * `UNPAID_SUBSCRIPTION_FEES` - Cannot start a session when you have unpaid post-paid subscription fees\n * `ACCESS_RESTRICTED` - You do not have access to this charge point\n * `PAYMENT_METHOD_REQUIRED` - Cannot start a session without a payment method\n * `CANNOT_BILL_PAYMENT_METHOD` - The payment method either is invalid or the partner does not allow billing\n * `CORPORATE_ACCOUNT_LIMIT_REACHED` - Legacy corporate-account refusal code; disabled billing is reported as `corporate_billing_disabled`, and spending-limit exhaustion as `corporate_billing_limit_exceeded`.\n * `corporate_billing_disabled` - Corporate billing is switched off for the partner or the user's accepted invite.\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `CANNOT_USE_EXPIRED_PAYMENT_METHOD` - The payment method has expired\n * `CANNOT_USE_PAYMENT_METHOD` - Payment method is not allowed or your subscription is cancelled\n * `PAYMENT_NO_FUNDS` - The current balance is below the needed minimum amount or there are not enough funds in the credit card (works only if you use Stripe)\n"
|
|
4146
4149
|
},
|
|
4147
4150
|
"rejectedPaymentMethodErrorCode": {
|
|
4148
4151
|
"type": "string",
|
|
4149
4152
|
"enum": [
|
|
4153
|
+
"corporate_billing_disabled",
|
|
4150
4154
|
"corporate_billing_policy_inactive",
|
|
4151
4155
|
"corporate_billing_limit_exceeded",
|
|
4152
4156
|
"corporate_billing_currency_mismatch",
|
|
@@ -4157,7 +4161,7 @@
|
|
|
4157
4161
|
"corporate_billing_ad_hoc_tariff_unavailable",
|
|
4158
4162
|
"cannot_use_payment_method"
|
|
4159
4163
|
],
|
|
4160
|
-
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
|
|
4164
|
+
"description": "The reason the requested payment method was rejected before the session start fell back to the user's default payment method:\n * `corporate_billing_disabled` - Corporate billing is switched off for the partner or the user's accepted invite.\n * `corporate_billing_policy_inactive` - The assigned corporate billing policy is inactive, so corporate billing cannot be used for the new session.\n * `corporate_billing_limit_exceeded` - The partner-wide or individual corporate billing limit has been reached.\n * `corporate_billing_currency_mismatch` - The corporate billing limit currency differs from the session currency and the policy does not cover the session.\n * `corporate_billing_charger_type_not_covered` - The charge point's charger type is not covered by the corporate billing policy.\n * `corporate_billing_location_not_covered` - The location, its country, its tags or the roaming network is not covered by the corporate billing policy.\n * `corporate_billing_cross_operator_not_opted_in` - The charge point belongs to another operator that the partner has not opted in to cover.\n * `corporate_billing_exchange_rate_unavailable` - No exchange rate is available between the session currency and the corporate billing limit currency.\n * `corporate_billing_ad_hoc_tariff_unavailable` - The corporate tariff flagged for ad-hoc use at another operator's charge point is not applicable to the session.\n * `cannot_use_payment_method` - The requested payment method is not allowed or the related subscription is cancelled.\n"
|
|
4161
4165
|
}
|
|
4162
4166
|
}
|
|
4163
4167
|
}
|
|
@@ -15100,7 +15104,7 @@
|
|
|
15100
15104
|
"type": "object",
|
|
15101
15105
|
"properties": {
|
|
15102
15106
|
"data": {
|
|
15103
|
-
"description": "
|
|
15107
|
+
"description": "⚠️ Experimental feature — not yet a stable contract. This schema ships as experimental / beta. While experimental, it may change without a version bump — including breaking changes — wherever it is returned, including the session `reimbursementRecords` include. 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.\n\nReimbursement record read schema. A record is one immutable computed reimbursement entry for a single charging session, and has no general resource write surface. Reversing (credit) records are records too — they carry negated amounts and point at the record they reverse.\n",
|
|
15104
15108
|
"type": "object",
|
|
15105
15109
|
"properties": {
|
|
15106
15110
|
"id": {
|
|
@@ -15535,7 +15539,7 @@
|
|
|
15535
15539
|
],
|
|
15536
15540
|
"properties": {
|
|
15537
15541
|
"data": {
|
|
15538
|
-
"description": "
|
|
15542
|
+
"description": "⚠️ Experimental feature — not yet a stable contract. This schema ships as experimental / beta. While experimental, it may change without a version bump — including breaking changes — wherever it is returned, including the session `reimbursementRecords` include. 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.\n\nReimbursement record read schema. A record is one immutable computed reimbursement entry for a single charging session, and has no general resource write surface. Reversing (credit) records are records too — they carry negated amounts and point at the record they reverse.\n",
|
|
15539
15543
|
"type": "object",
|
|
15540
15544
|
"properties": {
|
|
15541
15545
|
"id": {
|
|
@@ -29146,7 +29150,7 @@
|
|
|
29146
29150
|
"anyOf": [
|
|
29147
29151
|
{
|
|
29148
29152
|
"title": "Create Booking Base",
|
|
29149
|
-
"description": "Base properties for create booking
|
|
29153
|
+
"description": "Base properties for create booking requests, shared between input and response.\n\nExisting commercial-public selection is unchanged. Commercial-private eligibility additionally requires the booking user's accepted partner-invite access-policy grants for own or shared charge points; other charging authorization cannot replace these grants. Personal charge points are excluded. See the location check booking availability action for the eligibility policy.\n\nIf no candidate can be selected, the created request is rejected. Its persisted rejectionReason can include booking-enabled EVSEs that are not accessible to the user, separately from EVSEs with booking disabled and other selection failures.\n",
|
|
29150
29154
|
"type": "object",
|
|
29151
29155
|
"properties": {
|
|
29152
29156
|
"id": {
|
|
@@ -29173,7 +29177,7 @@
|
|
|
29173
29177
|
},
|
|
29174
29178
|
"rejectionReason": {
|
|
29175
29179
|
"type": "string",
|
|
29176
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29180
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29177
29181
|
"readOnly": true
|
|
29178
29182
|
},
|
|
29179
29183
|
"createdAt": {
|
|
@@ -29188,7 +29192,7 @@
|
|
|
29188
29192
|
},
|
|
29189
29193
|
"userId": {
|
|
29190
29194
|
"type": "integer",
|
|
29191
|
-
"description": "ID of the user
|
|
29195
|
+
"description": "ID of the booking user, who must be visible to the requesting admin. This user's accepted partner-invite access-policy grants determine commercial-private booking eligibility; commercial-public selection remains unchanged."
|
|
29192
29196
|
},
|
|
29193
29197
|
"locationId": {
|
|
29194
29198
|
"type": "integer",
|
|
@@ -29211,7 +29215,7 @@
|
|
|
29211
29215
|
},
|
|
29212
29216
|
"evseId": {
|
|
29213
29217
|
"type": "integer",
|
|
29214
|
-
"description": "Specific EVSE ID to book.\n\nResponse behavior: Only present when a specific EVSE was requested. Omitted when EVSE selection was based on criteria or left to the system.\n"
|
|
29218
|
+
"description": "Specific EVSE ID to book. The reference must be visible to the requesting admin and belong to the requested location. A valid commercial-private reference still requires the booking user's private eligibility; lack of that eligibility is a business rejection, not an unknown-reference validation error.\n\nResponse behavior: Only present when a specific EVSE was requested. Omitted when EVSE selection was based on criteria or left to the system.\n"
|
|
29215
29219
|
},
|
|
29216
29220
|
"evseCriteria": {
|
|
29217
29221
|
"type": "object",
|
|
@@ -29383,7 +29387,7 @@
|
|
|
29383
29387
|
},
|
|
29384
29388
|
{
|
|
29385
29389
|
"title": "Update Booking Base",
|
|
29386
|
-
"description": "Base properties for update booking
|
|
29390
|
+
"description": "Base properties for update booking requests, shared between input and response.\n\nAccess is evaluated for the resulting booking user and time slot at the booking's location. Omitting userId retains the current user. The supported update input does not carry evseId, evseCriteria or parkingSpaceCriteria from the original create request; original create criteria are not reapplied by this input.\n\nWhen no candidate remains, the request is rejected for lack of user access if a caller-visible, booking-enabled, access-excluded commercial-private EVSE satisfies the effective update selection requirements. This access attribution is independent of occupancy. Other empty selection results retain the time-slot-unavailable rejection. A successful selection takes precedence over these rejection reasons.\n\nAn access rejection persists the booking request with status \"rejected\" and rejectionReason \"The booking cannot be updated because the user has no access to a bookable EVSE at the location.\" The existing booking's user, held EVSEs, dates, reservation and reservation cycle remain unchanged.\n",
|
|
29387
29391
|
"type": "object",
|
|
29388
29392
|
"properties": {
|
|
29389
29393
|
"id": {
|
|
@@ -29410,7 +29414,7 @@
|
|
|
29410
29414
|
},
|
|
29411
29415
|
"rejectionReason": {
|
|
29412
29416
|
"type": "string",
|
|
29413
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29417
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29414
29418
|
"readOnly": true
|
|
29415
29419
|
},
|
|
29416
29420
|
"createdAt": {
|
|
@@ -29429,7 +29433,7 @@
|
|
|
29429
29433
|
},
|
|
29430
29434
|
"userId": {
|
|
29431
29435
|
"type": "integer",
|
|
29432
|
-
"description": "ID of the user for
|
|
29436
|
+
"description": "ID of the proposed booking user, who must be visible to the requesting admin. Access is evaluated for this resulting user; when omitted, the booking's current user is retained and evaluated. A rejected update does not change the booking's user."
|
|
29433
29437
|
},
|
|
29434
29438
|
"externalId": {
|
|
29435
29439
|
"type": "string",
|
|
@@ -29524,7 +29528,7 @@
|
|
|
29524
29528
|
},
|
|
29525
29529
|
"rejectionReason": {
|
|
29526
29530
|
"type": "string",
|
|
29527
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29531
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29528
29532
|
"readOnly": true
|
|
29529
29533
|
},
|
|
29530
29534
|
"createdAt": {
|
|
@@ -29651,7 +29655,7 @@
|
|
|
29651
29655
|
"anyOf": [
|
|
29652
29656
|
{
|
|
29653
29657
|
"title": "Create Booking Base",
|
|
29654
|
-
"description": "Base properties for create booking
|
|
29658
|
+
"description": "Base properties for create booking requests, shared between input and response.\n\nExisting commercial-public selection is unchanged. Commercial-private eligibility additionally requires the booking user's accepted partner-invite access-policy grants for own or shared charge points; other charging authorization cannot replace these grants. Personal charge points are excluded. See the location check booking availability action for the eligibility policy.\n\nIf no candidate can be selected, the created request is rejected. Its persisted rejectionReason can include booking-enabled EVSEs that are not accessible to the user, separately from EVSEs with booking disabled and other selection failures.\n",
|
|
29655
29659
|
"type": "object",
|
|
29656
29660
|
"properties": {
|
|
29657
29661
|
"id": {
|
|
@@ -29678,7 +29682,7 @@
|
|
|
29678
29682
|
},
|
|
29679
29683
|
"rejectionReason": {
|
|
29680
29684
|
"type": "string",
|
|
29681
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29685
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29682
29686
|
"readOnly": true
|
|
29683
29687
|
},
|
|
29684
29688
|
"createdAt": {
|
|
@@ -29693,7 +29697,7 @@
|
|
|
29693
29697
|
},
|
|
29694
29698
|
"userId": {
|
|
29695
29699
|
"type": "integer",
|
|
29696
|
-
"description": "ID of the user
|
|
29700
|
+
"description": "ID of the booking user, who must be visible to the requesting admin. This user's accepted partner-invite access-policy grants determine commercial-private booking eligibility; commercial-public selection remains unchanged."
|
|
29697
29701
|
},
|
|
29698
29702
|
"locationId": {
|
|
29699
29703
|
"type": "integer",
|
|
@@ -29716,7 +29720,7 @@
|
|
|
29716
29720
|
},
|
|
29717
29721
|
"evseId": {
|
|
29718
29722
|
"type": "integer",
|
|
29719
|
-
"description": "Specific EVSE ID to book.\n\nResponse behavior: Only present when a specific EVSE was requested. Omitted when EVSE selection was based on criteria or left to the system.\n"
|
|
29723
|
+
"description": "Specific EVSE ID to book. The reference must be visible to the requesting admin and belong to the requested location. A valid commercial-private reference still requires the booking user's private eligibility; lack of that eligibility is a business rejection, not an unknown-reference validation error.\n\nResponse behavior: Only present when a specific EVSE was requested. Omitted when EVSE selection was based on criteria or left to the system.\n"
|
|
29720
29724
|
},
|
|
29721
29725
|
"evseCriteria": {
|
|
29722
29726
|
"type": "object",
|
|
@@ -29888,7 +29892,7 @@
|
|
|
29888
29892
|
},
|
|
29889
29893
|
{
|
|
29890
29894
|
"title": "Update Booking Base",
|
|
29891
|
-
"description": "Base properties for update booking
|
|
29895
|
+
"description": "Base properties for update booking requests, shared between input and response.\n\nAccess is evaluated for the resulting booking user and time slot at the booking's location. Omitting userId retains the current user. The supported update input does not carry evseId, evseCriteria or parkingSpaceCriteria from the original create request; original create criteria are not reapplied by this input.\n\nWhen no candidate remains, the request is rejected for lack of user access if a caller-visible, booking-enabled, access-excluded commercial-private EVSE satisfies the effective update selection requirements. This access attribution is independent of occupancy. Other empty selection results retain the time-slot-unavailable rejection. A successful selection takes precedence over these rejection reasons.\n\nAn access rejection persists the booking request with status \"rejected\" and rejectionReason \"The booking cannot be updated because the user has no access to a bookable EVSE at the location.\" The existing booking's user, held EVSEs, dates, reservation and reservation cycle remain unchanged.\n",
|
|
29892
29896
|
"type": "object",
|
|
29893
29897
|
"properties": {
|
|
29894
29898
|
"id": {
|
|
@@ -29915,7 +29919,7 @@
|
|
|
29915
29919
|
},
|
|
29916
29920
|
"rejectionReason": {
|
|
29917
29921
|
"type": "string",
|
|
29918
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29922
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
29919
29923
|
"readOnly": true
|
|
29920
29924
|
},
|
|
29921
29925
|
"createdAt": {
|
|
@@ -29934,7 +29938,7 @@
|
|
|
29934
29938
|
},
|
|
29935
29939
|
"userId": {
|
|
29936
29940
|
"type": "integer",
|
|
29937
|
-
"description": "ID of the user for
|
|
29941
|
+
"description": "ID of the proposed booking user, who must be visible to the requesting admin. Access is evaluated for this resulting user; when omitted, the booking's current user is retained and evaluated. A rejected update does not change the booking's user."
|
|
29938
29942
|
},
|
|
29939
29943
|
"externalId": {
|
|
29940
29944
|
"type": "string",
|
|
@@ -30029,7 +30033,7 @@
|
|
|
30029
30033
|
},
|
|
30030
30034
|
"rejectionReason": {
|
|
30031
30035
|
"type": "string",
|
|
30032
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30036
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30033
30037
|
"readOnly": true
|
|
30034
30038
|
},
|
|
30035
30039
|
"createdAt": {
|
|
@@ -30139,7 +30143,7 @@
|
|
|
30139
30143
|
"anyOf": [
|
|
30140
30144
|
{
|
|
30141
30145
|
"title": "Create Booking Base",
|
|
30142
|
-
"description": "Base properties for create booking
|
|
30146
|
+
"description": "Base properties for create booking requests, shared between input and response.\n\nExisting commercial-public selection is unchanged. Commercial-private eligibility additionally requires the booking user's accepted partner-invite access-policy grants for own or shared charge points; other charging authorization cannot replace these grants. Personal charge points are excluded. See the location check booking availability action for the eligibility policy.\n\nIf no candidate can be selected, the created request is rejected. Its persisted rejectionReason can include booking-enabled EVSEs that are not accessible to the user, separately from EVSEs with booking disabled and other selection failures.\n",
|
|
30143
30147
|
"type": "object",
|
|
30144
30148
|
"properties": {
|
|
30145
30149
|
"id": {
|
|
@@ -30166,7 +30170,7 @@
|
|
|
30166
30170
|
},
|
|
30167
30171
|
"rejectionReason": {
|
|
30168
30172
|
"type": "string",
|
|
30169
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30173
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30170
30174
|
"readOnly": true
|
|
30171
30175
|
},
|
|
30172
30176
|
"createdAt": {
|
|
@@ -30181,7 +30185,7 @@
|
|
|
30181
30185
|
},
|
|
30182
30186
|
"userId": {
|
|
30183
30187
|
"type": "integer",
|
|
30184
|
-
"description": "ID of the user
|
|
30188
|
+
"description": "ID of the booking user, who must be visible to the requesting admin. This user's accepted partner-invite access-policy grants determine commercial-private booking eligibility; commercial-public selection remains unchanged."
|
|
30185
30189
|
},
|
|
30186
30190
|
"locationId": {
|
|
30187
30191
|
"type": "integer",
|
|
@@ -30204,7 +30208,7 @@
|
|
|
30204
30208
|
},
|
|
30205
30209
|
"evseId": {
|
|
30206
30210
|
"type": "integer",
|
|
30207
|
-
"description": "Specific EVSE ID to book.\n\nResponse behavior: Only present when a specific EVSE was requested. Omitted when EVSE selection was based on criteria or left to the system.\n"
|
|
30211
|
+
"description": "Specific EVSE ID to book. The reference must be visible to the requesting admin and belong to the requested location. A valid commercial-private reference still requires the booking user's private eligibility; lack of that eligibility is a business rejection, not an unknown-reference validation error.\n\nResponse behavior: Only present when a specific EVSE was requested. Omitted when EVSE selection was based on criteria or left to the system.\n"
|
|
30208
30212
|
},
|
|
30209
30213
|
"evseCriteria": {
|
|
30210
30214
|
"type": "object",
|
|
@@ -30376,7 +30380,7 @@
|
|
|
30376
30380
|
},
|
|
30377
30381
|
{
|
|
30378
30382
|
"title": "Update Booking Base",
|
|
30379
|
-
"description": "Base properties for update booking
|
|
30383
|
+
"description": "Base properties for update booking requests, shared between input and response.\n\nAccess is evaluated for the resulting booking user and time slot at the booking's location. Omitting userId retains the current user. The supported update input does not carry evseId, evseCriteria or parkingSpaceCriteria from the original create request; original create criteria are not reapplied by this input.\n\nWhen no candidate remains, the request is rejected for lack of user access if a caller-visible, booking-enabled, access-excluded commercial-private EVSE satisfies the effective update selection requirements. This access attribution is independent of occupancy. Other empty selection results retain the time-slot-unavailable rejection. A successful selection takes precedence over these rejection reasons.\n\nAn access rejection persists the booking request with status \"rejected\" and rejectionReason \"The booking cannot be updated because the user has no access to a bookable EVSE at the location.\" The existing booking's user, held EVSEs, dates, reservation and reservation cycle remain unchanged.\n",
|
|
30380
30384
|
"type": "object",
|
|
30381
30385
|
"properties": {
|
|
30382
30386
|
"id": {
|
|
@@ -30403,7 +30407,7 @@
|
|
|
30403
30407
|
},
|
|
30404
30408
|
"rejectionReason": {
|
|
30405
30409
|
"type": "string",
|
|
30406
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30410
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30407
30411
|
"readOnly": true
|
|
30408
30412
|
},
|
|
30409
30413
|
"createdAt": {
|
|
@@ -30422,7 +30426,7 @@
|
|
|
30422
30426
|
},
|
|
30423
30427
|
"userId": {
|
|
30424
30428
|
"type": "integer",
|
|
30425
|
-
"description": "ID of the user for
|
|
30429
|
+
"description": "ID of the proposed booking user, who must be visible to the requesting admin. Access is evaluated for this resulting user; when omitted, the booking's current user is retained and evaluated. A rejected update does not change the booking's user."
|
|
30426
30430
|
},
|
|
30427
30431
|
"externalId": {
|
|
30428
30432
|
"type": "string",
|
|
@@ -30517,7 +30521,7 @@
|
|
|
30517
30521
|
},
|
|
30518
30522
|
"rejectionReason": {
|
|
30519
30523
|
"type": "string",
|
|
30520
|
-
"description": "Human-readable reason for rejection.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30524
|
+
"description": "Human-readable business rejection reason, persisted with the booking request and returned by its listing and read operations. Access-related rejections use this existing property, not a separate error code. See the create and update request schema descriptions for access-rejection conditions.\n\nResponse behavior: Only present when status is \"rejected\". Omitted for \"pending\" and \"approved\" requests.\n",
|
|
30521
30525
|
"readOnly": true
|
|
30522
30526
|
},
|
|
30523
30527
|
"createdAt": {
|
|
@@ -30686,14 +30690,15 @@
|
|
|
30686
30690
|
},
|
|
30687
30691
|
"failureReason": {
|
|
30688
30692
|
"readOnly": true,
|
|
30689
|
-
"description": "Recorded cause of a failed booking:\n- **request_not_processed**: The booking request could not be processed.\n- **booking_holds_no_evse**: The booking had no EVSE candidates to reserve.\n- **evse_occupied_or_reserved**: The EVSE was occupied or already reserved.\n- **charge_point_rejected_or_unresponsive**: The charge point rejected the reservation or was unresponsive.\n- **could_not_be_reserved**: The booking could not be reserved without an established more specific cause, including overdue recovery.\n\nIntegrations must tolerate future unknown values as new failure reasons may be added.\n",
|
|
30693
|
+
"description": "Recorded cause of a failed booking:\n- **request_not_processed**: The booking request could not be processed.\n- **booking_holds_no_evse**: The booking had no EVSE candidates to reserve.\n- **evse_occupied_or_reserved**: The EVSE was occupied or already reserved.\n- **charge_point_rejected_or_unresponsive**: The charge point rejected the reservation or was unresponsive.\n- **could_not_be_reserved**: The booking could not be reserved without an established more specific cause, including overdue recovery.\n- **user_no_longer_has_access**: At reservation time, the booking user no longer had access to any held EVSE. Inaccessible candidates are skipped; if none remain accessible, the accepted booking fails immediately. Revocation does not cancel an already reserved booking.\n\nIntegrations must tolerate future unknown values as new failure reasons may be added.\n",
|
|
30690
30694
|
"type": "string",
|
|
30691
30695
|
"enum": [
|
|
30692
30696
|
"request_not_processed",
|
|
30693
30697
|
"booking_holds_no_evse",
|
|
30694
30698
|
"evse_occupied_or_reserved",
|
|
30695
30699
|
"charge_point_rejected_or_unresponsive",
|
|
30696
|
-
"could_not_be_reserved"
|
|
30700
|
+
"could_not_be_reserved",
|
|
30701
|
+
"user_no_longer_has_access"
|
|
30697
30702
|
],
|
|
30698
30703
|
"example": "evse_occupied_or_reserved"
|
|
30699
30704
|
},
|
|
@@ -30932,14 +30937,15 @@
|
|
|
30932
30937
|
},
|
|
30933
30938
|
"failureReason": {
|
|
30934
30939
|
"readOnly": true,
|
|
30935
|
-
"description": "Recorded cause of a failed booking:\n- **request_not_processed**: The booking request could not be processed.\n- **booking_holds_no_evse**: The booking had no EVSE candidates to reserve.\n- **evse_occupied_or_reserved**: The EVSE was occupied or already reserved.\n- **charge_point_rejected_or_unresponsive**: The charge point rejected the reservation or was unresponsive.\n- **could_not_be_reserved**: The booking could not be reserved without an established more specific cause, including overdue recovery.\n\nIntegrations must tolerate future unknown values as new failure reasons may be added.\n",
|
|
30940
|
+
"description": "Recorded cause of a failed booking:\n- **request_not_processed**: The booking request could not be processed.\n- **booking_holds_no_evse**: The booking had no EVSE candidates to reserve.\n- **evse_occupied_or_reserved**: The EVSE was occupied or already reserved.\n- **charge_point_rejected_or_unresponsive**: The charge point rejected the reservation or was unresponsive.\n- **could_not_be_reserved**: The booking could not be reserved without an established more specific cause, including overdue recovery.\n- **user_no_longer_has_access**: At reservation time, the booking user no longer had access to any held EVSE. Inaccessible candidates are skipped; if none remain accessible, the accepted booking fails immediately. Revocation does not cancel an already reserved booking.\n\nIntegrations must tolerate future unknown values as new failure reasons may be added.\n",
|
|
30936
30941
|
"type": "string",
|
|
30937
30942
|
"enum": [
|
|
30938
30943
|
"request_not_processed",
|
|
30939
30944
|
"booking_holds_no_evse",
|
|
30940
30945
|
"evse_occupied_or_reserved",
|
|
30941
30946
|
"charge_point_rejected_or_unresponsive",
|
|
30942
|
-
"could_not_be_reserved"
|
|
30947
|
+
"could_not_be_reserved",
|
|
30948
|
+
"user_no_longer_has_access"
|
|
30943
30949
|
],
|
|
30944
30950
|
"example": "evse_occupied_or_reserved"
|
|
30945
30951
|
},
|
|
@@ -82368,6 +82374,10 @@
|
|
|
82368
82374
|
],
|
|
82369
82375
|
"type": "object",
|
|
82370
82376
|
"properties": {
|
|
82377
|
+
"averagePrice": {
|
|
82378
|
+
"type": "number",
|
|
82379
|
+
"description": "Stored average charging price in the location operator's currency. Stored prices are returned unchanged, including historical values beyond the currency's current unit-price precision. Reads do not apply write validation. Zero indicates free charging. Omitted when no average price is set."
|
|
82380
|
+
},
|
|
82371
82381
|
"id": {
|
|
82372
82382
|
"type": "integer",
|
|
82373
82383
|
"readOnly": true
|
|
@@ -83695,6 +83705,10 @@
|
|
|
83695
83705
|
],
|
|
83696
83706
|
"type": "object",
|
|
83697
83707
|
"properties": {
|
|
83708
|
+
"averagePrice": {
|
|
83709
|
+
"type": "number",
|
|
83710
|
+
"description": "Stored average charging price in the location operator's currency. Stored prices are returned unchanged, including historical values beyond the currency's current unit-price precision. Reads do not apply write validation. Zero indicates free charging. Omitted when no average price is set."
|
|
83711
|
+
},
|
|
83698
83712
|
"id": {
|
|
83699
83713
|
"type": "integer",
|
|
83700
83714
|
"readOnly": true
|
|
@@ -84995,6 +85009,10 @@
|
|
|
84995
85009
|
],
|
|
84996
85010
|
"type": "object",
|
|
84997
85011
|
"properties": {
|
|
85012
|
+
"averagePrice": {
|
|
85013
|
+
"type": "number",
|
|
85014
|
+
"description": "Stored average charging price in the location operator's currency. Stored prices are returned unchanged, including historical values beyond the currency's current unit-price precision. Reads do not apply write validation. Zero indicates free charging. Omitted when no average price is set."
|
|
85015
|
+
},
|
|
84998
85016
|
"id": {
|
|
84999
85017
|
"type": "integer",
|
|
85000
85018
|
"readOnly": true
|
|
@@ -86338,6 +86356,10 @@
|
|
|
86338
86356
|
],
|
|
86339
86357
|
"type": "object",
|
|
86340
86358
|
"properties": {
|
|
86359
|
+
"averagePrice": {
|
|
86360
|
+
"type": "number",
|
|
86361
|
+
"description": "Stored average charging price in the location operator's currency. Stored prices are returned unchanged, including historical values beyond the currency's current unit-price precision. Reads do not apply write validation. Zero indicates free charging. Omitted when no average price is set."
|
|
86362
|
+
},
|
|
86341
86363
|
"id": {
|
|
86342
86364
|
"type": "integer",
|
|
86343
86365
|
"readOnly": true
|
|
@@ -88819,7 +88841,7 @@
|
|
|
88819
88841
|
]
|
|
88820
88842
|
},
|
|
88821
88843
|
"failureReason": {
|
|
88822
|
-
"description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**:
|
|
88844
|
+
"description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_disabled**: Corporate billing is switched off for the partner or the driver's accepted invite\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**: Legacy corporate-account refusal value retained for historical records; newly detected disabled billing uses corporate_billing_disabled\n- **corporate_billing_currency_mismatch**: The session currency differs from the corporate billing currency\n- **corporate_billing_cross_operator_not_opted_in**: The operator serving the session is not opted in to the partner's cross-operator corporate billing\n- **corporate_billing_exchange_rate_unavailable**: No exchange rate is available to convert the session amount into the corporate billing currency\n- **corporate_billing_charger_type_not_covered**: The charger type is not covered by the corporate billing policy\n- **corporate_billing_partner_not_covered**: The partner is not covered by the corporate billing policy\n- **corporate_billing_country_not_covered**: The country is not covered by the corporate billing policy\n- **corporate_billing_location_not_covered**: The location is not covered by the corporate billing policy\n- **corporate_billing_location_tag_not_covered**: The location tag is not covered by the corporate billing policy\n- **corporate_billing_roaming_not_covered**: Roaming is not covered by the corporate billing policy\n\nTariffs:\n- **tariff_charging_not_allowed**: The applicable tariff does not allow charging\n- **no_tariff_group_configured**: No tariff group is configured for the charge point\n- **tariff_resolution_failed**: No tariff could be resolved for the requested charging\n\nCharge point and EVSE state:\n- **evse_disabled**: The requested EVSE is disabled\n- **evse_out_of_order**: The requested EVSE is out of order\n- **evse_occupied**: The requested EVSE is already in use\n- **evse_inoperative**: The requested EVSE is not operational\n- **evse_has_queued_reservations**: The requested EVSE has queued reservations\n- **ev_not_connected_to_evse**: No vehicle is connected to the requested EVSE\n- **session_already_running**: A charging session is already running\n\nRFID tokens:\n- **rfid_tag_expired**: The RFID tag has expired\n- **rfid_tag_disabled**: The RFID tag is disabled\n- **rfid_tag_suspended**: The RFID tag is suspended\n- **rfid_charge_point_scope_mismatch**: The RFID tag may not be used on the requested charge point\n\nRoaming setup:\n- **ocpi_roaming_not_setup**: The OCPI roaming configuration needed to serve the command is missing\n- **internal_roaming_not_setup**: The internal roaming configuration needed to serve the command is missing\n\nCommand execution:\n- **remote_start_failed**: The charge point refused or failed the remote start\n- **rejected**: The charge point rejected the command\n- **failed**: The command failed while it was being executed\n- **not_supported**: The command is not supported for the requested charge point\n- **timeout**: The charge point did not respond within the command timeout\n- **command_expired**: The command was no longer valid by the time it could be executed\n- **unknown_session**: The referenced charging session is unknown to the platform\n- **unknown_reservation**: The referenced reservation is unknown to the platform\n- **canceled_reservation**: The reservation was cancelled instead of being honoured\n",
|
|
88823
88845
|
"type": "string",
|
|
88824
88846
|
"enum": [
|
|
88825
88847
|
"charging_not_allowed",
|
|
@@ -88833,6 +88855,7 @@
|
|
|
88833
88855
|
"previous_session_not_paid",
|
|
88834
88856
|
"unpaid_subscription_fees",
|
|
88835
88857
|
"payment_method_required",
|
|
88858
|
+
"corporate_billing_disabled",
|
|
88836
88859
|
"corporate_billing_policy_inactive",
|
|
88837
88860
|
"corporate_billing_limit_exceeded",
|
|
88838
88861
|
"corporate_account_limit_reached",
|
|
@@ -89067,7 +89090,7 @@
|
|
|
89067
89090
|
]
|
|
89068
89091
|
},
|
|
89069
89092
|
"failureReason": {
|
|
89070
|
-
"description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**:
|
|
89093
|
+
"description": "The reason a command did not succeed:\n\nAuthorization and access:\n- **charging_not_allowed**: Charging is not allowed for the authorizing token\n- **location_is_closed**: The location was closed when the command was received\n- **access_restricted**: Access to the charge point is restricted for the authorizing token\n- **user_verification_not_complete**: The user behind the token has not completed verification\n- **terms_not_accepted**: The user has not accepted the required terms and policies\n- **user_is_disabled**: The user account is disabled\n- **authorization_failed**: The authorization of the token was refused\n- **pre_authorization_failed**: The payment pre-authorization for the session failed\n- **token_not_authorized_for_booking**: The token is not authorized to book the requested EVSE\n- **operator_in_migration_mode**: The operator is in migration mode and does not accept new charging\n\nPayment, subscription and billing:\n- **subscription_required**: A subscription plan is required to start charging\n- **unpaid_subscription_fees**: The user has unpaid subscription fees\n- **previous_session_not_paid**: An earlier session of the user is still unpaid\n- **payment_method_required**: The user has no payment method that can be charged\n- **payment_method_expired**: The user's payment method has expired\n- **payment_method_not_allowed**: The user's payment method is not allowed for this charge point\n- **payment_method_doesnt_have_sufficient_funds**: The user's payment method has insufficient funds\n- **cannot_bill_payment_method**: The user's payment method could not be billed\n- **invalid_payment_method_for_direct_charges**: The user's payment method cannot be used for direct charges\n- **user_invoice_details_not_provided**: The user has not provided the invoice details required to be billed\n\nCorporate billing:\n- **corporate_billing_disabled**: Corporate billing is switched off for the partner or the driver's accepted invite\n- **corporate_billing_policy_inactive**: The corporate billing policy is not active\n- **corporate_billing_limit_exceeded**: The corporate billing policy limit is exceeded\n- **corporate_account_limit_reached**: Legacy corporate-account refusal value retained for historical records; newly detected disabled billing uses corporate_billing_disabled\n- **corporate_billing_currency_mismatch**: The session currency differs from the corporate billing currency\n- **corporate_billing_cross_operator_not_opted_in**: The operator serving the session is not opted in to the partner's cross-operator corporate billing\n- **corporate_billing_exchange_rate_unavailable**: No exchange rate is available to convert the session amount into the corporate billing currency\n- **corporate_billing_charger_type_not_covered**: The charger type is not covered by the corporate billing policy\n- **corporate_billing_partner_not_covered**: The partner is not covered by the corporate billing policy\n- **corporate_billing_country_not_covered**: The country is not covered by the corporate billing policy\n- **corporate_billing_location_not_covered**: The location is not covered by the corporate billing policy\n- **corporate_billing_location_tag_not_covered**: The location tag is not covered by the corporate billing policy\n- **corporate_billing_roaming_not_covered**: Roaming is not covered by the corporate billing policy\n\nTariffs:\n- **tariff_charging_not_allowed**: The applicable tariff does not allow charging\n- **no_tariff_group_configured**: No tariff group is configured for the charge point\n- **tariff_resolution_failed**: No tariff could be resolved for the requested charging\n\nCharge point and EVSE state:\n- **evse_disabled**: The requested EVSE is disabled\n- **evse_out_of_order**: The requested EVSE is out of order\n- **evse_occupied**: The requested EVSE is already in use\n- **evse_inoperative**: The requested EVSE is not operational\n- **evse_has_queued_reservations**: The requested EVSE has queued reservations\n- **ev_not_connected_to_evse**: No vehicle is connected to the requested EVSE\n- **session_already_running**: A charging session is already running\n\nRFID tokens:\n- **rfid_tag_expired**: The RFID tag has expired\n- **rfid_tag_disabled**: The RFID tag is disabled\n- **rfid_tag_suspended**: The RFID tag is suspended\n- **rfid_charge_point_scope_mismatch**: The RFID tag may not be used on the requested charge point\n\nRoaming setup:\n- **ocpi_roaming_not_setup**: The OCPI roaming configuration needed to serve the command is missing\n- **internal_roaming_not_setup**: The internal roaming configuration needed to serve the command is missing\n\nCommand execution:\n- **remote_start_failed**: The charge point refused or failed the remote start\n- **rejected**: The charge point rejected the command\n- **failed**: The command failed while it was being executed\n- **not_supported**: The command is not supported for the requested charge point\n- **timeout**: The charge point did not respond within the command timeout\n- **command_expired**: The command was no longer valid by the time it could be executed\n- **unknown_session**: The referenced charging session is unknown to the platform\n- **unknown_reservation**: The referenced reservation is unknown to the platform\n- **canceled_reservation**: The reservation was cancelled instead of being honoured\n",
|
|
89071
89094
|
"type": "string",
|
|
89072
89095
|
"enum": [
|
|
89073
89096
|
"charging_not_allowed",
|
|
@@ -89081,6 +89104,7 @@
|
|
|
89081
89104
|
"previous_session_not_paid",
|
|
89082
89105
|
"unpaid_subscription_fees",
|
|
89083
89106
|
"payment_method_required",
|
|
89107
|
+
"corporate_billing_disabled",
|
|
89084
89108
|
"corporate_billing_policy_inactive",
|
|
89085
89109
|
"corporate_billing_limit_exceeded",
|
|
89086
89110
|
"corporate_account_limit_reached",
|
|
@@ -93087,6 +93111,13 @@
|
|
|
93087
93111
|
"revenueSharing": {
|
|
93088
93112
|
"type": "object",
|
|
93089
93113
|
"properties": {
|
|
93114
|
+
"partnerSharePercentagePrivateEvseAccessFees": {
|
|
93115
|
+
"type": "number",
|
|
93116
|
+
"format": "float",
|
|
93117
|
+
"minimum": 0,
|
|
93118
|
+
"maximum": 100,
|
|
93119
|
+
"description": "The partner's share of the revenue from private EVSE access fees from other partners given access to this partner's commercial private charge points. Omit the property to leave the share unconfigured."
|
|
93120
|
+
},
|
|
93090
93121
|
"partnerSharePercentageAcEvse": {
|
|
93091
93122
|
"type": "number",
|
|
93092
93123
|
"format": "float",
|
|
@@ -93150,6 +93181,12 @@
|
|
|
93150
93181
|
"monthlyPlatformFees": {
|
|
93151
93182
|
"type": "object",
|
|
93152
93183
|
"properties": {
|
|
93184
|
+
"perPrivateEvseOfOtherPartners": {
|
|
93185
|
+
"type": "number",
|
|
93186
|
+
"format": "float",
|
|
93187
|
+
"minimum": 0,
|
|
93188
|
+
"description": "Fee per EVSE, without tax, of commercial private charge points of other partners to which this partner is given access. Omit the property to leave the fee unconfigured."
|
|
93189
|
+
},
|
|
93153
93190
|
"perChargePoint": {
|
|
93154
93191
|
"type": "number",
|
|
93155
93192
|
"format": "float",
|
|
@@ -93520,6 +93557,13 @@
|
|
|
93520
93557
|
"revenueSharing": {
|
|
93521
93558
|
"type": "object",
|
|
93522
93559
|
"properties": {
|
|
93560
|
+
"partnerSharePercentagePrivateEvseAccessFees": {
|
|
93561
|
+
"type": "number",
|
|
93562
|
+
"format": "float",
|
|
93563
|
+
"minimum": 0,
|
|
93564
|
+
"maximum": 100,
|
|
93565
|
+
"description": "The partner's share of the revenue from private EVSE access fees from other partners given access to this partner's commercial private charge points. Omit the property to leave the share unconfigured."
|
|
93566
|
+
},
|
|
93523
93567
|
"partnerSharePercentageAcEvse": {
|
|
93524
93568
|
"type": "number",
|
|
93525
93569
|
"format": "float",
|
|
@@ -93583,6 +93627,12 @@
|
|
|
93583
93627
|
"monthlyPlatformFees": {
|
|
93584
93628
|
"type": "object",
|
|
93585
93629
|
"properties": {
|
|
93630
|
+
"perPrivateEvseOfOtherPartners": {
|
|
93631
|
+
"type": "number",
|
|
93632
|
+
"format": "float",
|
|
93633
|
+
"minimum": 0,
|
|
93634
|
+
"description": "Fee per EVSE, without tax, of commercial private charge points of other partners to which this partner is given access. Omit the property to leave the fee unconfigured."
|
|
93635
|
+
},
|
|
93586
93636
|
"perChargePoint": {
|
|
93587
93637
|
"type": "number",
|
|
93588
93638
|
"format": "float",
|
|
@@ -93860,334 +93910,13 @@
|
|
|
93860
93910
|
"revenueSharing": {
|
|
93861
93911
|
"type": "object",
|
|
93862
93912
|
"properties": {
|
|
93863
|
-
"
|
|
93864
|
-
"type": "number",
|
|
93865
|
-
"format": "float",
|
|
93866
|
-
"minimum": 0,
|
|
93867
|
-
"maximum": 100,
|
|
93868
|
-
"description": "Applied to the session amount without tax, after any session fees and electricity cost are deducted."
|
|
93869
|
-
},
|
|
93870
|
-
"partnerSharePercentageDcEvse": {
|
|
93913
|
+
"partnerSharePercentagePrivateEvseAccessFees": {
|
|
93871
93914
|
"type": "number",
|
|
93872
93915
|
"format": "float",
|
|
93873
93916
|
"minimum": 0,
|
|
93874
93917
|
"maximum": 100,
|
|
93875
|
-
"description": "
|
|
93876
|
-
},
|
|
93877
|
-
"excludeConnectionFee": {
|
|
93878
|
-
"type": "boolean",
|
|
93879
|
-
"description": "If true and the tariff has a connection fee, the partner receives no share of it and the operator keeps it in full. The connection fee excluded is the amount without tax."
|
|
93880
|
-
},
|
|
93881
|
-
"deductElectricityCost": {
|
|
93882
|
-
"type": "boolean",
|
|
93883
|
-
"description": "The electricity cost without tax is deducted from the session amount, together with the session fees, before the partner's share is calculated."
|
|
93884
|
-
},
|
|
93885
|
-
"reimburseForElectricityCost": {
|
|
93886
|
-
"type": "boolean",
|
|
93887
|
-
"description": "If true, the partner also receives the electricity cost. The partner receives (Revenue − Deducted fees − Electricity cost) × Partner percentage + Electricity cost, where revenue and electricity cost are the amounts without tax and deducted fees are the fixed fee per session, the fee per kWh and the handling fee. It can be supplied only if `deductElectricityCost` is true."
|
|
93888
|
-
},
|
|
93889
|
-
"fixedFeePerSessionAc": {
|
|
93890
|
-
"type": "number",
|
|
93891
|
-
"format": "float",
|
|
93892
|
-
"nullable": true,
|
|
93893
|
-
"description": "Flat fee without tax for every billed session on an AC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
93894
|
-
},
|
|
93895
|
-
"fixedFeePerSessionDc": {
|
|
93896
|
-
"type": "number",
|
|
93897
|
-
"format": "float",
|
|
93898
|
-
"nullable": true,
|
|
93899
|
-
"description": "Flat fee without tax for every billed session on a DC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
93900
|
-
},
|
|
93901
|
-
"feePerKwhAc": {
|
|
93902
|
-
"type": "number",
|
|
93903
|
-
"format": "float",
|
|
93904
|
-
"nullable": true,
|
|
93905
|
-
"description": "Flat fee without tax for every billed kWh on an AC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
93906
|
-
},
|
|
93907
|
-
"feePerKwhDc": {
|
|
93908
|
-
"type": "number",
|
|
93909
|
-
"format": "float",
|
|
93910
|
-
"nullable": true,
|
|
93911
|
-
"description": "Flat fee without tax for every billed kWh on a DC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
93918
|
+
"description": "The partner's share of the revenue from private EVSE access fees from other partners given access to this partner's commercial private charge points. Omit the property to leave the share unconfigured."
|
|
93912
93919
|
},
|
|
93913
|
-
"handlingFee": {
|
|
93914
|
-
"type": "number",
|
|
93915
|
-
"format": "float",
|
|
93916
|
-
"minimum": 0,
|
|
93917
|
-
"maximum": 100,
|
|
93918
|
-
"nullable": true,
|
|
93919
|
-
"description": "A percentage of the total amount the user paid for the session, including tax. It is taken off the session amount before the partner's share is calculated."
|
|
93920
|
-
}
|
|
93921
|
-
}
|
|
93922
|
-
},
|
|
93923
|
-
"monthlyPlatformFees": {
|
|
93924
|
-
"type": "object",
|
|
93925
|
-
"properties": {
|
|
93926
|
-
"perChargePoint": {
|
|
93927
|
-
"type": "number",
|
|
93928
|
-
"format": "float",
|
|
93929
|
-
"description": "The amount without tax."
|
|
93930
|
-
},
|
|
93931
|
-
"perAcEvse": {
|
|
93932
|
-
"type": "number",
|
|
93933
|
-
"format": "float",
|
|
93934
|
-
"description": "The amount without tax."
|
|
93935
|
-
},
|
|
93936
|
-
"perDcEvse": {
|
|
93937
|
-
"type": "number",
|
|
93938
|
-
"format": "float",
|
|
93939
|
-
"description": "The amount without tax."
|
|
93940
|
-
}
|
|
93941
|
-
}
|
|
93942
|
-
},
|
|
93943
|
-
"reimbursementFees": {
|
|
93944
|
-
"type": "object",
|
|
93945
|
-
"description": "Home-charging reimbursement fees configured on the contract itself and charged to the partner for reimbursed charging sessions and reimbursement periods. Only available when the home-charging reimbursement feature is enabled for the operator. All other home-charging reimbursement settings are managed on the partner resource.\n",
|
|
93946
|
-
"properties": {
|
|
93947
|
-
"perSession": {
|
|
93948
|
-
"type": "number",
|
|
93949
|
-
"format": "float",
|
|
93950
|
-
"minimum": 0,
|
|
93951
|
-
"description": "Flat fee charged for every reimbursed charging session, in the contract's currency."
|
|
93952
|
-
},
|
|
93953
|
-
"perPeriod": {
|
|
93954
|
-
"type": "number",
|
|
93955
|
-
"format": "float",
|
|
93956
|
-
"minimum": 0,
|
|
93957
|
-
"description": "Flat fee charged for every reimbursement period, in the contract's currency."
|
|
93958
|
-
}
|
|
93959
|
-
}
|
|
93960
|
-
},
|
|
93961
|
-
"lastUpdatedAt": {
|
|
93962
|
-
"type": "string",
|
|
93963
|
-
"format": "date-time",
|
|
93964
|
-
"description": "ISO 8601 formatted date",
|
|
93965
|
-
"readOnly": true
|
|
93966
|
-
},
|
|
93967
|
-
"settlementOverrides": {
|
|
93968
|
-
"type": "array",
|
|
93969
|
-
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
93970
|
-
"items": {
|
|
93971
|
-
"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.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
93972
|
-
"type": "object",
|
|
93973
|
-
"required": [
|
|
93974
|
-
"id",
|
|
93975
|
-
"name",
|
|
93976
|
-
"priority",
|
|
93977
|
-
"restriction",
|
|
93978
|
-
"acPercent",
|
|
93979
|
-
"dcPercent"
|
|
93980
|
-
],
|
|
93981
|
-
"properties": {
|
|
93982
|
-
"name": {
|
|
93983
|
-
"type": "string",
|
|
93984
|
-
"maxLength": 255,
|
|
93985
|
-
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
93986
|
-
"example": "Fleet drivers"
|
|
93987
|
-
},
|
|
93988
|
-
"priority": {
|
|
93989
|
-
"type": "integer",
|
|
93990
|
-
"minimum": 1,
|
|
93991
|
-
"maximum": 4294967295,
|
|
93992
|
-
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
93993
|
-
"example": 1
|
|
93994
|
-
},
|
|
93995
|
-
"id": {
|
|
93996
|
-
"type": "integer",
|
|
93997
|
-
"description": "Unique identifier for the settlement override",
|
|
93998
|
-
"example": 123
|
|
93999
|
-
},
|
|
94000
|
-
"restriction": {
|
|
94001
|
-
"type": "object",
|
|
94002
|
-
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
94003
|
-
"required": [
|
|
94004
|
-
"type"
|
|
94005
|
-
],
|
|
94006
|
-
"properties": {
|
|
94007
|
-
"type": {
|
|
94008
|
-
"type": "string",
|
|
94009
|
-
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
94010
|
-
"enum": [
|
|
94011
|
-
"users_of_the_partner",
|
|
94012
|
-
"user_groups",
|
|
94013
|
-
"ad_hoc_users",
|
|
94014
|
-
"users_of_specific_partners"
|
|
94015
|
-
]
|
|
94016
|
-
},
|
|
94017
|
-
"targetIds": {
|
|
94018
|
-
"type": "array",
|
|
94019
|
-
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
94020
|
-
"items": {
|
|
94021
|
-
"type": "integer"
|
|
94022
|
-
},
|
|
94023
|
-
"example": [
|
|
94024
|
-
12,
|
|
94025
|
-
34
|
|
94026
|
-
]
|
|
94027
|
-
}
|
|
94028
|
-
}
|
|
94029
|
-
},
|
|
94030
|
-
"acPercent": {
|
|
94031
|
-
"type": "number",
|
|
94032
|
-
"format": "float",
|
|
94033
|
-
"nullable": true,
|
|
94034
|
-
"minimum": 0,
|
|
94035
|
-
"maximum": 100,
|
|
94036
|
-
"description": "Partner share percentage applied to AC sessions matched by this override.\nApplied to the session amount without tax, after any session fees and electricity\ncost are deducted.\n`null` means the value is inherited from the partner contract.\n",
|
|
94037
|
-
"example": 70.5
|
|
94038
|
-
},
|
|
94039
|
-
"dcPercent": {
|
|
94040
|
-
"type": "number",
|
|
94041
|
-
"format": "float",
|
|
94042
|
-
"nullable": true,
|
|
94043
|
-
"minimum": 0,
|
|
94044
|
-
"maximum": 100,
|
|
94045
|
-
"description": "Partner share percentage applied to DC sessions matched by this override.\nApplied to the session amount without tax, after any session fees and electricity\ncost are deducted.\n`null` means the value is inherited from the partner contract.\n",
|
|
94046
|
-
"example": 60
|
|
94047
|
-
}
|
|
94048
|
-
}
|
|
94049
|
-
}
|
|
94050
|
-
}
|
|
94051
|
-
},
|
|
94052
|
-
"required": [
|
|
94053
|
-
"id",
|
|
94054
|
-
"operatorId",
|
|
94055
|
-
"title",
|
|
94056
|
-
"partnerId",
|
|
94057
|
-
"startDate"
|
|
94058
|
-
]
|
|
94059
|
-
}
|
|
94060
|
-
}
|
|
94061
|
-
}
|
|
94062
|
-
},
|
|
94063
|
-
"401": {
|
|
94064
|
-
"schema": {
|
|
94065
|
-
"type": "object",
|
|
94066
|
-
"properties": {
|
|
94067
|
-
"message": {
|
|
94068
|
-
"type": "string"
|
|
94069
|
-
}
|
|
94070
|
-
}
|
|
94071
|
-
}
|
|
94072
|
-
},
|
|
94073
|
-
"403": {
|
|
94074
|
-
"schema": {
|
|
94075
|
-
"type": "object",
|
|
94076
|
-
"properties": {
|
|
94077
|
-
"message": {
|
|
94078
|
-
"type": "string",
|
|
94079
|
-
"default": "This action is unauthorized."
|
|
94080
|
-
}
|
|
94081
|
-
}
|
|
94082
|
-
}
|
|
94083
|
-
},
|
|
94084
|
-
"404": {
|
|
94085
|
-
"schema": {
|
|
94086
|
-
"type": "object",
|
|
94087
|
-
"properties": {
|
|
94088
|
-
"message": {
|
|
94089
|
-
"type": "string"
|
|
94090
|
-
}
|
|
94091
|
-
}
|
|
94092
|
-
}
|
|
94093
|
-
},
|
|
94094
|
-
"429": {
|
|
94095
|
-
"schema": {
|
|
94096
|
-
"type": "object",
|
|
94097
|
-
"properties": {
|
|
94098
|
-
"message": {
|
|
94099
|
-
"type": "string"
|
|
94100
|
-
}
|
|
94101
|
-
}
|
|
94102
|
-
}
|
|
94103
|
-
}
|
|
94104
|
-
},
|
|
94105
|
-
"partnerContractUpdate": {
|
|
94106
|
-
"200": {
|
|
94107
|
-
"schema": {
|
|
94108
|
-
"type": "object",
|
|
94109
|
-
"properties": {
|
|
94110
|
-
"data": {
|
|
94111
|
-
"type": "object",
|
|
94112
|
-
"properties": {
|
|
94113
|
-
"id": {
|
|
94114
|
-
"type": "integer",
|
|
94115
|
-
"readOnly": true
|
|
94116
|
-
},
|
|
94117
|
-
"operatorId": {
|
|
94118
|
-
"type": "integer",
|
|
94119
|
-
"description": "The ID of the operator this resource belongs to",
|
|
94120
|
-
"example": 1
|
|
94121
|
-
},
|
|
94122
|
-
"title": {
|
|
94123
|
-
"type": "string"
|
|
94124
|
-
},
|
|
94125
|
-
"partnerId": {
|
|
94126
|
-
"type": "integer"
|
|
94127
|
-
},
|
|
94128
|
-
"contractType": {
|
|
94129
|
-
"type": "string",
|
|
94130
|
-
"enum": [
|
|
94131
|
-
"revenueSharing",
|
|
94132
|
-
"paymentFacilitation"
|
|
94133
|
-
],
|
|
94134
|
-
"description": "Indicates the business relationship model for the contract. `revenueSharing` means the operator is the supplier and remits a share to the partner. `paymentFacilitation` means the partner is the supplier and the operator acts as payment facilitator."
|
|
94135
|
-
},
|
|
94136
|
-
"startDate": {
|
|
94137
|
-
"type": "string",
|
|
94138
|
-
"format": "date-time",
|
|
94139
|
-
"description": "The contract is effective from the first of the selected month."
|
|
94140
|
-
},
|
|
94141
|
-
"endDate": {
|
|
94142
|
-
"type": "string",
|
|
94143
|
-
"format": "date-time",
|
|
94144
|
-
"nullable": true,
|
|
94145
|
-
"description": "The contract expires at the last day of the selected month. If nothing is selected, there is no expiration date."
|
|
94146
|
-
},
|
|
94147
|
-
"autoRenewal": {
|
|
94148
|
-
"type": "boolean"
|
|
94149
|
-
},
|
|
94150
|
-
"externalId": {
|
|
94151
|
-
"type": "string",
|
|
94152
|
-
"description": "Used to store custom information, usually used for external references or metadata to the resource.",
|
|
94153
|
-
"maxLength": 255
|
|
94154
|
-
},
|
|
94155
|
-
"accessAndPermissions": {
|
|
94156
|
-
"type": "object",
|
|
94157
|
-
"properties": {
|
|
94158
|
-
"sessionsRemoteControl": {
|
|
94159
|
-
"type": "boolean",
|
|
94160
|
-
"description": "Allows the partner to start/stop session, unlock connector, trigger message, set a charging profile and get the composite schedule."
|
|
94161
|
-
},
|
|
94162
|
-
"startReservation": {
|
|
94163
|
-
"type": "boolean",
|
|
94164
|
-
"description": "Allows the partner to make reservations."
|
|
94165
|
-
},
|
|
94166
|
-
"stopReservation": {
|
|
94167
|
-
"type": "boolean",
|
|
94168
|
-
"description": "Allows the partner to cancel reservations."
|
|
94169
|
-
},
|
|
94170
|
-
"resetChargePoint": {
|
|
94171
|
-
"type": "boolean",
|
|
94172
|
-
"description": "Allows the partner to reset charge points."
|
|
94173
|
-
},
|
|
94174
|
-
"firmwareUpdate": {
|
|
94175
|
-
"type": "boolean",
|
|
94176
|
-
"description": "Allows the partner to make firmware updates to the charge points."
|
|
94177
|
-
},
|
|
94178
|
-
"createFromTemplate": {
|
|
94179
|
-
"type": "boolean",
|
|
94180
|
-
"description": "Allows the partner to create charge points from templates."
|
|
94181
|
-
},
|
|
94182
|
-
"changeSystemStatus": {
|
|
94183
|
-
"type": "boolean",
|
|
94184
|
-
"description": "Allows the partner to change the system status of charge points."
|
|
94185
|
-
}
|
|
94186
|
-
}
|
|
94187
|
-
},
|
|
94188
|
-
"revenueSharing": {
|
|
94189
|
-
"type": "object",
|
|
94190
|
-
"properties": {
|
|
94191
93920
|
"partnerSharePercentageAcEvse": {
|
|
94192
93921
|
"type": "number",
|
|
94193
93922
|
"format": "float",
|
|
@@ -94251,6 +93980,353 @@
|
|
|
94251
93980
|
"monthlyPlatformFees": {
|
|
94252
93981
|
"type": "object",
|
|
94253
93982
|
"properties": {
|
|
93983
|
+
"perPrivateEvseOfOtherPartners": {
|
|
93984
|
+
"type": "number",
|
|
93985
|
+
"format": "float",
|
|
93986
|
+
"minimum": 0,
|
|
93987
|
+
"description": "Fee per EVSE, without tax, of commercial private charge points of other partners to which this partner is given access. Omit the property to leave the fee unconfigured."
|
|
93988
|
+
},
|
|
93989
|
+
"perChargePoint": {
|
|
93990
|
+
"type": "number",
|
|
93991
|
+
"format": "float",
|
|
93992
|
+
"description": "The amount without tax."
|
|
93993
|
+
},
|
|
93994
|
+
"perAcEvse": {
|
|
93995
|
+
"type": "number",
|
|
93996
|
+
"format": "float",
|
|
93997
|
+
"description": "The amount without tax."
|
|
93998
|
+
},
|
|
93999
|
+
"perDcEvse": {
|
|
94000
|
+
"type": "number",
|
|
94001
|
+
"format": "float",
|
|
94002
|
+
"description": "The amount without tax."
|
|
94003
|
+
}
|
|
94004
|
+
}
|
|
94005
|
+
},
|
|
94006
|
+
"reimbursementFees": {
|
|
94007
|
+
"type": "object",
|
|
94008
|
+
"description": "Home-charging reimbursement fees configured on the contract itself and charged to the partner for reimbursed charging sessions and reimbursement periods. Only available when the home-charging reimbursement feature is enabled for the operator. All other home-charging reimbursement settings are managed on the partner resource.\n",
|
|
94009
|
+
"properties": {
|
|
94010
|
+
"perSession": {
|
|
94011
|
+
"type": "number",
|
|
94012
|
+
"format": "float",
|
|
94013
|
+
"minimum": 0,
|
|
94014
|
+
"description": "Flat fee charged for every reimbursed charging session, in the contract's currency."
|
|
94015
|
+
},
|
|
94016
|
+
"perPeriod": {
|
|
94017
|
+
"type": "number",
|
|
94018
|
+
"format": "float",
|
|
94019
|
+
"minimum": 0,
|
|
94020
|
+
"description": "Flat fee charged for every reimbursement period, in the contract's currency."
|
|
94021
|
+
}
|
|
94022
|
+
}
|
|
94023
|
+
},
|
|
94024
|
+
"lastUpdatedAt": {
|
|
94025
|
+
"type": "string",
|
|
94026
|
+
"format": "date-time",
|
|
94027
|
+
"description": "ISO 8601 formatted date",
|
|
94028
|
+
"readOnly": true
|
|
94029
|
+
},
|
|
94030
|
+
"settlementOverrides": {
|
|
94031
|
+
"type": "array",
|
|
94032
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
94033
|
+
"items": {
|
|
94034
|
+
"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.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
94035
|
+
"type": "object",
|
|
94036
|
+
"required": [
|
|
94037
|
+
"id",
|
|
94038
|
+
"name",
|
|
94039
|
+
"priority",
|
|
94040
|
+
"restriction",
|
|
94041
|
+
"acPercent",
|
|
94042
|
+
"dcPercent"
|
|
94043
|
+
],
|
|
94044
|
+
"properties": {
|
|
94045
|
+
"name": {
|
|
94046
|
+
"type": "string",
|
|
94047
|
+
"maxLength": 255,
|
|
94048
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
94049
|
+
"example": "Fleet drivers"
|
|
94050
|
+
},
|
|
94051
|
+
"priority": {
|
|
94052
|
+
"type": "integer",
|
|
94053
|
+
"minimum": 1,
|
|
94054
|
+
"maximum": 4294967295,
|
|
94055
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
94056
|
+
"example": 1
|
|
94057
|
+
},
|
|
94058
|
+
"id": {
|
|
94059
|
+
"type": "integer",
|
|
94060
|
+
"description": "Unique identifier for the settlement override",
|
|
94061
|
+
"example": 123
|
|
94062
|
+
},
|
|
94063
|
+
"restriction": {
|
|
94064
|
+
"type": "object",
|
|
94065
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
94066
|
+
"required": [
|
|
94067
|
+
"type"
|
|
94068
|
+
],
|
|
94069
|
+
"properties": {
|
|
94070
|
+
"type": {
|
|
94071
|
+
"type": "string",
|
|
94072
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
94073
|
+
"enum": [
|
|
94074
|
+
"users_of_the_partner",
|
|
94075
|
+
"user_groups",
|
|
94076
|
+
"ad_hoc_users",
|
|
94077
|
+
"users_of_specific_partners"
|
|
94078
|
+
]
|
|
94079
|
+
},
|
|
94080
|
+
"targetIds": {
|
|
94081
|
+
"type": "array",
|
|
94082
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
94083
|
+
"items": {
|
|
94084
|
+
"type": "integer"
|
|
94085
|
+
},
|
|
94086
|
+
"example": [
|
|
94087
|
+
12,
|
|
94088
|
+
34
|
|
94089
|
+
]
|
|
94090
|
+
}
|
|
94091
|
+
}
|
|
94092
|
+
},
|
|
94093
|
+
"acPercent": {
|
|
94094
|
+
"type": "number",
|
|
94095
|
+
"format": "float",
|
|
94096
|
+
"nullable": true,
|
|
94097
|
+
"minimum": 0,
|
|
94098
|
+
"maximum": 100,
|
|
94099
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\nApplied to the session amount without tax, after any session fees and electricity\ncost are deducted.\n`null` means the value is inherited from the partner contract.\n",
|
|
94100
|
+
"example": 70.5
|
|
94101
|
+
},
|
|
94102
|
+
"dcPercent": {
|
|
94103
|
+
"type": "number",
|
|
94104
|
+
"format": "float",
|
|
94105
|
+
"nullable": true,
|
|
94106
|
+
"minimum": 0,
|
|
94107
|
+
"maximum": 100,
|
|
94108
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\nApplied to the session amount without tax, after any session fees and electricity\ncost are deducted.\n`null` means the value is inherited from the partner contract.\n",
|
|
94109
|
+
"example": 60
|
|
94110
|
+
}
|
|
94111
|
+
}
|
|
94112
|
+
}
|
|
94113
|
+
}
|
|
94114
|
+
},
|
|
94115
|
+
"required": [
|
|
94116
|
+
"id",
|
|
94117
|
+
"operatorId",
|
|
94118
|
+
"title",
|
|
94119
|
+
"partnerId",
|
|
94120
|
+
"startDate"
|
|
94121
|
+
]
|
|
94122
|
+
}
|
|
94123
|
+
}
|
|
94124
|
+
}
|
|
94125
|
+
},
|
|
94126
|
+
"401": {
|
|
94127
|
+
"schema": {
|
|
94128
|
+
"type": "object",
|
|
94129
|
+
"properties": {
|
|
94130
|
+
"message": {
|
|
94131
|
+
"type": "string"
|
|
94132
|
+
}
|
|
94133
|
+
}
|
|
94134
|
+
}
|
|
94135
|
+
},
|
|
94136
|
+
"403": {
|
|
94137
|
+
"schema": {
|
|
94138
|
+
"type": "object",
|
|
94139
|
+
"properties": {
|
|
94140
|
+
"message": {
|
|
94141
|
+
"type": "string",
|
|
94142
|
+
"default": "This action is unauthorized."
|
|
94143
|
+
}
|
|
94144
|
+
}
|
|
94145
|
+
}
|
|
94146
|
+
},
|
|
94147
|
+
"404": {
|
|
94148
|
+
"schema": {
|
|
94149
|
+
"type": "object",
|
|
94150
|
+
"properties": {
|
|
94151
|
+
"message": {
|
|
94152
|
+
"type": "string"
|
|
94153
|
+
}
|
|
94154
|
+
}
|
|
94155
|
+
}
|
|
94156
|
+
},
|
|
94157
|
+
"429": {
|
|
94158
|
+
"schema": {
|
|
94159
|
+
"type": "object",
|
|
94160
|
+
"properties": {
|
|
94161
|
+
"message": {
|
|
94162
|
+
"type": "string"
|
|
94163
|
+
}
|
|
94164
|
+
}
|
|
94165
|
+
}
|
|
94166
|
+
}
|
|
94167
|
+
},
|
|
94168
|
+
"partnerContractUpdate": {
|
|
94169
|
+
"200": {
|
|
94170
|
+
"schema": {
|
|
94171
|
+
"type": "object",
|
|
94172
|
+
"properties": {
|
|
94173
|
+
"data": {
|
|
94174
|
+
"type": "object",
|
|
94175
|
+
"properties": {
|
|
94176
|
+
"id": {
|
|
94177
|
+
"type": "integer",
|
|
94178
|
+
"readOnly": true
|
|
94179
|
+
},
|
|
94180
|
+
"operatorId": {
|
|
94181
|
+
"type": "integer",
|
|
94182
|
+
"description": "The ID of the operator this resource belongs to",
|
|
94183
|
+
"example": 1
|
|
94184
|
+
},
|
|
94185
|
+
"title": {
|
|
94186
|
+
"type": "string"
|
|
94187
|
+
},
|
|
94188
|
+
"partnerId": {
|
|
94189
|
+
"type": "integer"
|
|
94190
|
+
},
|
|
94191
|
+
"contractType": {
|
|
94192
|
+
"type": "string",
|
|
94193
|
+
"enum": [
|
|
94194
|
+
"revenueSharing",
|
|
94195
|
+
"paymentFacilitation"
|
|
94196
|
+
],
|
|
94197
|
+
"description": "Indicates the business relationship model for the contract. `revenueSharing` means the operator is the supplier and remits a share to the partner. `paymentFacilitation` means the partner is the supplier and the operator acts as payment facilitator."
|
|
94198
|
+
},
|
|
94199
|
+
"startDate": {
|
|
94200
|
+
"type": "string",
|
|
94201
|
+
"format": "date-time",
|
|
94202
|
+
"description": "The contract is effective from the first of the selected month."
|
|
94203
|
+
},
|
|
94204
|
+
"endDate": {
|
|
94205
|
+
"type": "string",
|
|
94206
|
+
"format": "date-time",
|
|
94207
|
+
"nullable": true,
|
|
94208
|
+
"description": "The contract expires at the last day of the selected month. If nothing is selected, there is no expiration date."
|
|
94209
|
+
},
|
|
94210
|
+
"autoRenewal": {
|
|
94211
|
+
"type": "boolean"
|
|
94212
|
+
},
|
|
94213
|
+
"externalId": {
|
|
94214
|
+
"type": "string",
|
|
94215
|
+
"description": "Used to store custom information, usually used for external references or metadata to the resource.",
|
|
94216
|
+
"maxLength": 255
|
|
94217
|
+
},
|
|
94218
|
+
"accessAndPermissions": {
|
|
94219
|
+
"type": "object",
|
|
94220
|
+
"properties": {
|
|
94221
|
+
"sessionsRemoteControl": {
|
|
94222
|
+
"type": "boolean",
|
|
94223
|
+
"description": "Allows the partner to start/stop session, unlock connector, trigger message, set a charging profile and get the composite schedule."
|
|
94224
|
+
},
|
|
94225
|
+
"startReservation": {
|
|
94226
|
+
"type": "boolean",
|
|
94227
|
+
"description": "Allows the partner to make reservations."
|
|
94228
|
+
},
|
|
94229
|
+
"stopReservation": {
|
|
94230
|
+
"type": "boolean",
|
|
94231
|
+
"description": "Allows the partner to cancel reservations."
|
|
94232
|
+
},
|
|
94233
|
+
"resetChargePoint": {
|
|
94234
|
+
"type": "boolean",
|
|
94235
|
+
"description": "Allows the partner to reset charge points."
|
|
94236
|
+
},
|
|
94237
|
+
"firmwareUpdate": {
|
|
94238
|
+
"type": "boolean",
|
|
94239
|
+
"description": "Allows the partner to make firmware updates to the charge points."
|
|
94240
|
+
},
|
|
94241
|
+
"createFromTemplate": {
|
|
94242
|
+
"type": "boolean",
|
|
94243
|
+
"description": "Allows the partner to create charge points from templates."
|
|
94244
|
+
},
|
|
94245
|
+
"changeSystemStatus": {
|
|
94246
|
+
"type": "boolean",
|
|
94247
|
+
"description": "Allows the partner to change the system status of charge points."
|
|
94248
|
+
}
|
|
94249
|
+
}
|
|
94250
|
+
},
|
|
94251
|
+
"revenueSharing": {
|
|
94252
|
+
"type": "object",
|
|
94253
|
+
"properties": {
|
|
94254
|
+
"partnerSharePercentagePrivateEvseAccessFees": {
|
|
94255
|
+
"type": "number",
|
|
94256
|
+
"format": "float",
|
|
94257
|
+
"minimum": 0,
|
|
94258
|
+
"maximum": 100,
|
|
94259
|
+
"description": "The partner's share of the revenue from private EVSE access fees from other partners given access to this partner's commercial private charge points. Omit the property to leave the share unconfigured."
|
|
94260
|
+
},
|
|
94261
|
+
"partnerSharePercentageAcEvse": {
|
|
94262
|
+
"type": "number",
|
|
94263
|
+
"format": "float",
|
|
94264
|
+
"minimum": 0,
|
|
94265
|
+
"maximum": 100,
|
|
94266
|
+
"description": "Applied to the session amount without tax, after any session fees and electricity cost are deducted."
|
|
94267
|
+
},
|
|
94268
|
+
"partnerSharePercentageDcEvse": {
|
|
94269
|
+
"type": "number",
|
|
94270
|
+
"format": "float",
|
|
94271
|
+
"minimum": 0,
|
|
94272
|
+
"maximum": 100,
|
|
94273
|
+
"description": "Applied to the session amount without tax, after any session fees and electricity cost are deducted."
|
|
94274
|
+
},
|
|
94275
|
+
"excludeConnectionFee": {
|
|
94276
|
+
"type": "boolean",
|
|
94277
|
+
"description": "If true and the tariff has a connection fee, the partner receives no share of it and the operator keeps it in full. The connection fee excluded is the amount without tax."
|
|
94278
|
+
},
|
|
94279
|
+
"deductElectricityCost": {
|
|
94280
|
+
"type": "boolean",
|
|
94281
|
+
"description": "The electricity cost without tax is deducted from the session amount, together with the session fees, before the partner's share is calculated."
|
|
94282
|
+
},
|
|
94283
|
+
"reimburseForElectricityCost": {
|
|
94284
|
+
"type": "boolean",
|
|
94285
|
+
"description": "If true, the partner also receives the electricity cost. The partner receives (Revenue − Deducted fees − Electricity cost) × Partner percentage + Electricity cost, where revenue and electricity cost are the amounts without tax and deducted fees are the fixed fee per session, the fee per kWh and the handling fee. It can be supplied only if `deductElectricityCost` is true."
|
|
94286
|
+
},
|
|
94287
|
+
"fixedFeePerSessionAc": {
|
|
94288
|
+
"type": "number",
|
|
94289
|
+
"format": "float",
|
|
94290
|
+
"nullable": true,
|
|
94291
|
+
"description": "Flat fee without tax for every billed session on an AC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
94292
|
+
},
|
|
94293
|
+
"fixedFeePerSessionDc": {
|
|
94294
|
+
"type": "number",
|
|
94295
|
+
"format": "float",
|
|
94296
|
+
"nullable": true,
|
|
94297
|
+
"description": "Flat fee without tax for every billed session on a DC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
94298
|
+
},
|
|
94299
|
+
"feePerKwhAc": {
|
|
94300
|
+
"type": "number",
|
|
94301
|
+
"format": "float",
|
|
94302
|
+
"nullable": true,
|
|
94303
|
+
"description": "Flat fee without tax for every billed kWh on an AC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
94304
|
+
},
|
|
94305
|
+
"feePerKwhDc": {
|
|
94306
|
+
"type": "number",
|
|
94307
|
+
"format": "float",
|
|
94308
|
+
"nullable": true,
|
|
94309
|
+
"description": "Flat fee without tax for every billed kWh on a DC charge point. It is taken off the session amount before the partner's share is calculated, and the operator keeps it in full."
|
|
94310
|
+
},
|
|
94311
|
+
"handlingFee": {
|
|
94312
|
+
"type": "number",
|
|
94313
|
+
"format": "float",
|
|
94314
|
+
"minimum": 0,
|
|
94315
|
+
"maximum": 100,
|
|
94316
|
+
"nullable": true,
|
|
94317
|
+
"description": "A percentage of the total amount the user paid for the session, including tax. It is taken off the session amount before the partner's share is calculated."
|
|
94318
|
+
}
|
|
94319
|
+
}
|
|
94320
|
+
},
|
|
94321
|
+
"monthlyPlatformFees": {
|
|
94322
|
+
"type": "object",
|
|
94323
|
+
"properties": {
|
|
94324
|
+
"perPrivateEvseOfOtherPartners": {
|
|
94325
|
+
"type": "number",
|
|
94326
|
+
"format": "float",
|
|
94327
|
+
"minimum": 0,
|
|
94328
|
+
"description": "Fee per EVSE, without tax, of commercial private charge points of other partners to which this partner is given access. Omit the property to leave the fee unconfigured."
|
|
94329
|
+
},
|
|
94254
94330
|
"perChargePoint": {
|
|
94255
94331
|
"type": "number",
|
|
94256
94332
|
"format": "float",
|
|
@@ -94561,6 +94637,13 @@
|
|
|
94561
94637
|
"revenueSharing": {
|
|
94562
94638
|
"type": "object",
|
|
94563
94639
|
"properties": {
|
|
94640
|
+
"partnerSharePercentagePrivateEvseAccessFees": {
|
|
94641
|
+
"type": "number",
|
|
94642
|
+
"format": "float",
|
|
94643
|
+
"minimum": 0,
|
|
94644
|
+
"maximum": 100,
|
|
94645
|
+
"description": "The partner's share of the revenue from private EVSE access fees from other partners given access to this partner's commercial private charge points. Omit the property to leave the share unconfigured."
|
|
94646
|
+
},
|
|
94564
94647
|
"partnerSharePercentageAcEvse": {
|
|
94565
94648
|
"type": "number",
|
|
94566
94649
|
"format": "float",
|
|
@@ -94624,6 +94707,12 @@
|
|
|
94624
94707
|
"monthlyPlatformFees": {
|
|
94625
94708
|
"type": "object",
|
|
94626
94709
|
"properties": {
|
|
94710
|
+
"perPrivateEvseOfOtherPartners": {
|
|
94711
|
+
"type": "number",
|
|
94712
|
+
"format": "float",
|
|
94713
|
+
"minimum": 0,
|
|
94714
|
+
"description": "Fee per EVSE, without tax, of commercial private charge points of other partners to which this partner is given access. Omit the property to leave the fee unconfigured."
|
|
94715
|
+
},
|
|
94627
94716
|
"perChargePoint": {
|
|
94628
94717
|
"type": "number",
|
|
94629
94718
|
"format": "float",
|
|
@@ -108889,6 +108978,2879 @@
|
|
|
108889
108978
|
}
|
|
108890
108979
|
}
|
|
108891
108980
|
},
|
|
108981
|
+
"partnerSettlementReportsListingV1_1": {
|
|
108982
|
+
"200": {
|
|
108983
|
+
"schema": {
|
|
108984
|
+
"type": "object",
|
|
108985
|
+
"properties": {
|
|
108986
|
+
"data": {
|
|
108987
|
+
"type": "array",
|
|
108988
|
+
"items": {
|
|
108989
|
+
"type": "object",
|
|
108990
|
+
"properties": {
|
|
108991
|
+
"id": {
|
|
108992
|
+
"type": "integer",
|
|
108993
|
+
"description": "Unique settlement report identifier."
|
|
108994
|
+
},
|
|
108995
|
+
"partnerId": {
|
|
108996
|
+
"type": "integer",
|
|
108997
|
+
"description": "Unique identifier of the partner involved in the settlement."
|
|
108998
|
+
},
|
|
108999
|
+
"number": {
|
|
109000
|
+
"type": "string",
|
|
109001
|
+
"description": "Settlement report reference number."
|
|
109002
|
+
},
|
|
109003
|
+
"date": {
|
|
109004
|
+
"type": "string",
|
|
109005
|
+
"format": "date",
|
|
109006
|
+
"description": "Date the settlement report was generated."
|
|
109007
|
+
},
|
|
109008
|
+
"periodStart": {
|
|
109009
|
+
"type": "string",
|
|
109010
|
+
"format": "date",
|
|
109011
|
+
"description": "Start date of the period covered by the report."
|
|
109012
|
+
},
|
|
109013
|
+
"periodEnd": {
|
|
109014
|
+
"type": "string",
|
|
109015
|
+
"format": "date",
|
|
109016
|
+
"description": "End date of the period covered by the report."
|
|
109017
|
+
},
|
|
109018
|
+
"currencyCode": {
|
|
109019
|
+
"description": "Currency used in the settlement (e.g., USD, EUR).",
|
|
109020
|
+
"type": "string",
|
|
109021
|
+
"enum": [
|
|
109022
|
+
"AED",
|
|
109023
|
+
"AFN",
|
|
109024
|
+
"ALL",
|
|
109025
|
+
"AMD",
|
|
109026
|
+
"ANG",
|
|
109027
|
+
"AOA",
|
|
109028
|
+
"ARS",
|
|
109029
|
+
"AUD",
|
|
109030
|
+
"AWG",
|
|
109031
|
+
"AZN",
|
|
109032
|
+
"BAM",
|
|
109033
|
+
"BBD",
|
|
109034
|
+
"BDT",
|
|
109035
|
+
"BGN",
|
|
109036
|
+
"BHD",
|
|
109037
|
+
"BIF",
|
|
109038
|
+
"BMD",
|
|
109039
|
+
"BND",
|
|
109040
|
+
"BOB",
|
|
109041
|
+
"BOV",
|
|
109042
|
+
"BRL",
|
|
109043
|
+
"BSD",
|
|
109044
|
+
"BTN",
|
|
109045
|
+
"BWP",
|
|
109046
|
+
"BYN",
|
|
109047
|
+
"BZD",
|
|
109048
|
+
"CAD",
|
|
109049
|
+
"CDF",
|
|
109050
|
+
"CHE",
|
|
109051
|
+
"CHF",
|
|
109052
|
+
"CHW",
|
|
109053
|
+
"CLF",
|
|
109054
|
+
"CLP",
|
|
109055
|
+
"CNY",
|
|
109056
|
+
"COP",
|
|
109057
|
+
"COU",
|
|
109058
|
+
"CRC",
|
|
109059
|
+
"CUC",
|
|
109060
|
+
"CUP",
|
|
109061
|
+
"CVE",
|
|
109062
|
+
"CZK",
|
|
109063
|
+
"DJF",
|
|
109064
|
+
"DKK",
|
|
109065
|
+
"DOP",
|
|
109066
|
+
"DZD",
|
|
109067
|
+
"EGP",
|
|
109068
|
+
"ERN",
|
|
109069
|
+
"ETB",
|
|
109070
|
+
"EUR",
|
|
109071
|
+
"FJD",
|
|
109072
|
+
"FKP",
|
|
109073
|
+
"GBP",
|
|
109074
|
+
"GEL",
|
|
109075
|
+
"GHS",
|
|
109076
|
+
"GIP",
|
|
109077
|
+
"GMD",
|
|
109078
|
+
"GNF",
|
|
109079
|
+
"GTQ",
|
|
109080
|
+
"GYD",
|
|
109081
|
+
"HKD",
|
|
109082
|
+
"HNL",
|
|
109083
|
+
"HRK",
|
|
109084
|
+
"HTG",
|
|
109085
|
+
"HUF",
|
|
109086
|
+
"IDR",
|
|
109087
|
+
"ILS",
|
|
109088
|
+
"INR",
|
|
109089
|
+
"IQD",
|
|
109090
|
+
"IRR",
|
|
109091
|
+
"ISK",
|
|
109092
|
+
"JMD",
|
|
109093
|
+
"JOD",
|
|
109094
|
+
"JPY",
|
|
109095
|
+
"KES",
|
|
109096
|
+
"KGS",
|
|
109097
|
+
"KHR",
|
|
109098
|
+
"KMF",
|
|
109099
|
+
"KPW",
|
|
109100
|
+
"KRW",
|
|
109101
|
+
"KWD",
|
|
109102
|
+
"KYD",
|
|
109103
|
+
"KZT",
|
|
109104
|
+
"LAK",
|
|
109105
|
+
"LBP",
|
|
109106
|
+
"LKR",
|
|
109107
|
+
"LRD",
|
|
109108
|
+
"LSL",
|
|
109109
|
+
"LYD",
|
|
109110
|
+
"MAD",
|
|
109111
|
+
"MDL",
|
|
109112
|
+
"MGA",
|
|
109113
|
+
"MKD",
|
|
109114
|
+
"MMK",
|
|
109115
|
+
"MNT",
|
|
109116
|
+
"MOP",
|
|
109117
|
+
"MRU",
|
|
109118
|
+
"MUR",
|
|
109119
|
+
"MVR",
|
|
109120
|
+
"MWK",
|
|
109121
|
+
"MXN",
|
|
109122
|
+
"MXV",
|
|
109123
|
+
"MYR",
|
|
109124
|
+
"MZN",
|
|
109125
|
+
"NAD",
|
|
109126
|
+
"NGN",
|
|
109127
|
+
"NIO",
|
|
109128
|
+
"NOK",
|
|
109129
|
+
"NPR",
|
|
109130
|
+
"NZD",
|
|
109131
|
+
"OMR",
|
|
109132
|
+
"PAB",
|
|
109133
|
+
"PEN",
|
|
109134
|
+
"PGK",
|
|
109135
|
+
"PHP",
|
|
109136
|
+
"PKR",
|
|
109137
|
+
"PLN",
|
|
109138
|
+
"PYG",
|
|
109139
|
+
"QAR",
|
|
109140
|
+
"RON",
|
|
109141
|
+
"RSD",
|
|
109142
|
+
"RUB",
|
|
109143
|
+
"RWF",
|
|
109144
|
+
"SAR",
|
|
109145
|
+
"SBD",
|
|
109146
|
+
"SCR",
|
|
109147
|
+
"SDG",
|
|
109148
|
+
"SEK",
|
|
109149
|
+
"SGD",
|
|
109150
|
+
"SHP",
|
|
109151
|
+
"SLL",
|
|
109152
|
+
"SOS",
|
|
109153
|
+
"SRD",
|
|
109154
|
+
"SSP",
|
|
109155
|
+
"STN",
|
|
109156
|
+
"SVC",
|
|
109157
|
+
"SYP",
|
|
109158
|
+
"SZL",
|
|
109159
|
+
"THB",
|
|
109160
|
+
"TJS",
|
|
109161
|
+
"TMT",
|
|
109162
|
+
"TND",
|
|
109163
|
+
"TOP",
|
|
109164
|
+
"TRY",
|
|
109165
|
+
"TTD",
|
|
109166
|
+
"TWD",
|
|
109167
|
+
"TZS",
|
|
109168
|
+
"UAH",
|
|
109169
|
+
"UGX",
|
|
109170
|
+
"USD",
|
|
109171
|
+
"USN",
|
|
109172
|
+
"UYI",
|
|
109173
|
+
"UYU",
|
|
109174
|
+
"UYW",
|
|
109175
|
+
"UZS",
|
|
109176
|
+
"VES",
|
|
109177
|
+
"VND",
|
|
109178
|
+
"VUV",
|
|
109179
|
+
"WST",
|
|
109180
|
+
"XAF",
|
|
109181
|
+
"XAG",
|
|
109182
|
+
"XAU",
|
|
109183
|
+
"XBA",
|
|
109184
|
+
"XBB",
|
|
109185
|
+
"XBC",
|
|
109186
|
+
"XBD",
|
|
109187
|
+
"XCD",
|
|
109188
|
+
"XDR",
|
|
109189
|
+
"XOF",
|
|
109190
|
+
"XPD",
|
|
109191
|
+
"XPF",
|
|
109192
|
+
"XPT",
|
|
109193
|
+
"XSU",
|
|
109194
|
+
"XTS",
|
|
109195
|
+
"XUA",
|
|
109196
|
+
"XXX",
|
|
109197
|
+
"YER",
|
|
109198
|
+
"ZAR",
|
|
109199
|
+
"ZMW",
|
|
109200
|
+
"ZWL"
|
|
109201
|
+
]
|
|
109202
|
+
},
|
|
109203
|
+
"totals": {
|
|
109204
|
+
"description": "Settlement totals for the period, each with the tax-exclusive amount and, where stored, the tax-inclusive amount.\n\nA tax-inclusive amount, when present, is the stored total of the tax-inclusive amounts of the underlying records, substituting the tax-exclusive amount for any record that carries no tax-inclusive one.\n",
|
|
109205
|
+
"type": "object",
|
|
109206
|
+
"properties": {
|
|
109207
|
+
"amount": {
|
|
109208
|
+
"description": "Total settlement amount.",
|
|
109209
|
+
"type": "object",
|
|
109210
|
+
"properties": {
|
|
109211
|
+
"withoutTax": {
|
|
109212
|
+
"type": "number",
|
|
109213
|
+
"description": "The tax-exclusive amount."
|
|
109214
|
+
},
|
|
109215
|
+
"withTax": {
|
|
109216
|
+
"type": "number",
|
|
109217
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
109218
|
+
}
|
|
109219
|
+
},
|
|
109220
|
+
"required": [
|
|
109221
|
+
"withoutTax"
|
|
109222
|
+
]
|
|
109223
|
+
},
|
|
109224
|
+
"expenses": {
|
|
109225
|
+
"description": "Total expenses incurred during the settlement period.",
|
|
109226
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109227
|
+
},
|
|
109228
|
+
"revenue": {
|
|
109229
|
+
"description": "Total revenue generated during the settlement period.",
|
|
109230
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109231
|
+
},
|
|
109232
|
+
"awaitedRevenue": {
|
|
109233
|
+
"description": "Revenue expected but not yet collected.",
|
|
109234
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109235
|
+
},
|
|
109236
|
+
"collectedRevenue": {
|
|
109237
|
+
"description": "Revenue collected during the settlement period.",
|
|
109238
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109239
|
+
},
|
|
109240
|
+
"collectedRevenueFromPreviousPeriod": {
|
|
109241
|
+
"description": "Revenue collected during this period, but related to a previous periods.",
|
|
109242
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109243
|
+
}
|
|
109244
|
+
},
|
|
109245
|
+
"required": [
|
|
109246
|
+
"amount",
|
|
109247
|
+
"expenses",
|
|
109248
|
+
"revenue",
|
|
109249
|
+
"awaitedRevenue",
|
|
109250
|
+
"collectedRevenue",
|
|
109251
|
+
"collectedRevenueFromPreviousPeriod"
|
|
109252
|
+
]
|
|
109253
|
+
},
|
|
109254
|
+
"totalEnergyCpoWh": {
|
|
109255
|
+
"type": "number",
|
|
109256
|
+
"description": "Total amount of energy (in Wh) delivered by the Charge Point Operator."
|
|
109257
|
+
},
|
|
109258
|
+
"totalEnergyEmspWh": {
|
|
109259
|
+
"type": "number",
|
|
109260
|
+
"description": "Total amount of energy (in Wh) consumed by the EMSP."
|
|
109261
|
+
},
|
|
109262
|
+
"supplier": {
|
|
109263
|
+
"description": "Company details for the entity supplying the service - the CPO.",
|
|
109264
|
+
"type": "object",
|
|
109265
|
+
"properties": {
|
|
109266
|
+
"type": {
|
|
109267
|
+
"type": "string",
|
|
109268
|
+
"enum": [
|
|
109269
|
+
"individual",
|
|
109270
|
+
"company"
|
|
109271
|
+
]
|
|
109272
|
+
},
|
|
109273
|
+
"name": {
|
|
109274
|
+
"type": "string"
|
|
109275
|
+
},
|
|
109276
|
+
"contactPerson": {
|
|
109277
|
+
"type": "string",
|
|
109278
|
+
"nullable": true
|
|
109279
|
+
},
|
|
109280
|
+
"country": {
|
|
109281
|
+
"type": "string",
|
|
109282
|
+
"nullable": true,
|
|
109283
|
+
"enum": [
|
|
109284
|
+
"AF",
|
|
109285
|
+
"AX",
|
|
109286
|
+
"AL",
|
|
109287
|
+
"DZ",
|
|
109288
|
+
"AS",
|
|
109289
|
+
"AD",
|
|
109290
|
+
"AO",
|
|
109291
|
+
"AI",
|
|
109292
|
+
"AQ",
|
|
109293
|
+
"AG",
|
|
109294
|
+
"AR",
|
|
109295
|
+
"AM",
|
|
109296
|
+
"AW",
|
|
109297
|
+
"AU",
|
|
109298
|
+
"AT",
|
|
109299
|
+
"AZ",
|
|
109300
|
+
"BS",
|
|
109301
|
+
"BH",
|
|
109302
|
+
"BD",
|
|
109303
|
+
"BB",
|
|
109304
|
+
"BY",
|
|
109305
|
+
"BE",
|
|
109306
|
+
"BZ",
|
|
109307
|
+
"BJ",
|
|
109308
|
+
"BM",
|
|
109309
|
+
"BT",
|
|
109310
|
+
"BO",
|
|
109311
|
+
"BQ",
|
|
109312
|
+
"BA",
|
|
109313
|
+
"BW",
|
|
109314
|
+
"BV",
|
|
109315
|
+
"BR",
|
|
109316
|
+
"IO",
|
|
109317
|
+
"BN",
|
|
109318
|
+
"BG",
|
|
109319
|
+
"BF",
|
|
109320
|
+
"BI",
|
|
109321
|
+
"KH",
|
|
109322
|
+
"CM",
|
|
109323
|
+
"CA",
|
|
109324
|
+
"CV",
|
|
109325
|
+
"KY",
|
|
109326
|
+
"CF",
|
|
109327
|
+
"TD",
|
|
109328
|
+
"CL",
|
|
109329
|
+
"CN",
|
|
109330
|
+
"CX",
|
|
109331
|
+
"CC",
|
|
109332
|
+
"CO",
|
|
109333
|
+
"KM",
|
|
109334
|
+
"CG",
|
|
109335
|
+
"CD",
|
|
109336
|
+
"CK",
|
|
109337
|
+
"CR",
|
|
109338
|
+
"CI",
|
|
109339
|
+
"HR",
|
|
109340
|
+
"CU",
|
|
109341
|
+
"CW",
|
|
109342
|
+
"CY",
|
|
109343
|
+
"CZ",
|
|
109344
|
+
"DK",
|
|
109345
|
+
"DJ",
|
|
109346
|
+
"DM",
|
|
109347
|
+
"DO",
|
|
109348
|
+
"EC",
|
|
109349
|
+
"EG",
|
|
109350
|
+
"SV",
|
|
109351
|
+
"GQ",
|
|
109352
|
+
"ER",
|
|
109353
|
+
"EE",
|
|
109354
|
+
"ET",
|
|
109355
|
+
"FK",
|
|
109356
|
+
"FO",
|
|
109357
|
+
"FJ",
|
|
109358
|
+
"FI",
|
|
109359
|
+
"FR",
|
|
109360
|
+
"GF",
|
|
109361
|
+
"PF",
|
|
109362
|
+
"TF",
|
|
109363
|
+
"GA",
|
|
109364
|
+
"GM",
|
|
109365
|
+
"GE",
|
|
109366
|
+
"DE",
|
|
109367
|
+
"GH",
|
|
109368
|
+
"GI",
|
|
109369
|
+
"GR",
|
|
109370
|
+
"GL",
|
|
109371
|
+
"GD",
|
|
109372
|
+
"GP",
|
|
109373
|
+
"GU",
|
|
109374
|
+
"GT",
|
|
109375
|
+
"GG",
|
|
109376
|
+
"GN",
|
|
109377
|
+
"GW",
|
|
109378
|
+
"GY",
|
|
109379
|
+
"HT",
|
|
109380
|
+
"HM",
|
|
109381
|
+
"VA",
|
|
109382
|
+
"HN",
|
|
109383
|
+
"HK",
|
|
109384
|
+
"HU",
|
|
109385
|
+
"IS",
|
|
109386
|
+
"IN",
|
|
109387
|
+
"ID",
|
|
109388
|
+
"IR",
|
|
109389
|
+
"IQ",
|
|
109390
|
+
"IE",
|
|
109391
|
+
"IM",
|
|
109392
|
+
"IL",
|
|
109393
|
+
"IT",
|
|
109394
|
+
"JM",
|
|
109395
|
+
"JP",
|
|
109396
|
+
"JE",
|
|
109397
|
+
"JO",
|
|
109398
|
+
"KZ",
|
|
109399
|
+
"KE",
|
|
109400
|
+
"KI",
|
|
109401
|
+
"KP",
|
|
109402
|
+
"KR",
|
|
109403
|
+
"XK",
|
|
109404
|
+
"KW",
|
|
109405
|
+
"KG",
|
|
109406
|
+
"LA",
|
|
109407
|
+
"LV",
|
|
109408
|
+
"LB",
|
|
109409
|
+
"LS",
|
|
109410
|
+
"LR",
|
|
109411
|
+
"LY",
|
|
109412
|
+
"LI",
|
|
109413
|
+
"LT",
|
|
109414
|
+
"LU",
|
|
109415
|
+
"MO",
|
|
109416
|
+
"MK",
|
|
109417
|
+
"MG",
|
|
109418
|
+
"MW",
|
|
109419
|
+
"MY",
|
|
109420
|
+
"MV",
|
|
109421
|
+
"ML",
|
|
109422
|
+
"MT",
|
|
109423
|
+
"MH",
|
|
109424
|
+
"MQ",
|
|
109425
|
+
"MR",
|
|
109426
|
+
"MU",
|
|
109427
|
+
"YT",
|
|
109428
|
+
"MX",
|
|
109429
|
+
"FM",
|
|
109430
|
+
"MD",
|
|
109431
|
+
"MC",
|
|
109432
|
+
"MN",
|
|
109433
|
+
"ME",
|
|
109434
|
+
"MS",
|
|
109435
|
+
"MA",
|
|
109436
|
+
"MZ",
|
|
109437
|
+
"MM",
|
|
109438
|
+
"NA",
|
|
109439
|
+
"NR",
|
|
109440
|
+
"NP",
|
|
109441
|
+
"NL",
|
|
109442
|
+
"NC",
|
|
109443
|
+
"NZ",
|
|
109444
|
+
"NI",
|
|
109445
|
+
"NE",
|
|
109446
|
+
"NG",
|
|
109447
|
+
"NU",
|
|
109448
|
+
"NF",
|
|
109449
|
+
"MP",
|
|
109450
|
+
"NO",
|
|
109451
|
+
"OM",
|
|
109452
|
+
"PK",
|
|
109453
|
+
"PW",
|
|
109454
|
+
"PS",
|
|
109455
|
+
"PA",
|
|
109456
|
+
"PG",
|
|
109457
|
+
"PY",
|
|
109458
|
+
"PE",
|
|
109459
|
+
"PH",
|
|
109460
|
+
"PN",
|
|
109461
|
+
"PL",
|
|
109462
|
+
"PT",
|
|
109463
|
+
"PR",
|
|
109464
|
+
"QA",
|
|
109465
|
+
"RE",
|
|
109466
|
+
"RO",
|
|
109467
|
+
"RU",
|
|
109468
|
+
"RW",
|
|
109469
|
+
"BL",
|
|
109470
|
+
"SH",
|
|
109471
|
+
"KN",
|
|
109472
|
+
"LC",
|
|
109473
|
+
"MF",
|
|
109474
|
+
"PM",
|
|
109475
|
+
"VC",
|
|
109476
|
+
"WS",
|
|
109477
|
+
"SM",
|
|
109478
|
+
"ST",
|
|
109479
|
+
"SA",
|
|
109480
|
+
"SN",
|
|
109481
|
+
"RS",
|
|
109482
|
+
"SC",
|
|
109483
|
+
"SL",
|
|
109484
|
+
"SG",
|
|
109485
|
+
"SX",
|
|
109486
|
+
"SK",
|
|
109487
|
+
"SI",
|
|
109488
|
+
"SB",
|
|
109489
|
+
"SO",
|
|
109490
|
+
"ZA",
|
|
109491
|
+
"GS",
|
|
109492
|
+
"SS",
|
|
109493
|
+
"ES",
|
|
109494
|
+
"LK",
|
|
109495
|
+
"SD",
|
|
109496
|
+
"SR",
|
|
109497
|
+
"SJ",
|
|
109498
|
+
"SZ",
|
|
109499
|
+
"SE",
|
|
109500
|
+
"CH",
|
|
109501
|
+
"SY",
|
|
109502
|
+
"TW",
|
|
109503
|
+
"TJ",
|
|
109504
|
+
"TZ",
|
|
109505
|
+
"TH",
|
|
109506
|
+
"TL",
|
|
109507
|
+
"TG",
|
|
109508
|
+
"TK",
|
|
109509
|
+
"TO",
|
|
109510
|
+
"TT",
|
|
109511
|
+
"TN",
|
|
109512
|
+
"TR",
|
|
109513
|
+
"TM",
|
|
109514
|
+
"TC",
|
|
109515
|
+
"TV",
|
|
109516
|
+
"UG",
|
|
109517
|
+
"UA",
|
|
109518
|
+
"AE",
|
|
109519
|
+
"GB",
|
|
109520
|
+
"US",
|
|
109521
|
+
"UM",
|
|
109522
|
+
"UY",
|
|
109523
|
+
"UZ",
|
|
109524
|
+
"VU",
|
|
109525
|
+
"VE",
|
|
109526
|
+
"VN",
|
|
109527
|
+
"VG",
|
|
109528
|
+
"VI",
|
|
109529
|
+
"WF",
|
|
109530
|
+
"EH",
|
|
109531
|
+
"YE",
|
|
109532
|
+
"ZM",
|
|
109533
|
+
"ZW"
|
|
109534
|
+
]
|
|
109535
|
+
},
|
|
109536
|
+
"region": {
|
|
109537
|
+
"type": "string",
|
|
109538
|
+
"nullable": true
|
|
109539
|
+
},
|
|
109540
|
+
"city": {
|
|
109541
|
+
"type": "string",
|
|
109542
|
+
"nullable": true
|
|
109543
|
+
},
|
|
109544
|
+
"postCode": {
|
|
109545
|
+
"type": "string",
|
|
109546
|
+
"nullable": true
|
|
109547
|
+
},
|
|
109548
|
+
"address": {
|
|
109549
|
+
"type": "string",
|
|
109550
|
+
"nullable": true
|
|
109551
|
+
},
|
|
109552
|
+
"regNo": {
|
|
109553
|
+
"type": "string",
|
|
109554
|
+
"nullable": true
|
|
109555
|
+
},
|
|
109556
|
+
"taxId": {
|
|
109557
|
+
"type": "string",
|
|
109558
|
+
"nullable": true
|
|
109559
|
+
},
|
|
109560
|
+
"phone": {
|
|
109561
|
+
"type": "string",
|
|
109562
|
+
"nullable": true
|
|
109563
|
+
},
|
|
109564
|
+
"email": {
|
|
109565
|
+
"type": "string",
|
|
109566
|
+
"nullable": true
|
|
109567
|
+
}
|
|
109568
|
+
},
|
|
109569
|
+
"required": [
|
|
109570
|
+
"type",
|
|
109571
|
+
"name",
|
|
109572
|
+
"contactPerson",
|
|
109573
|
+
"country",
|
|
109574
|
+
"region",
|
|
109575
|
+
"city",
|
|
109576
|
+
"postCode",
|
|
109577
|
+
"address",
|
|
109578
|
+
"regNo",
|
|
109579
|
+
"taxId",
|
|
109580
|
+
"phone",
|
|
109581
|
+
"email"
|
|
109582
|
+
]
|
|
109583
|
+
},
|
|
109584
|
+
"customer": {
|
|
109585
|
+
"description": "Company details for the entity receiving the service - the Partner/EMSP.",
|
|
109586
|
+
"type": "object",
|
|
109587
|
+
"properties": {
|
|
109588
|
+
"type": {
|
|
109589
|
+
"type": "string",
|
|
109590
|
+
"enum": [
|
|
109591
|
+
"individual",
|
|
109592
|
+
"company"
|
|
109593
|
+
]
|
|
109594
|
+
},
|
|
109595
|
+
"name": {
|
|
109596
|
+
"type": "string"
|
|
109597
|
+
},
|
|
109598
|
+
"contactPerson": {
|
|
109599
|
+
"type": "string",
|
|
109600
|
+
"nullable": true
|
|
109601
|
+
},
|
|
109602
|
+
"country": {
|
|
109603
|
+
"type": "string",
|
|
109604
|
+
"nullable": true,
|
|
109605
|
+
"enum": [
|
|
109606
|
+
"AF",
|
|
109607
|
+
"AX",
|
|
109608
|
+
"AL",
|
|
109609
|
+
"DZ",
|
|
109610
|
+
"AS",
|
|
109611
|
+
"AD",
|
|
109612
|
+
"AO",
|
|
109613
|
+
"AI",
|
|
109614
|
+
"AQ",
|
|
109615
|
+
"AG",
|
|
109616
|
+
"AR",
|
|
109617
|
+
"AM",
|
|
109618
|
+
"AW",
|
|
109619
|
+
"AU",
|
|
109620
|
+
"AT",
|
|
109621
|
+
"AZ",
|
|
109622
|
+
"BS",
|
|
109623
|
+
"BH",
|
|
109624
|
+
"BD",
|
|
109625
|
+
"BB",
|
|
109626
|
+
"BY",
|
|
109627
|
+
"BE",
|
|
109628
|
+
"BZ",
|
|
109629
|
+
"BJ",
|
|
109630
|
+
"BM",
|
|
109631
|
+
"BT",
|
|
109632
|
+
"BO",
|
|
109633
|
+
"BQ",
|
|
109634
|
+
"BA",
|
|
109635
|
+
"BW",
|
|
109636
|
+
"BV",
|
|
109637
|
+
"BR",
|
|
109638
|
+
"IO",
|
|
109639
|
+
"BN",
|
|
109640
|
+
"BG",
|
|
109641
|
+
"BF",
|
|
109642
|
+
"BI",
|
|
109643
|
+
"KH",
|
|
109644
|
+
"CM",
|
|
109645
|
+
"CA",
|
|
109646
|
+
"CV",
|
|
109647
|
+
"KY",
|
|
109648
|
+
"CF",
|
|
109649
|
+
"TD",
|
|
109650
|
+
"CL",
|
|
109651
|
+
"CN",
|
|
109652
|
+
"CX",
|
|
109653
|
+
"CC",
|
|
109654
|
+
"CO",
|
|
109655
|
+
"KM",
|
|
109656
|
+
"CG",
|
|
109657
|
+
"CD",
|
|
109658
|
+
"CK",
|
|
109659
|
+
"CR",
|
|
109660
|
+
"CI",
|
|
109661
|
+
"HR",
|
|
109662
|
+
"CU",
|
|
109663
|
+
"CW",
|
|
109664
|
+
"CY",
|
|
109665
|
+
"CZ",
|
|
109666
|
+
"DK",
|
|
109667
|
+
"DJ",
|
|
109668
|
+
"DM",
|
|
109669
|
+
"DO",
|
|
109670
|
+
"EC",
|
|
109671
|
+
"EG",
|
|
109672
|
+
"SV",
|
|
109673
|
+
"GQ",
|
|
109674
|
+
"ER",
|
|
109675
|
+
"EE",
|
|
109676
|
+
"ET",
|
|
109677
|
+
"FK",
|
|
109678
|
+
"FO",
|
|
109679
|
+
"FJ",
|
|
109680
|
+
"FI",
|
|
109681
|
+
"FR",
|
|
109682
|
+
"GF",
|
|
109683
|
+
"PF",
|
|
109684
|
+
"TF",
|
|
109685
|
+
"GA",
|
|
109686
|
+
"GM",
|
|
109687
|
+
"GE",
|
|
109688
|
+
"DE",
|
|
109689
|
+
"GH",
|
|
109690
|
+
"GI",
|
|
109691
|
+
"GR",
|
|
109692
|
+
"GL",
|
|
109693
|
+
"GD",
|
|
109694
|
+
"GP",
|
|
109695
|
+
"GU",
|
|
109696
|
+
"GT",
|
|
109697
|
+
"GG",
|
|
109698
|
+
"GN",
|
|
109699
|
+
"GW",
|
|
109700
|
+
"GY",
|
|
109701
|
+
"HT",
|
|
109702
|
+
"HM",
|
|
109703
|
+
"VA",
|
|
109704
|
+
"HN",
|
|
109705
|
+
"HK",
|
|
109706
|
+
"HU",
|
|
109707
|
+
"IS",
|
|
109708
|
+
"IN",
|
|
109709
|
+
"ID",
|
|
109710
|
+
"IR",
|
|
109711
|
+
"IQ",
|
|
109712
|
+
"IE",
|
|
109713
|
+
"IM",
|
|
109714
|
+
"IL",
|
|
109715
|
+
"IT",
|
|
109716
|
+
"JM",
|
|
109717
|
+
"JP",
|
|
109718
|
+
"JE",
|
|
109719
|
+
"JO",
|
|
109720
|
+
"KZ",
|
|
109721
|
+
"KE",
|
|
109722
|
+
"KI",
|
|
109723
|
+
"KP",
|
|
109724
|
+
"KR",
|
|
109725
|
+
"XK",
|
|
109726
|
+
"KW",
|
|
109727
|
+
"KG",
|
|
109728
|
+
"LA",
|
|
109729
|
+
"LV",
|
|
109730
|
+
"LB",
|
|
109731
|
+
"LS",
|
|
109732
|
+
"LR",
|
|
109733
|
+
"LY",
|
|
109734
|
+
"LI",
|
|
109735
|
+
"LT",
|
|
109736
|
+
"LU",
|
|
109737
|
+
"MO",
|
|
109738
|
+
"MK",
|
|
109739
|
+
"MG",
|
|
109740
|
+
"MW",
|
|
109741
|
+
"MY",
|
|
109742
|
+
"MV",
|
|
109743
|
+
"ML",
|
|
109744
|
+
"MT",
|
|
109745
|
+
"MH",
|
|
109746
|
+
"MQ",
|
|
109747
|
+
"MR",
|
|
109748
|
+
"MU",
|
|
109749
|
+
"YT",
|
|
109750
|
+
"MX",
|
|
109751
|
+
"FM",
|
|
109752
|
+
"MD",
|
|
109753
|
+
"MC",
|
|
109754
|
+
"MN",
|
|
109755
|
+
"ME",
|
|
109756
|
+
"MS",
|
|
109757
|
+
"MA",
|
|
109758
|
+
"MZ",
|
|
109759
|
+
"MM",
|
|
109760
|
+
"NA",
|
|
109761
|
+
"NR",
|
|
109762
|
+
"NP",
|
|
109763
|
+
"NL",
|
|
109764
|
+
"NC",
|
|
109765
|
+
"NZ",
|
|
109766
|
+
"NI",
|
|
109767
|
+
"NE",
|
|
109768
|
+
"NG",
|
|
109769
|
+
"NU",
|
|
109770
|
+
"NF",
|
|
109771
|
+
"MP",
|
|
109772
|
+
"NO",
|
|
109773
|
+
"OM",
|
|
109774
|
+
"PK",
|
|
109775
|
+
"PW",
|
|
109776
|
+
"PS",
|
|
109777
|
+
"PA",
|
|
109778
|
+
"PG",
|
|
109779
|
+
"PY",
|
|
109780
|
+
"PE",
|
|
109781
|
+
"PH",
|
|
109782
|
+
"PN",
|
|
109783
|
+
"PL",
|
|
109784
|
+
"PT",
|
|
109785
|
+
"PR",
|
|
109786
|
+
"QA",
|
|
109787
|
+
"RE",
|
|
109788
|
+
"RO",
|
|
109789
|
+
"RU",
|
|
109790
|
+
"RW",
|
|
109791
|
+
"BL",
|
|
109792
|
+
"SH",
|
|
109793
|
+
"KN",
|
|
109794
|
+
"LC",
|
|
109795
|
+
"MF",
|
|
109796
|
+
"PM",
|
|
109797
|
+
"VC",
|
|
109798
|
+
"WS",
|
|
109799
|
+
"SM",
|
|
109800
|
+
"ST",
|
|
109801
|
+
"SA",
|
|
109802
|
+
"SN",
|
|
109803
|
+
"RS",
|
|
109804
|
+
"SC",
|
|
109805
|
+
"SL",
|
|
109806
|
+
"SG",
|
|
109807
|
+
"SX",
|
|
109808
|
+
"SK",
|
|
109809
|
+
"SI",
|
|
109810
|
+
"SB",
|
|
109811
|
+
"SO",
|
|
109812
|
+
"ZA",
|
|
109813
|
+
"GS",
|
|
109814
|
+
"SS",
|
|
109815
|
+
"ES",
|
|
109816
|
+
"LK",
|
|
109817
|
+
"SD",
|
|
109818
|
+
"SR",
|
|
109819
|
+
"SJ",
|
|
109820
|
+
"SZ",
|
|
109821
|
+
"SE",
|
|
109822
|
+
"CH",
|
|
109823
|
+
"SY",
|
|
109824
|
+
"TW",
|
|
109825
|
+
"TJ",
|
|
109826
|
+
"TZ",
|
|
109827
|
+
"TH",
|
|
109828
|
+
"TL",
|
|
109829
|
+
"TG",
|
|
109830
|
+
"TK",
|
|
109831
|
+
"TO",
|
|
109832
|
+
"TT",
|
|
109833
|
+
"TN",
|
|
109834
|
+
"TR",
|
|
109835
|
+
"TM",
|
|
109836
|
+
"TC",
|
|
109837
|
+
"TV",
|
|
109838
|
+
"UG",
|
|
109839
|
+
"UA",
|
|
109840
|
+
"AE",
|
|
109841
|
+
"GB",
|
|
109842
|
+
"US",
|
|
109843
|
+
"UM",
|
|
109844
|
+
"UY",
|
|
109845
|
+
"UZ",
|
|
109846
|
+
"VU",
|
|
109847
|
+
"VE",
|
|
109848
|
+
"VN",
|
|
109849
|
+
"VG",
|
|
109850
|
+
"VI",
|
|
109851
|
+
"WF",
|
|
109852
|
+
"EH",
|
|
109853
|
+
"YE",
|
|
109854
|
+
"ZM",
|
|
109855
|
+
"ZW"
|
|
109856
|
+
]
|
|
109857
|
+
},
|
|
109858
|
+
"region": {
|
|
109859
|
+
"type": "string",
|
|
109860
|
+
"nullable": true
|
|
109861
|
+
},
|
|
109862
|
+
"city": {
|
|
109863
|
+
"type": "string",
|
|
109864
|
+
"nullable": true
|
|
109865
|
+
},
|
|
109866
|
+
"postCode": {
|
|
109867
|
+
"type": "string",
|
|
109868
|
+
"nullable": true
|
|
109869
|
+
},
|
|
109870
|
+
"address": {
|
|
109871
|
+
"type": "string",
|
|
109872
|
+
"nullable": true
|
|
109873
|
+
},
|
|
109874
|
+
"regNo": {
|
|
109875
|
+
"type": "string",
|
|
109876
|
+
"nullable": true
|
|
109877
|
+
},
|
|
109878
|
+
"taxId": {
|
|
109879
|
+
"type": "string",
|
|
109880
|
+
"nullable": true
|
|
109881
|
+
},
|
|
109882
|
+
"phone": {
|
|
109883
|
+
"type": "string",
|
|
109884
|
+
"nullable": true
|
|
109885
|
+
},
|
|
109886
|
+
"email": {
|
|
109887
|
+
"type": "string",
|
|
109888
|
+
"nullable": true
|
|
109889
|
+
},
|
|
109890
|
+
"bankIban": {
|
|
109891
|
+
"type": "string",
|
|
109892
|
+
"nullable": true,
|
|
109893
|
+
"description": "IBAN of the bank account."
|
|
109894
|
+
},
|
|
109895
|
+
"bankCode": {
|
|
109896
|
+
"type": "string",
|
|
109897
|
+
"nullable": true,
|
|
109898
|
+
"description": "Bank code assigned by a central bank, a bank supervisory body or a Bankers Association in the country."
|
|
109899
|
+
},
|
|
109900
|
+
"bankAccountNumber": {
|
|
109901
|
+
"type": "string",
|
|
109902
|
+
"nullable": true,
|
|
109903
|
+
"description": "Bank account number."
|
|
109904
|
+
},
|
|
109905
|
+
"bankAccountType": {
|
|
109906
|
+
"type": "string",
|
|
109907
|
+
"nullable": true,
|
|
109908
|
+
"description": "Type of the bank account."
|
|
109909
|
+
},
|
|
109910
|
+
"bankBic": {
|
|
109911
|
+
"type": "string",
|
|
109912
|
+
"nullable": true,
|
|
109913
|
+
"description": "BIC/SWIFT code of the bank."
|
|
109914
|
+
}
|
|
109915
|
+
},
|
|
109916
|
+
"required": [
|
|
109917
|
+
"type",
|
|
109918
|
+
"name",
|
|
109919
|
+
"contactPerson",
|
|
109920
|
+
"country",
|
|
109921
|
+
"region",
|
|
109922
|
+
"city",
|
|
109923
|
+
"postCode",
|
|
109924
|
+
"address",
|
|
109925
|
+
"regNo",
|
|
109926
|
+
"taxId",
|
|
109927
|
+
"phone",
|
|
109928
|
+
"email",
|
|
109929
|
+
"bankIban",
|
|
109930
|
+
"bankName",
|
|
109931
|
+
"bankAddress",
|
|
109932
|
+
"bankCode",
|
|
109933
|
+
"bankAccountNumber",
|
|
109934
|
+
"bankAccountType",
|
|
109935
|
+
"bankAccountHolder",
|
|
109936
|
+
"bankBic"
|
|
109937
|
+
]
|
|
109938
|
+
},
|
|
109939
|
+
"downloadUrl": {
|
|
109940
|
+
"type": "string",
|
|
109941
|
+
"format": "url",
|
|
109942
|
+
"description": "Link to download the full settlement report document."
|
|
109943
|
+
},
|
|
109944
|
+
"externalId": {
|
|
109945
|
+
"description": "An optional external identifier for integration purposes",
|
|
109946
|
+
"type": "string",
|
|
109947
|
+
"maxLength": 255
|
|
109948
|
+
},
|
|
109949
|
+
"deductedFees": {
|
|
109950
|
+
"description": "Aggregated deducted fees for the settlement period. Included only when at least one fee is non-zero, and each individual fee is included only when the settlement report holds a stored value for it.\n\nA tax-inclusive amount, when present, is the stored total of the tax-inclusive amounts of the underlying records, substituting the tax-exclusive amount for any record that carries no tax-inclusive one.\n",
|
|
109951
|
+
"type": "object",
|
|
109952
|
+
"properties": {
|
|
109953
|
+
"perSessionAc": {
|
|
109954
|
+
"description": "Total fixed fee for AC sessions in the settlement period.",
|
|
109955
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109956
|
+
},
|
|
109957
|
+
"perSessionDc": {
|
|
109958
|
+
"description": "Total fixed fee for DC sessions in the settlement period.",
|
|
109959
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109960
|
+
},
|
|
109961
|
+
"perKwhAc": {
|
|
109962
|
+
"description": "Total fee per AC kWh delivered in the settlement period.",
|
|
109963
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109964
|
+
},
|
|
109965
|
+
"perKwhDc": {
|
|
109966
|
+
"description": "Total fee per DC kWh delivered in the settlement period.",
|
|
109967
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109968
|
+
},
|
|
109969
|
+
"handling": {
|
|
109970
|
+
"description": "Total percentage-based handling fee for the settlement period.\n\n`withoutTax` is the tax-exclusive fee total, whereas the v1.0 `handlingFee` number was the tax-inclusive amount.\n",
|
|
109971
|
+
"$ref": "#/paths/~1public-api~1resources~1partner-settlement-reports~1v1.1~1%7BpartnerSettlementReport%7D/get/responses/200/content/application~1json/schema/properties/data"
|
|
109972
|
+
}
|
|
109973
|
+
}
|
|
109974
|
+
},
|
|
109975
|
+
"partnerInvoiceId": {
|
|
109976
|
+
"type": "integer",
|
|
109977
|
+
"description": "Identifier of the latest issued partner invoice for this settlement report.\nOmitted when no partner invoice has been issued.\nRetained after a credit note is issued — the credit note is a separate document and the reference points at the invoice the report produced.\n"
|
|
109978
|
+
},
|
|
109979
|
+
"customFields": {
|
|
109980
|
+
"description": "Live 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 settlement report's current partner owner or are not visible to the acting administrator are omitted. The `customFields` property itself is omitted when no fields apply.\n\nThese values reflect the current custom field configuration and are not captured in the historical settlement report document, its party and settings snapshots, or derived partner invoices. Existing settlement report access controls continue to determine whether the report can be read; custom field visibility does not grant access to a report.\n",
|
|
109981
|
+
"type": "object",
|
|
109982
|
+
"additionalProperties": true
|
|
109983
|
+
}
|
|
109984
|
+
},
|
|
109985
|
+
"required": [
|
|
109986
|
+
"id",
|
|
109987
|
+
"partnerId",
|
|
109988
|
+
"number",
|
|
109989
|
+
"date",
|
|
109990
|
+
"periodStart",
|
|
109991
|
+
"periodEnd",
|
|
109992
|
+
"currencyCode",
|
|
109993
|
+
"totals",
|
|
109994
|
+
"totalEnergyCpoWh",
|
|
109995
|
+
"totalEnergyEmspWh",
|
|
109996
|
+
"supplier",
|
|
109997
|
+
"customer",
|
|
109998
|
+
"downloadUrl"
|
|
109999
|
+
]
|
|
110000
|
+
}
|
|
110001
|
+
},
|
|
110002
|
+
"links": {
|
|
110003
|
+
"type": "object",
|
|
110004
|
+
"properties": {
|
|
110005
|
+
"first": {
|
|
110006
|
+
"type": "string",
|
|
110007
|
+
"description": "The URL to fetch the first page",
|
|
110008
|
+
"nullable": true
|
|
110009
|
+
},
|
|
110010
|
+
"last": {
|
|
110011
|
+
"type": "string",
|
|
110012
|
+
"description": "The URL to fetch the last page",
|
|
110013
|
+
"nullable": true
|
|
110014
|
+
},
|
|
110015
|
+
"prev": {
|
|
110016
|
+
"type": "string",
|
|
110017
|
+
"description": "The URL to fetch the previous page",
|
|
110018
|
+
"nullable": true
|
|
110019
|
+
},
|
|
110020
|
+
"next": {
|
|
110021
|
+
"type": "string",
|
|
110022
|
+
"description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
|
|
110023
|
+
"nullable": true
|
|
110024
|
+
}
|
|
110025
|
+
}
|
|
110026
|
+
},
|
|
110027
|
+
"meta": {
|
|
110028
|
+
"type": "object",
|
|
110029
|
+
"properties": {
|
|
110030
|
+
"path": {
|
|
110031
|
+
"type": "string",
|
|
110032
|
+
"description": "The base route of the endpoint (unpaginated)"
|
|
110033
|
+
},
|
|
110034
|
+
"per_page": {
|
|
110035
|
+
"type": "integer",
|
|
110036
|
+
"description": "The max number of items in each page"
|
|
110037
|
+
},
|
|
110038
|
+
"next_cursor": {
|
|
110039
|
+
"type": "string",
|
|
110040
|
+
"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.",
|
|
110041
|
+
"nullable": true
|
|
110042
|
+
},
|
|
110043
|
+
"prev_cursor": {
|
|
110044
|
+
"type": "string",
|
|
110045
|
+
"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.",
|
|
110046
|
+
"nullable": true
|
|
110047
|
+
}
|
|
110048
|
+
}
|
|
110049
|
+
}
|
|
110050
|
+
},
|
|
110051
|
+
"required": [
|
|
110052
|
+
"data",
|
|
110053
|
+
"links",
|
|
110054
|
+
"meta"
|
|
110055
|
+
]
|
|
110056
|
+
}
|
|
110057
|
+
},
|
|
110058
|
+
"401": {
|
|
110059
|
+
"schema": {
|
|
110060
|
+
"type": "object",
|
|
110061
|
+
"properties": {
|
|
110062
|
+
"message": {
|
|
110063
|
+
"type": "string"
|
|
110064
|
+
}
|
|
110065
|
+
}
|
|
110066
|
+
}
|
|
110067
|
+
},
|
|
110068
|
+
"403": {
|
|
110069
|
+
"schema": {
|
|
110070
|
+
"type": "object",
|
|
110071
|
+
"properties": {
|
|
110072
|
+
"message": {
|
|
110073
|
+
"type": "string",
|
|
110074
|
+
"default": "This action is unauthorized."
|
|
110075
|
+
}
|
|
110076
|
+
}
|
|
110077
|
+
}
|
|
110078
|
+
},
|
|
110079
|
+
"404": {
|
|
110080
|
+
"schema": {
|
|
110081
|
+
"type": "object",
|
|
110082
|
+
"properties": {
|
|
110083
|
+
"message": {
|
|
110084
|
+
"type": "string"
|
|
110085
|
+
}
|
|
110086
|
+
}
|
|
110087
|
+
}
|
|
110088
|
+
},
|
|
110089
|
+
"422": {
|
|
110090
|
+
"schema": {
|
|
110091
|
+
"type": "object",
|
|
110092
|
+
"required": [
|
|
110093
|
+
"message"
|
|
110094
|
+
],
|
|
110095
|
+
"properties": {
|
|
110096
|
+
"message": {
|
|
110097
|
+
"type": "string"
|
|
110098
|
+
},
|
|
110099
|
+
"errors": {
|
|
110100
|
+
"type": "object",
|
|
110101
|
+
"additionalProperties": {
|
|
110102
|
+
"type": "array",
|
|
110103
|
+
"items": {
|
|
110104
|
+
"type": "string"
|
|
110105
|
+
}
|
|
110106
|
+
}
|
|
110107
|
+
}
|
|
110108
|
+
}
|
|
110109
|
+
}
|
|
110110
|
+
},
|
|
110111
|
+
"429": {
|
|
110112
|
+
"schema": {
|
|
110113
|
+
"type": "object",
|
|
110114
|
+
"properties": {
|
|
110115
|
+
"message": {
|
|
110116
|
+
"type": "string"
|
|
110117
|
+
}
|
|
110118
|
+
}
|
|
110119
|
+
}
|
|
110120
|
+
}
|
|
110121
|
+
},
|
|
110122
|
+
"partnerSettlementReportReadV1_1": {
|
|
110123
|
+
"200": {
|
|
110124
|
+
"schema": {
|
|
110125
|
+
"type": "object",
|
|
110126
|
+
"properties": {
|
|
110127
|
+
"data": {
|
|
110128
|
+
"type": "object",
|
|
110129
|
+
"properties": {
|
|
110130
|
+
"id": {
|
|
110131
|
+
"type": "integer",
|
|
110132
|
+
"description": "Unique settlement report identifier."
|
|
110133
|
+
},
|
|
110134
|
+
"partnerId": {
|
|
110135
|
+
"type": "integer",
|
|
110136
|
+
"description": "Unique identifier of the partner involved in the settlement."
|
|
110137
|
+
},
|
|
110138
|
+
"number": {
|
|
110139
|
+
"type": "string",
|
|
110140
|
+
"description": "Settlement report reference number."
|
|
110141
|
+
},
|
|
110142
|
+
"date": {
|
|
110143
|
+
"type": "string",
|
|
110144
|
+
"format": "date",
|
|
110145
|
+
"description": "Date the settlement report was generated."
|
|
110146
|
+
},
|
|
110147
|
+
"periodStart": {
|
|
110148
|
+
"type": "string",
|
|
110149
|
+
"format": "date",
|
|
110150
|
+
"description": "Start date of the period covered by the report."
|
|
110151
|
+
},
|
|
110152
|
+
"periodEnd": {
|
|
110153
|
+
"type": "string",
|
|
110154
|
+
"format": "date",
|
|
110155
|
+
"description": "End date of the period covered by the report."
|
|
110156
|
+
},
|
|
110157
|
+
"currencyCode": {
|
|
110158
|
+
"description": "Currency used in the settlement (e.g., USD, EUR).",
|
|
110159
|
+
"type": "string",
|
|
110160
|
+
"enum": [
|
|
110161
|
+
"AED",
|
|
110162
|
+
"AFN",
|
|
110163
|
+
"ALL",
|
|
110164
|
+
"AMD",
|
|
110165
|
+
"ANG",
|
|
110166
|
+
"AOA",
|
|
110167
|
+
"ARS",
|
|
110168
|
+
"AUD",
|
|
110169
|
+
"AWG",
|
|
110170
|
+
"AZN",
|
|
110171
|
+
"BAM",
|
|
110172
|
+
"BBD",
|
|
110173
|
+
"BDT",
|
|
110174
|
+
"BGN",
|
|
110175
|
+
"BHD",
|
|
110176
|
+
"BIF",
|
|
110177
|
+
"BMD",
|
|
110178
|
+
"BND",
|
|
110179
|
+
"BOB",
|
|
110180
|
+
"BOV",
|
|
110181
|
+
"BRL",
|
|
110182
|
+
"BSD",
|
|
110183
|
+
"BTN",
|
|
110184
|
+
"BWP",
|
|
110185
|
+
"BYN",
|
|
110186
|
+
"BZD",
|
|
110187
|
+
"CAD",
|
|
110188
|
+
"CDF",
|
|
110189
|
+
"CHE",
|
|
110190
|
+
"CHF",
|
|
110191
|
+
"CHW",
|
|
110192
|
+
"CLF",
|
|
110193
|
+
"CLP",
|
|
110194
|
+
"CNY",
|
|
110195
|
+
"COP",
|
|
110196
|
+
"COU",
|
|
110197
|
+
"CRC",
|
|
110198
|
+
"CUC",
|
|
110199
|
+
"CUP",
|
|
110200
|
+
"CVE",
|
|
110201
|
+
"CZK",
|
|
110202
|
+
"DJF",
|
|
110203
|
+
"DKK",
|
|
110204
|
+
"DOP",
|
|
110205
|
+
"DZD",
|
|
110206
|
+
"EGP",
|
|
110207
|
+
"ERN",
|
|
110208
|
+
"ETB",
|
|
110209
|
+
"EUR",
|
|
110210
|
+
"FJD",
|
|
110211
|
+
"FKP",
|
|
110212
|
+
"GBP",
|
|
110213
|
+
"GEL",
|
|
110214
|
+
"GHS",
|
|
110215
|
+
"GIP",
|
|
110216
|
+
"GMD",
|
|
110217
|
+
"GNF",
|
|
110218
|
+
"GTQ",
|
|
110219
|
+
"GYD",
|
|
110220
|
+
"HKD",
|
|
110221
|
+
"HNL",
|
|
110222
|
+
"HRK",
|
|
110223
|
+
"HTG",
|
|
110224
|
+
"HUF",
|
|
110225
|
+
"IDR",
|
|
110226
|
+
"ILS",
|
|
110227
|
+
"INR",
|
|
110228
|
+
"IQD",
|
|
110229
|
+
"IRR",
|
|
110230
|
+
"ISK",
|
|
110231
|
+
"JMD",
|
|
110232
|
+
"JOD",
|
|
110233
|
+
"JPY",
|
|
110234
|
+
"KES",
|
|
110235
|
+
"KGS",
|
|
110236
|
+
"KHR",
|
|
110237
|
+
"KMF",
|
|
110238
|
+
"KPW",
|
|
110239
|
+
"KRW",
|
|
110240
|
+
"KWD",
|
|
110241
|
+
"KYD",
|
|
110242
|
+
"KZT",
|
|
110243
|
+
"LAK",
|
|
110244
|
+
"LBP",
|
|
110245
|
+
"LKR",
|
|
110246
|
+
"LRD",
|
|
110247
|
+
"LSL",
|
|
110248
|
+
"LYD",
|
|
110249
|
+
"MAD",
|
|
110250
|
+
"MDL",
|
|
110251
|
+
"MGA",
|
|
110252
|
+
"MKD",
|
|
110253
|
+
"MMK",
|
|
110254
|
+
"MNT",
|
|
110255
|
+
"MOP",
|
|
110256
|
+
"MRU",
|
|
110257
|
+
"MUR",
|
|
110258
|
+
"MVR",
|
|
110259
|
+
"MWK",
|
|
110260
|
+
"MXN",
|
|
110261
|
+
"MXV",
|
|
110262
|
+
"MYR",
|
|
110263
|
+
"MZN",
|
|
110264
|
+
"NAD",
|
|
110265
|
+
"NGN",
|
|
110266
|
+
"NIO",
|
|
110267
|
+
"NOK",
|
|
110268
|
+
"NPR",
|
|
110269
|
+
"NZD",
|
|
110270
|
+
"OMR",
|
|
110271
|
+
"PAB",
|
|
110272
|
+
"PEN",
|
|
110273
|
+
"PGK",
|
|
110274
|
+
"PHP",
|
|
110275
|
+
"PKR",
|
|
110276
|
+
"PLN",
|
|
110277
|
+
"PYG",
|
|
110278
|
+
"QAR",
|
|
110279
|
+
"RON",
|
|
110280
|
+
"RSD",
|
|
110281
|
+
"RUB",
|
|
110282
|
+
"RWF",
|
|
110283
|
+
"SAR",
|
|
110284
|
+
"SBD",
|
|
110285
|
+
"SCR",
|
|
110286
|
+
"SDG",
|
|
110287
|
+
"SEK",
|
|
110288
|
+
"SGD",
|
|
110289
|
+
"SHP",
|
|
110290
|
+
"SLL",
|
|
110291
|
+
"SOS",
|
|
110292
|
+
"SRD",
|
|
110293
|
+
"SSP",
|
|
110294
|
+
"STN",
|
|
110295
|
+
"SVC",
|
|
110296
|
+
"SYP",
|
|
110297
|
+
"SZL",
|
|
110298
|
+
"THB",
|
|
110299
|
+
"TJS",
|
|
110300
|
+
"TMT",
|
|
110301
|
+
"TND",
|
|
110302
|
+
"TOP",
|
|
110303
|
+
"TRY",
|
|
110304
|
+
"TTD",
|
|
110305
|
+
"TWD",
|
|
110306
|
+
"TZS",
|
|
110307
|
+
"UAH",
|
|
110308
|
+
"UGX",
|
|
110309
|
+
"USD",
|
|
110310
|
+
"USN",
|
|
110311
|
+
"UYI",
|
|
110312
|
+
"UYU",
|
|
110313
|
+
"UYW",
|
|
110314
|
+
"UZS",
|
|
110315
|
+
"VES",
|
|
110316
|
+
"VND",
|
|
110317
|
+
"VUV",
|
|
110318
|
+
"WST",
|
|
110319
|
+
"XAF",
|
|
110320
|
+
"XAG",
|
|
110321
|
+
"XAU",
|
|
110322
|
+
"XBA",
|
|
110323
|
+
"XBB",
|
|
110324
|
+
"XBC",
|
|
110325
|
+
"XBD",
|
|
110326
|
+
"XCD",
|
|
110327
|
+
"XDR",
|
|
110328
|
+
"XOF",
|
|
110329
|
+
"XPD",
|
|
110330
|
+
"XPF",
|
|
110331
|
+
"XPT",
|
|
110332
|
+
"XSU",
|
|
110333
|
+
"XTS",
|
|
110334
|
+
"XUA",
|
|
110335
|
+
"XXX",
|
|
110336
|
+
"YER",
|
|
110337
|
+
"ZAR",
|
|
110338
|
+
"ZMW",
|
|
110339
|
+
"ZWL"
|
|
110340
|
+
]
|
|
110341
|
+
},
|
|
110342
|
+
"totals": {
|
|
110343
|
+
"description": "Settlement totals for the period, each with the tax-exclusive amount and, where stored, the tax-inclusive amount.\n\nA tax-inclusive amount, when present, is the stored total of the tax-inclusive amounts of the underlying records, substituting the tax-exclusive amount for any record that carries no tax-inclusive one.\n",
|
|
110344
|
+
"type": "object",
|
|
110345
|
+
"properties": {
|
|
110346
|
+
"amount": {
|
|
110347
|
+
"description": "Total settlement amount.",
|
|
110348
|
+
"type": "object",
|
|
110349
|
+
"properties": {
|
|
110350
|
+
"withoutTax": {
|
|
110351
|
+
"type": "number",
|
|
110352
|
+
"description": "The tax-exclusive amount."
|
|
110353
|
+
},
|
|
110354
|
+
"withTax": {
|
|
110355
|
+
"type": "number",
|
|
110356
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
110357
|
+
}
|
|
110358
|
+
},
|
|
110359
|
+
"required": [
|
|
110360
|
+
"withoutTax"
|
|
110361
|
+
]
|
|
110362
|
+
},
|
|
110363
|
+
"expenses": {
|
|
110364
|
+
"description": "Total expenses incurred during the settlement period.",
|
|
110365
|
+
"type": "object",
|
|
110366
|
+
"properties": {
|
|
110367
|
+
"withoutTax": {
|
|
110368
|
+
"type": "number",
|
|
110369
|
+
"description": "The tax-exclusive amount."
|
|
110370
|
+
},
|
|
110371
|
+
"withTax": {
|
|
110372
|
+
"type": "number",
|
|
110373
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
110374
|
+
}
|
|
110375
|
+
},
|
|
110376
|
+
"required": [
|
|
110377
|
+
"withoutTax"
|
|
110378
|
+
]
|
|
110379
|
+
},
|
|
110380
|
+
"revenue": {
|
|
110381
|
+
"description": "Total revenue generated during the settlement period.",
|
|
110382
|
+
"type": "object",
|
|
110383
|
+
"properties": {
|
|
110384
|
+
"withoutTax": {
|
|
110385
|
+
"type": "number",
|
|
110386
|
+
"description": "The tax-exclusive amount."
|
|
110387
|
+
},
|
|
110388
|
+
"withTax": {
|
|
110389
|
+
"type": "number",
|
|
110390
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
110391
|
+
}
|
|
110392
|
+
},
|
|
110393
|
+
"required": [
|
|
110394
|
+
"withoutTax"
|
|
110395
|
+
]
|
|
110396
|
+
},
|
|
110397
|
+
"awaitedRevenue": {
|
|
110398
|
+
"description": "Revenue expected but not yet collected.",
|
|
110399
|
+
"type": "object",
|
|
110400
|
+
"properties": {
|
|
110401
|
+
"withoutTax": {
|
|
110402
|
+
"type": "number",
|
|
110403
|
+
"description": "The tax-exclusive amount."
|
|
110404
|
+
},
|
|
110405
|
+
"withTax": {
|
|
110406
|
+
"type": "number",
|
|
110407
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
110408
|
+
}
|
|
110409
|
+
},
|
|
110410
|
+
"required": [
|
|
110411
|
+
"withoutTax"
|
|
110412
|
+
]
|
|
110413
|
+
},
|
|
110414
|
+
"collectedRevenue": {
|
|
110415
|
+
"description": "Revenue collected during the settlement period.",
|
|
110416
|
+
"type": "object",
|
|
110417
|
+
"properties": {
|
|
110418
|
+
"withoutTax": {
|
|
110419
|
+
"type": "number",
|
|
110420
|
+
"description": "The tax-exclusive amount."
|
|
110421
|
+
},
|
|
110422
|
+
"withTax": {
|
|
110423
|
+
"type": "number",
|
|
110424
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
110425
|
+
}
|
|
110426
|
+
},
|
|
110427
|
+
"required": [
|
|
110428
|
+
"withoutTax"
|
|
110429
|
+
]
|
|
110430
|
+
},
|
|
110431
|
+
"collectedRevenueFromPreviousPeriod": {
|
|
110432
|
+
"description": "Revenue collected during this period, but related to a previous periods.",
|
|
110433
|
+
"type": "object",
|
|
110434
|
+
"properties": {
|
|
110435
|
+
"withoutTax": {
|
|
110436
|
+
"type": "number",
|
|
110437
|
+
"description": "The tax-exclusive amount."
|
|
110438
|
+
},
|
|
110439
|
+
"withTax": {
|
|
110440
|
+
"type": "number",
|
|
110441
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
110442
|
+
}
|
|
110443
|
+
},
|
|
110444
|
+
"required": [
|
|
110445
|
+
"withoutTax"
|
|
110446
|
+
]
|
|
110447
|
+
}
|
|
110448
|
+
},
|
|
110449
|
+
"required": [
|
|
110450
|
+
"amount",
|
|
110451
|
+
"expenses",
|
|
110452
|
+
"revenue",
|
|
110453
|
+
"awaitedRevenue",
|
|
110454
|
+
"collectedRevenue",
|
|
110455
|
+
"collectedRevenueFromPreviousPeriod"
|
|
110456
|
+
]
|
|
110457
|
+
},
|
|
110458
|
+
"totalEnergyCpoWh": {
|
|
110459
|
+
"type": "number",
|
|
110460
|
+
"description": "Total amount of energy (in Wh) delivered by the Charge Point Operator."
|
|
110461
|
+
},
|
|
110462
|
+
"totalEnergyEmspWh": {
|
|
110463
|
+
"type": "number",
|
|
110464
|
+
"description": "Total amount of energy (in Wh) consumed by the EMSP."
|
|
110465
|
+
},
|
|
110466
|
+
"supplier": {
|
|
110467
|
+
"description": "Company details for the entity supplying the service - the CPO.",
|
|
110468
|
+
"type": "object",
|
|
110469
|
+
"properties": {
|
|
110470
|
+
"type": {
|
|
110471
|
+
"type": "string",
|
|
110472
|
+
"enum": [
|
|
110473
|
+
"individual",
|
|
110474
|
+
"company"
|
|
110475
|
+
]
|
|
110476
|
+
},
|
|
110477
|
+
"name": {
|
|
110478
|
+
"type": "string"
|
|
110479
|
+
},
|
|
110480
|
+
"contactPerson": {
|
|
110481
|
+
"type": "string",
|
|
110482
|
+
"nullable": true
|
|
110483
|
+
},
|
|
110484
|
+
"country": {
|
|
110485
|
+
"type": "string",
|
|
110486
|
+
"nullable": true,
|
|
110487
|
+
"enum": [
|
|
110488
|
+
"AF",
|
|
110489
|
+
"AX",
|
|
110490
|
+
"AL",
|
|
110491
|
+
"DZ",
|
|
110492
|
+
"AS",
|
|
110493
|
+
"AD",
|
|
110494
|
+
"AO",
|
|
110495
|
+
"AI",
|
|
110496
|
+
"AQ",
|
|
110497
|
+
"AG",
|
|
110498
|
+
"AR",
|
|
110499
|
+
"AM",
|
|
110500
|
+
"AW",
|
|
110501
|
+
"AU",
|
|
110502
|
+
"AT",
|
|
110503
|
+
"AZ",
|
|
110504
|
+
"BS",
|
|
110505
|
+
"BH",
|
|
110506
|
+
"BD",
|
|
110507
|
+
"BB",
|
|
110508
|
+
"BY",
|
|
110509
|
+
"BE",
|
|
110510
|
+
"BZ",
|
|
110511
|
+
"BJ",
|
|
110512
|
+
"BM",
|
|
110513
|
+
"BT",
|
|
110514
|
+
"BO",
|
|
110515
|
+
"BQ",
|
|
110516
|
+
"BA",
|
|
110517
|
+
"BW",
|
|
110518
|
+
"BV",
|
|
110519
|
+
"BR",
|
|
110520
|
+
"IO",
|
|
110521
|
+
"BN",
|
|
110522
|
+
"BG",
|
|
110523
|
+
"BF",
|
|
110524
|
+
"BI",
|
|
110525
|
+
"KH",
|
|
110526
|
+
"CM",
|
|
110527
|
+
"CA",
|
|
110528
|
+
"CV",
|
|
110529
|
+
"KY",
|
|
110530
|
+
"CF",
|
|
110531
|
+
"TD",
|
|
110532
|
+
"CL",
|
|
110533
|
+
"CN",
|
|
110534
|
+
"CX",
|
|
110535
|
+
"CC",
|
|
110536
|
+
"CO",
|
|
110537
|
+
"KM",
|
|
110538
|
+
"CG",
|
|
110539
|
+
"CD",
|
|
110540
|
+
"CK",
|
|
110541
|
+
"CR",
|
|
110542
|
+
"CI",
|
|
110543
|
+
"HR",
|
|
110544
|
+
"CU",
|
|
110545
|
+
"CW",
|
|
110546
|
+
"CY",
|
|
110547
|
+
"CZ",
|
|
110548
|
+
"DK",
|
|
110549
|
+
"DJ",
|
|
110550
|
+
"DM",
|
|
110551
|
+
"DO",
|
|
110552
|
+
"EC",
|
|
110553
|
+
"EG",
|
|
110554
|
+
"SV",
|
|
110555
|
+
"GQ",
|
|
110556
|
+
"ER",
|
|
110557
|
+
"EE",
|
|
110558
|
+
"ET",
|
|
110559
|
+
"FK",
|
|
110560
|
+
"FO",
|
|
110561
|
+
"FJ",
|
|
110562
|
+
"FI",
|
|
110563
|
+
"FR",
|
|
110564
|
+
"GF",
|
|
110565
|
+
"PF",
|
|
110566
|
+
"TF",
|
|
110567
|
+
"GA",
|
|
110568
|
+
"GM",
|
|
110569
|
+
"GE",
|
|
110570
|
+
"DE",
|
|
110571
|
+
"GH",
|
|
110572
|
+
"GI",
|
|
110573
|
+
"GR",
|
|
110574
|
+
"GL",
|
|
110575
|
+
"GD",
|
|
110576
|
+
"GP",
|
|
110577
|
+
"GU",
|
|
110578
|
+
"GT",
|
|
110579
|
+
"GG",
|
|
110580
|
+
"GN",
|
|
110581
|
+
"GW",
|
|
110582
|
+
"GY",
|
|
110583
|
+
"HT",
|
|
110584
|
+
"HM",
|
|
110585
|
+
"VA",
|
|
110586
|
+
"HN",
|
|
110587
|
+
"HK",
|
|
110588
|
+
"HU",
|
|
110589
|
+
"IS",
|
|
110590
|
+
"IN",
|
|
110591
|
+
"ID",
|
|
110592
|
+
"IR",
|
|
110593
|
+
"IQ",
|
|
110594
|
+
"IE",
|
|
110595
|
+
"IM",
|
|
110596
|
+
"IL",
|
|
110597
|
+
"IT",
|
|
110598
|
+
"JM",
|
|
110599
|
+
"JP",
|
|
110600
|
+
"JE",
|
|
110601
|
+
"JO",
|
|
110602
|
+
"KZ",
|
|
110603
|
+
"KE",
|
|
110604
|
+
"KI",
|
|
110605
|
+
"KP",
|
|
110606
|
+
"KR",
|
|
110607
|
+
"XK",
|
|
110608
|
+
"KW",
|
|
110609
|
+
"KG",
|
|
110610
|
+
"LA",
|
|
110611
|
+
"LV",
|
|
110612
|
+
"LB",
|
|
110613
|
+
"LS",
|
|
110614
|
+
"LR",
|
|
110615
|
+
"LY",
|
|
110616
|
+
"LI",
|
|
110617
|
+
"LT",
|
|
110618
|
+
"LU",
|
|
110619
|
+
"MO",
|
|
110620
|
+
"MK",
|
|
110621
|
+
"MG",
|
|
110622
|
+
"MW",
|
|
110623
|
+
"MY",
|
|
110624
|
+
"MV",
|
|
110625
|
+
"ML",
|
|
110626
|
+
"MT",
|
|
110627
|
+
"MH",
|
|
110628
|
+
"MQ",
|
|
110629
|
+
"MR",
|
|
110630
|
+
"MU",
|
|
110631
|
+
"YT",
|
|
110632
|
+
"MX",
|
|
110633
|
+
"FM",
|
|
110634
|
+
"MD",
|
|
110635
|
+
"MC",
|
|
110636
|
+
"MN",
|
|
110637
|
+
"ME",
|
|
110638
|
+
"MS",
|
|
110639
|
+
"MA",
|
|
110640
|
+
"MZ",
|
|
110641
|
+
"MM",
|
|
110642
|
+
"NA",
|
|
110643
|
+
"NR",
|
|
110644
|
+
"NP",
|
|
110645
|
+
"NL",
|
|
110646
|
+
"NC",
|
|
110647
|
+
"NZ",
|
|
110648
|
+
"NI",
|
|
110649
|
+
"NE",
|
|
110650
|
+
"NG",
|
|
110651
|
+
"NU",
|
|
110652
|
+
"NF",
|
|
110653
|
+
"MP",
|
|
110654
|
+
"NO",
|
|
110655
|
+
"OM",
|
|
110656
|
+
"PK",
|
|
110657
|
+
"PW",
|
|
110658
|
+
"PS",
|
|
110659
|
+
"PA",
|
|
110660
|
+
"PG",
|
|
110661
|
+
"PY",
|
|
110662
|
+
"PE",
|
|
110663
|
+
"PH",
|
|
110664
|
+
"PN",
|
|
110665
|
+
"PL",
|
|
110666
|
+
"PT",
|
|
110667
|
+
"PR",
|
|
110668
|
+
"QA",
|
|
110669
|
+
"RE",
|
|
110670
|
+
"RO",
|
|
110671
|
+
"RU",
|
|
110672
|
+
"RW",
|
|
110673
|
+
"BL",
|
|
110674
|
+
"SH",
|
|
110675
|
+
"KN",
|
|
110676
|
+
"LC",
|
|
110677
|
+
"MF",
|
|
110678
|
+
"PM",
|
|
110679
|
+
"VC",
|
|
110680
|
+
"WS",
|
|
110681
|
+
"SM",
|
|
110682
|
+
"ST",
|
|
110683
|
+
"SA",
|
|
110684
|
+
"SN",
|
|
110685
|
+
"RS",
|
|
110686
|
+
"SC",
|
|
110687
|
+
"SL",
|
|
110688
|
+
"SG",
|
|
110689
|
+
"SX",
|
|
110690
|
+
"SK",
|
|
110691
|
+
"SI",
|
|
110692
|
+
"SB",
|
|
110693
|
+
"SO",
|
|
110694
|
+
"ZA",
|
|
110695
|
+
"GS",
|
|
110696
|
+
"SS",
|
|
110697
|
+
"ES",
|
|
110698
|
+
"LK",
|
|
110699
|
+
"SD",
|
|
110700
|
+
"SR",
|
|
110701
|
+
"SJ",
|
|
110702
|
+
"SZ",
|
|
110703
|
+
"SE",
|
|
110704
|
+
"CH",
|
|
110705
|
+
"SY",
|
|
110706
|
+
"TW",
|
|
110707
|
+
"TJ",
|
|
110708
|
+
"TZ",
|
|
110709
|
+
"TH",
|
|
110710
|
+
"TL",
|
|
110711
|
+
"TG",
|
|
110712
|
+
"TK",
|
|
110713
|
+
"TO",
|
|
110714
|
+
"TT",
|
|
110715
|
+
"TN",
|
|
110716
|
+
"TR",
|
|
110717
|
+
"TM",
|
|
110718
|
+
"TC",
|
|
110719
|
+
"TV",
|
|
110720
|
+
"UG",
|
|
110721
|
+
"UA",
|
|
110722
|
+
"AE",
|
|
110723
|
+
"GB",
|
|
110724
|
+
"US",
|
|
110725
|
+
"UM",
|
|
110726
|
+
"UY",
|
|
110727
|
+
"UZ",
|
|
110728
|
+
"VU",
|
|
110729
|
+
"VE",
|
|
110730
|
+
"VN",
|
|
110731
|
+
"VG",
|
|
110732
|
+
"VI",
|
|
110733
|
+
"WF",
|
|
110734
|
+
"EH",
|
|
110735
|
+
"YE",
|
|
110736
|
+
"ZM",
|
|
110737
|
+
"ZW"
|
|
110738
|
+
]
|
|
110739
|
+
},
|
|
110740
|
+
"region": {
|
|
110741
|
+
"type": "string",
|
|
110742
|
+
"nullable": true
|
|
110743
|
+
},
|
|
110744
|
+
"city": {
|
|
110745
|
+
"type": "string",
|
|
110746
|
+
"nullable": true
|
|
110747
|
+
},
|
|
110748
|
+
"postCode": {
|
|
110749
|
+
"type": "string",
|
|
110750
|
+
"nullable": true
|
|
110751
|
+
},
|
|
110752
|
+
"address": {
|
|
110753
|
+
"type": "string",
|
|
110754
|
+
"nullable": true
|
|
110755
|
+
},
|
|
110756
|
+
"regNo": {
|
|
110757
|
+
"type": "string",
|
|
110758
|
+
"nullable": true
|
|
110759
|
+
},
|
|
110760
|
+
"taxId": {
|
|
110761
|
+
"type": "string",
|
|
110762
|
+
"nullable": true
|
|
110763
|
+
},
|
|
110764
|
+
"phone": {
|
|
110765
|
+
"type": "string",
|
|
110766
|
+
"nullable": true
|
|
110767
|
+
},
|
|
110768
|
+
"email": {
|
|
110769
|
+
"type": "string",
|
|
110770
|
+
"nullable": true
|
|
110771
|
+
}
|
|
110772
|
+
},
|
|
110773
|
+
"required": [
|
|
110774
|
+
"type",
|
|
110775
|
+
"name",
|
|
110776
|
+
"contactPerson",
|
|
110777
|
+
"country",
|
|
110778
|
+
"region",
|
|
110779
|
+
"city",
|
|
110780
|
+
"postCode",
|
|
110781
|
+
"address",
|
|
110782
|
+
"regNo",
|
|
110783
|
+
"taxId",
|
|
110784
|
+
"phone",
|
|
110785
|
+
"email"
|
|
110786
|
+
]
|
|
110787
|
+
},
|
|
110788
|
+
"customer": {
|
|
110789
|
+
"description": "Company details for the entity receiving the service - the Partner/EMSP.",
|
|
110790
|
+
"type": "object",
|
|
110791
|
+
"properties": {
|
|
110792
|
+
"type": {
|
|
110793
|
+
"type": "string",
|
|
110794
|
+
"enum": [
|
|
110795
|
+
"individual",
|
|
110796
|
+
"company"
|
|
110797
|
+
]
|
|
110798
|
+
},
|
|
110799
|
+
"name": {
|
|
110800
|
+
"type": "string"
|
|
110801
|
+
},
|
|
110802
|
+
"contactPerson": {
|
|
110803
|
+
"type": "string",
|
|
110804
|
+
"nullable": true
|
|
110805
|
+
},
|
|
110806
|
+
"country": {
|
|
110807
|
+
"type": "string",
|
|
110808
|
+
"nullable": true,
|
|
110809
|
+
"enum": [
|
|
110810
|
+
"AF",
|
|
110811
|
+
"AX",
|
|
110812
|
+
"AL",
|
|
110813
|
+
"DZ",
|
|
110814
|
+
"AS",
|
|
110815
|
+
"AD",
|
|
110816
|
+
"AO",
|
|
110817
|
+
"AI",
|
|
110818
|
+
"AQ",
|
|
110819
|
+
"AG",
|
|
110820
|
+
"AR",
|
|
110821
|
+
"AM",
|
|
110822
|
+
"AW",
|
|
110823
|
+
"AU",
|
|
110824
|
+
"AT",
|
|
110825
|
+
"AZ",
|
|
110826
|
+
"BS",
|
|
110827
|
+
"BH",
|
|
110828
|
+
"BD",
|
|
110829
|
+
"BB",
|
|
110830
|
+
"BY",
|
|
110831
|
+
"BE",
|
|
110832
|
+
"BZ",
|
|
110833
|
+
"BJ",
|
|
110834
|
+
"BM",
|
|
110835
|
+
"BT",
|
|
110836
|
+
"BO",
|
|
110837
|
+
"BQ",
|
|
110838
|
+
"BA",
|
|
110839
|
+
"BW",
|
|
110840
|
+
"BV",
|
|
110841
|
+
"BR",
|
|
110842
|
+
"IO",
|
|
110843
|
+
"BN",
|
|
110844
|
+
"BG",
|
|
110845
|
+
"BF",
|
|
110846
|
+
"BI",
|
|
110847
|
+
"KH",
|
|
110848
|
+
"CM",
|
|
110849
|
+
"CA",
|
|
110850
|
+
"CV",
|
|
110851
|
+
"KY",
|
|
110852
|
+
"CF",
|
|
110853
|
+
"TD",
|
|
110854
|
+
"CL",
|
|
110855
|
+
"CN",
|
|
110856
|
+
"CX",
|
|
110857
|
+
"CC",
|
|
110858
|
+
"CO",
|
|
110859
|
+
"KM",
|
|
110860
|
+
"CG",
|
|
110861
|
+
"CD",
|
|
110862
|
+
"CK",
|
|
110863
|
+
"CR",
|
|
110864
|
+
"CI",
|
|
110865
|
+
"HR",
|
|
110866
|
+
"CU",
|
|
110867
|
+
"CW",
|
|
110868
|
+
"CY",
|
|
110869
|
+
"CZ",
|
|
110870
|
+
"DK",
|
|
110871
|
+
"DJ",
|
|
110872
|
+
"DM",
|
|
110873
|
+
"DO",
|
|
110874
|
+
"EC",
|
|
110875
|
+
"EG",
|
|
110876
|
+
"SV",
|
|
110877
|
+
"GQ",
|
|
110878
|
+
"ER",
|
|
110879
|
+
"EE",
|
|
110880
|
+
"ET",
|
|
110881
|
+
"FK",
|
|
110882
|
+
"FO",
|
|
110883
|
+
"FJ",
|
|
110884
|
+
"FI",
|
|
110885
|
+
"FR",
|
|
110886
|
+
"GF",
|
|
110887
|
+
"PF",
|
|
110888
|
+
"TF",
|
|
110889
|
+
"GA",
|
|
110890
|
+
"GM",
|
|
110891
|
+
"GE",
|
|
110892
|
+
"DE",
|
|
110893
|
+
"GH",
|
|
110894
|
+
"GI",
|
|
110895
|
+
"GR",
|
|
110896
|
+
"GL",
|
|
110897
|
+
"GD",
|
|
110898
|
+
"GP",
|
|
110899
|
+
"GU",
|
|
110900
|
+
"GT",
|
|
110901
|
+
"GG",
|
|
110902
|
+
"GN",
|
|
110903
|
+
"GW",
|
|
110904
|
+
"GY",
|
|
110905
|
+
"HT",
|
|
110906
|
+
"HM",
|
|
110907
|
+
"VA",
|
|
110908
|
+
"HN",
|
|
110909
|
+
"HK",
|
|
110910
|
+
"HU",
|
|
110911
|
+
"IS",
|
|
110912
|
+
"IN",
|
|
110913
|
+
"ID",
|
|
110914
|
+
"IR",
|
|
110915
|
+
"IQ",
|
|
110916
|
+
"IE",
|
|
110917
|
+
"IM",
|
|
110918
|
+
"IL",
|
|
110919
|
+
"IT",
|
|
110920
|
+
"JM",
|
|
110921
|
+
"JP",
|
|
110922
|
+
"JE",
|
|
110923
|
+
"JO",
|
|
110924
|
+
"KZ",
|
|
110925
|
+
"KE",
|
|
110926
|
+
"KI",
|
|
110927
|
+
"KP",
|
|
110928
|
+
"KR",
|
|
110929
|
+
"XK",
|
|
110930
|
+
"KW",
|
|
110931
|
+
"KG",
|
|
110932
|
+
"LA",
|
|
110933
|
+
"LV",
|
|
110934
|
+
"LB",
|
|
110935
|
+
"LS",
|
|
110936
|
+
"LR",
|
|
110937
|
+
"LY",
|
|
110938
|
+
"LI",
|
|
110939
|
+
"LT",
|
|
110940
|
+
"LU",
|
|
110941
|
+
"MO",
|
|
110942
|
+
"MK",
|
|
110943
|
+
"MG",
|
|
110944
|
+
"MW",
|
|
110945
|
+
"MY",
|
|
110946
|
+
"MV",
|
|
110947
|
+
"ML",
|
|
110948
|
+
"MT",
|
|
110949
|
+
"MH",
|
|
110950
|
+
"MQ",
|
|
110951
|
+
"MR",
|
|
110952
|
+
"MU",
|
|
110953
|
+
"YT",
|
|
110954
|
+
"MX",
|
|
110955
|
+
"FM",
|
|
110956
|
+
"MD",
|
|
110957
|
+
"MC",
|
|
110958
|
+
"MN",
|
|
110959
|
+
"ME",
|
|
110960
|
+
"MS",
|
|
110961
|
+
"MA",
|
|
110962
|
+
"MZ",
|
|
110963
|
+
"MM",
|
|
110964
|
+
"NA",
|
|
110965
|
+
"NR",
|
|
110966
|
+
"NP",
|
|
110967
|
+
"NL",
|
|
110968
|
+
"NC",
|
|
110969
|
+
"NZ",
|
|
110970
|
+
"NI",
|
|
110971
|
+
"NE",
|
|
110972
|
+
"NG",
|
|
110973
|
+
"NU",
|
|
110974
|
+
"NF",
|
|
110975
|
+
"MP",
|
|
110976
|
+
"NO",
|
|
110977
|
+
"OM",
|
|
110978
|
+
"PK",
|
|
110979
|
+
"PW",
|
|
110980
|
+
"PS",
|
|
110981
|
+
"PA",
|
|
110982
|
+
"PG",
|
|
110983
|
+
"PY",
|
|
110984
|
+
"PE",
|
|
110985
|
+
"PH",
|
|
110986
|
+
"PN",
|
|
110987
|
+
"PL",
|
|
110988
|
+
"PT",
|
|
110989
|
+
"PR",
|
|
110990
|
+
"QA",
|
|
110991
|
+
"RE",
|
|
110992
|
+
"RO",
|
|
110993
|
+
"RU",
|
|
110994
|
+
"RW",
|
|
110995
|
+
"BL",
|
|
110996
|
+
"SH",
|
|
110997
|
+
"KN",
|
|
110998
|
+
"LC",
|
|
110999
|
+
"MF",
|
|
111000
|
+
"PM",
|
|
111001
|
+
"VC",
|
|
111002
|
+
"WS",
|
|
111003
|
+
"SM",
|
|
111004
|
+
"ST",
|
|
111005
|
+
"SA",
|
|
111006
|
+
"SN",
|
|
111007
|
+
"RS",
|
|
111008
|
+
"SC",
|
|
111009
|
+
"SL",
|
|
111010
|
+
"SG",
|
|
111011
|
+
"SX",
|
|
111012
|
+
"SK",
|
|
111013
|
+
"SI",
|
|
111014
|
+
"SB",
|
|
111015
|
+
"SO",
|
|
111016
|
+
"ZA",
|
|
111017
|
+
"GS",
|
|
111018
|
+
"SS",
|
|
111019
|
+
"ES",
|
|
111020
|
+
"LK",
|
|
111021
|
+
"SD",
|
|
111022
|
+
"SR",
|
|
111023
|
+
"SJ",
|
|
111024
|
+
"SZ",
|
|
111025
|
+
"SE",
|
|
111026
|
+
"CH",
|
|
111027
|
+
"SY",
|
|
111028
|
+
"TW",
|
|
111029
|
+
"TJ",
|
|
111030
|
+
"TZ",
|
|
111031
|
+
"TH",
|
|
111032
|
+
"TL",
|
|
111033
|
+
"TG",
|
|
111034
|
+
"TK",
|
|
111035
|
+
"TO",
|
|
111036
|
+
"TT",
|
|
111037
|
+
"TN",
|
|
111038
|
+
"TR",
|
|
111039
|
+
"TM",
|
|
111040
|
+
"TC",
|
|
111041
|
+
"TV",
|
|
111042
|
+
"UG",
|
|
111043
|
+
"UA",
|
|
111044
|
+
"AE",
|
|
111045
|
+
"GB",
|
|
111046
|
+
"US",
|
|
111047
|
+
"UM",
|
|
111048
|
+
"UY",
|
|
111049
|
+
"UZ",
|
|
111050
|
+
"VU",
|
|
111051
|
+
"VE",
|
|
111052
|
+
"VN",
|
|
111053
|
+
"VG",
|
|
111054
|
+
"VI",
|
|
111055
|
+
"WF",
|
|
111056
|
+
"EH",
|
|
111057
|
+
"YE",
|
|
111058
|
+
"ZM",
|
|
111059
|
+
"ZW"
|
|
111060
|
+
]
|
|
111061
|
+
},
|
|
111062
|
+
"region": {
|
|
111063
|
+
"type": "string",
|
|
111064
|
+
"nullable": true
|
|
111065
|
+
},
|
|
111066
|
+
"city": {
|
|
111067
|
+
"type": "string",
|
|
111068
|
+
"nullable": true
|
|
111069
|
+
},
|
|
111070
|
+
"postCode": {
|
|
111071
|
+
"type": "string",
|
|
111072
|
+
"nullable": true
|
|
111073
|
+
},
|
|
111074
|
+
"address": {
|
|
111075
|
+
"type": "string",
|
|
111076
|
+
"nullable": true
|
|
111077
|
+
},
|
|
111078
|
+
"regNo": {
|
|
111079
|
+
"type": "string",
|
|
111080
|
+
"nullable": true
|
|
111081
|
+
},
|
|
111082
|
+
"taxId": {
|
|
111083
|
+
"type": "string",
|
|
111084
|
+
"nullable": true
|
|
111085
|
+
},
|
|
111086
|
+
"phone": {
|
|
111087
|
+
"type": "string",
|
|
111088
|
+
"nullable": true
|
|
111089
|
+
},
|
|
111090
|
+
"email": {
|
|
111091
|
+
"type": "string",
|
|
111092
|
+
"nullable": true
|
|
111093
|
+
},
|
|
111094
|
+
"bankIban": {
|
|
111095
|
+
"type": "string",
|
|
111096
|
+
"nullable": true,
|
|
111097
|
+
"description": "IBAN of the bank account."
|
|
111098
|
+
},
|
|
111099
|
+
"bankCode": {
|
|
111100
|
+
"type": "string",
|
|
111101
|
+
"nullable": true,
|
|
111102
|
+
"description": "Bank code assigned by a central bank, a bank supervisory body or a Bankers Association in the country."
|
|
111103
|
+
},
|
|
111104
|
+
"bankAccountNumber": {
|
|
111105
|
+
"type": "string",
|
|
111106
|
+
"nullable": true,
|
|
111107
|
+
"description": "Bank account number."
|
|
111108
|
+
},
|
|
111109
|
+
"bankAccountType": {
|
|
111110
|
+
"type": "string",
|
|
111111
|
+
"nullable": true,
|
|
111112
|
+
"description": "Type of the bank account."
|
|
111113
|
+
},
|
|
111114
|
+
"bankBic": {
|
|
111115
|
+
"type": "string",
|
|
111116
|
+
"nullable": true,
|
|
111117
|
+
"description": "BIC/SWIFT code of the bank."
|
|
111118
|
+
}
|
|
111119
|
+
},
|
|
111120
|
+
"required": [
|
|
111121
|
+
"type",
|
|
111122
|
+
"name",
|
|
111123
|
+
"contactPerson",
|
|
111124
|
+
"country",
|
|
111125
|
+
"region",
|
|
111126
|
+
"city",
|
|
111127
|
+
"postCode",
|
|
111128
|
+
"address",
|
|
111129
|
+
"regNo",
|
|
111130
|
+
"taxId",
|
|
111131
|
+
"phone",
|
|
111132
|
+
"email",
|
|
111133
|
+
"bankIban",
|
|
111134
|
+
"bankName",
|
|
111135
|
+
"bankAddress",
|
|
111136
|
+
"bankCode",
|
|
111137
|
+
"bankAccountNumber",
|
|
111138
|
+
"bankAccountType",
|
|
111139
|
+
"bankAccountHolder",
|
|
111140
|
+
"bankBic"
|
|
111141
|
+
]
|
|
111142
|
+
},
|
|
111143
|
+
"downloadUrl": {
|
|
111144
|
+
"type": "string",
|
|
111145
|
+
"format": "url",
|
|
111146
|
+
"description": "Link to download the full settlement report document."
|
|
111147
|
+
},
|
|
111148
|
+
"externalId": {
|
|
111149
|
+
"description": "An optional external identifier for integration purposes",
|
|
111150
|
+
"type": "string",
|
|
111151
|
+
"maxLength": 255
|
|
111152
|
+
},
|
|
111153
|
+
"deductedFees": {
|
|
111154
|
+
"description": "Aggregated deducted fees for the settlement period. Included only when at least one fee is non-zero, and each individual fee is included only when the settlement report holds a stored value for it.\n\nA tax-inclusive amount, when present, is the stored total of the tax-inclusive amounts of the underlying records, substituting the tax-exclusive amount for any record that carries no tax-inclusive one.\n",
|
|
111155
|
+
"type": "object",
|
|
111156
|
+
"properties": {
|
|
111157
|
+
"perSessionAc": {
|
|
111158
|
+
"description": "Total fixed fee for AC sessions in the settlement period.",
|
|
111159
|
+
"type": "object",
|
|
111160
|
+
"properties": {
|
|
111161
|
+
"withoutTax": {
|
|
111162
|
+
"type": "number",
|
|
111163
|
+
"description": "The tax-exclusive amount."
|
|
111164
|
+
},
|
|
111165
|
+
"withTax": {
|
|
111166
|
+
"type": "number",
|
|
111167
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
111168
|
+
}
|
|
111169
|
+
},
|
|
111170
|
+
"required": [
|
|
111171
|
+
"withoutTax"
|
|
111172
|
+
]
|
|
111173
|
+
},
|
|
111174
|
+
"perSessionDc": {
|
|
111175
|
+
"description": "Total fixed fee for DC sessions in the settlement period.",
|
|
111176
|
+
"type": "object",
|
|
111177
|
+
"properties": {
|
|
111178
|
+
"withoutTax": {
|
|
111179
|
+
"type": "number",
|
|
111180
|
+
"description": "The tax-exclusive amount."
|
|
111181
|
+
},
|
|
111182
|
+
"withTax": {
|
|
111183
|
+
"type": "number",
|
|
111184
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
111185
|
+
}
|
|
111186
|
+
},
|
|
111187
|
+
"required": [
|
|
111188
|
+
"withoutTax"
|
|
111189
|
+
]
|
|
111190
|
+
},
|
|
111191
|
+
"perKwhAc": {
|
|
111192
|
+
"description": "Total fee per AC kWh delivered in the settlement period.",
|
|
111193
|
+
"type": "object",
|
|
111194
|
+
"properties": {
|
|
111195
|
+
"withoutTax": {
|
|
111196
|
+
"type": "number",
|
|
111197
|
+
"description": "The tax-exclusive amount."
|
|
111198
|
+
},
|
|
111199
|
+
"withTax": {
|
|
111200
|
+
"type": "number",
|
|
111201
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
111202
|
+
}
|
|
111203
|
+
},
|
|
111204
|
+
"required": [
|
|
111205
|
+
"withoutTax"
|
|
111206
|
+
]
|
|
111207
|
+
},
|
|
111208
|
+
"perKwhDc": {
|
|
111209
|
+
"description": "Total fee per DC kWh delivered in the settlement period.",
|
|
111210
|
+
"type": "object",
|
|
111211
|
+
"properties": {
|
|
111212
|
+
"withoutTax": {
|
|
111213
|
+
"type": "number",
|
|
111214
|
+
"description": "The tax-exclusive amount."
|
|
111215
|
+
},
|
|
111216
|
+
"withTax": {
|
|
111217
|
+
"type": "number",
|
|
111218
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
111219
|
+
}
|
|
111220
|
+
},
|
|
111221
|
+
"required": [
|
|
111222
|
+
"withoutTax"
|
|
111223
|
+
]
|
|
111224
|
+
},
|
|
111225
|
+
"handling": {
|
|
111226
|
+
"description": "Total percentage-based handling fee for the settlement period.\n\n`withoutTax` is the tax-exclusive fee total, whereas the v1.0 `handlingFee` number was the tax-inclusive amount.\n",
|
|
111227
|
+
"type": "object",
|
|
111228
|
+
"properties": {
|
|
111229
|
+
"withoutTax": {
|
|
111230
|
+
"type": "number",
|
|
111231
|
+
"description": "The tax-exclusive amount."
|
|
111232
|
+
},
|
|
111233
|
+
"withTax": {
|
|
111234
|
+
"type": "number",
|
|
111235
|
+
"description": "The tax-inclusive amount. Omitted when no tax-inclusive value is stored for this amount."
|
|
111236
|
+
}
|
|
111237
|
+
},
|
|
111238
|
+
"required": [
|
|
111239
|
+
"withoutTax"
|
|
111240
|
+
]
|
|
111241
|
+
}
|
|
111242
|
+
}
|
|
111243
|
+
},
|
|
111244
|
+
"partnerInvoiceId": {
|
|
111245
|
+
"type": "integer",
|
|
111246
|
+
"description": "Identifier of the latest issued partner invoice for this settlement report.\nOmitted when no partner invoice has been issued.\nRetained after a credit note is issued — the credit note is a separate document and the reference points at the invoice the report produced.\n"
|
|
111247
|
+
},
|
|
111248
|
+
"customFields": {
|
|
111249
|
+
"description": "Live 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 settlement report's current partner owner or are not visible to the acting administrator are omitted. The `customFields` property itself is omitted when no fields apply.\n\nThese values reflect the current custom field configuration and are not captured in the historical settlement report document, its party and settings snapshots, or derived partner invoices. Existing settlement report access controls continue to determine whether the report can be read; custom field visibility does not grant access to a report.\n",
|
|
111250
|
+
"type": "object",
|
|
111251
|
+
"additionalProperties": true
|
|
111252
|
+
}
|
|
111253
|
+
},
|
|
111254
|
+
"required": [
|
|
111255
|
+
"id",
|
|
111256
|
+
"partnerId",
|
|
111257
|
+
"number",
|
|
111258
|
+
"date",
|
|
111259
|
+
"periodStart",
|
|
111260
|
+
"periodEnd",
|
|
111261
|
+
"currencyCode",
|
|
111262
|
+
"totals",
|
|
111263
|
+
"totalEnergyCpoWh",
|
|
111264
|
+
"totalEnergyEmspWh",
|
|
111265
|
+
"supplier",
|
|
111266
|
+
"customer",
|
|
111267
|
+
"downloadUrl"
|
|
111268
|
+
]
|
|
111269
|
+
}
|
|
111270
|
+
},
|
|
111271
|
+
"required": [
|
|
111272
|
+
"data"
|
|
111273
|
+
]
|
|
111274
|
+
}
|
|
111275
|
+
},
|
|
111276
|
+
"401": {
|
|
111277
|
+
"schema": {
|
|
111278
|
+
"type": "object",
|
|
111279
|
+
"properties": {
|
|
111280
|
+
"message": {
|
|
111281
|
+
"type": "string"
|
|
111282
|
+
}
|
|
111283
|
+
}
|
|
111284
|
+
}
|
|
111285
|
+
},
|
|
111286
|
+
"403": {
|
|
111287
|
+
"schema": {
|
|
111288
|
+
"type": "object",
|
|
111289
|
+
"properties": {
|
|
111290
|
+
"message": {
|
|
111291
|
+
"type": "string",
|
|
111292
|
+
"default": "This action is unauthorized."
|
|
111293
|
+
}
|
|
111294
|
+
}
|
|
111295
|
+
}
|
|
111296
|
+
},
|
|
111297
|
+
"404": {
|
|
111298
|
+
"schema": {
|
|
111299
|
+
"type": "object",
|
|
111300
|
+
"properties": {
|
|
111301
|
+
"message": {
|
|
111302
|
+
"type": "string"
|
|
111303
|
+
}
|
|
111304
|
+
}
|
|
111305
|
+
}
|
|
111306
|
+
},
|
|
111307
|
+
"429": {
|
|
111308
|
+
"schema": {
|
|
111309
|
+
"type": "object",
|
|
111310
|
+
"properties": {
|
|
111311
|
+
"message": {
|
|
111312
|
+
"type": "string"
|
|
111313
|
+
}
|
|
111314
|
+
}
|
|
111315
|
+
}
|
|
111316
|
+
}
|
|
111317
|
+
},
|
|
111318
|
+
"partnerSettlementReportPartnerSettlementRecordsListingV1_1": {
|
|
111319
|
+
"200": {
|
|
111320
|
+
"schema": {
|
|
111321
|
+
"type": "object",
|
|
111322
|
+
"properties": {
|
|
111323
|
+
"data": {
|
|
111324
|
+
"type": "array",
|
|
111325
|
+
"items": {
|
|
111326
|
+
"type": "object",
|
|
111327
|
+
"properties": {
|
|
111328
|
+
"date": {
|
|
111329
|
+
"type": "string",
|
|
111330
|
+
"format": "date",
|
|
111331
|
+
"description": "Date the payment was made."
|
|
111332
|
+
},
|
|
111333
|
+
"paidAmount": {
|
|
111334
|
+
"type": "number",
|
|
111335
|
+
"description": "Amount recorded as paid, in the settlement report's currency. Negative values record a reversing entry."
|
|
111336
|
+
},
|
|
111337
|
+
"note": {
|
|
111338
|
+
"type": "string",
|
|
111339
|
+
"description": "Free-text note on the settlement record."
|
|
111340
|
+
}
|
|
111341
|
+
},
|
|
111342
|
+
"required": [
|
|
111343
|
+
"id",
|
|
111344
|
+
"date",
|
|
111345
|
+
"paidAmount",
|
|
111346
|
+
"note"
|
|
111347
|
+
]
|
|
111348
|
+
}
|
|
111349
|
+
},
|
|
111350
|
+
"links": {
|
|
111351
|
+
"type": "object",
|
|
111352
|
+
"properties": {
|
|
111353
|
+
"first": {
|
|
111354
|
+
"type": "string",
|
|
111355
|
+
"description": "The URL to fetch the first page",
|
|
111356
|
+
"nullable": true
|
|
111357
|
+
},
|
|
111358
|
+
"last": {
|
|
111359
|
+
"type": "string",
|
|
111360
|
+
"description": "The URL to fetch the last page",
|
|
111361
|
+
"nullable": true
|
|
111362
|
+
},
|
|
111363
|
+
"prev": {
|
|
111364
|
+
"type": "string",
|
|
111365
|
+
"description": "The URL to fetch the previous page",
|
|
111366
|
+
"nullable": true
|
|
111367
|
+
},
|
|
111368
|
+
"next": {
|
|
111369
|
+
"type": "string",
|
|
111370
|
+
"description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
|
|
111371
|
+
"nullable": true
|
|
111372
|
+
}
|
|
111373
|
+
}
|
|
111374
|
+
},
|
|
111375
|
+
"meta": {
|
|
111376
|
+
"type": "object",
|
|
111377
|
+
"properties": {
|
|
111378
|
+
"path": {
|
|
111379
|
+
"type": "string",
|
|
111380
|
+
"description": "The base route of the endpoint (unpaginated)"
|
|
111381
|
+
},
|
|
111382
|
+
"per_page": {
|
|
111383
|
+
"type": "integer",
|
|
111384
|
+
"description": "The max number of items in each page"
|
|
111385
|
+
},
|
|
111386
|
+
"next_cursor": {
|
|
111387
|
+
"type": "string",
|
|
111388
|
+
"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.",
|
|
111389
|
+
"nullable": true
|
|
111390
|
+
},
|
|
111391
|
+
"prev_cursor": {
|
|
111392
|
+
"type": "string",
|
|
111393
|
+
"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.",
|
|
111394
|
+
"nullable": true
|
|
111395
|
+
}
|
|
111396
|
+
}
|
|
111397
|
+
}
|
|
111398
|
+
},
|
|
111399
|
+
"required": [
|
|
111400
|
+
"data",
|
|
111401
|
+
"links",
|
|
111402
|
+
"meta"
|
|
111403
|
+
]
|
|
111404
|
+
}
|
|
111405
|
+
},
|
|
111406
|
+
"401": {
|
|
111407
|
+
"schema": {
|
|
111408
|
+
"type": "object",
|
|
111409
|
+
"properties": {
|
|
111410
|
+
"message": {
|
|
111411
|
+
"type": "string"
|
|
111412
|
+
}
|
|
111413
|
+
}
|
|
111414
|
+
}
|
|
111415
|
+
},
|
|
111416
|
+
"403": {
|
|
111417
|
+
"schema": {
|
|
111418
|
+
"type": "object",
|
|
111419
|
+
"properties": {
|
|
111420
|
+
"message": {
|
|
111421
|
+
"type": "string",
|
|
111422
|
+
"default": "This action is unauthorized."
|
|
111423
|
+
}
|
|
111424
|
+
}
|
|
111425
|
+
}
|
|
111426
|
+
},
|
|
111427
|
+
"404": {
|
|
111428
|
+
"schema": {
|
|
111429
|
+
"type": "object",
|
|
111430
|
+
"properties": {
|
|
111431
|
+
"message": {
|
|
111432
|
+
"type": "string"
|
|
111433
|
+
}
|
|
111434
|
+
}
|
|
111435
|
+
}
|
|
111436
|
+
},
|
|
111437
|
+
"429": {
|
|
111438
|
+
"schema": {
|
|
111439
|
+
"type": "object",
|
|
111440
|
+
"properties": {
|
|
111441
|
+
"message": {
|
|
111442
|
+
"type": "string"
|
|
111443
|
+
}
|
|
111444
|
+
}
|
|
111445
|
+
}
|
|
111446
|
+
}
|
|
111447
|
+
},
|
|
111448
|
+
"partnerSettlementReportPartnerSettlementRecordCreateV1_1": {
|
|
111449
|
+
"201": {
|
|
111450
|
+
"schema": {
|
|
111451
|
+
"type": "object",
|
|
111452
|
+
"properties": {
|
|
111453
|
+
"data": {
|
|
111454
|
+
"type": "object",
|
|
111455
|
+
"properties": {
|
|
111456
|
+
"date": {
|
|
111457
|
+
"type": "string",
|
|
111458
|
+
"format": "date",
|
|
111459
|
+
"description": "Date the payment was made."
|
|
111460
|
+
},
|
|
111461
|
+
"paidAmount": {
|
|
111462
|
+
"type": "number",
|
|
111463
|
+
"description": "Amount recorded as paid, in the settlement report's currency. Negative values record a reversing entry."
|
|
111464
|
+
},
|
|
111465
|
+
"note": {
|
|
111466
|
+
"type": "string",
|
|
111467
|
+
"description": "Free-text note on the settlement record."
|
|
111468
|
+
}
|
|
111469
|
+
},
|
|
111470
|
+
"required": [
|
|
111471
|
+
"id",
|
|
111472
|
+
"date",
|
|
111473
|
+
"paidAmount",
|
|
111474
|
+
"note"
|
|
111475
|
+
]
|
|
111476
|
+
}
|
|
111477
|
+
},
|
|
111478
|
+
"required": [
|
|
111479
|
+
"data"
|
|
111480
|
+
]
|
|
111481
|
+
}
|
|
111482
|
+
},
|
|
111483
|
+
"401": {
|
|
111484
|
+
"schema": {
|
|
111485
|
+
"type": "object",
|
|
111486
|
+
"properties": {
|
|
111487
|
+
"message": {
|
|
111488
|
+
"type": "string"
|
|
111489
|
+
}
|
|
111490
|
+
}
|
|
111491
|
+
}
|
|
111492
|
+
},
|
|
111493
|
+
"403": {
|
|
111494
|
+
"schema": {
|
|
111495
|
+
"type": "object",
|
|
111496
|
+
"properties": {
|
|
111497
|
+
"message": {
|
|
111498
|
+
"type": "string",
|
|
111499
|
+
"default": "This action is unauthorized."
|
|
111500
|
+
}
|
|
111501
|
+
}
|
|
111502
|
+
}
|
|
111503
|
+
},
|
|
111504
|
+
"404": {
|
|
111505
|
+
"schema": {
|
|
111506
|
+
"type": "object",
|
|
111507
|
+
"properties": {
|
|
111508
|
+
"message": {
|
|
111509
|
+
"type": "string"
|
|
111510
|
+
}
|
|
111511
|
+
}
|
|
111512
|
+
}
|
|
111513
|
+
},
|
|
111514
|
+
"409": {
|
|
111515
|
+
"schema": {
|
|
111516
|
+
"type": "object",
|
|
111517
|
+
"required": [
|
|
111518
|
+
"message",
|
|
111519
|
+
"errorCode"
|
|
111520
|
+
],
|
|
111521
|
+
"properties": {
|
|
111522
|
+
"message": {
|
|
111523
|
+
"type": "string",
|
|
111524
|
+
"description": "Human-readable explanation of why the settlement record write is blocked."
|
|
111525
|
+
},
|
|
111526
|
+
"errorCode": {
|
|
111527
|
+
"type": "string",
|
|
111528
|
+
"description": "Machine-readable code describing why the settlement record write is blocked.\n\nAllowed values:\n- `payment_tracking_managed_via_partner_invoice` - The settlement report has at least one partner invoice, so payments are tracked by registering them on those invoices. Settlement records for the report can no longer be created, updated or deleted directly.\n",
|
|
111529
|
+
"enum": [
|
|
111530
|
+
"payment_tracking_managed_via_partner_invoice"
|
|
111531
|
+
]
|
|
111532
|
+
}
|
|
111533
|
+
}
|
|
111534
|
+
}
|
|
111535
|
+
},
|
|
111536
|
+
"422": {
|
|
111537
|
+
"schema": {
|
|
111538
|
+
"type": "object",
|
|
111539
|
+
"required": [
|
|
111540
|
+
"message"
|
|
111541
|
+
],
|
|
111542
|
+
"properties": {
|
|
111543
|
+
"message": {
|
|
111544
|
+
"type": "string"
|
|
111545
|
+
},
|
|
111546
|
+
"errors": {
|
|
111547
|
+
"type": "object",
|
|
111548
|
+
"additionalProperties": {
|
|
111549
|
+
"type": "array",
|
|
111550
|
+
"items": {
|
|
111551
|
+
"type": "string"
|
|
111552
|
+
}
|
|
111553
|
+
}
|
|
111554
|
+
}
|
|
111555
|
+
}
|
|
111556
|
+
}
|
|
111557
|
+
},
|
|
111558
|
+
"429": {
|
|
111559
|
+
"schema": {
|
|
111560
|
+
"type": "object",
|
|
111561
|
+
"properties": {
|
|
111562
|
+
"message": {
|
|
111563
|
+
"type": "string"
|
|
111564
|
+
}
|
|
111565
|
+
}
|
|
111566
|
+
}
|
|
111567
|
+
}
|
|
111568
|
+
},
|
|
111569
|
+
"partnerSettlementReportPartnerSettlementRecordReadV1_1": {
|
|
111570
|
+
"200": {
|
|
111571
|
+
"schema": {
|
|
111572
|
+
"type": "object",
|
|
111573
|
+
"properties": {
|
|
111574
|
+
"data": {
|
|
111575
|
+
"type": "object",
|
|
111576
|
+
"properties": {
|
|
111577
|
+
"date": {
|
|
111578
|
+
"type": "string",
|
|
111579
|
+
"format": "date",
|
|
111580
|
+
"description": "Date the payment was made."
|
|
111581
|
+
},
|
|
111582
|
+
"paidAmount": {
|
|
111583
|
+
"type": "number",
|
|
111584
|
+
"description": "Amount recorded as paid, in the settlement report's currency. Negative values record a reversing entry."
|
|
111585
|
+
},
|
|
111586
|
+
"note": {
|
|
111587
|
+
"type": "string",
|
|
111588
|
+
"description": "Free-text note on the settlement record."
|
|
111589
|
+
}
|
|
111590
|
+
},
|
|
111591
|
+
"required": [
|
|
111592
|
+
"id",
|
|
111593
|
+
"date",
|
|
111594
|
+
"paidAmount",
|
|
111595
|
+
"note"
|
|
111596
|
+
]
|
|
111597
|
+
}
|
|
111598
|
+
},
|
|
111599
|
+
"required": [
|
|
111600
|
+
"data"
|
|
111601
|
+
]
|
|
111602
|
+
}
|
|
111603
|
+
},
|
|
111604
|
+
"401": {
|
|
111605
|
+
"schema": {
|
|
111606
|
+
"type": "object",
|
|
111607
|
+
"properties": {
|
|
111608
|
+
"message": {
|
|
111609
|
+
"type": "string"
|
|
111610
|
+
}
|
|
111611
|
+
}
|
|
111612
|
+
}
|
|
111613
|
+
},
|
|
111614
|
+
"403": {
|
|
111615
|
+
"schema": {
|
|
111616
|
+
"type": "object",
|
|
111617
|
+
"properties": {
|
|
111618
|
+
"message": {
|
|
111619
|
+
"type": "string",
|
|
111620
|
+
"default": "This action is unauthorized."
|
|
111621
|
+
}
|
|
111622
|
+
}
|
|
111623
|
+
}
|
|
111624
|
+
},
|
|
111625
|
+
"404": {
|
|
111626
|
+
"schema": {
|
|
111627
|
+
"type": "object",
|
|
111628
|
+
"properties": {
|
|
111629
|
+
"message": {
|
|
111630
|
+
"type": "string"
|
|
111631
|
+
}
|
|
111632
|
+
}
|
|
111633
|
+
}
|
|
111634
|
+
},
|
|
111635
|
+
"429": {
|
|
111636
|
+
"schema": {
|
|
111637
|
+
"type": "object",
|
|
111638
|
+
"properties": {
|
|
111639
|
+
"message": {
|
|
111640
|
+
"type": "string"
|
|
111641
|
+
}
|
|
111642
|
+
}
|
|
111643
|
+
}
|
|
111644
|
+
}
|
|
111645
|
+
},
|
|
111646
|
+
"partnerSettlementReportPartnerSettlementRecordUpdateV1_1": {
|
|
111647
|
+
"200": {
|
|
111648
|
+
"schema": {
|
|
111649
|
+
"type": "object",
|
|
111650
|
+
"properties": {
|
|
111651
|
+
"data": {
|
|
111652
|
+
"type": "object",
|
|
111653
|
+
"properties": {
|
|
111654
|
+
"date": {
|
|
111655
|
+
"type": "string",
|
|
111656
|
+
"format": "date",
|
|
111657
|
+
"description": "Date the payment was made."
|
|
111658
|
+
},
|
|
111659
|
+
"paidAmount": {
|
|
111660
|
+
"type": "number",
|
|
111661
|
+
"description": "Amount recorded as paid, in the settlement report's currency. Negative values record a reversing entry."
|
|
111662
|
+
},
|
|
111663
|
+
"note": {
|
|
111664
|
+
"type": "string",
|
|
111665
|
+
"description": "Free-text note on the settlement record."
|
|
111666
|
+
}
|
|
111667
|
+
},
|
|
111668
|
+
"required": [
|
|
111669
|
+
"id",
|
|
111670
|
+
"date",
|
|
111671
|
+
"paidAmount",
|
|
111672
|
+
"note"
|
|
111673
|
+
]
|
|
111674
|
+
}
|
|
111675
|
+
},
|
|
111676
|
+
"required": [
|
|
111677
|
+
"data"
|
|
111678
|
+
]
|
|
111679
|
+
}
|
|
111680
|
+
},
|
|
111681
|
+
"401": {
|
|
111682
|
+
"schema": {
|
|
111683
|
+
"type": "object",
|
|
111684
|
+
"properties": {
|
|
111685
|
+
"message": {
|
|
111686
|
+
"type": "string"
|
|
111687
|
+
}
|
|
111688
|
+
}
|
|
111689
|
+
}
|
|
111690
|
+
},
|
|
111691
|
+
"403": {
|
|
111692
|
+
"schema": {
|
|
111693
|
+
"type": "object",
|
|
111694
|
+
"properties": {
|
|
111695
|
+
"message": {
|
|
111696
|
+
"type": "string",
|
|
111697
|
+
"default": "This action is unauthorized."
|
|
111698
|
+
}
|
|
111699
|
+
}
|
|
111700
|
+
}
|
|
111701
|
+
},
|
|
111702
|
+
"404": {
|
|
111703
|
+
"schema": {
|
|
111704
|
+
"type": "object",
|
|
111705
|
+
"properties": {
|
|
111706
|
+
"message": {
|
|
111707
|
+
"type": "string"
|
|
111708
|
+
}
|
|
111709
|
+
}
|
|
111710
|
+
}
|
|
111711
|
+
},
|
|
111712
|
+
"409": {
|
|
111713
|
+
"schema": {
|
|
111714
|
+
"type": "object",
|
|
111715
|
+
"required": [
|
|
111716
|
+
"message",
|
|
111717
|
+
"errorCode"
|
|
111718
|
+
],
|
|
111719
|
+
"properties": {
|
|
111720
|
+
"message": {
|
|
111721
|
+
"type": "string",
|
|
111722
|
+
"description": "Human-readable explanation of why the settlement record write is blocked."
|
|
111723
|
+
},
|
|
111724
|
+
"errorCode": {
|
|
111725
|
+
"type": "string",
|
|
111726
|
+
"description": "Machine-readable code describing why the settlement record write is blocked.\n\nAllowed values:\n- `payment_tracking_managed_via_partner_invoice` - The settlement report has at least one partner invoice, so payments are tracked by registering them on those invoices. Settlement records for the report can no longer be created, updated or deleted directly.\n",
|
|
111727
|
+
"enum": [
|
|
111728
|
+
"payment_tracking_managed_via_partner_invoice"
|
|
111729
|
+
]
|
|
111730
|
+
}
|
|
111731
|
+
}
|
|
111732
|
+
}
|
|
111733
|
+
},
|
|
111734
|
+
"422": {
|
|
111735
|
+
"schema": {
|
|
111736
|
+
"type": "object",
|
|
111737
|
+
"required": [
|
|
111738
|
+
"message"
|
|
111739
|
+
],
|
|
111740
|
+
"properties": {
|
|
111741
|
+
"message": {
|
|
111742
|
+
"type": "string"
|
|
111743
|
+
},
|
|
111744
|
+
"errors": {
|
|
111745
|
+
"type": "object",
|
|
111746
|
+
"additionalProperties": {
|
|
111747
|
+
"type": "array",
|
|
111748
|
+
"items": {
|
|
111749
|
+
"type": "string"
|
|
111750
|
+
}
|
|
111751
|
+
}
|
|
111752
|
+
}
|
|
111753
|
+
}
|
|
111754
|
+
}
|
|
111755
|
+
},
|
|
111756
|
+
"429": {
|
|
111757
|
+
"schema": {
|
|
111758
|
+
"type": "object",
|
|
111759
|
+
"properties": {
|
|
111760
|
+
"message": {
|
|
111761
|
+
"type": "string"
|
|
111762
|
+
}
|
|
111763
|
+
}
|
|
111764
|
+
}
|
|
111765
|
+
}
|
|
111766
|
+
},
|
|
111767
|
+
"partnerSettlementReportPartnerSettlementRecordDeleteV1_1": {
|
|
111768
|
+
"401": {
|
|
111769
|
+
"schema": {
|
|
111770
|
+
"type": "object",
|
|
111771
|
+
"properties": {
|
|
111772
|
+
"message": {
|
|
111773
|
+
"type": "string"
|
|
111774
|
+
}
|
|
111775
|
+
}
|
|
111776
|
+
}
|
|
111777
|
+
},
|
|
111778
|
+
"403": {
|
|
111779
|
+
"schema": {
|
|
111780
|
+
"type": "object",
|
|
111781
|
+
"properties": {
|
|
111782
|
+
"message": {
|
|
111783
|
+
"type": "string",
|
|
111784
|
+
"default": "This action is unauthorized."
|
|
111785
|
+
}
|
|
111786
|
+
}
|
|
111787
|
+
}
|
|
111788
|
+
},
|
|
111789
|
+
"404": {
|
|
111790
|
+
"schema": {
|
|
111791
|
+
"type": "object",
|
|
111792
|
+
"properties": {
|
|
111793
|
+
"message": {
|
|
111794
|
+
"type": "string"
|
|
111795
|
+
}
|
|
111796
|
+
}
|
|
111797
|
+
}
|
|
111798
|
+
},
|
|
111799
|
+
"409": {
|
|
111800
|
+
"schema": {
|
|
111801
|
+
"type": "object",
|
|
111802
|
+
"required": [
|
|
111803
|
+
"message",
|
|
111804
|
+
"errorCode"
|
|
111805
|
+
],
|
|
111806
|
+
"properties": {
|
|
111807
|
+
"message": {
|
|
111808
|
+
"type": "string",
|
|
111809
|
+
"description": "Human-readable explanation of why the settlement record write is blocked."
|
|
111810
|
+
},
|
|
111811
|
+
"errorCode": {
|
|
111812
|
+
"type": "string",
|
|
111813
|
+
"description": "Machine-readable code describing why the settlement record write is blocked.\n\nAllowed values:\n- `payment_tracking_managed_via_partner_invoice` - The settlement report has at least one partner invoice, so payments are tracked by registering them on those invoices. Settlement records for the report can no longer be created, updated or deleted directly.\n",
|
|
111814
|
+
"enum": [
|
|
111815
|
+
"payment_tracking_managed_via_partner_invoice"
|
|
111816
|
+
]
|
|
111817
|
+
}
|
|
111818
|
+
}
|
|
111819
|
+
}
|
|
111820
|
+
},
|
|
111821
|
+
"422": {
|
|
111822
|
+
"schema": {
|
|
111823
|
+
"type": "object",
|
|
111824
|
+
"required": [
|
|
111825
|
+
"message"
|
|
111826
|
+
],
|
|
111827
|
+
"properties": {
|
|
111828
|
+
"message": {
|
|
111829
|
+
"type": "string"
|
|
111830
|
+
},
|
|
111831
|
+
"errors": {
|
|
111832
|
+
"type": "object",
|
|
111833
|
+
"additionalProperties": {
|
|
111834
|
+
"type": "array",
|
|
111835
|
+
"items": {
|
|
111836
|
+
"type": "string"
|
|
111837
|
+
}
|
|
111838
|
+
}
|
|
111839
|
+
}
|
|
111840
|
+
}
|
|
111841
|
+
}
|
|
111842
|
+
},
|
|
111843
|
+
"429": {
|
|
111844
|
+
"schema": {
|
|
111845
|
+
"type": "object",
|
|
111846
|
+
"properties": {
|
|
111847
|
+
"message": {
|
|
111848
|
+
"type": "string"
|
|
111849
|
+
}
|
|
111850
|
+
}
|
|
111851
|
+
}
|
|
111852
|
+
}
|
|
111853
|
+
},
|
|
108892
111854
|
"partnersListingDeprecated": {
|
|
108893
111855
|
"200": {
|
|
108894
111856
|
"schema": {
|
|
@@ -132970,7 +135932,7 @@
|
|
|
132970
135932
|
"data": {
|
|
132971
135933
|
"type": "array",
|
|
132972
135934
|
"items": {
|
|
132973
|
-
"description": "
|
|
135935
|
+
"description": "⚠️ Experimental feature — not yet a stable contract. This schema ships as experimental / beta. While experimental, it may change without a version bump — including breaking changes — wherever it is returned, including the session `reimbursementRecords` include. 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.\n\nReimbursement record read schema. A record is one immutable computed reimbursement entry for a single charging session, and has no general resource write surface. Reversing (credit) records are records too — they carry negated amounts and point at the record they reverse.\n",
|
|
132974
135936
|
"type": "object",
|
|
132975
135937
|
"properties": {
|
|
132976
135938
|
"id": {
|
|
@@ -133441,7 +136403,7 @@
|
|
|
133441
136403
|
"type": "object",
|
|
133442
136404
|
"properties": {
|
|
133443
136405
|
"data": {
|
|
133444
|
-
"description": "
|
|
136406
|
+
"description": "⚠️ Experimental feature — not yet a stable contract. This schema ships as experimental / beta. While experimental, it may change without a version bump — including breaking changes — wherever it is returned, including the session `reimbursementRecords` include. 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.\n\nReimbursement record read schema. A record is one immutable computed reimbursement entry for a single charging session, and has no general resource write surface. Reversing (credit) records are records too — they carry negated amounts and point at the record they reverse.\n",
|
|
133445
136407
|
"type": "object",
|
|
133446
136408
|
"properties": {
|
|
133447
136409
|
"id": {
|
|
@@ -142767,6 +145729,360 @@
|
|
|
142767
145729
|
"description": "True when the vehicle association was cryptographically verified (e.g., ISO 15118 Plug & Charge)."
|
|
142768
145730
|
}
|
|
142769
145731
|
}
|
|
145732
|
+
},
|
|
145733
|
+
"reimbursementRecords": {
|
|
145734
|
+
"type": "array",
|
|
145735
|
+
"items": {
|
|
145736
|
+
"description": "⚠️ Experimental feature — not yet a stable contract. This schema ships as experimental / beta. While experimental, it may change without a version bump — including breaking changes — wherever it is returned, including the session `reimbursementRecords` include. 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.\n\nReimbursement record read schema. A record is one immutable computed reimbursement entry for a single charging session, and has no general resource write surface. Reversing (credit) records are records too — they carry negated amounts and point at the record they reverse.\n",
|
|
145737
|
+
"type": "object",
|
|
145738
|
+
"properties": {
|
|
145739
|
+
"id": {
|
|
145740
|
+
"type": "integer",
|
|
145741
|
+
"readOnly": true,
|
|
145742
|
+
"description": "Identifier of this reimbursement record."
|
|
145743
|
+
},
|
|
145744
|
+
"operatorId": {
|
|
145745
|
+
"type": "integer",
|
|
145746
|
+
"description": "Operator the record belongs to, as exposed by the operators resource."
|
|
145747
|
+
},
|
|
145748
|
+
"sessionId": {
|
|
145749
|
+
"type": "integer",
|
|
145750
|
+
"description": "Charging session the reimbursement was computed for, as exposed by the sessions resource. Reversing (credit) records repeat the reversed record's session."
|
|
145751
|
+
},
|
|
145752
|
+
"beneficiary": {
|
|
145753
|
+
"description": "Party the reimbursement is owed to.\n",
|
|
145754
|
+
"type": "object",
|
|
145755
|
+
"properties": {
|
|
145756
|
+
"userId": {
|
|
145757
|
+
"type": "integer",
|
|
145758
|
+
"description": "User the reimbursement is owed to, as exposed by the users resource."
|
|
145759
|
+
}
|
|
145760
|
+
}
|
|
145761
|
+
},
|
|
145762
|
+
"payer": {
|
|
145763
|
+
"description": "Party that owes the reimbursement. Company reimbursements carry `partnerId` (and `partnerContractId` when the payment is governed by a partner contract); public reimbursements carry `operatorId`.\n",
|
|
145764
|
+
"type": "object",
|
|
145765
|
+
"properties": {
|
|
145766
|
+
"partnerId": {
|
|
145767
|
+
"type": "integer",
|
|
145768
|
+
"description": "Partner paying the reimbursement. Present on company reimbursements."
|
|
145769
|
+
},
|
|
145770
|
+
"partnerContractId": {
|
|
145771
|
+
"type": "integer",
|
|
145772
|
+
"description": "Partner contract the reimbursement is settled under. Present when the paying partner has a contract."
|
|
145773
|
+
},
|
|
145774
|
+
"operatorId": {
|
|
145775
|
+
"type": "integer",
|
|
145776
|
+
"description": "Operator paying the reimbursement. Present on public reimbursements."
|
|
145777
|
+
}
|
|
145778
|
+
}
|
|
145779
|
+
},
|
|
145780
|
+
"reimbursementPolicyId": {
|
|
145781
|
+
"type": "integer",
|
|
145782
|
+
"description": "Reimbursement policy whose terms were applied when the amount was computed. Omitted when no policy governed the session."
|
|
145783
|
+
},
|
|
145784
|
+
"energy": {
|
|
145785
|
+
"type": "integer",
|
|
145786
|
+
"description": "Reimbursed energy in Wh."
|
|
145787
|
+
},
|
|
145788
|
+
"rate": {
|
|
145789
|
+
"type": "number",
|
|
145790
|
+
"format": "float",
|
|
145791
|
+
"description": "Monetary rate per kWh applied when computing the reimbursement amount, in the record currency. Its origin is given by `electricityRateSource`. Omitted, together with `electricityRateSource`, on records computed before the platform required a resolved rate; such records are no longer produced."
|
|
145792
|
+
},
|
|
145793
|
+
"electricityRateSource": {
|
|
145794
|
+
"description": "Origin of the per-kWh rate used to reimburse a home-charging session:\n- **policy**: The electricity rate linked to the policy provides the rate. `electricityRateId` is required and must belong to the same operator as the policy; `integrationId` must not be set on the policy.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. Neither `electricityRateId` nor `integrationId` is set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. `integrationId` is required and must reference a regional electricity rates integration of the same operator; `electricityRateId` must not be set on the policy. The integration's region-to-rate bindings are configured in the admin panel.\n",
|
|
145795
|
+
"type": "string",
|
|
145796
|
+
"enum": [
|
|
145797
|
+
"policy",
|
|
145798
|
+
"charge_point",
|
|
145799
|
+
"integration"
|
|
145800
|
+
]
|
|
145801
|
+
},
|
|
145802
|
+
"taxBasis": {
|
|
145803
|
+
"description": "How tax was applied when the reimbursement amount was computed:\n- **exempt**: No tax was applied. The amount is identical with and without tax.\n- **percentage**: Tax was applied as a percentage of the net amount — see `taxPercentage`.\n- **flat_amount**: Tax was applied as a fixed amount per record, independent of the reimbursed energy.\n- **compound**: Tax was applied as a combination of a percentage and a fixed component.\n",
|
|
145804
|
+
"type": "string",
|
|
145805
|
+
"enum": [
|
|
145806
|
+
"exempt",
|
|
145807
|
+
"percentage",
|
|
145808
|
+
"flat_amount",
|
|
145809
|
+
"compound"
|
|
145810
|
+
]
|
|
145811
|
+
},
|
|
145812
|
+
"taxPercentage": {
|
|
145813
|
+
"type": "number",
|
|
145814
|
+
"format": "float",
|
|
145815
|
+
"description": "Tax percentage applied to the reimbursement amount. Present when the applied `taxBasis` carries a percentage component; omitted when no tax percentage could be resolved."
|
|
145816
|
+
},
|
|
145817
|
+
"amount": {
|
|
145818
|
+
"description": "Reimbursement amount, split by tax inclusion. Reversing (credit) records carry negated amounts.",
|
|
145819
|
+
"type": "object",
|
|
145820
|
+
"properties": {
|
|
145821
|
+
"withTax": {
|
|
145822
|
+
"type": "number"
|
|
145823
|
+
},
|
|
145824
|
+
"withoutTax": {
|
|
145825
|
+
"type": "number"
|
|
145826
|
+
}
|
|
145827
|
+
},
|
|
145828
|
+
"required": [
|
|
145829
|
+
"withTax"
|
|
145830
|
+
]
|
|
145831
|
+
},
|
|
145832
|
+
"currency": {
|
|
145833
|
+
"description": "ISO 4217 currency code for the record's monetary amounts.",
|
|
145834
|
+
"type": "string",
|
|
145835
|
+
"enum": [
|
|
145836
|
+
"AED",
|
|
145837
|
+
"AFN",
|
|
145838
|
+
"ALL",
|
|
145839
|
+
"AMD",
|
|
145840
|
+
"ANG",
|
|
145841
|
+
"AOA",
|
|
145842
|
+
"ARS",
|
|
145843
|
+
"AUD",
|
|
145844
|
+
"AWG",
|
|
145845
|
+
"AZN",
|
|
145846
|
+
"BAM",
|
|
145847
|
+
"BBD",
|
|
145848
|
+
"BDT",
|
|
145849
|
+
"BGN",
|
|
145850
|
+
"BHD",
|
|
145851
|
+
"BIF",
|
|
145852
|
+
"BMD",
|
|
145853
|
+
"BND",
|
|
145854
|
+
"BOB",
|
|
145855
|
+
"BOV",
|
|
145856
|
+
"BRL",
|
|
145857
|
+
"BSD",
|
|
145858
|
+
"BTN",
|
|
145859
|
+
"BWP",
|
|
145860
|
+
"BYN",
|
|
145861
|
+
"BZD",
|
|
145862
|
+
"CAD",
|
|
145863
|
+
"CDF",
|
|
145864
|
+
"CHE",
|
|
145865
|
+
"CHF",
|
|
145866
|
+
"CHW",
|
|
145867
|
+
"CLF",
|
|
145868
|
+
"CLP",
|
|
145869
|
+
"CNY",
|
|
145870
|
+
"COP",
|
|
145871
|
+
"COU",
|
|
145872
|
+
"CRC",
|
|
145873
|
+
"CUC",
|
|
145874
|
+
"CUP",
|
|
145875
|
+
"CVE",
|
|
145876
|
+
"CZK",
|
|
145877
|
+
"DJF",
|
|
145878
|
+
"DKK",
|
|
145879
|
+
"DOP",
|
|
145880
|
+
"DZD",
|
|
145881
|
+
"EGP",
|
|
145882
|
+
"ERN",
|
|
145883
|
+
"ETB",
|
|
145884
|
+
"EUR",
|
|
145885
|
+
"FJD",
|
|
145886
|
+
"FKP",
|
|
145887
|
+
"GBP",
|
|
145888
|
+
"GEL",
|
|
145889
|
+
"GHS",
|
|
145890
|
+
"GIP",
|
|
145891
|
+
"GMD",
|
|
145892
|
+
"GNF",
|
|
145893
|
+
"GTQ",
|
|
145894
|
+
"GYD",
|
|
145895
|
+
"HKD",
|
|
145896
|
+
"HNL",
|
|
145897
|
+
"HRK",
|
|
145898
|
+
"HTG",
|
|
145899
|
+
"HUF",
|
|
145900
|
+
"IDR",
|
|
145901
|
+
"ILS",
|
|
145902
|
+
"INR",
|
|
145903
|
+
"IQD",
|
|
145904
|
+
"IRR",
|
|
145905
|
+
"ISK",
|
|
145906
|
+
"JMD",
|
|
145907
|
+
"JOD",
|
|
145908
|
+
"JPY",
|
|
145909
|
+
"KES",
|
|
145910
|
+
"KGS",
|
|
145911
|
+
"KHR",
|
|
145912
|
+
"KMF",
|
|
145913
|
+
"KPW",
|
|
145914
|
+
"KRW",
|
|
145915
|
+
"KWD",
|
|
145916
|
+
"KYD",
|
|
145917
|
+
"KZT",
|
|
145918
|
+
"LAK",
|
|
145919
|
+
"LBP",
|
|
145920
|
+
"LKR",
|
|
145921
|
+
"LRD",
|
|
145922
|
+
"LSL",
|
|
145923
|
+
"LYD",
|
|
145924
|
+
"MAD",
|
|
145925
|
+
"MDL",
|
|
145926
|
+
"MGA",
|
|
145927
|
+
"MKD",
|
|
145928
|
+
"MMK",
|
|
145929
|
+
"MNT",
|
|
145930
|
+
"MOP",
|
|
145931
|
+
"MRU",
|
|
145932
|
+
"MUR",
|
|
145933
|
+
"MVR",
|
|
145934
|
+
"MWK",
|
|
145935
|
+
"MXN",
|
|
145936
|
+
"MXV",
|
|
145937
|
+
"MYR",
|
|
145938
|
+
"MZN",
|
|
145939
|
+
"NAD",
|
|
145940
|
+
"NGN",
|
|
145941
|
+
"NIO",
|
|
145942
|
+
"NOK",
|
|
145943
|
+
"NPR",
|
|
145944
|
+
"NZD",
|
|
145945
|
+
"OMR",
|
|
145946
|
+
"PAB",
|
|
145947
|
+
"PEN",
|
|
145948
|
+
"PGK",
|
|
145949
|
+
"PHP",
|
|
145950
|
+
"PKR",
|
|
145951
|
+
"PLN",
|
|
145952
|
+
"PYG",
|
|
145953
|
+
"QAR",
|
|
145954
|
+
"RON",
|
|
145955
|
+
"RSD",
|
|
145956
|
+
"RUB",
|
|
145957
|
+
"RWF",
|
|
145958
|
+
"SAR",
|
|
145959
|
+
"SBD",
|
|
145960
|
+
"SCR",
|
|
145961
|
+
"SDG",
|
|
145962
|
+
"SEK",
|
|
145963
|
+
"SGD",
|
|
145964
|
+
"SHP",
|
|
145965
|
+
"SLL",
|
|
145966
|
+
"SOS",
|
|
145967
|
+
"SRD",
|
|
145968
|
+
"SSP",
|
|
145969
|
+
"STN",
|
|
145970
|
+
"SVC",
|
|
145971
|
+
"SYP",
|
|
145972
|
+
"SZL",
|
|
145973
|
+
"THB",
|
|
145974
|
+
"TJS",
|
|
145975
|
+
"TMT",
|
|
145976
|
+
"TND",
|
|
145977
|
+
"TOP",
|
|
145978
|
+
"TRY",
|
|
145979
|
+
"TTD",
|
|
145980
|
+
"TWD",
|
|
145981
|
+
"TZS",
|
|
145982
|
+
"UAH",
|
|
145983
|
+
"UGX",
|
|
145984
|
+
"USD",
|
|
145985
|
+
"USN",
|
|
145986
|
+
"UYI",
|
|
145987
|
+
"UYU",
|
|
145988
|
+
"UYW",
|
|
145989
|
+
"UZS",
|
|
145990
|
+
"VES",
|
|
145991
|
+
"VND",
|
|
145992
|
+
"VUV",
|
|
145993
|
+
"WST",
|
|
145994
|
+
"XAF",
|
|
145995
|
+
"XAG",
|
|
145996
|
+
"XAU",
|
|
145997
|
+
"XBA",
|
|
145998
|
+
"XBB",
|
|
145999
|
+
"XBC",
|
|
146000
|
+
"XBD",
|
|
146001
|
+
"XCD",
|
|
146002
|
+
"XDR",
|
|
146003
|
+
"XOF",
|
|
146004
|
+
"XPD",
|
|
146005
|
+
"XPF",
|
|
146006
|
+
"XPT",
|
|
146007
|
+
"XSU",
|
|
146008
|
+
"XTS",
|
|
146009
|
+
"XUA",
|
|
146010
|
+
"XXX",
|
|
146011
|
+
"YER",
|
|
146012
|
+
"ZAR",
|
|
146013
|
+
"ZMW",
|
|
146014
|
+
"ZWL"
|
|
146015
|
+
]
|
|
146016
|
+
},
|
|
146017
|
+
"periodStartsOn": {
|
|
146018
|
+
"description": "Uses the YYYY-MM-DD date format.",
|
|
146019
|
+
"type": "string",
|
|
146020
|
+
"format": "date"
|
|
146021
|
+
},
|
|
146022
|
+
"periodEndsOn": {
|
|
146023
|
+
"description": "Uses the YYYY-MM-DD date format.",
|
|
146024
|
+
"type": "string",
|
|
146025
|
+
"format": "date"
|
|
146026
|
+
},
|
|
146027
|
+
"credit": {
|
|
146028
|
+
"description": "Reversal this record carries out. Present only on reversing (credit) records.\n",
|
|
146029
|
+
"type": "object",
|
|
146030
|
+
"properties": {
|
|
146031
|
+
"reimbursementRecordId": {
|
|
146032
|
+
"type": "integer",
|
|
146033
|
+
"description": "Reimbursement record this record reverses, as exposed by this same resource."
|
|
146034
|
+
},
|
|
146035
|
+
"reason": {
|
|
146036
|
+
"type": "string",
|
|
146037
|
+
"description": "Reason the reversal was issued, as supplied when the credit was requested."
|
|
146038
|
+
}
|
|
146039
|
+
}
|
|
146040
|
+
},
|
|
146041
|
+
"creditedByReimbursementRecordId": {
|
|
146042
|
+
"type": "integer",
|
|
146043
|
+
"description": "Reversing (credit) record that reverses this record, as exposed by this same resource. Omitted when this record has not been reversed."
|
|
146044
|
+
},
|
|
146045
|
+
"authUserId": {
|
|
146046
|
+
"type": "integer",
|
|
146047
|
+
"description": "User whose credential authorized the charging session, as exposed by the users resource. `effectiveUserId` differs from it when the session's vehicle belongs to the charge point owner and the reimbursement was attributed to that owner instead."
|
|
146048
|
+
},
|
|
146049
|
+
"effectiveUserId": {
|
|
146050
|
+
"type": "integer",
|
|
146051
|
+
"description": "User the session was attributed to for reimbursement purposes, as exposed by the users resource. Equal to `beneficiary.userId` on company reimbursements; on public reimbursements the beneficiary is the charge point owner while the effective user is the driver."
|
|
146052
|
+
},
|
|
146053
|
+
"customFields": {
|
|
146054
|
+
"readOnly": true,
|
|
146055
|
+
"description": "Live 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 reimbursement record's current operator owner or are not visible to the acting administrator are omitted. The `customFields` property itself is omitted when no fields apply.\n\nThese values are live metadata and are not captured in the record's immutable financial, policy, tag, or calculation history. Existing reimbursement record access controls continue to determine whether the record can be read; custom field visibility does not grant access to a record.\n",
|
|
146056
|
+
"type": "object",
|
|
146057
|
+
"additionalProperties": true
|
|
146058
|
+
},
|
|
146059
|
+
"createdAt": {
|
|
146060
|
+
"type": "string",
|
|
146061
|
+
"format": "date-time",
|
|
146062
|
+
"description": "ISO 8601 formatted date",
|
|
146063
|
+
"readOnly": true
|
|
146064
|
+
},
|
|
146065
|
+
"updatedAt": {
|
|
146066
|
+
"type": "string",
|
|
146067
|
+
"format": "date-time",
|
|
146068
|
+
"description": "ISO 8601 formatted date",
|
|
146069
|
+
"readOnly": true
|
|
146070
|
+
}
|
|
146071
|
+
},
|
|
146072
|
+
"required": [
|
|
146073
|
+
"id",
|
|
146074
|
+
"operatorId",
|
|
146075
|
+
"sessionId",
|
|
146076
|
+
"energy",
|
|
146077
|
+
"taxBasis",
|
|
146078
|
+
"amount",
|
|
146079
|
+
"periodStartsOn",
|
|
146080
|
+
"periodEndsOn",
|
|
146081
|
+
"createdAt",
|
|
146082
|
+
"updatedAt"
|
|
146083
|
+
]
|
|
146084
|
+
},
|
|
146085
|
+
"description": "The reimbursement records of the session, ordered by record id ascending. Each entry uses the reimbursement records resource schema. Returned only when `include[]=reimbursementRecords` is set and the caller may view reimbursement records; otherwise omitted. An empty array when the session has no reimbursement records."
|
|
142770
146086
|
}
|
|
142771
146087
|
},
|
|
142772
146088
|
"required": [
|