HomeGuidesAPI ReferenceChangelog
Terms of Use
Changelog

3.281.0 release notes

  1. ⚠️ Breaking changes
    1. Changed rate validation on POST /public-api/resources/currency-rates/v1.0 and PATCH /public-api/resources/currency-rates/v1.0/{currencyRate} to reject values greater than 999999999.999999. Rates must still be greater than zero.
    2. Removed PLUG_AND_CHARGE from the capabilities response array on GET and POST /public-api/resources/charge-points/v1.0 and GET and PATCH /public-api/resources/charge-points/v1.0/{chargePoint}.
  2. ✨ New features
    1. Added GET /public-api/resources/sessions/v1.0/{session}/edits to retrieve a session's edit history, newest first, with cursor pagination. Entries include the edit type and, when available, the administrator ID, reason, previous and new tariff details, original amount, and timestamp.
    2. Added filter[editTypes], filter[editCreatedByAdminIds], filter[editCreatedAfter], and filter[editCreatedBefore] to GET /public-api/resources/sessions/v1.0 to find sessions by their edit history.
    3. Added the experimental endpoint POST /public-api/actions/reimbursement-record/v1.0/{reimbursementRecord}/correct-amount, accepting required amountWithTax and reason fields. It fully reverses the original record and returns a corrective record in the current reimbursement period; the corrected amount must be positive and differ from the current amount after currency rounding.
    4. Added supersedesReimbursementRecordId to reimbursement record responses to identify the record replaced by a correction. It is available on GET /public-api/resources/reimbursement-records/v1.0, GET /public-api/resources/reimbursement-records/v1.0/{reimbursementRecord}, POST /public-api/actions/reimbursement-record/v1.0/{reimbursementRecord}/issue-credit, POST /public-api/actions/reimbursement-record/v1.0/{reimbursementRecord}/set-custom-fields, and reimbursement records embedded in GET /public-api/resources/sessions/v1.0/{session}.
    5. Added POST /public-api/actions/reimbursement-report/v1.0/{reimbursementReport}/set-paid-status, accepting required paidStatus with not_paid or paid. Added paidStatus to responses from GET /public-api/resources/reimbursement-reports/v1.0, GET /public-api/resources/reimbursement-reports/v1.0/{reimbursementReport}, and POST /public-api/actions/reimbursement-report/v1.0/{reimbursementReport}/set-custom-fields, plus filter[paidStatus] on the listing endpoint.
    6. Added optional purchaseOrderNumber to requests on POST /public-api/resources/partners/v2.0 and PATCH /public-api/resources/partners/v2.0/{partner}. The field is also returned by those endpoints, GET /public-api/resources/partners/v2.0, GET /public-api/resources/partners/v2.0/{partner}, and POST /public-api/actions/partner/v1.0/{partner}/disable, POST /public-api/actions/partner/v1.0/{partner}/enable, POST /public-api/actions/partner/v1.0/{partner}/start-offboarding, and POST /public-api/actions/partner/v1.0/{partner}/set-custom-fields.
    7. Added optional purchaseOrderNumber to the request body on POST /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/issue-partner-invoice to override the purchase order number for that invoice without changing the partner or settlement report. Omitting it uses the report's value, falling back to the partner's; sending null or an empty string suppresses it, and self-billing invoices never carry one.
    8. Added purchaseOrderNumber to responses from GET /public-api/resources/partner-settlement-reports/v1.1, GET /public-api/resources/partner-settlement-reports/v1.1/{partnerSettlementReport}, GET /public-api/resources/partner-invoices/v1.0, GET /public-api/resources/partner-invoices/v1.0/{partnerInvoice}, and POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/issue-credit-note, POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/register-payment, POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/set-custom-fields, and POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/update-external-id.
    9. Added optional publicSharing.fiscalMode to PATCH /public-api/resources/charge-points/v2.0/{chargePoint} for personal charge points, with HCC_V for normal tax treatment and HCC_E for a 0% energy fee tax rate and a home charging compensation marker in OCPI charging detail records. The field is returned when public sharing or roaming publication is enabled by GET and POST /public-api/resources/charge-points/v2.0, GET and PATCH /public-api/resources/charge-points/v2.0/{chargePoint}, and POST /public-api/actions/charge-point/v1.0/{chargePoint}/set-custom-fields; setting it when both access options are disabled returns 409 Conflict.
    10. Added the boolean isMasterPass response field on GET and POST /public-api/resources/id-tags/v2.0, GET and PATCH /public-api/resources/id-tags/v2.0/{idTag}, and POST /public-api/actions/id-tag/v1.0/{idTag}/set-custom-fields. Added filter[isMasterPass] with true or false on the listing endpoint.
    11. Added optional evseIds for Payter terminals on POST /public-api/resources/payment-terminals/v1.1 and PATCH /public-api/resources/payment-terminals/v1.1/{paymentTerminal}; the IDs must belong to the linked charge point. The field is also returned by those endpoints, GET /public-api/resources/payment-terminals/v1.1, GET /public-api/resources/payment-terminals/v1.1/{paymentTerminal}, and POST /public-api/actions/payment-terminal/v1.0/{paymentTerminal}/set-custom-fields.
    12. Added optional skipPreAuthorization and skipUnpaidSessionCheck to requests on POST /public-api/resources/users/v1.1 and PATCH /public-api/resources/users/v1.1/{user} for per-user control of these checks.
  3. 🔧 Improvements
    1. Made churnReason optional on POST /public-api/actions/churn-record/v1.0/record-exit and POST /public-api/actions/partner/v1.0/{partner}/start-offboarding. Partner disable requests on POST /public-api/actions/partner/v1.0/{partner}/disable also no longer require a churn reason when omitted; the existing nested reason fields remain supported.
    2. Made transactionTimeout optional when creating a Payter terminal in plug-in-first mode on POST /public-api/resources/payment-terminals/v1.1. Omitting it, or supplying zero or a negative value, uses a 60-second timeout.
    3. Expanded failureReason responses on GET /public-api/resources/ocpi-commands/v1.0 and GET /public-api/resources/ocpi-commands/v1.0/{ocpiCommand}, and filter[failureReason] on the listing endpoint, with charging_profile_not_set, charging_profile_not_found_on_charge_point, charging_profile_no_confirmation, charging_profile_rejected_by_charge_point, charging_profile_dlm_outcome_uncorrelated, charging_profile_session_ended, charging_profile_charge_point_offline, charging_profile_schedule_unreadable, and charging_profile_callback_not_delivered.
    4. Expanded card network support with dinacard in paymentMethod.cardNetwork and paymentMethod.type requests and cardDetails.cardNetwork and cardDetails.type responses on POST /public-api/resources/transactions/v1.0 and PATCH /public-api/resources/transactions/v1.0/{transaction}. The new value can also appear in responses from GET /public-api/resources/transactions/v1.0, GET /public-api/resources/transactions/v1.0/{transaction}, and POST /public-api/actions/transaction/v1.0/{transaction}/set-custom-fields, and is accepted by the listing endpoint's filter[cardNetwork] and filter[paymentMethod].
    5. Expanded user payment method responses with dinacard for cardNetwork and issuer on GET and POST /public-api/resources/users/v1.0/{user}/payment-methods and GET and PATCH /public-api/resources/users/v1.0/{user}/payment-methods/{paymentMethodId}. Added dinacard to filter[selectedPaymentMethod] on GET /public-api/resources/sessions/v1.0.
    6. Expanded Valina terminal screensaverPaymentMethods with dinacard in requests and responses on POST /public-api/resources/payment-terminals/v1.1 and PATCH /public-api/resources/payment-terminals/v1.1/{paymentTerminal}. The new value can also appear in responses from GET /public-api/resources/payment-terminals/v1.1, GET /public-api/resources/payment-terminals/v1.1/{paymentTerminal}, and POST /public-api/actions/payment-terminal/v1.0/{paymentTerminal}/set-custom-fields.
    7. Expanded access for otherwise authorized API consumers to read dedicated master passes through GET /public-api/resources/id-tags/v2.0/{idTag} and GET /public-api/resources/rfid-tags/v1.0/{rfidTag}, and to manage their notes through GET and POST /public-api/resources/id-tags/v2.0/{idTag}/notes and GET, PATCH, and DELETE /public-api/resources/id-tags/v2.0/{idTag}/notes/{note}.
    8. Changed currency responses on GET /public-api/resources/partner-expenses/v1.0 to fall back to the expense's currency when the associated session has no currency.