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

3.257.0 release notes

about 1 hour ago by ReadMe API
  1. ⚠️ Breaking changes
    1. Changed GET /public-api/resources/transactions/v1.0 to reject filled custom field filters that are unknown, unavailable, inaccessible, or non-filterable with 400, instead of silently ignoring them. Remove unsupported filter[customFields.<identifier>] criteria before retrying.
    2. Changed settlement record writes to return 409 with errorCode set to payment_tracking_managed_via_partner_invoice when the settlement report has at least one partner invoice: POST /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}/records and PUT or DELETE /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}/records/{PartnerSettlementRecord}. Register payments through POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/register-payment instead.
    3. Changed custom field updates to return 412 Precondition Failed without modifying values when custom fields are disabled for the tenant or target resource. This applies to POST /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/set-custom-fields, POST /public-api/actions/partner/v1.0/{partner}/set-custom-fields, POST /public-api/actions/payment-terminal/v1.0/{paymentTerminal}/set-custom-fields, POST /public-api/actions/reimbursement-record/v1.0/{reimbursementRecord}/set-custom-fields, POST /public-api/actions/reimbursement-report/v1.0/{reimbursementReport}/set-custom-fields, and POST /public-api/actions/session/v1.0/{session}/set-custom-fields.
  2. ✨ New features
    1. Added custom field update actions for ID tags, installer jobs, tariffs, tariff groups, user groups, users, and vehicles: POST /public-api/actions/id-tag/v1.0/{idTag}/set-custom-fields, POST /public-api/actions/installer-job/v1.0/{installerJob}/set-custom-fields, POST /public-api/actions/tariff/v1.0/{tariff}/set-custom-fields, POST /public-api/actions/tariff-group/v1.0/{tariffGroup}/set-custom-fields, POST /public-api/actions/user-group/v1.0/USERGROUP/set-custom-fields, POST /public-api/actions/users/v1.0/{user}/set-custom-fields, and POST /public-api/actions/vehicle/v1.0/{vehicle}/set-custom-fields. Send a customFields object keyed by field identifier; omitted identifiers remain unchanged, explicit null clears a value, and disabled custom fields return 412.
    2. Added the optional customFields response property to ID tag, installer job, tariff, tariff group, user group, user, and vehicle reads: GET /public-api/resources/id-tags/v2.0 and GET /public-api/resources/id-tags/v2.0/{idTag}; GET /public-api/resources/installer-jobs/v1.0 and GET /public-api/resources/installer-jobs/v1.0/{installerJob}; GET /public-api/resources/tariffs/v1.0 and GET /public-api/resources/tariffs/v1.0/{tariff}; GET /public-api/resources/tariff-groups/v1.0 and GET /public-api/resources/tariff-groups/v1.0/{tariffGroup}; GET /public-api/resources/user-groups/v1.0 and GET /public-api/resources/user-groups/v1.0/USERGROUP; GET /public-api/resources/users/v1.1 and GET /public-api/resources/users/v1.1/{user}; and GET /public-api/resources/vehicles/v1.0 and GET /public-api/resources/vehicles/v1.0/{vehicle}. Values are keyed by field identifier, and the property is omitted when no fields apply.
    3. Added custom field filtering to GET /public-api/resources/id-tags/v2.0, GET /public-api/resources/installer-jobs/v1.0, GET /public-api/resources/tariffs/v1.0, GET /public-api/resources/tariff-groups/v1.0, GET /public-api/resources/user-groups/v1.0, GET /public-api/resources/users/v1.1, and GET /public-api/resources/vehicles/v1.0, using filter[customFields.<identifier>] and inclusive from/to bounds for number, date, and date-time fields. Unfilled criteria are ignored; filled unsupported criteria return 400, and malformed values for supported fields return 422.
    4. Added the experimental POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/register-payment endpoint, accepting required paidAmount and date fields plus an optional note, and returning the updated invoice with 202 Accepted. Negative amounts can reverse payments, but credited invoices, credit notes, and entries that would reduce the total paid below zero return 409.
    5. Added amountPaid to partner invoice responses from GET /public-api/resources/partner-invoices/v1.0, GET /public-api/resources/partner-invoices/v1.0/{partnerInvoice}, POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/issue-credit-note, and POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/update-external-id. The field reports the total registered payments in the invoice currency and is omitted on credit notes.
    6. Added the optional partnerInvoiceId response field to GET and POST /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}/records and GET and PUT /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}/records/{PartnerSettlementRecord}, identifying the invoice associated with a payment record.
    7. Added the optional Payter operationMode request field to POST /public-api/resources/payment-terminals/v1.1 and PATCH /public-api/resources/payment-terminals/v1.1/{paymentTerminal}, with values always_on and plug_in_first, and exposed the active mode in their responses, 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. Creation defaults to plug_in_first, updates preserve the mode when omitted, always_on requires a single charge point rather than a charging zone and preauthorizeAmount in the request, and explicitly selecting plug_in_first requires transactionTimeout in the request.
  3. 🔧 Improvements
    1. Expanded termType with analytics in responses from GET /public-api/resources/consent-history/v1.0, GET and POST /public-api/resources/consents/v1.0, GET /public-api/resources/terms-and-policies/v2.0, and GET /public-api/resources/terms-and-policies/v2.0/{termVersion}. The consent and consent history listing endpoints also accept analytics in filter[termType].
    2. Expanded the partner invite language values with Slovak (sk) and Vietnamese (vi-VN) for POST /public-api/resources/partner-invites/v2.0 and responses from GET /public-api/resources/partner-invites/v2.0 and GET and PATCH /public-api/resources/partner-invites/v2.0/{partnerInvite}.
    3. Expanded notifications.billing.settlementReportLanguage with Slovak (sk) and Vietnamese (vi-VN) for POST /public-api/resources/partners/v2.0, PATCH /public-api/resources/partners/v2.0/{partner}, and partner responses from 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}/set-custom-fields.
    4. Changed successful user group creation on POST /public-api/resources/user-groups/v1.0 to return 201 Created rather than 200 OK, matching the documented response status.