Monta.comGuidesAPI ReferenceChangelog

Changelog

2023-09-19

:rocket: Feature

  • When creating a Subscription of type tax-refund you can modify payoutPerKwh and priceIncludesVAT field.

:bug: Fix

  • Update Plans and Subscription models
  • Fixed fromDate/toDate filter for Wallet Transactions
  • Add endDayOfWeek to Tariff Recurring Period

2023-09-14

🚧

Deprecation Note

  • We have deprecated operatorId field on Team models. Use the new field operator instead. The old field will be removed by 01.12.23.
  • We have deprecated maxKW field on various model. Use the new field maxKw instead. The old field will be removed by 01.12.23.

:rocket: Feature

  • Introduced endpoints for listing and retrieving Sponsored Charge Points
  • Added endpoints for listing and retrieving Plans
  • Implemented endpoints for creating, updating, canceling, and fetching Subscriptions
  • Added support for specifying multiple days for Tariffs Recurring Periods
  • Charge Auth Tokens Added support for the following fields when creating or updating:
    • userId
    • teamId
    • montaNetwork
    • roamingNetwork
    • activelUntil
  • Price Groups
    • New endpoint to set a default price group
    • New endpoint to apply a price group to Team Members, Charge Points, and Sites
    • Added the ability to specify a from/to dates for a fee
    • Price groups now support multiple tariffs
  • Webhooks
    • Expanded webhook support for Charge Points and Sites
    • Charges events will also be triggered when the charge was paid by the operator

:bug: Bugs

  • Fixed display name missing for team members on the charges endpoint

:memo: Docs

  • Updated and added API documentation for Price Groups, Subscriptions, Sponsored Charge Points, and more

2023-08-31

