@ampeco/public-api-mcp 3.255.2 → 3.256.1

package/dist/generated/response-schemas.json

@@ -12920,7 +12920,7 @@
                 "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."
               },
               "electricityRateSource": {
-                "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n",
+                "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",
                 "type": "string",
                 "enum": [
                   "policy",
@@ -13355,7 +13355,7 @@
                 "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."
               },
               "electricityRateSource": {
-                "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n",
+                "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",
                 "type": "string",
                 "enum": [
                   "policy",
@@ -16402,6 +16402,455 @@
       }
     }
   },
+  "transactionSetCustomFields": {
+    "202": {
+      "schema": {
+        "type": "object",
+        "description": "Transaction",
+        "properties": {
+          "id": {
+            "type": "integer"
+          },
+          "operatorId": {
+            "type": "integer",
+            "description": "The ID of the operator this resource belongs to",
+            "example": 1
+          },
+          "number": {
+            "type": "string",
+            "nullable": true
+          },
+          "date": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "userId": {
+            "type": "integer",
+            "nullable": true
+          },
+          "userEmail": {
+            "type": "string",
+            "format": "email"
+          },
+          "sessionId": {
+            "type": "integer",
+            "nullable": true
+          },
+          "paymentMethod": {
+            "type": "string",
+            "nullable": true,
+            "deprecated": true,
+            "description": "The description that is generated by the payment terminal. This property should be used for payment terminal integrations."
+          },
+          "paymentMethodId": {
+            "type": "string",
+            "description": "The ID of the payment method, as returned by the payment method listing `( Users / Payment Methods / Listing)`. For corporate billing the format is `corporate:1234` , for subscription - that is when the user has an active post-paid subscription, the format is `subscription_installment:1235`, for wallets the format is `wallet:applepay`, for bank transfers `bank_transfer:sepa` and for balance the returned value is null. When a transaction covers an ad-hoc session, no additional data can be obtained through the \"Users / Payment Methods\" endpoint.",
+            "nullable": true
+          },
+          "paymentProcessorId": {
+            "type": "integer",
+            "description": "Stable identifier of the payment processor integration that collected the payment. Use it for automated\nmatching and reconciliation. Present only when a payment processor integration collected the payment,\nwhich includes card payments and post-paid subscription settlements charged to a stored payment method.\nOmitted for payment terminal transactions, which identify their integration through `terminalId` and the\n`integrationId` of the payment terminal resource, and for transactions recorded before the identifier was captured.\n"
+          },
+          "purchaseResourceType": {
+            "type": "string",
+            "enum": [
+              "subscription_plan",
+              "topup_package",
+              "session",
+              "payment_authorisation",
+              "payment_terminal_authorisation",
+              "custom_fee",
+              "card_registration"
+            ],
+            "description": "The type of purchase the transaction is for."
+          },
+          "purchaseResourceId": {
+            "type": "integer",
+            "nullable": true,
+            "description": "The ID of the resource referenced by `purchaseResourceType`:\n- `session`: the ID of the charging session.\n- `topup_package`: the ID of the top-up package.\n- `subscription_plan`: the ID of the subscription plan.\n- `custom_fee`: the ID of the custom fee.\n- `card_registration`: the ID of the payment method that was tokenized by this transaction.\n- `payment_terminal_authorisation` and `payment_authorisation`: `null`.\n"
+          },
+          "totalAmount": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 10000000000000
+          },
+          "authorizedAmount": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 10000000000000,
+            "description": "The PSP-authorised ceiling for this transaction. Omitted when the transaction has no pre-authorisation amount set."
+          },
+          "currency": {
+            "type": "string",
+            "minLength": 3,
+            "maxLength": 3,
+            "description": "The ISO 4217 3-letter code of the currency"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "finalized",
+              "failed",
+              "reversed",
+              "refunded",
+              "authorized",
+              "initialized"
+            ]
+          },
+          "pendingReason": {
+            "type": "string",
+            "enum": [
+              "3ds_authentication",
+              "psp_processing",
+              "bank_transfer_pending",
+              "bank_transfer_processing",
+              "payment_terminal_authorization",
+              "awaiting_reconciliation",
+              "other"
+            ],
+            "description": "Reason a transaction is currently pending. Available only while `status` is `pending`; omitted once the transaction reaches a terminal status. The property may also be absent on a pending transaction when no specific reason has been recorded — for example legacy transactions created before the enum rolled out to all PSPs, or transactions handled by a payment service provider that does not yet report a pending reason.\n- **3ds_authentication**: Transaction requires 3D Secure verification from the user\n- **psp_processing**: Payment processor is processing the transaction\n- **bank_transfer_pending**: User needs to complete the bank transfer redirect\n- **bank_transfer_processing**: Bank transfer initiated, awaiting confirmation\n- **payment_terminal_authorization**: Waiting for payment terminal authorization\n- **awaiting_reconciliation**: The payment is handled by a payment terminal on the charge point, and the transaction is waiting to be reconciled with the amount that terminal settles. The amount currently on the transaction is provisional until reconciliation completes.\n- **other**: Pending but the reason does not fit any of the defined categories\n",
+            "example": "3ds_authentication"
+          },
+          "ref": {
+            "type": "string",
+            "description": "Reference to the payment processor or payment terminal where more information about\nthe transaction could be checked. It is the primary reference for the payment and is\nupdated as the payment progresses through authorisation and capture.\n"
+          },
+          "bankMessage": {
+            "type": "string"
+          },
+          "failureReason": {
+            "type": "string",
+            "nullable": true
+          },
+          "invoiceId": {
+            "type": "integer",
+            "nullable": true,
+            "description": "The ID of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this points at the\nreplacement, not at the reversed original. The value is therefore not stable for the lifetime\nof the transaction - re-read it rather than caching the transaction-to-invoice mapping.\n"
+          },
+          "invoiceNo": {
+            "deprecated": true,
+            "type": "string",
+            "nullable": true,
+            "description": "**This property is deprecated. Use `invoiceId` instead.**\n\nThe number of the transaction's current valid invoice. When an invoice is fully reversed by a\ncredit note and a replacement invoice is issued for the transaction, this carries the\nreplacement's number, not the reversed original's.\n"
+          },
+          "receiptId": {
+            "type": "integer",
+            "nullable": true
+          },
+          "billingType": {
+            "type": "string",
+            "description": "The type of billing used for the transaction. Internal transactions are processed in our system, while external transactions are billed externally.\nAutomatically set to `external` for transactions created against sessions initiated over OCPP (local payment terminal, RFID, plug-and-charge).\n",
+            "enum": [
+              "internal",
+              "external"
+            ]
+          },
+          "lastUpdatedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "ISO 8601 formatted date",
+            "readOnly": true
+          },
+          "finalizedAt": {
+            "type": "string",
+            "nullable": true,
+            "format": "date-time",
+            "description": "ISO 8601 formatted date",
+            "readOnly": true
+          },
+          "terminalId": {
+            "type": "integer",
+            "description": "The ID of the payment terminal when such is used",
+            "nullable": true
+          },
+          "voucherId": {
+            "type": "integer",
+            "description": "Returned only if the paymentMethodId property is null, this is the id of the balance voucher that paid the transaction"
+          },
+          "subscriptionBillingPeriodId": {
+            "type": "integer",
+            "description": "The ID of the subscription billing period this transaction belongs to. Present on both credit-sale transactions (session fees, subscription fees) and settlement payment transactions."
+          },
+          "settledByTransactionId": {
+            "type": "integer",
+            "description": "The ID of the settlement transaction that paid for this obligation. Present only on credit-sale transactions (session fees, base fees, charger fees) that have been settled."
+          },
+          "cardDetails": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "deprecated": true,
+                "description": "**This property is deprecated. Use `cardNetwork` instead.**\n\nCard brand\n",
+                "nullable": true,
+                "enum": [
+                  "visa",
+                  "mastercard",
+                  "paypal",
+                  "maestro",
+                  "amex",
+                  "bancontact",
+                  "cartes_bancaires",
+                  "diners_club",
+                  "discover",
+                  "interac",
+                  "jcb",
+                  "mada",
+                  "visa_electron",
+                  "unknown"
+                ],
+                "x-enumDescriptions": {
+                  "bancontact": "Bancontact",
+                  "cartes_bancaires": "Cartes Bancaires",
+                  "diners_club": "Diners Club",
+                  "discover": "Discover",
+                  "interac": "Interac",
+                  "jcb": "JCB",
+                  "mada": "MADA",
+                  "visa_electron": "Visa Electron"
+                }
+              },
+              "cardNetwork": {
+                "type": "string",
+                "description": "Card network. Replaces the deprecated `type`.",
+                "enum": [
+                  "visa",
+                  "mastercard",
+                  "paypal",
+                  "maestro",
+                  "amex",
+                  "bancontact",
+                  "cartes_bancaires",
+                  "diners_club",
+                  "discover",
+                  "interac",
+                  "jcb",
+                  "mada",
+                  "visa_electron",
+                  "unknown"
+                ],
+                "x-enumDescriptions": {
+                  "bancontact": "Bancontact",
+                  "cartes_bancaires": "Cartes Bancaires",
+                  "diners_club": "Diners Club",
+                  "discover": "Discover",
+                  "interac": "Interac",
+                  "jcb": "JCB",
+                  "mada": "MADA",
+                  "visa_electron": "Visa Electron"
+                }
+              },
+              "last4": {
+                "type": "string",
+                "description": "Card number last 4 digits",
+                "minLength": 4,
+                "maxLength": 4,
+                "nullable": true
+              },
+              "expMonth": {
+                "type": "string",
+                "description": "Card expiration month",
+                "nullable": true
+              },
+              "expYear": {
+                "type": "string",
+                "description": "Card expiration year",
+                "nullable": true
+              },
+              "token": {
+                "type": "string",
+                "description": "Card token",
+                "nullable": true
+              },
+              "cardType": {
+                "type": "string",
+                "description": "Card category.\n\nAllowed values:\n- `credit` - Credit card.\n- `debit` - Debit card.\n- `prepaid` - Prepaid card.\n",
+                "enum": [
+                  "credit",
+                  "debit",
+                  "prepaid"
+                ]
+              },
+              "bin": {
+                "type": "string",
+                "description": "Bank identification number recorded for this transaction (first 6-8 digits)."
+              },
+              "fingerprint": {
+                "type": "string",
+                "description": "Unique card fingerprint recorded for this transaction for cross-channel and cross-PSP card identification. Carries the Payment Account Reference (PAR) where the PSP provides it."
+              },
+              "acquirerName": {
+                "type": "string",
+                "description": "Name of the acquiring bank recorded for this transaction."
+              },
+              "issuerName": {
+                "type": "string",
+                "description": "Name of the card issuing bank recorded for this transaction."
+              },
+              "issuerCode": {
+                "type": "string",
+                "description": "Code of the card issuing bank recorded for this transaction."
+              },
+              "tokenizationMethod": {
+                "type": "string",
+                "enum": [
+                  "apple_pay",
+                  "google_pay",
+                  "masterpass",
+                  "visa_checkout",
+                  "samsung_pay",
+                  "amex_express_checkout",
+                  "twint"
+                ],
+                "description": "The tokenization method used to create the payment method.\nThis field indicates if the card was tokenized through a digital wallet service.\nOnly present when the payment method was created using a supported tokenization method.\n",
+                "x-enumDescriptions": {
+                  "apple_pay": "Apple Pay tokenization",
+                  "google_pay": "Google Pay tokenization",
+                  "masterpass": "Masterpass tokenization",
+                  "visa_checkout": "Visa Checkout tokenization",
+                  "samsung_pay": "Samsung Pay tokenization",
+                  "amex_express_checkout": "American Express Express Checkout tokenization",
+                  "twint": "TWINT tokenization"
+                }
+              }
+            }
+          },
+          "paymentMetadata": {
+            "type": "object",
+            "description": "Regulatory payment metadata captured from the payment source (terminal or online).\nOmitted when no metadata has been recorded for this transaction.\n",
+            "properties": {
+              "applicationIdentifier": {
+                "type": "string",
+                "description": "Application Identifier (AID) from the card chip."
+              },
+              "terminalIdentifier": {
+                "type": "string",
+                "description": "Terminal ID configured on the payment device."
+              },
+              "merchantIdentifier": {
+                "type": "string",
+                "description": "Merchant ID assigned by the acquirer."
+              },
+              "authorisationCode": {
+                "type": "string",
+                "description": "Authorisation code from the issuer/acquirer."
+              },
+              "acquirerIdentifier": {
+                "type": "string",
+                "description": "Acquirer ID identifying the acquiring bank."
+              },
+              "cardholderVerificationMethod": {
+                "description": "How the cardholder was verified.",
+                "type": "string",
+                "enum": [
+                  "no_cvm",
+                  "signature",
+                  "online_pin",
+                  "offline_pin",
+                  "consumer_device",
+                  "online_pin_and_signature",
+                  "offline_pin_and_signature"
+                ],
+                "x-enumDescriptions": {
+                  "no_cvm": "No cardholder verification was performed, for example a low-value contactless tap below the verification limit.",
+                  "signature": "Cardholder verified by signature on the receipt.",
+                  "online_pin": "PIN entered at the terminal and verified online by the card issuer.",
+                  "offline_pin": "PIN entered at the terminal and verified offline by the card chip.",
+                  "consumer_device": "Cardholder verified on their own device, for example a phone biometric or passcode (CDCVM).",
+                  "online_pin_and_signature": "Cardholder verified by both an online-verified PIN and a signature.",
+                  "offline_pin_and_signature": "Cardholder verified by both an offline-verified PIN and a signature."
+                }
+              }
+            }
+          },
+          "paymentOrderReference": {
+            "type": "string",
+            "maxLength": 255,
+            "description": "An additional reference for the same payment, written once by whichever system took the\npayment and not changed as the payment progresses — either issued by the payment provider\nor supplied to the provider by the merchant. Recorded so the transaction can be reconciled\nagainst the provider's own reports.\nOmitted when no payment order reference has been recorded for this transaction.\n"
+          },
+          "customFields": {
+            "description": "Applicable custom field values keyed by administrator-defined identifier. Omitted when none apply; an applicable field without a value is returned as null.",
+            "type": "object",
+            "additionalProperties": true
+          }
+        },
+        "required": [
+          "id",
+          "operatorId",
+          "number",
+          "date",
+          "userId",
+          "sessionId",
+          "ref",
+          "currency"
+        ]
+      }
+    },
+    "401": {
+      "schema": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "403": {
+      "schema": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "default": "This action is unauthorized."
+          }
+        }
+      }
+    },
+    "404": {
+      "schema": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "422": {
+      "schema": {
+        "type": "object",
+        "required": [
+          "message"
+        ],
+        "properties": {
+          "message": {
+            "type": "string"
+          },
+          "errors": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    },
+    "429": {
+      "schema": {
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
   "transactionIssueInvoice": {
     "401": {
       "schema": {
@@ -18307,6 +18756,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -18508,6 +18958,7 @@
                 "SessionUpdateNotification",
                 "session.chargingPeriod.changed",
                 "UserChangedNotification",
+                "user.UserGroup.changed",
                 "SubOperatorChangedNotification",
                 "TariffChangedNotification",
                 "tariffGroup.changed",
@@ -18647,6 +19098,7 @@
                     "SessionUpdateNotification",
                     "session.chargingPeriod.changed",
                     "UserChangedNotification",
+                    "user.UserGroup.changed",
                     "SubOperatorChangedNotification",
                     "TariffChangedNotification",
                     "tariffGroup.changed",
@@ -18776,6 +19228,7 @@
                     "SessionUpdateNotification",
                     "session.chargingPeriod.changed",
                     "UserChangedNotification",
+                    "user.UserGroup.changed",
                     "SubOperatorChangedNotification",
                     "TariffChangedNotification",
                     "tariffGroup.changed",
@@ -18980,6 +19433,7 @@
                       "SessionUpdateNotification",
                       "session.chargingPeriod.changed",
                       "UserChangedNotification",
+                      "user.UserGroup.changed",
                       "SubOperatorChangedNotification",
                       "TariffChangedNotification",
                       "tariffGroup.changed",
@@ -19235,6 +19689,7 @@
                     "SessionUpdateNotification",
                     "session.chargingPeriod.changed",
                     "UserChangedNotification",
+                    "user.UserGroup.changed",
                     "SubOperatorChangedNotification",
                     "TariffChangedNotification",
                     "tariffGroup.changed",
@@ -19463,6 +19918,7 @@
                     "SessionUpdateNotification",
                     "session.chargingPeriod.changed",
                     "UserChangedNotification",
+                    "user.UserGroup.changed",
                     "SubOperatorChangedNotification",
                     "TariffChangedNotification",
                     "tariffGroup.changed",
@@ -19679,6 +20135,7 @@
                     "SessionUpdateNotification",
                     "session.chargingPeriod.changed",
                     "UserChangedNotification",
+                    "user.UserGroup.changed",
                     "SubOperatorChangedNotification",
                     "TariffChangedNotification",
                     "tariffGroup.changed",
@@ -123128,7 +123585,11 @@
                 },
                 "electricityRateId": {
                   "type": "integer",
-                  "description": "Linked electricity rate providing the reimbursement rate. Set only when `electricityRateSource` is `policy`, where it is required."
+                  "description": "Linked electricity rate providing the reimbursement rate. Present only when `electricityRateSource` is `policy`."
+                },
+                "integrationId": {
+                  "type": "integer",
+                  "description": "Regional electricity rates integration that resolves the reimbursement rate. Present only when `electricityRateSource` is `integration`. The integration is created and configured in the admin panel; use the id shown on its detail page."
                 },
                 "validityEndsOn": {
                   "description": "Uses the YYYY-MM-DD date format.",
@@ -123142,7 +123603,7 @@
                     "charge_point",
                     "integration"
                   ],
-                  "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n"
+                  "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"
                 },
                 "id": {
                   "type": "integer",
@@ -123318,7 +123779,11 @@
               },
               "electricityRateId": {
                 "type": "integer",
-                "description": "Linked electricity rate providing the reimbursement rate. Set only when `electricityRateSource` is `policy`, where it is required."
+                "description": "Linked electricity rate providing the reimbursement rate. Present only when `electricityRateSource` is `policy`."
+              },
+              "integrationId": {
+                "type": "integer",
+                "description": "Regional electricity rates integration that resolves the reimbursement rate. Present only when `electricityRateSource` is `integration`. The integration is created and configured in the admin panel; use the id shown on its detail page."
               },
               "validityEndsOn": {
                 "description": "Uses the YYYY-MM-DD date format.",
@@ -123332,7 +123797,7 @@
                   "charge_point",
                   "integration"
                 ],
-                "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n"
+                "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"
               },
               "id": {
                 "type": "integer",
@@ -123449,7 +123914,11 @@
               },
               "electricityRateId": {
                 "type": "integer",
-                "description": "Linked electricity rate providing the reimbursement rate. Set only when `electricityRateSource` is `policy`, where it is required."
+                "description": "Linked electricity rate providing the reimbursement rate. Present only when `electricityRateSource` is `policy`."
+              },
+              "integrationId": {
+                "type": "integer",
+                "description": "Regional electricity rates integration that resolves the reimbursement rate. Present only when `electricityRateSource` is `integration`. The integration is created and configured in the admin panel; use the id shown on its detail page."
               },
               "validityEndsOn": {
                 "description": "Uses the YYYY-MM-DD date format.",
@@ -123463,7 +123932,7 @@
                   "charge_point",
                   "integration"
                 ],
-                "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n"
+                "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"
               },
               "id": {
                 "type": "integer",
@@ -123643,7 +124112,11 @@
               },
               "electricityRateId": {
                 "type": "integer",
-                "description": "Linked electricity rate providing the reimbursement rate. Set only when `electricityRateSource` is `policy`, where it is required."
+                "description": "Linked electricity rate providing the reimbursement rate. Present only when `electricityRateSource` is `policy`."
+              },
+              "integrationId": {
+                "type": "integer",
+                "description": "Regional electricity rates integration that resolves the reimbursement rate. Present only when `electricityRateSource` is `integration`. The integration is created and configured in the admin panel; use the id shown on its detail page."
               },
               "validityEndsOn": {
                 "description": "Uses the YYYY-MM-DD date format.",
@@ -123657,7 +124130,7 @@
                   "charge_point",
                   "integration"
                 ],
-                "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n"
+                "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"
               },
               "id": {
                 "type": "integer",
@@ -123823,7 +124296,7 @@
                   "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."
                 },
                 "electricityRateSource": {
-                  "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n",
+                  "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",
                   "type": "string",
                   "enum": [
                     "policy",
@@ -124294,7 +124767,7 @@
                 "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."
               },
               "electricityRateSource": {
-                "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.\n- **charge_point**: The electricity rate assigned to the personal charge point provides the rate, whichever surface assigned it. `electricityRateId` must not be set on the policy.\n- **integration**: An integration resolves the electricity rate — for example by the charge point's region. The integration and its region-to-rate bindings are configured in the admin panel. `electricityRateId` is not set on the policy.\n",
+                "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",
                 "type": "string",
                 "enum": [
                   "policy",
@@ -142512,9 +142985,9 @@
                   }
                 },
                 "lastUpdatedAt": {
+                  "description": "ISO 8601 formatted date",
                   "type": "string",
                   "format": "date-time",
-                  "description": "ISO 8601 formatted date",
                   "readOnly": true
                 }
               },
@@ -142754,9 +143227,9 @@
                 }
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               }
             },
