HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog

3.284.0 release notes

  1. ⚠️ Breaking changes
    1. Changed date validation on POST /public-api/resources/partner-contracts/v1.0 and PATCH / PUT /public-api/resources/partner-contracts/v1.0/{partnerContract} to reject an endDate before startDate with 422. The check applies when creating a contract or changing dates on a contract that has not ended.
    2. Changed filter[origin] validation on GET /public-api/resources/partner-expenses/v1.1 and GET /public-api/resources/partner-revenues/v1.1 to reject unsupported origin values instead of accepting arbitrary strings.
  2. ✨ New features
    1. Added roaming_connection as a circuit user priority type on POST /public-api/resources/circuits/v2.0/{circuit}/user-priorities and PATCH /public-api/resources/circuits/v2.0/{circuit}/user-priorities/USERPRIORITY. Set targetId to an eligible roaming connection ID, omit it on creation to cover all roaming connections, or send null on update to cover all roaming connections; responses omit targetId for an all-connections priority.
    2. Added the optional afirLabellingLetter response field to connectors, identifying the applicable AFIR compatibility label when available. It is returned by 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 / POST /public-api/resources/evses/v2.1, GET / PATCH /public-api/resources/evses/v2.1/{evse}, and POST /public-api/actions/evse/v1.0/{evse}/set-custom-fields.
    3. Added the optional reimbursement.fixedAmountPerPeriodEnabled setting to POST /public-api/resources/partner-contracts/v1.0 and PATCH / PUT /public-api/resources/partner-contracts/v1.0/{partnerContract} to enable fixed payments per reimbursement period. The setting is also returned, when reimbursement is enabled, by those endpoints, GET /public-api/resources/partner-contracts/v1.0, GET /public-api/resources/partner-contracts/v1.0/{partnerContract}, and POST /public-api/actions/partner-contract/v1.0/{partnerContract}/disable, POST /public-api/actions/partner-contract/v1.0/{partnerContract}/reactivate, and POST /public-api/actions/partner-contract/v1.0/{partnerContract}/start-offboarding.
    4. Added the optional fixedAmountPerPeriod field to requests on POST /public-api/resources/reimbursement-policies/v1.0 and PATCH /public-api/resources/reimbursement-policies/v1.0/{reimbursementPolicy}, and to responses from those endpoints and GET /public-api/resources/reimbursement-policies/v1.0 and GET /public-api/resources/reimbursement-policies/v1.0/{reimbursementPolicy}. It specifies a non-negative payment to the driver in addition to energy reimbursement; non-zero amounts require fixed payments to be enabled on the applicable partner contract or operator settings, and sending null on update removes the amount.
    5. Added partnerCurrency to responses from GET /public-api/resources/partner-settlement-reports/v1.1 and GET /public-api/resources/partner-settlement-reports/v1.1/{partnerSettlementReport} for eligible cross-operator reports with a stored exchange rate. It contains currencyCode, conversionRate, and converted totals; subtotals and other amounts remain in the report currency.
    6. Added subtotals.expenses.homeChargingReimbursementAdminFee and subtotals.revenues.homeChargingReimbursementAdminFeeRefund to responses from GET /public-api/resources/partner-settlement-reports/v1.1 and GET /public-api/resources/partner-settlement-reports/v1.1/{partnerSettlementReport} when the report contains the corresponding records.
  3. 🔧 Improvements
    1. Expanded expense response origin values with home_charging_reimbursement_admin_fee on GET /public-api/resources/partner-expenses/v1.1, GET /public-api/resources/partner-expenses/v1.2, and POST /public-api/actions/partner-expense/v1.0/{partnerExpense}/set-custom-fields; expanded revenue response origin values with home_charging_reimbursement_admin_fee_refund on GET /public-api/resources/partner-revenues/v1.1, GET /public-api/resources/partner-revenues/v1.2, and POST /public-api/actions/partner-revenue/v1.0/{partnerRevenue}/set-custom-fields. The respective new values are also accepted by filter[origin] on the v1.2 listing endpoints.
    2. Changed partial updates on PATCH /public-api/resources/circuits/v2.0/{circuit}/user-priorities/USERPRIORITY to preserve omitted type, targetId, and priority values when the type is unchanged. Changing type discards the previous target, so switching to partner or userGroup requires a new targetId.
    3. Added 409 Conflict responses for duplicate roaming connection priorities on POST /public-api/resources/circuits/v2.0/{circuit}/user-priorities and PATCH /public-api/resources/circuits/v2.0/{circuit}/user-priorities/USERPRIORITY.
    4. Changed the enabled response field to reflect whether the roaming operator is enabled in the CPO role on GET /public-api/resources/roaming-cpos/v1.0, GET / PATCH /public-api/resources/roaming-cpos/v1.0/{roamingCpo}, GET /public-api/resources/roaming-operators/v2.0, and GET / PATCH /public-api/resources/roaming-operators/v2.0/{roamingOperator}.
    5. Changed invoice locale fallback to prefer the configured invoice language before the operator's default locale when no explicit locale is supplied for invoice details on POST /public-api/resources/transactions/v1.0 and POST /public-api/actions/evse/v1.0/{evse}/start-ad-hoc-session. Invoice issuance through POST /public-api/actions/transactions/v1.0/{transaction}/issue-invoice also uses this fallback when no user locale is available.
    6. Added a 404 Not Found response to PATCH /public-api/resources/charge-points/v1.0/{chargePoint}/configurations/{key} when the configuration key does not exist, including a QRCode0 key that the charge point refused when a configuration template attempted to create it.