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

3.269.0 release notes

about 3 hours ago by ReadMe API
  1. ✨ New features
    1. Added experimental custom field actions at POST /public-api/actions/invoice/v1.0/{invoice}/set-custom-fields, POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/set-custom-fields, and POST /public-api/actions/receipt/v1.0/{receipt}/set-custom-fields. Send a required customFields object to update values; omitted identifiers remain unchanged and null clears a value, with 412 returned when custom fields are disabled for the tenant or resource.
    2. Added optional customFields to invoice responses from GET /public-api/resources/invoices/v1.0, GET /public-api/resources/invoices/v1.0/{invoice}, and POST /public-api/actions/invoice/v1.0/{invoice}/update-external-id, and receipt responses from GET /public-api/resources/receipts/v2.0 and GET /public-api/resources/receipts/v2.0/{receipt}. Returned values respect the token owner's custom field visibility permissions.
    3. Added optional customFields 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, POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/register-payment, and POST /public-api/actions/partner-invoice/v1.0/{partnerInvoice}/update-external-id. Returned values respect the token owner's custom field visibility permissions.
    4. Added custom field filtering to GET /public-api/resources/invoices/v1.0, GET /public-api/resources/partner-invoices/v1.0, and GET /public-api/resources/receipts/v2.0.
    5. Added POST /public-api/actions/session/v1.0/{session}/restore-billing to return a session with billingStatus of dropped to suspended, with an optional reason of up to 1,000 characters. The action does not bill the session or rerun validation rules; it returns 202 on success, 409 for an incompatible billing status, or 423 when the session is locked.
    6. Added an optional uuid response field to locations returned by GET and POST /public-api/resources/locations/v2.0 and GET and PATCH /public-api/resources/locations/v2.0/{location}.
    7. Added an optional uuid response field to EVSEs returned by GET and POST /public-api/resources/evses/v2.1, GET and PATCH /public-api/resources/evses/v2.1/{evse}, GET and POST /public-api/resources/charge-points/v2.0/{chargePoint}/evses, and GET and PATCH /public-api/resources/charge-points/v2.0/{chargePoint}/evses/{evse}.
    8. Added an optional uuid response field to charge detail records returned by GET /public-api/resources/cdrs/v2.0 and GET /public-api/resources/cdrs/v2.0/{cdr}.
    9. Added an optional uuid response field to tariffs returned by GET and POST /public-api/resources/tariffs/v1.0, GET, PATCH, and PUT /public-api/resources/tariffs/v1.0/{tariff}, GET /public-api/resources/tariff-snapshots/v1.0/{tariffSnapshot}, and POST /public-api/actions/tariff/v1.0/{tariff}/set-custom-fields.
    10. Added filter[uuid] to GET /public-api/resources/locations/v2.0, GET /public-api/resources/evses/v2.1, GET /public-api/resources/cdrs/v2.0, and GET /public-api/resources/tariffs/v1.0 to find records by UUID.
    11. Added optional taxCountry to settlement report responses from GET /public-api/resources/partner-settlement-reports/v1.0, GET /public-api/resources/partner-settlement-reports/v1.0/{partnerSettlementReport}, GET /public-api/resources/partner-settlement-reports/v1.1, GET /public-api/resources/partner-settlement-reports/v1.1/{partnerSettlementReport}, and POST /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/issue-partner-invoice, POST /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/set-custom-fields, and POST /public-api/actions/partner-settlement-report/v1.0/{partnerSettlementReport}/update-external-id. The field identifies the applicable tax country using an ISO 3166-1 alpha-2 code and is omitted when unavailable.
    12. Added filter[taxCountry] to GET /public-api/resources/partner-settlement-reports/v1.1, accepting a valid country code.
    13. Added optional subtotals and revenueSharingSummary to GET /public-api/resources/partner-settlement-reports/v1.1 and GET /public-api/resources/partner-settlement-reports/v1.1/{partnerSettlementReport}. These provide breakdowns by direction and origin and revenue sharing summaries for sessions and private EVSE access fees when available; reports generated before these figures were stored omit them.
  2. 🔧 Improvements
    1. Expanded type on POST /public-api/actions/session/v1.0/{session}/resume-billing with drop_session to exclude an eligible suspended session from billing while preserving its amounts and cancelling any unsent charge detail record. This option requires a non-empty reason of up to 1,000 characters and returns 409 if the session already has an order or its charge detail record has been sent or is being sent.
    2. Expanded paymentMethod.bankTransferType with other on POST /public-api/resources/transactions/v1.0 and PATCH /public-api/resources/transactions/v1.0/{transaction}. Payment method responses may also return bankTransferType: other from 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}.
    3. Changed communication log responses from GET /public-api/logs/communication/v1.0 and GET /public-api/logs/communication/v1.0/{id} to return communicationError instead of responseBody when a communication failure message is present, even if the response status alone does not indicate an error.