@@ -142881,9 +143354,9 @@
                 }
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               }
             },
@@ -142996,9 +143469,9 @@
                 }
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               }
             },
@@ -145435,6 +145908,11 @@
                   "nullable": true,
                   "description": "Used to store custom information, usually used for external references or metadata to the resource."
                 },
+                "isBaseTariff": {
+                  "type": "boolean",
+                  "readOnly": true,
+                  "description": "`true` when this tariff is the base tariff in at least one tariff group, including a group not visible to the current API token; otherwise `false`. This identifies the tariff, but does not grant access to its groups.\nA base tariff cannot have restrictions. It cannot be detached from or moved within a group where it is the base tariff. A tariff may belong to multiple groups, and this value remains `true` while at least one group uses it as a base.\nNot included on tariff snapshots, which do not capture historical group membership.\n"
+                },
                 "incrementalPreAuthorizationSupported": {
                   "type": "boolean",
                   "readOnly": true,
@@ -145446,6 +145924,7 @@
                 "operatorId",
                 "name",
                 "type",
+                "isBaseTariff",
                 "incrementalPreAuthorizationSupported"
               ]
             }
@@ -146750,6 +147229,11 @@
                 "nullable": true,
                 "description": "Used to store custom information, usually used for external references or metadata to the resource."
               },
