Schemas
AddVehicleUser
userIdId of the user to share the vehicle with. Must belong to the vehicle's team or already be a shared user.
AdditionalPricing
typeType of the additional pricing. absolute means the value is a price.
The value of this additional pricing. Both absolute and percentage values here are represented as a money object.
titleA title for this additional pricing.
Address
address1First line of address
zipZip-code
cityCity (readable)
address2Second line of address
address3Third line of address
provinceProvince
countryCountry (readable)
countryAreaIdCountry area id
AfirChargePointDto
idId of this charge point.
evseIdThe EVSE id for this charge point.
Location information for this charge point.
Indicates public opening hours for this charge point.
List of supported connector types at this charge point (e.g. type-2, ccs, ...).
isOperationalIndicates if this charge point is operational.
isAvailableIndicates if this charge point is available for charging right now.
roamingOperatorIdThe Roaming Operator ID for this charge point.
roamingOperatorNameThe Roaming Operator Name for this charge point.
roamingOperatorContactEmailThe Roaming Operator contact email for this charge point.
disabledParkingSpotsThe amount of disabled parking spotsnull indicates this information is not provided.
isRenewableElectricityIndicates if this Charge Point is running 100% renewable energynull indicates this information is not provided.
vehicleCompatibilityList of vehicle types supported at this charge point.null indicates this information is not provided.
typeType of charge point (AC / DC).
maxKwMax KW available at this charge point.
stateState of the charge point.
publicPriceLabelPublic Price label of this charge point.
AfirChargePointDto.OpeningHours
openTwentyFourSevenIndicates if this charge point is available 24/7.
If openTwentyFourSeven is false, this field contains the opening hours for this charge point.
AfirChargePointDto.OpeningHours.Schedule
AfirChargePointDto.OpeningHours.Schedule.OpeningHourEntry
fromtoAlert
idId of the alert.
typeThe aggregated issue-type token this alert groups.
What an alert or issue is about.
statusCurrent status of the alert.
operatorIdId of the operator this alert belongs to.
titleHuman label for the alert, if set.
triggerReasonHuman-readable explanation for why this alert was raised, if set.
issueCountNumber of issues currently attached to this alert.
eventCountTotal events across every attached issue.
chargePointCountNumber of distinct charge points across every attached issue.
firstEventAtEarliest event across every attached issue, if any.
lastEventAtMost recent event across every attached issue, if any.
isManualWhether this alert was created by hand rather than by the alerting engine.
snoozedUntilWhen a snoozed alert automatically re-opens, if set.
Day-bucketed event counts across every attached issue.
AlertComment
idId of the comment.
authorNameDisplay name of the author.
bodyComment body.
createdAtWhen the comment was posted.
authorIdAuthor's user id, if known.
AlertDetail
idId of the alert.
operatorIdtypeWhat an alert or issue is about.
statusissueCounteventCountchargePointCountisManualIssues attached to this alert.
Notifications (Monta workflow runs) this alert has produced.
Event-source breakdown across every attached issue.
titletriggerReasonfirstEventAtlastEventAtsnoozedUntilAlertEvent
idId of the event.
sourceSystem that produced the event.
typeType of the event.
occurredAtWhen the source system observed this event.
chargePointIdCharge point this event concerns, if any.
connectorIdConnector index this event concerns, if any.
siteIdSite this event concerns, if any.
teamIdTeam this event concerns, if any.
AlertEventFrequencyBucket
startStart of the day bucket (UTC).
countNumber of events in this bucket.
AlertNotification
idId of the workflow trigger.
workflowNameName of the workflow that ran.
triggeredAtWhen the workflow triggered.
outcomeOutcome of the workflow run.
channelsChannels the workflow delivered on; populated only for sent.
AlertScope
typeThe kind of entity this alert or issue is scoped to.
idId of the scoped entity.
AlertScopeInput
typeThe kind of entity.
idId of the entity. For operator it must be the operator the alert or issue is created under.
Amenity
attributeAmenity attribute name
Amenity value
AmenityAttribute
AmenityRequest
attributeAmenity attribute name
valueAmenity value
AmenityUpdate
attributeAmenity attribute name
Amenity value
AppliedPriceGroupTeam
teamIdteamNametotalChargePointCountappliedChargePointCountappliedCostCountappliedRoamingCountappliedMemberCounttotalMemberCountApplyChargePoints
charge_point_idsIds of the charge points to assign to the payment terminal. Pass an empty list to clear the current assignment. All ids must belong to the payment terminal's team.
ApplyPriceGroup
selectedChargePointIdsList of charge point ids
selectedSiteIdsList of site ids
selectedTeamMemberIdsList of team member ids
resetCostFlag to indicate if costs should be reset
teamIdTeam to apply the price group to. Only relevant for operator-owned price groups: if provided, the price group is applied to that team only; if omitted, it is applied across every team under the operator.
ApplyRevenueShareAgreement
policyCodeCode of the policy this agreement applies.
sourceTeamIdId of the team the revenue is shared from.
recipientTeamIdId of the team the revenue is shared to.
attributionSourceTeamIdOptional id of the team charges are attributed to.
startedAtOptional start of the agreement.
ApplyTeamMemberFeeDto
team_member_idsIds of the team members the fee should be applied to.
ApproveSubscription
nextPurchaseAtDate when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ).
sendNotificationsWhether to send the subscription-approved notifications (e.g. the confirmation or add-a-payment-card email to the team's admins). Defaults to true. Set to false to suppress them, e.g. when migrating existing customers from another CPMS.
firstPurchaseAtDeprecated: use nextPurchaseAt instead.
Date when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ).
AttachEvseRequest
chargingStationIdentityconnectorIdphaseSetupzeroAllowedloadManagementDisabledminCurrentAmaxCurrentAmaxPowerWminPowerWAuditEvent
idA unique identifier used for single retrieval and paging
timestampThe time (UTC) the action was taken
operatorIdThe operator under which the action was taken
User details (at the time of the event) of the user that performed the action
actionThe action (verb) that was performed, like CREATE, UPDATE, DELETE, TRIGGER
entityIdThe ID of the entity (subject) that the event applies to
entityTypeThe type of the entity (subject) that the event applies to, like Operator, Team, OperatorUser, TeamMember
Additional data + context for the action taken
teamIdThe team under which the action was taken, if any
operationThe specific command that was issued, for actions that carry one (like TRIGGER). Values are open-ended, like REBOOT, UNLOCK, SYNC, FIRMWARE_UPDATE.
What initiated the action, if known
AuditEventSource
typeThe kind of actor that initiated the action: USER, SYSTEM or ANONYMOUS. This list is open-ended and may gain new values without a version bump.
AuthorizationLink
authorizeLinkLink the user follows to authorize their vehicle account
providerVehicle integration provider that issued the link
authFlowAuthorization flow the client should use to complete linking
tokenToken identifying the authorization session
AutoStart
autoStartCurrent auto-start status. not-available means the charge point is public or its model does not support auto-start.
AvailableEvse
chargingStationIdentityconnectorIdnameoperatorNamemodelImageUrlbrandNamemodelNameAvailableEvseList
BankAccount
nameName of the bank account
createdAtWhen the bank account was created
idId of the bank account
typeWhich set of fields identifies the account. Determines what the other fields must contain.
ibanIBAN of the bank account
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account
institutionNumberInstitution number of the bank account
currencyIdId of the bank account's currency
updatedAtWhen the bank account was last updated
Breakdown
subTotalPriceThe total price for this breakdown entry
subTotalMasterPriceThe total master price for this breakdown entry
subTotalSecondaryPriceThe total secondary price for this breakdown entry
The list of prices and tariffs relevant for this breakdown entry
fromThe initial timestamp for this breakdown entry, currently in hourly format
toThe final timestamp for this breakdown entry, currently in hourly format
coveredKwhHow many kWh of this breakdown entry were paid for by the promotion code's kWh allowance. The allowance covers the earliest kWh of the charge first, so it fills whole entries until it runs out, then one entry partially, then nothing. Null when the charge carries no promotion code, and on the cost breakdown.
BreakdownSummary
totalMasterPriceTotal master price for the given charge
totalSecondaryPriceTotal secondary price for the given charge
totalFeesTotal fees for the given charge
totalAdjustmentsTotal adjustments for a given charge, for instance, based on certain business rules, the final price may be adjusted to prevent it from exceeding 1000 EUR
totalPriceTotal price for the given charge
totalDiscountTotal discount applied for the given charge
BulkCreatePromotionCode
nameName shared by every code in the batch
codesThe codes to create, chosen by you, up to 5000 per request. Each must be lowercase alphanumeric with optional hyphens, at most 64 characters, and unique within the request. A shared prefix is worth keeping: pass it to GET /promotion-codes?codePrefix= to list the batch again.
amountCurrency amount deposited into the driver's wallet when a code is redeemed (max 500). Every code in the batch carries the same amount and is single-use — send one request per amount.
descriptionDescription shared by every code in the batch
startAtWhen the codes become redeemable (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Set a future date to issue the batch inactive — a code stays unredeemable until this passes, so vouchers can be printed and distributed before they carry value, then activated per code with PATCH /promotion-codes/{id} when one is sold.
endAtWhen the codes expire (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
BulkCreateSubscription
planIdsIds of plans the team should be subscribed to. Each plan is processed independently — failures do not abort siblings.
teamIdId of the team that should be subscribed to all selected plans
userIdThe user that should be assigned as the purchaser of the subscriptions. If not provided, the subscriptions will be assigned to the default user for this consumer.
nextPurchaseAtDate when the wallet will be charged for the first time (ISO8601). Has to be a date in the future.
sendNotificationsWhether to send the subscription-created notifications (e.g. confirmation email to the team's admins). Defaults to true. Set to false to suppress them, e.g. when migrating existing customers from another CPMS. Applies to every subscription in the bulk request.
BulkCreateSubscriptionResult
statusOutcome of the create attempt for this plan
planIdPlan id this result corresponds to
Created subscription, present only when status is created
errorFailure reason, present only when status is failed
BulkInviteTeamMember
Members to invite to the team. Each item is processed independently — a failure on one member does not abort siblings. The response lists every input item with its individual outcome.
teamIdId of the team that the members will be invited to. All members in the request are added to this team.
BulkInviteTeamMemberItem
roleRole for this member within the team
userIdId of the user to be invited. When inviting by userId the fields email or phone must not be provided.
emailEmail of the user to be invited. When inviting by email the fields userId or phone must not be provided.
phone^\+[1-9]\d{1,14}$Phone of the user to be invited. When inviting by phone the fields userId or email must not be provided.
priceGroupIdThe price group for this team member, when not provided the default team price group will be applied
costGroupIdThe cost group for this team member
teamMemberProfileIdThe team member profile id to apply to this team member
canConfigureChargePointsIndicates if the team member can configure charge points
canPayWithTeamWalletGives the team member access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canRequestSponsoringAllows the team member to request sponsoring from this team
canManageTeamMembersAllows the team member to view and manage other members settings
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
canDepositToWalletGives the team member permission to deposit to the team wallet
canWithdrawFromWalletGives the team member permission to withdraw from the team wallet
canManageChargeKeysGives the team member permission to manage charge keys for the team
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
noteA note for the team member
chargePointIdsIds of the charge points this team member will have access to
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
notifyUserControls whether an invitation email and/or SMS is sent to the user based on the provided email and phone fields.
immediateAccessGrants the invited member access to the team immediately, without waiting for them to accept the invitation.
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
costCenterIdThe cost center to assign to this team member. Must belong to the same operator, and when it is scoped to a team, to that team.
BulkInviteTeamMemberResult
statusOutcome of the invite attempt for this member
indexZero-based index of the member in the request members array this result corresponds to
Created team member, present only when status is created
errorFailure reason, present only when status is failed
BulkTeamAutoWithdrawal
teamIdsIds of the teams to switch automatic withdrawal on or off for: between 1 and 50 distinct, positive ids. Page through larger lists in several requests.
enabledtrue switches automatic withdrawal on for every listed team, false switches it off.
BulkTeamAutoWithdrawalResult
How many teams ended up with each result. The counts add up to requested.
One entry per requested team, in request order.
BulkTeamOnboarding
teamIdsIds of the teams to apply the onboarding steps to. Duplicates are ignored.
The onboarding steps to enable for every listed team, as {step, config?, displayMode?} entries. Applied identically to each team; the list replaces that team's full enabled set, so an empty list clears onboarding for the team.
BulkTeamOnboardingResult
Per-team outcome, one entry per distinct team id in the request.
Cdr
idUnique CDR identifier.
operatorIdID of the operator that owns this CDR.
chargeIdID of the charge session this CDR was generated from.
chargeEndedAtTimestamp (ISO-8601) when the charge ended.
Raw OCPI CDR payload as received from the roaming partner. Structure follows the OCPI CDR specification; treat as opaque.
CdrExportAccepted
statusExport request status. Always queued for an accepted request.
messageHuman-readable confirmation message.
CdrExportRequest
from\d{4}-\d{2}-\d{2} · requiredStart of the export range (inclusive), in yyyy-MM-dd format.
to\d{4}-\d{2}-\d{2} · requiredEnd of the export range (inclusive), in yyyy-MM-dd format. Must be on or after from, and the range may not exceed 31 days.
emailEmail address that the export will be delivered to. Must belong to a Monta user with the export permission on the target operator.
operatorIdThe ID of the operator whose CDRs will be exported. If not provided, operator ID will be derived from the used api credentials.
formatOutput format for the exported file. Defaults to CSV.
emspIdentifierOptional filter. When set, only CDRs whose EMSP identifier ({CountryCode}*{PartyId}) matches are exported. Does not appear as a column in the exported file.
selfManagedOptional filter. When set, only CDRs with the matching self-managed flag (bilateral agreement) are exported.
directionDirection of the CDRs to export. INBOUND (default) exports CDRs Monta issued as CPO to partner eMSPs (Monta operated the charge point). OUTBOUND exports CDRs Monta received as eMSP from partner CPOs (Monta's drivers charged on partner networks). Defaults to INBOUND when omitted.
Charge
humanReadableIdThe human readable id for this charge
User that performed the charge
typeType of the charge
The public information about the charge point related to this charge
createdAtCreation date
updatedAtUpdate date
stateState of the charge. This is a normalized enum value for consistent processing across different charge point types
rawStateThe original charge state value from the charge point before any mapping. While state provides normalized values for consistency, rawState preserves the exact state reported by the charge point. Use this when you need fine-grained state information or want to distinguish between similar states. This field may contain values not present in the 'state' enum as new charge point states are introduced.
List of consumed kWh split by hour (1 hour buckets)
List of consumed kWh split by maximum available resolution (ie. 15min buckets)
emaidProviderIdThe first 5 characters of an EMAID, which is the provider id.
The protocol data for this charge, e.g. OICP or OCPI related data.
idId of the charge
Team that performed the charge, if part of the charge points' team
chargePointIdId of the charge point related to this charge
sponsoredChargePointIdId of the sponsored charge point related to this charge
priceGroupIdId of the price group related to this charge. Note: The underlying price/costGroup models can change and you have to use other fields to get the historic data (costBreakdown, priceBreakdown, price)
costPriceGroupIdId of the cost price group related to this charge
memberCostPriceGroupIdId of the member cost price group related to this charge
siteIdId of the site in which the charge point that performed this charge is
promotionCodeIdId of the promotion code related to this charge
What the charge's promotion code covered, resolved when the charge completed. Null when no promotion code covered any part of this charge.
cablePluggedInAtDate when cable was plugged in
startedAtDate when charge started
stoppedAtDate when charge stopped
fullyChargedAtWhen the EV stopped drawing energy (last transition to suspended-by-EV). Cleared if charging resumes; kept on completed charges.
releasedAtDate indicating when the cable was released.
Note: This value is meaningful only if the charge point properly supports Release Detection.
failedAtDate when charge failed
timeoutAtDate when charge timed out
completedAtDate when charge was considered completed
startSourceIndicates the starting source for this charge, e.g app-ios, app-android
Note: This is an ever-growing list, new values might be added. Please make sure to implement appropriate fallbacks
consumedKwhConsumed Kwh
kwhLimitConfigured Kwh limit for this charge
startMeterKwhKwh of the meter before charging started
endMeterKwhKwh of the meter after charging stopped
pricePrice for this charge
priceLimitConfigured price limit for this charge
costCost incurred for this charge
averagePricePerKwhAverage price per Kwh
averageCo2PerKwhAverage CO2 consumption per Kwh. Null when it cannot be determined
averageRenewablePerKwhAverage percentage of renewable energy per Kwh
failureReasonFailure reason for this charge
stopReasonReason why this charge stopped
paymentMethodPayment method for this charge
noteA note taken for this charge
Currency used for payment.
Team who paid for this charge
Team who sponsored this charge
Operator this of this charge
The object used to authenticate a charge
Information about the state of charge if available
socStartState of charge at the start of the session, if available
socLimitConfigured SoC limit for this charge
Generic payment session for this charge. If provided, the charge was paid with this payment session.
partnerExternalIdExternal Id of this entity, managed by you. We recommend to fill this always with a unique identifier from your side,since it allows you to find a started charge later, even if this requests'response was not captured by you or something went wrong.
smartChargeIdThe smart charge id for this charge, if applicable. Note: If not null, this indicates the charge was a smart charge.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
chargePointKwThe charge point KW recorded during the charge.
The signed data of the charge.
vehicleIdThe vehicle id for this charge, vehicle details can be fetched from the vehicle API
vidThe VID recorded for this charge, if reported by the charge point.
Estimated CO2 impact of this charge. Null until the charge has drawn energy.
Detailed breakdown of the costs by hour
Note: Deprecated, this field will be be removed by 01.04.2024, Use the charges/:chargeId/breakdown endpoint instead
Detailed breakdown of the prices by hour
Note: Deprecated, this field will be be removed by 01.04.2024, Use the charges/:chargeId/breakdown endpoint instead
ChargeAuthToken
identifierThe identifier of the charge auth token, Note: without prefix e.g VID:
typeThe method type used for this charge auth token
createdAtCreation date of this charge auth token
updatedAtUpdate date of this charge auth token
idThe id of the charge auth token
teamIdId of the team that the charge auth token belongs to
userIdId of the user that the charge auth token is associated to
vehicleIdId of the vehicle linked to this charge auth token
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
nameName of the charge auth token
Operator of this charge auth token
montaNetworkIf the charge auth token is active in the Monta network
roamingNetworkIf the charge auth token is active in the Roaming network
operatorNetworkAllow this charge auth token to be used on other teams charge points under the same operator
activeUntilIndicates until when this charge auth token is active, null means indefinitely
blockedAtIf the charge auth token is blocked, it will not be able to charge.
null= not blocked- date-time = blocked since date-time
deletedIf the charge auth token is deleted
Maximum cumulative spend allowed on this charge auth token over a rolling 30-day window.
null means no limit is set. Limits are currently always in EUR. The write side of this field takes a plain decimal amount in the same currency.
dailyChargeCountLimitMaximum number of charges this charge auth token may start in a rolling 24-hour window. null means no limit is set.
concurrentChargesLimitMaximum number of concurrent active charges this charge auth token may have. null means no limit is set.
ChargeAuthTokenInventory
identifierThe card UID.
statusLifecycle status.
idInventory entry id.
printedIdentifierHuman readable value printed on the physical card. Used to look the card up when the UID cannot be scanned. Not used for charge authorisation.
chargeAuthTokenIdId of the charge auth token created when the card was claimed, otherwise null.
claimedByTeamIdTeam the card was claimed by, otherwise null.
claimedAtWhen the card was claimed, otherwise null.
blockedAtWhen the card was blocked, otherwise null.
createdAtWhen the entry was created.
updatedAtWhen the entry was last updated.
deletedAtWhen the entry was removed
ChargeAuthTokenInventoryBulkLoad
Cards to load as available stock. Each entry is either a bare UID string or an object carrying the UID and the value printed on the card. Each is validated independently; malformed or already-loaded entries are reported in errors while valid new ones are still created.
ChargeAuthTokenInventoryBulkLoadItem
identifierThe card UID.
printedIdentifierHuman readable value printed on the physical card. Optional; must be unique per operator when supplied.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = object · requires: identifier |
ChargeAuthentication
typeThe method type used to authenticate a charge
idThe id of the chosen authentication method
partnerExternalIdExternal Id of this entity, managed by you.
ChargeBreakdown
chargeIdThe charge id associated with this charge breakdown
The price breakdown, Includes information necessary to understand the composition of the final charge price
The cost breakdown is similar to the price breakdown but focuses on the costs incurred for the given charge
ChargeCost
timeHour for the sum of the cost
valueSum of cost for this hour
ChargeEmissionFactorDto
gramsPerKwhThe factor applied, in g CO2 per kWh.
emissionFactorSetNamePublished factor set this figure came from. Null when it came from country configuration instead.
ChargeHistoryItem
internalChargeIdocppChargeIdstatusstartTimechargePointIdentityconnectorIdnodeNamenodeIdphpChargeIdendedAtstartingSocstartingWhmaxObservedPowerWsocvehicleIdtotalPricecurrencyIdocppStatusocppStatusAtChargeImpactBasisDto
asOfWhen the emission factors were resolved as of, i.e. when the charge began drawing power.
The grid intensity the charge was priced at.
The combustion baseline the saving was measured against.
ChargeImpactReportDto
co2EmittedCO2 emitted by this charge, in grams. Measured from hourly grid intensity where available, otherwise estimated at the grid emission factor.
co2SavedVsIceCO2 avoided versus the same journey in a combustion-engine car, in grams.
costSavingsEstimated saving versus fuelling a combustion-engine car. An indicative comparison against a per-country configured measurementNull where the country has no comparison figure configured.
The emission factors these figures were derived from.
ChargeIntent
typedepartureTimepriorityChargeKeyLimitCap
Monta's recommended values, used as the cap while none is configured
Monta's ceiling: the highest value each cap may be set to. null means no ceiling.
idId of this set of caps
operatorIdId of the operator these caps belong to
nameName of the team settings profile, as shown in the Hub
defaultForTeamTypeTeams of this type get these caps by default: professional, private, all, operator, default_private_team, none, or null when the caps apply only to teams assigned to the profile explicitly. Also sets which recommended and max values apply.
Cap on a charge key's rolling 30-day spend. null means no cap is configured, so recommended applies. Currently always in EUR. The write side takes a plain decimal amount in the same currency.
dailyChargeCountLimitCap on a charge key's daily charge count. null means no cap is configured, so recommended applies.
concurrentChargesLimitCap on a charge key's concurrent charges. null means no cap is configured, so recommended applies.
ChargeKeyLimitValues
Rolling 30-day spend limit
dailyChargeCountLimitDaily charge count limit
concurrentChargesLimitConcurrent charges limit
ChargeKwhConsumption
chargeIdId of the charge
consumptionPeriodSizeInSecondsSpecifies the time interval, in seconds
Detailed breakdown of the kwh consumption in time interval of 5, 10, 15, 30 and 60 minutes
Note: Representation is in seconds, 3600 by default
ChargeMetadata
typeThe type of this metadata
idThe id of the the charge
kwhThe total kwh for the charge
ChargePoint
idId of this charge point.
teamIdId of the team.
createdAtCreation date of this charge point.
updatedAtDate this charge point was last updated.
visibilityIndicates if this charge point is public or private.
Location information for this charge point.
List of supported connector types at this charge point (e.g. type-2, ccs, ...).
Deeplinks to open charge screen in Monta app or web.
cablePluggedInIndicates if a cable is plugged in (true).
evseIdThe EVSE id for this charge point.
isActiveIndicates if this charge point is active (true) or not (false). Active = fully onboarded to Monta.
reservableIndicates if the charge point can be reserved.
roamingIndicates whether roaming is enabled for this charge point.
Protocol data, containing information about the protocol.
Note: Currently only OCPP is supported.
showOnMapIndicates if this charge point should be displayed on the map.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
siteIdId of the site.
Operator of this charge point.
deletedAtDate this charge point was deleted.
activeAtLast date when charge point was activated.
serialNumberSerial number of this charge point.
nameName of the charge point.
maxKwMax KW available at this charge point.
typeType of charge point (AC / DC).
noteA note you have entered for this charge point, e.g. via our Portal.
operatorNoteAn operator note you have entered for this charge point, e.g. via our Portal.
stateState of the charge point.
lastMeterReadingKwhLast meter reading (KWH) for this charge point.
meterIdMeter Id of this charge point.
chargePointModelIdThe ID of the charge point model for this charge point.
brandNameBrand name for this charge point.
modelNameModel name for this charge point.
firmwareVersionCurrent firmware version for this charge point.
integrationTypeIndicates what kind of integration this charge point is using (e.g oicp, ocpi, Note: null meaning not integrated).
priceGroupIdThe id of the public price group for this charge point.
costGroupIdThe id of the cost price group for this charge point.
roamingPriceGroupIdThe id of the roaming price group for this charge point.
sponsoredPriceGroupIdThe id of the sponsored price group for this charge point.
scheduleIdThe id of the schedule assigned to this charge point.
reservationTimeThe max duration(in minutes) that this Charge Point can be reserved fornull indicates that reservation is not supported.
SIM card data for the given charge point.
lastConnectedAtThe last date/time this charge point was reported as connected.
disconnectedAtThe date/time this charge point was reported as disconnected.
occupiedIndicates if the Charge Point is currently occupied. Note: At the moment this is only determined by a charge point sensor attached to it.
Additional information for this charge point (e.g. bus compatibility, motorcycle compatibility, etc.).
smartChargeSettingCode
autoStartCurrent auto-start status. not-available means the charge point is public or its model does not support auto-start.
userIdId of the user that owns this charge point.
autoRegisterRfidWhether RFID tags are auto-registered when scanned at this charge point.
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
ChargePointBrand
identifierThe identifier of the charge point brand
nameThe name of the charge point brand
idThe id of the charge point brand
createdAtCreation date of this charge point brand
updatedAtUpdate date of this charge point brand
ChargePointCTClamps_1
resultChargePointConnector
identifierIdentifier of connector
nameReadable name of connector
idId of this connector
ChargePointDataConsumption
Total data consumed over the whole period
Data consumption per day
startAtStart of the reporting period
endAtEnd of the reporting period
ChargePointDeeplinks
appFollow this link to open the Monta App with this charge point
webFollow this link to open the Monta Web App with this charge point
ChargePointGridSubscriptionStatus
ChargePointGridV2Response
nameinfoUrlactiveAtChargePointIntegration
stateThe current state of the charge point integration
serialNumberThe serial number of this charge point integration
chargePointIdentityThe identity number of this charge point integration
integrationTypeIdentifierThe integration type (method) used
The charge point associated to this integration
createdAtThe Creation date of this charge point integration
idThe id of this charge point integration
connectorIdThe connector id for this charge point integration
activeAtThe Date this charge point integration was set to active
updatedAtThe Date this charge point integration was last updated
deletedAtThe Date this charge point integration was deleted
ChargePointIntegrationStateDto
Enumerate the possible states for a charge point integration
ChargePointIntegrationType
definitions:
oicp- Indicates the current integration is OICP.ocpi- Indicates the current integration is OCPI.ocpp- Indicates the current integration is OCPP.other- Fallback value, Indicates a new type was added but is not mapped/unknown on this API yet.
ChargePointLog
idUnique identifier for the log entry
timestampTimestamp of the OCPP log
messageMessage content of the OCPP log, can be a string or an array of mixed types
ChargePointLogResult.CursorPage
ChargePointLogResult.CursorPage.CursorPageMeta
paginationTypeperPageitemCountafterbeforeChargePointLogResult.OffsetPage
ChargePointLogResult.OffsetPage.OffsetPageMeta
paginationTypeitemCountcurrentPageperPagetotalPageCounttotalItemCountChargePointMetadata
busCompatibleBus-compatible charge point
motorcycleCompatibleMotorcycle-compatible charge point
lorryCompatibleLorry-compatible charge point
lorryWithDangerousGoodsCompatibleLorry with dangerous goods allowed
lorryWithTrailerCompatibleLorry with trailer compatible
personalVehicleCompatiblePersonal vehicle-compatible charge point
personalVehicleWithTrailerCompatiblePersonal vehicle with trailer compatible
rigidLoryCompatibleRigid lorry compatible
vanCompatibleVan-compatible charge point
vehicleWithDisabilityPermitCompatibleVehicles with disability permit compatible
additionalParkingFeesPolicyAdditional parking fees policy
buildingTenantsOnlyPolicyBuilding tenants only parking policy
customersOnlyPolicyCustomers only parking policy
disabilityPermitPolicyDisability permit parking policy
evOnlyPolicyElectric vehicle only parking policy
employeesOnlyPolicyEmployees only parking policy
overnightParkingPolicyOvernight parking policy
parkingOnlyWhileChargingPolicyParking only while charging policy
reservationPolicyReservation required parking policy
taxisOnlyPolicyTaxis only parking policy
floorLevelFloor level of the charge point
cableLengthCable length in centimeters
behindBarrierPolicyBehind barrier parking policy
HDV parking spot details
dangerousGoodsAllowedDangerous goods are allowed
rigidVehiclesAllowedRigid vehicles are allowed
twoWheeledStationTwo wheeled station available
vehicleAccessibilityVehicle accessibility description
heightRestrictionHeight restriction in place
reservationRequiredReservation is required
overnightParkingAllowedOvernight parking is allowed
accessConditionsAccess conditions description
barrierBarrier present at the charge point
chargingWhenClosedCharging allowed when site is closed
trailerPullThroughTrailer pull-through available
ChargePointModel
identifierThe identifier of the charge point model
nameThe name of the charge point model, name is composed by (Brand name - Model name)
The brand of the charge point model
The supported features by this charge point model, only supported features will be included
idThe id of the charge point model
createdAtCreation date of this charge point model
updatedAtUpdate date of this charge point model
ChargePointModelDto.ChargePointBrandDto
nameThe name of the charge point brand
idThe id of the charge point brand
ChargePointModelFeature
keyThe key that identifies this feature
descriptionThe description for this feature
requirementsThe requirements for this feature
enabledThe current status of the feature
ChargePointOcpp
statusStatus of the OCPP.
updatedAtIndicates when the status was last updated.
errorCodeThe error code reported by the charge point in its most recent OCPP status notification. NoError means the charge point reported no fault.
infoAdditional free-format information reported by the charge point about its current status or error.
vendorErrorCodeA vendor-specific error code reported by the charge point. Its meaning is defined by the charge point vendor.
vendorIdIdentifies the vendor-specific implementation the charge point uses to report its status and error codes.
ChargePointOcppStatus
Various types of Charge Point OCPP protocol statuses
ChargePointPublishSettings
idIdentifier of the publish settings record.
identifierPublic-facing identifier used in the web URL.
enabledWhether the public web link is currently enabled.
web_urlPublic web URL that exposes the charge point data when enabled.
ChargePointSensor
typeType of the charge point sensor
createdAtCreation date of this charge point sensor
updatedAtDate this charge point sensor was last updated
idId of this charge point sensor
operatorIdThe operator id to which this charge point sensor is belongs to
chargePointIdThe charge point id to which this charge point sensor is assigned to
externalIdExternal Id of this sensor, ideally it references the sensor id in your system
partnerExternalIdExternal Id of this entity, managed by you
valueValue this sensor is reporting, this is sensor specific, this value is managed by you
valueUpdatedAtLast date when charge point sensor was changed
deletedAtDate this charge point sensor was deleted
ChargePointSensorType
Various types of Charge Point Sensors. Definitions:
occupancy- The sensor is of type occupancy (presence). accept values for type occupancy are true, false or null
ChargePointState
Various types of Charge Point states. Definitions:
available- The charge point is available for charging.busy- The charge point is currently in use.busy-blocked- The charge point is currently in use and blocked.busy-charging- The charge point is currently in use and charging.busy-non-charging- The charge point is currently in use and not charging.busy-non-released- The charge point is currently in use and not released.busy-reserved- The charge point is currently in use and reserved.busy-scheduled- The charge point is currently in use and scheduled.error- The charge point is in an error state.disconnected- The charge point is disconnected from Monta.passive- The charge point is in a passive state, charging can only be controlled locally.maintenance- The charge point is in maintenance mode.exempt- The charge point is exempt from downtime reporting due to external factors.
ChargePointStatisticsDto
fromDateStart date of the statistics period
toDateEnd date of the statistics period
totalEnergyConsumedTotal energy consumed during the period (in kWh)
totalSessionsTotal number of charging sessions during the period
sessionSuccessRateSuccess rate of charging sessions during the period (as a percentage)
chargePointIdId of the charge point
siteIdId of the site
systemUptimePercentagePercentage of uptime for the system during the period
Detailed state for the period
Detailed state that is exempt from uptime calculations
Daily statistics for the period
Monthly statistics for the period
ChargePointTicket
systemExternal system the ticket lives in
externalIdId of the ticket in the external system
titleTitle of the ticket
statusStatus of the ticket, normalised across external systems
createdAtCreation date of this ticket reference
updatedAtDate this ticket reference was last updated
idId of this ticket reference
chargePointIdId of the charge point this ticket belongs to
nativeStatusStatus as reported by the external system
urlLink to the ticket in the external system
alertIdId of the alert that triggered the ticket
alertOpenedAtWhen the triggering alert was opened
ticketCreatedAtWhen the ticket was created in the external system
commentCountNumber of comments on the ticket in the external system
lastCommentAtWhen the last comment was added in the external system
returnedToServiceAtWhen the external system reported the charge point back in service
ChargePrice
timeHour for the sum of the price
valueSum of price for this hour
ChargeScheduleItem
startendcurrentAnumberOfPhasespowerWChargeStateDto
Enumerate the various types of charge state
ChargeStateDto_1
isPluggedInVehicle is plugged in
isChargingVehicle is charging
batteryLevelBattery level in percentage
batteryCapacityBattery capacity in Kwh
chargeLimitCharge limit in percentage
chargeRateKwCharge rate in Kw
updatedAtCharge state was last updated at
ChargeVerification
outcomeWhole-charge verdict. not_run means no detector has reported yet — it is not a pass.
flagsNumber of results that flagged something, resolved ones included
unresolvedFlagsNumber of flags no operator has resolved yet
inconclusiveNumber of checks that could not reach a conclusion, typically for missing data
confirmationsNumber of checks that passed
notApplicableNumber of checks that did not apply to this charge. These demand no attention and are ignored when deriving outcome.
Every detector result, grouped by the bucket it counts towards
highestSeverityHighest severity across every result. Null when there are no results.
ChargeVerificationResults
Results that flagged something
Results that could not reach a conclusion
Results that passed
Charge_1
ocppChargeIdstartTimechargeIdstartingWhstartingSocchargedWhremainingKwhsockwhmaxObservedPowerWlastAllocatedCurrentlastAllocatedPowerWlastAllocatedAtestimatedEndTimeocppStatusocppStatusAtbatteryCapacityKwheffectiveTargetKwhassumedVehicleMaxPowerWtopUpDeltaWCharger
ididentitynameteamIdctClampssolarChargephaseModephaseSwitchMinIntervalSecondsconnectorIdmodelImageUrlbrandNamemodelNameconfiguredNumberOfPhaseslastCurrentLimitAlastCurrentLimitAtlastChargingNumberOfPhasesCharger.Charge
isControlledisSolarChargechargeIdexternalChargeIdfuseProtectionLimitingCounterCharger.ChargeUser
ididentifierlanguagelanguagesChargesInsight
typeThe type of charge insight
fromDateIndicates the starting period (fromDate) used calculate the insights, format (YYYY-MM-DD)
Note: The date will be always in UTC
toDateIndicates the end period (toDate) used calculate the insights, format (YYYY-MM-DD), always in UCT
Note: The date will be always in UTC
titleThe title for for this charge insight
The operator to which this charge insight belongs to
The currency applicable for this charge insight
The compilation of insights entries composing this charge insight
ChargesInsightByChargeAuthTokenReportDto
identifierThe identifier of the charge auth token, Note: without prefix e.g VID:
typeThe method type used for this charge auth token
Charge consumptions grouped by chargeType
idThe id of the charge auth token
ChargesInsightByChargeAuthTokenReportDto.Consumption
chargeTypeDefines the type of charge, ie. if it was a sponsored or public charge.
definitions:
sponsored- Charges that have been sponsored.team-operator- Charges that belong to Charge Points of the same operator as paying team operator.public- Any charge that was paid for by this team that does not match the other cases.
Note that more chargeTypes might be added in the future. Make sure to handle this gracefully.
totalSessionsNumber of charging sessions
totalKwhSum of all Kwh consumed
totalNetPriceSum of all charge net prices
totalVatSum of all charge vat amounts
totalGrossPriceSum of all charge gross prices
memberCostGroupIdThe ID of the Member Cost Group applied to this charges, or Null if none
memberCostGroupNameThe name of the Member Cost Group applied to this charges, or Null if none
memberCostGroupPriceSum of all charge costs in the Member Cost Group currency, or Null if none
ChargesInsightChargerReport
teamIdTeam ID used for this report
chargePointIdID of the Charge Point
Charge consumptions
lastChargeAtDate time of the last charge at this charge point during the report period. Null if no charges were made.
ChargesInsightChargerReportDto.Consumption
totalSessionsNumber of charging sessions
totalKwhSum of all Kwh consumed
ChargesInsightDriverMemberCostsReport
teamIdTeam ID used for this report
teamMemberIdTeam Member ID of the Driver
userIdUser ID of the Driver
Charge consumptions grouped by chargeType
ChargesInsightDriverMemberCostsReportDto.Consumption
chargeTypeDefines the type of charge, ie. if it was a sponsored or public charge.
definitions:
sponsored- Charges that have been sponsored.team-operator- Charges that belong to Charge Points of the same operator as paying team operator.public- Any charge that was paid for by this team that does not match the other cases.
Note that more chargeTypes might be added in the future. Make sure to handle this gracefully.
totalSessionsNumber of charging sessions
totalKwhSum of all Kwh consumed
totalNetPriceSum of all charge net prices
totalVatSum of all charge vat amounts
totalGrossPriceSum of all charge gross prices
Breakdown of the charges by country
memberCostGroupIdThe ID of the Member Cost Group applied to this charges, or Null if none
memberCostGroupNameThe name of the Member Cost Group applied to this charges, or Null if none
memberCostGroupPriceSum of all charge costs in the Member Cost Group currency, or Null if none
ChargesInsightDriverMemberCostsReportDto.Consumption.CountryBreakdown
countryCodeTwo letter Country Code
totalSessionsNumber of charging sessions
totalKwhSum of all Kwh consumed
totalNetPriceSum of all charge net prices
totalVatSum of all charge vat amounts
totalGrossPriceSum of all charge gross prices
memberCostGroupPriceSum of all charge costs in the Member Cost Group currency, or Null if none
ChargesInsightDriverReport
teamIdTeam ID used for this report
teamMemberIdTeam Member ID of the Driver
userIdUser ID of the Driver
Charge consumptions grouped by chargeType
ChargesInsightDriverReportDto.Consumption
chargeTypeDefines the type of charge, ie. if it was a sponsored or public charge.
definitions:
sponsored- Charges that have been sponsored.team-operator- Charges that belong to Charge Points of the same operator as paying team operator.public- Any charge that was paid for by this team that does not match the other cases.
Note that more chargeTypes might be added in the future. Make sure to handle this gracefully.
totalSessionsNumber of charging sessions
totalKwhSum of all Kwh consumed
totalNetPriceSum of all charge net prices
totalVatSum of all charge vat amounts
totalGrossPriceSum of all charge gross prices
ChargesInsightEntry
typeThe type for this insight entry
The summary for this insight entry, The summary contains the compiled statistics for the entry
ChargesInsightEntryTypeDto
Enumerate the various types of charge insights
ChargesInsightSummary
totalKwhThe total kWh charged for this entry
totalPriceThe total price for this entry
totalCostThe total cost for this entry
totalSessionsThe total sessions for this entry
ChargesInsightTypeDto
Enumerate the various types of charges insights
ChargingRuleDto
nameName of the charging rule
typeThe type of the charging rule
isActiveIndicates if this rule is active
isSponsoredIndicates if the charge is sponsored
creatorUserIdUser that created this rule
supportedChargingRuleTypesThe type of charging rules supported by this charge point
The settings of the charging rule, depending on the type of the rule
idId of this charging rule
vehicleIdVehicle id of the vehicle this rule applies to
chargePointIdId of the charge point this rule belongs to
ChargingRuleResponseSettings
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object · requires: start, stop |
startThe time when the charging should start. Required when delayedStart is true; may be null otherwise
beReadyAtThe time when the charging should stop
delayedStartIndicates if the charging should start immediately
defaultMaxBatteryPercentageThe maximum battery percentage to charge to. Null when the rule has none
ChargingRuleScheduledChargeSettingsDto
startThe time when the charging should start
stopThe time when the charging should stop
ChargingRuleScheduledChargeSettingsResponseDto
startThe time when the charging should start
stopThe time when the charging should stop
ChargingRuleSettings
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: beReadyAt, start | |
| type = object · requires: start, stop |
startThe time when the charging should start
beReadyAtThe time when the charging should stop
delayedStartIndicates if the charging should start immediately
defaultMaxBatteryPercentageThe maximum battery percentage to charge to
ChargingRuleSmartChargeSettingsDto
startThe time when the charging should start
beReadyAtThe time when the charging should stop
delayedStartIndicates if the charging should start immediately
defaultMaxBatteryPercentageThe maximum battery percentage to charge to
ChargingRuleSmartChargeSettingsResponseDto
startThe time when the charging should start. Required when delayedStart is true; may be null otherwise
beReadyAtThe time when the charging should stop
delayedStartIndicates if the charging should start immediately
defaultMaxBatteryPercentageThe maximum battery percentage to charge to. Null when the rule has none
ChargingRuleType
Types of Charge Point Charging Rules
CircuitSettings
voltageLevelVLNnumPhasescontinuousConsumptionWCircuitSettingsUpdate
voltageLevelVLNnumPhasescontinuousConsumptionWClearChargingProfile
idThe id of the charge point profile.
connectorIdThe connector id to clear the profile for.
chargingProfilePurposeThe charging profile purpose type.
ClearChargingProfileConfirmation
statusThe status of the clear charging profile request.
Component
typeThe type of price/fee for this component
priceThe price of this component
descriptionThe readable description of this component
masterPricingIndicates this component is master a master pricing
The tag for this component
Additional information (metadata) for this component, e.g tariffId, kwh and others
ComponentMetadataDto
typeEnumerate the various types of metadata.The content of metadata payloads may differ depending on the typefor example, a tariff payload is different from a spot-price payload. This type offers reliable means to associate the metadata with the appropriate model class
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object · requires: kwh | |
| type = object | |
| type = object | |
| type = object · requires: from, to | |
| type = object | |
| type = object |
typeThe type of this metadata entry
kwhThe kwh for this metadata entry
pricePerKwhThe price per kwh for this metadata entry
ComponentMetadataTypeDto
Enumerate the various types of metadata.The content of metadata payloads may differ depending on the typefor example, a tariff payload is different from a spot-price payload. This type offers reliable means to associate the metadata with the appropriate model class
ComponentTypeDto
Enumerate the various component types.component types identify the component inside a break down
ConnectThirdPartyIntegrationDto
nameName of the third-party integration to connect. Currently only allStar is supported.
ConsentRequest
consent_typeConsumer
nameA name for this credential (e.g. Monta Team A)
operatorIdsList of operator ids that are authorized for API operations. If empty, all child operators of this operator are authorized.
teamIdsList of team ids that are authorized for API operations. If empty, all teams of this operator are authorized.
clientIdYour client id
scopesList of scopes for this account
createdAtCreation date of this consumer
operatorIdYour operator id
rateLimitRate-limit for your account; requests per rateLimitIntervalInSeconds
rateLimitIntervalInSecondsRate-limit interval for your rateLimit
updatedAtUpdate date of this consumer
Coordinates
latitudeLatitude value of coordinate
longitudeLongitude value of coordinate
CostCenter
nameName of the cost center
externalIdExternal Id of this cost center, managed by you.
createdAtCreation date of this cost center
updatedAtDate this cost center was last updated
idId of this cost center
operatorIdId of the operator this cost center belongs to
teamIdId of the team this cost center belongs to. Null when the cost center is operator-scoped.
descriptionDescription of the cost center
teamsCountNumber of teams assigned to this cost center. Only returned when retrieving a single cost center.
teamMembersCountNumber of team members assigned to this cost center. Only returned when retrieving a single cost center.
teamMemberProfilesCountNumber of team member profiles assigned to this cost center. Only returned when retrieving a single cost center.
vehiclesCountNumber of vehicles assigned to this cost center. Only returned when retrieving a single cost center.
chargeKeysCountNumber of charge keys assigned to this cost center. Only returned when retrieving a single cost center.
Country
idId of the country
nameName of the country
alpha2CodeCountry code in Alpha-2 format, following ISO-3166
sanctionedSpecifies if the country is sanctioned or not
CountryArea
idId of the country area
countryIdId of the country for the country area
nameName of the country area
levelThe level of depth for this country area
externalIdThe external id of the country area
CreateAdditionalPricingDto
typeType of the additional pricing. absolute means the value is a price.
valueThe value of this additional pricing.
titleA title for this additional pricing.
CreateAlert
typeThe alert type token.
What a new alert or issue is about.
operatorIdOperator to create the alert under. Defaults to your own operator.
titleHuman label for the alert.
triggerReasonWhy the alert was raised.
issueIdsIds of existing issues of the same operator to attach, at most 100.
CreateAlertComment
bodyComment body, at most 5000 characters.
CreateAuthorizationLink
userIdId of the application user the authorization link is created for
redirectUri^https://\S+$ · requiredURI the user is redirected to after authorizing their vehicle account. Must be an https:// URL.
providerenode|smartcarVehicle integration provider. Defaults to enode when omitted.
brandIdVehicle brand id used to pick a provider-specific authorization flow
scopesScopes requested from the vehicle account. Defaults to charge-state and control-charging. charge-state also grants the odometer, location the vehicle's location, all every scope. Smartcar always requests every scope.
CreateBankAccount
nameName of the bank account
typeWhich set of fields identifies the bank account.iban requires iban. swift requires swift. bsb requires bsb. sort_account requires sortCode and accountNumber. routing_account requires routingNumber, accountNumber and accountType. local_canadian requires institutionNumber, transitNumber and accountNumber. emirates requires iban.
ibanIBAN of the bank account. Validated against its check digits.
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account (Canada, 5 digits)
institutionNumberInstitution number of the bank account (Canada, 3 digits)
CreateChargeAuthToken
teamIdId of the team the charge auth token belongs
identifier^(?!VID:)[\s\S]* · requiredIdentifier of the the charge auth token, Note: without prefix e.g VID:
typeType of the charge auth token
userIdId of the user the charge auth token should be associated to
vehicleIdId of the vehicle to link to this charge auth token
nameName of the charge auth token
montaNetworkIf the charge auth token should be active in the Monta network
roamingNetworkIf the charge auth token should be active in the Roaming network
operatorNetworkIndicates that the charge auth token can be used on other teams charge points underthe same operator
activeUntilIndicates until when this charge auth token should be active, null means indefinitely
blockedAtIf the charge auth token is blocked, it will not be able to charge.
null= not blocked- date-time = blocked since date-time
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
CreateChargePoint
teamIdId of the team that the charge point belongs to
siteIdId of the site the charge point belongs to
chargePointModelIdId of the charge point model
nameName of the charge point
maxKwMax Kw (Max Power) the charge point can output
visibilityVisibility type of the charge point
typeElectric current type the charge point support
activeIndicates the charge point is active
showOnMapCode
connectorIdsCode
noteA note (instructions, warning, information) you have entered for this charge point
latitudeCode
longitudeCode
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
smartChargeSetting^(off|optional|force…Code
userIdId of the user that owns this charge point
meterIdMeter id of the charge point.
autoRegisterRfidWhether RFID tags are auto-registered when scanned at this charge point. Ignored unless RFID auto-registration is enabled for your operator.
CreateChargePointOcppConfig
keyThe unique configuration key for the OCPP setting
storePersist Configuration (this means this configuration will be kept across reboots, please do not set this to true if you are changing the OCPP url of a charge point)
valueThe value associated with the configuration key
CreateChargePointSensor
typeType of the charge point sensor
chargePointIdThe charge point id to which this charge point sensor is assigned to
valueValue this sensor is reporting, this is sensor specific, this value is managed by you
valueUpdatedAtIndicates when the value for this sensor was last updated
externalIdExternal Id of this sensor, ideally it references the sensor id in your system
partnerExternalIdExternal Id of this entity, managed by you
CreateChargingRule
nameName of the charging rule
typeThe type of the charging rule
isActiveIndicates if this rule is active
isSponsoredIndicates if the charge is sponsored
creatorUserIdUser ID of the rule creator that you ware impersonating
The settings of the charging rule, depending on the type of the rule
vehicleIdVehicle id of the vehicle this rule applies to
CreateCostCenter
nameName of the cost center.
externalIdExternal Id of this cost center, managed by you.
teamIdId of the team this cost center belongs to. When omitted, the cost center is operator-scoped.
descriptionDescription of the cost center.
CreateDeeplink
destinationTypeType of destination for the deeplink
Destination details for the deeplink
commentOptional comment for the deeplink
operatorIdThe ID of the operator for whom the deeplink will be created. If not provided, operator ID will be derived from the used api credentials
CreateFeatureGroup
relationTypeRelation type that the feature group should apply to.
idsList of IDs that the feature group should be applied to. If one of the IDs does not belong to your operator, applying feature group will fail. Therefore, make sure all the Ids belong to your operator.
CreateInstallerJobDto
siteIdSite id of the site where the installer job will be created.
descriptionA description of the installer job, visible for the installer.
emailThe email of the installer. If provided, an email will be sent to the installerwith the description of the installer job.
CreateIssue
typeThe issue type token.
What a new alert or issue is about.
operatorIdOperator to create the issue under. Defaults to your own operator.
teamIdTeam the issue belongs to, if any. Must belong to the same operator.
siteIdSite the issue belongs to, if any. Must belong to the same operator.
CreateLocalPaymentTerminalDto
teamIdThe team that owns the local payment terminal.
payingTeamIdThe team that pays for charges started on this terminal.
idTagThe id tag (or prefix) used to authorize charges on this terminal.
idTagPrefixIf true, the id tag is treated as a prefix (any tag starting with this value is accepted).
nameDisplay name of the local payment terminal.
priceLimitOptional spending limit (in the team's currency) per charge.
CreateNodeRequest
parentNodeIdnamefuseLimitAbufferApowerLimitWmaxExpectedResidualCurrentAmaxExpectedResidualPowerWCreateOdometerReading
odometerKmOdometer reading in whole kilometres. Values outside 0-4000000 are rejected with 422.
readingAtWhen the reading was taken (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Defaults to the time of the request.
sourceRefYour own identifier for this reading, echoed back on reads. Maximum 128 characters.
CreateOnboardingProfile
nameName of the profile, unique per operator.
The onboarding steps a linked team receives, as {step, config?, displayMode?} entries. Present in the list means enabled.
descriptionDescription of the profile.
enabledWhether the profile can be assigned to teams. Defaults to true.
Optional welcome screen text overrides.
CreateOperatorList
nameName of the operator list.
listTypeThe single entity type this list is restricted to.
descriptionOptional free-text description of the operator list.
sourceHow the list is populated. MANUAL (default) for a hand-curated list, or FILTER for a dynamic list that reconciles from filterDefinition. Immutable after creation.
syncModeReconciliation mode for a FILTER list. Only AUTO is supported on the Partner API (changes are applied automatically); defaults to AUTO.
Required when source is FILTER: the saved filter the list resolves its members from. Charge-point lists only.
CreateOrUpdateChargePointIntegration
chargePointIdId of the charge point to setup the integration
chargePointModelIdId of the charge point model to be integrated
serialNumberThe serial number for the charge point integration
connectorIdConnector id for the charge point integration. when null the connectorId will default to 1
autoConnectIndicates that an attempt to connect the charge point should happen, when autoConnect is set to true the Charge Point needs to point to Monta (via OCPP websocket)
Note: when false the integration will be create but the state will be to pending
ocppPasswordBasic authentication password that will be required for the OCPP websocket connection. Gets ignored, i.e. does not clear the password, when null
CreateOrUpdateGracePeriod
startTimeStart time for the grace period
endTimeEnd time for the grace period
CreateOrUpdatePriceGroupDto
nameName of the price group
typeType of the price group
The master price
teamIdTeam ID. When omitted the price group is created at operator scope and owned by the calling operator.
All the fees for the price group
CreateOrUpdatePricingDto
typeType of the pricing. minute is used for Minute fee. min is used for the master price.
endAtFullyChargedUsed by the Minute fee. True means it will stop charging the fee when the charge is complete. False means it will stop charging the fee when the cable is unplugged
vatUsed by Spot Price. True means it will add 25% VAT in the price calculations
priceThe price of this Fee or Master price,
Note: the master price cannot be a negative value
descriptionName of the pricing. It is null when it's the master price
percentageUsed by Spot Price. It will multiply the fallback price by this percentage
tariffIdThe id of the selected Tariff
tagIdThe id of the selected charge pricing tag
applyAfterMinutesUsed by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied.
priceMinUsed by spot price. The minimum that the raw spot price can be. This will be used in calculations if spot price is lower than this
priceMaxUsed by spot price. The maximum that the raw spot price can be. This will be used in calculations if spot price is higher than this
feePriceMaxUsed by Idle fee. The maximum the user will be charged for the idle fee
Used by spot price. Additional absolute money or percentages values to be added on top of the previous calculations
fromDateTime "from" time to which this pricing should apply from
toDateTime "to" time to which this pricing should apply to
intervalSpecifies the time resolution used for spot price calculations.
Note: Only has an effect if such resolution is available (, ie 15-min MTU from 30.09.25).
Grace periods during which idle fees are not applied
CreatePriceGroupTag
nameName of the tag. names are unique and cannot be reused.
descriptionDescription of the tag.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
CreatePromotionCode
nameName of the promotion code
code^[a-z0-9]+(?:-[a-z0-… · requiredUnique code string. Must be lowercase alphanumeric, optionally hyphen-separated (e.g. summer-2025).
amountPercentage off for the discount types (max 100), or the currency amount deposited into the driver's wallet for credit (max 500). The cap is enforced per type by the server, so a percentage type above 100 is rejected with 422 even though the schema maximum is 500.
descriptionDescription of the promotion code
maxUsesCountMaximum number of times the code can be used. For credit this must be 1 or omitted — a higher value is rejected with 422, and omitting it creates the code as single-use.
startAtWhen the promotion code becomes active (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
endAtWhen the promotion code expires (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
typeWhat the code gives the driver.
ongoing-charge-discount-percentage— a percentage off each charge.charge-package-discount-percentage— a percentage off a charge package.credit— depositsamountas currency into the driver's wallet instead of applying any discount. Must be enabled for your operator.
userIdUser ID to limit this code to a specific user
maxDiscountAmountCap on the total discount a single driver can accumulate from this code. Once a driver reaches it the code stops discounting for them; the code stays usable for everyone else. Ignored for credit. Omit to set no cap.
selectedTeamIdsTeam IDs the promotion code is restricted to. Omit or pass an empty array to leave the code unrestricted.
amountKwhkWh allowance the discount covers per budget period. Ignored for credit, and must be enabled for your operator. Omit or pass null for no kWh cap.
budgetPeriodTypecalendar-monthReset window for the kWh allowance; calendar-month resets on the 1st, null means a lifetime cap. Ignored for credit.
includeHomeChargingWhether the kWh allowance also covers charge points owned by the subscribing team, so home charging draws on the same allowance as public charging.
selectedListIdsList IDs the promotion code is restricted to. Omit or pass an empty array to leave the code unrestricted.
maxChargeUsesCountMax charges per driver eligible for the discount after redeeming. Omit to set no limit.
CreateRevenueSharePolicy
nameHuman-readable name.
kindWho the revenue is shared between.
sellerWho sells the electricity.
policyTypeHow the share is measured.
policyValueThe share value: a percentage of net, or an amount per kWh.
moneyFlowHow the settled share reaches the recipient.
validFromStart of the validity window.
descriptionOptional internal description.
validToOptional end of the validity window.
CreateRfidChargeIntent
rfidtypedepartureTimeCreateScheduleDto
teamIdId of the team that should own this schedule
nameName of the schedule
timezoneTimezone for interpreting the schedule entry times
visibilityDefault visibility for charge points in this schedule. Defaults to public when omitted.
priceGroupIdId of the default price group applied during scheduled windows. Defaults to the team's default price group when omitted.
selectedChargePointIdsIds of charge points to assign to this schedule
selectedSiteIdsIds of sites to assign to this schedule
Time windows that make up this schedule
CreateScheduleEntryDto
dayOfWeekDay of week this entry applies to
from^([01]\d|2[0-3]):[0-… · requiredStart time of this entry (HH:mm)
to^([01]\d|2[0-3]):[0-… · requiredEnd time of this entry (HH:mm)
visibilityVisibility override for this time window. Null means the schedule's default visibility is used.
priceGroupIdPrice group override for this time window. Null means the schedule's default price group is used.
CreateSite
teamIdId of the team that the site belongs to
nameName of the site
Address of the site. countryId is always required. address1, city, and zipCode must either all be provided (geocoding will resolve coordinates) or all be left null — in which case latitude and longitude must be supplied instead. Partial addresses are rejected.
visibilityVisibility type of the site. Controls who can charge at the site: public means any Monta user can charge here, private restricts charging to team members / access-token holders. This field does NOT control whether the site appears on the consumer map — use showOnMap for that.
latitudeLatitude coordinate for the site location. Required when the address (address1/city/zipCode) is omitted. When provided along with longitude, overrides geocoding from address.
longitudeLongitude coordinate for the site location. Required when the address (address1/city/zipCode) is omitted. When provided along with latitude, overrides geocoding from address.
showOnMapWhether this site should be visible on the consumer map. If omitted, the site will be visible on the map by default. This is independent of visibility — a private site can still be shown on the map, and a public site can be hidden.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site. Defaults to inherit when omitted.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
Metadata for the site including amenities, energy mix, opening hours, site developer, and pictures.
noteA free-text note for this site, visible in the app.
operatorIdDeprecated: the site is always assigned to the operator of its team.
Note: if provided, it must match the operator of the given team.
CreateSolarPanelRequest
latitudelongitudedeclinationazimuthpeakProductionKwexternalIdCreateSponsoredChargePointDto
payoutScheduleThe payout schedule for this sponsored charge point
sponsoringTeamIdId of the team that is sponsoring this charge point
chargePointIdId of the charge point to be sponsored
userIdId of the user to have a charge point sponsored
priceGroupIdThe price group for this sponsorship, Only price groups of type reimbursement or sponsored are allowed
Note: if the priceGroupId is null the charge point cost price group will be used instead, if the charge point has no cost price group set the request will fail, please ensure that charge point has a valid cost group assigned when not providing a priceGroupId
payForSubscriptionsIndicates that company pay for subscriptions
autoApproveElectricityCostWhen true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review. When omitted, the value is inherited from the team member's (or team-member-profile's) auto_approve_electricity_cost setting.
noteNote for the sponsored charge point
sendEmailNotificationWhether to email the charge point owner that their reimbursement is set up. Defaults to true. Set to false to suppress it, e.g. when migrating existing customers from another CPMS.
CreateSubscription
customerTypeType of the customer that the subscription is created for. e.g. team or charge-point
planIdId of the plan to subscribe to
customerIdId of the customer the subscription is created for, e.g. team or charge-point id
discountAbsoluteAllows to modify the absolute discount on a subscription if provided. If not provided, the discount of the plan is used. Note: If you want to set it on an existing subscription, you have to cancel the subscription first.
discountPercentageAllows to modify the percentage discount on a subscription if provided. If not provided, the discount of the plan is used. Note: If you want to set it on an existing subscription, you have to cancel the subscription first.
Configure the subscription, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.
userIdThe user that should be assigned as the purchaser of the subscription. If not provided, the subscription will be assigned to the default user for this consumer.
nextPurchaseAtDate when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Has to be a date in the future.
sendNotificationsWhether to send the subscription-created notifications (e.g. confirmation email to the team's admins). Defaults to true. Set to false to suppress them, e.g. when migrating existing customers from another CPMS.
CreateTariffPricesRequest
startStart date that marks when prices should be created for a tariff (yyyy-MM-dd)
endEnd date that marks when prices should be created for a tariff (yyyy-MM-dd)
CreateTariffRequest
externalIdexternal id
nameRadius Elnet A/S
descriptionShort description of this tariff
countryIdId of the country where the tariff is applicable
currencyIdId of the currency in which the tariff is applicable
pricesWithVatIndication if prices are with vat
zipCodesZip codes where this tariff is applicable
timeZoneWhat time zone is the tariff active in
areaHuman description of the area the tariff is active in
countryAreaIdId of the country area where the tariff is applicable
teamIdTeam id
tariffTypeDynamic or weekly
activeIndication if this tariff is active
customerTypeWhat kind of customer types are the tariff for?
CreateTeamDto
nameName of the team.
contactEmailContact email of the team. Named "email" in the GET APIs.
typetype of the team.
Address of the team. Only countryId is mandatory. Address1, city, and zipCode must be provided together or all left null.
userIdId of the user that owns the team.
userEmailEmail of the user that owns the team, useful when the userId is not known.
operatorIdId of the operator this team should be assigned to
Note: if not provided the team will be assigned to the default operator for the given consumer, if the default operator cannot be assigned the request will be rejected.
financeEmailFinance contact email of the team.
financeCommunicationEmailRecipient for important payment notices (late payment, freeze warning, frozen). When not set, these go to financeEmail.
legalEmailLegal contact email of the team.
companyNameThe company name for the team.
vatNumberThe vat number for the team.
companyRegistrationNumberThe company registration number for the team.
Custom fields to set on this entity: a flat map of string keys (1-64 characters, no : or ,, not starting with monta) to string values (up to 256 characters), at most 20 pairs per entity. Fields are scoped to your operator. externalId is the same value as the deprecated partnerExternalId.
paymentMethodThe payment method for the team.
Note: if not provided the team will be created with the default payment method source.
themeIdThe theme id to assign to the team.
Note: When theme is provided, it must belong to the same operator as the team
The onboarding steps enabled for the team, as {step, config?, displayMode?} entries. Present in the list means enabled; the list is the full enabled set.
onboardingProfileIdOnboarding profile to apply, from GET /onboarding-profiles. Copies the profile's steps onto the team and locks them to the profile. Cannot be combined with onboardingSteps.
The app-onboarding welcome-screen text override. Omit to use Monta's default copy.
categoryCategory identifier of the team, one of: housing-association, cpo, parking, hotel, fleet, company, priced-by-site-owner.
Note: if not provided Monta assigns a default based on the team type.
selfRegisterChargeKeysWhether team members can register their own charge keys.
Note: defaults to false when omitted. Self-registration is also enabled when the team's operator team settings template enables it.
joinCodeCustom code users enter in the app to join the team, 4-50 characters. Monta generates one when omitted.
Note: stored slugified (lowercased, spaces and symbols become dashes, e.g. MVV Energie 042 → mvv-energie-042); the response returns the stored value. Join codes are unique across all teams on Monta, so a code that is already taken (after slugifying) is rejected with 422.
partnerExternalIdExternal Id of this entity, managed by you.
Deprecated: use customFields.externalId instead — both read and write the same value.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
Deprecated: use customFields instead; this payload is not migrated automatically.
CreateTeamMember
roleRole for this member within the team
teamIdId of the team that the user will be invited
userIdId of the user to be invited
Note: When inviting by userId the fields email or phone must not be provided.
emailEmail of the user to be invited
Note: When inviting by email the fields userId or phone must not be provided.
phone^\+[1-9]\d{1,14}$Phone of the user to be invited
Note: When inviting by phone the fields userId or email must not be provided.
priceGroupIdThe price group for this team member, when not provided the default team price group will be applied
costGroupIdThe cost group for this team member
teamMemberProfileIdThe team member profile id to apply to this team member
canConfigureChargePointsIndicates if the team member can configure charge points
canPayWithTeamWalletGives the team member access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canRequestSponsoringAllows the team member to request sponsoring from this team for their charge point
canManageTeamMembersAllows the team member to view and manage other members settings
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
canDepositToWalletGives the team member permission to deposit to the team wallet
canWithdrawFromWalletGives the team member permission to withdraw from the team wallet
canManageChargeKeysGives the team member permission to manage charge keys for the team
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
noteA note for the team member
chargePointIdsIds of the charge point this team member with will have access
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
notifyUserControls whether an invitation email and/or SMS is sent to the user based on the provided email and phone fields.
immediateAccessGrants the invited member access to the team immediately, without waiting for them to accept the invitation. When true and the user already exists, the team member is created in accepted state so the operator can configure pricing, charge-point access and other settings right away. When true and the user does not yet exist, the immediate-access intent is persisted on the invitation and applied when the user registers — the team member is then created in accepted state with the inviter recorded as the acceptor (operator-initiated acceptance). If both immediateAccess and the deprecated autoAccept are sent, immediateAccess takes precedence.
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
sponsoredPriceGroupIdPrice group used to reimburse this team member for home charging. Omit or set null to use the employee's own cost price group (cloned at SCP creation time).
autoApproveElectricityCostWhen true, employee-submitted electricity costs are auto-approved for SCPs created for this team member.
reimbursementEnabledMaster switch — whether the team member participates in home reimbursement.
reimbursementPayoutScheduleDefault payout schedule applied to sponsored charge points created for this team member.
reimbursementSubscriptionWhether the operator reimburses the charge-point subscription price.
costCenterIdThe cost center to assign to this team member. Must belong to the same operator, and when it is scoped to a team, to that team.
canManageTeamWalletDeprecated: use canDepositToWallet and canWithdrawFromWallet instead. When set to true, automatically grants both deposit and withdraw permissions.
autoAcceptDeprecated: use immediateAccess instead. When true, the invitation is granted immediately: existing users are added to the team in accepted state, and for new users the immediate-access intent is persisted on the invitation so it is honoured when they later register.
CreateTeamMemberFeeDto
nameName of the member fee.
monthly_priceMonthly price charged per member, in the team's currency. Use 0 for a free tier.
CreateTeamMemberProfile
nameThe team member profile name
descriptionThe team member profile description
roleRole for team member profile
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
teamIdId of the team
priceGroupIdThe price group, when not provided the default team price group will be applied
costGroupIdThe cost group
canConfigureChargePointsAllows the team applying member profile to configure charge points
canPayWithTeamWalletGives the team member applying this profile access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canRequestSponsoringAllows the team applying member profile to request sponsoring from this team for their charge point
canManageTeamMembersAllows the team applying member profile to view and manage other members settings
canDepositToWalletGives the team member permission to deposit to the team wallet
canWithdrawFromWalletGives the team member permission to withdraw from the team wallet
canManageChargeKeysGives the team member permission to manage charge keys for the team
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
sponsoredPriceGroupIdPrice group used to reimburse members in this profile for home charging. Omit or set null to use the employee's own cost price group (cloned at SCP creation time).
autoApproveElectricityCostWhen true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.
reimbursementEnabledMaster switch — whether members in this profile participate in home reimbursement.
reimbursementPayoutScheduleDefault payout schedule applied to sponsored charge points created for members in this profile.
reimbursementSubscriptionWhether the operator reimburses the charge-point subscription price.
canManageTeamWalletDeprecated: use canDepositToWallet and canWithdrawFromWallet instead. When set to true, automatically grants both deposit and withdraw permissions.
CreateUser
countryIdCountry Id of the user
emailEmail address of the user. Required unless phone is provided. Without an email, phone must match an existing Monta user, which is then linked to your application; a new user can't be created without an email.
phone^\+[1-9]\d{1,14}$Phone number of the user in E.164 format
firstNameFirst name of the user
lastNameLast name of the user
sendWelcomeEmailControls whether a welcome email is sent to the user after creation. For new users, the email includes a link to set their password. For existing users, the email welcomes them to the operator's platform.
languageUser preferred language
legalEmailUser legal email address
address1User address line 1
address2User address line 2
address3User address line 3
zipUser zip/postal code
cityUser city
provinceUser province/state
isEmailOrPhoneProvidedCreateVehicle
nameName of the vehicle
teamIdId of the team the vehicle belongs to
modelIdId of the vehicle model
licensePlateLicense plate of the vehicle
brandManual vehicle brand name. Required when modelId is not provided.
modelNameManual vehicle model name. Required when modelId is not provided.
vehicleTypeVehicle type. Required when modelId is not provided.
vid^VID:[0-9A-Fa-f]{6,2…VID identifier for auto-charge. Format: VID:xxxxxxxxxxxx
CreateVehicleIdIntent
vehicleIdTagbatteryCapacityKwhtypevehicleIddepartureTimeCreatedOrUpdateAddress
countryIdThe country id.
Note: If the chosen countryId is under sanctions the request will get rejected.
address1First line of address
address2Second line of address
address3Third line of address
cityThe city name
zipCodeThe address zip code
countryAreaIdThe country area id
CreatedPromotionCode
idID of the created promotion code
codeThe code a driver redeems
CtClampIntegrationResult
Currency
identifierCurrency identifier, e.g. dkk
nameReadable name of currency
decimalsNumber of decimals for this currency
CurrencyDto
ididentifiernamedecimalsCurrencyDto_1
idid of the currency
identifierCurrency identifier
nameReadable name of currency
decimalsNumber of decimals for this currency
Currency_1
identifier3 characters identifier
decimalsHow many decimals the currency has
idid of the currency
masterWhether the currency is master or not, master meaning the default currency
nameName of the currency
CursorBasedPageMeta
itemCountThe number of items in the result
perPageThe requested maximum number of items returned
afterA cursor to retrieve the next page of items in a new request
beforeA cursor to retrieve the previous page of items in a new request
CursorBasedResponse
CursorBasedResponse_1
CursorBasedResponse_2
CursorBasedResponse_3
CursorBasedResponse_4
CursorBasedResponse_5
CursorBasedResponse_6
CursorPage_ChargeHistoryItem_
totalSizeperPagecurrentSizebeforeafterDailyDataConsumption
dateDay of the consumption
bytesBytes consumed on the day
megabytesMegabytes consumed on the day (1 MB = 1,000,000 bytes)
DashboardNetworkOverviewDto
disconnectedCountNumber of disconnected charge points
errorCountNumber of charge points in error state
maintenanceCountNumber of charge points in maintenance state
totalChargePointCountTotal number of charge points
DataConsumptionTotal
bytesTotal bytes consumed
megabytesTotal megabytes consumed (1 MB = 1,000,000 bytes)
DataTransferMeterIntegration
chargePointIdentitytimeoutSecondsDeeplinkDto
destinationTypeType of destination for the deeplink
createdAtCreation timestamp
updatedAtLast update timestamp
idUnique identifier of the deeplink
Destination details for the deeplink
commentOptional comment for the deeplink
visitsNumber of visits to this deeplink
operatorIdID of the operator who created the deeplink. Null for deeplinks without an operator (e.g.: permanent charge point links)
qrCodeUrlURL to the QR code image
appUrlOptional URL for the mobile app
deletedAtDeletion timestamp, if deleted
DefaultComponentMetadata
typeThe type of this metadata entry
kwhThe kwh for this metadata entry
priceThe kwh for this metadata entry
DeleteTariffConfirmationDto
confirmMust be true to confirm this bulk destructive operation. Omitting this field or setting it to false will result in a 422 error.
DestinationLinkOrResource
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
urlURL of the link
DestinationResource
resourceTypeType of the resource
resourceIdID of the resource
DetailedBreakdown
The summary of the total prices for this breakdown
The currency applicable for this breakdown (for all the components: prices, fees, adjustments)
The breakdown entries for this breakdown, currently organized on an hourly basis
The fees that compose this breakdown
The adjustments applied for this breakdown
DurationFeeComponentMetadata
typeThe type of this metadata entry
totalMinutesThe total duration in minutes for this metadata entry
feePerMinuteFor the fee per minute for this metadata entry
DynamicPriceEntry
timeStartInclusive start of the price interval (UTC, RFC 3339). Must align to the batch resolution grid.
timeEndExclusive end of the price interval (UTC, RFC 3339). timeEnd - timeStart must equal the batch resolution.
priceNon-negative price per kWh in the parent tariff's currency. Up to 4 decimal places.
DynamicTariffPrice
timeStartInclusive start of the price interval (UTC, RFC 3339)
timeEndExclusive end of the price interval (UTC, RFC 3339)
pricePrice per kWh in the parent tariff's currency, with up to 4 decimal precision
resolutionTime granularity of the price entry
sourceWhere the price came from. dagster denotes Monta-ingested DSO data, manual denotes a partner upsert, dso-import denotes a one-off DSO file import.
idId of the dynamic price entry
tariffIdId of the parent tariff (always a DYNAMIC tariff)
EInvoice
idId of the e-invoice
walletIdId of the wallet the e-invoice was issued from
invoiceNumberSerial number carried on the transmitted document
documentTypeWhether the document was issued by the seller or self-billed by the buyer
issueDateDate the document was issued
currencyCodeISO 4217 currency of every amount on the document
netAmountTotal excluding VAT, in major units
vatAmountTotal VAT, in major units
grossAmountTotal including VAT, in major units
periodFromStart of the period the document covers
periodToEnd of the period the document covers
The other party on the document — the buyer on an invoice, the seller on a self-billed invoice
Delivery state of the document on the e-invoicing network
EInvoiceDetail
idId of the e-invoice
walletIdId of the wallet the e-invoice was issued from
invoiceNumberSerial number carried on the transmitted document
documentTypeWhether the document was issued by the seller or self-billed by the buyer
issueDateDate the document was issued
currencyCodeISO 4217 currency of every amount on the document
periodFromStart of the period the document covers
periodToEnd of the period the document covers
Line items on the document
Document totals, in major units
VAT breakdown, one entry per rate and category
noteFree-text note carried on the document
Party that issued the document
Party the document was issued to
Delivery state of the document on the e-invoicing network
EInvoiceIdentifier
schemeIdentifier scheme, as used on the e-invoicing network
idIdentifier value within the scheme
EInvoiceLine
idId of the line
itemNameName of the item charged for
quantityQuantity charged for, in unitCode units
unitCodeUN/ECE Recommendation 20 code for the unit quantity is measured in
unitPricePrice per unit excluding VAT, in major units
netAmountLine total excluding VAT, in major units
VAT applied to the line
itemDescriptionLonger description of the item charged for
EInvoiceLineTax
taxPercentVAT rate applied, as a percentage
taxCategoryVAT category applied
countryCodeISO 3166-1 alpha-2 country whose VAT rules apply
EInvoiceParty
ownerTypeType of owner: operator, team
ownerIdId of the owner, either a teamId or an operatorId depending on ownerType
companyNameRegistered company name
countryCodeISO 3166-1 alpha-2 country of registration
Tax and routing identifiers registered for the party
EInvoiceSubmission
statusDelivery state of the document on the e-invoicing network
errorDetailsWhy the submission failed, when status is FAILED
submittedAtWhen the document was handed to the network
deliveredAtWhen the network confirmed delivery to the buyer
paymentLifecycleStatusLatest payment state the buyer reported back over the network
paymentLifecycleStatusAtWhen the buyer reported paymentLifecycleStatus
EInvoiceTaxSubtotal
taxPercentVAT rate applied, as a percentage
taxCategoryVAT category applied
countryCodeISO 3166-1 alpha-2 country whose VAT rules apply
taxableAmountAmount the rate was applied to, in major units
taxAmountVAT charged at this rate, in major units
EInvoiceTotals
netAmountTotal excluding VAT, in major units
vatAmountTotal VAT, in major units
grossAmountTotal including VAT, in major units
EReport
idMonta's id for the e-report
typeCodeIN for an initial declaration, RE for a rectificative that restates it in full
revisionRevision of the declaration for this window. A rectificative restates the whole window, so only the highest revision is current.
periodFromStart of the declaration window, inclusive
periodToEnd of the declaration window, exclusive
Domestic B2C sales, aggregated per day, category and rate
Cross-border sales, declared one invoice at a time
documentIdThe id DGFiP assigned to the declaration. Null until the declaration is accepted.
statusTransmission status of the declaration
errorDetailsWhy the transmission failed, present when status is FAILED
submittedAtWhen the declaration was transmitted
deliveredAtWhen DGFiP acknowledged the declaration
The declarant this e-report was filed for
EReportB2cCategory
Whether a domestic B2C line declares goods or services
EReportB2cLine
dateDay the sales were made
categoryWhether the line declares goods or services
currencyCodeCurrency of the amounts on this line
transactionCountHow many transactions the line aggregates
netAmountNet amount, in major units
vatAmountVAT amount, in major units
The line split by VAT rate
EReportB2cTaxSubtotal
vatPercentageVAT rate applied, as a percentage
netAmountNet amount at this rate, in major units
vatAmountVAT amount at this rate, in major units
transactionCountHow many transactions fell at this rate
EReportCrossBorderInvoice
invoiceNumberInvoice number as issued
issueDateDate the invoice was issued
currencyCodeCurrency of the amounts on this invoice
buyerNameRegistered name of the buyer
buyerCountryCodeCountry the buyer is registered in
buyerIdentifierSchemeIdentifier scheme the buyer was identified by
buyerIdentifierValueIdentifier value the buyer was identified by
netAmountNet amount, in major units
vatAmountVAT amount, in major units
The invoice split by tax category and rate
EReportCrossBorderTaxSubtotal
taxCategoryTax treatment applied to this portion
vatPercentageVAT rate applied, as a percentage
netAmountNet amount at this rate, in major units
vatAmountVAT amount at this rate, in major units
EReportDeclarant
ownerTypeWhether the declarant is a team or an operator
ownerIdId of the declarant
companyNameRegistered company name of the declarant
countryCodeCountry the declarant is registered in
Registration identifiers held for the declarant
EReportDeclarantRef
ownerTypeWhether the declarant is a team or an operator
ownerIdId of the declarant, to pass as ownerId when listing e-reports
EReportIdentifier
schemeIdentifier scheme
idIdentifier value
EReportTypeCode
IN for an initial declaration, RE for a rectificative that restates it in full
EinvoicePaymentLifecycleStatus
ElectricCurrentType
definitions:
ac- Indicates the charge point useac(alternating current) as electric current.dc- Indicates the charge point useac(direct current) as electric current.other- Indicates the team member has only access to the selected charge points.
EnergyMeterValues
measuredAtcurrentL1AcurrentL2AcurrentL3AvoltageL1VvoltageL2VvoltageL3VpowerL1WpowerL2WpowerL3WpowerWEnergyMix
isGreenEnergyIndicates if the energy is green
List of energy sources with their category and percentage
List of environmental impacts for this energy mix
supplierNameName of the energy supplier
energyProductNameName of the energy product
EnergyMixRequest
isGreenEnergyWhether the site's electricity comes from renewable sources. true is a claim that has to be backed up in the same energy mix by at least one of: supplier_name, energy_product_name, or energy_sources with percentages adding up to 100. Blank names and partial source lists don't count, and the request is rejected with a 422. false or null needs no other fields.
List of energy sources with their category and percentage
List of environmental impacts for this energy mix
supplierNameName of the energy supplier
energyProductNameName of the energy product
EnergySource
sourceEnergy source category
percentagePercentage of this energy source
EnergySourceCategory
EnergySourceItem
sourceEnergy source category
percentagePercentage of this energy source (0–100)
EnergySourceRequest
sourceEnergy source category
percentagePercentage of this energy source (0–100)
EnergyVehicleListItem
vehicleIdTagtypesiteIdsiteNameoperatorIdvehicleIdbatteryCapacityKwhmaxKwAcmaxKwDcintegrationCapacityKwhEnode
vendorTypedeviceIdvendorNameEnodeIntegrationResult
EnodeRegistrationLinkResult
resultlinktokenEnodeRegistrationLinkResult.EnodeLinkResult
Enode_1
resultEnode_2
vendorTypeEnvironmentalImpact
categoryCategory of the environmental impact.
amountAmount of environmental impact
EnvironmentalImpactCategory
EnvironmentalImpactItem
categoryCategory of the environmental impact
amountAmount of environmental impact
EnvironmentalImpactRequest
categoryCategory of the environmental impact
amountAmount of environmental impact
Evse
chargingStationIdentityconnectorIdphaseSetupzeroAllowedloadManagementDisabledminPowerWmaxPowerWminCurrentAmaxCurrentAphpChargerIdrampUpProtectionStateexternalPowerLimitWexternalPowerLimitExpiresAtocppStatusocppStatusAtEvseAllocationSeries
evseIdtimeallocatedPowerWallocatedCurrentAEvseAllocations
EvseStateHistoryResponse
startAtendAtEvseStateItem
chargePointIdentityconnectorIdstateEvseStateMeasurement
timestampExceptionalPeriod
periodBeginExceptional period begin in HH:mm format (e.g. 08:00)
periodEndExceptional period end in HH:mm format (e.g. 17:00 or 00:00 for end of day)
ExceptionalPeriodRequest
periodBegin^\d{4}-\d{2}-\d{2}T\… · requiredPeriod begin in ISO 8601 datetime format
periodEnd^\d{4}-\d{2}-\d{2}T\… · requiredPeriod end in ISO 8601 datetime format
ExemptState
percentagePercentage of the time spent in exempt state
durationDuration in exempt state (in seconds)
FeatureCatalog
typeType of the feature catalog.
nameName of the feature catalog.
FeatureGroupConfiguration
idId of the feature group configuration.
Feature catalog.
featureConfigurationFeature configuration.
FeatureGroupDto
idId of the feature group.
nameName of the feature group.
FilterMatchCount
countHow many charge points the filter definition matches right now.
FilterMatchCountRequest
The filter definition to preview, in the same shape a FILTER list stores it.
FiscalChorusProRequest
serviceCodeRequiredtrue if this public-sector customer requires a service code on invoices sent through Chorus Pro.
serviceCodeThe Chorus Pro service code that routes invoices to the right department. Leave empty if none is required.
FiscalDeclarationRequest
issuanceScopeWhich wave of France's mandatory e-invoicing rollout the company belongs to (the company declares this itself):
IN_SCOPE_2026— large and mid-size companies, required to issue e-invoices from September 2026.IN_SCOPE_2027— small and very small companies, required from September 2027.OUT_OF_SCOPE— the company is not covered by the mandate.
FiscalRegistrationRequest
The company's own declaration about when it must start using mandatory e-invoicing. Required.
vatPaymentBasisWhen the company owes VAT to the tax authority:
ENCAISSEMENTS— once the customer pays the invoice (the usual French default).DEBITS— as soon as the invoice is issued, even if not yet paid. Leave empty for VAT-exempt companies.
vatGroupIdIf several related companies file VAT together as a single taxable entity (a French "assujetti unique" VAT group), this is that group's identifier. There is no default value — leave it empty if the company is not part of such a group.
legalFormCodeThe company's legal form, as a 4-digit code from the French national business registry (INSEE "catégorie juridique"). For example, 5710 is a simplified joint-stock company (SAS). The first digit gives the broad type: 1 = sole trader, 5 = commercial company, 7 or 4 = public body, 9 = association.
vatExemptionReasonCodeIf the company is exempt from VAT, this is the standard code (from the European e-invoicing standard EN 16931) that says why, and it is required whenever an exemption applies. Possible values:
VATEX-FR-FRANCHISE— small business below the French turnover threshold (franchise en base).VATEX-EU-132-1A— postal services provided by the public postal operator (La Poste).VATEX-EU-132-1B— hospital and medical care provided by public bodies.VATEX-EU-132-1C— medical and paramedical care provided directly by healthcare professionals.VATEX-EU-132-1D— supply of human organs, blood and breast milk.VATEX-EU-132-1E— services and dental prostheses supplied by dental technicians.VATEX-EU-132-1G— services closely linked to welfare and social-security work.VATEX-EU-132-1H— services closely linked to the protection of children and young persons.VATEX-EU-132-1I— school, university or vocational education provided by certified bodies.VATEX-EU-132-1J— private tuition given independently by teachers, covering regular school curricula.VATEX-EU-135-1A— insurance and reinsurance, including related broker services.VATEX-EU-135-1B— granting, negotiating and managing credit or loans.VATEX-EU-135-1C— managing bank accounts, deposits, debts and payments.VATEX-EU-135-1D— transactions in currency, bank notes and cash conversion.VATEX-EU-135-1E— transactions in shares, bonds, company interests and other securities.VATEX-EU-135-1K— financial leasing or long-term letting of residential real estate.
routingIdentifier^\d{9}(_[A-Za-z0-9._…Where the company wants to receive its electronic invoices. Leave it empty and invoices go to the company as a whole, addressed to its SIREN — which is what most companies want. Set it to send invoices to one particular place instead:
- the whole company — the 9-digit SIREN on its own, e.g.
840227060. - one establishment — the SIREN, an underscore, then that site's 14-digit SIRET, e.g.
840227060_84022706000012. - one department — the SIREN, an underscore, then a code the company chooses, e.g.
840227060_SERVICEACHATS.
Always send the full value including the SIREN, and it must be this company's own SIREN — send compliance_identifiers.FR_SIREN in the same request so it can be checked. After the underscore you may use letters, digits, dots, hyphens and underscores, up to 115 characters. A 14-digit code after the underscore is read as a SIRET and must be a real SIRET of this company.
Settings for Chorus Pro, the French government portal used to send invoices to public-sector customers. Only relevant if the company invoices public bodies.
ForecastItem
timestampforecastPowerKwisPowerEnoughForChargingFullTariff
tariff
list of the tariff prices
Price specification
FuseProtectionOperationalState
FuseProtectionSettings
fuseProtectionEnabledfuseLimitCurrentAfuseSafetyMarginCurrentAfuseProtectionNotificationEnableddataSourcechangedAtFuseProtectionSettingsUpdate
fuseProtectionEnabledfuseLimitCurrentAfuseSafetyMarginCurrentAfuseProtectionNotificationEnableddataSourcechangedAtFuseProtectionState
fuseProtectionOperationalStatelastDataAtGenericPaymentSession
providerThe provider of the payment session
externalIdThe external id of the payment session. Allows retrieving receipts via receipt.monta.com by using date and externalId or cardLast4.
partnerExternalIdExternal Id of this entity, managed by you.
cardBrandThe brand of the card used for the payment session
cardLast4The last 4 digits of the card used for the payment session. Allows retrieving receipts via receipt.monta.com by using date and externalId or cardLast4.
amountThe amount of the payment session. Negative amounts will be rejected by the API
GracePeriod
startTimeStart time for the grace period
endTimeEnd time for the grace period
GridConnectionType
GridServiceProviderFeedbackMessages
configurationSavedmeterIdUpdatedsubscribeSuccessunsubscribeSuccessGridServiceProviderMeterId
statuslabelidtitlesubtitledescriptionformatRegexformatDescriptionformatHintrequiredLabelinvalidFormatLabelGridSubscriptionV2
statustitledescriptiongridPartnerstatusReasonteasertermstermsAgreementsmartMeterConsentTitlesmartMeterConsentTextsmartMeterConsentAgreementstatusLabelGridTariff
externalIdExternal id of the tariff
nameName of the tariff
descriptionDescription of the tariff
zipCodesZip codes covered by this tariff
tariffTypeType of the tariff
timeZoneTime zone of the tariff
areaArea of the tariff
createdAtCreation date of the tariff
Period groups with pricing schedules
idId of the tariff
countryIdCountry Id of the tariff
countryAreaIdCountry area Id of the tariff
currencyIdCurrency Id of the tariff
pricesWithVatIndicates if VAT is already in the price of the tariff
activeIndicates if the tariff is active
customerTypeCustomer type of the tariff
updatedAtLast update date of the tariff
GridTariffPeriodGroup
activeFromStart date when this period group becomes active
activeToEnd date when this period group stops being active
descriptionDescription of the period group
Recurring periods within this period group
idId of the period group
GridTariffRecurringPeriod
dayOfWeekDay of the week when this period starts
pricePrice for this period in the tariff's currency
idId of the recurring period
endDayOfWeekDay of the week when this period ends (null if same as start)
startHourHour when this period starts (0-23)
endHourHour when this period ends (0-24)
startMinuteMinute within startHour when this period starts (0, 15, 30 or 45)
endMinuteMinute within endHour when this period ends (0, 15, 30 or 45; 0 when endHour is 24)
isHolidayWhether this period applies to holidays
rateNameName of the rate
HdvParkingSpot
heightHeight in centimeters
widthWidth in centimeters
lengthLength in centimeters
weightWeight in kilograms
angledOrientationAngled orientation
driveThroughOrientationDrive-through orientation
parallelOrientationParallel orientation
perpendicularOrientationPerpendicular orientation
turningRadiusTurning radius in meters
cpPositioncpPosition, if any
HistoricalMeterValuesData
timecurrentL1AcurrentL2AcurrentL3AvoltageL1VvoltageL2VvoltageL3VpowerL1WpowerL2WpowerL3WpowerWkwhsocHomeState
teamIdoperatorIdHomeStateDto
teamIdoperatorIdHours
twentyFourSevenIs the location open 24/7?
List of regular weekly opening hours
List of exceptional opening periods
List of exceptional closing periods
IdleFeeComponentMetadata
typeThe type of this metadata entry
fromThe starting date for when the idle fee started to count
toThe end date for when the idle fee stopped counting
amountPerMinuteThe idle fee per minute for this metadata entry
minutesFor how long the the charge stayed idle after fully charged
InstallerJob
The operator of this installer job
publicLinkPublic link of this installer job, shareable with the installer
List of tasks of this installer job
createdAtDate this installer job was created
idId of this installer job
siteIdId of the site related to this installer job
teamIdId of the team of this installer job
descriptionDescription of this installer job, will be visible to the installer
chargePointCountNumber of charge points included in this installer job
chargePointActiveCountNumber of active (finished) charge points in this installer job
emailEmail of the installer assigned to this job.
completedAtDate this installer job was completed
updatedAtDate this installer job was updated
deletedAtDate this installer job was deleted
InstallerJobTask
createdAtCreation date of this installer job task
idId of this installer job task
installerJobIdId of the installer job of this installer job task
chargePointIdId of the charge point to install
serialNumberSerial number of the charge point to install
connectorConnector ID of the charge point to install
noteNote of this installer job task, will be visible to the installer
installerNoteNote provided by installer during this installer job task
activeAtDate this installer job task was active
updatedAtDate this installer job task was last updated
deletedAtDate this installer job task was deleted
IntegrationsSetupRequest
homeIdentityfeatureIntegrationsUpdate.SolarPanel
peakPowerKwdeclinationazimuthcurrentProductionInvoiceDto
idId of the invoice
displayNumberHuman-readable invoice number shown on the PDF and in Monta Hub. For invoices issued after the sequencing rollout this is the official serial number (e.g. 3508-2026-6577); older invoices fall back to the stringified id.
walletIdId of the wallet
fromInvoice from date
toInvoice to date
totalPayableBalanceTotal payable balance
Currency
statusstatus of the invoice
createdAtInvoice creation date
dueAtInvoice due date
approvedAtThe date it was approved
totalStatementTotal statement
pdfUrlURL to the invoice PDF
InvoiceRequest
idId of the invoice request
statusStatus of the invoice request
requestedAtThe timestamp when the invoice request was created
approvedAtThe timestamp when the invoice request was approved
rejectedAtThe timestamp when the invoice request was rejected
rejectionReasonThe reason for rejecting the invoice request
updatedAtThe timestamp when the invoice request was last updated
Issue
idId of the issue.
typeThe issue-type token.
What an alert or issue is about.
statusCurrent status of the issue.
operatorIdId of the operator this issue belongs to.
teamIdId of the team this issue is scoped to, when service-alerts exposes it. Null today.
siteIdId of the site this issue is scoped to, when service-alerts exposes it. Null today.
eventCountNumber of events attached to this issue.
firstEventAtEarliest event on this issue, if any.
lastEventAtMost recent event on this issue, if any.
resolvedAtWhen this issue was resolved, if it has been.
IssueDetail
idId of the issue.
operatorIdtypeWhat an alert or issue is about.
statuseventCountDay-bucketed event counts for this issue.
Events attached to this issue, most recent first.
teamIdsiteIdfirstEventAtlastEventAtresolvedAtIssueSourceBreakdown
dimensionStable machine key for this dimension.
titleHuman-readable label for this dimension.
IssueSourceEntry
labelThe raw grouped value.
countNumber of events in this row.
assetTypeOpen-vocabulary asset type, if this row denotes a Monta entity.
assetIdOpaque id of the asset; not necessarily numeric.
IssueSources
KafkaEventType
KwhConsumption
timeTime interval
valueThe amount of energy consumed (in kWh) during the corresponding time interval
KwhPerTime
timeStart time for the sum of the kWh
valueSum of kWh
Location
Coordinates (lat, lng)
addressLabelThe full address.
Address
LocationDto
latitudeLatitude of the vehicle
longitudeLongitude of the vehicle
updatedAtLocation was last updated at
MapResult
Charge points in that area not belonging to a site. A charge point that belongs to a site is never returned here, at any zoom level - it is represented by its site in sites instead, so that one location shows as a single pin rather than a stack of pins. To list the charge points inside a site, call GET /charge-points?siteId={id}.
Sites in that area. A site groups several charge points at one location, and is returned in place of those charge points. chargePointCount tells you how many it contains.
Clusters (of charge points and sites) in that area. Only returned below zoom 14; from zoom 14 upwards the individual chargePoints and sites entries are returned instead.
MapResultChargePoint
visibilityIndicates if this charge point is public or private
Location information for this charge point
List of supported connector types at this charge point (e.g. type-2, ccs, ...)
Deeplinks to open charge screen in Monta app or web.
idId of this charge point
siteIdId of the site
nameName of the site
maxKwMax KW available at this charge point.
typeType of charge point (AC / DC)
noteA note you have entered for this charge point, e.g. via our Portal.
stateChargepoint state
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
MapResultCluster
Coordinates of the cluster
countNumber of entities (Charge points and sites) clustered.
MapResultSite
nameName of the site
visibilityIndicates if this site is public or private
Location information for this site
List of supported connector types at this site (e.g. type-2, ccs, ...)
idId of the site
chargePointCountNumber of charge points at this site
maxKwMax KW available at this site.
typeType of charge points at this site (AC / DC)
noteA note you have entered for this site, e.g. via our Portal.
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
Message
idId of the message.
bodyThe message body.
The channels the message was sent on.
Per-channel delivery status. Populated asynchronously after send, so channels may be absent immediately after sending.
createdAtWhen the message was created.
userIdId of the user the message was sent to.
subjectSubject / title, if one was set.
actionUrlDeep link carried by the message, if any.
readAtWhen the recipient read the message, or null if unread.
MessageChannels
webInboxDeliver to the user's in-app inbox.
mobilePushDeliver as a mobile push notification.
emailDeliver as an email.
smsDeliver as an SMS.
MessageDeliveryResults
In-app inbox delivery.
Mobile push delivery.
Email delivery.
SMS delivery.
MessageDeliveryStatus
statusDelivery status.
atWhen this status was recorded.
MetadataDto
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
typeThe type of this metadata
idThe id of the the tax refund
kwhThe total kwh for the tax refund
chargeIdThe reference to chargeId for the tax refund
Meter
typeMeterProperties
meterUuidchargePointIdentityisReceivingDatatimeoutSecondsmeterIdentifierdigitalInputNumberdigitalInputActiveLevellastDi1lastDi2lastDiAtmqttTopictopicPrefixMeterValues
measuredAtcurrentL1AcurrentL2AcurrentL3AvoltageL1VvoltageL2VvoltageL3VpowerL1WpowerL2WpowerL3WpowerWkwhsoccurrentDcAvoltageDcVpowerDcWMoney
amountThe amount of money
Currency
localeCurrent user locale
MontaAppResponse
statusHTTP status of the response
originName of the service that generated this response
environmentEnvironment where this response was generated
statusCodeNumeric HTTP status code
messagePrimary response message for developers/logging
localizedMessageUser-friendly message that can be displayed to end users
errorCodeOptional error code for categorizing errors
Additional metadata related to the response
Detailed validation errors for form fields
MontaAppResponse.ErrorDetail
fieldName of the field that failed validation
List of validation issues for the field
MontaAppResponse.ErrorDetail.Body
messageError message describing the validation issue
MontaHttpStatus
HTTP status codes used in Monta API responses
MontaMqttMeterIntegration
meterUuidtimeoutSecondsMontaPage.Meta
itemCountcurrentPageperPagetotalPageCounttotalItemCountNestedTeam
Parent team, the one who sends the invite
userRoleThe role assigned to the nested team
accessAccess to parent team CPs / sites: to all or selected charge points and/or sites
stateState of the nested team invitation
createdAtDatetime of the creation of nested team invite
idId of the nested team relation
Parent team, the one who receives the invite
Price group applied to the nested team
User who requested the invitation
selectedChargePointIdsSelected charge points nested team has access to
noteInternal note for this nested team
updatedAtDatetime of the update of nested team invite
invitedAtDatetime nested team was invited
NestedTeamInvite
parentTeamIdId of the parent team, the one who sends the invite
nestedTeamIdId of the nested team, the one who receives the invite
priceGroupIdPrice group applied to the nested team
accessIs access granted to all or selected charge points and sites
selectedChargePointIdsList of charge point ids nested team access will be assigned to
selectedSiteIdsList of site ids nested team access will be assigned to
Node
idnamefuseLimitApowerLimitWbufferAexternalPowerLimitWexternalPowerLimitExpiresAtmaxExpectedResidualCurrentAmaxExpectedResidualPowerWNodeThresholds
timefuseLimitAbufferApowerLimitWOcpiChargeProtocolData
cdrIdThe unique identifier assigned to the charge data record (CDR)
emspAuthIdThe eMSP auth id (contract id) of the roaming driver that authorized the charge, stable across that driver's sessions
OdometerReading
idId of the odometer reading
chargeIdId of the charge the reading belongs to
odometerKmOdometer reading in whole kilometres
readingAtWhen the reading was taken (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
sourceWhere the reading came from
sourceLabelHuman-readable label for source
capturePhasePoint in the charge lifecycle the reading was captured at. Readings you push are always manual.
confidenceHow trustworthy the value is: verified for a Monta vehicle integration, declared for anything a human or a partner reported
confidenceLabelHuman-readable label for confidence
editableTrue only for readings you pushed yourself. Readings from a vehicle integration, the driver app or the operator hub are another party's evidence and cannot be patched or deleted.
vehicleIdId of the vehicle the reading was taken from. Null when the charge has no vehicle assigned.
sourceRefYour own identifier for this reading, echoed back as you sent it
createdAtWhen the reading was recorded (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
OffsetBasedResponse
OffsetBasedResponse_1
OffsetBasedResponse_10
OffsetBasedResponse_11
OffsetBasedResponse_12
OffsetBasedResponse_13
OffsetBasedResponse_14
OffsetBasedResponse_15
OffsetBasedResponse_16
OffsetBasedResponse_17
OffsetBasedResponse_18
OffsetBasedResponse_19
OffsetBasedResponse_2
OffsetBasedResponse_20
OffsetBasedResponse_21
OffsetBasedResponse_22
OffsetBasedResponse_23
OffsetBasedResponse_24
OffsetBasedResponse_25
OffsetBasedResponse_26
OffsetBasedResponse_27
OffsetBasedResponse_28
OffsetBasedResponse_29
OffsetBasedResponse_3
OffsetBasedResponse_30
OffsetBasedResponse_31
OffsetBasedResponse_32
OffsetBasedResponse_33
OffsetBasedResponse_34
OffsetBasedResponse_35
OffsetBasedResponse_36
OffsetBasedResponse_37
OffsetBasedResponse_38
OffsetBasedResponse_39
OffsetBasedResponse_4
OffsetBasedResponse_40
OffsetBasedResponse_41
OffsetBasedResponse_42
OffsetBasedResponse_43
OffsetBasedResponse_44
OffsetBasedResponse_45
OffsetBasedResponse_46
OffsetBasedResponse_47
OffsetBasedResponse_48
OffsetBasedResponse_49
OffsetBasedResponse_5
OffsetBasedResponse_50
OffsetBasedResponse_51
OffsetBasedResponse_52
OffsetBasedResponse_53
OffsetBasedResponse_54
OffsetBasedResponse_55
OffsetBasedResponse_56
OffsetBasedResponse_57
OffsetBasedResponse_58
OffsetBasedResponse_59
OffsetBasedResponse_6
OffsetBasedResponse_60
OffsetBasedResponse_61
OffsetBasedResponse_62
OffsetBasedResponse_63
OffsetBasedResponse_64
OffsetBasedResponse_65
OffsetBasedResponse_66
OffsetBasedResponse_67
OffsetBasedResponse_68
OffsetBasedResponse_69
OffsetBasedResponse_7
OffsetBasedResponse_70
OffsetBasedResponse_71
OffsetBasedResponse_72
OffsetBasedResponse_73
OffsetBasedResponse_76
OffsetBasedResponse_8
OffsetBasedResponse_9
OicpChargeProtocolData
sessionIdThe unique identifier of the session
OnboardingProfile
nameName of the profile, unique per operator
The onboarding steps a linked team receives, as {step, config?, displayMode?} entries.
idId of this onboarding profile
operatorIdId of the operator this profile belongs to
descriptionDescription of the profile
enabledWhether the profile can be assigned to teams
inUseCountNumber of teams currently linked to this profile
Welcome screen text overrides applied to linked teams; null when not configured.
createdAtCreation date of this profile
updatedAtDate this profile was last updated
OnboardingStep
stepThe onboarding step key. Present in the list means the step is enabled for the team.
configOptional per-step configuration, interpreted by the step. SETUP_CHARGING_RULE: the charging rule type, one of scheduled, smart. ADD_TEAM_MEMBER: the member type the invite creates, one of member, admin; null/absent keeps the app's native invite flow, which picks the role. Null/absent for all other steps.
displayModeHow the app presents the step: full_screen (default) or waiting_step (a passive card). waiting_step is rejected for SETUP_CHARGING_RULE. Absent/null defaults to full_screen.
OnboardingWelcomeSlot
modecustom shows text, follows reuses another slot's text, default uses Monta's copy.
textCustom text, used when mode is custom.
followsSlot whose text to reuse, used when mode is follows.
OnboardingWelcomeText
enabledWhether the welcome text overrides are shown.
typeWelcome screen flavour. Required when enabled is true.
Per-charger-state text overrides, keyed by slot (e.g. ready). Omitted slots use Monta's default copy.
OnboardingWelcomeTextSlot
modecustom shows text, follows reuses another slot's text, default shows Monta's copy.
textThe operator's text (max 200 characters). Required when mode is custom.
followsThe slot whose text to reuse. Required when mode is follows.
OnboardingWelcomeText_1
enabledWhether the operator's own text is active. false reverts the app to Monta's default copy.
typeWhich onboarding flow the text is written for: home (private charger, one slot per charger state) or public / semi_public (shared chargers, the single shared_chargers slot). Required when enabled is true.
Override per slot. Keys: no_charger, awaiting_installation, ready (home) or shared_chargers (public/semi_public). A slot left out uses Monta's default copy. Required on writes: the map replaces the saved one.
OpeningHour
Opening times for the location
chargingWhenClosedIndicates if charging is allowed when closed
OpeningHoursRequest
Opening times for the location
chargingWhenClosedIndicates if charging is allowed when closed
OpeningTimesRequest
twentyFourSevenIs the location open 24/7?
List of regular weekly opening hours
List of exceptional opening periods
List of exceptional closing periods
Operator
nameName of operator
identifierIdentifier of operator
idID of the operator
partnerIdId of the partner
vatNumberVAT number
OperatorAdjustmentTransaction
fromWalletIdId of the wallet to transfer from
toWalletIdId of the wallet to transfer to
noteNote for the transaction
currencyIdCurrency identifier
amountAmount to transfer
partnerExternalId**Note: This has been deprecated and will be null always.**External Id of this entity, managed by you.
**Note: This has been deprecated and will be null always.**Custom JSON payload for this entity, managed by you.
OperatorList
idId of the operator list.
operatorIdId of the operator that owns this list.
nameName of the operator list.
sourceOrigin of the list. partner for lists created via the Monta API.
itemCountTotal number of items in the list.
Per-entity-type breakdown of the item count, keyed by entity type.
descriptionFree-text description of the operator list.
listTypeThe single entity type a homogeneous list is restricted to. null for mixed lists that can hold multiple entity types.
createdByUserIdId of the user who created the list, when known.
createdAtWhen the list was created (ISO-8601).
updatedAtWhen the list was last updated (ISO-8601).
syncModeReconciliation mode of a FILTER list; null for a manually-curated list.
The saved filter a FILTER-source list resolves its membership from; null for a manual list.
lastSyncedAtWhen the list was last reconciled (ISO-8601); null if it never has been.
lastSyncStatusStatus of the last reconciliation.
The reconcile run kicked off by creating or editing the filter, to poll; null otherwise.
OperatorListItem
idId of the operator list item.
entityTypeType of the referenced entity.
entityIdId of the referenced entity.
labelHuman-readable label for the referenced entity, when available.
addedAtWhen the item was added to the list (ISO-8601).
OperatorListItemRef
entityTypeType of the referenced entity.
entityIdId of the referenced entity.
OperatorListSyncMode
Reconciliation mode of a filter list. The Partner API only accepts `AUTO` (changes are applied automatically); `MANUAL` can appear on a list created through the Hub and is therefore representable on reads.
OperatorListSyncRun
idId of the sync run.
listIdId of the list this run reconciled.
statusStatus of the run.
triggerWhat triggered the run.
matchedCountHow many entities the filter matched. Null until the run finishes.
addedCountHow many members were added. Null until the run finishes.
removedCountHow many members were removed. Null until the run finishes.
proposedCountHow many changes were proposed. Null until the run finishes.
excludedSkippedCountHow many candidates were skipped because they are excluded. Null until the run finishes.
errorMessageError message when the run failed.
startedAtWhen the run started (ISO-8601).
finishedAtWhen the run finished (ISO-8601).
createdAtWhen the run was created (ISO-8601).
updatedAtWhen the run was last updated (ISO-8601).
The charge-point ids behind each outcome tally, keyed by outcome. Only returned by the single-run endpoint.
OperatorListType
OperatorTeamSetting
idId of the account template, as accepted by operatorTeamSettingId on team update
nameName of the account template
defaultPage_TariffRecurringPeriodDto_
pageNumberoffsetsizeemptynumberOfElementstotalSizetotalPagesPageable
numbermodeParkingType
PartialAddress
address1First line of address
address2Second line of address
address3Third line of address
zipZip-code
cityCity (readable)
provinceProvince
countrySubdivisionCodeISO 3166-2 country subdivision code
countryCountry (readable)
countryAreaIdCountry area id
ParticipationHistoryMessage
idtitlebodybutton_textstart_timeend_timeParticipationHistoryRecord
idstart_timekwhpayoutpayout_labelParticipationHistoryReport
subtitletotal_kwhtotal_payouttotal_kwh_labeltotal_payout_labelregistered_only_reasoninfo_urlPatchCharge
For Partners who want to start charging from payment terminals, kiosks etc. Used to link charge transaction against your billing and to allow users retrieving receipts via receipt.monta.com by using date and genericPaymentSession.externalIdor genericPaymentSession.cardLast4.
Note: This field is optional, but if provided, you need to provide the full data, since it will be overwritten with values from this object.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
PatchChargeAuthToken
teamIdId of the team the charge auth token belongs to
userIdId of the user the charge auth token should be associated to
vehicleIdId of the vehicle to link to this charge auth token
nameName of the charge auth token
montaNetworkIf the charge auth token should be active in the Monta network
roamingNetworkIf the charge auth token should be active in the Roaming network
operatorNetworkIndicates that the charge auth token can be used on other teams charge points underthe same operator
activeUntilIndicates until when this charge auth token is active, null means indefinitely.
Note: Use ../block and ../unblock endpoints to (un)block a charge auth token.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
costCenterIdId of the cost center to assign to the charge auth token. Send null to clear the assignment; omit the field to leave it unchanged.
rollingSpendLimitMaximum cumulative spend allowed on this charge auth token over a rolling 30-day window, as a plain decimal amount in the currency of rollingSpendLimit on read (currently always EUR). Omit the field to leave it unchanged. Must be strictly positive, and may not exceed the cap that applies to the owning operator — a request above the cap is rejected. Send null to remove the limit; this is only accepted when no cap applies, otherwise null is rejected and a value up to the cap is required.
dailyChargeCountLimitMaximum number of charges this charge auth token may start in a rolling 24-hour window. Omit the field to leave it unchanged. Must be strictly positive, and may not exceed the cap that applies to the owning operator. Send null to remove the limit; this is only accepted when no cap applies, otherwise null is rejected and a value up to the cap is required.
concurrentChargesLimitMaximum number of concurrent active charges this charge auth token may have. Omit the field to leave it unchanged. Must be strictly positive, and may not exceed the cap that applies to the owning operator. Send null to remove the limit; this is only accepted when no cap applies, otherwise null is rejected and a value up to the cap is required.
PatchChargeKeyLimitCap
rollingSpendLimitCap on a charge key's rolling 30-day spend, as a plain decimal amount in the currency of rollingSpendLimit on read (currently always EUR). Send null to remove the cap (the recommended value then applies); omit the field to leave it unchanged. Must be strictly positive and may not exceed max.
dailyChargeCountLimitCap on a charge key's daily charge count. Send null to remove the cap; omit the field to leave it unchanged. Must be strictly positive and may not exceed max.
concurrentChargesLimitCap on a charge key's concurrent charges. Send null to remove the cap; omit the field to leave it unchanged. Must be strictly positive and may not exceed max.
PatchChargePoint
siteIdId of the site the charge point belongs to.
nameName of the charge point.
maxKwMax Kw (Max Power) the charge point can output.
visibilityVisibility type of the charge point.
typeElectric current type the charge point support.
activeIndicates the charge point is active.
showOnMapCode
Ids of the connectors this charge point support.
noteA note (instructions, warning, information) you have entered for this charge point
latitudeCode
longitudeCode
partnerExternalIdExternal Id of this entity, managed by you.
Code
meterIdMeter id of the charge point.
roamingIndicates if the charge point is roaming enabled.
roamingPriceGroupIdThe id of the roaming price group for this charge point.
Note: This field is required if the roaming field is set to true and the charge point doesn't have an associated roaming price group id.
smartChargeSetting^(off|optional|force…Code
userIdId of the user that owns this charge point. Can only be set or updated, not removed.
autoRegisterRfidWhether RFID tags are auto-registered when scanned at this charge point. Ignored unless RFID auto-registration is enabled for your operator.
Charge point metadata to update. Only the fields sent are changed.
PatchChargePointMetadata
motorcycleCompatibleMotorcycle-compatible charge point. Send null to clear.
Code
PatchChargePointSensor
typeType of the charge point sensor
chargePointIdThe charge point id to which this charge point sensor is assigned to
valueValue this sensor is reporting, this is sensor specific, this value is managed by you
valueUpdatedAtIndicates when the value for this sensor was last updated
externalIdExternal Id of this sensor, ideally it references the sensor id in your system
partnerExternalIdExternal Id of this entity, managed by you
PatchCostCenter
nameName of the cost center.
externalIdExternal Id of this cost center, managed by you.
descriptionDescription of the cost center.
PatchDeeplink
destinationTypeType of the destination the deeplink is pointing to
Destination details for the deeplink
commentOptional comment related to the deeplink
PatchDynamicPricesRequest
resolutionTime granularity that every entry's [timeStart, timeEnd) must conform to.
sourceOrigin of the price data.
Price-interval entries to upsert. Each entry's (timeStart, resolution) is the conflict key — a re-submitted entry updates price, timeEnd, and source in place. Max 5000 entries per request.
PatchGenericPaymentSession
providerThe provider of the payment session
externalIdThe external id of the payment session. Allows retrieving receipts via receipt.monta.com by using date and externalId or cardLast4.
partnerExternalIdExternal Id of this entity, managed by you.
cardBrandThe brand of the card used for the payment session
cardLast4The last 4 digits of the card used for the payment session. Allows retrieving receipts via receipt.monta.com by using date and externalId or cardLast4.
amountThe amount of the payment session. Negative amounts will be rejected by the API
PatchNestedTeam
priceGroupIdPrice group applied to the nested team
noteA note (instructions, warning, information) you have entered for this nested team member
selectedChargePointIdsList of charge point ids nested team access will be assigned to
PatchOdometerReading
odometerKmCorrected odometer reading in whole kilometres. Values outside 0-4000000 are rejected with 422.
readingAtCorrected time of the reading (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
sourceRefCorrected identifier for this reading. Maximum 128 characters. Omitted fields are left untouched, so an existing sourceRef can be overwritten but not cleared.
PatchOnboardingProfile
nameName of the profile, unique per operator.
descriptionDescription of the profile.
Note: Send null to clear it; omit the field to leave it unchanged.
enabledWhether the profile can be assigned to teams.
Replaces the full step set and re-applies it to every linked team. Omit to leave steps unchanged.
Replaces the welcome screen text overrides and re-applies them to linked teams. Omit to leave unchanged.
PatchOperator
nameUpdated name of the operator
emailPrimary contact email for the operator
financeEmailFinance / billing email for the operator
financeCommunicationEmailRecipient for important payment notices (late payment, freeze warning, frozen). When not set, these go to financeEmail.
PatchPriceGroupTag
nameName of the tag.
descriptionDescription of the tag.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
PatchSite
nameName of the site
Address of the site. Only countryId is mandatory. Address1, city, and zipCode must be provided together or all left null.
latitudeLatitude coordinate for the site location. When provided along with longitude, overrides geocoding from address.
longitudeLongitude coordinate for the site location. When provided along with latitude, overrides geocoding from address.
visibilityVisibility type of the site. Controls who can charge at the site: public means any Monta user can charge here, private restricts charging to team members / access-token holders. This field does NOT control whether the site appears on the consumer map — use showOnMap for that.
showOnMapWhether this site should be visible on the consumer map. This is independent of visibility — a private site can still be shown on the map, and a public site can be hidden.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site. Omit to leave the current value untouched.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
Metadata for the site including amenities, energy mix, opening hours, site developer, and pictures.
noteA free-text note for this site, visible in the app.
PatchSponsoredChargePoint
priceGroupIdThe price group for this sponsorship, Only price groups of type reimbursement or sponsored are allowed
Note: if the priceGroupId is null the charge point cost price group will be used instead, if the charge point has no cost price group set the request will fail
payoutScheduleThe payout schedule for this sponsored charge point
payForSubscriptionsIndicates that company pay for subscriptions
autoApproveElectricityCostWhen true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review.
noteNote for the sponsored charge point
sendEmailNotificationWhether to email the charge point owner that their reimbursement settings changed. Defaults to true. Set to false to suppress it, e.g. when migrating existing customers from another CPMS.
PatchTeam
userIdId of the user that owns the team
userEmailemail of the user that owns the team, useful when the userId is not known
nameName of the team
contactEmailContact email of the team. Named "email" in the GET APIs.
financeEmailFinance contact email of the team
financeCommunicationEmailRecipient for important payment notices (late payment, freeze warning, frozen). When not set, these go to financeEmail.
legalEmailLegal contact email of the team.
Address of the team. Only countryId is mandatory. Address1, city, and zipCode must be provided together or all left null.
companyNameThe company name for the team
vatNumberThe vat number for the team
companyRegistrationNumberThe company registration number for the team
Custom fields to set on this entity: a flat map of string keys (1-64 characters, no : or ,, not starting with monta) to string values (up to 256 characters), at most 20 pairs per entity. Fields are scoped to your operator. externalId is the same value as the deprecated partnerExternalId.
Note: merged into the existing fields — omitted keys are kept, a null value deletes the key and {} changes nothing.
paymentMethodThe payment method for the team
themeIdThe theme id to assign to the team.
Note: When theme is provided, it must belong to the same operator as the team
The onboarding steps enabled for the team, as {step, config?, displayMode?} entries. Sending the list replaces the full enabled set; omitting it leaves the steps unchanged.
The app-onboarding welcome-screen text override. Sending it replaces the saved override (slots required; {} clears them); omitting it leaves it unchanged. Send enabled: false to revert to Monta's default copy. Rejected with 409 while the team is linked to an onboarding profile.
categoryCategory identifier of the team, one of: housing-association, cpo, parking, hotel, fleet, company, priced-by-site-owner.
Note: omit the field to leave the category unchanged.
inventoryOnlyChargeKeysWhether the team is restricted to only charge keys that are in the operator inventory
selfRegisterChargeKeysWhether team members can register their own charge keys.
Note: omit the field to leave it unchanged. Self-registration stays enabled while the team's operator team settings template enables it, so sending false does not disable it in that case.
costCenterIdThe cost center id to assign to the team.
Note: Send null to clear the assignment; omit the field to leave it unchanged.
operatorTeamSettingIdAccount template the team follows, from GET /operator-team-settings. The template supplies the team's default price groups, so pinning one is how an operator-owned tariff becomes a team default.
Note: Send null to unpin the team; omit the field to leave it unchanged.
onboardingProfileIdOnboarding profile to lock the team to, from GET /onboarding-profiles. Copies the profile's steps onto the team; while assigned, onboardingSteps cannot be edited.
Note: Send null to detach and keep the current steps (editable again); omit the field to leave it unchanged.
autoWithdrawTurn automatic bank withdrawal on or off for the team. Personal teams, frozen teams and teams using the invoice payment method are not eligible.
Note: Mutually exclusive with invoiceWithdraw; enabling is refused with 422 (AUTO_WITHDRAW_CONFLICT_INVOICE_WITHDRAW) while invoiceWithdraw is on, and with 422 (AUTO_WITHDRAW_TEAM_INELIGIBLE) for an ineligible team. Enabling succeeds even if the team has no bank account, and no payout happens until one is added. Disabling always works. Omit the field to leave the setting unchanged.
joinCodeCustom code users enter in the app to join the team, 4-50 characters. Omit the field to leave it unchanged.
Note: stored slugified (lowercased, spaces and symbols become dashes, e.g. MVV Energie 042 → mvv-energie-042); the response returns the stored value. Join codes are unique across all teams on Monta, so a code that is already taken (after slugifying) is rejected with 422.
partnerExternalIdExternal Id of this entity, managed by you.
Deprecated: use customFields.externalId instead — both read and write the same value.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
Deprecated: use customFields instead; this payload is not migrated automatically.
PatchTeamMember
chargePointIdsIds of the charge points to patch this team member with
roleRole for this member within the team
priceGroupIdThe price group for this team member
costGroupIdThe cost group for this team member
teamMemberProfileIdThe team member profile id to apply to this team member
canConfigureChargePointsIndicates if the team member can configure charge points
canPayWithTeamWalletGives the team member access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canDepositToWalletGives the team member permission to deposit to the team wallet
canWithdrawFromWalletGives the team member permission to withdraw from the team wallet
canManageChargeKeysGives the team member permission to manage charge keys for the team
canRequestSponsoringAllows the team member to request sponsoring from this team for their charge point
canManageTeamMembersAllows the team member to view and manage other members settings
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
noteA note for the team member
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
sponsoredPriceGroupIdPrice group used to reimburse this team member for home charging. Omit to leave unchanged.
autoApproveElectricityCostWhen true, employee-submitted electricity costs are auto-approved for SCPs created for this team member.
reimbursementEnabledMaster switch — whether the team member participates in home reimbursement.
reimbursementPayoutScheduleDefault payout schedule applied to sponsored charge points created for this team member.
reimbursementSubscriptionWhether the operator reimburses the charge-point subscription price.
costCenterIdThe cost center id to assign to the team member.
Note: Send null to clear the assignment; omit the field to leave it unchanged.
canManageTeamWalletDeprecated: use canDepositToWallet and canWithdrawFromWallet instead. When set, its value is propagated to both deposit and withdraw permissions if those are not explicitly provided.
PatchTeamMemberProfile
nameName for the team member profile
descriptionDescription for the team member profile
roleRole for the team member profile
priceGroupIdThe price group for the team member profile
costGroupIdThe cost group for the team member profile
canPayWithTeamWalletGives the team member applying this profile access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canDepositToWalletGives the team member permission to deposit to the team wallet
canWithdrawFromWalletGives the team member permission to withdraw from the team wallet
canManageChargeKeysGives the team member permission to manage charge keys for the team
canRequestSponsoringAllows the team member to request sponsoring from this team for their charge point
canManageTeamMembersAllows the team member to view and manage other members settings
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
canConfigureChargePointsAllows the team member profile to configure charge points
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
sponsoredPriceGroupIdPrice group used to reimburse members in this profile for home charging. Send null to clear and fall back to the employee's own cost price group; omit to leave unchanged.
autoApproveElectricityCostWhen true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.
reimbursementEnabledMaster switch — whether members in this profile participate in home reimbursement.
reimbursementPayoutScheduleDefault payout schedule applied to sponsored charge points created for members in this profile.
reimbursementSubscriptionWhether the operator reimburses the charge-point subscription price.
costCenterIdThe cost center id to assign to the team member profile.
Note: Send null to clear the assignment; omit the field to leave it unchanged.
canManageTeamWalletDeprecated: use canDepositToWallet and canWithdrawFromWallet instead. When set, its value is propagated to both deposit and withdraw permissions if those are not explicitly provided.
PatchUser
emailUser email address
phone^\+[1-9]\d{1,14}$User phone number in E.164 format
firstNameUser first name
lastNameUser last name
languageUser preferred language
legalEmailUser legal email address
address1User address line 1
address2User address line 2
address3User address line 3
zipUser zip/postal code
cityUser city
provinceUser province/state
marketingEmailsAcceptedSet or withdraw the user's marketing email consent for your application. false withdraws it immediately. true requests it: if your application requires double opt-in, Monta emails the user a confirmation link and marketingEmailsAcceptedAt is only set once they confirm; otherwise it is set immediately.
PatchUserContacts
emailUser email address
phone^\+[1-9]\d{1,14}$User phone number in E.164 format
PatchWalletTransaction
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
PayingTeam
publicNamePublic name of the team
idId of the paying team
operatorIdId of the operator the paying team belongs to
PaymentTerminal
idId of this terminal. NOTE: This is a String
typeType of this terminal, ie "payter"
chargePointIdsThe charge points ids this terminal is assigned to
serialSerial number of the Payment Terminal
nameName given to the Payment Terminal, defaults to "No Name" if not set by the merchant
createdAtDate this entity was created
teamIdThe team this terminal belongs to
payingTeamIdThe team charged for sessions started on this terminal. Only set for local terminals
idTagRFID token the charge point authorises with. Only set for local terminals
isConnectedIndicates if the terminal is connected or disconnected.
connectedAtDate this payment terminal did connect
updatedAtDate this entity was updated
deletedAtDate this entity was deleted
PaymentTerminalSession
statusStatus of the payment terminal session.
currencyIdentifier of the currency the session was charged in.
reservedAmountAmount initially reserved on the payment card when the session started.
committedAmountFinal committed amount captured from the payment card after the session ended.
createdAtDate the session was created.
idIdentifier of the payment terminal session.
chargeIdIdentifier of the charge associated with this session, when one was created.
chargePointIdIdentifier of the charge point on which the session was performed.
failedReasonReason the session failed, when applicable.
PeakProtectionOperationalState
PeakProtectionSettings
peakProtectionEnabledpeakLimitPowerKwpeakSafetyMarginKwpeakProtectionNotificationEnableddataSourcechangedAtPeakProtectionSettingsUpdate
peakProtectionEnabledpeakLimitPowerKwpeakSafetyMarginKwpeakProtectionNotificationEnableddataSourcechangedAtPeakProtectionState
peakProtectionOperationalStatecurrentTotalPowerKwlastDataAtPerformance
statusState of the system or charge point
durationDuration in the given status (in seconds)
usagePercentagePercentage of time in this state
PerificMeterIntegration
meterIdentifiertimeoutSecondsdigitalInputNumberdigitalInputActiveLevelPlan
idThe id of the Plan
identifierA unique, readable, identifier of the Plan
nameName of the Plan
applicableForIndicates whether this plan can be applied to teams or charge points. 'operator' value is only used internally.
activeIndicates if the plan is active (only active plans can be applied).
applicationAudienceIndicates whether this plan is shown in your (operator's) app only, or in the Monta app as well.
visibleInMarketPlaceIndicates whether this plan is shown in the market place or not.
priceModelIndicates if the price is fixed, per charge point or per user.
Active plan prices
pricesWithVatIndicates if the prices are incl. VAT or not. Default is true.
serviceTypePlan service type, custom, tax-refund or charge-package
Additional configuration, based on serviceType
countryIdDetermines the country where the plan is available. null means it is available in all countries.
descriptionDescription of the Plan
summarySummary of the Plan
termsTerms of the Plan
contractUrlURL for a generic contract template the user can fill out right after subscribing
supportEmailSupport E-Mail for this Plan
PlanPrice
Currency for price.
idid of the Plan Price
pricePrice of the plan
PlanServiceConfig
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: additionalFeeAbsolute, additionalFeePercentage, additionalStartingFee | |
| type = object · requires: additionalFeeAbsolute, additionalFeePercentage, payoutPerKwh +1 more |
additionalFeePercentageThis percentage will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.
additionalFeeAbsoluteThis absolute value will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
additionalStartingFeeThis absolute value will be added as additional fee, once per charge session, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
additionalFeeApplicationScopeType of charges to which custom additional fees are applied
roamingAdditionalFeePercentageSame as the additional fee percentage, but only applied to roaming sessions.
roamingAdditionalFeeAbsoluteSame as the additional fee absolute, but only applied to roaming sessions.
roamingAdditionalStartingFeeSame as the additional starting fee, but only applied to roaming sessions.
PlanServiceConfigCustom
additionalFeePercentageThis percentage will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.
additionalFeeAbsoluteThis absolute value will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
additionalStartingFeeThis absolute value will be added as additional fee, once per charge session, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
additionalFeeApplicationScopeType of charges to which custom additional fees are applied
roamingAdditionalFeePercentageSame as the additional fee percentage, but only applied to roaming sessions.
roamingAdditionalFeeAbsoluteSame as the additional fee absolute, but only applied to roaming sessions.
roamingAdditionalStartingFeeSame as the additional starting fee, but only applied to roaming sessions.
PlanServiceConfigTaxRefund
additionalFeePercentageThis percentage will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.
additionalFeeAbsoluteThis absolute value will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
payoutPerKwhAmount to pay out per kWh
priceIncludesVatIndicates whether the VAT is already included in the price
additionalFeeApplicationScopeType of charges to which custom additional fees are applied
PlansStats
Projected monthly revenue across plans owned by the calling operator
noSubscriptionCountNumber of charge points without an active plan subscription
Total tax-refund amount. Null when the operator has no tax-refund plans.
PowerLimitScheduleItem
dayOfWeekstartTimeendTimepowerLimitWPowerfoxIntegrationResult
Powerfox_1
resultPriceGroup
nameName of the price group
idId of the price group
PriceGroupAppliedTo
chargePointsId's of the ChargePoints this Pricegroup has been applied to
sitesId's of the Sites this Pricegroup has been applied to
teamMembersId's of the Team Members this Pricegroup has been applied to
PriceGroupTag
nameThe name for this tag.
createdAtCreation date of this resource.
idThe id for this tag.
descriptionThe description for this tag.
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
The operator to which this resource belongs to.
updatedAtLast update date of this resource.
PriceGroupType
PriceGroup_1
idId of the price group
nameName of the price group
typeType of the price group
The master price
Tariffs of the price group
createdAtWhen the price group was created
teamIdId of the team for which this price group belongs
defaultFees of the price group
teamMemberCountTo how many team members the price group has been applied to
chargePointCountTo how many charge points the price group has been applied to
updatedAtWhen the price group was updated
PriceItem
startTimeendTimepricePerKWhcurrencyIdPriceSpecification
price specifications
PricesForecast
The operator to which this charge point and price group belongs to
The currency applicable for this forecast
The price group applicable for this forecast
The compilation of entries composing this prices forecast
PricesForecastEntry
timeThe time this forecasted price is applicable, forecast is valid from time + 1 Hour
pricePerKwhThe projected price per kWh
nameThe human readable name for the forecast (includes the currency information)
Pricing
idId of the pricing
typeType of the pricing. minute is used for Minute fee. min is used for the master price.
masterIf this is the master price (not a fee)
dynamicPricingIf it's a dynamic price. It will be true if a tariffId is present.
endAtFullyChargedUsed by the Minute fee and min master price. True means it will stop applying the pricing when the charge is complete. False means it will stop charging the fee when the cable is unplugged
vatUsed by Spot Price. True means it will add % of VAT on top the price calculations
Note: vat rates differ from country to country.
updatedAtWhen the pricing was last updated
The price of this Fee or Master price
descriptionName of the pricing. It will be null when it's the master price
percentageUsed by Spot Price. It will multiply the fallback price by this percentage
tariffIdThe id of the selected Tariff
applyAfterMinutesUsed by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied.
Used by spot price. The minimum that the raw spot price can be. This will be used in calculations if spot price is lower than this
Used by spot price. The maximum that the raw spot price can be. This will be used in calculations if spot price is higher than this
Used by Idle fee. The maximum the user will be charged for the idle fee
Used by spot price. Additional absolute money or percentages values to be added on top of the previous calculations
fromDateTime "from" time to which this pricing should apply from
toDateTime "to" time to which this pricing should apply to
tagIdThe id of the charge pricing tag for this pricing
intervalSpecifies the time resolution used for spot price calculations.
Note: Only has an effect if such resolution is available (, ie 15-min MTU from 30.09.25).
Grace periods during which idle fees are not applied
PromotionCode
promotionCodeIdId of the promotion code
userIdId of user using the promotion code
statusStatus of the promotion code
PromotionCodeBulkResult
The codes created by this request
skippedExistingCodesThe requested codes that already existed and were therefore not created again. Codes are unique across all operators, so a code held elsewhere is reported here instead of failing the batch. A replayed request returns an empty created list and every code here, so retrying is safe.
PromotionCodeCoverage
promotionCodeIdThe promotion code that covered part of this charge
subscriptionIdThe subscription that granted the promotion code, resolved when the charge completed. Null when the code was not granted by a subscription.
typeThe kind of promotion code. Null for a type this API version does not know.
Present only when the promotion code carries a kWh allowance
Present only when the promotion code carries a maximum discount amount
PromotionCodeDeeplinks
deeplinkRedeem deeplink resolving on the operator's own subdomain, or on the bare app host when the operator's identifier is a reserved one such as Monta's.
appDeeplinkRedeem deeplink resolving on the host the operator's branded app actually claims, falling back to the operator subdomain when the operator has no branded app. Use this one for a QR code meant to open a white-label app.
PromotionCodeDiscountCap
consumedAmountThe discount the code applied to this charge, in the charge's own currency
PromotionCodeKwhAllowance
coveredKwhHow many kWh of this charge the allowance paid for. Zero means it was already spent.
PromotionCodeType
PromotionCode_1
idId of the promotion code
codePromotion code
descriptionDescription of the promotion code
amountAmount associated with the promotion code
amountFormattedFormatted amount associated with the promotion code
typeType of the promotion code
nameName of the promotion code
maxUsesCountMaximum number of times the code can be used
usesCountNumber of times the code has been used
usableWhether the promotion code is currently usable
The operator to this promotion code is associated
createdAtCreation timestamp of the promotion code (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
updatedAtUpdate timestamp of the promotion code (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
deletedAtSoft deletion timestamp of the promotion code (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
startAtStart timestamp of the promotion code (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
endAtEnd timestamp of the promotion code (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
userIdUser ID this code is scoped to, if any
maxDiscountAmountCap on the total discount a single driver can accumulate from this code. Null when no cap is set.
selectedTeamIdsTeam IDs the promotion code is restricted to. Empty when the code is not team-restricted.
amountKwhkWh allowance the discount covers per budget period. Null means no kWh cap.
budgetPeriodTypeReset window for the kWh allowance; calendar-month resets on the 1st, null means a lifetime cap.
includeHomeChargingWhether the kWh allowance also covers charge points owned by the subscribing team, so home charging draws on the same allowance as public charging.
selectedListIdsList IDs the promotion code is restricted to. Empty when the code is not list-restricted.
The redeem deeplinks for this code. Null when the code has no meaningful deeplink.
PublicChargePoint
evseIdThe EVSE id for this charge point
chargePointOperatorNameThe charge point operator name
Location information for this charge point
idId of this charge point
nameName of the charge point
chargePointOperatorIdThe charge point operator id
maxKwMax KW available at this charge point.
chargePointModelIdThe ID of the charge point model for this charge point.
brandNameBrand name for this charge point
modelNameModel name for this charge point
deletedAtDate this charge point was deleted
PublicTeam
idId of the public team
publicNamePublic name of the team
memberCountNumber of members in the team
PublicUser
idId of the user
displayNameFormatted name to be displayed
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
PublicUser_1
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
displayNameDisplay name of the user
PushPricesRequest
overlayReasonDto
idId of the reason
identifierIdentifier of the reason
reasonReason of the report
typeType of the report
priorityPriority of the report
Receipt
idId of the receipt
versionThe version of the receipt layout
totalAmountThe total amount on the receipt
A list of transaction ids linked to the receipt
vatValue added tax (VAT) amount on the receipt.
createdAtThe date and time receipt was created
identifierHuman-readable receipt number (identifier)
Currency
pdfUrlPDF url where the receipt can be fetched from
ReceiptEntry
titleTitle
amountAmount
subAmountSub amount
subTitleSubtitle
RedeemPromotionCodeDto
promotionCodeIdPromotion code id
userIdId of the user redeeming the code
teamIdId of the team (if applicable)
RegisterComplianceRequest
The company's French tax and electronic-invoicing settings. Required: without it the company is left with registration numbers but no tax profile and no declaration, so it cannot be invoiced under the French e-invoicing rules.
The company's official French registration numbers, given as key/value pairs where each key names a type of identifier and the value is the number itself. You do not need to send all three — always include FR_SIREN, and add the others only if they apply:
FR_SIREN— required. The 9-digit number that identifies the company nationally.FR_SIRET— optional. The 14-digit number that identifies one specific site of the company (its SIREN followed by a 5-digit site code). Include it when registering a particular establishment.FR_VAT— optional. The company's French VAT number. It is derived from the SIREN/SIRET, so you normally don't need to set it yourself.
RegularHours
periodBeginPeriod begin in HH:mm format (e.g. 08:00)
periodEndPeriod end in HH:mm format (e.g. 17:00 or 00:00 for end of day)
weekdayNumber of day in the week, from Monday (1) till Sunday (7)
RegularHoursRequest
periodBegin^([01][0-9]|2[0-3]):… · requiredPeriod begin in HH:mm format
periodEnd^([01][0-9]|2[0-3]):… · requiredPeriod end in HH:mm format
weekdayDay of the week, from Monday (1) to Sunday (7)
ReportDto
idId of the report
operatorIdId of the operator related to the report
relationTypeType of the relation
relationIdId of the relation
stateState of the report
imageUrlsList of image URLs
createdAtTime when the report was created
reportedByUserIdId of the user who reported
bodyBody of the report
Reason of the report
sourceSource of the report
assignedToOperatorIdId of the operator assigned to the report
assignedToUserIdId of the user assigned to the report
resolvedByUserIdId of the user who resolved the report
operatorNoteNote from the operator
adminNoteNote from the admin
userNoteNote from the user
resolvedAtTime when the report was resolved
escalatedAtTime when the report was escalated
assignedAtTime when the report was assigned
Additional raw payload data, ie. for driver-support reports coming from Zendesk
updatedAtTime when the report was updated
deletedAtTime when the report was deleted
RevenueShareAgreement
codeStable code identifying the agreement.
statusLifecycle status.
policyCodeCode of the policy this agreement applies.
policyVersionVersion of the policy this agreement applies.
sourceTeamIdId of the team the revenue is shared from.
sourceTeamNameName of the team the revenue is shared from.
recipientTeamIdId of the team the revenue is shared to.
recipientTeamNameName of the team the revenue is shared to.
attributionSourceTeamIdId of the team charges are attributed to.
startedAtWhen the agreement started.
endedAtWhen the agreement ended.
createdAtCreation timestamp.
updatedAtLast update timestamp.
RevenueShareCalculation
idStable identifier of the calculation.
agreementCodeCode of the agreement the calculation belongs to.
policyCodeCode of the policy applied to the charge.
sourceTeamIdId of the team that generated the revenue.
sourceTeamNameName of the team that generated the revenue.
recipientTeamIdId of the team receiving the share.
recipientTeamNameName of the team receiving the share.
chargeIdId of the charge the calculation was derived from.
grossAmountGross amount of the charge.
netAmountNet amount of the charge.
attributedNetAmountNet amount attributed to the policy.
shareAmountAmount of the share.
shareTaxAmountTax amount applied to the share.
shareTaxRateTax rate applied to the share.
shareTaxCodeTax code applied to the share.
currencyCurrency of the amounts.
settlementStatusSettlement status of the share.
walletTransactionIdId of the wallet transaction that settled the share.
externalSettledAtWhen the share was settled externally.
computedAtWhen the calculation was computed.
errorReasonReason the calculation failed, when applicable.
RevenueSharePolicy
codeStable code identifying the policy.
nameHuman-readable name.
kindWho the revenue is shared between.
sellerWho sells the electricity.
policyTypeHow the share is measured.
policyValueThe share value: a percentage of net, or an amount per kWh.
moneyFlowHow the settled share reaches the recipient.
statusLifecycle status.
descriptionOptional internal description.
versionPolicy version.
validFromStart of the validity window.
validToEnd of the validity window.
createdAtCreation timestamp.
updatedAtLast update timestamp.
deletedAtSoft-delete timestamp, null when the policy is not deleted.
RevenueShareSettlement
idStable identifier of the settlement.
statusLifecycle status.
agreementCodeCode of the agreement the settlement belongs to.
periodStartStart of the settled period.
periodEndEnd of the settled period.
currencyCurrency of the settled amounts.
totalShareAmountTotal shared amount for the period.
totalTaxAmountTotal tax amount for the period.
walletTransactionIdIdentifier of the wallet transaction that settled the share.
attemptsNumber of settlement attempts made.
lastAttemptAtTimestamp of the last settlement attempt.
settledAtTimestamp when the settlement was completed.
errorReasonReason the settlement failed, when applicable.
createdAtCreation timestamp.
SaveEyeIntegrationResult
SavedPaymentMethod
typePayment method type
brandCard brand. Null for non-card payment methods
last4Last four card digits. Null for non-card payment methods
expiryMonthCard expiry month. Null for non-card payment methods
expiryYearCard expiry year. Null for non-card payment methods
expiredWhether the card has expired. Always false for non-card payment methods
Saveeye_1
resultSchedule
idId of the schedule
teamIdId of the team that owns this schedule
nameName of the schedule
visibilityDefault visibility for charge points in this schedule
timezoneTimezone for interpreting the schedule entry times
entryCountNumber of entries in this schedule
createdAtWhen the schedule was created
priceGroupIdId of the default price group applied during scheduled windows
List of schedule entries defining time windows and their overrides
selectedChargePointIdsIds of charge points directly assigned to this schedule
selectedSiteIdsIds of sites assigned to this schedule
updatedAtWhen the schedule was last updated
ScheduleEntry
idId of the schedule entry
dayOfWeekDay of week this entry applies to
fromStart time of this entry (HH:mm:ss)
toEnd time of this entry (HH:mm:ss)
visibilityVisibility override for this time window. Null means the schedule's default visibility is used.
priceGroupIdPrice group override for this time window. Null means the schedule's default price group is used.
ScheduleOverride
startDaystartTimeendDayendTimetypeiddepartureDaydepartureTimeSendMessageRequest
bodyThe message body. 1–4096 characters.
Which channels to deliver on. Defaults to in-app inbox only.
userIdId of the user to send the message to. The user must belong to your operator.
subjectOptional subject / title. Up to 140 characters. Used as the push/email title; falls back to a default when omitted.
actionUrlOptional deep link opened from the message. Must be an https:// URL, a monta-app:// deeplink, or an internal /path.
SendWelcomeEmail
Users to send the welcome email to (between 1 and 100, no duplicates)
forceSend again to users who already got the welcome email. By default they are skipped, so repeating a call is safe
SendWelcomeEmailItem
userIdId of the user to send the welcome email to
SendWelcomeEmailResult
One result per requested user, in request order
Number of users per result status
SetChargingProfile
connectorIdThe connector id to set the profile for.
The charging profile to set.
SetChargingProfileConfirmation
statusThe status of the set charging profile request.
SetDefaultTeam
teamIdId of an existing private team owned by the operator (or one of its sub-operators) to assign as the user's default team
SetManualChargeIntentRequest
typeprioritydepartureTimeSetNodeExternalPowerLimitRequest
limitWexpiresAtSetSiteRequest
topNodeFuseLimitAoperatorIdteamIdSetTeamChargeIntentRequest
typeCharge intent type. PRICE_OPTIMIZE also requires target and departureTime.
departureTimeDaily departure time (local time).
Charging target.
Schedule overrides. Defaults to none.
priorityIntent priority. Defaults to 0.
SetUserChargeIntentRequest
type^(PRICE_OPTIMIZE|CHA… · requiredCharge intent type
departureTimeDeparture time (local time of the site). Required for PRICE_OPTIMIZE.
Charging target. Required for PRICE_OPTIMIZE.
Schedule overrides. Defaults to an empty list.
priorityPriority of the charge intent. Defaults to 0.
Settings
SettingsChangeLogEntry
idsiteIdentityTypeentityIdactioncommentcreatedAtchangesuserIdShellyMeterIntegration
topicPrefix^[^/+#]*$ · requiredtimeoutSecondsSignatureExplanation
receivedPayloadStringThe processed payload as string
receivedPayloadBytesThe processed payload as bytes (hex)
webhookSecretThe secret used to sign the payload
webhookSecretBytesThe secret used to sign the payload as bytes (hex)
signatureAlgorithmThe algorithm used for generating the signature
signatureThe resulting signature
signatureWithPrefixThe resulting signature including prefix
SignedData
formatSignature format as given by the charge point.
endMeterOriginating from the charge point for the end recording. The format is the exact format received from the charge point.
certificatePublic key for the signature.
startMeterOriginating from the charge point for the start recording. The format is the exact format received from the charge point
Note: some formats sends both start and end data in the signed endMeter data. In this case this is null.
SignedDataFormat
Enumerate the possible charge signed data formats
SimCard
imsiimsi (International Mobile Subscriber Identity) for the SIM card
iccidiccid (Integrated Circuit Card Identifier) for the SIM card
SimpleTeamMemberDto
idId of the team member
teamIdTeam id of team member
displayNameThe team member display name, formats can be: First and Last Name, User: #id, email, or phone
partnerExternalIdExternal Id of this entity, managed by you.
userIdUser id of team member. If the user does not exist yet, it will be null.
Site
idnameisActiveoperatorIdcommentteamIdphpSiteIdimportedOcppGroupIdSiteAmenities
List of amenities configured for the site
SiteAmenitiesUpdate
Full list of amenities to set on the site. Replaces any existing amenities.
SiteConfig
rampUpProtectionEnabledcountryAreatimeZoneIddefaultBatteryCapacityKwhgridConnectionTypevehicleAwareRampUpDurationSecondssubPrioritizationNONE is deprecated, use EQUAL_SHARE.
topUpEnableddcChargingEfficiencyFactorappSmartChargeOverrideEnabledoptimizerVersionSiteConfigRequest
timeZoneIdrampUpProtectionEnabledgridConnectionTypevehicleAwareRampUpDurationSecondssubPrioritizationNONE is deprecated, use EQUAL_SHARE.
countryAreadefaultBatteryCapacityKwhtopUpEnableddcChargingEfficiencyFactorappSmartChargeOverrideEnabledoptimizerVersionSiteDeveloper
nameName of the developer
emailEmail of the developer
companyRegistrationNumberCompany registration number
SiteDeveloperRequest
nameDeveloper name
emailDeveloper email
companyRegistrationNumberCompany registration number
SiteEnergyMix
List of energy sources with their category and percentage
List of environmental impacts for this energy mix
is_green_energyIndicates if the energy is green
supplier_nameName of the energy supplier
energy_product_nameName of the energy product
SiteImages
imagesPublic URLs of the images attached to this site (max 4)
SiteListItem
idnameisActiveoperatorIdnumberOfEvsesnumberOfSubgroupscurrentPowerWcommentchargePointIdsteamIdphpSiteIdSiteMetadata
atmATM available at the site
digitalChargePriceDisplayDigital charge price display available
driverLoungeDriver lounge available
fuelStationFuel station available
parkingAreaParking area available
powerSupplyPower supply available
showerShower available
vendingMachineVending machine available
washingMachineWashing machine available
wifiWiFi available
toiletsNumber of toilets
cafeCafe available
foodDeliveryFood delivery available
hotelHotel available
mallMall available
museumMuseum available
parkPark available
outdoorGymOutdoor gym available
recreationAreaRecreation area available
restaurantRestaurant available
supermarketSupermarket available
airportAirport nearby
bikeSharingBike sharing available
busStopBus stop nearby
carpoolParkingCarpool parking available
metroStationMetro station nearby
taxiStandTaxi stand available
tramStopTram stop nearby
secureTruckParkingSecure truck parking available
truckDealershipTruck dealership available
truckParkingTruck parking available
truckRepairTruck repair available
truckWashTruck wash available
accessControlledAreaAccess controlled area
cameraSurveillanceCamera surveillance
entryGateEntry gate available
exitGateExit gate available
floodLightingFlood lighting available
guardGuard available
licensePlateRecognitionLicense plate recognition available
pedestrianTurnstilesPedestrian turnstiles available
perimeterFencePerimeter fence available
Energy mix information
picturesPictures of the site
Site developer information
Cafe address
Food delivery address
Hotel address
Mall address
Museum address
Park address
Outdoor gym address
Recreation area address
Restaurant address
Supermarket address
parkingTypeParking type
roofedRoofed area available
lightingLighting available
openingDateOpening date of the site
Opening hours information
totalParkingSpacesTotal number of parking spaces at the site
totalAccessibleSpaceTotal number of accessible parking spaces at the site
truckOnlyTotal number of truck parking spaces at the site
trailerParkingIndicates if trailer parking is available at the site
facilitiesParking facilities available at the site
venueWithAccessibilityIndicates if the site is accessible for people with disabilities
SiteMetadataRequest
List of amenities for the site
Energy mix information for the site
Opening hours for the site
Site developer contact details
picturesList of picture URLs for the site (max 4)
SiteStatisticsDto
fromDateStart date of the statistics period
toDateEnd date of the statistics period
totalEnergyConsumedTotal energy consumed during the period (in kWh)
totalSessionsTotal number of charging sessions during the period
sessionSuccessRateSuccess rate of charging sessions during the period (as a percentage)
siteIdId of the site
systemUptimePercentagePercentage of uptime for the system during the period
Detailed state for the period
Daily statistics for the period
Monthly statistics for the period
Site_1
nameName of the site
createdAtCreation date of this charging site
updatedAtDate this charging site was last updated
visibilityIndicates if this site is public or private. Controls who can charge at the site; independent of showOnMap.
driverSupportVisibilityWhether Monta's AI Driver Support may reach drivers at this site.
- inherit — follow the site's visibility: a public site is reachable, a private site is not.
- public — always reachable, even when the site's visibility is private.
- off — never reachable, even when the site is public.
Location information for this site
List of supported connector types at this site (e.g. type-2, ccs, ...)
idId of the site
teamIdId of the team that has access to the site
partnerExternalIdExternal Id of this entity, managed by you.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
Operator of this charging site
deletedAtDate this charging site was deleted
chargePointCountNumber of charge points at this site
activeChargePointCountNumber of active charge points at this site
availableChargePointCountNumber of available charge points at this site
maxKwMax KW available at this site.
typeType of charge points at this site (AC / DC)
showOnMapWhether this site is visible on the consumer map. Independent of visibility: a public site can still be hidden, and a private site can still be shown.
noteA note you have entered for this site, e.g. via our Portal.
Additional information for this site, e.g. totalParkingSpaces.
maxKWDeprecated (will be removed by 01.04.24), use maxKw field instead.
Slice_TariffRecurringPeriodDto_
pageNumberoffsetsizeemptynumberOfElementsSnoozeAlert
snoozedUntilWhen the alert wakes up again. Omit to snooze until it is changed manually.
SolarChargeOperationalState
SolarChargingSettings
solarChargingEnabledminSurplusCurrentForChargingAbatteryProtectionEnabledsolarChargeByDefaultsolarChargeGracePeriodSecondsbatteryProtectionLockTimeMinutessolarChargingSourceSolarChargingSettingsUpdate
solarChargingEnabledminSurplusCurrentForChargingAsolarChargingSourcebatteryProtectionEnabledsolarChargeByDefaultsolarChargeGracePeriodSecondsbatteryProtectionLockTimeMinutesSolarChargingState
solarChargeOperationalStatesurplusPowerKwlastDataAtSolarForecast
forecastFetchedAtSolarForecastItem
endTimestampsolarProductionWSolarForecastResponse
solarPanelIdforecastFetchedAtSolarInverter
resultSolarPanel
idnodeIdexternalIdlatitudelongitudedeclinationazimuthpeakProductionKwSolarPanel_1
integrationUuidlongitudelatitudedeclinationazimuthpeakProductionKwproductionModifierSolarPanel_2
resultSolarPanel_3
declinationazimuthpeakProductionKwproductionModifierSort
Sort.Order
ignoreCasedirectionpropertyascendingSplitBillingItem
idId of this split billing item.
processedWhether this item has been processed into a settlement.
teamIdId of the team this item belongs to.
userIdId of the user this item is attributed to.
chargeIdId of the underlying charge.
settlementIdId of the settlement this item is part of, if any.
Per-kWh price cap for this item.
Total amount of this item.
createdAtWhen this item was created.
SplitBillingSettlement
Amount due for this settlement.
Total amount including any fees.
statusSettlement status.
idId of this settlement.
teamIdId of the team this settlement belongs to.
userIdId of the user that owns this settlement.
attemptsNumber of times the settlement has been attempted.
lastAttemptAtWhen the settlement was last attempted.
periodServer-rendered (English) label for the billing period the settlement covers, e.g. April 2026. Prefer firstItemAt/lastItemAt for locale-aware rendering.
firstItemAtTimestamp of the earliest split-billing item in the settlement. Use together with lastItemAt to render a localised period. Null for historical settlements created before the field existed.
lastItemAtTimestamp of the latest split-billing item in the settlement. See firstItemAt.
sessionCountNumber of split-billing charges included in this settlement.
createdAtWhen this settlement was created.
SponsorTeam
publicNamePublic team name
idID of the sponsor team
SponsoredChargePoint
payoutThe payout frequency for this sponsored charge point
The charge point being sponsored
createdAtCreation date of this sponsored charge point
updatedAtDate this sponsored charge point was last updated
idId of this sponsored charge point
teamIdId of the team of this sponsored charge point
noteNote for the sponsored charge point
payForSubscriptionsIndicates the company pays for the subscriptions
autoApproveElectricityCostWhen true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review.
Operator of this sponsored charge point
acceptedAtDate the sponsorship was accepted
deletedAtDate this sponsored charge point was deleted
SponsoredChargePointApprove
sponsoredChargePointIdsList of sponsored charge point ids to approve
payoutPayout schedule used after approval
payForSubscriptionsWhether the sponsor pays for the sponsored user's subscription fees
sponsoredPriceGroupIdOptional price group id to apply to the approved sponsorship. If omitted, the price group already attached to the sponsored charge point is used.
sendEmailNotificationWhether to send an email notification to the charge point owner about the approval
SponsoredChargePointCostChangesReview
sponsoredChargePointIdsList of charge point ids that are selected for cost changes review
sendEmailNotificationIndicates if an email notification should be sent to the charge point owner about the cost changes review
SponsoredChargePointData
Location information for this charge point
createdAtCreation date of this charge point
updatedAtDate this charge point was last updated
idId of this charge point
nameName of the charge point
The user (owner) of this charge point
The sponsored price group of this charge point
serialNumberSerial number for this charge point
lastMeterReadingKwhLast meter reading (KWH) for this charge point
maxKwMax KW available at this charge point.
chargePointModelIdThe ID of the charge point model for this charge point.
brandNameBrand name for this charge point
modelNameModel name for this charge point
firmwareVersionCurrent firmware version for this charge point
isActiveIndicates if this charge point is active (true) or not (false). Active = fully onboarded to Monta.
activeAtLast date when charge point was activated
deletedAtDate this charge point was deleted
SponsoredChargePointReject
sponsoredChargePointIdsList of sponsored charge point ids to reject (the underlying sponsorship will be removed)
SpotPriceAdditionalPercentageComponentMetadata
typeThe type of this metadata entry
priceThe additional price on top of the spot price metadata entry
percentageThe additional percentage on top of the spot price metadata entry
SpotPriceAdditionalPriceComponentMetadata
typeThe type of this metadata entry
kwhThe kwh for this spot price metadata entry
priceThe additional price on top of the spot price metadata entry
SpotPriceComponentMetadata
typeThe type of this metadata entry
kwhThe kwh for this metadata entry
pricePerKwhThe price per kwh for this metadata entry
StartChargeRequest
payingTeamIdThe id of the team that will be paying for the charge.
chargePointIdId of the charge point used for this charge
reserveChargeCode
kwhLimitThe charge kWh limit, meaning the charge will stop once the limit kWh is reached.
Note: kwhLimit can be set in parallel with socLimit, in this case the first limit to hit will stop the charge
socLimitThe charge SoC limit, meaning the charge will stop once the limit SoC % is reached.
Note: socLimit can be set in parallel with kwhLimit, in this case the first limit to hit will stop the charge
priceLimitThe charge price limit, meaning the charge will stop once the price limit is reached.
Note: priceLimit will be in the currency of the charge point.
priceGroupIdAllows you to enforce a specific price group for this charge.
Note: The price group must be of type team or charge-point.
For Partners who want to start charging from payment terminals, kiosks etc. Used to link charge transaction against your billing and to allow users retrieving receipts via receipt.monta.com by using date and genericPaymentSession.externalIdor genericPaymentSession.cardLast4.
partnerExternalIdExternal Id of this entity, managed by you.
Note: How this field is used is up to the partner, but we highly recommend using a unique partnerExternalId for each charge.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys. The payload is limited to 1000 characters.
StateOfCharge
sourceSource of this value, eg vehicle or charge-point
percentageValue of SoC in %
States
stateState of the system or charge point
percentagePercentage of the time spent in this state
durationDuration in this state (in seconds)
StaticLimit_1
resultStromleserIntegrationResult
Stromleser_1
resultSubscribeTeamToPlan
userIdThe user that should be assigned as the purchaser of the subscription. If not provided, the subscription will be assigned to the default user for this consumer.
nextPurchaseAtDate when wallet will be charged for the first time (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Has to be a date in the future.
Subscription
stateState of the subscription
customerTypeCustomer type
createdAtSubscription creation date
updatedAtSubscription update date
idId of the subscription
nextPurchaseAtDate of next purchase
cancelledAtSubscription cancellation date
endAtSubscription end date
The validity period of the subscription, exposing the start (from) and end (to) dates as a dedicated object for billing system integrations.
discountPercentageDiscount percentage
discountAbsoluteDiscount absolute
discountAmountDiscount amount
originalAmountOriginal amount
totalAmountTotal amount
purchaseCountNumber of purchases
chargePointsNumber of charge points
customerIdThe id of the customer
planIdPlan id
Subscription configuration, based on the plans serviceType.Currently you can configure tax-refund subscriptions only.
canCancelIndicates if the subscription can be cancelled
noteA note on the subscription
deletedAtSubscription marked as deleted date
SubscriptionBillingPeriod
startStart of the period (inclusive).
endEnd of the period (inclusive).
amountAmount for the period in the subscription's currency.
currencyISO 4217 currency code.
SubscriptionCancellationPreview
endAtThe date the subscription would end if cancelled with the requested option.
Refund or final-purchase that would result from cancelling now. Null when there is nothing to reconcile (no purchase yet, paid period already elapsed, or end-of-billing-period cancellation).
SubscriptionCustomerType
Enumerate the various subscription customer types
SubscriptionPurchase
typeThe type of this subscription purchase
The currency for this purchase
The subscription this purchase refers to
createdAtCreation date of this subscription purchase
idId of the subscription purchase
noteNote for this subscription purchase
discountPercentageThe discount percentage applied to this purchase
discountAbsoluteThe absolute discount applied to this purchase
originalAmountThe original amount of this purchase
discountAmountThe discounted amount of this purchase
totalAmountThe total amount of this purchase
updatedAtUpdate date of this subscription purchase
deletedAtDeleted date of this subscription purchase
SubscriptionPurchaseTypeDto
Enumerate the possible purchase types for subscription purchases
SubscriptionReconciliation
typeReconciliation type — refund returns money to the customer, purchase charges a final prorated amount.
The current billing period the subscription is in.
The portion of the billing period being reconciled (refunded or charged).
SubscriptionServiceConfig
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: additionalFeeAbsolute, payoutPerKwh, priceIncludesVat +1 more | |
| type = object · requires: additionalFeeAbsolute, additionalFeePercentage, additionalStartingFee +2 more |
serviceTypePlan service type, custom or tax-refund
payoutPerKwhAmount to pay out per kWh
priceIncludesVatIndicates whether the VAT is already included in the price
additionalFeeAbsoluteThis absolute value will be added as additional fee, paid by charge point owner.Will be only applied to charge point owned by operator.Note: This uses the default currency of the operator!
roamingAdditionalFeeAbsoluteSame as the additional fee absolute, but only applied to roaming sessions.
SubscriptionServiceConfigCustom
serviceTypePlan service type, custom or tax-refund
subscriptionAdditionalFeeApplicationScopeAmount to pay out per kWh
additionalFeePercentageThis percentage will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.
additionalFeeAbsoluteThis absolute value will be added as additional fee, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
additionalStartingFeeThis absolute value will be added as additional fee, once per charge session, paid by charge point owner.Will only be applied to charge point owned by operator.Note: This uses the default currency of the operator!
roamingAdditionalFeePercentageSame as the additional fee percentage, but only applied to roaming sessions.
roamingAdditionalFeeAbsoluteSame as the additional fee absolute, but only applied to roaming sessions.
roamingAdditionalStartingFeeSame as the additional starting fee, but only applied to roaming sessions.
SubscriptionServiceConfigTaxRefund
serviceTypePlan service type, custom or tax-refund
payoutPerKwhAmount to pay out per kWh
priceIncludesVatIndicates whether the VAT is already included in the price
additionalFeeAbsoluteThis absolute value will be added as additional fee, paid by charge point owner.Will be only applied to charge point owned by operator.Note: This uses the default currency of the operator!
roamingAdditionalFeeAbsoluteSame as the additional fee absolute, but only applied to roaming sessions.
SubscriptionStatsDto
pending_countactive_countcancelling_countpaused_countunpaid_counttotal_unpaid_amountSubscriptionValidityPeriod
fromStart date of the subscription's validity period
toEnd date of the subscription's validity period
TariffComponentMetadata
typeThe type of this metadata entry
tariffIdThe tariff id for this metadata entry
tariffFromIndicates from when (date-time) the tariff was applied, only relevant from time-based-tariff components
tariffToIndicates until when(date-time) the tariff was applied, only relevant from time-based-tariff components
kwhThe kwh for this metadata entry
pricePerKwhThe price per kwh for this metadata entry
TariffDto
externalIdExternal id of the tariff
nameName of the tariff
descriptionDescription of the tariff
zipCodesZip codes of the tariff
tariffTypeType of the tariff
timeZoneTime zone of the tariff
areaArea of the tariff
createdAtCreation date of the tariff
idId of the tariff
countryIdCountry Id of the tariff
countryAreaIdCountry area Id of the tariff
currencyIdCurrency Id of the tariff
teamIdTeam Id of the tariff
operatorIdOperator Id of the tariff
pricesWithVatIndicates if VAT is already in the price of the tariff
activeIndicates if the Tariff is active or not
customerTypeCustomer type of the tariff
updatedAtLast update date of the tariff
TariffPeriodGroup
activeFromtariff period group active from date
activeTotariff period group active to date
descriptiontariff period group description
idtariff period group id
tariffIdtariff id
TariffPeriodGroup_1
activeFromtariff period group active from date
activeTotariff period group active to date
descriptiontariff period group description
tariffIdtariff id
TariffPeriodGroup_2
activeFromtariff period group active from date
activeTotariff period group active to date
descriptiontariff period group description
TariffPriceResolution
Time granularity of a dynamic price entry.
TariffPriceSource
Origin of a dynamic price entry.
TariffRecurringPeriod
dayOfWeekday of the period
priceprice during the period
idid of the period
tariffIdid of the tariff
endDayOfWeekEnd day of the period
startstarting hour of the period
endending hour of the period
startMinuteminute within the starting hour when the period starts (0, 15, 30 or 45)
endMinuteminute within the ending hour when the period ends (0, 15, 30 or 45)
TariffRecurringPeriodCreateRequestDto
tariffIdId of the tariff this period will belong to
groupIdId of the tariff period group this period will belong to
dayOfWeekCapitalized name of the day of the week
startHourhour that the period starts at
endHourhour that the period ends at
priceprice during the period
endDayOfWeekCapitalized name of the day of the week that the price is for
startMinuteminute within startHour that the period starts at: 0, 15, 30 or 45. Defaults to 0
endMinuteminute within endHour that the period ends at: 0, 15, 30 or 45. Defaults to 0
TariffRecurringPeriodUpdateRequestDto
dayOfWeekCapitalized name of the day of the week
endDayOfWeekCapitalized name of the end day of the week
startHourhour that the period starts at
endHourhour that the period ends at
startMinuteminute within startHour that the period starts at: 0, 15, 30 or 45
endMinuteminute within endHour that the period ends at: 0, 15, 30 or 45
priceprice during the period
TaxRefundMetadata
typeThe type of this metadata
idThe id of the the tax refund
kwhThe total kwh for the tax refund
chargeIdThe reference to chargeId for the tax refund
Team
idId of the team
nameName of the team
joinCodeCode to share with a user to join the team. Slugified and unique across all teams on Monta.
The address where the team is located
The currency assigned for this team
typeType of the team
userIdId of the user that owns this team
isFrozenWhether the team is frozen or not
createdAtCreation date of this team
updatedAtUpdate date of this team
paymentMethodThe team's billing method (for example source or invoice). This does not indicate whether a saved card exists; use hasPaymentCard and paymentMethods for saved payment methods.
emailEmail of the team that will receive team communications. Named "contact email" in the creation/update APIs.
financeEmailFinance email of the team that will receive finance related emails
financeCommunicationEmailRecipient for important payment notices (late payment, freeze warning, frozen). When not set, these go to financeEmail.
legalEmailLegal email of the team (certified e-mail)
externalIdExternal id of the team
Custom fields of this entity, managed by you: a flat map of string keys (1-64 characters, no : or ,) to string values (up to 256 characters), at most 20 pairs. Fields are scoped to your operator and never visible to other operators. externalId is the same value as the deprecated partnerExternalId.
recipientCodeThe recipient code used for e-invoicing
companyNameThe company name for the given team
taxIdentificationNumberThe tax identification number for the given team
vatNumberThe VAT number for the given team
companyRegistrationNumberThe company registration number for the team
The operator to this team is associated
Category of the team. Set it with category on team create and patch.
frozenReasonTeam freezing reason
featureGroupIdFeature group id assigned to team
frozenAtFrozen date of this team
blockedAtBlocked date of this team
deletedAtThe deleted date of this team
The invoice request associated with this team, if any. This is only available for teams that have set payment method as an invoice.
themeIdThe theme id associated with the team.
Tags associated with this team
The onboarding steps enabled for the team, as {step, config?, displayMode?} entries. Returned on the single-team read.
The app-onboarding welcome-screen text override. Returned on the single-team read; null when never configured (Monta's default copy is shown).
autoWithdrawEnabledWhether automatic bank withdrawal is on for the team (equivalent to autoWithdrawNextAt being set). Mutually exclusive with invoiceWithdraw (see the team settings), but legacy teams can have both set, so check invoiceWithdraw as well.
autoWithdrawNextAtWhen the next automatic withdrawal is due; null when automatic withdrawal is off. A payout only happens when the team also has a bank account, is not frozen and has enough balance.
hasPaymentCardWhether this team has at least one saved card, including expired cards. Check paymentMethods[].expired to determine whether a saved card is still valid. Only returned on the single team read, and only when the consumer also has the wallet-transactions:read scope. Always null on team lists; null when the lookup failed.
Saved payment method summaries (brand, last four digits, expiry). Only returned on the single team read, and only when the consumer also has the wallet-transactions:read scope. Always null on team lists; null when the lookup failed.
partnerExternalIdExternal Id of this entity, managed by you.
Deprecated: use customFields.externalId instead — both read and write the same value.
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
Deprecated: use customFields instead; this payload is not migrated automatically.
operatorIdDeprecated (will be removed by 01.04.24), use operator field instead.
TeamAutoWithdrawalOutcome
What happened to one team:
- enabled: switched on; if the bank-account lookup failed, reason is bank-account-unknown.
- already-on: already on; nothing changed and the next withdrawal date is kept.
- no-bank-account: switched on, but no payout happens until the team adds a bank account.
- invoice-withdraw-conflict: not switched on, because invoice withdrawal is on for the team.
- ineligible: not switched on; reason says why.
- disabled: switched off.
- already-off: already off; nothing changed.
- not-yours: not changed, because the team moved to another operator while the request ran.
- failed: not changed; reason says why, and retrying is safe.
TeamAutoWithdrawalReason
Why a team got its result:
- personal-team, frozen, invoiced-team (the team pays by invoice), no-operator: the team is ineligible.
- bank-account-unknown: the team is enabled, but whether it has a bank account could not be checked.
- unexpected-error: the team failed because of an unexpected error.
- not-attempted: the team failed because the request ran out of time before reaching it; nothing changed, so send it again.
TeamAutoWithdrawalResult
teamIdThe team the result refers to.
resultWhat happened to the team.
reasonWhy the team got this result. Always set for ineligible and failed, can be bank-account-unknown for enabled, and null otherwise.
autoWithdrawNextAtWhen the next automatic withdrawal is due. Set for enabled, no-bank-account and already-on (the existing date, unchanged), null otherwise.
TeamAutoWithdrawalSummary
requestedNumber of teams in the request.
enabledTeams switched on (enabled), including those whose bank-account lookup failed (reason bank-account-unknown).
alreadyOnTeams that were already on (already-on).
noBankAccountTeams switched on that have no bank account yet (no-bank-account).
invoiceWithdrawConflictTeams not switched on because invoice withdrawal is on (invoice-withdraw-conflict).
ineligibleTeams that cannot use automatic withdrawal (ineligible).
disabledTeams switched off (disabled).
alreadyOffTeams that were already off (already-off).
notYoursTeams that left the caller's operator while the request ran (not-yours).
failedTeams that could not be changed because of an unexpected error (failed).
TeamDto.TeamAddressDto
address1First line of address
address2Second line of address
address3Third line of address
cityThe address city
provinceThe address province
countrySubdivisionCodeISO 3166-2 country subdivision code
zipCodeThe address zip code
countryIdThe address country
TeamDto.TeamCategoryDto
identifierCategory identifier, one of: home, housing-association, cpo, parking, hotel, fleet, company, priced-by-site-owner.
nameCategory name
TeamDto.TeamTagDto
nameTag identifier
idTag id
TeamEvseGridStatusV2Response
idnameisSubscribedstatusteamIdidentitybrandNamemodelNamemodelImageUrlctClampssolarChargestatusLabelTeamGridBulkFailure
chargePointIderrorCodemessageTeamGridBulkResult
TeamGridStatusV2Response
subscribedCounttotalCountisSubscribednametitledescriptionsubscribedCountTextsubscribeCtaunsubscribeCtaunsubscribeDialogTitleunsubscribeDialogBodyunsubscribeDialogConfirmtermstermsAgreementsmartMeterConsentTitlesmartMeterConsentTextsmartMeterConsentAgreementinfoUrlTeamMember
idId of the team member
roleRole of the this member within the team
accessIndicates if the user has access to all charge points or only to selected charge points
stateState of the invitation
chargePointIdsThe charge points ids this team member has access
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
teamIdTeam id of team member
displayNameThe team member display name, formats can be: First and Last Name, User: #id, email, or phone
Operator of this team member
partnerExternalTeamIdThe partner external id for the team
teamTypeType of the team this member belongs to
userIdUser id of team member. If the user does not exist yet, it will be null
emailEmail of the team member
phonePhone number of the team member
noteNote for team member
invitedAtDate of team member was invited to join the team
invitedByEmail of the team member that invited this team member
acceptedAtDate of team member accepted the invitation
acceptedByEmail of the team member that accepted the invitation
rejectedAtDate of team member rejected the invitation
createdAtDate the team member was created
updatedAtDate the team member was updated
deletedAtDate the team member was deleted
priceGroupIdThe price group for this team member
costGroupIdThe cost group for this team member
costCenterIdThe cost center assigned to this team member. null when none is assigned, and always null while the invitation is still pending.
teamMemberProfileIdThe team member profile id to apply to this team member
canConfigureChargePointsIndicates if the team member can configure charge points
canPayWithTeamWalletIndicates if the team member can pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canManageTeamWalletIndicates if team member has access to withdraw and deposit from your team wallet to your bank account
canDepositToWalletIndicates if team member can deposit to team wallet
canWithdrawFromWalletIndicates if team member can withdraw from team wallet
canManageChargeKeysIndicates if team member can manage charge keys for the team
canRequestSponsoringIndicates if the team member is allowed to request sponsoring from this team for their charge point
canManageTeamMembersIndicates that the team member can view and manage other members settings
partnerExternalIdExternal Id of this entity, managed by you
Custom JSON payload for this entity, managed by you.
Note: the expected shape is a flat JSON object with named keys.
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
sponsoredPriceGroupIdPrice group used to reimburse this team member for home charging. null means the employee's own cost price group is cloned at SCP creation time.
autoApproveElectricityCostWhen true, employee-submitted electricity costs are auto-approved for SCPs created for this team member.
reimbursementEnabledMaster switch — whether the team member participates in home reimbursement. Gates auto-creation of sponsored charge points on acceptance and on charge-point install.
reimbursementPayoutScheduleDefault payout schedule applied to sponsored charge points created for this team member.
reimbursementSubscriptionWhether the operator reimburses the charge-point subscription price for this team member.
TeamMemberAccess_1
definitions:
all- Indicates the team member has access all the team's charge points.selected- Indicates the team member has only access to the selected charge points.other- Fallback value, Indicates a new type was added but is not mapped/unknown on this API yet.
TeamMemberFeeDto
nameName of the member fee.
monthlyPriceMonthly price charged per member, in the team's currency.
idUnique identifier of the member fee.
teamIdIdentifier of the team this fee belongs to.
memberCountNumber of team members currently assigned to this fee.
createdAtCreation timestamp (ISO 8601).
updatedAtLast update timestamp (ISO 8601).
TeamMemberProfile
idId of the team member profile
nameThe team member profile name
roleRole of the this team member profile
teamWalletChargePaymentTypeOn which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
teamIdTeam id of team member profile
descriptionThe team member profile description
priceGroupIdThe price group for this team member profile
costGroupIdThe cost group for this team member profile
canPayWithTeamWalletIndicates if the team member profile gives access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType
canManageTeamWalletIndicates if team member profile has access to withdraw and deposit from your team wallet to your bank account
canDepositToWalletIndicates if team member profile can deposit to team wallet
canWithdrawFromWalletIndicates if team member profile can withdraw from team wallet
canManageChargeKeysIndicates if team member profile can manage charge keys for the team
canRequestSponsoringIndicates if the team member profile is allowed to request sponsoring from this team for their charge point
canManageTeamMembersIndicates that the team member profile can view and manage other members settings
canConfigureChargePointsIndicates that the team member profile can configure charge points
canPayForChargesCountryIdsList of country ids for which the team member can pay for charges
Operator of this team member
createdAtDate the team member profile was created
updatedAtDate the team member profile was updated
deletedAtDate the team member profile was deleted
kwhPriceCapAcMaximum price per kWh in the team currency that the team will cover when charging on AC.
kwhPriceCapDcMaximum price per kWh in the team currency that the team will cover when charging on DC.
sponsoredPriceGroupIdPrice group used to reimburse members in this profile for home charging. null means the employee's own cost price group is cloned at SCP creation time.
autoApproveElectricityCostWhen true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.
reimbursementEnabledMaster switch — whether members in this profile participate in home reimbursement.
reimbursementPayoutScheduleDefault payout schedule applied to sponsored charge points created for members in this profile.
reimbursementSubscriptionWhether the operator reimburses the charge-point subscription price for members in this profile.
TeamOnboardingResult
statusWhether the onboarding steps were applied to this team.
teamIdThe team the outcome refers to.
errorReason the team failed, absent when the status is UPDATED.
TeamOrOperator
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: identifier, name | |
| type = object · requires: publicName |
nameName of operator
identifierIdentifier of operator
idID of the operator
partnerIdId of the partner
vatNumberVAT number
TeamSettings
teamIdId of the team these settings belong to
invoiceWithdrawWhether team balance is withdrawn via invoice. Mutually exclusive with autoWithdrawEnabled.
joinCodeCode used to join the team
selfRegisterChargeKeysWhether members can self-register charge keys for this team
autoAcceptInvitationRequestsWhether team join requests are accepted automatically
autoGenerateChargePointGroupsWhether charge point groups are generated automatically for the team
showMembersOnAppWhether team members are shown in the app
customerTypeCustomer type of the team
invoicePeriodInvoicing period for the team
invoiceDestinationCodeDestination code used on team invoices
poNumberPurchase order number applied to team invoices
eanNumberEAN/CIF number of the team
partnerExternalIdExternal id assigned to the team by the partner
inventoryOnlyChargeKeysWhether the team is restricted to only charge keys that are in the operator inventory
The onboarding steps enabled for the team, as {step, config?, displayMode?} entries. Absent unless the feature is enabled for the operator.
onboardingProfileIdThe onboarding profile the team is locked to; null when its steps are set directly.
The app-onboarding welcome-screen text override; null when never configured (Monta's default copy is shown). Absent unless the feature is enabled for the operator.
autoWithdrawEnabledWhether automatic bank withdrawal is on for the team (equivalent to autoWithdrawNextAt being set). Mutually exclusive with invoiceWithdraw, but legacy teams can have both set, so check invoiceWithdraw as well. Change it with autoWithdraw on PATCH /teams/{id}.
autoWithdrawNextAtWhen the next automatic withdrawal is due; null when automatic withdrawal is off.
TeamWalletChargePaymentType
On which chargers is the team member allowed to pay with Team Wallet?
* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session
ThemeCreate
nameName of the theme
app_primary_colorPrimary colour for the app
app_secondary_colorSecondary colour for the app
portal_primary_colorPrimary colour for the portal
portal_secondary_colorSecondary colour for the portal
app_imageApp logo as a base64-encoded data URL. Allowed MIME types: image/png, image/jpeg, image/svg+xml. Max 4 MB.
portal_imagePortal logo as a base64-encoded data URL.
portal_fav_iconPortal favicon as a base64-encoded data URL.
defaultsidebar_theming_enabledWhether sidebar theming is enabled
ThemeDto
nameName of the theme
titleTitle of the theme formatted with operator name
primaryColorPrimary color in HEX format
secondaryColorSecondary color in HEX format
logoUrlUrl of the logo image
favIconUrlUrl of the favicon image
Operator associated with the theme
idUnique identifier of the theme
ThemeOperatorDto
identifierOperator identifier
idOperator id
themingEnabledIndicates if theming is enabled for the operator
ThemeUpdate
nameName of the theme
defaultsidebar_theming_enabledWhether sidebar theming is enabled
app_primary_colorPrimary colour for the app
app_secondary_colorSecondary colour for the app
portal_primary_colorPrimary colour for the portal
portal_secondary_colorSecondary colour for the portal
app_imageReplacement app logo as a base64-encoded data URL
portal_imageReplacement portal logo as a base64-encoded data URL
portal_fav_iconReplacement portal favicon as a base64-encoded data URL
ThirdPartyIntegrationStatusDto
enabledWhether the integration is currently connected
ThirdPartyIntegrationsDto
AllStar integration status
TimePeriod
dateDate for the statistics
Performance metrics for the day
Token
accessTokenAccess token, required to interact with our endpoints.
refreshTokenRefresh token, required to get a new access token.
accessTokenExpirationDateExpiration date of access token (1 hour)
refreshTokenExpirationDateExpiration date of refresh token (24 hours)
UpdateAutoStart
stateDesired auto-start state. on enables instant-start, off disables.
UpdateBankAccount
typeWhich set of fields identifies the account.iban requires iban. swift requires swift. bsb requires bsb. sort_account requires sortCode and accountNumber. routing_account requires routingNumber, accountNumber and accountType. local_canadian requires institutionNumber, transitNumber and accountNumber. emirates requires iban.
nameName of the bank account
ibanIBAN of the bank account. Validated against its check digits.
swiftSWIFT/BIC of the bank account
bsbBSB number of the bank account (Australia)
sortCodeSort code of the bank account (United Kingdom)
accountNumberAccount number of the bank account
routingNumberRouting number of the bank account (United States)
accountTypeAccount type, required with receive option routing_account
transitNumberTransit number of the bank account (Canada, 5 digits)
institutionNumberInstitution number of the bank account (Canada, 3 digits)
UpdateChargePointPublishSettings
identifierPublic identifier (kept stable when omitted).
enabledToggle the public web link on or off. When omitted, the current value is preserved.
UpdateChargingRule
nameName of the charging rule
typeThe type of the charging rule
isActiveIndicates if this rule is active
isSponsoredIndicates if the charge is sponsored
The settings of the charging rule, depending on the type of the rule
vehicleIdVehicle id of the vehicle this rule applies to
UpdateEvseRequest
updateExternalPowerLimitphaseSetupminCurrentAmaxCurrentAmaxPowerWminPowerWzeroAllowedloadManagementDisabledexternalPowerLimitWexternalPowerLimitExpiresAtUpdateInstallerJobChargePointDto
serialNumberSerial number to set on the charge point. Mutually exclusive with note and isActive.
connectorConnector id to set on the charge point. Mutually exclusive with note and isActive.
noteOperator note for the charge point. Mutually exclusive with serialNumber, connector and isActive.
isActiveActivate or deactivate the charge point. Mutually exclusive with serialNumber, connector and note.
UpdateLocalPaymentTerminalDto
payingTeamIdidTagidTagPrefixnamepriceLimitUpdateNodeRequest
namefuseLimitApowerLimitWbufferAmaxExpectedResidualCurrentAmaxExpectedResidualPowerWUpdateOperatorList
nameNew name for the operator list.
descriptionNew description for the operator list.
syncModeNew reconciliation mode for a FILTER list. Only AUTO is supported. Ignored for a manual list.
New filter definition for a FILTER list (charge-point lists only). A list's source is immutable, so this may only be set on a list that is already FILTER-source.
UpdateOperatorListItems
actionWhether to add the provided items to the list or remove them from it.
The items to add or remove. All entity ids must belong to your operator's scope.
UpdateOperatorTeam
operatorTeamWhether this team should be marked as an operator team. Operator teams have special privileges within the platform, such as managing charge points and infrastructure.
UpdatePowerLimitScheduleRequest
UpdateProfileMembersAction
Action to perform on team members in the profile
* add - Add team members to the profile
* remove - Remove team members from the profile
UpdateProfileMembersDto
actionAction to perform on team members in the profile
* add - Add team members to the profile
* remove - Remove team members from the profile
team_member_idsUpdatePromotionCode
nameName of the promotion code
code^[a-z0-9]+(?:-[a-z0-…Unique code string. Cannot be changed once used. Must be lowercase alphanumeric, optionally hyphen-separated.
descriptionDescription of the promotion code
amountDiscount amount or percentage. Cannot be changed once the code has been used.
maxUsesCountMaximum number of times the code can be used
startAtWhen the promotion code becomes active (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
endAtWhen the promotion code expires (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
maxDiscountAmountCap on the total discount a single driver can accumulate from this code. Once a driver reaches it the code stops discounting for them; the code stays usable for everyone else. Ignored for credit. Omit to leave unchanged.
selectedTeamIdsTeam IDs the promotion code is restricted to. Pass an empty array to clear restrictions.
amountKwhkWh allowance the discount covers per budget period. Ignored for credit, and must be enabled for your operator.
budgetPeriodTypecalendar-monthReset window for the kWh allowance; calendar-month resets on the 1st, null means a lifetime cap. Ignored for credit.
includeHomeChargingWhether the kWh allowance also covers charge points owned by the subscribing team, so home charging draws on the same allowance as public charging.
selectedListIdsList IDs the promotion code is restricted to. Pass an empty array to clear restrictions.
maxChargeUsesCountMax charges per driver eligible for the discount after redeeming. Omit to leave unchanged.
UpdateRevenueShareAgreement
endedAtWhen the agreement ended.
startedAtWhen the agreement started.
attributionSourceTeamIdOptional id of the team charges are attributed to.
UpdateRevenueSharePolicy
name.*\S.*Human-readable name.
descriptionOptional internal description.
policyValueThe share value.
moneyFlowHow the settled share reaches the recipient.
validFromStart of the validity window.
validToEnd of the validity window.
UpdateRfidChargeIntentRequest
typedepartureTimeUpdateSchedule
nameName of the schedule.
price_group_idId of the default price group applied during scheduled windows.
visibilityDefault visibility for charge points in this schedule.
timezoneTimezone for interpreting the schedule entry times.
selected_charge_point_idsReplaces the set of charge points assigned to this schedule. Omit to leave unchanged.
selected_site_idsReplaces the set of sites assigned to this schedule. Omit to leave unchanged.
Replaces the schedule entries. Omit to leave unchanged.
UpdateScheduleEntry
day_of_weekDay of week this entry applies to.
fromStart time of this entry (HH:mm or HH:mm:ss).
toEnd time of this entry (HH:mm or HH:mm:ss).
idId of an existing entry to update. Omit to create a new entry.
visibilityVisibility override for this time window.
price_group_idPrice group override for this time window.
UpdateSiteConfigRequest
countryAreatimeZoneIddefaultBatteryCapacityKwhrampUpProtectionEnabledgridConnectionTypevehicleAwareRampUpDurationSecondssubPrioritizationNONE is deprecated, use EQUAL_SHARE.
topUpEnableddcChargingEfficiencyFactorappSmartChargeOverrideEnabledoptimizerVersionUpdateSiteRequest
nametopNodeFuseLimitAteamIdcommentUpdateSolarPanelRequest
externalIdlatitudelongitudedeclinationazimuthpeakProductionKwUpdateSubscription
discountPercentagePercentage discount to set on the subscription.
discountAbsoluteAbsolute discount to set on the subscription.
nextPurchaseAtDate when the wallet will next be charged (ISO8601: yyyy-MM-ddTHH:mm:ssZ).
Subscription configuration, based on the plan's serviceType. Currently you can configure tax-refund subscriptions only.
UpdateTariffRequest
externalIdexternal id
nameRadius Elnet A/S
descriptionShort description of this tariff
countryIdId of the country where the tariff is applicable
currencyIdId of the currency in which the tariff is applicable
pricesWithVatIndication if prices are with vat
activeIndication if this tariff is active
timeZoneWhat timezone is the tariff active in
areaHuman description of the area the tariff is active in
countryAreaIdId of the country area where the tariff is applicable
teamIdTeam id
zipCodesZip codes where this tariff is applicable
tariffTypeDynamic or weekly
customerTypeWhat kind of customer types are the tariff for?
UpdateTeamMemberFeeDto
nameName of the member fee.
monthly_priceMonthly price charged per member, in the team's currency.
UpdateVehicle
nameName of the vehicle
modelIdId of the vehicle model. Omit or leave null to keep the existing value.
teamIdId of the team the vehicle belongs to
licensePlateLicense plate of the vehicle
brandManual vehicle brand name.
modelNameManual vehicle model name.
vehicleTypeVehicle type.
vid^$|^VID:[0-9A-Fa-f]{…VID identifier for auto-charge. Format: VID:xxxxxxxxxxxx. Send an empty string to remove the vehicle's VID.
UpdateVehicleIdIntentRequest
vehicleIdTag.*\S.*vehicleIdbatteryCapacityKwhtypedepartureTimeUpsertChargePointTicket
titleTitle of the ticket
statusStatus of the ticket, normalised across external systems
nativeStatusStatus as reported by the external system
urlHTTPS link to the ticket in the external system
alertIdId of the alert that triggered the ticket
alertOpenedAtWhen the triggering alert was opened
ticketCreatedAtWhen the ticket was created in the external system
commentCountNumber of comments on the ticket in the external system
lastCommentAtWhen the last comment was added in the external system
returnedToServiceAtWhen the external system reported the charge point back in service
User
idId of the user
firstNameFirst name of the user
lastNameLast name of the user
emailEmail of the user
legalEmailLegal email of the user (certified e-mail)
phonePhone number of the user
profileImageUrlURL of the profile image
Address of the user
languagePreferred language of the user
termsReadAtTimestamp when the user read the terms
taxIdentificationNumberPersonal tax number if set for the user
vatNumberVAT number which is the company tax id
recipientCodeThe recipient code used for e-invoicing
createdAtTimestamp when the user was created
updatedAtTimestamp when the user was last updated
deletedAtTimestamp when the user was deleted
emailVerifiedAtTimestamp when the email was verified
phoneVerifiedAtTimestamp when the phone was verified
marketingEmailsAcceptedAtTimestamp when the user accepted the marketing emails
defaultTeamIdID of the default team for the user
isGuestIndicates whether this user is a guest (ad-hoc) user who has not yet completed registration
nationalIdNational identification number. Returned only when configured per operator
hasPaymentCardWhether this user has at least one saved card, including expired cards. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
hasValidPaymentCardWhether this user has at least one saved card that has not expired. Only returned on the single user read, and only when the consumer also has the wallet-transactions:read scope. Always null on user lists; null when the lookup failed.
ValidateCodeRequestDto
codeThe promotion code to validate
Vehicle
vehicleIdTagvehicleIdbatteryCapacityKwhintegrationCapacityKwhmaxKwAcmaxKwDcVehicleBrand
nameName of the vehicle brand
idId of the vehicle brand
logoUrlURL of the brand logo
integrationStatusIntegration status of the brand. Null if no integration available, otherwise SUPPORTED or BETA
VehicleConnector
nameName of the vehicle connector
slugSlug of the vehicle connector
idId of the vehicle connector
VehicleCustomSpecification
brandManually configured vehicle brand
modelManually configured vehicle model
vehicleTypeVehicle type
VehicleModel
Brand of the vehicle model
modelModel name
displayNameDisplay name of the vehicle model
List of connectors supported by this vehicle model
idId of the vehicle model
variantVariant of the vehicle model
releaseYearRelease year of the vehicle model
pictureUrlURL of the vehicle model picture
capacityKwhBattery capacity in kWh
maxKwAcMaximum AC charging power in kW
maxKwDcMaximum DC charging power in kW
VehicleUser
idId of the user the vehicle is shared with
ownerWhether this user is the owner of the vehicle
nameDisplay name of the user
profileImageUrlProfile image URL of the user
Vehicle_1
idId of the vehicle
teamIdTeam Id that the vehicle belongs to
userIdUser Id that the vehicle belongs to
nameName of the vehicle, can be customized by the user
licensePlateLicense plate of the vehicle
batteryCapacityKwhBattery capacity of the vehicle in Kwh
maxPowerKwAcMaximum AC charging power (in kW) that the vehicle can accept when charging via an AC charger
maxPowerKwDcMaximum DC charging power (in kW) that the vehicle can accept when using a DC fast charger
displayNameDisplay name of the vehicle
integrationIdId of the vehicle integration
integrationStatusStatus of the vehicle integration
manuallyConfiguredAtTimestamp when the vehicle was manually configured (null if using catalog model)
Custom specification for manually configured vehicles
vidVID identifier for auto-charge
Vehicle_2
idId of the vehicle integration
lastSeenAtVehicle was last seen at
vinVehicle identification number
odometerOdometer in Km
Charge state of the vehicle
Location of the vehicle. It is available only if the necessary permissions have been granted and applies exclusively to team-owned vehicles, not end-user vehicles.
VerificationOutcome
Whole-charge verification verdict, ordered by how much attention it demands: flagged > inconclusive > noted > verified. not_run means nothing was evaluated.
VerificationResult
idId of the verification result
resultKeyStable identifier of the detector that produced this result
resultVersionVersion of the detector logic that produced this result. Bumped when the rule changes meaning, so older results stay interpretable.
categoryWhat the detector was checking for
severityHow much attention the result demands
outcomeWhat the detector concluded for this single check
outcomeLabelHuman-readable label for outcome
resultTypeWhich bucket of the roll-up this result counts towards
Detector-specific supporting values. The shape varies per resultKey; treat as opaque. Always an object, {} when the detector recorded nothing.
detectedAtWhen the detector produced this result (ISO8601: yyyy-MM-ddTHH:mm:ssZ)
headlineOne-line summary of the finding, when the detector produced one
resolvedAtWhen the result was resolved by an operator (ISO8601: yyyy-MM-ddTHH:mm:ssZ). Null while open.
resolutionNoteNote the operator left when resolving the result
VioconMeterIntegration
meterIdentifiertimeoutSecondsVisibilityType
definitions:
private- Indicates the charge point access is private, only available to users from operator umbrella.public- Indicates the charge point access is public.
Wallet
ownerTypeType of owner: operator, team
idId of the wallet
ownerIdId of the owner of this wallet, either a teamId or operatorId (depending on ownerType)
currencyIdCurrency of this wallet.
countryIdCountryId of this wallet.
Balance of this wallet, if available (not in list endpoints).
WalletDto.BalanceDto
amountAmount of the balance
creditAmount of the credit
WalletTransaction
Currency for fromAmount.
Currency used for toAmount.
createdAtCreation date of transaction
groupTransaction group of this transaction
kindKind of this transaction, ie 'charge-sponsored'.
Note: This is an open field and therefore more kinds will be added moving forward.
stateTransaction state of this transaction
idId of the transaction
fromAmountAmount sent, incl. VAT
fromSubAmountAmount sent, excl. VAT
fromVatAmountVAT amount sent
fromTypeType of sender: operator, team
Type of sender: operator, team
fromWalletIdId of the wallet where the amount was sent from. Can be null if the transaction did not originate from a wallet.
toAmountAmount received, incl. VAT
toSubAmountAmount received, excl. VAT
toVatAmountVAT amount received
toTypeType of receiver: operator, team
Type of sender: operator, team
toWalletIdId of the wallet where the amount was sent to. Can be null if the transaction did not target a wallet.
exchangeRateExchange rate used for currency conversion
updatedAtUpdate date of transaction
completedAtCompletion date of transaction
referenceIdReference id of this transaction. e.g the charge id
referenceTypeReference type of this transaction.
vatPercentageVAT percentage included in this transaction.
noteA note that has been entered for this transaction.
Additional information for this transaction
partnerExternalId**Note: This has been deprecated and will be null always.**External Id of this entity, managed by you.
**Note: This has been deprecated and will be null always.**Custom JSON payload for this entity, managed by you.
WalletTransactionReferenceType
WebhookConfig
webhookUrlhttps://(?!(.*monta\… · requiredA HTTPS URL to send the webhook payload to when an event occurs.
webhookSecretA cryptoghrapic secret used to sign the webhook payload.
eventTypesA list of event types to subscribe to.
Custom headers to send with the webhook request. Note: Maximum of 5 headers are allowed. Must start with 'X-' (case-insensitive).
teamIdsAn optional list of team IDs. When set, only webhook events related to charge points belonging to one of the specified teams will be delivered. If omitted or set to null, events for all teams are delivered (current behaviour).
WebhookEntry
eventTypeCode
payload of this entry
statusStatus of the entry
createdAtCreation date of this entry
idId of the entry
consumerIdId of the consumer this entry belongs to
operatorIdId of the operator this entry belongs to
Contains the error message if the delivery failed
updatedAtUpdate date of this entry
WebhookEntry.EventType
WebhookEntryErrorPayload
errorCodeerror code for the entry
errorMessageerror message for the entry
WebhookEntryPayload
entityTypeType of the entity
eventTypeType of the event
entityIdId of the entity, if applicable
eventTimeThe timestamp indicating when the event was generated in ISO 8601 format (e.g. 2024-10-22T16:56:45.999Z)
payload of this entity, e.g. a full Charge object
WebhookEntryPayload.EntityType
WebhookEntryReplay
idsIds of the failed entries to replay.
fromDateReplay failed entries created at or after this time.
toDateReplay failed entries created at or before this time.
eventTypesOnly replay failed entries of these event types.
WebhookEntryReplayResult
replayedNumber of failed entries queued for delivery again.
WelcomeEmailCounts
successCountNumber of users the welcome email was sent to
skippedCountNumber of users skipped because they already got the welcome email
failureCountNumber of users the welcome email could not be sent to
WelcomeEmailItemResult
statussent: the welcome email was queued. skipped: the user already got the welcome email, nothing was sent (see force). failed: the email was not sent, see error
userIdId of the requested user
errorWhy the email was not sent, null when sent. USER_NOT_FOUND: the user does not exist or is not one of your users. USER_HAS_NO_EMAIL: the user has no email address. ALREADY_SENT: the user already got the welcome email. UNEXPECTED_ERROR: the email could not be queued, retry later