Documentation on managing charging stations using the API
This guide is intended for developers using the GraphQL API to work with charging station data. The API allows you to retrieve information about stations, manage their status, and perform other operations available in the system. To access the API, you must have a registered username and password, as well as access rights corresponding to your permission level.
API Endpoints
# Testing:
https://api.testing.itcharge.ru/graphql/cp
# Production:
https://api.itcharge.ru/graphql/cp
A playground is available for testing at https://api.testing.itcharge.ru/playground and the production environment at https://api.itcharge.ru/playground. It allows you to manually execute API requests, explore data structures, test authentication, and interact with other API features in real-time.
Key Concepts
GraphQL
GraphQL is a query language for APIs that allows you to request only the data you need. It provides a unified interface for interacting with data. More information about GraphQL.
Queries
Queries allow you to retrieve data from the server. In GraphQL, you define the structure of the response, avoiding overload with unnecessary information.
Mutations
Mutations are used to change data on the server. They work similarly to queries but modify the data state.
Subscriptions
Subscriptions allow you to receive real-time updates when data changes on the server.
Request Structure
{
query {
field
}
}
Registration
To register a new account, you need to follow these steps:
Post your phone number and wait for an SMS with a confirmation one-time code
mutation OTPGenerate {
OTPGenerate(phoneNumber: "+77777777777") {
expiresAt
}
}
{
"data": {
"OTPGenerate": {
"expiresAt": "2024-12-09T12:51:00.766Z"
}
}
}
Confirm your phone number with a request containing the code from the SMS message
Don't forget to specify the application version in the request (only required in the account registration process)
{
"x-application-version": "0.1.2-web-app"
}
{
OTPVerify (phoneNumber: "+77777777777", otp: "8146") {
token, customerId, companies { id, name, address, phone }
}
}
{
"data": {
"OTPVerify": {
"token": "HERE_IS_YOUR_JWT_TOKEN",
"customerId": "293c3a47-458e-465a-a1cf-fb18774e78bf",
"companies": [
{
"id": "f4bf6f80-f413-4d64-aa4f-b20f80e5d59b",
"name": "IT CHARGE CORP FLEET TESTING",
"address": null,
"phone": "+77777777777"
}
]
}
}
}
You need to save the obtained token and use it in the Authorization header for all subsequent requests to the server. The token is inserted into the Authorization header of each request.
{
"Authorization": "HERE_IS_YOUR_JWT_TOKEN"
}
In this way, you can access protected resources and perform various operations on the server using your authorization token. Make sure to store it in a safe place and do not share it with third parties.
Top up balance
To make payments, please provide your correct e-mail address.
mutation {
CurrentUserEdit (email: your@mail) {
email, country
}
}
{
"data": {
"CurrentUserEdit": {
"email": "your@mail.address",
"country": "RUSSIAN_FEDERATION"
}
}
}
Then add a bank card by make an request and follow redirectUrl.
mutation {
AddNewPayment (paymentType: "BANK_CARD", idempotenceKey: "8ef7aa6f-b14e-4aac-8b04-d8e9fa5c49a9") {
status, redirectUrl, confirmationToken, returnUrl
}
}
{
"data": {
"AddNewPayment": {
"status": "PENDING",
"redirectUrl": "https://yoomoney.ru/checkout/payments/v2/contract?orderId=2ee90c5c-000f-5000-9000-1d4ae235fd4f",
"confirmationToken": null,
"returnUrl": null
}
}
}
Get a list of bank cards
{
PaymentMethods {
id, paymentType, last4, cardType, selected
}
}
{
"data": {
"PaymentMethods": [
{
"id": "2bd7f32b-30f6-4e29-af5b-934ae5e4211a",
"paymentType": "BANK_CARD",
"last4": 4477,
"cardType": "MASTER_CARD",
"selected": true
}
]
}
}
Replenishment of the personal account balance
mutation {
PaymentsTopUp (amount: 100, idempotenceKey: "cb95cb89-85c7-4a85-9b21-e4c6d6304101", paymentMethodId: "2bd7f32b-30f6-4e29-af5b-934ae5e4211a") {
redirectUrl
}
}
{
"data": {
"PaymentsTopUp": {
"redirectUrl": "https://yoomoney.ru/checkout/payments/v2/contract?orderId=2ee917bc-000f-5000-8000-13ce8e6aef99",
}
}
}
Check your available balance and payment status
{
BalanceBrief {
currency, status, total, invoicesInProcess { id, seqNo, status, amount, currency, createdAt, invoiceItems { id, purpose, amount, currency, description, transaction { id, seqNo } } }
}
}
{
"data": {
"BalanceBrief": {
"currency": "RUB",
"status": "POSITIVE",
"total": 22567.58,
"invoicesInProcess": [
{
"id": "07e89a5f-7ec1-493e-877c-d8e8221a1e44",
"seqNo": 643,
"status": "PENDING",
"amount": 100,
"currency": "RUB",
"createdAt": "2024-12-04T10:45:48.439Z",
"invoiceItems": [
{
"id": "687",
"purpose": "TRANSACTION",
"amount": 100,
"currency": "RUB",
"description": "Payment for the transaction",
"transaction": {
"id": "5b6c7da0-f3ca-4b0c-9f26-b3fa68a9a633",
"seqNo": 908
}
}
]
}
]
}
}
}
Charging process
Retrieving the list of available charging stations
To retrieve the number and list of available charging stations, send the ChargingStationsList query with the Page definition as the appropriate parameter to the server.
{
ChargingStationsList(page: { size: 2, number: 1 }) {
count
rows {
id
name
}
}
}
{
"data": {
"ChargingStationsList": {
"count": 135,
"rows": [
{
"id": "6c3f3185-65af-47f0-bd38-ba6a6111110a",
"name": "Charging station 7329 Center Avenue"
},
{
"id": "6f48dcda-9a1a-40fc-af4e-1f8fb3fb216d",
"name": "Charging station 77422 Aleen Key"
}
]
}
}
}
Retrieving the parameters of the selected charging station
To find out the parameters of the selected charging station, you need to use the request ChargingStation. As an additional parameter, specify the id of the station received in the previous step:
{
ChargingStation(chargingStationId: "a7be80bf-926a-42f2-9658-5c6eddfa3b40") {
id
name
evses {
connectors {
id
evseId
}
}
}
}
{
"data": {
"ChargingStation": {
"id": "a7be80bf-926a-42f2-9658-5c6eddfa3b40",
"name": "Test321",
"evses": [
{
"connectors": [
{
"id": 1,
"evseId": 1
}
]
}
]
}
}
}
Initiating a new charging transaction
To initiate a new charging transaction, use the StartTransaction mutation. In the request, provide the chargingStationId, evseId, and not required connectorId along with the authorization token in the header:
{
"StartTransaction": {
"chargingStationId": "ec173d2f-26a9-4c80-b174-19523a84f85b",
"connectorId": 1,
"evseId": 1,
"remoteStartId": null,
"error": {
"code": null,
"errorText": null
}
}
}
{
"data": {
"StartTransaction": {
"remoteStartId": 994,
"error": null
}
}
}
Retrieving the active transaction
To get details of the active charging transaction, use the TransactionCard query with an activeTransaction filter:
{
TransactionCard(activeTransaction: { eq :true }) {
id
chargingState
}
}
{
"data": {
"TransactionCard": {
"id": "c0be9a96-29ba-46dd-b873-b82312ff7642",
"chargingState": "CHARGING"
}
}
}
Stopping a transaction
To stop a transaction, use the StopTransaction mutation with the transactionId as an argument:
{
mutation {
StopTransaction(
transactionId: "c0be9a96-29ba-46dd-b873-b82312ff7642"
) {
success
error {
code
errorText
}
}
}
{
"data": {
"StopTransaction": {
"success": true,
"error": null
}
}
}
Getting the status of the transaction after stopping
To get the status of the transaction after stopping it, use the Transaction query with the transactionId as an argument:
{
Transaction(transactionId: "c0be9a96-29ba-46dd-b873-b82312ff7642") {
chargingState
chargingStationName
}
}
{
"data": {
"Transaction": {
"chargingState": "EVCONNECTED",
"chargingStationName": "Test emulatorIskra"
}
}
}
Retrieving a list of transactions
To get the count and list of transactions available to you, you need to use the TransactionsList query specifying page variable size and number with authorization token in the header.
{
TransactionsList(page: { number: 1, size: 5 }) {
count
rows {
seqNo
id
startedPercentage
chargingState
percentage
stoppedReason
startedTimestamp
stoppedTimestamp
isRoaming
transactionStep
startedKW
latestKW
totalKW
totalDuration
currentKW
stopInitiator
updatedAt
createdAt
tariff {
type
amount
name
currency
}
connector {
id
evseId
type
status
}
payment {
amount
currency
}
invoice {
amount
currency
status
}
chargingStation {
id
name
}
authorization {
customer {
id
phone
seqNo
}
company {
id
name
}
}
tenant
}
}
}
{
"data": {
"TransactionsList": {
"count": 825,
"rows": [
{
"seqNo": 824,
"id": "c053e61b-d754-4eac-9b19-f0ab16a49d07",
"startedPercentage": 21,
"chargingState": "EVCONNECTED",
"percentage": 27,
"stoppedReason": "REMOTE",
"startedTimestamp": "2024-11-13T18:15:13.242Z",
"stoppedTimestamp": "2024-11-13T18:17:42.869Z",
"isRoaming": false,
"transactionStep": "FINISHED_SUCCESS",
"startedKW": 0,
"latestKW": 0.8,
"totalKW": 0.8,
"totalDuration": 3,
"currentKW": null,
"stopInitiator": "USER",
"updatedAt": "2024-11-13T18:17:42.902Z",
"createdAt": "2024-11-13T18:15:13.243Z",
"tariff": null,
"connector": {
"id": 1,
"evseId": 1,
"type": "C_CCS2",
"status": "OCCUPIED"
},
"payment": null,
"invoice": null,
"chargingStation": {
"id": "ec173d2f-26a9-4c80-b174-19523a84f85b",
"name": " Test Emulator Iskra"
},
"authorization": {
"customer": null,
"company": null
},
"tenant": "iskra"
},
{
"seqNo": 823,
"id": "88bd3591-a637-4299-8aaa-2df4bbaced3a",
"startedPercentage": 21,
"chargingState": "EVCONNECTED",
"percentage": 23,
"stoppedReason": "REMOTE",
"startedTimestamp": "2024-11-13T16:58:06.899Z",
"stoppedTimestamp": "2024-11-13T16:59:12.893Z",
"isRoaming": false,
"transactionStep": "FINISHED_SUCCESS",
"startedKW": 0,
"latestKW": 0.35,
"totalKW": 0.35,
"totalDuration": 2,
"currentKW": null,
"stopInitiator": "USER",
"updatedAt": "2024-11-13T16:59:13.089Z",
"createdAt": "2024-11-13T16:58:06.988Z",
"tariff": {
"type": "PER_KW",
"amount": 10,
"name": "Test321",
"currency": "RUB"
},
"connector": {
"id": 1,
"evseId": 1,
"type": "GBT_DC",
"status": "OCCUPIED"
},
"payment": null,
"invoice": null,
"chargingStation": {
"id": "f0ba3f22-0c3f-4167-b1ad-584403c63f73",
"name": "Test Emulator Itcharge"
},
"authorization": {
"customer": null,
"company": null
},
"tenant": "itcharge"
}
]
}
}
}
Queries
ActivePaymentMethod
Response
Returns a PaymentMethod
Example
Query
query ActivePaymentMethod {
ActivePaymentMethod {
id
paymentType
paymentService
selected
first6
last4
expiryMonth
expiryYear
cardType
issuerCountry
issuerName
ico
}
}
Response
{
"data": {
"ActivePaymentMethod": {
"id": "4",
"paymentType": "BANK_CARD",
"paymentService": "YOOKASSA",
"selected": false,
"first6": 987.65,
"last4": 123.45,
"expiryMonth": "abc123",
"expiryYear": "xyz789",
"cardType": "MASTER_CARD",
"issuerCountry": "AFGHANISTAN",
"issuerName": "xyz789",
"ico": "xyz789"
}
}
}
Balance
Example
Query
query Balance($id: ID!) {
Balance(id: $id) {
id
customer {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
seqNo
total
debit
credit
currency
description
promocode {
id
seqNo
code
name
amount
currency
active
internalPrivateUseDescription
customerId
customer {
...CustomerFragment
}
tenant
createdAt
updatedAt
}
discount {
id
seqNo
name
description
internalPrivateUseDescription
percent
amount
freeCharging
active
validFrom
validTill
discountTargets {
...DiscountTargetFragment
}
tenant
createdAt
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
payment {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
tenant
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"Balance": {
"id": 4,
"customer": Customer,
"company": Company,
"seqNo": 987.65,
"total": 987.65,
"debit": 123.45,
"credit": 987.65,
"currency": "USD",
"description": "abc123",
"promocode": Promocode,
"discount": Discount,
"invoice": Invoice,
"payment": Payment,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
BalanceBrief
Response
Returns a BalanceBrief
Example
Query
query BalanceBrief(
$customerId: String,
$companyId: String
) {
BalanceBrief(
customerId: $customerId,
companyId: $companyId
) {
total
currency
status
invoicesInProcess {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
}
}
Variables
{
"customerId": "abc123",
"companyId": "abc123"
}
Response
{
"data": {
"BalanceBrief": {
"total": 987.65,
"currency": "USD",
"status": "POSITIVE",
"invoicesInProcess": [Invoice]
}
}
}
BalanceCard
Response
Returns a BalanceCard
Arguments
| Name | Description |
|---|---|
id - Float
|
Example
Query
query BalanceCard($id: Float) {
BalanceCard(id: $id) {
id
customer {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
seqNo
total
debit
credit
currency
description
promocode {
id
seqNo
code
name
amount
currency
active
internalPrivateUseDescription
customerId
customer {
...CustomerFragment
}
tenant
createdAt
updatedAt
}
discount {
id
seqNo
name
description
internalPrivateUseDescription
percent
amount
freeCharging
active
validFrom
validTill
discountTargets {
...DiscountTargetFragment
}
tenant
createdAt
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
payment {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
tenant
createdAt
updatedAt
}
}
Variables
{"id": 123.45}
Response
{
"data": {
"BalanceCard": {
"id": 4,
"customer": Customer,
"company": Company,
"seqNo": 123.45,
"total": 987.65,
"debit": 123.45,
"credit": 987.65,
"currency": "USD",
"description": "abc123",
"promocode": Promocode,
"discount": Discount,
"invoice": Invoice,
"payment": Payment,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
BalanceCheckStatus
Response
Returns a BalanceStatus
Example
Query
query BalanceCheckStatus {
BalanceCheckStatus {
status
}
}
Response
{"data": {"BalanceCheckStatus": {"status": "POSITIVE"}}}
Balances
Response
Returns [Balance!]
Example
Query
query Balances(
$limit: Float,
$customerId: String,
$companyId: String
) {
Balances(
limit: $limit,
customerId: $customerId,
companyId: $companyId
) {
id
customer {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
seqNo
total
debit
credit
currency
description
promocode {
id
seqNo
code
name
amount
currency
active
internalPrivateUseDescription
customerId
customer {
...CustomerFragment
}
tenant
createdAt
updatedAt
}
discount {
id
seqNo
name
description
internalPrivateUseDescription
percent
amount
freeCharging
active
validFrom
validTill
discountTargets {
...DiscountTargetFragment
}
tenant
createdAt
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
payment {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
tenant
createdAt
updatedAt
}
}
Variables
{
"limit": 123.45,
"customerId": "xyz789",
"companyId": "xyz789"
}
Response
{
"data": {
"Balances": [
{
"id": "4",
"customer": Customer,
"company": Company,
"seqNo": 987.65,
"total": 123.45,
"debit": 987.65,
"credit": 987.65,
"currency": "USD",
"description": "abc123",
"promocode": Promocode,
"discount": Discount,
"invoice": Invoice,
"payment": Payment,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
BalancesList
Response
Returns a BalancesList
Arguments
| Name | Description |
|---|---|
debit - FilterCompareNumber
|
|
credit - FilterCompareNumber
|
|
total - FilterCompareNumber
|
|
customer - CustomerInputFilter
|
|
company - CompanyInputFilter
|
|
payment - PaymentInputFilter
|
|
invoice - InvoiceInputFilter
|
|
description - FilterCompareString
|
|
tenant - FilterCompareString
|
|
onlyLatest - FilterCompareBoolean
|
|
updatedAt - FilterCompareTime
|
|
createdAt - FilterCompareTime
|
|
page - Page
|
|
orderBy - [BalancesListRequestOrderInputType!]
|
Example
Query
query BalancesList(
$debit: FilterCompareNumber,
$credit: FilterCompareNumber,
$total: FilterCompareNumber,
$customer: CustomerInputFilter,
$company: CompanyInputFilter,
$payment: PaymentInputFilter,
$invoice: InvoiceInputFilter,
$description: FilterCompareString,
$tenant: FilterCompareString,
$onlyLatest: FilterCompareBoolean,
$updatedAt: FilterCompareTime,
$createdAt: FilterCompareTime,
$page: Page,
$orderBy: [BalancesListRequestOrderInputType!]
) {
BalancesList(
debit: $debit,
credit: $credit,
total: $total,
customer: $customer,
company: $company,
payment: $payment,
invoice: $invoice,
description: $description,
tenant: $tenant,
onlyLatest: $onlyLatest,
updatedAt: $updatedAt,
createdAt: $createdAt,
page: $page,
orderBy: $orderBy
) {
rows {
id
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
seqNo
total
debit
credit
currency
description
promocode {
...PromocodeFragment
}
discount {
...DiscountFragment
}
invoice {
...InvoiceFragment
}
payment {
...PaymentFragment
}
tenant
createdAt
updatedAt
}
count
}
}
Variables
{
"debit": FilterCompareNumber,
"credit": FilterCompareNumber,
"total": FilterCompareNumber,
"customer": CustomerInputFilter,
"company": CompanyInputFilter,
"payment": PaymentInputFilter,
"invoice": InvoiceInputFilter,
"description": FilterCompareString,
"tenant": FilterCompareString,
"onlyLatest": FilterCompareBoolean,
"updatedAt": FilterCompareTime,
"createdAt": FilterCompareTime,
"page": Page,
"orderBy": [BalancesListRequestOrderInputType]
}
Response
{
"data": {
"BalancesList": {
"rows": [BalanceCard],
"count": 987.65
}
}
}
CaptchaInit
Response
Returns a CaptchaResponse
Example
Query
query CaptchaInit(
$phoneNumber: String!,
$tenant: String
) {
CaptchaInit(
phoneNumber: $phoneNumber,
tenant: $tenant
) {
challenge1
challenge2
}
}
Variables
{
"phoneNumber": "xyz789",
"tenant": "xyz789"
}
Response
{
"data": {
"CaptchaInit": {
"challenge1": ["xyz789"],
"challenge2": ["abc123"]
}
}
}
CarMaker
Example
Query
query CarMaker($id: Int!) {
CarMaker(id: $id) {
id
name
fullName
models {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
logo {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"CarMaker": {
"id": 123,
"name": "abc123",
"fullName": "abc123",
"models": [CarModel],
"logo": File
}
}
}
CarMakers
Response
Returns [CarMaker!]
Example
Query
query CarMakers {
CarMakers {
id
name
fullName
models {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
logo {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Response
{
"data": {
"CarMakers": [
{
"id": 123,
"name": "xyz789",
"fullName": "xyz789",
"models": [CarModel],
"logo": File
}
]
}
}
CarModel
Example
Query
query CarModel($id: Int!) {
CarModel(id: $id) {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
id
type
images {
...FileFragment
}
}
maker {
id
name
fullName
models {
...CarModelFragment
}
logo {
...FileFragment
}
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"CarModel": {
"id": 987,
"makerId": 123,
"name": "abc123",
"fullName": "abc123",
"description": "abc123",
"batteryAmountKW": 987.65,
"country": "AFGHANISTAN",
"year": "xyz789",
"connectors": [CarModelConnector],
"maker": CarMaker,
"images": [File]
}
}
}
CarsList
Response
Returns a CarsList
Arguments
| Name | Description |
|---|---|
id - FilterCompareNumber
|
|
customer - CustomerInputFilter
|
|
emaidType - EmaidTypeEnum
|
|
vin - FilterCompareString
|
|
vehicleId - FilterCompareString
|
|
createdAt - FilterCompareTime
|
|
updatedAt - FilterCompareTime
|
|
page - Page!
|
|
orderBy - [CarsListRequestOrderInputType!]
|
Example
Query
query CarsList(
$id: FilterCompareNumber,
$customer: CustomerInputFilter,
$emaidType: EmaidTypeEnum,
$vin: FilterCompareString,
$vehicleId: FilterCompareString,
$createdAt: FilterCompareTime,
$updatedAt: FilterCompareTime,
$page: Page!,
$orderBy: [CarsListRequestOrderInputType!]
) {
CarsList(
id: $id,
customer: $customer,
emaidType: $emaidType,
vin: $vin,
vehicleId: $vehicleId,
createdAt: $createdAt,
updatedAt: $updatedAt,
page: $page,
orderBy: $orderBy
) {
rows {
id
name
description
color
emaidType
vin
vehicleId
plateNumber
year
batteryAmountKW
model {
...CarModelFragment
}
images {
...FileFragment
}
customers {
...CustomerFragment
}
}
count
}
}
Variables
{
"id": FilterCompareNumber,
"customer": CustomerInputFilter,
"emaidType": "VIN",
"vin": FilterCompareString,
"vehicleId": FilterCompareString,
"createdAt": FilterCompareTime,
"updatedAt": FilterCompareTime,
"page": Page,
"orderBy": [CarsListRequestOrderInputType]
}
Response
{"data": {"CarsList": {"rows": [Car], "count": 987.65}}}
ChargingStation
Response
Returns a ChargingStation
Example
Query
query ChargingStation(
$chargingStationId: String!,
$editMode: Boolean
) {
ChargingStation(
chargingStationId: $chargingStationId,
editMode: $editMode
) {
id
seqNo
forceBlocked
coordinates {
latitude
longitude
}
evses {
id
power
connectors {
...ConnectorFragment
}
tariff {
...TariffTypeFragment
}
hasActiveChargingProfile
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
periods {
...PeriodTypeFragment
}
}
temporaryClosedTill
active
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
uptimeMonitorings {
status
createdAt
}
transactions {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
...ChargingStationFragment
}
connector {
...ConnectorFragment
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
...TariffTypeFragment
}
payment {
...PaymentFragment
}
invoice {
...InvoiceFragment
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
...MeterValueFragment
}
authorization {
...AuthorizationFragment
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
...UserFragment
}
onReview {
...TransactionOnReviewFragment
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
territoryAccessData {
id
name
description
requestDescription
requestType
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
accessPermissionRequestData {
entryActionType
autoConfirmed
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
password
login
host
}
createdAt
updatedAt
}
}
Variables
{
"chargingStationId": "xyz789",
"editMode": true
}
Response
{
"data": {
"ChargingStation": {
"id": 4,
"seqNo": 123.45,
"forceBlocked": true,
"coordinates": Coordinates,
"evses": [Evses],
"name": "xyz789",
"address": "xyz789",
"photoUrls": ["xyz789"],
"plugshareLink": "abc123",
"description": "abc123",
"internalPrivateUseDescription": "xyz789",
"openingHours": OpeningHoursType,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"active": false,
"invisible": true,
"connected": true,
"disconnectedAt": "2007-12-03T10:15:30Z",
"distance": 123.45,
"computedStatus": "ALL_AVAILABLE",
"speed": "SLOW",
"specialIdentifier": "EVIKA",
"ocppVersion": "V120SOAP",
"serialNumber": "abc123",
"model": "xyz789",
"vendorName": "xyz789",
"firmwareVersion": "abc123",
"bootNotificationRequestAcceptedAt": "2007-12-03T10:15:30Z",
"blacklisted": false,
"isTestCS": false,
"isInRoaming": false,
"ip": "abc123",
"soapUrl": "abc123",
"vpnServerIp": "xyz789",
"connectionHost": "xyz789",
"emulator": true,
"autoAcceptAuthorizeRequests": false,
"external": true,
"canReserve": true,
"company": Company,
"uptimeMonitorings": [UptimeMonitoring],
"transactions": [Transaction],
"images": [File],
"territoryAccessData": TerritoryAccessData,
"accessPermissionRequestData": AccessPermissionRequestData,
"timezone": "abc123",
"tenant": "abc123",
"lastConnectionStatusChangedAt": "2007-12-03T10:15:30Z",
"ftpAccess": FtpAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
ChargingStationCard
Response
Returns a ChargingStationCard
Example
Query
query ChargingStationCard(
$id: String,
$seqNo: Float,
$editMode: Boolean
) {
ChargingStationCard(
id: $id,
seqNo: $seqNo,
editMode: $editMode
) {
id
seqNo
forceBlocked
coordinates {
latitude
longitude
}
evses {
id
power
connectors {
...ConnectorFragment
}
tariff {
...TariffTypeFragment
}
hasActiveChargingProfile
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
periods {
...PeriodTypeFragment
}
}
temporaryClosedTill
scheduleClosed
active
archived
debugMode
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
reservations {
id
seqNo
reserveNowId
used
canceled
cancelReason
validFrom
validTo
tariff {
...TariffTypeFragment
}
chargingStation {
...ChargingStationCardFragment
}
connector {
...ConnectorFragment
}
invoice {
...InvoiceFragment
}
authorization {
...AuthorizationFragment
}
roamingAccessId
tenant
createdAt
updatedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
supportsChargingProfiles
hasActiveChargingProfile
uptimeMonitorings {
status
createdAt
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
territoryAccessData {
id
name
description
requestDescription
requestType
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
accessPermissionRequestData {
entryActionType
autoConfirmed
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
password
login
host
}
createdAt
updatedAt
}
}
Variables
{
"id": "abc123",
"seqNo": 123.45,
"editMode": true
}
Response
{
"data": {
"ChargingStationCard": {
"id": 4,
"seqNo": 987.65,
"forceBlocked": false,
"coordinates": Coordinates,
"evses": [Evses],
"name": "abc123",
"address": "xyz789",
"photoUrls": ["abc123"],
"plugshareLink": "abc123",
"description": "xyz789",
"internalPrivateUseDescription": "xyz789",
"openingHours": OpeningHoursType,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"scheduleClosed": false,
"active": false,
"archived": true,
"debugMode": false,
"invisible": true,
"connected": false,
"disconnectedAt": "2007-12-03T10:15:30Z",
"distance": 987.65,
"computedStatus": "ALL_AVAILABLE",
"speed": "SLOW",
"specialIdentifier": "EVIKA",
"ocppVersion": "V120SOAP",
"serialNumber": "abc123",
"model": "xyz789",
"vendorName": "xyz789",
"firmwareVersion": "xyz789",
"bootNotificationRequestAcceptedAt": "2007-12-03T10:15:30Z",
"blacklisted": true,
"isTestCS": false,
"isInRoaming": false,
"ip": "xyz789",
"soapUrl": "abc123",
"vpnServerIp": "abc123",
"connectionHost": "abc123",
"emulator": false,
"autoAcceptAuthorizeRequests": false,
"external": true,
"canReserve": false,
"reservations": [ReservationCard],
"company": Company,
"supportsChargingProfiles": true,
"hasActiveChargingProfile": true,
"uptimeMonitorings": [UptimeMonitoring],
"images": [File],
"territoryAccessData": TerritoryAccessData,
"accessPermissionRequestData": AccessPermissionRequestData,
"timezone": "abc123",
"tenant": "xyz789",
"lastConnectionStatusChangedAt": "2007-12-03T10:15:30Z",
"ftpAccess": FtpAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
ChargingStationGetConfiguration
Response
Returns a ChargingStationConfiguration
Arguments
| Name | Description |
|---|---|
chargingStationId - String!
|
Example
Query
query ChargingStationGetConfiguration($chargingStationId: String!) {
ChargingStationGetConfiguration(chargingStationId: $chargingStationId) {
configuration
}
}
Variables
{"chargingStationId": "xyz789"}
Response
{
"data": {
"ChargingStationGetConfiguration": {
"configuration": "xyz789"
}
}
}
ChargingStationGetDiagnostics
Response
Returns a ChargingStationGetDiagnosticsResponse
Example
Query
query ChargingStationGetDiagnostics(
$chargingStationId: String!,
$startTime: String,
$stopTime: String
) {
ChargingStationGetDiagnostics(
chargingStationId: $chargingStationId,
startTime: $startTime,
stopTime: $stopTime
) {
fileName
}
}
Variables
{
"chargingStationId": "xyz789",
"startTime": "abc123",
"stopTime": "xyz789"
}
Response
{
"data": {
"ChargingStationGetDiagnostics": {
"fileName": "abc123"
}
}
}
ChargingStationGetLog
Response
Returns [ChargingStationLogResponse!]
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
ocppAction - AvailableOCPP160Actions
|
|
destination - OcppMessageDirection
|
|
dateFrom - String
|
|
dateTo - String
|
Example
Query
query ChargingStationGetLog(
$id: ID!,
$ocppAction: AvailableOCPP160Actions,
$destination: OcppMessageDirection,
$dateFrom: String,
$dateTo: String
) {
ChargingStationGetLog(
id: $id,
ocppAction: $ocppAction,
destination: $destination,
dateFrom: $dateFrom,
dateTo: $dateTo
) {
ocpp_action
ocpp_message_direction
ocpp_request
ocpp_response
ocpp_raw_message
ocpp_message
ocpp_raw_request
ocpp_raw_response
log_level
message
timestamp
}
}
Variables
{
"id": 4,
"ocppAction": "AUTHORIZE",
"destination": "TO_CS",
"dateFrom": "xyz789",
"dateTo": "abc123"
}
Response
{
"data": {
"ChargingStationGetLog": [
{
"ocpp_action": "xyz789",
"ocpp_message_direction": "abc123",
"ocpp_request": "abc123",
"ocpp_response": "abc123",
"ocpp_raw_message": "abc123",
"ocpp_message": "xyz789",
"ocpp_raw_request": "xyz789",
"ocpp_raw_response": "xyz789",
"log_level": "abc123",
"message": "abc123",
"timestamp": "abc123"
}
]
}
}
ChargingStationGraphInfo
Response
Returns a ChargingStationGraphInfo
Arguments
| Name | Description |
|---|---|
chargingStationId - String!
|
Example
Query
query ChargingStationGraphInfo($chargingStationId: String!) {
ChargingStationGraphInfo(chargingStationId: $chargingStationId) {
lastTransactionStep
isOffline
countUptimeForLast24H
countUptimeForLast30D
countKWForLast30D
last10Transactions {
totalKW
transactionStep
updatedAt
createdAt
}
}
}
Variables
{"chargingStationId": "xyz789"}
Response
{
"data": {
"ChargingStationGraphInfo": {
"lastTransactionStep": "CABLE_PLUGGED_IN",
"isOffline": true,
"countUptimeForLast24H": 987.65,
"countUptimeForLast30D": 123.45,
"countKWForLast30D": [987.65],
"last10Transactions": [LastTransactions]
}
}
}
ChargingStations
Response
Returns [ChargingStation!]
Arguments
| Name | Description |
|---|---|
connected - Boolean
|
|
free - Boolean
|
|
excludeTestCS - Boolean
|
|
speed - SpeedEnum
|
|
power - [PowerEnum!]
|
|
connectors - [ConnectorInputType!]
|
|
distance - CoordinatesWithDistance
|
|
distanceWithIn - CoordinatesWithDistanceAndMeters
|
|
coordinatesBox2d - ChargingStationCoordinatesBox2d
|
|
page - Page
|
|
companyIds - [String!]
|
Example
Query
query ChargingStations(
$connected: Boolean,
$free: Boolean,
$excludeTestCS: Boolean,
$speed: SpeedEnum,
$power: [PowerEnum!],
$connectors: [ConnectorInputType!],
$distance: CoordinatesWithDistance,
$distanceWithIn: CoordinatesWithDistanceAndMeters,
$coordinatesBox2d: ChargingStationCoordinatesBox2d,
$page: Page,
$companyIds: [String!]
) {
ChargingStations(
connected: $connected,
free: $free,
excludeTestCS: $excludeTestCS,
speed: $speed,
power: $power,
connectors: $connectors,
distance: $distance,
distanceWithIn: $distanceWithIn,
coordinatesBox2d: $coordinatesBox2d,
page: $page,
companyIds: $companyIds
) {
id
seqNo
forceBlocked
coordinates {
latitude
longitude
}
evses {
id
power
connectors {
...ConnectorFragment
}
tariff {
...TariffTypeFragment
}
hasActiveChargingProfile
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
periods {
...PeriodTypeFragment
}
}
temporaryClosedTill
active
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
uptimeMonitorings {
status
createdAt
}
transactions {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
...ChargingStationFragment
}
connector {
...ConnectorFragment
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
...TariffTypeFragment
}
payment {
...PaymentFragment
}
invoice {
...InvoiceFragment
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
...MeterValueFragment
}
authorization {
...AuthorizationFragment
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
...UserFragment
}
onReview {
...TransactionOnReviewFragment
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
territoryAccessData {
id
name
description
requestDescription
requestType
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
accessPermissionRequestData {
entryActionType
autoConfirmed
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
password
login
host
}
createdAt
updatedAt
}
}
Variables
{
"connected": false,
"free": true,
"excludeTestCS": true,
"speed": "SLOW",
"power": ["SLOW"],
"connectors": [ConnectorInputType],
"distance": CoordinatesWithDistance,
"distanceWithIn": CoordinatesWithDistanceAndMeters,
"coordinatesBox2d": ChargingStationCoordinatesBox2d,
"page": Page,
"companyIds": ["abc123"]
}
Response
{
"data": {
"ChargingStations": [
{
"id": "4",
"seqNo": 987.65,
"forceBlocked": false,
"coordinates": Coordinates,
"evses": [Evses],
"name": "abc123",
"address": "xyz789",
"photoUrls": ["abc123"],
"plugshareLink": "xyz789",
"description": "xyz789",
"internalPrivateUseDescription": "xyz789",
"openingHours": OpeningHoursType,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"active": true,
"invisible": false,
"connected": true,
"disconnectedAt": "2007-12-03T10:15:30Z",
"distance": 987.65,
"computedStatus": "ALL_AVAILABLE",
"speed": "SLOW",
"specialIdentifier": "EVIKA",
"ocppVersion": "V120SOAP",
"serialNumber": "abc123",
"model": "xyz789",
"vendorName": "abc123",
"firmwareVersion": "xyz789",
"bootNotificationRequestAcceptedAt": "2007-12-03T10:15:30Z",
"blacklisted": false,
"isTestCS": false,
"isInRoaming": true,
"ip": "abc123",
"soapUrl": "abc123",
"vpnServerIp": "xyz789",
"connectionHost": "abc123",
"emulator": false,
"autoAcceptAuthorizeRequests": false,
"external": false,
"canReserve": false,
"company": Company,
"uptimeMonitorings": [UptimeMonitoring],
"transactions": [Transaction],
"images": [File],
"territoryAccessData": TerritoryAccessData,
"accessPermissionRequestData": AccessPermissionRequestData,
"timezone": "abc123",
"tenant": "xyz789",
"lastConnectionStatusChangedAt": "2007-12-03T10:15:30Z",
"ftpAccess": FtpAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
ChargingStationsList
Response
Returns a ChargingStationsList
Arguments
Example
Query
query ChargingStationsList(
$id: FilterUuid,
$seqNo: FilterCompareNumber,
$archived: FilterCompareBoolean,
$debugMode: FilterCompareBoolean,
$connected: Boolean,
$blacklisted: Boolean,
$forceBlocked: Boolean,
$isTestCS: Boolean,
$invisible: Boolean,
$autoAcceptAuthorizeRequests: Boolean,
$emulator: Boolean,
$external: Boolean,
$canReserve: FilterCompareBoolean,
$name: FilterCompareString,
$serialNumber: FilterCompareString,
$companyIds: FilterArrayUuid,
$address: FilterCompareString,
$description: FilterCompareString,
$ocppVersion: FilterCompareOcppVersion,
$model: FilterCompareString,
$vendorName: FilterCompareString,
$ip: FilterCompareString,
$soapUrl: FilterCompareString,
$vpnServerIp: FilterCompareString,
$connectionHost: FilterCompareString,
$plugshareLink: FilterCompareString,
$temporaryClosedTill: FilterCompareTime,
$tenant: FilterCompareString,
$multiContains: MultiContainsInputType,
$excludeTestCS: Boolean,
$connectors: ConnectorType,
$distanceWithIn: FilterDistanceWithIn,
$coordinatesBox2d: FilterChargingStationCoordinatesBox2d,
$supportsChargingProfiles: Boolean,
$updatedAt: FilterCompareTime,
$createdAt: FilterCompareTime,
$page: Page,
$orderBy: [ChargingStationsListRequestOrderInputType!]
) {
ChargingStationsList(
id: $id,
seqNo: $seqNo,
archived: $archived,
debugMode: $debugMode,
connected: $connected,
blacklisted: $blacklisted,
forceBlocked: $forceBlocked,
isTestCS: $isTestCS,
invisible: $invisible,
autoAcceptAuthorizeRequests: $autoAcceptAuthorizeRequests,
emulator: $emulator,
external: $external,
canReserve: $canReserve,
name: $name,
serialNumber: $serialNumber,
companyIds: $companyIds,
address: $address,
description: $description,
ocppVersion: $ocppVersion,
model: $model,
vendorName: $vendorName,
ip: $ip,
soapUrl: $soapUrl,
vpnServerIp: $vpnServerIp,
connectionHost: $connectionHost,
plugshareLink: $plugshareLink,
temporaryClosedTill: $temporaryClosedTill,
tenant: $tenant,
multiContains: $multiContains,
excludeTestCS: $excludeTestCS,
connectors: $connectors,
distanceWithIn: $distanceWithIn,
coordinatesBox2d: $coordinatesBox2d,
supportsChargingProfiles: $supportsChargingProfiles,
updatedAt: $updatedAt,
createdAt: $createdAt,
page: $page,
orderBy: $orderBy
) {
rows {
id
seqNo
forceBlocked
coordinates {
...CoordinatesFragment
}
evses {
...EvsesFragment
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
...OpeningHoursTypeFragment
}
temporaryClosedTill
scheduleClosed
active
archived
debugMode
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
reservations {
...ReservationCardFragment
}
company {
...CompanyFragment
}
supportsChargingProfiles
hasActiveChargingProfile
uptimeMonitorings {
...UptimeMonitoringFragment
}
images {
...FileFragment
}
territoryAccessData {
...TerritoryAccessDataFragment
}
accessPermissionRequestData {
...AccessPermissionRequestDataFragment
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
...FtpAccessFragment
}
createdAt
updatedAt
}
count
}
}
Variables
{
"id": FilterUuid,
"seqNo": FilterCompareNumber,
"archived": FilterCompareBoolean,
"debugMode": FilterCompareBoolean,
"connected": true,
"blacklisted": true,
"forceBlocked": true,
"isTestCS": false,
"invisible": true,
"autoAcceptAuthorizeRequests": false,
"emulator": true,
"external": false,
"canReserve": FilterCompareBoolean,
"name": FilterCompareString,
"serialNumber": FilterCompareString,
"companyIds": FilterArrayUuid,
"address": FilterCompareString,
"description": FilterCompareString,
"ocppVersion": FilterCompareOcppVersion,
"model": FilterCompareString,
"vendorName": FilterCompareString,
"ip": FilterCompareString,
"soapUrl": FilterCompareString,
"vpnServerIp": FilterCompareString,
"connectionHost": FilterCompareString,
"plugshareLink": FilterCompareString,
"temporaryClosedTill": FilterCompareTime,
"tenant": FilterCompareString,
"multiContains": MultiContainsInputType,
"excludeTestCS": true,
"connectors": ConnectorType,
"distanceWithIn": FilterDistanceWithIn,
"coordinatesBox2d": FilterChargingStationCoordinatesBox2d,
"supportsChargingProfiles": false,
"updatedAt": FilterCompareTime,
"createdAt": FilterCompareTime,
"page": Page,
"orderBy": [ChargingStationsListRequestOrderInputType]
}
Response
{
"data": {
"ChargingStationsList": {
"rows": [ChargingStationCard],
"count": 123.45
}
}
}
CurrentUserBrief
Response
Returns a UserBrief
Example
Query
query CurrentUserBrief {
CurrentUserBrief {
id
seqNo
email
phone
name
surname
middlename
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
tenant
hasNotAcceptedPdAgreement
tenantSettings {
country
featureBalance
vatRate {
...VatRateFragment
}
paymentService
currency
}
customerSettings {
paymentAutoTopUpEnabled
paymentAutoTopUpAmount
paymentAutoTopUpAmountTrigger
canUseDevEnv
}
country
role
defaultCoordinates {
latitude
longitude
}
}
}
Response
{
"data": {
"CurrentUserBrief": {
"id": "4",
"seqNo": 987.65,
"email": "xyz789",
"phone": "xyz789",
"name": "abc123",
"surname": "abc123",
"middlename": "abc123",
"company": Company,
"tenant": "xyz789",
"hasNotAcceptedPdAgreement": true,
"tenantSettings": TenantSettings,
"customerSettings": CustomerSettings,
"country": "AFGHANISTAN",
"role": "SUPER_ADMIN",
"defaultCoordinates": Coordinates
}
}
}
CustomerCars
Response
Returns [Car!]
Example
Query
query CustomerCars {
CustomerCars {
id
name
description
color
emaidType
vin
vehicleId
plateNumber
year
batteryAmountKW
model {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
customers {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
}
}
Response
{
"data": {
"CustomerCars": [
{
"id": 987,
"name": "abc123",
"description": "xyz789",
"color": "BLACK",
"emaidType": "VIN",
"vin": "abc123",
"vehicleId": "abc123",
"plateNumber": "abc123",
"year": "xyz789",
"batteryAmountKW": 123.45,
"model": CarModel,
"images": [File],
"customers": [Customer]
}
]
}
}
ExternalCustomerAuthorize
Response
Returns an ExternalCustomerAuthorizeResponse
Example
Query
query ExternalCustomerAuthorize(
$tenant: String!,
$token: String!
) {
ExternalCustomerAuthorize(
tenant: $tenant,
token: $token
) {
token
customerId
companies {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
}
}
Variables
{
"tenant": "xyz789",
"token": "xyz789"
}
Response
{
"data": {
"ExternalCustomerAuthorize": {
"token": "abc123",
"customerId": "xyz789",
"companies": [Company]
}
}
}
Invoice
Example
Query
query Invoice($id: ID!) {
Invoice(id: $id) {
id
seqNo
amount
currency
status
vatRate {
id
name
description
amount
country
createdAt
updatedAt
}
internalPrivateUseDescription
invoiceItems {
id
amount
currency
vatRate {
...VatRateFragment
}
purpose
description
reservation {
...ReservationCardFragment
}
transaction {
...TransactionFragment
}
discount {
...DiscountFragment
}
createdAt
updatedAt
}
payments {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
customer {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
tenant
createdAt
updatedAt
}
}
Variables
{"id": 4}
Response
{
"data": {
"Invoice": {
"id": 4,
"seqNo": 987.65,
"amount": 987.65,
"currency": "USD",
"status": "PAID",
"vatRate": VatRate,
"internalPrivateUseDescription": "xyz789",
"invoiceItems": [InvoiceItem],
"payments": [Payment],
"customer": Customer,
"company": Company,
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
Invoices
Response
Returns [Invoice!]
Example
Query
query Invoices(
$limit: Float,
$customerId: String
) {
Invoices(
limit: $limit,
customerId: $customerId
) {
id
seqNo
amount
currency
status
vatRate {
id
name
description
amount
country
createdAt
updatedAt
}
internalPrivateUseDescription
invoiceItems {
id
amount
currency
vatRate {
...VatRateFragment
}
purpose
description
reservation {
...ReservationCardFragment
}
transaction {
...TransactionFragment
}
discount {
...DiscountFragment
}
createdAt
updatedAt
}
payments {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
customer {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
tenant
createdAt
updatedAt
}
}
Variables
{"limit": 987.65, "customerId": "xyz789"}
Response
{
"data": {
"Invoices": [
{
"id": "4",
"seqNo": 123.45,
"amount": 123.45,
"currency": "USD",
"status": "PAID",
"vatRate": VatRate,
"internalPrivateUseDescription": "abc123",
"invoiceItems": [InvoiceItem],
"payments": [Payment],
"customer": Customer,
"company": Company,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
OTPVerify
Response
Returns an OtpVerifyResponse
Arguments
| Name | Description |
|---|---|
phoneNumber - String!
|
|
otp - String!
|
|
tenant - String
|
|
imageChallenge - ImageChallenge
|
Example
Query
query OTPVerify(
$phoneNumber: String!,
$otp: String!,
$tenant: String,
$imageChallenge: ImageChallenge
) {
OTPVerify(
phoneNumber: $phoneNumber,
otp: $otp,
tenant: $tenant,
imageChallenge: $imageChallenge
) {
token
customerId
companies {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
validationStatus {
otpRemainingAttempts
otpRetryIn
}
}
}
Variables
{
"phoneNumber": "abc123",
"otp": "xyz789",
"tenant": "abc123",
"imageChallenge": ImageChallenge
}
Response
{
"data": {
"OTPVerify": {
"token": "abc123",
"customerId": "xyz789",
"companies": [Company],
"validationStatus": OtpValidationStatus
}
}
}
Payment
Example
Query
query Payment($id: ID!) {
Payment(id: $id) {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
customerPhone
paymentMethodId
transactionId
transaction {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
...ChargingStationFragment
}
connector {
...ConnectorFragment
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
...TariffTypeFragment
}
payment {
...PaymentFragment
}
invoice {
...InvoiceFragment
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
...MeterValueFragment
}
authorization {
...AuthorizationFragment
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
...UserFragment
}
onReview {
...TransactionOnReviewFragment
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
chargingStationName
paymentService
amount
vatRate {
id
name
description
amount
country
createdAt
updatedAt
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"Payment": {
"id": 4,
"seqNo": 123.45,
"paid": true,
"refunded": true,
"refundId": "abc123",
"test": false,
"externalPaymentId": "xyz789",
"customerId": "abc123",
"invoice": Invoice,
"customerPhone": "abc123",
"paymentMethodId": "abc123",
"transactionId": "abc123",
"transaction": Transaction,
"chargingStationName": "abc123",
"paymentService": "YOOKASSA",
"amount": "abc123",
"vatRate": VatRate,
"incomeAmount": "xyz789",
"currency": "USD",
"description": "xyz789",
"status": "PENDING",
"capturedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"receiptStatus": "PENDING",
"receiptId": "xyz789",
"receiptUrl": "abc123",
"rrn": "abc123",
"receiptService": "BUHTA",
"cancellationParty": "YANDEX_CHECKOUT",
"cancellationReason": "abc123",
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
PaymentCard
Response
Returns a PaymentCard
Example
Query
query PaymentCard(
$id: String,
$seqNo: Float
) {
PaymentCard(
id: $id,
seqNo: $seqNo
) {
id
seqNo
status
paymentService
paid
refunded
refundId
test
amount
incomeAmount
currency
vatRate {
id
name
description
amount
country
createdAt
updatedAt
}
description
rrn
externalPaymentId
customer {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
paymentMethodId
paymentMethod {
id
paymentType
paymentService
selected
first6
last4
expiryMonth
expiryYear
cardType
issuerCountry
issuerName
ico
}
transaction {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
...ChargingStationFragment
}
connector {
...ConnectorFragment
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
...TariffTypeFragment
}
payment {
...PaymentFragment
}
invoice {
...InvoiceFragment
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
...MeterValueFragment
}
authorization {
...AuthorizationFragment
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
...UserFragment
}
onReview {
...TransactionOnReviewFragment
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
capturedAt
expiresAt
receiptService
receiptStatus
receiptId
receiptUrl
cancellationParty
cancellationReason
receiptRefundId
receiptRefundUrl
tenant
createdAt
updatedAt
}
}
Variables
{"id": "abc123", "seqNo": 987.65}
Response
{
"data": {
"PaymentCard": {
"id": 4,
"seqNo": 987.65,
"status": "PENDING",
"paymentService": "YOOKASSA",
"paid": false,
"refunded": true,
"refundId": "abc123",
"test": true,
"amount": "abc123",
"incomeAmount": "xyz789",
"currency": "USD",
"vatRate": VatRate,
"description": "xyz789",
"rrn": "abc123",
"externalPaymentId": "abc123",
"customer": Customer,
"invoice": Invoice,
"paymentMethodId": "xyz789",
"paymentMethod": PaymentMethod,
"transaction": Transaction,
"capturedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"receiptService": "BUHTA",
"receiptStatus": "PENDING",
"receiptId": "xyz789",
"receiptUrl": "abc123",
"cancellationParty": "YANDEX_CHECKOUT",
"cancellationReason": "xyz789",
"receiptRefundId": "xyz789",
"receiptRefundUrl": "abc123",
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
PaymentMethods
Response
Returns [PaymentMethod!]
Example
Query
query PaymentMethods {
PaymentMethods {
id
paymentType
paymentService
selected
first6
last4
expiryMonth
expiryYear
cardType
issuerCountry
issuerName
ico
}
}
Response
{
"data": {
"PaymentMethods": [
{
"id": 4,
"paymentType": "BANK_CARD",
"paymentService": "YOOKASSA",
"selected": true,
"first6": 987.65,
"last4": 987.65,
"expiryMonth": "xyz789",
"expiryYear": "abc123",
"cardType": "MASTER_CARD",
"issuerCountry": "AFGHANISTAN",
"issuerName": "abc123",
"ico": "xyz789"
}
]
}
}
PaymentTopUpMethods
Response
Returns a PaymentTopUpMethods
Example
Query
query PaymentTopUpMethods {
PaymentTopUpMethods {
paymentServices {
id
ico
title
paymentService
}
paymentMethods {
id
paymentType
paymentService
selected
first6
last4
expiryMonth
expiryYear
cardType
issuerCountry
issuerName
ico
}
}
}
Response
{
"data": {
"PaymentTopUpMethods": {
"paymentServices": [PaymentService],
"paymentMethods": [PaymentMethod]
}
}
}
Payments
Response
Returns [Payment!]
Example
Query
query Payments {
Payments {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
customerPhone
paymentMethodId
transactionId
transaction {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
...ChargingStationFragment
}
connector {
...ConnectorFragment
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
...TariffTypeFragment
}
payment {
...PaymentFragment
}
invoice {
...InvoiceFragment
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
...MeterValueFragment
}
authorization {
...AuthorizationFragment
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
...UserFragment
}
onReview {
...TransactionOnReviewFragment
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
chargingStationName
paymentService
amount
vatRate {
id
name
description
amount
country
createdAt
updatedAt
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
}
Response
{
"data": {
"Payments": [
{
"id": "4",
"seqNo": 123.45,
"paid": false,
"refunded": true,
"refundId": "xyz789",
"test": true,
"externalPaymentId": "xyz789",
"customerId": "abc123",
"invoice": Invoice,
"customerPhone": "abc123",
"paymentMethodId": "abc123",
"transactionId": "abc123",
"transaction": Transaction,
"chargingStationName": "xyz789",
"paymentService": "YOOKASSA",
"amount": "abc123",
"vatRate": VatRate,
"incomeAmount": "abc123",
"currency": "USD",
"description": "abc123",
"status": "PENDING",
"capturedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"receiptStatus": "PENDING",
"receiptId": "xyz789",
"receiptUrl": "abc123",
"rrn": "abc123",
"receiptService": "BUHTA",
"cancellationParty": "YANDEX_CHECKOUT",
"cancellationReason": "abc123",
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
PaymentsList
Response
Returns a PaymentsList
Arguments
| Name | Description |
|---|---|
id - FilterUuid
|
|
test - Boolean
|
|
status - FilterComparePaymentStatus
|
|
paymentService - FilterComparePaymentService
|
|
paid - Boolean
|
|
refunded - Boolean
|
|
refundId - FilterCompareString
|
|
description - FilterCompareString
|
|
customer - CustomerInputFilter
|
|
paymentMethod - PaymentMethodInputFilter
|
|
externalPaymentId - FilterCompareString
|
|
transaction - PaymentTransactionInputFilter
|
|
rrn - FilterCompareString
|
|
tenant - FilterCompareString
|
|
page - Page
|
|
orderBy - [PaymentsListRequestOrderInputType!]
|
Example
Query
query PaymentsList(
$id: FilterUuid,
$test: Boolean,
$status: FilterComparePaymentStatus,
$paymentService: FilterComparePaymentService,
$paid: Boolean,
$refunded: Boolean,
$refundId: FilterCompareString,
$description: FilterCompareString,
$customer: CustomerInputFilter,
$paymentMethod: PaymentMethodInputFilter,
$externalPaymentId: FilterCompareString,
$transaction: PaymentTransactionInputFilter,
$rrn: FilterCompareString,
$tenant: FilterCompareString,
$page: Page,
$orderBy: [PaymentsListRequestOrderInputType!]
) {
PaymentsList(
id: $id,
test: $test,
status: $status,
paymentService: $paymentService,
paid: $paid,
refunded: $refunded,
refundId: $refundId,
description: $description,
customer: $customer,
paymentMethod: $paymentMethod,
externalPaymentId: $externalPaymentId,
transaction: $transaction,
rrn: $rrn,
tenant: $tenant,
page: $page,
orderBy: $orderBy
) {
rows {
id
seqNo
status
paymentService
paid
refunded
refundId
test
amount
incomeAmount
currency
vatRate {
...VatRateFragment
}
description
rrn
externalPaymentId
customer {
...CustomerFragment
}
invoice {
...InvoiceFragment
}
paymentMethodId
paymentMethod {
...PaymentMethodFragment
}
transaction {
...TransactionFragment
}
capturedAt
expiresAt
receiptService
receiptStatus
receiptId
receiptUrl
cancellationParty
cancellationReason
receiptRefundId
receiptRefundUrl
tenant
createdAt
updatedAt
}
count
}
}
Variables
{
"id": FilterUuid,
"test": true,
"status": FilterComparePaymentStatus,
"paymentService": FilterComparePaymentService,
"paid": false,
"refunded": true,
"refundId": FilterCompareString,
"description": FilterCompareString,
"customer": CustomerInputFilter,
"paymentMethod": PaymentMethodInputFilter,
"externalPaymentId": FilterCompareString,
"transaction": PaymentTransactionInputFilter,
"rrn": FilterCompareString,
"tenant": FilterCompareString,
"page": Page,
"orderBy": [PaymentsListRequestOrderInputType]
}
Response
{
"data": {
"PaymentsList": {
"rows": [PaymentCard],
"count": 123.45
}
}
}
PushTokenCheck
Response
Returns a ValidateResponse
Arguments
| Name | Description |
|---|---|
pushToken - String!
|
|
pushService - PushNotificationsServiceEnum
|
Example
Query
query PushTokenCheck(
$pushToken: String!,
$pushService: PushNotificationsServiceEnum
) {
PushTokenCheck(
pushToken: $pushToken,
pushService: $pushService
) {
active
}
}
Variables
{
"pushToken": "xyz789",
"pushService": "EXPO"
}
Response
{"data": {"PushTokenCheck": {"active": false}}}
ReservationCard
Response
Returns a ReservationCard
Arguments
| Name | Description |
|---|---|
id - String
|
|
seqNo - Float
|
|
authorization - AuthorizationInputFilter
|
|
activeReservation - Boolean
|
Example
Query
query ReservationCard(
$id: String,
$seqNo: Float,
$authorization: AuthorizationInputFilter,
$activeReservation: Boolean
) {
ReservationCard(
id: $id,
seqNo: $seqNo,
authorization: $authorization,
activeReservation: $activeReservation
) {
id
seqNo
reserveNowId
used
canceled
cancelReason
validFrom
validTo
tariff {
id
type
amount
currency
name
}
chargingStation {
id
seqNo
forceBlocked
coordinates {
...CoordinatesFragment
}
evses {
...EvsesFragment
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
...OpeningHoursTypeFragment
}
temporaryClosedTill
scheduleClosed
active
archived
debugMode
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
reservations {
...ReservationCardFragment
}
company {
...CompanyFragment
}
supportsChargingProfiles
hasActiveChargingProfile
uptimeMonitorings {
...UptimeMonitoringFragment
}
images {
...FileFragment
}
territoryAccessData {
...TerritoryAccessDataFragment
}
accessPermissionRequestData {
...AccessPermissionRequestDataFragment
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
...FtpAccessFragment
}
createdAt
updatedAt
}
connector {
id
evseId
pending
initiating
emergencyButtonPressed
type
status
outletType
maxAmps
power
activeTransaction {
...TransactionCardFragment
}
activeTransactionBrief {
...TransactionBriefFragment
}
tariff {
...TariffTypeFragment
}
tariffGroup {
...TariffGroupFragment
}
tariffBooking {
...TariffTypeFragment
}
tariffParkingTime {
...TariffTypeFragment
}
tariffPenaltyForBlockingCharging {
...TariffTypeFragment
}
tariffPriorityCharging {
...TariffTypeFragment
}
tariffTransaction {
...TariffTypeFragment
}
tariffTransactionStart {
...TariffTypeFragment
}
hasActiveChargingProfile
oldOCPPStatus
oldOCPPErrorCode
info
vendorId
vendorErrorCode
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
authorization {
id
seqNo
idToken
idTokenType
chargingStationId
chargingStation {
...ChargingStationFragment
}
status
transactionId
transaction {
...TransactionFragment
}
reservationId
reservation {
...ReservationCardFragment
}
customerId
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
userId
user {
...UserFragment
}
authorizationCardId
authorizationCard {
...AuthorizationCardFragment
}
ocppVersion
appVersion
initiator
app
tenant
roamingAccessId
roamingAccess {
...RoamingAccessFragment
}
createdAt
updatedAt
}
roamingAccessId
tenant
createdAt
updatedAt
}
}
Variables
{
"id": "abc123",
"seqNo": 123.45,
"authorization": AuthorizationInputFilter,
"activeReservation": false
}
Response
{
"data": {
"ReservationCard": {
"id": "4",
"seqNo": 123.45,
"reserveNowId": 123.45,
"used": false,
"canceled": true,
"cancelReason": "BY_CUSTOMER",
"validFrom": "2007-12-03T10:15:30Z",
"validTo": "2007-12-03T10:15:30Z",
"tariff": TariffType,
"chargingStation": ChargingStationCard,
"connector": Connector,
"invoice": Invoice,
"authorization": Authorization,
"roamingAccessId": 123.45,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
ReservationsList
Response
Returns a ReservationsList
Arguments
| Name | Description |
|---|---|
id - FilterUuid
|
|
seqNo - FilterCompareNumber
|
|
customer - CustomerInputFilter
|
|
chargingStation - ChargingStationInputFilter
|
|
evseId - FilterCompareNumber
|
|
connectorId - FilterCompareNumber
|
|
authorization - AuthorizationInputFilter
|
|
used - FilterCompareBoolean
|
|
canceled - FilterCompareBoolean
|
|
cancelReason - FilterCompareCancelReason
|
|
validFrom - FilterCompareTime
|
|
validTo - FilterCompareTime
|
|
tariff - TariffsListFilter
|
|
tenant - FilterCompareString
|
|
createdAt - FilterCompareTime
|
|
updatedAt - FilterCompareTime
|
|
page - Page!
|
|
orderBy - [ReservationsListRequestOrderInputType!]
|
Example
Query
query ReservationsList(
$id: FilterUuid,
$seqNo: FilterCompareNumber,
$customer: CustomerInputFilter,
$chargingStation: ChargingStationInputFilter,
$evseId: FilterCompareNumber,
$connectorId: FilterCompareNumber,
$authorization: AuthorizationInputFilter,
$used: FilterCompareBoolean,
$canceled: FilterCompareBoolean,
$cancelReason: FilterCompareCancelReason,
$validFrom: FilterCompareTime,
$validTo: FilterCompareTime,
$tariff: TariffsListFilter,
$tenant: FilterCompareString,
$createdAt: FilterCompareTime,
$updatedAt: FilterCompareTime,
$page: Page!,
$orderBy: [ReservationsListRequestOrderInputType!]
) {
ReservationsList(
id: $id,
seqNo: $seqNo,
customer: $customer,
chargingStation: $chargingStation,
evseId: $evseId,
connectorId: $connectorId,
authorization: $authorization,
used: $used,
canceled: $canceled,
cancelReason: $cancelReason,
validFrom: $validFrom,
validTo: $validTo,
tariff: $tariff,
tenant: $tenant,
createdAt: $createdAt,
updatedAt: $updatedAt,
page: $page,
orderBy: $orderBy
) {
rows {
id
seqNo
reserveNowId
used
canceled
cancelReason
validFrom
validTo
tariff {
...TariffTypeFragment
}
chargingStation {
...ChargingStationCardFragment
}
connector {
...ConnectorFragment
}
invoice {
...InvoiceFragment
}
authorization {
...AuthorizationFragment
}
roamingAccessId
tenant
createdAt
updatedAt
}
count
}
}
Variables
{
"id": FilterUuid,
"seqNo": FilterCompareNumber,
"customer": CustomerInputFilter,
"chargingStation": ChargingStationInputFilter,
"evseId": FilterCompareNumber,
"connectorId": FilterCompareNumber,
"authorization": AuthorizationInputFilter,
"used": FilterCompareBoolean,
"canceled": FilterCompareBoolean,
"cancelReason": FilterCompareCancelReason,
"validFrom": FilterCompareTime,
"validTo": FilterCompareTime,
"tariff": TariffsListFilter,
"tenant": FilterCompareString,
"createdAt": FilterCompareTime,
"updatedAt": FilterCompareTime,
"page": Page,
"orderBy": [ReservationsListRequestOrderInputType]
}
Response
{
"data": {
"ReservationsList": {
"rows": [ReservationCard],
"count": 123.45
}
}
}
SupportedCountries
Response
Returns [SupportedCountry!]!
Example
Query
query SupportedCountries {
SupportedCountries {
enum
}
}
Response
{"data": {"SupportedCountries": [{"enum": "AFGHANISTAN"}]}}
SystemMessages
Response
Returns [SystemMessage!]
Arguments
| Name | Description |
|---|---|
tenant - String
|
Example
Query
query SystemMessages($tenant: String) {
SystemMessages(tenant: $tenant) {
id
title
text
visibilityType
androidAppVersion
iosAppVersion
tenant
createdAt
updatedAt
}
}
Variables
{"tenant": "xyz789"}
Response
{
"data": {
"SystemMessages": [
{
"id": "4",
"title": "abc123",
"text": "abc123",
"visibilityType": "HIDEABLE",
"androidAppVersion": "xyz789",
"iosAppVersion": "xyz789",
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
Transaction
Response
Returns a Transaction
Example
Query
query Transaction(
$transactionId: String,
$remoteStartId: Float,
$activeTransaction: Boolean,
$unpaidTransaction: Boolean
) {
Transaction(
transactionId: $transactionId,
remoteStartId: $remoteStartId,
activeTransaction: $activeTransaction,
unpaidTransaction: $unpaidTransaction
) {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
id
seqNo
forceBlocked
coordinates {
...CoordinatesFragment
}
evses {
...EvsesFragment
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
...OpeningHoursTypeFragment
}
temporaryClosedTill
active
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
company {
...CompanyFragment
}
uptimeMonitorings {
...UptimeMonitoringFragment
}
transactions {
...TransactionFragment
}
images {
...FileFragment
}
territoryAccessData {
...TerritoryAccessDataFragment
}
accessPermissionRequestData {
...AccessPermissionRequestDataFragment
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
...FtpAccessFragment
}
createdAt
updatedAt
}
connector {
id
evseId
pending
initiating
emergencyButtonPressed
type
status
outletType
maxAmps
power
activeTransaction {
...TransactionCardFragment
}
activeTransactionBrief {
...TransactionBriefFragment
}
tariff {
...TariffTypeFragment
}
tariffGroup {
...TariffGroupFragment
}
tariffBooking {
...TariffTypeFragment
}
tariffParkingTime {
...TariffTypeFragment
}
tariffPenaltyForBlockingCharging {
...TariffTypeFragment
}
tariffPriorityCharging {
...TariffTypeFragment
}
tariffTransaction {
...TariffTypeFragment
}
tariffTransactionStart {
...TariffTypeFragment
}
hasActiveChargingProfile
oldOCPPStatus
oldOCPPErrorCode
info
vendorId
vendorErrorCode
updatedAt
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
id
type
amount
currency
name
}
payment {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
timestamp
messageId
power {
...MeterValueUnitFragment
}
voltage {
...MeterValueUnitFragment
}
current {
...MeterValueUnitFragment
}
soc {
...MeterValueUnitFragment
}
rawData
}
authorization {
id
seqNo
idToken
idTokenType
chargingStationId
chargingStation {
...ChargingStationFragment
}
status
transactionId
transaction {
...TransactionFragment
}
reservationId
reservation {
...ReservationCardFragment
}
customerId
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
userId
user {
...UserFragment
}
authorizationCardId
authorizationCard {
...AuthorizationCardFragment
}
ocppVersion
appVersion
initiator
app
tenant
roamingAccessId
roamingAccess {
...RoamingAccessFragment
}
createdAt
updatedAt
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
id
seqNo
role
company {
...CompanyFragment
}
tenant
name
surname
middlename
description
phone
email
pendingEmail
emailVerified
active
lastLogin
createdAt
updatedAt
}
onReview {
id
reviewed
description
reason
reviewerUser {
...UserFragment
}
tenant
createdAt
updatedAt
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
}
Variables
{
"transactionId": "abc123",
"remoteStartId": 987.65,
"activeTransaction": true,
"unpaidTransaction": false
}
Response
{
"data": {
"Transaction": {
"id": "4",
"seqNo": 123.45,
"startedPercentage": 987.65,
"percentage": 987.65,
"chargingStationId": "xyz789",
"chargingStation": ChargingStation,
"connector": Connector,
"hasActiveChargingProfile": true,
"chargingStationName": "abc123",
"customerId": "abc123",
"customerPhone": "abc123",
"evseId": 123.45,
"connectorId": 987.65,
"stoppedReason": "DE_AUTHORIZED",
"chargingState": "CHARGING",
"startedTimestamp": "2007-12-03T10:15:30Z",
"startChargingTimestamp": "2007-12-03T10:15:30Z",
"stoppedTimestamp": "2007-12-03T10:15:30Z",
"currentKW": 987.65,
"totalKW": 123.45,
"totalDuration": 987.65,
"tariff": TariffType,
"payment": Payment,
"invoice": Invoice,
"transactionStep": "CABLE_PLUGGED_IN",
"meterStart": 123.45,
"meterStop": 123.45,
"processedAt": "2007-12-03T10:15:30Z",
"reprocessedAt": "2007-12-03T10:15:30Z",
"startedKW": 987.65,
"latestKW": 987.65,
"meterValues": [MeterValue],
"authorization": Authorization,
"stopInitiator": "CUSTOMER",
"stoppedBySystemUserId": "abc123",
"stoppedBySystemUser": User,
"onReview": TransactionOnReview,
"tenant": "abc123",
"roamingAccessId": 987.65,
"isRoaming": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
TransactionCard
Response
Returns a TransactionCard
Arguments
| Name | Description |
|---|---|
id - String
|
|
authorization - AuthorizationInputFilter
|
|
activeTransaction - FilterCompareBoolean
|
|
unpaidTransaction - FilterCompareBoolean
|
Example
Query
query TransactionCard(
$id: String,
$authorization: AuthorizationInputFilter,
$activeTransaction: FilterCompareBoolean,
$unpaidTransaction: FilterCompareBoolean
) {
TransactionCard(
id: $id,
authorization: $authorization,
activeTransaction: $activeTransaction,
unpaidTransaction: $unpaidTransaction
) {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
id
seqNo
forceBlocked
coordinates {
...CoordinatesFragment
}
evses {
...EvsesFragment
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
...OpeningHoursTypeFragment
}
temporaryClosedTill
scheduleClosed
active
archived
debugMode
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
reservations {
...ReservationCardFragment
}
company {
...CompanyFragment
}
supportsChargingProfiles
hasActiveChargingProfile
uptimeMonitorings {
...UptimeMonitoringFragment
}
images {
...FileFragment
}
territoryAccessData {
...TerritoryAccessDataFragment
}
accessPermissionRequestData {
...AccessPermissionRequestDataFragment
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
...FtpAccessFragment
}
createdAt
updatedAt
}
connector {
id
evseId
pending
initiating
emergencyButtonPressed
type
status
outletType
maxAmps
power
activeTransaction {
...TransactionCardFragment
}
activeTransactionBrief {
...TransactionBriefFragment
}
tariff {
...TariffTypeFragment
}
tariffGroup {
...TariffGroupFragment
}
tariffBooking {
...TariffTypeFragment
}
tariffParkingTime {
...TariffTypeFragment
}
tariffPenaltyForBlockingCharging {
...TariffTypeFragment
}
tariffPriorityCharging {
...TariffTypeFragment
}
tariffTransaction {
...TariffTypeFragment
}
tariffTransactionStart {
...TariffTypeFragment
}
hasActiveChargingProfile
oldOCPPStatus
oldOCPPErrorCode
info
vendorId
vendorErrorCode
updatedAt
}
hasActiveChargingProfile
evseId
connectorId
maxAllowedSeconds
maxAllowedWh
maxAllowedMoney
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
id
type
amount
currency
name
}
payment {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
timestamp
messageId
power {
...MeterValueUnitFragment
}
voltage {
...MeterValueUnitFragment
}
current {
...MeterValueUnitFragment
}
soc {
...MeterValueUnitFragment
}
rawData
}
chartMeterValues {
meterValues {
...MeterValueFragment
}
maxPower
avgPower
soc
estimatedChargingTime
}
authorization {
id
seqNo
idToken
idTokenType
chargingStationId
chargingStation {
...ChargingStationFragment
}
status
transactionId
transaction {
...TransactionFragment
}
reservationId
reservation {
...ReservationCardFragment
}
customerId
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
userId
user {
...UserFragment
}
authorizationCardId
authorizationCard {
...AuthorizationCardFragment
}
ocppVersion
appVersion
initiator
app
tenant
roamingAccessId
roamingAccess {
...RoamingAccessFragment
}
createdAt
updatedAt
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
id
seqNo
role
company {
...CompanyFragment
}
tenant
name
surname
middlename
description
phone
email
pendingEmail
emailVerified
active
lastLogin
createdAt
updatedAt
}
onReview {
id
reviewed
description
reason
reviewerUser {
...UserFragment
}
tenant
createdAt
updatedAt
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
}
Variables
{
"id": "abc123",
"authorization": AuthorizationInputFilter,
"activeTransaction": FilterCompareBoolean,
"unpaidTransaction": FilterCompareBoolean
}
Response
{
"data": {
"TransactionCard": {
"id": 4,
"seqNo": 123.45,
"startedPercentage": 123.45,
"percentage": 123.45,
"chargingStationId": "abc123",
"chargingStation": ChargingStationCard,
"connector": Connector,
"hasActiveChargingProfile": false,
"evseId": 987.65,
"connectorId": 123.45,
"maxAllowedSeconds": 123.45,
"maxAllowedWh": 123.45,
"maxAllowedMoney": "xyz789",
"stoppedReason": "DE_AUTHORIZED",
"chargingState": "CHARGING",
"startedTimestamp": "2007-12-03T10:15:30Z",
"startChargingTimestamp": "2007-12-03T10:15:30Z",
"stoppedTimestamp": "2007-12-03T10:15:30Z",
"currentKW": 987.65,
"totalKW": 123.45,
"totalDuration": 123.45,
"tariff": TariffType,
"payment": Payment,
"invoice": Invoice,
"transactionStep": "CABLE_PLUGGED_IN",
"meterStart": 987.65,
"meterStop": 987.65,
"processedAt": "2007-12-03T10:15:30Z",
"reprocessedAt": "2007-12-03T10:15:30Z",
"startedKW": 987.65,
"latestKW": 987.65,
"meterValues": [MeterValue],
"chartMeterValues": ChartMeterValues,
"authorization": Authorization,
"stopInitiator": "CUSTOMER",
"stoppedBySystemUserId": "xyz789",
"stoppedBySystemUser": User,
"onReview": TransactionOnReview,
"tenant": "abc123",
"roamingAccessId": 123.45,
"isRoaming": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
Transactions
Response
Returns [Transaction!]
Example
Query
query Transactions {
Transactions {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
id
seqNo
forceBlocked
coordinates {
...CoordinatesFragment
}
evses {
...EvsesFragment
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
...OpeningHoursTypeFragment
}
temporaryClosedTill
active
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
company {
...CompanyFragment
}
uptimeMonitorings {
...UptimeMonitoringFragment
}
transactions {
...TransactionFragment
}
images {
...FileFragment
}
territoryAccessData {
...TerritoryAccessDataFragment
}
accessPermissionRequestData {
...AccessPermissionRequestDataFragment
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
...FtpAccessFragment
}
createdAt
updatedAt
}
connector {
id
evseId
pending
initiating
emergencyButtonPressed
type
status
outletType
maxAmps
power
activeTransaction {
...TransactionCardFragment
}
activeTransactionBrief {
...TransactionBriefFragment
}
tariff {
...TariffTypeFragment
}
tariffGroup {
...TariffGroupFragment
}
tariffBooking {
...TariffTypeFragment
}
tariffParkingTime {
...TariffTypeFragment
}
tariffPenaltyForBlockingCharging {
...TariffTypeFragment
}
tariffPriorityCharging {
...TariffTypeFragment
}
tariffTransaction {
...TariffTypeFragment
}
tariffTransactionStart {
...TariffTypeFragment
}
hasActiveChargingProfile
oldOCPPStatus
oldOCPPErrorCode
info
vendorId
vendorErrorCode
updatedAt
}
hasActiveChargingProfile
chargingStationName
customerId
customerPhone
evseId
connectorId
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
id
type
amount
currency
name
}
payment {
id
seqNo
paid
refunded
refundId
test
externalPaymentId
customerId
invoice {
...InvoiceFragment
}
customerPhone
paymentMethodId
transactionId
transaction {
...TransactionFragment
}
chargingStationName
paymentService
amount
vatRate {
...VatRateFragment
}
incomeAmount
currency
description
status
capturedAt
expiresAt
receiptStatus
receiptId
receiptUrl
rrn
receiptService
cancellationParty
cancellationReason
tenant
createdAt
updatedAt
}
invoice {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
timestamp
messageId
power {
...MeterValueUnitFragment
}
voltage {
...MeterValueUnitFragment
}
current {
...MeterValueUnitFragment
}
soc {
...MeterValueUnitFragment
}
rawData
}
authorization {
id
seqNo
idToken
idTokenType
chargingStationId
chargingStation {
...ChargingStationFragment
}
status
transactionId
transaction {
...TransactionFragment
}
reservationId
reservation {
...ReservationCardFragment
}
customerId
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
userId
user {
...UserFragment
}
authorizationCardId
authorizationCard {
...AuthorizationCardFragment
}
ocppVersion
appVersion
initiator
app
tenant
roamingAccessId
roamingAccess {
...RoamingAccessFragment
}
createdAt
updatedAt
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
id
seqNo
role
company {
...CompanyFragment
}
tenant
name
surname
middlename
description
phone
email
pendingEmail
emailVerified
active
lastLogin
createdAt
updatedAt
}
onReview {
id
reviewed
description
reason
reviewerUser {
...UserFragment
}
tenant
createdAt
updatedAt
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
}
Response
{
"data": {
"Transactions": [
{
"id": 4,
"seqNo": 123.45,
"startedPercentage": 123.45,
"percentage": 987.65,
"chargingStationId": "xyz789",
"chargingStation": ChargingStation,
"connector": Connector,
"hasActiveChargingProfile": true,
"chargingStationName": "abc123",
"customerId": "xyz789",
"customerPhone": "abc123",
"evseId": 123.45,
"connectorId": 987.65,
"stoppedReason": "DE_AUTHORIZED",
"chargingState": "CHARGING",
"startedTimestamp": "2007-12-03T10:15:30Z",
"startChargingTimestamp": "2007-12-03T10:15:30Z",
"stoppedTimestamp": "2007-12-03T10:15:30Z",
"currentKW": 123.45,
"totalKW": 123.45,
"totalDuration": 987.65,
"tariff": TariffType,
"payment": Payment,
"invoice": Invoice,
"transactionStep": "CABLE_PLUGGED_IN",
"meterStart": 987.65,
"meterStop": 987.65,
"processedAt": "2007-12-03T10:15:30Z",
"reprocessedAt": "2007-12-03T10:15:30Z",
"startedKW": 987.65,
"latestKW": 123.45,
"meterValues": [MeterValue],
"authorization": Authorization,
"stopInitiator": "CUSTOMER",
"stoppedBySystemUserId": "abc123",
"stoppedBySystemUser": User,
"onReview": TransactionOnReview,
"tenant": "xyz789",
"roamingAccessId": 123.45,
"isRoaming": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
TransactionsList
Response
Returns a TransactionsList
Arguments
| Name | Description |
|---|---|
id - FilterUuid
|
|
seqNo - FilterCompareNumber
|
|
customer - CustomerInputFilter
|
|
company - CompanyInputFilter
|
|
chargingStation - ChargingStationInputFilter
|
|
evseId - FilterCompareNumber
|
|
connectorId - FilterCompareNumber
|
|
authorization - AuthorizationInputFilter
|
|
transactionStep - FilterCompareTransactionSteps
|
|
payment - PaymentInputFilter
|
|
chargingState - FilterCompareChargingState
|
|
onReview - TransactionsOnReviewInputFilter
|
|
stoppedReason - FilterCompareStoppedReason
|
|
stopInitiator - FilterCompareStopInitiator
|
|
startedKW - FilterCompareNumber
|
|
latestKW - FilterCompareNumber
|
|
totalKW - FilterCompareNumber
|
|
tariff - TariffsListFilter
|
|
tenant - FilterCompareString
|
|
createdAt - FilterCompareTime
|
|
updatedAt - FilterCompareTime
|
|
page - Page!
|
|
orderBy - [TransactionsListRequestOrderInputType!]
|
Example
Query
query TransactionsList(
$id: FilterUuid,
$seqNo: FilterCompareNumber,
$customer: CustomerInputFilter,
$company: CompanyInputFilter,
$chargingStation: ChargingStationInputFilter,
$evseId: FilterCompareNumber,
$connectorId: FilterCompareNumber,
$authorization: AuthorizationInputFilter,
$transactionStep: FilterCompareTransactionSteps,
$payment: PaymentInputFilter,
$chargingState: FilterCompareChargingState,
$onReview: TransactionsOnReviewInputFilter,
$stoppedReason: FilterCompareStoppedReason,
$stopInitiator: FilterCompareStopInitiator,
$startedKW: FilterCompareNumber,
$latestKW: FilterCompareNumber,
$totalKW: FilterCompareNumber,
$tariff: TariffsListFilter,
$tenant: FilterCompareString,
$createdAt: FilterCompareTime,
$updatedAt: FilterCompareTime,
$page: Page!,
$orderBy: [TransactionsListRequestOrderInputType!]
) {
TransactionsList(
id: $id,
seqNo: $seqNo,
customer: $customer,
company: $company,
chargingStation: $chargingStation,
evseId: $evseId,
connectorId: $connectorId,
authorization: $authorization,
transactionStep: $transactionStep,
payment: $payment,
chargingState: $chargingState,
onReview: $onReview,
stoppedReason: $stoppedReason,
stopInitiator: $stopInitiator,
startedKW: $startedKW,
latestKW: $latestKW,
totalKW: $totalKW,
tariff: $tariff,
tenant: $tenant,
createdAt: $createdAt,
updatedAt: $updatedAt,
page: $page,
orderBy: $orderBy
) {
rows {
id
seqNo
startedPercentage
percentage
chargingStationId
chargingStation {
...ChargingStationCardFragment
}
connector {
...ConnectorFragment
}
hasActiveChargingProfile
evseId
connectorId
maxAllowedSeconds
maxAllowedWh
maxAllowedMoney
stoppedReason
chargingState
startedTimestamp
startChargingTimestamp
stoppedTimestamp
currentKW
totalKW
totalDuration
tariff {
...TariffTypeFragment
}
payment {
...PaymentFragment
}
invoice {
...InvoiceFragment
}
transactionStep
meterStart
meterStop
processedAt
reprocessedAt
startedKW
latestKW
meterValues {
...MeterValueFragment
}
chartMeterValues {
...ChartMeterValuesFragment
}
authorization {
...AuthorizationFragment
}
stopInitiator
stoppedBySystemUserId
stoppedBySystemUser {
...UserFragment
}
onReview {
...TransactionOnReviewFragment
}
tenant
roamingAccessId
isRoaming
createdAt
updatedAt
}
count
}
}
Variables
{
"id": FilterUuid,
"seqNo": FilterCompareNumber,
"customer": CustomerInputFilter,
"company": CompanyInputFilter,
"chargingStation": ChargingStationInputFilter,
"evseId": FilterCompareNumber,
"connectorId": FilterCompareNumber,
"authorization": AuthorizationInputFilter,
"transactionStep": FilterCompareTransactionSteps,
"payment": PaymentInputFilter,
"chargingState": FilterCompareChargingState,
"onReview": TransactionsOnReviewInputFilter,
"stoppedReason": FilterCompareStoppedReason,
"stopInitiator": FilterCompareStopInitiator,
"startedKW": FilterCompareNumber,
"latestKW": FilterCompareNumber,
"totalKW": FilterCompareNumber,
"tariff": TariffsListFilter,
"tenant": FilterCompareString,
"createdAt": FilterCompareTime,
"updatedAt": FilterCompareTime,
"page": Page,
"orderBy": [TransactionsListRequestOrderInputType]
}
Response
{
"data": {
"TransactionsList": {
"rows": [TransactionCard],
"count": 987.65
}
}
}
TranslationLatestVersion
Response
Returns a TranslationLatestVersionResponse!
Arguments
| Name | Description |
|---|---|
version - Float!
|
|
lang - LanguageEnum!
|
Example
Query
query TranslationLatestVersion(
$version: Float!,
$lang: LanguageEnum!
) {
TranslationLatestVersion(
version: $version,
lang: $lang
) {
version
fileLink
latest
}
}
Variables
{"version": 123.45, "lang": "RUSSIAN"}
Response
{
"data": {
"TranslationLatestVersion": {
"version": 4,
"fileLink": "xyz789",
"latest": false
}
}
}
TranslationSupportedLanguages
Response
Returns [TranslationSupportedLanguage!]!
Example
Query
query TranslationSupportedLanguages {
TranslationSupportedLanguages {
enum
en
translated
}
}
Response
{
"data": {
"TranslationSupportedLanguages": [
{
"enum": "RUSSIAN",
"en": "abc123",
"translated": "xyz789"
}
]
}
}
TranslationsList
Response
Returns a TranslationsList
Arguments
| Name | Description |
|---|---|
id - FilterCompareNumber
|
|
lang - FilterCompareLanguage
|
|
tenant - FilterCompareString
|
|
version - FilterCompareNumber
|
|
appVersion - FilterCompareString
|
|
app - FilterCompareTranslationApp
|
|
subTenantId - FilterUuid
|
|
page - Page!
|
|
orderBy - [TranslationsRequestOrderInputType!]
|
Example
Query
query TranslationsList(
$id: FilterCompareNumber,
$lang: FilterCompareLanguage,
$tenant: FilterCompareString,
$version: FilterCompareNumber,
$appVersion: FilterCompareString,
$app: FilterCompareTranslationApp,
$subTenantId: FilterUuid,
$page: Page!,
$orderBy: [TranslationsRequestOrderInputType!]
) {
TranslationsList(
id: $id,
lang: $lang,
tenant: $tenant,
version: $version,
appVersion: $appVersion,
app: $app,
subTenantId: $subTenantId,
page: $page,
orderBy: $orderBy
) {
rows {
id
lang
tenant
version
appVersion
app
subTenantId
hash
fileLink
createdAt
updatedAt
}
count
}
}
Variables
{
"id": FilterCompareNumber,
"lang": FilterCompareLanguage,
"tenant": FilterCompareString,
"version": FilterCompareNumber,
"appVersion": FilterCompareString,
"app": FilterCompareTranslationApp,
"subTenantId": FilterUuid,
"page": Page,
"orderBy": [TranslationsRequestOrderInputType]
}
Response
{
"data": {
"TranslationsList": {
"rows": [Translation],
"count": 987.65
}
}
}
Mutations
AcceptLatestPdVersion
Response
Returns a CommonResponse!
Example
Query
mutation AcceptLatestPdVersion {
AcceptLatestPdVersion {
success
error {
code
errorText
}
}
}
Response
{
"data": {
"AcceptLatestPdVersion": {
"success": false,
"error": Error
}
}
}
AddNewPayment
Response
Returns a PaymentResponse
Arguments
| Name | Description |
|---|---|
paymentType - PaymentTypeEnum!
|
|
paymentToken - String
|
|
idempotenceKey - String
|
|
card - Card
|
Example
Query
mutation AddNewPayment(
$paymentType: PaymentTypeEnum!,
$paymentToken: String,
$idempotenceKey: String,
$card: Card
) {
AddNewPayment(
paymentType: $paymentType,
paymentToken: $paymentToken,
idempotenceKey: $idempotenceKey,
card: $card
) {
status
redirectUrl
returnUrl
confirmationToken
}
}
Variables
{
"paymentType": "BANK_CARD",
"paymentToken": "abc123",
"idempotenceKey": "abc123",
"card": Card
}
Response
{
"data": {
"AddNewPayment": {
"status": "PENDING",
"redirectUrl": "abc123",
"returnUrl": "xyz789",
"confirmationToken": "abc123"
}
}
}
AuthTelegramGetCustomerToken
Response
Returns an AuthTelegramGetCustomerTokenResponse!
Example
Query
mutation AuthTelegramGetCustomerToken(
$phoneNumber: String!,
$chatId: String!,
$tenant: String!
) {
AuthTelegramGetCustomerToken(
phoneNumber: $phoneNumber,
chatId: $chatId,
tenant: $tenant
) {
token
customerId
}
}
Variables
{
"phoneNumber": "xyz789",
"chatId": "xyz789",
"tenant": "xyz789"
}
Response
{
"data": {
"AuthTelegramGetCustomerToken": {
"token": "xyz789",
"customerId": "xyz789"
}
}
}
BalanceRefund
Response
Returns a BalanceBrief
Example
Query
mutation BalanceRefund(
$refundNumber: String,
$customerId: String!
) {
BalanceRefund(
refundNumber: $refundNumber,
customerId: $customerId
) {
total
currency
status
invoicesInProcess {
id
seqNo
amount
currency
status
vatRate {
...VatRateFragment
}
internalPrivateUseDescription
invoiceItems {
...InvoiceItemFragment
}
payments {
...PaymentFragment
}
customer {
...CustomerFragment
}
company {
...CompanyFragment
}
tenant
createdAt
updatedAt
}
}
}
Variables
{
"refundNumber": "xyz789",
"customerId": "abc123"
}
Response
{
"data": {
"BalanceRefund": {
"total": 123.45,
"currency": "USD",
"status": "POSITIVE",
"invoicesInProcess": [Invoice]
}
}
}
CancelReservation
Response
Returns a CommonResponse!
Example
Query
mutation CancelReservation(
$id: String,
$seqNo: Float,
$reserveNowId: Float
) {
CancelReservation(
id: $id,
seqNo: $seqNo,
reserveNowId: $reserveNowId
) {
success
error {
code
errorText
}
}
}
Variables
{
"id": "abc123",
"seqNo": 123.45,
"reserveNowId": 987.65
}
Response
{
"data": {
"CancelReservation": {
"success": false,
"error": Error
}
}
}
CarMakerCreate
Example
Query
mutation CarMakerCreate(
$name: String!,
$fullName: String
) {
CarMakerCreate(
name: $name,
fullName: $fullName
) {
id
name
fullName
models {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
logo {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Variables
{
"name": "abc123",
"fullName": "xyz789"
}
Response
{
"data": {
"CarMakerCreate": {
"id": 123,
"name": "xyz789",
"fullName": "xyz789",
"models": [CarModel],
"logo": File
}
}
}
CarMakerRemove
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation CarMakerRemove($id: Int!) {
CarMakerRemove(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"CarMakerRemove": {"success": false, "error": Error}
}
}
CarMakerUpdate
Example
Query
mutation CarMakerUpdate(
$name: String!,
$fullName: String,
$id: Int!
) {
CarMakerUpdate(
name: $name,
fullName: $fullName,
id: $id
) {
id
name
fullName
models {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
logo {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Variables
{
"name": "xyz789",
"fullName": "abc123",
"id": 123
}
Response
{
"data": {
"CarMakerUpdate": {
"id": 987,
"name": "xyz789",
"fullName": "abc123",
"models": [CarModel],
"logo": File
}
}
}
CarModelCreate
Response
Returns a CarModel!
Arguments
| Name | Description |
|---|---|
makerId - Int!
|
|
name - String!
|
|
fullName - String
|
|
description - String
|
|
batteryAmountKW - Float
|
|
country - CountryCodeEnumType
|
|
year - String
|
|
connectors - [CarModelConnectorCreate!]!
|
Example
Query
mutation CarModelCreate(
$makerId: Int!,
$name: String!,
$fullName: String,
$description: String,
$batteryAmountKW: Float,
$country: CountryCodeEnumType,
$year: String,
$connectors: [CarModelConnectorCreate!]!
) {
CarModelCreate(
makerId: $makerId,
name: $name,
fullName: $fullName,
description: $description,
batteryAmountKW: $batteryAmountKW,
country: $country,
year: $year,
connectors: $connectors
) {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
id
type
images {
...FileFragment
}
}
maker {
id
name
fullName
models {
...CarModelFragment
}
logo {
...FileFragment
}
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Variables
{
"makerId": 123,
"name": "xyz789",
"fullName": "xyz789",
"description": "xyz789",
"batteryAmountKW": 123.45,
"country": "AFGHANISTAN",
"year": "xyz789",
"connectors": [CarModelConnectorCreate]
}
Response
{
"data": {
"CarModelCreate": {
"id": 123,
"makerId": 987,
"name": "xyz789",
"fullName": "xyz789",
"description": "xyz789",
"batteryAmountKW": 123.45,
"country": "AFGHANISTAN",
"year": "abc123",
"connectors": [CarModelConnector],
"maker": CarMaker,
"images": [File]
}
}
}
CarModelRemove
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation CarModelRemove($id: Int!) {
CarModelRemove(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"CarModelRemove": {"success": true, "error": Error}
}
}
CarModelUpdate
Response
Returns a CarModel!
Arguments
| Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
fullName - String
|
|
description - String
|
|
batteryAmountKW - Float
|
|
country - CountryCodeEnumType
|
|
year - String
|
|
connectors - [CarModelConnectorInputType!]!
|
Example
Query
mutation CarModelUpdate(
$id: Int!,
$name: String!,
$fullName: String,
$description: String,
$batteryAmountKW: Float,
$country: CountryCodeEnumType,
$year: String,
$connectors: [CarModelConnectorInputType!]!
) {
CarModelUpdate(
id: $id,
name: $name,
fullName: $fullName,
description: $description,
batteryAmountKW: $batteryAmountKW,
country: $country,
year: $year,
connectors: $connectors
) {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
id
type
images {
...FileFragment
}
}
maker {
id
name
fullName
models {
...CarModelFragment
}
logo {
...FileFragment
}
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
}
}
Variables
{
"id": 123,
"name": "xyz789",
"fullName": "xyz789",
"description": "xyz789",
"batteryAmountKW": 987.65,
"country": "AFGHANISTAN",
"year": "xyz789",
"connectors": [CarModelConnectorInputType]
}
Response
{
"data": {
"CarModelUpdate": {
"id": 123,
"makerId": 987,
"name": "abc123",
"fullName": "abc123",
"description": "abc123",
"batteryAmountKW": 123.45,
"country": "AFGHANISTAN",
"year": "abc123",
"connectors": [CarModelConnector],
"maker": CarMaker,
"images": [File]
}
}
}
ChargingStationChangeAvailability
Response
Arguments
| Name | Description |
|---|---|
chargingStationId - String!
|
|
type - AvailabilityTypeEnumType
|
|
evseId - Float!
|
|
connectorId - Float!
|
Example
Query
mutation ChargingStationChangeAvailability(
$chargingStationId: String!,
$type: AvailabilityTypeEnumType,
$evseId: Float!,
$connectorId: Float!
) {
ChargingStationChangeAvailability(
chargingStationId: $chargingStationId,
type: $type,
evseId: $evseId,
connectorId: $connectorId
) {
response
}
}
Variables
{
"chargingStationId": "abc123",
"type": "INOPERATIVE",
"evseId": 987.65,
"connectorId": 123.45
}
Response
{"data": {"ChargingStationChangeAvailability": {"response": "ACCEPTED"}}}
ChargingStationChangeConfiguration
Response
Returns a CommonResponse!
Example
Query
mutation ChargingStationChangeConfiguration(
$chargingStationId: String!,
$key: String!,
$value: String!
) {
ChargingStationChangeConfiguration(
chargingStationId: $chargingStationId,
key: $key,
value: $value
) {
success
error {
code
errorText
}
}
}
Variables
{
"chargingStationId": "abc123",
"key": "abc123",
"value": "xyz789"
}
Response
{
"data": {
"ChargingStationChangeConfiguration": {
"success": true,
"error": Error
}
}
}
ChargingStationClearCache
Response
Returns a ChargingStationClearCacheResponse!
Arguments
| Name | Description |
|---|---|
chargingStationId - String!
|
Example
Query
mutation ChargingStationClearCache($chargingStationId: String!) {
ChargingStationClearCache(chargingStationId: $chargingStationId) {
response
}
}
Variables
{"chargingStationId": "abc123"}
Response
{"data": {"ChargingStationClearCache": {"response": "ACCEPTED"}}}
ChargingStationCreateUpdate
Response
Returns a ChargingStationCard!
Arguments
| Name | Description |
|---|---|
id - String
|
|
coordinates - CoordinatesInput
|
|
evses - [EvsesInput!]
|
|
name - String
|
|
serialNumber - String
|
|
address - String
|
|
blacklisted - Boolean
|
|
invisible - Boolean
|
|
isTestCS - Boolean
|
|
forceBlocked - Boolean
|
|
emulator - Boolean
|
|
external - Boolean
|
|
canReserve - Boolean
|
|
autoAcceptAuthorizeRequests - Boolean
|
|
photoUrls - [String!]
|
|
plugshareLink - String
|
|
description - String
|
|
internalPrivateUseDescription - String
|
|
ocppVersion - OcppSupportedEnum
|
|
openingHours - OpeningHoursInput
|
|
temporaryClosedTill - DateTime
|
|
model - String
|
|
vendorName - String
|
|
companyId - String
|
|
supportsChargingProfiles - Boolean
|
|
timezone - String
|
Default = "Europe/Moscow" |
soapUrl - String
|
Example
Query
mutation ChargingStationCreateUpdate(
$id: String,
$coordinates: CoordinatesInput,
$evses: [EvsesInput!],
$name: String,
$serialNumber: String,
$address: String,
$blacklisted: Boolean,
$invisible: Boolean,
$isTestCS: Boolean,
$forceBlocked: Boolean,
$emulator: Boolean,
$external: Boolean,
$canReserve: Boolean,
$autoAcceptAuthorizeRequests: Boolean,
$photoUrls: [String!],
$plugshareLink: String,
$description: String,
$internalPrivateUseDescription: String,
$ocppVersion: OcppSupportedEnum,
$openingHours: OpeningHoursInput,
$temporaryClosedTill: DateTime,
$model: String,
$vendorName: String,
$companyId: String,
$supportsChargingProfiles: Boolean,
$timezone: String,
$soapUrl: String
) {
ChargingStationCreateUpdate(
id: $id,
coordinates: $coordinates,
evses: $evses,
name: $name,
serialNumber: $serialNumber,
address: $address,
blacklisted: $blacklisted,
invisible: $invisible,
isTestCS: $isTestCS,
forceBlocked: $forceBlocked,
emulator: $emulator,
external: $external,
canReserve: $canReserve,
autoAcceptAuthorizeRequests: $autoAcceptAuthorizeRequests,
photoUrls: $photoUrls,
plugshareLink: $plugshareLink,
description: $description,
internalPrivateUseDescription: $internalPrivateUseDescription,
ocppVersion: $ocppVersion,
openingHours: $openingHours,
temporaryClosedTill: $temporaryClosedTill,
model: $model,
vendorName: $vendorName,
companyId: $companyId,
supportsChargingProfiles: $supportsChargingProfiles,
timezone: $timezone,
soapUrl: $soapUrl
) {
id
seqNo
forceBlocked
coordinates {
latitude
longitude
}
evses {
id
power
connectors {
...ConnectorFragment
}
tariff {
...TariffTypeFragment
}
hasActiveChargingProfile
}
name
address
photoUrls
plugshareLink
description
internalPrivateUseDescription
openingHours {
periods {
...PeriodTypeFragment
}
}
temporaryClosedTill
scheduleClosed
active
archived
debugMode
invisible
connected
disconnectedAt
distance
computedStatus
speed
specialIdentifier
ocppVersion
serialNumber
model
vendorName
firmwareVersion
bootNotificationRequestAcceptedAt
blacklisted
isTestCS
isInRoaming
ip
soapUrl
vpnServerIp
connectionHost
emulator
autoAcceptAuthorizeRequests
external
canReserve
reservations {
id
seqNo
reserveNowId
used
canceled
cancelReason
validFrom
validTo
tariff {
...TariffTypeFragment
}
chargingStation {
...ChargingStationCardFragment
}
connector {
...ConnectorFragment
}
invoice {
...InvoiceFragment
}
authorization {
...AuthorizationFragment
}
roamingAccessId
tenant
createdAt
updatedAt
}
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
supportsChargingProfiles
hasActiveChargingProfile
uptimeMonitorings {
status
createdAt
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
territoryAccessData {
id
name
description
requestDescription
requestType
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
accessPermissionRequestData {
entryActionType
autoConfirmed
canChooseTime
openingHours {
...OpeningHoursTypeFragment
}
}
timezone
tenant
lastConnectionStatusChangedAt
ftpAccess {
password
login
host
}
createdAt
updatedAt
}
}
Variables
{
"id": "abc123",
"coordinates": CoordinatesInput,
"evses": [EvsesInput],
"name": "abc123",
"serialNumber": "abc123",
"address": "xyz789",
"blacklisted": false,
"invisible": true,
"isTestCS": true,
"forceBlocked": false,
"emulator": false,
"external": false,
"canReserve": true,
"autoAcceptAuthorizeRequests": true,
"photoUrls": ["abc123"],
"plugshareLink": "abc123",
"description": "abc123",
"internalPrivateUseDescription": "xyz789",
"ocppVersion": "V120SOAP",
"openingHours": OpeningHoursInput,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"model": "xyz789",
"vendorName": "xyz789",
"companyId": "abc123",
"supportsChargingProfiles": false,
"timezone": "Europe/Moscow",
"soapUrl": "xyz789"
}
Response
{
"data": {
"ChargingStationCreateUpdate": {
"id": "4",
"seqNo": 123.45,
"forceBlocked": false,
"coordinates": Coordinates,
"evses": [Evses],
"name": "abc123",
"address": "abc123",
"photoUrls": ["xyz789"],
"plugshareLink": "abc123",
"description": "xyz789",
"internalPrivateUseDescription": "abc123",
"openingHours": OpeningHoursType,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"scheduleClosed": false,
"active": true,
"archived": false,
"debugMode": true,
"invisible": false,
"connected": false,
"disconnectedAt": "2007-12-03T10:15:30Z",
"distance": 123.45,
"computedStatus": "ALL_AVAILABLE",
"speed": "SLOW",
"specialIdentifier": "EVIKA",
"ocppVersion": "V120SOAP",
"serialNumber": "abc123",
"model": "xyz789",
"vendorName": "abc123",
"firmwareVersion": "abc123",
"bootNotificationRequestAcceptedAt": "2007-12-03T10:15:30Z",
"blacklisted": true,
"isTestCS": false,
"isInRoaming": false,
"ip": "xyz789",
"soapUrl": "abc123",
"vpnServerIp": "xyz789",
"connectionHost": "xyz789",
"emulator": false,
"autoAcceptAuthorizeRequests": true,
"external": true,
"canReserve": true,
"reservations": [ReservationCard],
"company": Company,
"supportsChargingProfiles": false,
"hasActiveChargingProfile": false,
"uptimeMonitorings": [UptimeMonitoring],
"images": [File],
"territoryAccessData": TerritoryAccessData,
"accessPermissionRequestData": AccessPermissionRequestData,
"timezone": "abc123",
"tenant": "xyz789",
"lastConnectionStatusChangedAt": "2007-12-03T10:15:30Z",
"ftpAccess": FtpAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
ChargingStationDisconnect
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
id - String!
|
Example
Query
mutation ChargingStationDisconnect($id: String!) {
ChargingStationDisconnect(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": "xyz789"}
Response
{
"data": {
"ChargingStationDisconnect": {
"success": true,
"error": Error
}
}
}
ChargingStationReset
Response
Returns a ChargingStationResetResponse!
Arguments
| Name | Description |
|---|---|
chargingStationId - String!
|
|
type - ResetTypeEnum
|
Example
Query
mutation ChargingStationReset(
$chargingStationId: String!,
$type: ResetTypeEnum
) {
ChargingStationReset(
chargingStationId: $chargingStationId,
type: $type
) {
response
}
}
Variables
{
"chargingStationId": "xyz789",
"type": "HARD"
}
Response
{"data": {"ChargingStationReset": {"response": "ACCEPTED"}}}
ChargingStationUnlockConnector
Response
Returns a ChargingStationUnlockConnectorResponse!
Example
Query
mutation ChargingStationUnlockConnector(
$chargingStationId: String!,
$evseId: Float!,
$connectorId: Float!
) {
ChargingStationUnlockConnector(
chargingStationId: $chargingStationId,
evseId: $evseId,
connectorId: $connectorId
) {
response
}
}
Variables
{
"chargingStationId": "xyz789",
"evseId": 987.65,
"connectorId": 987.65
}
Response
{"data": {"ChargingStationUnlockConnector": {"response": "UNLOCKED"}}}
ChargingStationUpdateFirmwareRequest
Response
Returns a CommonResponse
Example
Query
mutation ChargingStationUpdateFirmwareRequest(
$chargingStationId: String!,
$location: String!
) {
ChargingStationUpdateFirmwareRequest(
chargingStationId: $chargingStationId,
location: $location
) {
success
error {
code
errorText
}
}
}
Variables
{
"chargingStationId": "xyz789",
"location": "abc123"
}
Response
{
"data": {
"ChargingStationUpdateFirmwareRequest": {
"success": false,
"error": Error
}
}
}
ChargingStationUpdateImages
Response
Returns [File!]!
Arguments
| Name | Description |
|---|---|
id - String!
|
|
images - [FileInput!]
|
Example
Query
mutation ChargingStationUpdateImages(
$id: String!,
$images: [FileInput!]
) {
ChargingStationUpdateImages(
id: $id,
images: $images
) {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
original {
...ImageDataFragment
}
resized {
...ImageProcessedDataFragment
}
cropped {
...ImageProcessedDataFragment
}
extracted {
...ImageProcessedDataFragment
}
}
active
}
}
Variables
{
"id": "xyz789",
"images": [FileInput]
}
Response
{
"data": {
"ChargingStationUpdateImages": [
{
"id": "xyz789",
"seqNo": 123.45,
"name": "abc123",
"description": "xyz789",
"fileType": "IMAGE",
"url": "abc123",
"mimeType": "abc123",
"extention": "xyz789",
"bucket": "abc123",
"path": "xyz789",
"size": 123.45,
"imageInfo": ImageInfo,
"active": false
}
]
}
}
CurrentUserDestroy
Response
Returns a CommonResponse!
Example
Query
mutation CurrentUserDestroy {
CurrentUserDestroy {
success
error {
code
errorText
}
}
}
Response
{
"data": {
"CurrentUserDestroy": {
"success": true,
"error": Error
}
}
}
CurrentUserEdit
Response
Returns a UserBrief!
Arguments
| Name | Description |
|---|---|
email - String
|
|
name - String
|
|
surname - String
|
|
middlename - String
|
|
country - CountryCodeEnumType
|
Example
Query
mutation CurrentUserEdit(
$email: String,
$name: String,
$surname: String,
$middlename: String,
$country: CountryCodeEnumType
) {
CurrentUserEdit(
email: $email,
name: $name,
surname: $surname,
middlename: $middlename,
country: $country
) {
id
seqNo
email
phone
name
surname
middlename
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
tenant
hasNotAcceptedPdAgreement
tenantSettings {
country
featureBalance
vatRate {
...VatRateFragment
}
paymentService
currency
}
customerSettings {
paymentAutoTopUpEnabled
paymentAutoTopUpAmount
paymentAutoTopUpAmountTrigger
canUseDevEnv
}
country
role
defaultCoordinates {
latitude
longitude
}
}
}
Variables
{
"email": "xyz789",
"name": "xyz789",
"surname": "xyz789",
"middlename": "abc123",
"country": "AFGHANISTAN"
}
Response
{
"data": {
"CurrentUserEdit": {
"id": 4,
"seqNo": 987.65,
"email": "xyz789",
"phone": "abc123",
"name": "xyz789",
"surname": "abc123",
"middlename": "abc123",
"company": Company,
"tenant": "xyz789",
"hasNotAcceptedPdAgreement": true,
"tenantSettings": TenantSettings,
"customerSettings": CustomerSettings,
"country": "AFGHANISTAN",
"role": "SUPER_ADMIN",
"defaultCoordinates": Coordinates
}
}
}
CustomerCarCreate
Response
Returns a Car
Example
Query
mutation CustomerCarCreate(
$modelId: Int!,
$name: String,
$description: String,
$color: ColorEnum,
$emaidType: EmaidTypeEnum,
$vin: String,
$vehicleId: String,
$plateNumber: String,
$year: String,
$batteryAmountKW: Float
) {
CustomerCarCreate(
modelId: $modelId,
name: $name,
description: $description,
color: $color,
emaidType: $emaidType,
vin: $vin,
vehicleId: $vehicleId,
plateNumber: $plateNumber,
year: $year,
batteryAmountKW: $batteryAmountKW
) {
id
name
description
color
emaidType
vin
vehicleId
plateNumber
year
batteryAmountKW
model {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
customers {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
}
}
Variables
{
"modelId": 987,
"name": "xyz789",
"description": "xyz789",
"color": "BLACK",
"emaidType": "VIN",
"vin": "abc123",
"vehicleId": "abc123",
"plateNumber": "xyz789",
"year": "abc123",
"batteryAmountKW": 987.65
}
Response
{
"data": {
"CustomerCarCreate": {
"id": 123,
"name": "abc123",
"description": "abc123",
"color": "BLACK",
"emaidType": "VIN",
"vin": "xyz789",
"vehicleId": "abc123",
"plateNumber": "xyz789",
"year": "abc123",
"batteryAmountKW": 987.65,
"model": CarModel,
"images": [File],
"customers": [Customer]
}
}
}
CustomerCarRemove
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
id - Int!
|
Example
Query
mutation CustomerCarRemove($id: Int!) {
CustomerCarRemove(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"CustomerCarRemove": {"success": true, "error": Error}
}
}
CustomerCarUpdate
Response
Returns a Car
Example
Query
mutation CustomerCarUpdate(
$id: Int!,
$name: String,
$description: String,
$color: ColorEnum,
$vin: String,
$plateNumber: String,
$year: String,
$batteryAmountKW: Float
) {
CustomerCarUpdate(
id: $id,
name: $name,
description: $description,
color: $color,
vin: $vin,
plateNumber: $plateNumber,
year: $year,
batteryAmountKW: $batteryAmountKW
) {
id
name
description
color
emaidType
vin
vehicleId
plateNumber
year
batteryAmountKW
model {
id
makerId
name
fullName
description
batteryAmountKW
country
year
connectors {
...CarModelConnectorFragment
}
maker {
...CarMakerFragment
}
images {
...FileFragment
}
}
images {
id
seqNo
name
description
fileType
url
mimeType
extention
bucket
path
size
imageInfo {
...ImageInfoFragment
}
active
}
customers {
id
seqNo
name
surname
middlename
description
phone
email
country
paymentMethods {
...PaymentMethodFragment
}
hasActivePaymentMethod
activePaymentMethodIssuer
totalPaymentsCount
directPaidTransactionsCount
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
otp
otpCreatedAt
internalPrivateUseDescription
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
removedAt
}
}
}
Variables
{
"id": 123,
"name": "abc123",
"description": "xyz789",
"color": "BLACK",
"vin": "abc123",
"plateNumber": "xyz789",
"year": "xyz789",
"batteryAmountKW": 123.45
}
Response
{
"data": {
"CustomerCarUpdate": {
"id": 987,
"name": "xyz789",
"description": "xyz789",
"color": "BLACK",
"emaidType": "VIN",
"vin": "abc123",
"vehicleId": "abc123",
"plateNumber": "abc123",
"year": "abc123",
"batteryAmountKW": 123.45,
"model": CarModel,
"images": [File],
"customers": [Customer]
}
}
}
ForceFinalizeTransaction
Response
Returns a CommonResponse
Example
Query
mutation ForceFinalizeTransaction(
$id: String!,
$stoppedTimestamp: DateTime!,
$latestKW: Float!
) {
ForceFinalizeTransaction(
id: $id,
stoppedTimestamp: $stoppedTimestamp,
latestKW: $latestKW
) {
success
error {
code
errorText
}
}
}
Variables
{
"id": "xyz789",
"stoppedTimestamp": "2007-12-03T10:15:30Z",
"latestKW": 123.45
}
Response
{
"data": {
"ForceFinalizeTransaction": {
"success": true,
"error": Error
}
}
}
ForcePayUnpaidTransaction
Response
Returns a ForcePaymentResponse!
Example
Query
mutation ForcePayUnpaidTransaction(
$transactionId: ID!,
$idempotenceKey: String!
) {
ForcePayUnpaidTransaction(
transactionId: $transactionId,
idempotenceKey: $idempotenceKey
) {
status
error
}
}
Variables
{
"transactionId": 4,
"idempotenceKey": "xyz789"
}
Response
{
"data": {
"ForcePayUnpaidTransaction": {"status": "PENDING", "error": "ALREADY_PAID"}
}
}
GenerateReceiptManually
Response
Returns a CommonResponse
Arguments
| Name | Description |
|---|---|
paymentId - ID!
|
|
receiptToGenerate - ReceiptGenerationTypeEnum!
|
|
amount - Float
|
Example
Query
mutation GenerateReceiptManually(
$paymentId: ID!,
$receiptToGenerate: ReceiptGenerationTypeEnum!,
$amount: Float
) {
GenerateReceiptManually(
paymentId: $paymentId,
receiptToGenerate: $receiptToGenerate,
amount: $amount
) {
success
error {
code
errorText
}
}
}
Variables
{"paymentId": 4, "receiptToGenerate": "PAYMENT", "amount": 987.65}
Response
{
"data": {
"GenerateReceiptManually": {
"success": false,
"error": Error
}
}
}
MarkTransactionReviewed
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
transactionIds - [String!]!
|
Example
Query
mutation MarkTransactionReviewed($transactionIds: [String!]!) {
MarkTransactionReviewed(transactionIds: $transactionIds) {
success
error {
code
errorText
}
}
}
Variables
{"transactionIds": ["abc123"]}
Response
{
"data": {
"MarkTransactionReviewed": {
"success": false,
"error": Error
}
}
}
OTPGenerate
Response
Returns an OtpCreateResponse!
Example
Query
mutation OTPGenerate(
$phoneNumber: String!,
$tenant: String,
$language: Language,
$captcha: String,
$latestPdVersionAccepted: Boolean,
$imageChallenge: ImageChallenge
) {
OTPGenerate(
phoneNumber: $phoneNumber,
tenant: $tenant,
language: $language,
captcha: $captcha,
latestPdVersionAccepted: $latestPdVersionAccepted,
imageChallenge: $imageChallenge
) {
expiresAt
validationStatus {
otpRemainingAttempts
otpRetryIn
phoneNumberRemainingAttempts
phoneNumberRetryIn
}
}
}
Variables
{
"phoneNumber": "abc123",
"tenant": "abc123",
"language": "RU",
"captcha": "xyz789",
"latestPdVersionAccepted": true,
"imageChallenge": ImageChallenge
}
Response
{
"data": {
"OTPGenerate": {
"expiresAt": "2007-12-03T10:15:30Z",
"validationStatus": PhoneNumberValidationStatus
}
}
}
OidcGetInternalToken
Response
Returns an OidcGetInternalTokenResponse!
Arguments
| Name | Description |
|---|---|
nonce - String!
|
Example
Query
mutation OidcGetInternalToken($nonce: String!) {
OidcGetInternalToken(nonce: $nonce) {
token
}
}
Variables
{"nonce": "xyz789"}
Response
{
"data": {
"OidcGetInternalToken": {
"token": "abc123"
}
}
}
OidcInit
Response
Returns an OidcInitResponse!
Arguments
| Name | Description |
|---|---|
service - OIDCServiceEnum!
|
Example
Query
mutation OidcInit($service: OIDCServiceEnum!) {
OidcInit(service: $service) {
nonce
redirectUrl
}
}
Variables
{"service": "DOMA"}
Response
{
"data": {
"OidcInit": {
"nonce": "xyz789",
"redirectUrl": "xyz789"
}
}
}
PayTransaction
Response
Returns a PaymentResponse!
Example
Query
mutation PayTransaction(
$transactionId: ID!,
$idempotenceKey: String!
) {
PayTransaction(
transactionId: $transactionId,
idempotenceKey: $idempotenceKey
) {
status
redirectUrl
returnUrl
confirmationToken
}
}
Variables
{
"transactionId": "4",
"idempotenceKey": "xyz789"
}
Response
{
"data": {
"PayTransaction": {
"status": "PENDING",
"redirectUrl": "abc123",
"returnUrl": "abc123",
"confirmationToken": "xyz789"
}
}
}
PaymentsCompanyTopUp
Response
Returns a CommonResponse!
Example
Query
mutation PaymentsCompanyTopUp(
$companyId: String!,
$amount: Float!,
$externalInvoiceNumber: String!
) {
PaymentsCompanyTopUp(
companyId: $companyId,
amount: $amount,
externalInvoiceNumber: $externalInvoiceNumber
) {
success
error {
code
errorText
}
}
}
Variables
{
"companyId": "xyz789",
"amount": 987.65,
"externalInvoiceNumber": "xyz789"
}
Response
{
"data": {
"PaymentsCompanyTopUp": {
"success": true,
"error": Error
}
}
}
PaymentsTopUp
Response
Returns a PaymentTopUpResponse!
Example
Query
mutation PaymentsTopUp(
$paymentServiceId: String,
$paymentMethodId: String,
$idempotenceKey: String!,
$amount: Float!
) {
PaymentsTopUp(
paymentServiceId: $paymentServiceId,
paymentMethodId: $paymentMethodId,
idempotenceKey: $idempotenceKey,
amount: $amount
) {
status
redirectUrl
returnUrl
confirmationToken
}
}
Variables
{
"paymentServiceId": "xyz789",
"paymentMethodId": "abc123",
"idempotenceKey": "abc123",
"amount": 987.65
}
Response
{
"data": {
"PaymentsTopUp": {
"status": "PENDING",
"redirectUrl": "xyz789",
"returnUrl": "xyz789",
"confirmationToken": "abc123"
}
}
}
PersonalDataVersionCreate
Response
Returns a PersonalDataVersion!
Example
Query
mutation PersonalDataVersionCreate(
$name: String!,
$description: String,
$version: Int!,
$subTenantId: String,
$tenant: String!
) {
PersonalDataVersionCreate(
name: $name,
description: $description,
version: $version,
subTenantId: $subTenantId,
tenant: $tenant
) {
id
name
description
version
subTenantId
tenant
createdAt
updatedAt
}
}
Variables
{
"name": "xyz789",
"description": "xyz789",
"version": 123,
"subTenantId": "xyz789",
"tenant": "abc123"
}
Response
{
"data": {
"PersonalDataVersionCreate": {
"id": 123.45,
"name": "xyz789",
"description": "abc123",
"version": 987,
"subTenantId": "abc123",
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
PushTokenRemove
Response
Returns a CommonResponse
Arguments
| Name | Description |
|---|---|
pushToken - String!
|
|
pushService - PushNotificationsServiceEnum
|
Example
Query
mutation PushTokenRemove(
$pushToken: String!,
$pushService: PushNotificationsServiceEnum
) {
PushTokenRemove(
pushToken: $pushToken,
pushService: $pushService
) {
success
error {
code
errorText
}
}
}
Variables
{
"pushToken": "abc123",
"pushService": "EXPO"
}
Response
{
"data": {
"PushTokenRemove": {"success": true, "error": Error}
}
}
PushTokenSave
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
pushToken - String!
|
|
pushService - PushNotificationsServiceEnum
|
Example
Query
mutation PushTokenSave(
$pushToken: String!,
$pushService: PushNotificationsServiceEnum
) {
PushTokenSave(
pushToken: $pushToken,
pushService: $pushService
) {
success
error {
code
errorText
}
}
}
Variables
{
"pushToken": "xyz789",
"pushService": "EXPO"
}
Response
{
"data": {
"PushTokenSave": {"success": true, "error": Error}
}
}
PushTokenUpdate
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
oldPushToken - String!
|
|
newPushToken - String!
|
|
pushService - PushNotificationsServiceEnum
|
Example
Query
mutation PushTokenUpdate(
$oldPushToken: String!,
$newPushToken: String!,
$pushService: PushNotificationsServiceEnum
) {
PushTokenUpdate(
oldPushToken: $oldPushToken,
newPushToken: $newPushToken,
pushService: $pushService
) {
success
error {
code
errorText
}
}
}
Variables
{
"oldPushToken": "abc123",
"newPushToken": "xyz789",
"pushService": "EXPO"
}
Response
{
"data": {
"PushTokenUpdate": {"success": true, "error": Error}
}
}
RemovePaymentMethod
Response
Returns a CommonResponse
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation RemovePaymentMethod($id: ID!) {
RemovePaymentMethod(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"RemovePaymentMethod": {
"success": true,
"error": Error
}
}
}
ReserveNow
Response
Returns a ReserveNowResponse!
Example
Query
mutation ReserveNow(
$chargingStationId: String!,
$evseId: Int!,
$connectorId: Int!,
$expiryTimeInMinutes: Int
) {
ReserveNow(
chargingStationId: $chargingStationId,
evseId: $evseId,
connectorId: $connectorId,
expiryTimeInMinutes: $expiryTimeInMinutes
) {
reservationId
reservationSeqNo
reserveNowId
error {
code
errorText
}
}
}
Variables
{
"chargingStationId": "xyz789",
"evseId": 123,
"connectorId": 123,
"expiryTimeInMinutes": 123
}
Response
{
"data": {
"ReserveNow": {
"reservationId": "abc123",
"reservationSeqNo": 987.65,
"reserveNowId": 987.65,
"error": Error
}
}
}
SetPaymentMethodSelected
Response
Returns a CommonResponse
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation SetPaymentMethodSelected($id: ID!) {
SetPaymentMethodSelected(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"SetPaymentMethodSelected": {
"success": true,
"error": Error
}
}
}
SignInAsCorporate
Response
Returns a SignInAsCorporateResponse!
Arguments
| Name | Description |
|---|---|
companyId - String!
|
Example
Query
mutation SignInAsCorporate($companyId: String!) {
SignInAsCorporate(companyId: $companyId) {
token
customerId
company {
id
seqNo
name
description
internalPrivateUseDescription
contactPerson
email
phone
country
type
zip
address
inn
kpp
contractNumber
contractIssuedAt
contractValidTill
bankAcccountNumber
bankAcccountBic
customers {
...CustomerFragment
}
chargingStations {
...ChargingStationFragment
}
authorizations {
...AuthorizationFragment
}
transactions {
...TransactionFragment
}
payments {
...PaymentFragment
}
balances {
...BalanceFragment
}
invoices {
...InvoiceFragment
}
lastMonthConsumption {
...LastMonthConsumptionFragment
}
transactionsCount {
...TransactionsCountFragment
}
last30dData {
...Last30dDataFragment
}
mostPopularByWeek {
...MostPopularByWeekFragment
}
tenant
tenantSettings {
...TenantSettingsFragment
}
createdAt
updatedAt
nameFull
nameForSign
charterType
representativePersonFull
representativePersonForSign
representativePersonJobTitleFull
representativePersonJobTitleForSign
serviceFeePercent
}
}
}
Variables
{"companyId": "xyz789"}
Response
{
"data": {
"SignInAsCorporate": {
"token": "abc123",
"customerId": "abc123",
"company": Company
}
}
}
StartTransaction
Response
Returns a StartTransactionResponse!
Arguments
| Name | Description |
|---|---|
chargingStationId - String!
|
|
evseId - Float!
|
|
connectorId - Int
|
|
limit - StartTransactionLimit
|
Example
Query
mutation StartTransaction(
$chargingStationId: String!,
$evseId: Float!,
$connectorId: Int,
$limit: StartTransactionLimit
) {
StartTransaction(
chargingStationId: $chargingStationId,
evseId: $evseId,
connectorId: $connectorId,
limit: $limit
) {
remoteStartId
error {
code
errorText
}
}
}
Variables
{
"chargingStationId": "abc123",
"evseId": 987.65,
"connectorId": 987,
"limit": StartTransactionLimit
}
Response
{
"data": {
"StartTransaction": {
"remoteStartId": 987.65,
"error": Error
}
}
}
StopTransaction
Response
Returns a CommonResponse!
Example
Query
mutation StopTransaction(
$transactionId: String,
$remoteStartId: String
) {
StopTransaction(
transactionId: $transactionId,
remoteStartId: $remoteStartId
) {
success
error {
code
errorText
}
}
}
Variables
{
"transactionId": "abc123",
"remoteStartId": "abc123"
}
Response
{
"data": {
"StopTransaction": {"success": true, "error": Error}
}
}
SuspendTransaction
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
transactionId - String!
|
Example
Query
mutation SuspendTransaction($transactionId: String!) {
SuspendTransaction(transactionId: $transactionId) {
success
error {
code
errorText
}
}
}
Variables
{"transactionId": "xyz789"}
Response
{
"data": {
"SuspendTransaction": {
"success": false,
"error": Error
}
}
}
SystemMessageCreateUpdate
Response
Returns a SystemMessage!
Example
Query
mutation SystemMessageCreateUpdate(
$id: Float,
$title: String,
$text: String,
$visibilityType: SystemMessageVisibilityEnum,
$androidAppVersion: String,
$iosAppVersion: String,
$tenant: String
) {
SystemMessageCreateUpdate(
id: $id,
title: $title,
text: $text,
visibilityType: $visibilityType,
androidAppVersion: $androidAppVersion,
iosAppVersion: $iosAppVersion,
tenant: $tenant
) {
id
title
text
visibilityType
androidAppVersion
iosAppVersion
tenant
createdAt
updatedAt
}
}
Variables
{
"id": 987.65,
"title": "abc123",
"text": "xyz789",
"visibilityType": "HIDEABLE",
"androidAppVersion": "abc123",
"iosAppVersion": "abc123",
"tenant": "abc123"
}
Response
{
"data": {
"SystemMessageCreateUpdate": {
"id": 4,
"title": "abc123",
"text": "xyz789",
"visibilityType": "HIDEABLE",
"androidAppVersion": "abc123",
"iosAppVersion": "abc123",
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
SystemMessageRemove
Response
Returns a CommonResponse!
Arguments
| Name | Description |
|---|---|
id - Float!
|
Example
Query
mutation SystemMessageRemove($id: Float!) {
SystemMessageRemove(id: $id) {
success
error {
code
errorText
}
}
}
Variables
{"id": 123.45}
Response
{
"data": {
"SystemMessageRemove": {
"success": false,
"error": Error
}
}
}
TerritoryAccessPermissionRequest
Response
Returns a TerritoryAccessPermissionResponse
Arguments
| Name | Description |
|---|---|
territoryAccessDataId - String!
|
|
customerId - String
|
|
carId - Float
|
|
entryActionType - AccessPermissionEntryActionTypeEnum!
|
Example
Query
mutation TerritoryAccessPermissionRequest(
$territoryAccessDataId: String!,
$customerId: String,
$carId: Float,
$entryActionType: AccessPermissionEntryActionTypeEnum!
) {
TerritoryAccessPermissionRequest(
territoryAccessDataId: $territoryAccessDataId,
customerId: $customerId,
carId: $carId,
entryActionType: $entryActionType
) {
message
qrCodeImage
timeArrival
timeDeparture
}
}
Variables
{
"territoryAccessDataId": "xyz789",
"customerId": "abc123",
"carId": 987.65,
"entryActionType": "OPEN_BARRIER"
}
Response
{
"data": {
"TerritoryAccessPermissionRequest": {
"message": "xyz789",
"qrCodeImage": "abc123",
"timeArrival": "2007-12-03T10:15:30Z",
"timeDeparture": "2007-12-03T10:15:30Z"
}
}
}
TransferTransaction
Response
Returns a CommonResponse!
Example
Query
mutation TransferTransaction(
$transactionId: String!,
$customerId: String!
) {
TransferTransaction(
transactionId: $transactionId,
customerId: $customerId
) {
success
error {
code
errorText
}
}
}
Variables
{
"transactionId": "abc123",
"customerId": "xyz789"
}
Response
{
"data": {
"TransferTransaction": {
"success": false,
"error": Error
}
}
}
TranslationCreate
Response
Returns [Translation!]!
Arguments
| Name | Description |
|---|---|
googleSpreadsheetsUrl - String!
|
|
sheetName - String!
|
|
app - TranslationAppEnum!
|
|
translationTargets - [TranslationTargetInputType!]!
|
Example
Query
mutation TranslationCreate(
$googleSpreadsheetsUrl: String!,
$sheetName: String!,
$app: TranslationAppEnum!,
$translationTargets: [TranslationTargetInputType!]!
) {
TranslationCreate(
googleSpreadsheetsUrl: $googleSpreadsheetsUrl,
sheetName: $sheetName,
app: $app,
translationTargets: $translationTargets
) {
id
lang
tenant
version
appVersion
app
subTenantId
hash
fileLink
createdAt
updatedAt
}
}
Variables
{
"googleSpreadsheetsUrl": "xyz789",
"sheetName": "abc123",
"app": "MAIN_WEBSITE",
"translationTargets": [TranslationTargetInputType]
}
Response
{
"data": {
"TranslationCreate": [
{
"id": "4",
"lang": "RUSSIAN",
"tenant": "xyz789",
"version": 123.45,
"appVersion": "xyz789",
"app": "MAIN_WEBSITE",
"subTenantId": "xyz789",
"hash": "abc123",
"fileLink": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
Types
AccessPermissionEntryActionTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"OPEN_BARRIER"
AccessPermissionRequestData
Fields
| Field Name | Description |
|---|---|
entryActionType - AccessPermissionEntryActionTypeEnum!
|
|
autoConfirmed - Boolean
|
|
canChooseTime - Boolean
|
|
openingHours - OpeningHoursType
|
Example
{
"entryActionType": "OPEN_BARRIER",
"autoConfirmed": false,
"canChooseTime": false,
"openingHours": OpeningHoursType
}
AccessPermissionRequestTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"SMS"
Amount
Fields
| Input Field | Description |
|---|---|
value - Float!
|
|
currency - CurrencyEnum!
|
Example
{"value": 123.45, "currency": "USD"}
AppTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IOS"
AuthInitiatorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER"
AuthTelegramGetCustomerTokenResponse
Authorization
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float
|
|
idToken - String
|
|
idTokenType - IdTokenEnumType
|
|
chargingStationId - String
|
|
chargingStation - ChargingStation
|
|
status - AuthorizationStatusEnumType
|
|
transactionId - String
|
|
transaction - Transaction
|
|
reservationId - String
|
|
reservation - ReservationCard
|
|
customerId - String
|
|
customer - Customer
|
|
company - Company
|
|
userId - String
|
|
user - User
|
|
authorizationCardId - String
|
|
authorizationCard - AuthorizationCard
|
|
ocppVersion - OcppSupportedEnum
|
|
appVersion - String
|
|
initiator - AuthInitiatorEnum
|
|
app - AppTypeEnum
|
|
tenant - String
|
|
roamingAccessId - Float
|
|
roamingAccess - RoamingAccess
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": "4",
"seqNo": 123.45,
"idToken": "xyz789",
"idTokenType": "CENTRAL",
"chargingStationId": "abc123",
"chargingStation": ChargingStation,
"status": "ACCEPTED",
"transactionId": "xyz789",
"transaction": Transaction,
"reservationId": "abc123",
"reservation": ReservationCard,
"customerId": "xyz789",
"customer": Customer,
"company": Company,
"userId": "xyz789",
"user": User,
"authorizationCardId": "xyz789",
"authorizationCard": AuthorizationCard,
"ocppVersion": "V120SOAP",
"appVersion": "xyz789",
"initiator": "CUSTOMER",
"app": "IOS",
"tenant": "xyz789",
"roamingAccessId": 123.45,
"roamingAccess": RoamingAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
AuthorizationCard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float
|
|
cardId - String!
|
|
blocked - Boolean
|
|
freeCharging - Boolean
|
|
name - String
|
|
description - String
|
|
type - AuthorizationCardTypeEnum
|
|
iso - AuthorizationCardIsoEnum
|
|
amount - Float
|
|
amountType - AuthorizationCardAmountTypeEnum
|
|
currency - CurrencyEnum
|
|
customerId - String
|
|
customer - Customer
|
|
userId - String
|
|
user - User
|
|
companyId - String
|
|
company - Company
|
|
chargingStations - [ChargingStationCard!]
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 987.65,
"cardId": "xyz789",
"blocked": false,
"freeCharging": false,
"name": "xyz789",
"description": "abc123",
"type": "RFID",
"iso": "ISO14443",
"amount": 987.65,
"amountType": "WATT",
"currency": "USD",
"customerId": "xyz789",
"customer": Customer,
"userId": "abc123",
"user": User,
"companyId": "xyz789",
"company": Company,
"chargingStations": [ChargingStationCard],
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
AuthorizationCardAmountTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"WATT"
AuthorizationCardIsoEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ISO14443"
AuthorizationCardTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RFID"
AuthorizationInputFilter
Fields
| Input Field | Description |
|---|---|
id - FilterUuid
|
|
seqNo - FilterCompareNumber
|
|
isRoaming - FilterCompareNotNull
|
Example
{
"id": FilterUuid,
"seqNo": FilterCompareNumber,
"isRoaming": FilterCompareNotNull
}
AuthorizationStatusEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
AvailabilityStatusEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
AvailabilityTypeEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INOPERATIVE"
AvailableOCPP160Actions
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTHORIZE"
Balance
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
customer - Customer
|
|
company - Company
|
|
seqNo - Float
|
|
total - Float!
|
|
debit - Float
|
|
credit - Float
|
|
currency - CurrencyEnum!
|
|
description - String
|
|
promocode - Promocode
|
|
discount - Discount
|
|
invoice - Invoice
|
|
payment - Payment
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"customer": Customer,
"company": Company,
"seqNo": 987.65,
"total": 987.65,
"debit": 987.65,
"credit": 123.45,
"currency": "USD",
"description": "xyz789",
"promocode": Promocode,
"discount": Discount,
"invoice": Invoice,
"payment": Payment,
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
BalanceBrief
Fields
| Field Name | Description |
|---|---|
total - Float!
|
|
currency - CurrencyEnum
|
|
status - BalanceStatusEnum!
|
|
invoicesInProcess - [Invoice!]
|
Example
{
"total": 123.45,
"currency": "USD",
"status": "POSITIVE",
"invoicesInProcess": [Invoice]
}
BalanceCard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
customer - Customer
|
|
company - Company
|
|
seqNo - Float
|
|
total - Float!
|
|
debit - Float
|
|
credit - Float
|
|
currency - CurrencyEnum!
|
|
description - String
|
|
promocode - Promocode
|
|
discount - Discount
|
|
invoice - Invoice
|
|
payment - Payment
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": "4",
"customer": Customer,
"company": Company,
"seqNo": 123.45,
"total": 987.65,
"debit": 987.65,
"credit": 987.65,
"currency": "USD",
"description": "abc123",
"promocode": Promocode,
"discount": Discount,
"invoice": Invoice,
"payment": Payment,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
BalanceStatus
Fields
| Field Name | Description |
|---|---|
status - BalanceStatusEnum!
|
Example
{"status": "POSITIVE"}
BalanceStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"POSITIVE"
BalancesList
Fields
| Field Name | Description |
|---|---|
rows - [BalanceCard!]!
|
|
count - Float!
|
Example
{"rows": [BalanceCard], "count": 987.65}
BalancesListRequestOrderInputType
Boolean
Description
The Boolean scalar type represents true or false.
CaptchaResponse
Fields
| Field Name | Description |
|---|---|
challenge1 - [String!]!
|
|
challenge2 - [String!]!
|
Example
{
"challenge1": ["xyz789"],
"challenge2": ["abc123"]
}
Car
Example
{
"id": 987,
"name": "xyz789",
"description": "abc123",
"color": "BLACK",
"emaidType": "VIN",
"vin": "xyz789",
"vehicleId": "xyz789",
"plateNumber": "xyz789",
"year": "abc123",
"batteryAmountKW": 123.45,
"model": CarModel,
"images": [File],
"customers": [Customer]
}
CarMaker
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
name - String!
|
|
fullName - String
|
|
models - [CarModel!]
|
|
logo - File
|
Example
{
"id": 987,
"name": "xyz789",
"fullName": "abc123",
"models": [CarModel],
"logo": File
}
CarModel
Example
{
"id": 987,
"makerId": 987,
"name": "abc123",
"fullName": "abc123",
"description": "xyz789",
"batteryAmountKW": 123.45,
"country": "AFGHANISTAN",
"year": "xyz789",
"connectors": [CarModelConnector],
"maker": CarMaker,
"images": [File]
}
CarModelConnector
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
type - ConnectorEnumType
|
|
images - [File!]
|
Example
{"id": 123, "type": "C_CCS1", "images": [File]}
CarModelConnectorCreate
Fields
| Input Field | Description |
|---|---|
type - ConnectorEnumType
|
Example
{"type": "C_CCS1"}
CarModelConnectorInputType
Fields
| Input Field | Description |
|---|---|
id - Int
|
|
type - ConnectorEnumType
|
Example
{"id": 987, "type": "C_CCS1"}
Card
CarsList
CarsListRequestOrderInputType
ChargingStateEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARGING"
ChargingStation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float!
|
|
forceBlocked - Boolean
|
|
coordinates - Coordinates
|
|
evses - [Evses!]
|
|
name - String
|
|
address - String
|
|
photoUrls - [String!]
|
|
plugshareLink - String
|
|
description - String
|
|
internalPrivateUseDescription - String
|
|
openingHours - OpeningHoursType
|
|
temporaryClosedTill - DateTime
|
|
active - Boolean
|
|
invisible - Boolean
|
|
connected - Boolean
|
|
disconnectedAt - DateTime
|
|
distance - Float
|
|
computedStatus - ChargingStationComputedStatusEnum
|
|
speed - SpeedEnum
|
|
specialIdentifier - SpecialIdentifierEnum
|
|
ocppVersion - OcppSupportedEnum
|
|
serialNumber - String
|
|
model - String
|
|
vendorName - String
|
|
firmwareVersion - String
|
|
bootNotificationRequestAcceptedAt - DateTime
|
|
blacklisted - Boolean
|
|
isTestCS - Boolean
|
|
isInRoaming - Boolean
|
|
ip - String
|
|
soapUrl - String
|
|
vpnServerIp - String
|
|
connectionHost - String
|
|
emulator - Boolean
|
|
autoAcceptAuthorizeRequests - Boolean
|
|
external - Boolean
|
|
canReserve - Boolean
|
|
company - Company
|
|
uptimeMonitorings - [UptimeMonitoring!]
|
|
transactions - [Transaction!]
|
|
images - [File!]
|
|
territoryAccessData - TerritoryAccessData
|
|
accessPermissionRequestData - AccessPermissionRequestData
|
|
timezone - String
|
|
tenant - String
|
|
lastConnectionStatusChangedAt - DateTime
|
|
ftpAccess - FtpAccess
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 987.65,
"forceBlocked": true,
"coordinates": Coordinates,
"evses": [Evses],
"name": "xyz789",
"address": "xyz789",
"photoUrls": ["xyz789"],
"plugshareLink": "xyz789",
"description": "abc123",
"internalPrivateUseDescription": "abc123",
"openingHours": OpeningHoursType,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"active": false,
"invisible": false,
"connected": true,
"disconnectedAt": "2007-12-03T10:15:30Z",
"distance": 123.45,
"computedStatus": "ALL_AVAILABLE",
"speed": "SLOW",
"specialIdentifier": "EVIKA",
"ocppVersion": "V120SOAP",
"serialNumber": "xyz789",
"model": "abc123",
"vendorName": "xyz789",
"firmwareVersion": "xyz789",
"bootNotificationRequestAcceptedAt": "2007-12-03T10:15:30Z",
"blacklisted": true,
"isTestCS": false,
"isInRoaming": true,
"ip": "abc123",
"soapUrl": "abc123",
"vpnServerIp": "abc123",
"connectionHost": "xyz789",
"emulator": false,
"autoAcceptAuthorizeRequests": false,
"external": false,
"canReserve": true,
"company": Company,
"uptimeMonitorings": [UptimeMonitoring],
"transactions": [Transaction],
"images": [File],
"territoryAccessData": TerritoryAccessData,
"accessPermissionRequestData": AccessPermissionRequestData,
"timezone": "xyz789",
"tenant": "xyz789",
"lastConnectionStatusChangedAt": "2007-12-03T10:15:30Z",
"ftpAccess": FtpAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ChargingStationCard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float!
|
|
forceBlocked - Boolean
|
|
coordinates - Coordinates
|
|
evses - [Evses!]
|
|
name - String
|
|
address - String
|
|
photoUrls - [String!]
|
|
plugshareLink - String
|
|
description - String
|
|
internalPrivateUseDescription - String
|
|
openingHours - OpeningHoursType
|
|
temporaryClosedTill - DateTime
|
|
scheduleClosed - Boolean
|
|
active - Boolean
|
|
archived - Boolean
|
|
debugMode - Boolean
|
|
invisible - Boolean
|
|
connected - Boolean
|
|
disconnectedAt - DateTime
|
|
distance - Float
|
|
computedStatus - ChargingStationComputedStatusEnum
|
|
speed - SpeedEnum
|
|
specialIdentifier - SpecialIdentifierEnum
|
|
ocppVersion - OcppSupportedEnum
|
|
serialNumber - String
|
|
model - String
|
|
vendorName - String
|
|
firmwareVersion - String
|
|
bootNotificationRequestAcceptedAt - DateTime
|
|
blacklisted - Boolean
|
|
isTestCS - Boolean
|
|
isInRoaming - Boolean
|
|
ip - String
|
|
soapUrl - String
|
|
vpnServerIp - String
|
|
connectionHost - String
|
|
emulator - Boolean
|
|
autoAcceptAuthorizeRequests - Boolean
|
|
external - Boolean
|
|
canReserve - Boolean
|
|
reservations - [ReservationCard!]
|
|
company - Company
|
|
supportsChargingProfiles - Boolean
|
|
hasActiveChargingProfile - Boolean
|
|
uptimeMonitorings - [UptimeMonitoring!]
|
|
Arguments
|
|
images - [File!]
|
|
territoryAccessData - TerritoryAccessData
|
|
accessPermissionRequestData - AccessPermissionRequestData
|
|
timezone - String
|
|
tenant - String
|
|
lastConnectionStatusChangedAt - DateTime
|
|
ftpAccess - FtpAccess
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
Example
{
"id": 4,
"seqNo": 987.65,
"forceBlocked": false,
"coordinates": Coordinates,
"evses": [Evses],
"name": "abc123",
"address": "xyz789",
"photoUrls": ["xyz789"],
"plugshareLink": "xyz789",
"description": "abc123",
"internalPrivateUseDescription": "xyz789",
"openingHours": OpeningHoursType,
"temporaryClosedTill": "2007-12-03T10:15:30Z",
"scheduleClosed": true,
"active": false,
"archived": false,
"debugMode": true,
"invisible": false,
"connected": true,
"disconnectedAt": "2007-12-03T10:15:30Z",
"distance": 123.45,
"computedStatus": "ALL_AVAILABLE",
"speed": "SLOW",
"specialIdentifier": "EVIKA",
"ocppVersion": "V120SOAP",
"serialNumber": "xyz789",
"model": "abc123",
"vendorName": "abc123",
"firmwareVersion": "abc123",
"bootNotificationRequestAcceptedAt": "2007-12-03T10:15:30Z",
"blacklisted": false,
"isTestCS": false,
"isInRoaming": true,
"ip": "xyz789",
"soapUrl": "abc123",
"vpnServerIp": "abc123",
"connectionHost": "abc123",
"emulator": true,
"autoAcceptAuthorizeRequests": true,
"external": true,
"canReserve": true,
"reservations": [ReservationCard],
"company": Company,
"supportsChargingProfiles": true,
"hasActiveChargingProfile": true,
"uptimeMonitorings": [UptimeMonitoring],
"images": [File],
"territoryAccessData": TerritoryAccessData,
"accessPermissionRequestData": AccessPermissionRequestData,
"timezone": "abc123",
"tenant": "xyz789",
"lastConnectionStatusChangedAt": "2007-12-03T10:15:30Z",
"ftpAccess": FtpAccess,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ChargingStationChangeAvailabilityResponse
Fields
| Field Name | Description |
|---|---|
response - AvailabilityStatusEnumType
|
Example
{"response": "ACCEPTED"}
ChargingStationClearCacheResponse
Fields
| Field Name | Description |
|---|---|
response - ClearCacheStatusEnumType
|
Example
{"response": "ACCEPTED"}
ChargingStationComputedStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL_AVAILABLE"
ChargingStationConfiguration
Fields
| Field Name | Description |
|---|---|
configuration - String
|
Example
{"configuration": "xyz789"}
ChargingStationCoordinatesBox2d
ChargingStationGetDiagnosticsResponse
Fields
| Field Name | Description |
|---|---|
fileName - String
|
Example
{"fileName": "xyz789"}
ChargingStationGraphInfo
Fields
| Field Name | Description |
|---|---|
lastTransactionStep - TransactionStepsEnum
|
|
isOffline - Boolean
|
|
countUptimeForLast24H - Float
|
|
countUptimeForLast30D - Float
|
|
countKWForLast30D - [Float!]
|
|
last10Transactions - [LastTransactions!]
|
Example
{
"lastTransactionStep": "CABLE_PLUGGED_IN",
"isOffline": true,
"countUptimeForLast24H": 987.65,
"countUptimeForLast30D": 987.65,
"countKWForLast30D": [123.45],
"last10Transactions": [LastTransactions]
}
ChargingStationInputFilter
Fields
| Input Field | Description |
|---|---|
id - FilterUuid
|
|
name - FilterCompareString
|
|
company - CompanyInputFilter
|
Example
{
"id": FilterUuid,
"name": FilterCompareString,
"company": CompanyInputFilter
}
ChargingStationLogResponse
Example
{
"ocpp_action": "abc123",
"ocpp_message_direction": "abc123",
"ocpp_request": "xyz789",
"ocpp_response": "abc123",
"ocpp_raw_message": "abc123",
"ocpp_message": "xyz789",
"ocpp_raw_request": "xyz789",
"ocpp_raw_response": "abc123",
"log_level": "abc123",
"message": "abc123",
"timestamp": "abc123"
}
ChargingStationResetResponse
Fields
| Field Name | Description |
|---|---|
response - ResetStatusEnumType
|
Example
{"response": "ACCEPTED"}
ChargingStationUnlockConnectorResponse
Fields
| Field Name | Description |
|---|---|
response - UnlockStatusEnumType
|
Example
{"response": "UNLOCKED"}
ChargingStationsList
Fields
| Field Name | Description |
|---|---|
rows - [ChargingStationCard!]!
|
|
count - Float!
|
Example
{"rows": [ChargingStationCard], "count": 987.65}
ChargingStationsListRequestOrderInputType
Example
{
"id": "asc",
"distance": DistanceSort,
"seqNo": "asc",
"evseId": "asc",
"connectorId": "asc",
"updatedAt": "asc",
"createdAt": "asc",
"lastConnectionStatusChangedAt": "asc",
"bootNotificationRequestAcceptedAt": "asc"
}
ChartElementSplittable
ChartMeterValues
Fields
| Field Name | Description |
|---|---|
meterValues - [MeterValue!]
|
|
maxPower - Float
|
|
avgPower - Float
|
|
soc - Float
|
|
estimatedChargingTime - Float
|
Example
{
"meterValues": [MeterValue],
"maxPower": 987.65,
"avgPower": 987.65,
"soc": 123.45,
"estimatedChargingTime": 123.45
}
ClearCacheStatusEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACCEPTED"
ColorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLACK"
CommonResponse
Company
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
seqNo - Float
|
|
name - String
|
|
description - String
|
|
internalPrivateUseDescription - String
|
|
contactPerson - String
|
|
email - String
|
|
phone - String
|
|
country - CountryCodeEnumType
|
|
type - CompanyTypeEnum
|
|
zip - String
|
|
address - String
|
|
inn - Float
|
|
kpp - Float
|
|
contractNumber - String
|
|
contractIssuedAt - DateTime
|
|
contractValidTill - DateTime
|
|
bankAcccountNumber - String
|
|
bankAcccountBic - Float
|
|
customers - [Customer!]
|
|
chargingStations - [ChargingStation!]
|
|
authorizations - [Authorization!]
|
|
transactions - [Transaction!]
|
|
payments - [Payment!]
|
|
balances - [Balance!]
|
|
invoices - [Invoice!]
|
|
lastMonthConsumption - LastMonthConsumption
|
|
transactionsCount - TransactionsCount
|
|
last30dData - Last30dData
|
|
mostPopularByWeek - [MostPopularByWeek!]
|
|
tenant - String
|
|
tenantSettings - TenantSettings
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
nameFull - String
|
|
nameForSign - String
|
|
charterType - String
|
|
representativePersonFull - String
|
|
representativePersonForSign - String
|
|
representativePersonJobTitleFull - String
|
|
representativePersonJobTitleForSign - String
|
|
serviceFeePercent - Float
|
Example
{
"id": 4,
"seqNo": 123.45,
"name": "abc123",
"description": "xyz789",
"internalPrivateUseDescription": "xyz789",
"contactPerson": "xyz789",
"email": "xyz789",
"phone": "xyz789",
"country": "AFGHANISTAN",
"type": "CHARGING_STATION_OPERATION",
"zip": "abc123",
"address": "abc123",
"inn": 123.45,
"kpp": 123.45,
"contractNumber": "abc123",
"contractIssuedAt": "2007-12-03T10:15:30Z",
"contractValidTill": "2007-12-03T10:15:30Z",
"bankAcccountNumber": "xyz789",
"bankAcccountBic": 987.65,
"customers": [Customer],
"chargingStations": [ChargingStation],
"authorizations": [Authorization],
"transactions": [Transaction],
"payments": [Payment],
"balances": [Balance],
"invoices": [Invoice],
"lastMonthConsumption": LastMonthConsumption,
"transactionsCount": TransactionsCount,
"last30dData": Last30dData,
"mostPopularByWeek": [MostPopularByWeek],
"tenant": "xyz789",
"tenantSettings": TenantSettings,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"nameFull": "xyz789",
"nameForSign": "abc123",
"charterType": "xyz789",
"representativePersonFull": "xyz789",
"representativePersonForSign": "xyz789",
"representativePersonJobTitleFull": "xyz789",
"representativePersonJobTitleForSign": "abc123",
"serviceFeePercent": 123.45
}
CompanyInputFilter
Fields
| Input Field | Description |
|---|---|
id - FilterUuid
|
|
name - FilterCompareString
|
Example
{
"id": FilterUuid,
"name": FilterCompareString
}
CompanyTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CHARGING_STATION_OPERATION"
CompareBetween
Connector
Fields
| Field Name | Description |
|---|---|
id - Float!
|
|
evseId - Float!
|
|
pending - Boolean
|
|
initiating - Boolean
|
|
emergencyButtonPressed - Boolean
|
|
type - ConnectorEnumType
|
|
status - ConnectorEnumStatus!
|
|
outletType - ConnectorOutletTypeEnum
|
|
maxAmps - Float
|
|
power - Float
|
|
activeTransaction - TransactionCard
|
|
activeTransactionBrief - TransactionBrief
|
|
tariff - TariffType
|
|
Arguments
|
|
tariffGroup - TariffGroup
|
|
tariffBooking - TariffType
|
|
tariffParkingTime - TariffType
|
|
tariffPenaltyForBlockingCharging - TariffType
|
|
tariffPriorityCharging - TariffType
|
|
tariffTransaction - TariffType
|
|
tariffTransactionStart - TariffType
|
|
hasActiveChargingProfile - Boolean
|
|
oldOCPPStatus - String
|
|
oldOCPPErrorCode - String
|
|
info - String
|
|
vendorId - String
|
|
vendorErrorCode - String
|
|
updatedAt - DateTime!
|
|
Example
{
"id": 987.65,
"evseId": 987.65,
"pending": true,
"initiating": true,
"emergencyButtonPressed": false,
"type": "C_CCS1",
"status": "AVAILABLE",
"outletType": "SOCKET",
"maxAmps": 123.45,
"power": 987.65,
"activeTransaction": TransactionCard,
"activeTransactionBrief": TransactionBrief,
"tariff": TariffType,
"tariffGroup": TariffGroup,
"tariffBooking": TariffType,
"tariffParkingTime": TariffType,
"tariffPenaltyForBlockingCharging": TariffType,
"tariffPriorityCharging": TariffType,
"tariffTransaction": TariffType,
"tariffTransactionStart": TariffType,
"hasActiveChargingProfile": false,
"oldOCPPStatus": "xyz789",
"oldOCPPErrorCode": "abc123",
"info": "abc123",
"vendorId": "abc123",
"vendorErrorCode": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
ConnectorEnumStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AVAILABLE"
ConnectorEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"C_CCS1"
ConnectorInput
Fields
| Input Field | Description |
|---|---|
type - ConnectorEnumType
|
|
status - ConnectorEnumStatus!
|
|
maxAmps - Float
|
|
power - Float!
|
|
tariffId - String
|
|
tariffGroupId - String
|
|
tariffBookingId - String
|
|
tariffParkingTimeId - String
|
|
tariffPenaltyForBlockingChargingId - String
|
|
tariffPriorityChargingId - String
|
|
tariffTransactionId - String
|
|
tariffTransactionStartId - String
|
|
outletType - ConnectorOutletTypeEnum
|
|
pending - Boolean
|
|
initiating - Boolean
|
Example
{
"type": "C_CCS1",
"status": "AVAILABLE",
"maxAmps": 123.45,
"power": 123.45,
"tariffId": "abc123",
"tariffGroupId": "abc123",
"tariffBookingId": "xyz789",
"tariffParkingTimeId": "abc123",
"tariffPenaltyForBlockingChargingId": "xyz789",
"tariffPriorityChargingId": "xyz789",
"tariffTransactionId": "abc123",
"tariffTransactionStartId": "xyz789",
"outletType": "SOCKET",
"pending": true,
"initiating": false
}
ConnectorInputType
Fields
| Input Field | Description |
|---|---|
type - ConnectorEnumType
|
|
outletType - ConnectorOutletTypeEnum
|
Example
{"type": "C_CCS1", "outletType": "SOCKET"}
ConnectorOutletTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SOCKET"
ConnectorType
Fields
| Input Field | Description |
|---|---|
type - FilterCompareConnectorType
|
|
free - FilterCompareNull
|
|
speed - FilterConnectorSpeed
|
|
power - FilterConnectorPower
|
Example
{
"type": FilterCompareConnectorType,
"free": FilterCompareNull,
"speed": FilterConnectorSpeed,
"power": FilterConnectorPower
}
Coordinates
CoordinatesInput
CoordinatesWithDistance
CoordinatesWithDistanceAndMeters
CountryCodeEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFGHANISTAN"
CurrencyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"USD"
Customer
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
seqNo - Float
|
|
name - String
|
|
surname - String
|
|
middlename - String
|
|
description - String
|
|
phone - String
|
|
email - String
|
|
country - CountryCodeEnumType
|
|
paymentMethods - [PaymentMethod!]
|
|
hasActivePaymentMethod - Boolean
|
|
activePaymentMethodIssuer - String
|
|
totalPaymentsCount - Float
|
|
directPaidTransactionsCount - Float
|
|
payments - [Payment!]
|
|
balances - [Balance!]
|
|
invoices - [Invoice!]
|
|
authorizations - [Authorization!]
|
|
transactions - [Transaction!]
|
|
lastMonthConsumption - LastMonthConsumption
|
|
transactionsCount - TransactionsCount
|
|
last30dData - Last30dData
|
|
mostPopularByWeek - [MostPopularByWeek!]
|
|
otp - String
|
|
otpCreatedAt - DateTime
|
|
internalPrivateUseDescription - String
|
|
tenant - String
|
|
tenantSettings - TenantSettings
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
|
removedAt - DateTime
|
Example
{
"id": "4",
"seqNo": 123.45,
"name": "abc123",
"surname": "xyz789",
"middlename": "abc123",
"description": "abc123",
"phone": "xyz789",
"email": "abc123",
"country": "AFGHANISTAN",
"paymentMethods": [PaymentMethod],
"hasActivePaymentMethod": true,
"activePaymentMethodIssuer": "abc123",
"totalPaymentsCount": 123.45,
"directPaidTransactionsCount": 987.65,
"payments": [Payment],
"balances": [Balance],
"invoices": [Invoice],
"authorizations": [Authorization],
"transactions": [Transaction],
"lastMonthConsumption": LastMonthConsumption,
"transactionsCount": TransactionsCount,
"last30dData": Last30dData,
"mostPopularByWeek": [MostPopularByWeek],
"otp": "xyz789",
"otpCreatedAt": "2007-12-03T10:15:30Z",
"internalPrivateUseDescription": "xyz789",
"tenant": "xyz789",
"tenantSettings": TenantSettings,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"removedAt": "2007-12-03T10:15:30Z"
}
CustomerInputFilter
Fields
| Input Field | Description |
|---|---|
phone - FilterCompareString
|
|
id - FilterUuid
|
Example
{
"phone": FilterCompareString,
"id": FilterUuid
}
CustomerSettings
DateTime
Example
"2007-12-03T10:15:30Z"
DayAndTimeInput
DayAndTimeType
Discount
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float
|
|
name - String
|
|
description - String
|
|
internalPrivateUseDescription - String
|
|
percent - Float
|
|
amount - Float
|
|
freeCharging - Boolean
|
|
active - Boolean
|
|
validFrom - DateTime
|
|
validTill - DateTime
|
|
discountTargets - [DiscountTarget!]
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": "4",
"seqNo": 123.45,
"name": "xyz789",
"description": "abc123",
"internalPrivateUseDescription": "abc123",
"percent": 987.65,
"amount": 987.65,
"freeCharging": true,
"active": false,
"validFrom": "2007-12-03T10:15:30Z",
"validTill": "2007-12-03T10:15:30Z",
"discountTargets": [DiscountTarget],
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
DiscountTarget
Example
{
"id": "4",
"discount": Discount,
"customer": Customer,
"chargingStation": ChargingStationCard,
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
DistanceSort
EmaidTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"VIN"
Error
Evses
Fields
| Field Name | Description |
|---|---|
id - Float!
|
|
power - Float
|
|
connectors - [Connector!]!
|
|
tariff - TariffType
|
|
hasActiveChargingProfile - Boolean
|
Example
{
"id": 987.65,
"power": 123.45,
"connectors": [Connector],
"tariff": TariffType,
"hasActiveChargingProfile": true
}
EvsesInput
Fields
| Input Field | Description |
|---|---|
power - Float
|
|
connectors - [ConnectorInput!]!
|
|
tariffId - String
|
Example
{
"power": 123.45,
"connectors": [ConnectorInput],
"tariffId": "abc123"
}
ExternalCustomerAuthorizeResponse
Fields
| Field Name | Description |
|---|---|
token - String!
|
|
customerId - String!
|
|
companies - [Company!]
|
Example
{
"token": "abc123",
"customerId": "xyz789",
"companies": [Company]
}
File
Example
{
"id": "abc123",
"seqNo": 987.65,
"name": "xyz789",
"description": "abc123",
"fileType": "IMAGE",
"url": "abc123",
"mimeType": "xyz789",
"extention": "abc123",
"bucket": "xyz789",
"path": "abc123",
"size": 123.45,
"imageInfo": ImageInfo,
"active": false
}
FileInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
Example
{"id": "xyz789"}
FileTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"IMAGE"
FilterArrayUuid
FilterChargingStationCoordinatesBox2d
FilterCompareBoolean
Fields
| Input Field | Description |
|---|---|
eq - Boolean
|
Example
{"eq": false}
FilterCompareCancelReason
Fields
| Input Field | Description |
|---|---|
eq - ReservationCancelReasonEnum
|
|
in - [ReservationCancelReasonEnum!]
|
|
nin - [ReservationCancelReasonEnum!]
|
Example
{"eq": "BY_CUSTOMER", "in": ["BY_CUSTOMER"], "nin": ["BY_CUSTOMER"]}
FilterCompareChargingState
Fields
| Input Field | Description |
|---|---|
eq - ChargingStateEnumType
|
|
in - [ChargingStateEnumType!]
|
|
nin - [ChargingStateEnumType!]
|
Example
{"eq": "CHARGING", "in": ["CHARGING"], "nin": ["CHARGING"]}
FilterCompareConnectorType
Fields
| Input Field | Description |
|---|---|
eq - ConnectorEnumType
|
|
in - [ConnectorEnumType!]
|
|
nin - [ConnectorEnumType!]
|
Example
{"eq": "C_CCS1", "in": ["C_CCS1"], "nin": ["C_CCS1"]}
FilterCompareLanguage
Fields
| Input Field | Description |
|---|---|
eq - LanguageEnum
|
|
in - [LanguageEnum!]
|
|
nin - [LanguageEnum!]
|
Example
{"eq": "RUSSIAN", "in": ["RUSSIAN"], "nin": ["RUSSIAN"]}
FilterCompareNotNull
Fields
| Input Field | Description |
|---|---|
eq - Boolean
|
Example
{"eq": true}
FilterCompareNull
Fields
| Input Field | Description |
|---|---|
eq - Boolean
|
Example
{"eq": true}
FilterCompareNumber
Example
{
"eq": 987.65,
"ne": 987.65,
"gt": 123.45,
"lt": 123.45,
"gte": 123.45,
"lte": 123.45,
"between": CompareBetween,
"in": [123.45],
"nin": [123.45]
}
FilterCompareOcppVersion
Fields
| Input Field | Description |
|---|---|
eq - OcppSupportedEnum
|
|
in - [OcppSupportedEnum!]
|
|
nin - [OcppSupportedEnum!]
|
Example
{"eq": "V120SOAP", "in": ["V120SOAP"], "nin": ["V120SOAP"]}
FilterComparePaymentService
Fields
| Input Field | Description |
|---|---|
eq - PaymentServiceEnum
|
|
in - [PaymentServiceEnum!]
|
|
nin - [PaymentServiceEnum!]
|
Example
{"eq": "YOOKASSA", "in": ["YOOKASSA"], "nin": ["YOOKASSA"]}
FilterComparePaymentStatus
Fields
| Input Field | Description |
|---|---|
eq - PaymentStatusEnum
|
|
in - [PaymentStatusEnum!]
|
|
nin - [PaymentStatusEnum!]
|
Example
{"eq": "PENDING", "in": ["PENDING"], "nin": ["PENDING"]}
FilterComparePaymentTypeEnum
Fields
| Input Field | Description |
|---|---|
eq - PaymentTypeEnum
|
|
in - [PaymentTypeEnum!]
|
|
nin - [PaymentTypeEnum!]
|
Example
{"eq": "BANK_CARD", "in": ["BANK_CARD"], "nin": ["BANK_CARD"]}
FilterComparePurpose
Fields
| Input Field | Description |
|---|---|
eq - TariffPurposeEnum
|
|
in - [TariffPurposeEnum!]
|
|
nin - [TariffPurposeEnum!]
|
Example
{"eq": "BOOKING", "in": ["BOOKING"], "nin": ["BOOKING"]}
FilterCompareStopInitiator
Fields
| Input Field | Description |
|---|---|
eq - StopInitiatorEnum
|
|
in - [StopInitiatorEnum!]
|
|
nin - [StopInitiatorEnum!]
|
Example
{"eq": "CUSTOMER", "in": ["CUSTOMER"], "nin": ["CUSTOMER"]}
FilterCompareStoppedReason
Fields
| Input Field | Description |
|---|---|
eq - ReasonEnumType
|
|
in - [ReasonEnumType!]
|
|
nin - [ReasonEnumType!]
|
Example
{"eq": "DE_AUTHORIZED", "in": ["DE_AUTHORIZED"], "nin": ["DE_AUTHORIZED"]}
FilterCompareString
FilterCompareTime
Fields
| Input Field | Description |
|---|---|
gt - String
|
|
lt - String
|
|
gte - String
|
|
lte - String
|
|
range - [DateTime!]
|
Example
{
"gt": "abc123",
"lt": "xyz789",
"gte": "xyz789",
"lte": "xyz789",
"range": ["2007-12-03T10:15:30Z"]
}
FilterCompareTransactionSteps
Fields
| Input Field | Description |
|---|---|
eq - TransactionStepsEnum
|
|
in - [TransactionStepsEnum!]
|
|
nin - [TransactionStepsEnum!]
|
Example
{
"eq": "CABLE_PLUGGED_IN",
"in": ["CABLE_PLUGGED_IN"],
"nin": ["CABLE_PLUGGED_IN"]
}
FilterCompareTranslationApp
Fields
| Input Field | Description |
|---|---|
eq - TranslationAppEnum
|
|
in - [TranslationAppEnum!]
|
|
nin - [TranslationAppEnum!]
|
Example
{"eq": "MAIN_WEBSITE", "in": ["MAIN_WEBSITE"], "nin": ["MAIN_WEBSITE"]}
FilterConnectorPower
Fields
| Input Field | Description |
|---|---|
eq - PowerEnum
|
|
in - [PowerEnum!]
|
Example
{"eq": "SLOW", "in": ["SLOW"]}
FilterConnectorSpeed
Fields
| Input Field | Description |
|---|---|
eq - SpeedEnum
|
|
in - [SpeedEnum!]
|
Example
{"eq": "SLOW", "in": ["SLOW"]}
FilterDistanceWithIn
FilterUuid
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
ForcePaymentErrorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALREADY_PAID"
ForcePaymentResponse
Fields
| Field Name | Description |
|---|---|
status - PaymentStatusEnum
|
|
error - ForcePaymentErrorEnum
|
Example
{"status": "PENDING", "error": "ALREADY_PAID"}
FtpAccess
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
IdTokenEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CENTRAL"
ImageChallenge
ImageData
ImageInfo
Fields
| Field Name | Description |
|---|---|
original - ImageData
|
|
resized - ImageProcessedData
|
|
cropped - ImageProcessedData
|
|
extracted - ImageProcessedData
|
Example
{
"original": ImageData,
"resized": ImageProcessedData,
"cropped": ImageProcessedData,
"extracted": ImageProcessedData
}
ImageProcessedData
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Invoice
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
seqNo - Float
|
|
amount - Float!
|
|
currency - CurrencyEnum!
|
|
status - InvoiceStatusEnum
|
|
vatRate - VatRate
|
|
internalPrivateUseDescription - String
|
|
invoiceItems - [InvoiceItem!]
|
|
payments - [Payment!]
|
|
customer - Customer
|
|
company - Company
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": "4",
"seqNo": 987.65,
"amount": 123.45,
"currency": "USD",
"status": "PAID",
"vatRate": VatRate,
"internalPrivateUseDescription": "abc123",
"invoiceItems": [InvoiceItem],
"payments": [Payment],
"customer": Customer,
"company": Company,
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
InvoiceInputFilter
Fields
| Input Field | Description |
|---|---|
id - FilterUuid
|
|
seqNo - FilterCompareNumber
|
Example
{
"id": FilterUuid,
"seqNo": FilterCompareNumber
}
InvoiceItem
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
amount - Float!
|
|
currency - CurrencyEnum!
|
|
vatRate - VatRate
|
|
purpose - InvoiceItemPurposeEnum
|
|
description - String
|
|
reservation - ReservationCard
|
|
transaction - Transaction
|
|
discount - Discount
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"amount": 987.65,
"currency": "USD",
"vatRate": VatRate,
"purpose": "ADJUSTMENT_ENTRY",
"description": "abc123",
"reservation": ReservationCard,
"transaction": Transaction,
"discount": Discount,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
InvoiceItemPurposeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADJUSTMENT_ENTRY"
InvoiceStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PAID"
Language
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EN"
LanguageEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RUSSIAN"
Last30dData
Fields
| Field Name | Description |
|---|---|
totalKWH - ChartElementSplittable
|
|
paidKWH - ChartElementSplittable
|
|
totalAmount - ChartElementSplittable
|
Example
{
"totalKWH": ChartElementSplittable,
"paidKWH": ChartElementSplittable,
"totalAmount": ChartElementSplittable
}
LastMonthConsumption
LastTransactions
Fields
| Field Name | Description |
|---|---|
totalKW - Float
|
|
transactionStep - TransactionStepsEnum
|
|
updatedAt - DateTime
|
|
createdAt - DateTime
|
Example
{
"totalKW": 987.65,
"transactionStep": "CABLE_PLUGGED_IN",
"updatedAt": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z"
}
MeterValue
Fields
| Field Name | Description |
|---|---|
timestamp - String
|
|
messageId - String
|
|
power - MeterValueUnit
|
|
voltage - MeterValueUnit
|
|
current - MeterValueUnit
|
|
soc - MeterValueUnit
|
|
rawData - String!
|
Example
{
"timestamp": "xyz789",
"messageId": "xyz789",
"power": MeterValueUnit,
"voltage": MeterValueUnit,
"current": MeterValueUnit,
"soc": MeterValueUnit,
"rawData": "xyz789"
}
MeterValueUnit
Fields
| Field Name | Description |
|---|---|
value - Float
|
|
unit - UnitOfMeasureEnumType
|
Example
{"value": 987.65, "unit": "WH"}
MostPopularByWeek
MultiContainsInputType
Fields
| Input Field | Description |
|---|---|
contains - String!
|
Example
{"contains": "xyz789"}
OIDCServiceEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DOMA"
OcppMessageDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TO_CS"
OcppSupportedEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"V120SOAP"
OidcGetInternalTokenResponse
Fields
| Field Name | Description |
|---|---|
token - String!
|
Example
{"token": "xyz789"}
OidcInitResponse
OpeningHoursInput
Fields
| Input Field | Description |
|---|---|
periods - [PeriodInput!]!
|
Example
{"periods": [PeriodInput]}
OpeningHoursType
Fields
| Field Name | Description |
|---|---|
periods - [PeriodType!]!
|
Example
{"periods": [PeriodType]}
OtpCreateResponse
Fields
| Field Name | Description |
|---|---|
expiresAt - DateTime!
|
|
validationStatus - PhoneNumberValidationStatus
|
Example
{
"expiresAt": "2007-12-03T10:15:30Z",
"validationStatus": PhoneNumberValidationStatus
}
OtpValidationStatus
OtpVerifyResponse
Fields
| Field Name | Description |
|---|---|
token - String!
|
|
customerId - String!
|
|
companies - [Company!]
|
|
validationStatus - OtpValidationStatus
|
Example
{
"token": "xyz789",
"customerId": "abc123",
"companies": [Company],
"validationStatus": OtpValidationStatus
}
Page
Payment
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
seqNo - Float
|
|
paid - Boolean
|
|
refunded - Boolean
|
|
refundId - String
|
|
test - Boolean
|
|
externalPaymentId - String
|
|
customerId - String
|
|
invoice - Invoice
|
|
customerPhone - String
|
|
paymentMethodId - String
|
|
transactionId - String
|
|
transaction - Transaction
|
|
chargingStationName - String
|
|
paymentService - PaymentServiceEnum
|
|
amount - String
|
|
vatRate - VatRate
|
|
incomeAmount - String
|
|
currency - CurrencyEnum
|
|
description - String
|
|
status - PaymentStatusEnum
|
|
capturedAt - DateTime
|
|
expiresAt - DateTime
|
|
receiptStatus - PaymentReceiptStatusEnum
|
|
receiptId - String
|
|
receiptUrl - String
|
|
rrn - String
|
|
receiptService - ReceiptServiceEnum
|
|
cancellationParty - PaymentCancellationPartyEnum
|
|
cancellationReason - String
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 987.65,
"paid": false,
"refunded": true,
"refundId": "abc123",
"test": true,
"externalPaymentId": "xyz789",
"customerId": "xyz789",
"invoice": Invoice,
"customerPhone": "abc123",
"paymentMethodId": "abc123",
"transactionId": "abc123",
"transaction": Transaction,
"chargingStationName": "xyz789",
"paymentService": "YOOKASSA",
"amount": "abc123",
"vatRate": VatRate,
"incomeAmount": "abc123",
"currency": "USD",
"description": "xyz789",
"status": "PENDING",
"capturedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"receiptStatus": "PENDING",
"receiptId": "abc123",
"receiptUrl": "xyz789",
"rrn": "abc123",
"receiptService": "BUHTA",
"cancellationParty": "YANDEX_CHECKOUT",
"cancellationReason": "abc123",
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PaymentCancellationPartyEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"YANDEX_CHECKOUT"
PaymentCard
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
seqNo - Float
|
|
status - PaymentStatusEnum
|
|
paymentService - PaymentServiceEnum
|
|
paid - Boolean
|
|
refunded - Boolean
|
|
refundId - String
|
|
test - Boolean
|
|
amount - String
|
|
incomeAmount - String
|
|
currency - CurrencyEnum
|
|
vatRate - VatRate
|
|
description - String
|
|
rrn - String
|
|
externalPaymentId - String
|
|
customer - Customer
|
|
invoice - Invoice
|
|
paymentMethodId - String
|
|
paymentMethod - PaymentMethod
|
|
transaction - Transaction
|
|
capturedAt - DateTime
|
|
expiresAt - DateTime
|
|
receiptService - ReceiptServiceEnum
|
|
receiptStatus - PaymentReceiptStatusEnum
|
|
receiptId - String
|
|
receiptUrl - String
|
|
cancellationParty - PaymentCancellationPartyEnum
|
|
cancellationReason - String
|
|
receiptRefundId - String
|
|
receiptRefundUrl - String
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 987.65,
"status": "PENDING",
"paymentService": "YOOKASSA",
"paid": false,
"refunded": true,
"refundId": "abc123",
"test": true,
"amount": "abc123",
"incomeAmount": "xyz789",
"currency": "USD",
"vatRate": VatRate,
"description": "abc123",
"rrn": "abc123",
"externalPaymentId": "abc123",
"customer": Customer,
"invoice": Invoice,
"paymentMethodId": "abc123",
"paymentMethod": PaymentMethod,
"transaction": Transaction,
"capturedAt": "2007-12-03T10:15:30Z",
"expiresAt": "2007-12-03T10:15:30Z",
"receiptService": "BUHTA",
"receiptStatus": "PENDING",
"receiptId": "abc123",
"receiptUrl": "abc123",
"cancellationParty": "YANDEX_CHECKOUT",
"cancellationReason": "xyz789",
"receiptRefundId": "abc123",
"receiptRefundUrl": "abc123",
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PaymentCardTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MASTER_CARD"
PaymentInputFilter
Fields
| Input Field | Description |
|---|---|
isPaid - FilterCompareBoolean
|
|
id - FilterUuid
|
|
seqNo - FilterCompareNumber
|
Example
{
"isPaid": FilterCompareBoolean,
"id": FilterUuid,
"seqNo": FilterCompareNumber
}
PaymentMethod
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
paymentType - PaymentTypeEnum
|
|
paymentService - PaymentServiceEnum
|
|
selected - Boolean
|
|
first6 - Float
|
|
last4 - Float
|
|
expiryMonth - String
|
|
expiryYear - String
|
|
cardType - PaymentCardTypeEnum
|
|
issuerCountry - CountryCodeEnumType
|
|
issuerName - String
|
|
ico - String
|
Example
{
"id": "4",
"paymentType": "BANK_CARD",
"paymentService": "YOOKASSA",
"selected": true,
"first6": 123.45,
"last4": 987.65,
"expiryMonth": "xyz789",
"expiryYear": "abc123",
"cardType": "MASTER_CARD",
"issuerCountry": "AFGHANISTAN",
"issuerName": "xyz789",
"ico": "xyz789"
}
PaymentMethodInputFilter
Fields
| Input Field | Description |
|---|---|
id - FilterUuid
|
|
paymentType - FilterComparePaymentTypeEnum
|
|
paymentService - FilterComparePaymentService
|
|
selected - FilterCompareBoolean
|
Example
{
"id": FilterUuid,
"paymentType": FilterComparePaymentTypeEnum,
"paymentService": FilterComparePaymentService,
"selected": FilterCompareBoolean
}
PaymentReceiptStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PENDING"
PaymentResponse
Fields
| Field Name | Description |
|---|---|
status - PaymentStatusEnum!
|
|
redirectUrl - String
|
|
returnUrl - String
|
|
confirmationToken - String
|
Example
{
"status": "PENDING",
"redirectUrl": "abc123",
"returnUrl": "abc123",
"confirmationToken": "abc123"
}
PaymentService
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
ico - String!
|
|
title - String!
|
|
paymentService - PaymentServiceEnum!
|
Example
{
"id": "abc123",
"ico": "abc123",
"title": "abc123",
"paymentService": "YOOKASSA"
}
PaymentServiceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"YOOKASSA"
PaymentStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
PaymentTopUpMethods
Fields
| Field Name | Description |
|---|---|
paymentServices - [PaymentService!]!
|
|
paymentMethods - [PaymentMethod!]!
|
Example
{
"paymentServices": [PaymentService],
"paymentMethods": [PaymentMethod]
}
PaymentTopUpResponse
Fields
| Field Name | Description |
|---|---|
status - PaymentStatusEnum
|
|
redirectUrl - String
|
|
returnUrl - String
|
|
confirmationToken - String
|
Example
{
"status": "PENDING",
"redirectUrl": "abc123",
"returnUrl": "abc123",
"confirmationToken": "xyz789"
}
PaymentTransactionInputFilter
Fields
| Input Field | Description |
|---|---|
id - FilterUuid
|
|
chargingStation - ChargingStationInputFilter
|
Example
{
"id": FilterUuid,
"chargingStation": ChargingStationInputFilter
}
PaymentTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BANK_CARD"
PaymentsList
Fields
| Field Name | Description |
|---|---|
rows - [PaymentCard!]!
|
|
count - Float!
|
Example
{"rows": [PaymentCard], "count": 123.45}
PaymentsListRequestOrderInputType
PeriodInput
Fields
| Input Field | Description |
|---|---|
open - DayAndTimeInput!
|
|
close - DayAndTimeInput
|
Example
{
"open": DayAndTimeInput,
"close": DayAndTimeInput
}
PeriodType
Fields
| Field Name | Description |
|---|---|
open - DayAndTimeType!
|
|
close - DayAndTimeType
|
Example
{
"open": DayAndTimeType,
"close": DayAndTimeType
}
PersonalDataVersion
Example
{
"id": 987.65,
"name": "abc123",
"description": "xyz789",
"version": 987,
"subTenantId": "xyz789",
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PhoneNumberValidationStatus
PowerEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SLOW"
Promocode
Example
{
"id": "4",
"seqNo": 123.45,
"code": "abc123",
"name": "xyz789",
"amount": 987.65,
"currency": "USD",
"active": false,
"internalPrivateUseDescription": "abc123",
"customerId": "abc123",
"customer": Customer,
"tenant": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
PushNotificationsServiceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXPO"
ReasonEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DE_AUTHORIZED"
ReceiptGenerationTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PAYMENT"
ReceiptServiceEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"BUHTA"
ReservationCancelReasonEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BY_CUSTOMER"
ReservationCard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float!
|
|
reserveNowId - Float
|
|
used - Boolean
|
|
canceled - Boolean
|
|
cancelReason - ReservationCancelReasonEnum
|
|
validFrom - DateTime
|
|
validTo - DateTime
|
|
tariff - TariffType
|
|
chargingStation - ChargingStationCard
|
|
connector - Connector
|
|
invoice - Invoice
|
|
authorization - Authorization
|
|
roamingAccessId - Float
|
|
tenant - String
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 123.45,
"reserveNowId": 987.65,
"used": true,
"canceled": true,
"cancelReason": "BY_CUSTOMER",
"validFrom": "2007-12-03T10:15:30Z",
"validTo": "2007-12-03T10:15:30Z",
"tariff": TariffType,
"chargingStation": ChargingStationCard,
"connector": Connector,
"invoice": Invoice,
"authorization": Authorization,
"roamingAccessId": 987.65,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ReservationsList
Fields
| Field Name | Description |
|---|---|
rows - [ReservationCard!]!
|
|
count - Float!
|
Example
{"rows": [ReservationCard], "count": 987.65}
ReservationsListRequestOrderInputType
ReserveNowResponse
ResetStatusEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
ResetTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HARD"
RoamingAccess
Example
{
"id": "4",
"name": "xyz789",
"description": "abc123",
"tenant": "abc123",
"chargingStationCategoryId": 987.65,
"companyId": "abc123",
"company": Company,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
SignInAsCorporateResponse
Sort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"asc"
SpecialIdentifierEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EVIKA"
SpeedEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SLOW"
StartTransactionLimit
StartTransactionResponse
StopInitiatorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CUSTOMER"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SupportedCountry
Fields
| Field Name | Description |
|---|---|
enum - CountryCodeEnumType!
|
Example
{"enum": "AFGHANISTAN"}
SystemMessage
Example
{
"id": 4,
"title": "xyz789",
"text": "xyz789",
"visibilityType": "HIDEABLE",
"androidAppVersion": "xyz789",
"iosAppVersion": "abc123",
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
SystemMessageVisibilityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"HIDEABLE"
TariffGroup
Example
{
"id": 4,
"seqNo": 987.65,
"name": "abc123",
"description": "xyz789",
"timetables": [TariffGroupTimetable],
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TariffGroupTimetable
Example
{
"id": "4",
"seqNo": 987.65,
"name": "abc123",
"description": "abc123",
"tariffId": "xyz789",
"tariff": TariffType,
"onHoliday": false,
"country": "AFGHANISTAN",
"timezone": "abc123",
"dayOfWeek": [987.65],
"startTime": "xyz789",
"endTime": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TariffPurposeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BOOKING"
TariffType
Fields
| Field Name | Description |
|---|---|
id - String
|
|
type - TariffTypeEnum!
|
|
amount - Float!
|
|
currency - CurrencyEnum!
|
|
name - String
|
Example
{
"id": "abc123",
"type": "PER_KW",
"amount": 987.65,
"currency": "USD",
"name": "xyz789"
}
TariffTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PER_KW"
TariffsListFilter
Fields
| Input Field | Description |
|---|---|
id - FilterCompareString
|
|
purpose - FilterComparePurpose
|
|
name - FilterCompareString
|
|
amount - FilterCompareNumber
|
Example
{
"id": FilterCompareString,
"purpose": FilterComparePurpose,
"name": FilterCompareString,
"amount": FilterCompareNumber
}
TenantSettings
Fields
| Field Name | Description |
|---|---|
country - CountryCodeEnumType
|
|
featureBalance - Boolean
|
|
vatRate - VatRate
|
|
paymentService - PaymentServiceEnum
|
|
currency - CurrencyEnum
|
Example
{
"country": "AFGHANISTAN",
"featureBalance": true,
"vatRate": VatRate,
"paymentService": "YOOKASSA",
"currency": "USD"
}
TerritoryAccessData
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
name - String
|
|
description - String
|
|
requestDescription - String
|
|
requestType - AccessPermissionRequestTypeEnum
|
|
canChooseTime - Boolean
|
|
openingHours - OpeningHoursType
|
Example
{
"id": "xyz789",
"name": "abc123",
"description": "abc123",
"requestDescription": "abc123",
"requestType": "SMS",
"canChooseTime": true,
"openingHours": OpeningHoursType
}
TerritoryAccessPermissionResponse
Transaction
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float!
|
|
startedPercentage - Float
|
|
percentage - Float
|
|
chargingStationId - String!
|
|
chargingStation - ChargingStation
|
|
connector - Connector
|
|
hasActiveChargingProfile - Boolean
|
|
chargingStationName - String
|
|
customerId - String
|
|
customerPhone - String
|
|
evseId - Float!
|
|
connectorId - Float
|
|
stoppedReason - ReasonEnumType
|
|
chargingState - ChargingStateEnumType
|
|
startedTimestamp - DateTime
|
|
startChargingTimestamp - DateTime
|
|
stoppedTimestamp - DateTime
|
|
currentKW - Float
|
|
totalKW - Float
|
|
totalDuration - Float
|
|
tariff - TariffType
|
|
payment - Payment
|
|
invoice - Invoice
|
|
transactionStep - TransactionStepsEnum
|
|
meterStart - Float
|
|
meterStop - Float
|
|
processedAt - DateTime
|
|
reprocessedAt - DateTime
|
|
startedKW - Float
|
|
latestKW - Float
|
|
meterValues - [MeterValue!]
|
|
authorization - Authorization
|
|
stopInitiator - StopInitiatorEnum
|
|
stoppedBySystemUserId - String
|
|
stoppedBySystemUser - User
|
|
onReview - TransactionOnReview
|
|
tenant - String
|
|
roamingAccessId - Float
|
|
isRoaming - Boolean
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 987.65,
"startedPercentage": 987.65,
"percentage": 123.45,
"chargingStationId": "xyz789",
"chargingStation": ChargingStation,
"connector": Connector,
"hasActiveChargingProfile": false,
"chargingStationName": "xyz789",
"customerId": "xyz789",
"customerPhone": "abc123",
"evseId": 123.45,
"connectorId": 123.45,
"stoppedReason": "DE_AUTHORIZED",
"chargingState": "CHARGING",
"startedTimestamp": "2007-12-03T10:15:30Z",
"startChargingTimestamp": "2007-12-03T10:15:30Z",
"stoppedTimestamp": "2007-12-03T10:15:30Z",
"currentKW": 987.65,
"totalKW": 123.45,
"totalDuration": 123.45,
"tariff": TariffType,
"payment": Payment,
"invoice": Invoice,
"transactionStep": "CABLE_PLUGGED_IN",
"meterStart": 987.65,
"meterStop": 987.65,
"processedAt": "2007-12-03T10:15:30Z",
"reprocessedAt": "2007-12-03T10:15:30Z",
"startedKW": 123.45,
"latestKW": 987.65,
"meterValues": [MeterValue],
"authorization": Authorization,
"stopInitiator": "CUSTOMER",
"stoppedBySystemUserId": "abc123",
"stoppedBySystemUser": User,
"onReview": TransactionOnReview,
"tenant": "xyz789",
"roamingAccessId": 123.45,
"isRoaming": true,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TransactionBrief
TransactionCard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float!
|
|
startedPercentage - Float
|
|
percentage - Float
|
|
chargingStationId - String!
|
|
chargingStation - ChargingStationCard
|
|
connector - Connector
|
|
hasActiveChargingProfile - Boolean
|
|
evseId - Float!
|
|
connectorId - Float
|
|
maxAllowedSeconds - Float
|
|
maxAllowedWh - Float
|
|
maxAllowedMoney - String
|
|
stoppedReason - ReasonEnumType
|
|
chargingState - ChargingStateEnumType
|
|
startedTimestamp - DateTime
|
|
startChargingTimestamp - DateTime
|
|
stoppedTimestamp - DateTime
|
|
currentKW - Float
|
|
totalKW - Float
|
|
totalDuration - Float
|
|
tariff - TariffType
|
|
payment - Payment
|
|
invoice - Invoice
|
|
transactionStep - TransactionStepsEnum
|
|
meterStart - Float
|
|
meterStop - Float
|
|
processedAt - DateTime
|
|
reprocessedAt - DateTime
|
|
startedKW - Float
|
|
latestKW - Float
|
|
meterValues - [MeterValue!]
|
|
chartMeterValues - ChartMeterValues
|
|
authorization - Authorization
|
|
stopInitiator - StopInitiatorEnum
|
|
stoppedBySystemUserId - String
|
|
stoppedBySystemUser - User
|
|
onReview - TransactionOnReview
|
|
tenant - String
|
|
roamingAccessId - Float
|
|
isRoaming - Boolean
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": "4",
"seqNo": 987.65,
"startedPercentage": 987.65,
"percentage": 987.65,
"chargingStationId": "abc123",
"chargingStation": ChargingStationCard,
"connector": Connector,
"hasActiveChargingProfile": false,
"evseId": 123.45,
"connectorId": 123.45,
"maxAllowedSeconds": 987.65,
"maxAllowedWh": 987.65,
"maxAllowedMoney": "xyz789",
"stoppedReason": "DE_AUTHORIZED",
"chargingState": "CHARGING",
"startedTimestamp": "2007-12-03T10:15:30Z",
"startChargingTimestamp": "2007-12-03T10:15:30Z",
"stoppedTimestamp": "2007-12-03T10:15:30Z",
"currentKW": 123.45,
"totalKW": 123.45,
"totalDuration": 987.65,
"tariff": TariffType,
"payment": Payment,
"invoice": Invoice,
"transactionStep": "CABLE_PLUGGED_IN",
"meterStart": 987.65,
"meterStop": 987.65,
"processedAt": "2007-12-03T10:15:30Z",
"reprocessedAt": "2007-12-03T10:15:30Z",
"startedKW": 123.45,
"latestKW": 123.45,
"meterValues": [MeterValue],
"chartMeterValues": ChartMeterValues,
"authorization": Authorization,
"stopInitiator": "CUSTOMER",
"stoppedBySystemUserId": "xyz789",
"stoppedBySystemUser": User,
"onReview": TransactionOnReview,
"tenant": "abc123",
"roamingAccessId": 987.65,
"isRoaming": false,
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TransactionOnReview
Example
{
"id": 123.45,
"reviewed": true,
"description": "xyz789",
"reason": "CHARGING_STATION_OFFLINE",
"reviewerUser": User,
"tenant": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TransactionReviewReasonEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHARGING_STATION_OFFLINE"
TransactionStepsEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CABLE_PLUGGED_IN"
TransactionsCount
TransactionsList
Fields
| Field Name | Description |
|---|---|
rows - [TransactionCard!]!
|
|
count - Float!
|
Example
{"rows": [TransactionCard], "count": 987.65}
TransactionsListRequestOrderInputType
TransactionsOnReviewInputFilter
Fields
| Input Field | Description |
|---|---|
reviewed - FilterCompareBoolean
|
Example
{"reviewed": FilterCompareBoolean}
Translation
Example
{
"id": 4,
"lang": "RUSSIAN",
"tenant": "xyz789",
"version": 123.45,
"appVersion": "abc123",
"app": "MAIN_WEBSITE",
"subTenantId": "abc123",
"hash": "abc123",
"fileLink": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
TranslationAppEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MAIN_WEBSITE"
TranslationLatestVersionResponse
TranslationSupportedLanguage
Fields
| Field Name | Description |
|---|---|
enum - LanguageEnum!
|
|
en - String!
|
|
translated - String!
|
Example
{
"enum": "RUSSIAN",
"en": "abc123",
"translated": "xyz789"
}
TranslationTargetInputType
TranslationsList
Fields
| Field Name | Description |
|---|---|
rows - [Translation!]!
|
|
count - Float!
|
Example
{"rows": [Translation], "count": 123.45}
TranslationsRequestOrderInputType
UnitOfMeasureEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"WH"
UnlockStatusEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNLOCKED"
UptimeMonitoring
Fields
| Field Name | Description |
|---|---|
status - UptimeStatusEnum!
|
|
createdAt - DateTime!
|
Example
{
"status": "CONNECTED",
"createdAt": "2007-12-03T10:15:30Z"
}
UptimeStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CONNECTED"
User
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float
|
|
role - UserRoleEnumType
|
|
company - Company
|
|
tenant - String
|
|
name - String!
|
|
surname - String!
|
|
middlename - String
|
|
description - String
|
|
phone - String
|
|
email - String
|
|
pendingEmail - String
|
|
emailVerified - Boolean
|
|
active - Boolean
|
|
lastLogin - DateTime
|
|
createdAt - DateTime
|
|
updatedAt - DateTime
|
Example
{
"id": 4,
"seqNo": 123.45,
"role": "SUPER_ADMIN",
"company": Company,
"tenant": "xyz789",
"name": "abc123",
"surname": "abc123",
"middlename": "abc123",
"description": "xyz789",
"phone": "xyz789",
"email": "abc123",
"pendingEmail": "abc123",
"emailVerified": true,
"active": true,
"lastLogin": "2007-12-03T10:15:30Z",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
UserBrief
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
seqNo - Float!
|
|
email - String
|
|
phone - String
|
|
name - String
|
|
surname - String
|
|
middlename - String
|
|
company - Company
|
|
tenant - String
|
|
hasNotAcceptedPdAgreement - Boolean
|
|
tenantSettings - TenantSettings
|
|
customerSettings - CustomerSettings
|
|
country - CountryCodeEnumType
|
|
role - UserRoleEnumType
|
|
defaultCoordinates - Coordinates
|
Example
{
"id": 4,
"seqNo": 123.45,
"email": "abc123",
"phone": "xyz789",
"name": "xyz789",
"surname": "abc123",
"middlename": "abc123",
"company": Company,
"tenant": "xyz789",
"hasNotAcceptedPdAgreement": true,
"tenantSettings": TenantSettings,
"customerSettings": CustomerSettings,
"country": "AFGHANISTAN",
"role": "SUPER_ADMIN",
"defaultCoordinates": Coordinates
}
UserRoleEnumType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SUPER_ADMIN"
ValidateResponse
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
Example
{"active": false}
VatRate
Example
{
"id": 123.45,
"name": "abc123",
"description": "abc123",
"amount": 123.45,
"country": "AFGHANISTAN",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}