:rocket: Feature

  • Create a Team no longer requires userId to be provided
  • Create/Update Tariffs no longer requires countryAreaId to be provided
  • Added the user and team member (if from CP's team) associated with a Charge
  • Charge Auth Tokens usage can now be limited to the operator's network.
  • Added support for partnerExternalId and partnerCustomPayload for Wallet Transactions
  • Added patch endpoint for Wallet Transactions
  • Added new filters to GET /wallet-transactions, you can now filter by:
    • referenceType
    • referenceId
    • state
    • group
    • partnerExternalId
  • Added new field activeAt to Charge Point model, indicating when the Charge Point was (last) activated

:bug: Fix

  • Price Groups: Added type roaming
  • Tariffs:
    • Fixed an issue where GET resource by ID would return 401
    • Fixed an issue with the validation of non-overlapping recurring periods with the same weekday
    • Fixed an issue with PATCH /tariffs/:idThat would lead to BAD_REQUEST

:memo: Docs

  • Added/Updates API documentation for Wallet Transactions, Price Groups, Subscriptions, and others.

2023-08-16

:rocket: Feature

  • Beta / For selected partners: We are launching our webhooks system, starting with charge transactions. Check out the guide and the api docs. 🚀
  • Added support to starting a Charge with kWhLimit or socLimit
  • Added new endpoints to list and fetch Country Area
  • Added displayName and priceGroupId for the Team Member model.
  • Expanded patch Team Member to support more fields
  • Added new filter by the state for Charge Points
  • Operators can now access the Charges paid by their teams via GET /charges/:id endpoint. However, they are not yet included in the GET /charges endpoint. This will come in a later release.
  • Added new field type for Charges

:bug: Fix

  • Fixed access checks when fetching Wallet Transactions by id were causing 403
  • Fixed access checks when fetching Price Groups by id were causing 403

:memo: Docs

  • Added/Updates API documentation for Team Members, Price Groups, and others.
  • Split our API docs in guides and api reference

2023-08-03

:rocket: Feature

  • Added new endpoints to list, create, update, and delete Price Groups
  • Added endpoint to create (invite) and delete a Team Member
  • Added endpoint to delete a Team
  • Allow listing deleted Sites and Charge Points
  • Partners can now use Monta's receipt system when providing genericPaymentSession when starting a Charge
  • New Endpoints to fetch, list, create and update the following entities in the tariffs context:
    • Tariffs
    • Period Groups
    • Recurring Periods
  • Added endpoint to generate the Prices for a given tariff

:warning: Breaking change

  • Previously, the userId field for Team Member was a non-nullable field, from this version onwards this field is nullable.

:memo: Docs

  • Added/Updates API documentation for Price Groups, Team Members, and Tariffs
  • Added detailed documentation for Price Groups.

2023-07-20

:rocket: Feature

  • Beta Price Groups endpoints are officially retired. The new price groups endpoints will be available soon
  • Wallet Transactions can now be fetched by teamId
  • Added the referenceId field for Wallet Transactions
  • Added support for filtering resources with null partnerExternalId
  • Added new /api/v1/consumers/me, api/v1/auth/me is now deprecated, please migrate to the new one
  • Exposing operator data for:
    - Teams
    - Charges
    - Charge Points,
    - Charge Auth Tokens,
    - Sites

:bug: Fix

  • Fixed typo for team-has-fund payments method

:memo: Docs

  • Removed beta Price Groups docs
  • Added documentation for new Consumer endpoint
  • Updated documentation for existing endpoints, query parameters, and fields

2023-07-06

:rocket: Feature

  • Added a Patch Team Member endpoint. Setting charge point ids for a Team Member is now supported
  • Ability to sort Charge Points by location via the sortByLocation query parameter
  • Updated Charge Point Model to expose the models supported features
  • Updated Charge Point model to expose the evse_id

:memo: Docs

  • Updated documentation for new endpoints, query parameters, and fields

2023-06-20

:rocket: Feature

  • Ability to filter Charges by partnerExternalId
  • Ability to provide partnerExternalId and partnerCustomPayload when starting a Charge
  • Expose new fields partnerExternalId and partnerCustomPayload for Charges
  • New patch endpoint to update partnerExternalId and partnerCustomPayload for Charges
  • New Endpoints to create and update the following entities:
    • Teams
    • Sites
    • Charge Points
  • New Endpoints to fetch one or multiple:
    • Charge Point Connectors
    • Charge Point Brands
    • Charge Point Models
    • Countries

:memo: Docs

  • Fixed missing charge-points/maps query filters
  • Added documentation with new endpoints:
    • Teams
    • Sites
    • Charge Points
    • Charge Point Connectors
    • Charge Point Brands
    • Charge Point Models
    • Countries

2023-05-02

:rocket: Feature

  • Added new Charge Point fields: brandName, modelName, firmwareVersion and integrationType
  • Added new field partnerCustomPayload on the following entities:
    • Charge Point,
    • Charge Auth Token,
    • Charge Point,
    • Team
  • New patch endpoint to update partnerExternalId and partnerCustomPayload for the following entities:
    • Charge Point,
    • Charge Auth Token,
    • Charge Point,
    • Team
  • Added endpoints to fetch and list Team members.
  • Ability to create Charge Auth Token assigned to a User.

:bug: Fix

  • Removed legacy \chargeAuthTokens endpoint.

:memo: Docs

  • Updated Charge Point states.

2023-03-20

🚀 Feature

  • Added new fields to Charge model: soc (State of Charge), socLimit and priceLimit
  • Added new field to Charge Point model: cablePluggedIn - indicates if a cable is plugged in currently
  • Added partnerExternalId to Charge Point, Site, Charge Auth Token and Team models
  • Added query parameter partnerExternalId to filter by it on Charge Point, Site, Charge Auth Token and Team index endpoints

🚧

Beta

  • Added endpoints to fetch Price Groups - this group of endpoints is subject to change in a near future release

2023-03-01

🐛 Fix

  • ⚠️ Breaking change: Wallet transaction's field updated_at is optional

2023-02-01

❗️

New Base URL

The new base url for the Partner API is partner-api.monta.com

The previous one (partner-api.monta.app) is deprecated and will continue to work until 01.04.2023.

🚀 Feature

  • Added support to create and delete Charge Auth Tokens
  • Added support to fetch one or multiple Teams
  • Added field operatorNote to Charge Point responses

🐛 Fix

  • Renamed /chargeAuthTokens endpoint to /charge-auth-tokens
    request parameters and response payloads will remain the same,
    we will support both endpoints until at least 13-02-2023
    then we will effectively remove /chargeAuthTokens

📝 Docs

  • Updated API documentation includes:
    • New endpoints to create and delete Charge Auth Tokens
    • New endpoints to fetch Teams
    • New Charge Point field
    • Instructions to migrate from the deprecated /chargeAuthTokens endpoint

2023-01-04

🚀 Feature

  • Charges can now be filtered by the combined filter chargeAuthType and chargeAuthId
  • New endpoints added to fetch one or multiple Charge Auth Token
  • Added a new field lastMeterReadingKwh to Charge Point

📝 Docs

  • Updated API documentation includes:
    • New endpoints to fetch Charge Auth Token
    • New Charge filters
    • New Charge Point field

🐛 Fix

  • Endpoint /api/v1/me would not work with certain scopes
  • Fetching a Wallet Transaction by id was not working

2022-12-14

🚀 Feature

  • Filter Charges, Sites and Charge Points by teamId
  • Wallet Transactions now have the createdAt and updatedAt fields
  • New fields kwhPerHourand stopReason added to Charge, allowing you to retrieve information:
    • The total Kwh consumed for that charge, split by hour
    • The reason why the charge was stopped

📝 Docs

  • Endpoints now also have the most important errors documented
  • General cleanup of examples and descriptions to help auto-generate valid requests

2022-11-07

🚀 Feature

  • New field chargeAuth added to Charge, allowing you to retrieve information about the authentication method used to authenticate the charge
  • Charge, ChargePoint and Site now have the createdAt and updatedAt fields

🐛 Fix

  • siteId query param of /api/v1/charge-points would allow for string values. This will now return a 400 - Bad Request if the value is not a number.

📝 Docs

  • Update documentation for auth/me and pagination parameters.

2022-09-16

🚀 Feature

  • Charge transactions can be filtered by fromDate and state
  • Charge transactions are sorted by createdAt descending

⚠️ Breaking change

  • Previously, the pagination page parameter would handle 0 and 1 equally but return an incorrect pagination meta data. Our Pagination page parameter was updated to start from 0. A page of 1 will now return the second page.

2022-09-14

🚀 Feature

  • New endpoint added for reserving a Charge Point.

⚠️ Breaking change

  • fromType and from on wallet transaction model is nullable now (e.g. for deposit transactions)
  • toType and to on wallet transaction model is nullable now (e.g. for withdrawal transactions)

2022-07-06

🚀 Feature

  • New map endpoint for Charge Points, allowing you to retrieve Clusters, Sites and Charge Points to be rendered on a map.
  • Added field deeplinks to Charge Points. They allow you to start charging via Monta app or web app [no registration needed].
  • Added auth scopes to credentials. Scope determines if you are eligible to access certain endpoints.

📝 Docs

  • Update contact url in docs.

2022-06-13

🚀 Feature

  • Rate-limit will be enforced from now on

⚠️ Breaking change

  • staticMapUrl removed from Location model

2022-06-03

🧹 Chore

  • Better error handling

2022-06-01

⚠️ Breaking change

  • Rename Connector.slug to Connector.identifier
  • Rename query param from/to to fromDate/toDate in wallet transactions

🐛 Fix

  • Throw 401 instead of 404 when client credentials are wrong

📝 Docs

  • Improve description for pagination parameters
  • Add schema for TeamOrOperator
  • Add enum values to all enum types
  • Add security schemes

2022-05-31

🚀 Feature

  • Initial Release with Sites, Charge Points, Charges, Wallet Transactions and Start/Stop charging