+              "isBaseTariff": {
+                "type": "boolean",
+                "readOnly": true,
+                "description": "`true` when this tariff is the base tariff in at least one tariff group, including a group not visible to the current API token; otherwise `false`. This identifies the tariff, but does not grant access to its groups.\nA base tariff cannot have restrictions. It cannot be detached from or moved within a group where it is the base tariff. A tariff may belong to multiple groups, and this value remains `true` while at least one group uses it as a base.\nNot included on tariff snapshots, which do not capture historical group membership.\n"
+              },
               "incrementalPreAuthorizationSupported": {
                 "type": "boolean",
                 "readOnly": true,
@@ -146761,6 +147245,7 @@
               "operatorId",
               "name",
               "type",
+              "isBaseTariff",
               "incrementalPreAuthorizationSupported"
             ]
           }
@@ -147950,6 +148435,11 @@
                 "nullable": true,
                 "description": "Used to store custom information, usually used for external references or metadata to the resource."
               },
+              "isBaseTariff": {
+                "type": "boolean",
+                "readOnly": true,
+                "description": "`true` when this tariff is the base tariff in at least one tariff group, including a group not visible to the current API token; otherwise `false`. This identifies the tariff, but does not grant access to its groups.\nA base tariff cannot have restrictions. It cannot be detached from or moved within a group where it is the base tariff. A tariff may belong to multiple groups, and this value remains `true` while at least one group uses it as a base.\nNot included on tariff snapshots, which do not capture historical group membership.\n"
+              },
               "incrementalPreAuthorizationSupported": {
                 "type": "boolean",
                 "readOnly": true,
@@ -147961,6 +148451,7 @@
               "operatorId",
               "name",
               "type",
+              "isBaseTariff",
               "incrementalPreAuthorizationSupported"
             ]
           }
