HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog
Terms of Use
Back to All

3.180.0 release notes

about 16 hours ago by ReadMe API
  1. ⚠️ Breaking changes
    1. Restructured the customer.bankDetails object on Partner Settlement Report responses (POST /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/update-external-id, GET /public-api/resources/partner-settlement-reports/v1.0, GET /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}). The bankIban, bankName, bankAddress, bankCode, bankAccountNumber, and bankAccountType properties are no longer guaranteed in the response — each is now returned only when the corresponding bank detail field is enabled in operator settings. Consumers must handle these properties as optional.
    2. Removed the schedule property from the Circuit listing response (GET /public-api/resources/circuits/v2.0) and the Circuit creation response (POST /public-api/resources/circuits/v2.0). To retrieve a circuit's schedule, use the dedicated GET /public-api/resources/circuits/v2.0/{circuit}/schedule endpoint.
  2. ✨ New features
    1. Added the optional ocpiMaxVoltage, ocpiMaxAmperage, and ocpiMaxElectricPower response properties to Connector data on EVSE and Connector endpoints, including GET/POST /public-api/resources/charge-points/v2.0/{chargePoint}/evses, GET/PATCH /public-api/resources/charge-points/v2.0/{chargePoint}/evses/{evse}, GET/POST /public-api/resources/charge-points/v2.0/{chargePoint}/evses/{evse}/connectors, GET/PATCH /public-api/resources/charge-points/v2.0/{chargePoint}/evses/{evse}/connectors/{connector}, GET /public-api/resources/evses/v2.0, GET/PUT /public-api/resources/evses/v2.0/{evse}, GET/POST /public-api/resources/evses/v2.1, and GET/PATCH /public-api/resources/evses/v2.1/{evse}. The same fields were also added as optional request properties on PUT /public-api/resources/evses/v2.0/{evse}.
    2. Added the optional bankDetails object to Operator responses on GET /public-api/resources/operators/v1.0 and GET /public-api/resources/operators/v1.0/{operator}. The object is returned only when at least one bank detail field is enabled in operator settings, and individual bank fields appear only when their corresponding settings are enabled.
    3. Added the optional bankAccountHolder and bankBic properties to Partner bank details on GET/POST /public-api/resources/partners/v2.0 and GET/PATCH /public-api/resources/partners/v2.0/{partner} (request and response). Also added them as optional request properties on POST /public-api/resources/users/v1.0, PATCH /public-api/resources/users/v1.0/{user}, POST /public-api/resources/users/v1.1, and PATCH /public-api/resources/users/v1.1/{user}.
    4. Added the optional offlineTariffId request and response property on POST/GET /public-api/resources/tariff-groups/v1.0 and PUT/GET /public-api/resources/tariff-groups/v1.0/{tariffGroup}, allowing a fallback tariff to be specified for offline charging.
    5. Added the optional scheduleLimitUnit request and response property on PUT/GET /public-api/resources/circuits/v2.0/{circuit}/schedule, allowing schedule limits to be expressed in amps or kilowatts.
    6. Added a new filter[refContains] query parameter on GET /public-api/resources/transactions/v1.0 to perform partial-match search on the transaction reference field.
    7. Expanded the calibrationLawDataAvailability enum with the new not_available value on POST/GET /public-api/resources/charge-points/v2.0, GET/PATCH /public-api/resources/charge-points/v2.0/{chargePoint} (request and response).
    8. Expanded the parkingType enum with the new IS_TENT and SECURE values on POST/GET /public-api/resources/locations/v2.0 and GET/PATCH /public-api/resources/locations/v2.0/{location} (request and response).
    9. Expanded card network/type enums with the new values bancontact, cartes_bancaires, diners_club, discover, interac, jcb, mada, and visa_electron. Affects the paymentMethod.cardNetwork request property and the cardDetails.type response property on the Transactions endpoints (GET/POST /public-api/resources/transactions/v1.0 and GET/PATCH /public-api/resources/transactions/v1.0/{transaction}), and the issuer response property on GET/POST /public-api/resources/users/v1.0/{user}/payment-methods.
  3. 🔧 Improvements
    1. Relaxed validation on POST /public-api/resources/charge-points/v2.0: the network.id and security.desiredProfile properties are no longer required for charge points that do not use a direct OCPP connection.
    2. Made the templateValidFrom field on Energy Coupon Template responses safe to omit. When no template start date is set, the property is now absent from the response instead of producing an error.
    3. Improved validation on POST /public-api/actions/subscription-billing-periods/v1.0/{billingPeriod}/retry-payment. The endpoint now returns a 422 validation error with a descriptive message when paymentMethodId is omitted and the user has no valid payment methods on file, and when a supplied paymentMethodId references an expired payment method, instead of attempting the payment and failing generically.
  4. 🗑️ Deprecations
    1. Deprecated the defaultPriceInformation and defaultPriceInformationOffline properties on Tariff display information. Affects request payloads on POST /public-api/actions/tariffs/v2.0/{tariff}/set-tariff-display-information, POST /public-api/resources/tariffs/v1.0, PATCH /public-api/resources/tariffs/v1.0/{tariff}, and PUT /public-api/resources/tariffs/v1.0/{tariff}, and response payloads on GET/POST /public-api/resources/tariffs/v1.0, GET/PATCH/PUT /public-api/resources/tariffs/v1.0/{tariff}, and GET /public-api/resources/tariff-snapshots/v1.0/{tariffSnapshot}.