Retrieve a list of charges

get

https://partner-api.monta.com/api/v1/charges

Required scope: charge-transactions:read
Organization authorization: supported

Pagination Limit: A maximum of 20,000 charges can be retrieved. To retrieve more data, use more specific filters, like date range filters such as fromDate, toDate, fromUpdatedDate, fromCompletedDate, or toCompletedDate.

Concurrency Limit: Only a small number of charge list requests may be in flight per consumer at a time. Further requests are rejected with 429 and errorCode CONCURRENCY_LIMIT_EXCEEDED; wait for a page to complete before requesting the next one.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 0

page number to retrieve (starts with 0)

perPage

int32

Defaults to 10

number of items per page (between 1 and 100, default 10)

teamId

int64 | null

Filter to retrieve charges with specified teamId
Note: Depending on the operatorRole the teamId will filter differently:
operatorRole = owner: will filter charges from charge points that are owned by the team
operatorRole = payer: will filter charges paid by team

operatorId

int64 | null

Filter to retrieve charges with specified operatorId
*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.
Note: When not provided and operatorRole = payer the default operator will be used for the given consumer, if the default operator cannot be assigned the request will be rejected

chargePointId

int64 | null

Filter to retrieve charges with specified chargePointId

siteId

int64 | null

Filter to retrieve charges with specified siteId

state

string | null

enum

Filter to retrieve charges by state

fromDate

date-time | null

Filter to retrieve charges where createdAt >= fromDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

toDate

date-time | null

Filter to retrieve charges where createdAt <= toDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

fromUpdatedDate

date-time | null

Filter to retrieve charges where updatedAt >= fromUpdatedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

fromCompletedDate

date-time | null

Filter to retrieve charges where completedAt >= fromCompletedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

toCompletedDate

date-time | null

Filter to retrieve charges where completedAt <= toCompletedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

chargeAuthType

string | null

enum

Filter to retrieve charges by the charge authentication type, must be combined with chargeAuthId

Allowed:

chargeAuthId

string | null

Filter to retrieve charges by the charge authentication id, must be combined with chargeAuthType
Note: for type vehicleId chargeAuthId must not include the VID: prefix

partnerExternalId

string | null

Filter charges by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

operatorRole

string | null

enum

Defaults to owner

Filter to indicate the desired role to list charges
e.g owner will always deliver charges from the operator charge points
payer will deliver charges paid by the operator

Allowed:

Responses

429

Too many charge list requests in flight for this consumer (errorCode CONCURRENCY_LIMIT_EXCEEDED)

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of charges that match the criteria

400The request is invalid

401Consumer with provided credentials was not found

403Operator doesn't have access to resource

404Entity with the provided id was not found