@@ -149138,6 +149629,11 @@
                 "nullable": true,
                 "description": "Used to store custom information, usually used for external references or metadata to the resource."
               },
+              "isBaseTariff": {
+                "type": "boolean",
+                "readOnly": true,
+                "description": "`true` when this tariff is the base tariff in at least one tariff group, including a group not visible to the current API token; otherwise `false`. This identifies the tariff, but does not grant access to its groups.\nA base tariff cannot have restrictions. It cannot be detached from or moved within a group where it is the base tariff. A tariff may belong to multiple groups, and this value remains `true` while at least one group uses it as a base.\nNot included on tariff snapshots, which do not capture historical group membership.\n"
+              },
               "incrementalPreAuthorizationSupported": {
                 "type": "boolean",
                 "readOnly": true,
@@ -149149,6 +149645,7 @@
               "operatorId",
               "name",
               "type",
+              "isBaseTariff",
               "incrementalPreAuthorizationSupported"
             ]
           }
@@ -150401,6 +150898,11 @@
                 "nullable": true,
                 "description": "Used to store custom information, usually used for external references or metadata to the resource."
               },
+              "isBaseTariff": {
+                "type": "boolean",
+                "readOnly": true,
+                "description": "`true` when this tariff is the base tariff in at least one tariff group, including a group not visible to the current API token; otherwise `false`. This identifies the tariff, but does not grant access to its groups.\nA base tariff cannot have restrictions. It cannot be detached from or moved within a group where it is the base tariff. A tariff may belong to multiple groups, and this value remains `true` while at least one group uses it as a base.\nNot included on tariff snapshots, which do not capture historical group membership.\n"
+              },
               "incrementalPreAuthorizationSupported": {
                 "type": "boolean",
                 "readOnly": true,
@@ -150412,6 +150914,7 @@
               "operatorId",
               "name",
               "type",
+              "isBaseTariff",
               "incrementalPreAuthorizationSupported"
             ]
           }
@@ -157251,6 +157754,11 @@
                   "type": "string",
                   "maxLength": 255,
                   "description": "An additional reference for the same payment, written once by whichever system took the\npayment and not changed as the payment progresses — either issued by the payment provider\nor supplied to the provider by the merchant. Recorded so the transaction can be reconciled\nagainst the provider's own reports.\nOmitted when no payment order reference has been recorded for this transaction.\n"
+                },
+                "customFields": {
+                  "description": "Applicable custom field values keyed by administrator-defined identifier. Omitted when none apply; an applicable field without a value is returned as null.",
+                  "type": "object",
+                  "additionalProperties": true
                 }
               },
               "required": [
@@ -157815,6 +158323,11 @@
                 "type": "string",
                 "maxLength": 255,
                 "description": "An additional reference for the same payment, written once by whichever system took the\npayment and not changed as the payment progresses — either issued by the payment provider\nor supplied to the provider by the merchant. Recorded so the transaction can be reconciled\nagainst the provider's own reports.\nOmitted when no payment order reference has been recorded for this transaction.\n"
+              },
+              "customFields": {
+                "description": "Applicable custom field values keyed by administrator-defined identifier. Omitted when none apply; an applicable field without a value is returned as null.",
+                "type": "object",
+                "additionalProperties": true
               }
             },
             "required": [
@@ -158264,6 +158777,11 @@
             "type": "string",
             "maxLength": 255,
             "description": "An additional reference for the same payment, written once by whichever system took the\npayment and not changed as the payment progresses — either issued by the payment provider\nor supplied to the provider by the merchant. Recorded so the transaction can be reconciled\nagainst the provider's own reports.\nOmitted when no payment order reference has been recorded for this transaction.\n"
+          },
+          "customFields": {
+            "description": "Applicable custom field values keyed by administrator-defined identifier. Omitted when none apply; an applicable field without a value is returned as null.",
+            "type": "object",
+            "additionalProperties": true
           }
         },
         "required": [
@@ -158711,6 +159229,11 @@
                 "type": "string",
                 "maxLength": 255,
                 "description": "An additional reference for the same payment, written once by whichever system took the\npayment and not changed as the payment progresses — either issued by the payment provider\nor supplied to the provider by the merchant. Recorded so the transaction can be reconciled\nagainst the provider's own reports.\nOmitted when no payment order reference has been recorded for this transaction.\n"
+              },
+              "customFields": {
+                "description": "Applicable custom field values keyed by administrator-defined identifier. Omitted when none apply; an applicable field without a value is returned as null.",
+                "type": "object",
+                "additionalProperties": true
               }
             },
             "required": [
@@ -159947,9 +160470,9 @@
                   "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
                 },
                 "lastUpdatedAt": {
+                  "description": "ISO 8601 formatted date",
                   "type": "string",
                   "format": "date-time",
-                  "description": "ISO 8601 formatted date",
                   "readOnly": true
                 },
                 "createdAt": {
@@ -162744,9 +163267,9 @@
                 "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               },
               "createdAt": {
@@ -165448,9 +165971,9 @@
                 "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               },
               "createdAt": {
@@ -168211,9 +168734,9 @@
                 "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               },
               "createdAt": {
@@ -177528,9 +178051,9 @@
                   "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
                 },
                 "lastUpdatedAt": {
+                  "description": "ISO 8601 formatted date",
                   "type": "string",
                   "format": "date-time",
-                  "description": "ISO 8601 formatted date",
                   "readOnly": true
                 },
                 "createdAt": {
@@ -180596,9 +181119,9 @@
                 "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               },
               "createdAt": {
@@ -183571,9 +184094,9 @@
                 "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               },
               "createdAt": {
@@ -186605,9 +187128,9 @@
                 "description": "Returns the hashed password. This property is optional and can be enabled by request.\n"
               },
               "lastUpdatedAt": {
+                "description": "ISO 8601 formatted date",
                 "type": "string",
                 "format": "date-time",
-                "description": "ISO 8601 formatted date",
                 "readOnly": true
               },
               "createdAt": {