GraphQL reference
Welcome to the GraphQL API Documentation, generated using SpectaQL. This documentation provides an in-depth overview of the available queries, mutations, types, and relationships within our API.
Our GraphQL API is designed to offer a flexible and efficient way to interact with our data, allowing clients to request only the information they need. Use this guide to explore the schema, understand request structures, and streamline your integration with our services.
For any questions or assistance, feel free to reach out to our team. Happy querying! 🚀
API Endpoints
# Acceptance:
https://router.acc.moveyou.dev
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
address
Use addressesGetAddress instead
Description
Get single address by ID
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Example
Query
query address($id: UUID!) {
address(id: $id) {
id
tenantId
street
houseNumber
houseNumberAddition
postalCode
city
country
province
location {
...CoordinatesFragment
}
area
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"address": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "xyz789",
"city": "xyz789",
"country": "AL",
"province": "xyz789",
"location": Coordinates,
"area": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
}
}
addressLookup
Use addressesGetAddressLookup instead
Description
Get Address Lookup Response
Response
Returns an AddressLookupResponse!
Arguments
| Name | Description |
|---|---|
input - AddressLookupInput!
|
Look for address based on postal code and country code |
Example
Query
query addressLookup($input: AddressLookupInput!) {
addressLookup(input: $input) {
city
province
street
}
}
Variables
{"input": AddressLookupInput}
Response
{
"data": {
"addressLookup": {
"city": "xyz789",
"province": "xyz789",
"street": "xyz789"
}
}
}
addresses
Use addressesGetAddresses instead
Description
List all addresses
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Response
Returns an AddressConnection!
Example
Query
query addresses(
$street: String,
$first: Int!,
$after: String
) {
addresses(
street: $street,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...AddressEdgeFragment
}
}
}
Variables
{
"street": "xyz789",
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"addresses": {
"pageInfo": PageInfo,
"edges": [AddressEdge]
}
}
}
addressesGetAddress
Description
Get single address by ID
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Example
Query
query addressesGetAddress($id: UUID!) {
addressesGetAddress(id: $id) {
id
tenantId
street
houseNumber
houseNumberAddition
postalCode
city
country
province
location {
...CoordinatesFragment
}
area
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"addressesGetAddress": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "abc123",
"houseNumber": "xyz789",
"houseNumberAddition": "xyz789",
"postalCode": "xyz789",
"city": "abc123",
"country": "AL",
"province": "xyz789",
"location": Coordinates,
"area": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
}
}
addressesGetAddressLookup
Description
Get Address Lookup Response
Response
Returns an AddressLookupResponse!
Arguments
| Name | Description |
|---|---|
input - AddressLookupInput!
|
Look for address based on postal code and country code |
Example
Query
query addressesGetAddressLookup($input: AddressLookupInput!) {
addressesGetAddressLookup(input: $input) {
city
province
street
}
}
Variables
{"input": AddressLookupInput}
Response
{
"data": {
"addressesGetAddressLookup": {
"city": "xyz789",
"province": "xyz789",
"street": "xyz789"
}
}
}
addressesGetAddresses
Description
List all addresses
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Response
Returns an AddressConnection!
Example
Query
query addressesGetAddresses(
$street: String,
$first: Int!,
$after: String
) {
addressesGetAddresses(
street: $street,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...AddressEdgeFragment
}
}
}
Variables
{
"street": "abc123",
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"addressesGetAddresses": {
"pageInfo": PageInfo,
"edges": [AddressEdge]
}
}
}
addressesGetShippingAddress
Description
Get single shipping address by ID
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Response
Returns a ShippingAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query addressesGetShippingAddress($id: UUID!) {
addressesGetShippingAddress(id: $id) {
id
name
firstName
lastName
phoneNumber
gender
address {
...AddressFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"addressesGetShippingAddress": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"phoneNumber": "abc123",
"gender": "MALE",
"address": Address
}
}
}
addressesGetShippingAddresses
Description
List all shipping addresses
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Response
Returns a ShippingAddressConnection!
Example
Query
query addressesGetShippingAddresses(
$name: String,
$first_name: String,
$last_name: String,
$first: Int!,
$after: String
) {
addressesGetShippingAddresses(
name: $name,
first_name: $first_name,
last_name: $last_name,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ShippingAddressEdgeFragment
}
}
}
Variables
{
"name": "xyz789",
"first_name": "xyz789",
"last_name": "abc123",
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"addressesGetShippingAddresses": {
"pageInfo": PageInfo,
"edges": [ShippingAddressEdge]
}
}
}
authTwoFactorAuthenticationCode
Description
Retrieve to factor authentication code
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a TwoFactorAuthenticationResponse!
Example
Query
query authTwoFactorAuthenticationCode {
authTwoFactorAuthenticationCode {
image
url
}
}
Response
{
"data": {
"authTwoFactorAuthenticationCode": {
"image": "xyz789",
"url": "xyz789"
}
}
}
availableCountries
Use userAvailableCountries instead
Description
List available countries
Response
Returns [CountryList!]!
Example
Query
query availableCountries {
availableCountries {
name
code
emoji
unicode
dialCode
image
}
}
Response
{
"data": {
"availableCountries": [
{
"name": "xyz789",
"code": "abc123",
"emoji": "xyz789",
"unicode": "xyz789",
"dialCode": "abc123",
"image": "xyz789"
}
]
}
}
card
use cardsGetCard instead.
Description
Get single card by UUID
Roles:
- ROLE_CARD_ADMIN
Example
Query
query card($id: UUID!) {
card(id: $id) {
id
tenant {
...TenantFragment
}
limit {
...TemplateLimitFragment
}
chargePointOperatorPool {
...ChargePointOperatorPoolFragment
}
chargePointOperators {
...ChargePointOperatorFragment
}
template {
...TemplateFragment
}
cardType
company {
...OrganizationalComponentFragment
}
companyName
user {
...UserFragment
}
vehicle {
...VehicleFragment
}
externalReference
cardNumber
associations {
... on FuelCard {
...FuelCardFragment
}
... on ChargeToken {
...ChargeTokenFragment
}
}
products {
...ProductFragment
}
locations {
...CardLocationFragment
}
comments {
...CardCommentFragment
}
mileageRequired
driverCodeRequired
tokenUid
panNumber
order {
...OrderFragment
}
locale
disabledAt
createdAt
updatedAt
token
maskedBankNumber
trackingStartsFrom
metadata {
...ValueFragment
}
printInfo {
...PrintInfoFragment
}
priceModifications {
...PriceModificationFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"card": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"limit": TemplateLimit,
"chargePointOperatorPool": ChargePointOperatorPool,
"chargePointOperators": [ChargePointOperator],
"template": Template,
"cardType": "CHARGE",
"company": OrganizationalComponent,
"companyName": "xyz789",
"user": User,
"vehicle": Vehicle,
"externalReference": "abc123",
"cardNumber": "abc123",
"associations": [FuelCard],
"products": [Product],
"locations": [CardLocation],
"comments": [CardComment],
"mileageRequired": true,
"driverCodeRequired": true,
"tokenUid": "xyz789",
"panNumber": "abc123",
"order": Order,
"locale": "xyz789",
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"token": "xyz789",
"maskedBankNumber": "xyz789",
"trackingStartsFrom": DateTimeUtc,
"metadata": [Value],
"printInfo": PrintInfo,
"priceModifications": [PriceModification]
}
}
}
cards
use cardsGetCards instead.
Description
List cards.
Roles:
- ROLE_CARD_ADMIN
Response
Returns a CardConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCardsWhereWhereConditions
|
|
orderBy - [QueryCardsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query cards(
$where: QueryCardsWhereWhereConditions,
$orderBy: [QueryCardsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
cards(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CardEdgeFragment
}
}
}
Variables
{
"where": QueryCardsWhereWhereConditions,
"orderBy": [QueryCardsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"cards": {
"pageInfo": PageInfo,
"edges": [CardEdge]
}
}
}
cardsCompareCardStatisticsAmountDifference
Description
Compare Statistics Amount Difference between two periods
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a CardStatisticsDifference!
Example
Query
query cardsCompareCardStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$cardType: CardType!
) {
cardsCompareCardStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
cardType: $cardType
) {
total
amount
percentage
}
}
Variables
{
"firstStartDate": "xyz789",
"firstEndDate": "abc123",
"secondStartDate": "abc123",
"secondEndDate": "xyz789",
"cardType": "CHARGE"
}
Response
{
"data": {
"cardsCompareCardStatisticsAmountDifference": {
"total": 123,
"amount": 123,
"percentage": 987.65
}
}
}
cardsDailyCardStatistic
Description
get daily statistics
Response
Returns a DailyCardStatistic
Example
Query
query cardsDailyCardStatistic(
$date: Date,
$type: String
) {
cardsDailyCardStatistic(
date: $date,
type: $type
) {
id
tenant {
...TenantFragment
}
date
type
amount
}
}
Variables
{
"date": "2007-12-03",
"type": "abc123"
}
Response
{
"data": {
"cardsDailyCardStatistic": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"type": "CHARGE",
"amount": 123
}
}
}
cardsGetCard
Description
Get single card by UUID
Roles:
- ROLE_CARD_ADMIN
Example
Query
query cardsGetCard($id: UUID!) {
cardsGetCard(id: $id) {
id
tenant {
...TenantFragment
}
limit {
...TemplateLimitFragment
}
chargePointOperatorPool {
...ChargePointOperatorPoolFragment
}
chargePointOperators {
...ChargePointOperatorFragment
}
template {
...TemplateFragment
}
cardType
company {
...OrganizationalComponentFragment
}
companyName
user {
...UserFragment
}
vehicle {
...VehicleFragment
}
externalReference
cardNumber
associations {
... on FuelCard {
...FuelCardFragment
}
... on ChargeToken {
...ChargeTokenFragment
}
}
products {
...ProductFragment
}
locations {
...CardLocationFragment
}
comments {
...CardCommentFragment
}
mileageRequired
driverCodeRequired
tokenUid
panNumber
order {
...OrderFragment
}
locale
disabledAt
createdAt
updatedAt
token
maskedBankNumber
trackingStartsFrom
metadata {
...ValueFragment
}
printInfo {
...PrintInfoFragment
}
priceModifications {
...PriceModificationFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"cardsGetCard": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"limit": TemplateLimit,
"chargePointOperatorPool": ChargePointOperatorPool,
"chargePointOperators": [ChargePointOperator],
"template": Template,
"cardType": "CHARGE",
"company": OrganizationalComponent,
"companyName": "abc123",
"user": User,
"vehicle": Vehicle,
"externalReference": "abc123",
"cardNumber": "abc123",
"associations": [FuelCard],
"products": [Product],
"locations": [CardLocation],
"comments": [CardComment],
"mileageRequired": false,
"driverCodeRequired": false,
"tokenUid": "abc123",
"panNumber": "xyz789",
"order": Order,
"locale": "abc123",
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"token": "xyz789",
"maskedBankNumber": "xyz789",
"trackingStartsFrom": DateTimeUtc,
"metadata": [Value],
"printInfo": PrintInfo,
"priceModifications": [PriceModification]
}
}
}
cardsGetCards
Description
List cards.
Roles:
- ROLE_CARD_ADMIN
Response
Returns a CardConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCardsGetCardsWhereWhereConditions
|
|
orderBy - [QueryCardsGetCardsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query cardsGetCards(
$where: QueryCardsGetCardsWhereWhereConditions,
$orderBy: [QueryCardsGetCardsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
cardsGetCards(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CardEdgeFragment
}
}
}
Variables
{
"where": QueryCardsGetCardsWhereWhereConditions,
"orderBy": [QueryCardsGetCardsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"cardsGetCards": {
"pageInfo": PageInfo,
"edges": [CardEdge]
}
}
}
cardsGetTemplate
Description
Get single template by UUID
Roles:
- ROLE_TEMPLATE_ADMIN
Example
Query
query cardsGetTemplate($id: UUID!) {
cardsGetTemplate(id: $id) {
id
tenant {
...TenantFragment
}
label
description
limit {
...TemplateLimitFragment
}
chargePointOperatorPool {
...ChargePointOperatorPoolFragment
}
chargePointOperators {
...ChargePointOperatorFragment
}
fuelEnabled
chargingEnabled
products {
...ProductFragment
}
locations {
...CardLocationFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"cardsGetTemplate": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"label": "xyz789",
"description": "abc123",
"limit": TemplateLimit,
"chargePointOperatorPool": ChargePointOperatorPool,
"chargePointOperators": [ChargePointOperator],
"fuelEnabled": false,
"chargingEnabled": true,
"products": [Product],
"locations": [CardLocation],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
cardsGetTemplates
Description
List templates.
Roles:
- ROLE_TEMPLATE_ADMIN
Response
Returns a TemplateConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCardsGetTemplatesWhereWhereConditions
|
|
orderBy - [QueryCardsGetTemplatesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query cardsGetTemplates(
$where: QueryCardsGetTemplatesWhereWhereConditions,
$orderBy: [QueryCardsGetTemplatesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
cardsGetTemplates(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TemplateEdgeFragment
}
}
}
Variables
{
"where": QueryCardsGetTemplatesWhereWhereConditions,
"orderBy": [QueryCardsGetTemplatesOrderByOrderByClause],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"cardsGetTemplates": {
"pageInfo": PageInfo,
"edges": [TemplateEdge]
}
}
}
categories
Use
productsCategories instead. Description
List all categories.
Response
Returns a ProductCategoryConnection!
Arguments
| Name | Description |
|---|---|
label - String
|
Filters by id. Accepts SQL LIKE wildcards % and _. |
orderBy - [QueryCategoriesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query categories(
$label: String,
$orderBy: [QueryCategoriesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
categories(
label: $label,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ProductCategoryEdgeFragment
}
}
}
Variables
{
"label": "abc123",
"orderBy": [QueryCategoriesOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"categories": {
"pageInfo": PageInfo,
"edges": [ProductCategoryEdge]
}
}
}
category
Use
productsCategory instead. Description
Get single category by id.
Response
Returns a ProductCategory
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query category($id: UUID) {
category(id: $id) {
id
label
products {
...ProductFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"category": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"label": "abc123",
"products": [Product],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
chargeLocation
Description
Retrieve a single charge location by ID.
This call is publicly accessible but has a rate limit of 10 requests per second.
Response
Returns a ChargeLocation
Arguments
| Name | Description |
|---|---|
id - UUID
|
Example
Query
query chargeLocation($id: UUID) {
chargeLocation(id: $id) {
id
externalId
chargePointOperator {
...ChargePointOperatorFragment
}
type
name
address
city
postalCode
country
coordinates {
...CoordinatesFragment
}
evses {
...ChargeLocationEVSEFragment
}
openingTimes {
...ChargeLocationOpeningTimesFragment
}
energyMix {
...ChargingEnergyMixFragment
}
operator {
...ChargeLocationBusinessDetailsFragment
}
suboperator {
...ChargeLocationBusinessDetailsFragment
}
owner {
...ChargeLocationBusinessDetailsFragment
}
timeZone
chargingWhenClosed
isFavorited
distance
lastUpdated
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"chargeLocation": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"chargePointOperator": ChargePointOperator,
"type": "ON_STREET",
"name": "xyz789",
"address": "xyz789",
"city": "xyz789",
"postalCode": "abc123",
"country": "xyz789",
"coordinates": Coordinates,
"evses": [ChargeLocationEVSE],
"openingTimes": [ChargeLocationOpeningTimes],
"energyMix": ChargingEnergyMix,
"operator": ChargeLocationBusinessDetails,
"suboperator": ChargeLocationBusinessDetails,
"owner": ChargeLocationBusinessDetails,
"timeZone": "xyz789",
"chargingWhenClosed": true,
"isFavorited": true,
"distance": 987.65,
"lastUpdated": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
chargeLocations
Description
List of charge locations
This call is publicly accessible but has a rate limit of 10 requests per second.
Response
Returns a ChargeLocationConnection!
Arguments
| Name | Description |
|---|---|
searchRadius - SearchRadiusInput
|
|
searchBox - SearchBoxInput
|
|
where - QueryChargeLocationsWhereWhereConditions
|
|
hasEvses - QueryChargeLocationsHasEvsesWhereHasConditions
|
|
hasEvsesConnectors - QueryChargeLocationsHasEvsesConnectorsWhereHasConditions
|
|
whereHas - QueryChargeLocationsWhereHasWhereHasConditions
|
|
orderBy - [QueryChargeLocationsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargeLocations(
$searchRadius: SearchRadiusInput,
$searchBox: SearchBoxInput,
$where: QueryChargeLocationsWhereWhereConditions,
$hasEvses: QueryChargeLocationsHasEvsesWhereHasConditions,
$hasEvsesConnectors: QueryChargeLocationsHasEvsesConnectorsWhereHasConditions,
$whereHas: QueryChargeLocationsWhereHasWhereHasConditions,
$orderBy: [QueryChargeLocationsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
chargeLocations(
searchRadius: $searchRadius,
searchBox: $searchBox,
where: $where,
hasEvses: $hasEvses,
hasEvsesConnectors: $hasEvsesConnectors,
whereHas: $whereHas,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ChargeLocationEdgeFragment
}
}
}
Variables
{
"searchRadius": SearchRadiusInput,
"searchBox": SearchBoxInput,
"where": QueryChargeLocationsWhereWhereConditions,
"hasEvses": QueryChargeLocationsHasEvsesWhereHasConditions,
"hasEvsesConnectors": QueryChargeLocationsHasEvsesConnectorsWhereHasConditions,
"whereHas": QueryChargeLocationsWhereHasWhereHasConditions,
"orderBy": [QueryChargeLocationsOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"chargeLocations": {
"pageInfo": PageInfo,
"edges": [ChargeLocationEdge]
}
}
}
chargeLocationsGeoJson
Description
Retrieve charge locations in GeoJson format.
This call is publicly accessible but has a rate limit of 10 requests per second.
Response
Returns a ChargeLocationGeoJson
Arguments
| Name | Description |
|---|---|
zoomLevel - Int
|
|
excludedProviders - [UUID!]
|
|
hasEvses - QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions
|
|
hasEvsesCapabilities - QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions
|
|
hasEvsesConnectors - QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions
|
|
whereHas - QueryChargeLocationsGeoJsonWhereHasWhereHasConditions
|
|
searchBox - SearchBoxInput
|
Example
Query
query chargeLocationsGeoJson(
$zoomLevel: Int,
$excludedProviders: [UUID!],
$hasEvses: QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions,
$hasEvsesCapabilities: QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions,
$hasEvsesConnectors: QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions,
$whereHas: QueryChargeLocationsGeoJsonWhereHasWhereHasConditions,
$searchBox: SearchBoxInput
) {
chargeLocationsGeoJson(
zoomLevel: $zoomLevel,
excludedProviders: $excludedProviders,
hasEvses: $hasEvses,
hasEvsesCapabilities: $hasEvsesCapabilities,
hasEvsesConnectors: $hasEvsesConnectors,
whereHas: $whereHas,
searchBox: $searchBox
) {
type
features {
...FeaturesFragment
}
}
}
Variables
{
"zoomLevel": 987,
"excludedProviders": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"hasEvses": QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions,
"hasEvsesCapabilities": QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions,
"hasEvsesConnectors": QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions,
"whereHas": QueryChargeLocationsGeoJsonWhereHasWhereHasConditions,
"searchBox": SearchBoxInput
}
Response
{
"data": {
"chargeLocationsGeoJson": {
"type": "abc123",
"features": [Features]
}
}
}
chargePointOperator
Description
Find a single charge point operator by ID.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns a ChargePointOperator
Example
Query
query chargePointOperator(
$id: UUID,
$disabled: Disabled
) {
chargePointOperator(
id: $id,
disabled: $disabled
) {
id
versions {
...VersionFragment
}
pivot {
...ChargePointOperatorTokenPivotFragment
}
chargePointOperatorPools {
...ChargePointOperatorPoolFragment
}
name
url
versionPath
activeVersion
partyId
countryCode
disabledAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
tokens {
...ChargeTokenConnectionFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"disabled": "WITHOUT"
}
Response
{
"data": {
"chargePointOperator": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"versions": [Version],
"pivot": ChargePointOperatorTokenPivot,
"chargePointOperatorPools": [
ChargePointOperatorPool
],
"name": "xyz789",
"url": "xyz789",
"versionPath": "xyz789",
"activeVersion": "xyz789",
"partyId": "abc123",
"countryCode": "xyz789",
"disabledAt": "2007-12-03T10:15:30Z",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"tokens": ChargeTokenConnection
}
}
}
chargePointOperatorPools
Description
List of charge point operator pools
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns [ChargePointOperatorPool!]!
Example
Query
query chargePointOperatorPools {
chargePointOperatorPools {
id
label
chargePointOperators {
...ChargePointOperatorFragment
}
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Response
{
"data": {
"chargePointOperatorPools": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"label": "abc123",
"chargePointOperators": [ChargePointOperator],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
]
}
}
chargePointOperatorTransactions
Description
Example query with relay pagination.
Response
Returns a ChargePointTransactionConnection!
Arguments
| Name | Description |
|---|---|
where - QueryChargePointOperatorTransactionsWhereWhereConditions
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargePointOperatorTransactions(
$where: QueryChargePointOperatorTransactionsWhereWhereConditions,
$first: Int!,
$after: String
) {
chargePointOperatorTransactions(
where: $where,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ChargePointTransactionEdgeFragment
}
}
}
Variables
{
"where": QueryChargePointOperatorTransactionsWhereWhereConditions,
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"chargePointOperatorTransactions": {
"pageInfo": PageInfo,
"edges": [ChargePointTransactionEdge]
}
}
}
chargePointOperators
Description
List multiple charge point operators.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns a ChargePointOperatorConnection!
Arguments
| Name | Description |
|---|---|
where - QueryChargePointOperatorsWhereWhereConditions
|
|
disabled - Disabled
|
Default = WITHOUT |
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargePointOperators(
$where: QueryChargePointOperatorsWhereWhereConditions,
$disabled: Disabled,
$first: Int!,
$after: String
) {
chargePointOperators(
where: $where,
disabled: $disabled,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ChargePointOperatorEdgeFragment
}
}
}
Variables
{
"where": QueryChargePointOperatorsWhereWhereConditions,
"disabled": "WITHOUT",
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"chargePointOperators": {
"pageInfo": PageInfo,
"edges": [ChargePointOperatorEdge]
}
}
}
chargeRecord
Description
Retrieve a single charge record by ID.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
- ROLE_CHARGE_TOKEN_OWNER
Response
Returns a ChargeRecord
Arguments
| Name | Description |
|---|---|
id - UUID
|
Example
Query
query chargeRecord($id: UUID) {
chargeRecord(id: $id) {
id
externalId
startDate
endDate
lastUpdated
token {
...ChargeTokenFragment
}
chargePointOperator {
...ChargePointOperatorFragment
}
location {
...ChargeLocationFragment
}
evse {
...ChargeLocationEVSEFragment
}
connector {
...ChargeConnectorFragment
}
totalCost {
...MoneyFragment
}
totalCostEur {
...MoneyFragment
}
totalEnergy
totalTime
totalParkingTime
chargingPeriods {
...ChargingPeriodFragment
}
tariffs {
...ChargeRecordTariffFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"chargeRecord": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"startDate": DateTimeUtc,
"endDate": DateTimeUtc,
"lastUpdated": DateTimeUtc,
"token": ChargeToken,
"chargePointOperator": ChargePointOperator,
"location": ChargeLocation,
"evse": ChargeLocationEVSE,
"connector": ChargeConnector,
"totalCost": Money,
"totalCostEur": Money,
"totalEnergy": 123.45,
"totalTime": 987,
"totalParkingTime": 123,
"chargingPeriods": [ChargingPeriod],
"tariffs": [ChargeRecordTariff],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
chargeRecords
Description
List of charge records.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
- ROLE_CHARGE_TOKEN_OWNER
Response
Returns a ChargeRecordConnection!
Arguments
| Name | Description |
|---|---|
where - QueryChargeRecordsWhereWhereConditions
|
|
orderBy - [QueryChargeRecordsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargeRecords(
$where: QueryChargeRecordsWhereWhereConditions,
$orderBy: [QueryChargeRecordsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
chargeRecords(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ChargeRecordEdgeFragment
}
}
}
Variables
{
"where": QueryChargeRecordsWhereWhereConditions,
"orderBy": [QueryChargeRecordsOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"chargeRecords": {
"pageInfo": PageInfo,
"edges": [ChargeRecordEdge]
}
}
}
chargeRecordsMonthlyOrganizationalComponentStatistics
Description
Retrieve monthly statistics of charge records per company.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Arguments
| Name | Description |
|---|---|
where - QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions
|
|
orderBy - [QueryChargeRecordsMonthlyOrganizationalComponentStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargeRecordsMonthlyOrganizationalComponentStatistics(
$where: QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions,
$orderBy: [QueryChargeRecordsMonthlyOrganizationalComponentStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
chargeRecordsMonthlyOrganizationalComponentStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyMonthlyChargeStatisticsEdgeFragment
}
}
}
Variables
{
"where": QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions,
"orderBy": [
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsOrderByOrderByClause
],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"chargeRecordsMonthlyOrganizationalComponentStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyMonthlyChargeStatisticsEdge]
}
}
}
chargeRecordsWeeklyOrganizationalComponentStatistics
Description
Retrieve weekly statistics of charge records per company.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns a CompanyWeeklyChargeStatisticsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions
|
|
orderBy - [QueryChargeRecordsWeeklyOrganizationalComponentStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargeRecordsWeeklyOrganizationalComponentStatistics(
$where: QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions,
$orderBy: [QueryChargeRecordsWeeklyOrganizationalComponentStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
chargeRecordsWeeklyOrganizationalComponentStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyWeeklyChargeStatisticsEdgeFragment
}
}
}
Variables
{
"where": QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions,
"orderBy": [
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsOrderByOrderByClause
],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"chargeRecordsWeeklyOrganizationalComponentStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyWeeklyChargeStatisticsEdge]
}
}
}
chargeRecordsYearlyOrganizationalComponentStatistics
Description
Retrieve yearly statistics of charge records per company.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns a CompanyYearlyChargeStatisticsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions
|
|
orderBy - [QueryChargeRecordsYearlyOrganizationalComponentStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargeRecordsYearlyOrganizationalComponentStatistics(
$where: QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions,
$orderBy: [QueryChargeRecordsYearlyOrganizationalComponentStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
chargeRecordsYearlyOrganizationalComponentStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyYearlyChargeStatisticsEdgeFragment
}
}
}
Variables
{
"where": QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions,
"orderBy": [
QueryChargeRecordsYearlyOrganizationalComponentStatisticsOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"chargeRecordsYearlyOrganizationalComponentStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyYearlyChargeStatisticsEdge]
}
}
}
chargeToken
Description
Find a single charge token by ID.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
- ROLE_CHARGE_TOKEN_OWNER
Response
Returns a ChargeToken
Example
Query
query chargeToken(
$id: UUID!,
$disabled: Disabled
) {
chargeToken(
id: $id,
disabled: $disabled
) {
id
tenant {
...TenantFragment
}
user {
...UserFragment
}
company {
...OrganizationalComponentFragment
}
organizationalComponent {
...OrganizationalComponentFragment
}
card {
...CardFragment
}
chargePointOperatorPool {
...ChargePointOperatorPoolFragment
}
pivot {
...ChargePointOperatorTokenPivotFragment
}
tokenUid
type
issuer
language
externalReference
lastChargingSession
disabledAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
chargePointOperators {
...ChargePointOperatorConnectionFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"disabled": "WITH"
}
Response
{
"data": {
"chargeToken": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"user": User,
"company": OrganizationalComponent,
"organizationalComponent": OrganizationalComponent,
"card": Card,
"chargePointOperatorPool": ChargePointOperatorPool,
"pivot": ChargePointOperatorTokenPivot,
"tokenUid": "xyz789",
"type": "RFID",
"issuer": "abc123",
"language": "xyz789",
"externalReference": "xyz789",
"lastChargingSession": DateTimeUtc,
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"chargePointOperators": ChargePointOperatorConnection
}
}
}
chargeTokens
Description
List Multiple charge tokens.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
- ROLE_CHARGE_TOKEN_OWNER
Response
Returns a ChargeTokenConnection!
Arguments
| Name | Description |
|---|---|
where - QueryChargeTokensWhereWhereConditions
|
|
orderBy - [QueryChargeTokensOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query chargeTokens(
$where: QueryChargeTokensWhereWhereConditions,
$orderBy: [QueryChargeTokensOrderByOrderByClause!],
$first: Int!,
$after: String
) {
chargeTokens(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ChargeTokenEdgeFragment
}
}
}
Variables
{
"where": QueryChargeTokensWhereWhereConditions,
"orderBy": [QueryChargeTokensOrderByOrderByClause],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"chargeTokens": {
"pageInfo": PageInfo,
"edges": [ChargeTokenEdge]
}
}
}
companiesCompareStatisticsAmountDifference
Description
Compare Statistics Amount Difference between two periods
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a StatisticsDifference!
Arguments
| Name | Description |
|---|---|
firstStartDate - String!
|
|
firstEndDate - String!
|
|
secondStartDate - String!
|
|
secondEndDate - String!
|
|
companyType - OrganizationalComponentStatisticType
|
Example
Query
query companiesCompareStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$companyType: OrganizationalComponentStatisticType
) {
companiesCompareStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
companyType: $companyType
) {
amount
percentage
}
}
Variables
{
"firstStartDate": "xyz789",
"firstEndDate": "abc123",
"secondStartDate": "xyz789",
"secondEndDate": "xyz789",
"companyType": "COMPANY"
}
Response
{
"data": {
"companiesCompareStatisticsAmountDifference": {
"amount": 123,
"percentage": 123.45
}
}
}
companiesCreditCheck
Description
Get credit report by inquiry id
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CREDIT_CHECK_NOT_AVAILABLE_FOR_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
Response
Returns a CreditCheck
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query companiesCreditCheck($id: UUID!) {
companiesCreditCheck(id: $id) {
status
report {
...CreditCheckReportFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"companiesCreditCheck": {
"status": "PENDING",
"report": CreditCheckReport
}
}
}
companiesDailyStatistics
Description
Retrieve daily company statistics
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns [DailyStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryCompaniesDailyStatisticsWhereWhereConditions
|
|
orderBy - [QueryCompaniesDailyStatisticsOrderByOrderByClause!]
|
Example
Query
query companiesDailyStatistics(
$where: QueryCompaniesDailyStatisticsWhereWhereConditions,
$orderBy: [QueryCompaniesDailyStatisticsOrderByOrderByClause!]
) {
companiesDailyStatistics(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
date
companyType
organizationalComponentType
amount
}
}
Variables
{
"where": QueryCompaniesDailyStatisticsWhereWhereConditions,
"orderBy": [
QueryCompaniesDailyStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"companiesDailyStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"companyType": "COMPANY",
"organizationalComponentType": "COMPANY",
"amount": 123
}
]
}
}
companiesGuarantee
Description
Get single guarantee by UUID
Roles:
- ROLE_GUARANTEE_ADMIN
Example
Query
query companiesGuarantee($id: UUID!) {
companiesGuarantee(id: $id) {
id
tenant {
...TenantFragment
}
organizationalComponent {
...OrganizationalComponentFragment
}
user {
...UserFragment
}
guaranteeType
amount {
...MoneyFragment
}
dateInitiated
activeFrom
fromImport
comment
status
pdf {
...FileFragment
}
createdAt
updatedAt
metadata {
...ValueFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"companiesGuarantee": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"organizationalComponent": OrganizationalComponent,
"user": User,
"guaranteeType": "BANK",
"amount": Money,
"dateInitiated": "2007-12-03",
"activeFrom": DateTimeUtc,
"fromImport": true,
"comment": "xyz789",
"status": "PENDING",
"pdf": File,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"metadata": [Value]
}
}
}
companiesGuarantees
Description
List guarantees.
Roles:
- ROLE_GUARANTEE_ADMIN
Response
Returns a GuaranteeConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCompaniesGuaranteesWhereWhereConditions
|
|
orderBy - [QueryCompaniesGuaranteesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query companiesGuarantees(
$where: QueryCompaniesGuaranteesWhereWhereConditions,
$orderBy: [QueryCompaniesGuaranteesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
companiesGuarantees(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...GuaranteeEdgeFragment
}
}
}
Variables
{
"where": QueryCompaniesGuaranteesWhereWhereConditions,
"orderBy": [
QueryCompaniesGuaranteesOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"companiesGuarantees": {
"pageInfo": PageInfo,
"edges": [GuaranteeEdge]
}
}
}
companiesInvoiceableOrganizationalComponents
Description
List organizational components for Invoicing Parent Selection.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns an OrganizationalComponentConnection!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
where - QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions
|
|
orderBy - [QueryCompaniesInvoiceableOrganizationalComponentsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query companiesInvoiceableOrganizationalComponents(
$id: UUID!,
$where: QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions,
$orderBy: [QueryCompaniesInvoiceableOrganizationalComponentsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
companiesInvoiceableOrganizationalComponents(
id: $id,
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...OrganizationalComponentEdgeFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"where": QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions,
"orderBy": [
QueryCompaniesInvoiceableOrganizationalComponentsOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"companiesInvoiceableOrganizationalComponents": {
"pageInfo": PageInfo,
"edges": [OrganizationalComponentEdge]
}
}
}
companiesOrganizationalComponent
Description
Get single organizational component by UUID.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns an OrganizationalComponent
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query companiesOrganizationalComponent($id: UUID!) {
companiesOrganizationalComponent(id: $id) {
id
address {
...AddressFragment
}
invoiceAddress {
...AddressFragment
}
shippingAddresses {
...ShippingAddressFragment
}
chargeTokens {
...ChargeTokenFragment
}
chargeRecordsLatestWeeklyStatistics {
...CompanyWeeklyChargeStatisticsFragment
}
chargeRecordsWeeklyStatistics {
...CompanyWeeklyChargeStatisticsPaginatorFragment
}
chargeRecordsMonthlyStatistics {
...CompanyMonthlyChargeStatisticsPaginatorFragment
}
chargeRecordsYearlyStatistics {
...CompanyYearlyChargeStatisticsPaginatorFragment
}
tenant {
...TenantFragment
}
organizationalComponentType {
...OrganizationalComponentTypeFragment
}
name
email
phoneNumbers {
...ContactPersonPhoneNumberFragment
}
registrationNumber
customerNumber
naceCode
website
country
invoiced
vatNumber
iban
bic
billingPeriod
invoiceVia
paymentMethod
status
purchaseOrderNumber
externalReference
language
invoiceEmail
creditLimit {
...MoneyFragment
}
parent {
...OrganizationalComponentFragment
}
children {
...OrganizationalComponentFragment
}
segment {
...CompanySegmentFragment
}
contactPerson {
...OrganizationalComponentContactPersonFragment
}
creditCheck {
...CreditCheckFragment
}
guarantees {
...GuaranteeFragment
}
paymentTerm
requirements {
...RequirementFragment
}
inCompleteRequirements
contract {
...FileFragment
}
temporaryCreditLimit {
...TemporaryCreditLimitFragment
}
organizationHierarchy
structuredReference {
...StructuredReferenceNumberFragment
}
invoicableCompany {
...OrganizationalComponentFragment
}
invoiceableOrganizationalComponent {
...OrganizationalComponentFragment
}
isCreditCheckPossible
pivot {
...OrganizationalComponentUserPivotFragment
}
companyApproval {
...CompanyApprovalFragment
}
legalForm
tradeName
disabledAt
disabledReason
disabledComment
deletedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
employees {
...UserConnectionFragment
}
activatedAt
cards {
...CardFragment
}
fuelTransactionsLatestWeeklyStatistics {
...CompanyFuelWeeklyTransactionsFragment
}
fuelTransactionsWeeklyStatistics {
...CompanyFuelWeeklyTransactionsFragment
}
fuelTransactionsMonthlyStatistics {
...CompanyFuelMonthlyTransactionsFragment
}
fuelTransactionsYearlyStatistics {
...CompanyFuelYearlyTransactionsFragment
}
identificationNumbers {
...CompanyIdentificationNumberFragment
}
metadata {
...ValueFragment
}
mandate {
...MandateFragment
}
mandates {
...MandateFragment
}
priceModifications {
...PriceModificationFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"companiesOrganizationalComponent": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"chargeTokens": [ChargeToken],
"chargeRecordsLatestWeeklyStatistics": CompanyWeeklyChargeStatistics,
"chargeRecordsWeeklyStatistics": CompanyWeeklyChargeStatisticsPaginator,
"chargeRecordsMonthlyStatistics": CompanyMonthlyChargeStatisticsPaginator,
"chargeRecordsYearlyStatistics": CompanyYearlyChargeStatisticsPaginator,
"tenant": Tenant,
"organizationalComponentType": OrganizationalComponentType,
"name": "abc123",
"email": "xyz789",
"phoneNumbers": [ContactPersonPhoneNumber],
"registrationNumber": "xyz789",
"customerNumber": "abc123",
"naceCode": "abc123",
"website": "xyz789",
"country": "AL",
"invoiced": true,
"vatNumber": "xyz789",
"iban": "xyz789",
"bic": "abc123",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"paymentMethod": "DIRECT_DEBIT",
"status": "INCOMPLETE",
"purchaseOrderNumber": "abc123",
"externalReference": "abc123",
"language": "NL",
"invoiceEmail": ["abc123"],
"creditLimit": Money,
"parent": OrganizationalComponent,
"children": [OrganizationalComponent],
"segment": CompanySegment,
"contactPerson": OrganizationalComponentContactPerson,
"creditCheck": CreditCheck,
"guarantees": [Guarantee],
"paymentTerm": 987,
"requirements": [Requirement],
"inCompleteRequirements": ["CREDIT_CHECK"],
"contract": File,
"temporaryCreditLimit": TemporaryCreditLimit,
"organizationHierarchy": {},
"structuredReference": StructuredReferenceNumber,
"invoicableCompany": OrganizationalComponent,
"invoiceableOrganizationalComponent": OrganizationalComponent,
"isCreditCheckPossible": true,
"pivot": OrganizationalComponentUserPivot,
"companyApproval": CompanyApproval,
"legalForm": "abc123",
"tradeName": "xyz789",
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "abc123",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"employees": UserConnection,
"activatedAt": "2007-12-03T10:15:30Z",
"cards": [Card],
"fuelTransactionsLatestWeeklyStatistics": CompanyFuelWeeklyTransactions,
"fuelTransactionsWeeklyStatistics": [
CompanyFuelWeeklyTransactions
],
"fuelTransactionsMonthlyStatistics": [
CompanyFuelMonthlyTransactions
],
"fuelTransactionsYearlyStatistics": [
CompanyFuelYearlyTransactions
],
"identificationNumbers": [
CompanyIdentificationNumber
],
"metadata": [Value],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification]
}
}
}
companiesOrganizationalComponentTypes
Description
List organizational component types.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Response
Returns [OrganizationalComponentType!]!
Arguments
| Name | Description |
|---|---|
where - QueryCompaniesOrganizationalComponentTypesWhereWhereConditions
|
|
orderBy - [QueryCompaniesOrganizationalComponentTypesOrderByOrderByClause!]
|
Example
Query
query companiesOrganizationalComponentTypes(
$where: QueryCompaniesOrganizationalComponentTypesWhereWhereConditions,
$orderBy: [QueryCompaniesOrganizationalComponentTypesOrderByOrderByClause!]
) {
companiesOrganizationalComponentTypes(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
name
deletedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"where": QueryCompaniesOrganizationalComponentTypesWhereWhereConditions,
"orderBy": [
QueryCompaniesOrganizationalComponentTypesOrderByOrderByClause
]
}
Response
{
"data": {
"companiesOrganizationalComponentTypes": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"name": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
]
}
}
companiesOrganizationalComponents
Description
Return a list of organizational components.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns an OrganizationalComponentConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCompaniesOrganizationalComponentsWhereWhereConditions
|
|
whereHas - QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions
|
|
orderBy - [QueryCompaniesOrganizationalComponentsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query companiesOrganizationalComponents(
$where: QueryCompaniesOrganizationalComponentsWhereWhereConditions,
$whereHas: QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions,
$orderBy: [QueryCompaniesOrganizationalComponentsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
companiesOrganizationalComponents(
where: $where,
whereHas: $whereHas,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...OrganizationalComponentEdgeFragment
}
}
}
Variables
{
"where": QueryCompaniesOrganizationalComponentsWhereWhereConditions,
"whereHas": QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions,
"orderBy": [
QueryCompaniesOrganizationalComponentsOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"companiesOrganizationalComponents": {
"pageInfo": PageInfo,
"edges": [OrganizationalComponentEdge]
}
}
}
companiesSearchByRegistrationNumber
Description
Search company information by registration number.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INVALID_REGISTRATION_NUMBER
- INVALID_COMPANY_DATA
- COMPANY_NOT_FOUND
- INTERNAL_SERVER_ERROR
Response
Returns a SearchCompanyResponse!
Example
Query
query companiesSearchByRegistrationNumber(
$country: Country!,
$registrationNumber: String!
) {
companiesSearchByRegistrationNumber(
country: $country,
registrationNumber: $registrationNumber
) {
country
name
registrationNumber
website
contactPerson {
...SearchCompanyContactPersonFragment
}
address {
...SearchCompanyAddressFragment
}
}
}
Variables
{
"country": "AL",
"registrationNumber": "xyz789"
}
Response
{
"data": {
"companiesSearchByRegistrationNumber": {
"country": "AL",
"name": "abc123",
"registrationNumber": "abc123",
"website": "abc123",
"contactPerson": SearchCompanyContactPerson,
"address": SearchCompanyAddress
}
}
}
companiesSegment
Description
Get single company segment by UUID
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Response
Returns a CompanySegment
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query companiesSegment($id: UUID!) {
companiesSegment(id: $id) {
id
tenant {
...TenantFragment
}
name
description
deletedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
priceModifications {
...PriceModificationFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"companiesSegment": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"name": "abc123",
"description": "abc123",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"priceModifications": [PriceModification]
}
}
}
companiesSegments
Description
List company segments
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Response
Returns a CompanySegmentConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCompaniesSegmentsWhereWhereConditions
|
|
orderBy - [QueryCompaniesSegmentsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query companiesSegments(
$where: QueryCompaniesSegmentsWhereWhereConditions,
$orderBy: [QueryCompaniesSegmentsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
companiesSegments(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanySegmentEdgeFragment
}
}
}
Variables
{
"where": QueryCompaniesSegmentsWhereWhereConditions,
"orderBy": [QueryCompaniesSegmentsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"companiesSegments": {
"pageInfo": PageInfo,
"edges": [CompanySegmentEdge]
}
}
}
companySegment
Use companiesSegment instead
Description
Get single company segment by UUID
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Response
Returns a CompanySegment
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query companySegment($id: UUID!) {
companySegment(id: $id) {
id
tenant {
...TenantFragment
}
name
description
deletedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
priceModifications {
...PriceModificationFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"companySegment": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"name": "xyz789",
"description": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"priceModifications": [PriceModification]
}
}
}
companySegments
Use companiesSegments instead
Description
List company segments
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Response
Returns a CompanySegmentConnection!
Arguments
| Name | Description |
|---|---|
where - QueryCompanySegmentsWhereWhereConditions
|
|
orderBy - [QueryCompanySegmentsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query companySegments(
$where: QueryCompanySegmentsWhereWhereConditions,
$orderBy: [QueryCompanySegmentsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
companySegments(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanySegmentEdgeFragment
}
}
}
Variables
{
"where": QueryCompanySegmentsWhereWhereConditions,
"orderBy": [QueryCompanySegmentsOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"companySegments": {
"pageInfo": PageInfo,
"edges": [CompanySegmentEdge]
}
}
}
compareCardStatisticsAmountDifference
use cardsCompareCardStatisticsAmountDifference instead.
Description
Compare Statistics Amount Difference between two periods
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a CardStatisticsDifference!
Example
Query
query compareCardStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$cardType: CardType!
) {
compareCardStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
cardType: $cardType
) {
total
amount
percentage
}
}
Variables
{
"firstStartDate": "xyz789",
"firstEndDate": "xyz789",
"secondStartDate": "abc123",
"secondEndDate": "abc123",
"cardType": "CHARGE"
}
Response
{
"data": {
"compareCardStatisticsAmountDifference": {
"total": 987,
"amount": 123,
"percentage": 123.45
}
}
}
compareCompanyStatisticsAmountDifference
Use companiesCompareStatisticsAmountDifference instead
Description
Compare Statistics Amount Difference between two periods
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a StatisticsDifference!
Arguments
| Name | Description |
|---|---|
firstStartDate - String!
|
|
firstEndDate - String!
|
|
secondStartDate - String!
|
|
secondEndDate - String!
|
|
companyType - OrganizationalComponentStatisticType
|
Example
Query
query compareCompanyStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$companyType: OrganizationalComponentStatisticType
) {
compareCompanyStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
companyType: $companyType
) {
amount
percentage
}
}
Variables
{
"firstStartDate": "abc123",
"firstEndDate": "xyz789",
"secondStartDate": "xyz789",
"secondEndDate": "xyz789",
"companyType": "COMPANY"
}
Response
{
"data": {
"compareCompanyStatisticsAmountDifference": {
"amount": 123,
"percentage": 987.65
}
}
}
compareStatisticsAmountDifference
Use userCompareStatisticsAmountDifference instead
Description
Compare Statistics Amount Difference between two periods
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a StatisticsDifference!
Example
Query
query compareStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$userType: UserType
) {
compareStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
userType: $userType
) {
amount
percentage
}
}
Variables
{
"firstStartDate": "abc123",
"firstEndDate": "abc123",
"secondStartDate": "xyz789",
"secondEndDate": "xyz789",
"userType": "ANONYMOUS"
}
Response
{
"data": {
"compareStatisticsAmountDifference": {"amount": 987, "percentage": 987.65}
}
}
compareTransactionStatisticsAmountDifference
Use transactionCompareStatisticsAmountDifference instead
Description
Compare Statistics Amount Difference between two periods
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a StatisticsDifference!
Arguments
| Name | Description |
|---|---|
firstStartDate - String!
|
|
firstEndDate - String!
|
|
secondStartDate - String!
|
|
secondEndDate - String!
|
|
transactionType - TransactionType
|
Example
Query
query compareTransactionStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$transactionType: TransactionType
) {
compareTransactionStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
transactionType: $transactionType
) {
amount
percentage
}
}
Variables
{
"firstStartDate": "abc123",
"firstEndDate": "xyz789",
"secondStartDate": "xyz789",
"secondEndDate": "abc123",
"transactionType": "FUEL"
}
Response
{
"data": {
"compareTransactionStatisticsAmountDifference": {
"amount": 987,
"percentage": 987.65
}
}
}
creditCheck
Use companiesCreditCheck instead
Description
Get credit report by inquiry id
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CREDIT_CHECK_NOT_AVAILABLE_FOR_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
Response
Returns a CreditCheck
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query creditCheck($id: UUID!) {
creditCheck(id: $id) {
status
report {
...CreditCheckReportFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"creditCheck": {
"status": "PENDING",
"report": CreditCheckReport
}
}
}
dailyCardStatistic
use cardsDailyCardStatistic instead.
Description
get daily statistics
Response
Returns a DailyCardStatistic
Example
Query
query dailyCardStatistic(
$date: Date,
$type: String
) {
dailyCardStatistic(
date: $date,
type: $type
) {
id
tenant {
...TenantFragment
}
date
type
amount
}
}
Variables
{
"date": "2007-12-03",
"type": "xyz789"
}
Response
{
"data": {
"dailyCardStatistic": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"type": "CHARGE",
"amount": 123
}
}
}
dailyCardStatistics
Response
Returns [DailyCardStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryDailyCardStatisticsWhereWhereConditions
|
|
orderBy - [QueryDailyCardStatisticsOrderByOrderByClause!]
|
Example
Query
query dailyCardStatistics(
$where: QueryDailyCardStatisticsWhereWhereConditions,
$orderBy: [QueryDailyCardStatisticsOrderByOrderByClause!]
) {
dailyCardStatistics(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
date
type
amount
}
}
Variables
{
"where": QueryDailyCardStatisticsWhereWhereConditions,
"orderBy": [
QueryDailyCardStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"dailyCardStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"type": "CHARGE",
"amount": 123
}
]
}
}
dailyCompanyStatistics
Use companiesDailyStatistics instead
Description
Retrieve daily company statistics
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns [DailyStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryDailyCompanyStatisticsWhereWhereConditions
|
|
orderBy - [QueryDailyCompanyStatisticsOrderByOrderByClause!]
|
Example
Query
query dailyCompanyStatistics(
$where: QueryDailyCompanyStatisticsWhereWhereConditions,
$orderBy: [QueryDailyCompanyStatisticsOrderByOrderByClause!]
) {
dailyCompanyStatistics(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
date
companyType
organizationalComponentType
amount
}
}
Variables
{
"where": QueryDailyCompanyStatisticsWhereWhereConditions,
"orderBy": [
QueryDailyCompanyStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"dailyCompanyStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"companyType": "COMPANY",
"organizationalComponentType": "COMPANY",
"amount": 123
}
]
}
}
dailyTransactionStatistic
Use transactionDailyTransactionStatistic instead
Description
Retrieve daily transactions statistic by date, type and tenantId
Roles:
- ROLE_TRANSACTION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a DailyTransactionStatistic
Arguments
| Name | Description |
|---|---|
date - Date
|
|
transactionType - TransactionType
|
|
tenantId - String
|
Example
Query
query dailyTransactionStatistic(
$date: Date,
$transactionType: TransactionType,
$tenantId: String
) {
dailyTransactionStatistic(
date: $date,
transactionType: $transactionType,
tenantId: $tenantId
) {
id
company {
...OrganizationalComponentFragment
}
tenant {
...TenantFragment
}
date
transactionType
amount
}
}
Variables
{
"date": "2007-12-03",
"transactionType": "FUEL",
"tenantId": "abc123"
}
Response
{
"data": {
"dailyTransactionStatistic": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"tenant": Tenant,
"date": "2007-12-03",
"transactionType": "FUEL",
"amount": 123
}
}
}
dailyTransactionStatistics
Use transactionDailyTransactionStatistics instead
Description
Retrieve daily transactions statistics
Roles:
- ROLE_TRANSACTION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns [DailyTransactionStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryDailyTransactionStatisticsWhereWhereConditions
|
|
orderBy - [QueryDailyTransactionStatisticsOrderByOrderByClause!]
|
Example
Query
query dailyTransactionStatistics(
$where: QueryDailyTransactionStatisticsWhereWhereConditions,
$orderBy: [QueryDailyTransactionStatisticsOrderByOrderByClause!]
) {
dailyTransactionStatistics(
where: $where,
orderBy: $orderBy
) {
id
company {
...OrganizationalComponentFragment
}
tenant {
...TenantFragment
}
date
transactionType
amount
}
}
Variables
{
"where": QueryDailyTransactionStatisticsWhereWhereConditions,
"orderBy": [
QueryDailyTransactionStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"dailyTransactionStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"tenant": Tenant,
"date": "2007-12-03",
"transactionType": "FUEL",
"amount": 123
}
]
}
}
dailyUserStatistic
Use userDailyStatistic instead
Description
Retrieve daily user statistics by date and type
Response
Returns a DailyUserStatistic
Example
Query
query dailyUserStatistic(
$date: Date,
$userType: UserType
) {
dailyUserStatistic(
date: $date,
userType: $userType
) {
id
tenant {
...TenantFragment
}
date
userType
amount
}
}
Variables
{
"date": "2007-12-03",
"userType": "ANONYMOUS"
}
Response
{
"data": {
"dailyUserStatistic": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"userType": "ANONYMOUS",
"amount": 123
}
}
}
dailyUserStatistics
Use userDailyStatistics instead
Description
Retrieve list of daily user statistics
Response
Returns [DailyUserStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryDailyUserStatisticsWhereWhereConditions
|
|
orderBy - [QueryDailyUserStatisticsOrderByOrderByClause!]
|
Example
Query
query dailyUserStatistics(
$where: QueryDailyUserStatisticsWhereWhereConditions,
$orderBy: [QueryDailyUserStatisticsOrderByOrderByClause!]
) {
dailyUserStatistics(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
date
userType
amount
}
}
Variables
{
"where": QueryDailyUserStatisticsWhereWhereConditions,
"orderBy": [
QueryDailyUserStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"dailyUserStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"userType": "ANONYMOUS",
"amount": 123
}
]
}
}
entities
use metadataEntities instead.
Description
List all entities
Response
Returns [EntityType!]!
Example
Query
query entities {
entities
}
Response
{"data": {"entities": ["ORGANIZATIONAL_COMPONENT"]}}
expenseReport
Description
Find a single expense report by an identifying attribute.
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Response
Returns an ExpenseReport
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query expenseReport($id: UUID!) {
expenseReport(id: $id) {
id
expenseReportNumber
tenantId
company {
...OrganizationalComponentFragment
}
quantity
taxRate
totalPrice {
...MoneyFragment
}
subTotal {
...MoneyFragment
}
totalTax {
...MoneyFragment
}
redemptionAmount {
...MoneyFragment
}
status
reportingPeriodEndDate
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"expenseReport": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"expenseReportNumber": "abc123",
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"quantity": 123.45,
"taxRate": 987.65,
"totalPrice": Money,
"subTotal": Money,
"totalTax": Money,
"redemptionAmount": Money,
"status": "OPEN",
"reportingPeriodEndDate": "2007-12-03",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
expenseReports
Description
List all expense reports.
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Response
Returns an ExpenseReportConnection!
Arguments
| Name | Description |
|---|---|
where - QueryExpenseReportsWhereWhereConditions
|
|
orderBy - [QueryExpenseReportsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query expenseReports(
$where: QueryExpenseReportsWhereWhereConditions,
$orderBy: [QueryExpenseReportsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
expenseReports(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ExpenseReportEdgeFragment
}
}
}
Variables
{
"where": QueryExpenseReportsWhereWhereConditions,
"orderBy": [QueryExpenseReportsOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"expenseReports": {
"pageInfo": PageInfo,
"edges": [ExpenseReportEdge]
}
}
}
export
Use invoicesExport instead
Description
Invoice Export by identifying attribute.
Roles:
- ROLE_INVOICE_ADMIN
Example
Query
query export($id: UUID!) {
export(id: $id) {
id
name
description
fileType
config {
...ExportConfigFragment
}
status
category
downloadUrl {
...FileFragment
}
records
fields
renames {
...FieldRenameFragment
}
filters {
...FilterFragment
}
createdBy {
...UserFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"export": {
"id": "4",
"name": "abc123",
"description": "xyz789",
"fileType": "CSV",
"config": ExportConfig,
"status": "PENDING",
"category": "INVOICES",
"downloadUrl": File,
"records": 987,
"fields": ["abc123"],
"renames": [FieldRename],
"filters": [Filter],
"createdBy": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
exports
Use invoicesExports instead
Description
List all invoice exports
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns an ExportConnection!
Arguments
| Name | Description |
|---|---|
where - QueryExportsWhereWhereConditions
|
|
whereHas - QueryExportsWhereHasWhereHasConditions
|
|
orderBy - [QueryExportsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query exports(
$where: QueryExportsWhereWhereConditions,
$whereHas: QueryExportsWhereHasWhereHasConditions,
$orderBy: [QueryExportsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
exports(
where: $where,
whereHas: $whereHas,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ExportEdgeFragment
}
}
}
Variables
{
"where": QueryExportsWhereWhereConditions,
"whereHas": QueryExportsWhereHasWhereHasConditions,
"orderBy": [QueryExportsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"exports": {
"pageInfo": PageInfo,
"edges": [ExportEdge]
}
}
}
field
use metadataField instead.
Description
Get single field by id
Roles:
- ROLE_FIELD_ADMIN
- ROLE_METADATA_ADMIN
Example
Query
query field($id: UUID) {
field(id: $id) {
id
tenant {
...TenantFragment
}
entityType
name
label
disabledAt
deletedAt
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"field": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"entityType": "ORGANIZATIONAL_COMPONENT",
"name": "xyz789",
"label": "xyz789",
"disabledAt": DateTimeUtc,
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
fields
use metadataFields instead.
Description
List all fields
Roles:
- ROLE_FIELD_ADMIN
- ROLE_METADATA_ADMIN
Response
Returns [Field!]!
Arguments
| Name | Description |
|---|---|
orderBy - [QueryFieldsOrderByOrderByClause!]
|
|
entity_type - EntityType
|
Filters by id. Accepts SQL LIKE wildcards % and _. |
Example
Query
query fields(
$orderBy: [QueryFieldsOrderByOrderByClause!],
$entity_type: EntityType
) {
fields(
orderBy: $orderBy,
entity_type: $entity_type
) {
id
tenant {
...TenantFragment
}
entityType
name
label
disabledAt
deletedAt
createdAt
updatedAt
}
}
Variables
{
"orderBy": [QueryFieldsOrderByOrderByClause],
"entity_type": "ORGANIZATIONAL_COMPONENT"
}
Response
{
"data": {
"fields": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"entityType": "ORGANIZATIONAL_COMPONENT",
"name": "abc123",
"label": "abc123",
"disabledAt": DateTimeUtc,
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
]
}
}
fuelCard
Description
Find a single fuel card by an identifying attribute.
Roles:
- ROLE_FUEL_CARD_ADMIN
Example
Query
query fuelCard($id: UUID) {
fuelCard(id: $id) {
id
provider
limit {
...LimitFragment
}
locations {
...FuelLocationFragment
}
transactions {
...FuelTransactionFragment
}
cardNumber
pan
company {
...OrganizationalComponentFragment
}
user {
...UserFragment
}
vehicle {
...VehicleFragment
}
card {
...CardFragment
}
disabledAt
expiryYear
expiryMonth
notes
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"fuelCard": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"provider": "LODDER",
"limit": Limit,
"locations": [FuelLocation],
"transactions": [FuelTransaction],
"cardNumber": "abc123",
"pan": "abc123",
"company": OrganizationalComponent,
"user": User,
"vehicle": Vehicle,
"card": Card,
"disabledAt": DateTimeUtc,
"expiryYear": 987,
"expiryMonth": 987,
"notes": ["abc123"],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
}
}
fuelCards
Description
List multiple fuel cards.
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Returns a FuelCardConnection!
Arguments
| Name | Description |
|---|---|
where - QueryFuelCardsWhereWhereConditions
|
|
orderBy - [QueryFuelCardsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query fuelCards(
$where: QueryFuelCardsWhereWhereConditions,
$orderBy: [QueryFuelCardsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
fuelCards(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...FuelCardEdgeFragment
}
}
}
Variables
{
"where": QueryFuelCardsWhereWhereConditions,
"orderBy": [QueryFuelCardsOrderByOrderByClause],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"fuelCards": {
"pageInfo": PageInfo,
"edges": [FuelCardEdge]
}
}
}
fuelCardsOrganizationalComponentMonthlyTransactionStatistics
Description
List fuel card Monthly transactions
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Arguments
| Name | Description |
|---|---|
where - QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions
|
|
orderBy - [QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query fuelCardsOrganizationalComponentMonthlyTransactionStatistics(
$where: QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions,
$orderBy: [QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
fuelCardsOrganizationalComponentMonthlyTransactionStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyFuelMonthlyTransactionsEdgeFragment
}
}
}
Variables
{
"where": QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions,
"orderBy": [
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"fuelCardsOrganizationalComponentMonthlyTransactionStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyFuelMonthlyTransactionsEdge]
}
}
}
fuelCardsOrganizationalComponentWeeklyTransactionStatistics
Description
List fuel card weekly transactions
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Returns a CompanyFuelWeeklyTransactionsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions
|
|
orderBy - [QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query fuelCardsOrganizationalComponentWeeklyTransactionStatistics(
$where: QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions,
$orderBy: [QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
fuelCardsOrganizationalComponentWeeklyTransactionStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyFuelWeeklyTransactionsEdgeFragment
}
}
}
Variables
{
"where": QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions,
"orderBy": [
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsOrderByOrderByClause
],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"fuelCardsOrganizationalComponentWeeklyTransactionStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyFuelWeeklyTransactionsEdge]
}
}
}
fuelCardsOrganizationalComponentYearlyTransactionStatistics
Description
List fuel card yearly transactions
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Returns a CompanyFuelYearlyTransactionsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions
|
|
orderBy - [QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query fuelCardsOrganizationalComponentYearlyTransactionStatistics(
$where: QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions,
$orderBy: [QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
fuelCardsOrganizationalComponentYearlyTransactionStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyFuelYearlyTransactionsEdgeFragment
}
}
}
Variables
{
"where": QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions,
"orderBy": [
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"fuelCardsOrganizationalComponentYearlyTransactionStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyFuelYearlyTransactionsEdge]
}
}
}
gasStation
use gasStationsGetStation instead.
Description
Find a single gas station by an identifying attribute.
Response
Returns a GasStation
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query gasStation($id: UUID) {
gasStation(id: $id) {
id
hub {
...HubFragment
}
brand {
...BrandFragment
}
address {
...AddressFragment
}
name
location
url
isManned
serviceIds {
...ServiceIdsFragment
}
deactivatedAt
fuelTanks {
...FuelTankFragment
}
alerts {
...AlertFragment
}
openingHours {
...OpeningHourFragment
}
paymentMethods {
...TerminalPaymentMethodFragment
}
products {
...ProductFragment
}
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"gasStation": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"hub": Hub,
"brand": Brand,
"address": Address,
"name": "abc123",
"location": "abc123",
"url": "xyz789",
"isManned": false,
"serviceIds": ServiceIds,
"deactivatedAt": DateTimeUtc,
"fuelTanks": [FuelTank],
"alerts": [Alert],
"openingHours": [OpeningHour],
"paymentMethods": [TerminalPaymentMethod],
"products": [Product],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
}
}
gasStations
use gasStationsGetStations instead.
Description
List multiple gas stations.
Response
Returns a GasStationConnection!
Arguments
| Name | Description |
|---|---|
where - QueryGasStationsWhereWhereConditions
|
|
whereProducts - QueryGasStationsWhereProductsWhereHasConditions
|
|
orderBy - [QueryGasStationsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query gasStations(
$where: QueryGasStationsWhereWhereConditions,
$whereProducts: QueryGasStationsWhereProductsWhereHasConditions,
$orderBy: [QueryGasStationsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
gasStations(
where: $where,
whereProducts: $whereProducts,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...GasStationEdgeFragment
}
}
}
Variables
{
"where": QueryGasStationsWhereWhereConditions,
"whereProducts": QueryGasStationsWhereProductsWhereHasConditions,
"orderBy": [QueryGasStationsOrderByOrderByClause],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"gasStations": {
"pageInfo": PageInfo,
"edges": [GasStationEdge]
}
}
}
gasStationsGetStation
Description
Find a single gas station by an identifying attribute.
Response
Returns a GasStation
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query gasStationsGetStation($id: UUID) {
gasStationsGetStation(id: $id) {
id
hub {
...HubFragment
}
brand {
...BrandFragment
}
address {
...AddressFragment
}
name
location
url
isManned
serviceIds {
...ServiceIdsFragment
}
deactivatedAt
fuelTanks {
...FuelTankFragment
}
alerts {
...AlertFragment
}
openingHours {
...OpeningHourFragment
}
paymentMethods {
...TerminalPaymentMethodFragment
}
products {
...ProductFragment
}
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"gasStationsGetStation": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"hub": Hub,
"brand": Brand,
"address": Address,
"name": "abc123",
"location": "abc123",
"url": "abc123",
"isManned": true,
"serviceIds": ServiceIds,
"deactivatedAt": DateTimeUtc,
"fuelTanks": [FuelTank],
"alerts": [Alert],
"openingHours": [OpeningHour],
"paymentMethods": [TerminalPaymentMethod],
"products": [Product],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
}
}
gasStationsGetStations
Description
List multiple gas stations.
Response
Returns a GasStationConnection!
Arguments
| Name | Description |
|---|---|
where - QueryGasStationsGetStationsWhereWhereConditions
|
|
whereProducts - QueryGasStationsGetStationsWhereProductsWhereHasConditions
|
|
orderBy - [QueryGasStationsGetStationsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query gasStationsGetStations(
$where: QueryGasStationsGetStationsWhereWhereConditions,
$whereProducts: QueryGasStationsGetStationsWhereProductsWhereHasConditions,
$orderBy: [QueryGasStationsGetStationsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
gasStationsGetStations(
where: $where,
whereProducts: $whereProducts,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...GasStationEdgeFragment
}
}
}
Variables
{
"where": QueryGasStationsGetStationsWhereWhereConditions,
"whereProducts": QueryGasStationsGetStationsWhereProductsWhereHasConditions,
"orderBy": [
QueryGasStationsGetStationsOrderByOrderByClause
],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"gasStationsGetStations": {
"pageInfo": PageInfo,
"edges": [GasStationEdge]
}
}
}
getOnboardingLinkForTenant
Use
paymentsGetOnboardingLinkForTenant instead. Description
Get onboarding link for tenant
getParkingCost
Response
Returns [ParkingCosts]
Arguments
| Name | Description |
|---|---|
input - getParkingCostInput!
|
Look for cost based on location, startTime and endTime |
Example
Query
query getParkingCost($input: getParkingCostInput!) {
getParkingCost(input: $input) {
areaManagerId
areaId
calculatedAmount
calculatedVAT
specifCalcAmountList {
...ParkingSpecificAmountListFragment
}
}
}
Variables
{"input": getParkingCostInput}
Response
{
"data": {
"getParkingCost": [
{
"areaManagerId": 987,
"areaId": "abc123",
"calculatedAmount": "abc123",
"calculatedVAT": "abc123",
"specifCalcAmountList": [
ParkingSpecificAmountList
]
}
]
}
}
getParkingFareInfo
Response
Returns [ParkingFareInfo]
Arguments
| Name | Description |
|---|---|
input - getParkingFareInfoInput!
|
Look for FareInfo based on location, startTime and endTime |
Example
Query
query getParkingFareInfo($input: getParkingFareInfoInput!) {
getParkingFareInfo(input: $input) {
maxDuration
startTime
endTime
day
fares {
...FareFragment
}
}
}
Variables
{"input": getParkingFareInfoInput}
Response
{
"data": {
"getParkingFareInfo": [
{
"maxDuration": 987,
"startTime": 123,
"endTime": 123,
"day": "xyz789",
"fares": [Fare]
}
]
}
}
guarantee
Use companiesGuarantee instead
Description
Get single guarantee by UUID
Roles:
- ROLE_GUARANTEE_ADMIN
Example
Query
query guarantee($id: UUID!) {
guarantee(id: $id) {
id
tenant {
...TenantFragment
}
organizationalComponent {
...OrganizationalComponentFragment
}
user {
...UserFragment
}
guaranteeType
amount {
...MoneyFragment
}
dateInitiated
activeFrom
fromImport
comment
status
pdf {
...FileFragment
}
createdAt
updatedAt
metadata {
...ValueFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"guarantee": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"organizationalComponent": OrganizationalComponent,
"user": User,
"guaranteeType": "BANK",
"amount": Money,
"dateInitiated": "2007-12-03",
"activeFrom": DateTimeUtc,
"fromImport": false,
"comment": "xyz789",
"status": "PENDING",
"pdf": File,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"metadata": [Value]
}
}
}
guarantees
Use companiesGuarantees instead
Description
List guarantees.
Roles:
- ROLE_GUARANTEE_ADMIN
Response
Returns a GuaranteeConnection!
Arguments
| Name | Description |
|---|---|
where - QueryGuaranteesWhereWhereConditions
|
|
orderBy - [QueryGuaranteesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query guarantees(
$where: QueryGuaranteesWhereWhereConditions,
$orderBy: [QueryGuaranteesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
guarantees(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...GuaranteeEdgeFragment
}
}
}
Variables
{
"where": QueryGuaranteesWhereWhereConditions,
"orderBy": [QueryGuaranteesOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"guarantees": {
"pageInfo": PageInfo,
"edges": [GuaranteeEdge]
}
}
}
hub
Description
Find a single hub by an identifying attribute.
Example
Query
query hub($id: UUID) {
hub(id: $id) {
id
tenant {
...TenantFragment
}
gasStations {
...GasStationFragment
}
name
facilities {
... on Shop {
...ShopFragment
}
... on Wash {
...WashFragment
}
... on GasStation {
...GasStationFragment
}
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"hub": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"gasStations": [GasStation],
"name": "xyz789",
"facilities": [Shop]
}
}
}
hubs
Description
List multiple hubs.
Response
Returns a HubConnection!
Example
Query
query hubs(
$name: String,
$first: Int!,
$after: String
) {
hubs(
name: $name,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...HubEdgeFragment
}
}
}
Variables
{
"name": "xyz789",
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"hubs": {
"pageInfo": PageInfo,
"edges": [HubEdge]
}
}
}
invoice
Description
Find a single invoice by an identifying attribute.
Roles:
- ROLE_INVOICE_ADMIN
Example
Query
query invoice($id: UUID!) {
invoice(id: $id) {
id
invoiceNumber
parent {
...InvoiceFragment
}
child {
...InvoiceFragment
}
address {
...AddressDetailsFragment
}
user {
...InvoiceOwnerFragment
}
company {
...InvoiceOwnerFragment
}
invoiceableCompanyId
invoiceableCompany {
...OrganizationalComponentFragment
}
totalTax {
...MoneyFragment
}
vatBreakdown {
...VatBreakdownFragment
}
subTotal {
...MoneyFragment
}
totalPrice {
...MoneyFragment
}
effectiveDiscount {
...MoneyFragment
}
effectiveMargin {
...MoneyFragment
}
status
notes
creditedBy {
...UserFragment
}
invoiceRows {
...InvoiceRowFragment
}
transactionBlocks {
...TransactionBlockFragment
}
tenant {
...TenantDetailsFragment
}
mandate {
...MandateFragment
}
invoiceCategory
invoiceType
dueDate
paymentDate
invoiceDate
paymentMethod
paymentCollectionDate
statementPeriod {
...StatementPeriodFragment
}
pdf
language
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"invoice": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"invoiceNumber": "abc123",
"parent": Invoice,
"child": Invoice,
"address": AddressDetails,
"user": InvoiceOwner,
"company": InvoiceOwner,
"invoiceableCompanyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"invoiceableCompany": OrganizationalComponent,
"totalTax": Money,
"vatBreakdown": [VatBreakdown],
"subTotal": Money,
"totalPrice": Money,
"effectiveDiscount": Money,
"effectiveMargin": Money,
"status": "CONCEPT",
"notes": "abc123",
"creditedBy": User,
"invoiceRows": [InvoiceRow],
"transactionBlocks": [TransactionBlock],
"tenant": TenantDetails,
"mandate": Mandate,
"invoiceCategory": "SETTLEMENT",
"invoiceType": "B2B_INVOICE",
"dueDate": DateTimeUtc,
"paymentDate": DateTimeUtc,
"invoiceDate": DateTimeUtc,
"paymentMethod": "DIRECT_DEBIT",
"paymentCollectionDate": DateTimeUtc,
"statementPeriod": StatementPeriod,
"pdf": "abc123",
"language": "NL",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
invoiceMonthlyStatistic
Description
Get single monthly statistic for invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns a TenantInvoiceMonthlyStatistic
Arguments
| Name | Description |
|---|---|
where - QueryInvoiceMonthlyStatisticWhereWhereConditions
|
Example
Query
query invoiceMonthlyStatistic($where: QueryInvoiceMonthlyStatisticWhereWhereConditions) {
invoiceMonthlyStatistic(where: $where) {
id
tenant {
...TenantDetailsFragment
}
month
year
status
amountOfInvoices
totalAmountWithTax {
...MoneyFragment
}
totalAmountWithoutTax {
...MoneyFragment
}
createdAt
updatedAt
}
}
Variables
{
"where": QueryInvoiceMonthlyStatisticWhereWhereConditions
}
Response
{
"data": {
"invoiceMonthlyStatistic": {
"id": 123,
"tenant": TenantDetails,
"month": 987,
"year": 987,
"status": "CONCEPT",
"amountOfInvoices": 987,
"totalAmountWithTax": Money,
"totalAmountWithoutTax": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
invoiceMonthlyStatistics
Description
List all monthly statistics for invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns a TenantInvoiceMonthlyStatisticConnection!
Arguments
| Name | Description |
|---|---|
where - QueryInvoiceMonthlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryInvoiceMonthlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query invoiceMonthlyStatistics(
$where: QueryInvoiceMonthlyStatisticsWhereWhereConditions,
$orderBy: [QueryInvoiceMonthlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
invoiceMonthlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TenantInvoiceMonthlyStatisticEdgeFragment
}
}
}
Variables
{
"where": QueryInvoiceMonthlyStatisticsWhereWhereConditions,
"orderBy": [
QueryInvoiceMonthlyStatisticsOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"invoiceMonthlyStatistics": {
"pageInfo": PageInfo,
"edges": [TenantInvoiceMonthlyStatisticEdge]
}
}
}
invoiceQuarterlyStatistic
Description
Get single quarterly statistic for invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns a TenantInvoiceQuarterlyStatistic
Arguments
| Name | Description |
|---|---|
where - QueryInvoiceQuarterlyStatisticWhereWhereConditions
|
Example
Query
query invoiceQuarterlyStatistic($where: QueryInvoiceQuarterlyStatisticWhereWhereConditions) {
invoiceQuarterlyStatistic(where: $where) {
id
tenant {
...TenantDetailsFragment
}
quarter
year
status
amountOfInvoices
totalAmountWithTax {
...MoneyFragment
}
totalAmountWithoutTax {
...MoneyFragment
}
createdAt
updatedAt
}
}
Variables
{
"where": QueryInvoiceQuarterlyStatisticWhereWhereConditions
}
Response
{
"data": {
"invoiceQuarterlyStatistic": {
"id": 123,
"tenant": TenantDetails,
"quarter": 123,
"year": 123,
"status": "CONCEPT",
"amountOfInvoices": 123,
"totalAmountWithTax": Money,
"totalAmountWithoutTax": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
invoiceQuarterlyStatistics
Description
List all quarterly statistic for invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Arguments
| Name | Description |
|---|---|
where - QueryInvoiceQuarterlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryInvoiceQuarterlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query invoiceQuarterlyStatistics(
$where: QueryInvoiceQuarterlyStatisticsWhereWhereConditions,
$orderBy: [QueryInvoiceQuarterlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
invoiceQuarterlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TenantInvoiceQuarterlyStatisticEdgeFragment
}
}
}
Variables
{
"where": QueryInvoiceQuarterlyStatisticsWhereWhereConditions,
"orderBy": [
QueryInvoiceQuarterlyStatisticsOrderByOrderByClause
],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"invoiceQuarterlyStatistics": {
"pageInfo": PageInfo,
"edges": [TenantInvoiceQuarterlyStatisticEdge]
}
}
}
invoiceYearlyStatistic
Description
Get single quarterly statistic for invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns a TenantInvoiceYearlyStatistic
Arguments
| Name | Description |
|---|---|
where - QueryInvoiceYearlyStatisticWhereWhereConditions
|
Example
Query
query invoiceYearlyStatistic($where: QueryInvoiceYearlyStatisticWhereWhereConditions) {
invoiceYearlyStatistic(where: $where) {
id
tenant {
...TenantDetailsFragment
}
year
status
amountOfInvoices
totalAmountWithTax {
...MoneyFragment
}
totalAmountWithoutTax {
...MoneyFragment
}
createdAt
updatedAt
}
}
Variables
{"where": QueryInvoiceYearlyStatisticWhereWhereConditions}
Response
{
"data": {
"invoiceYearlyStatistic": {
"id": 987,
"tenant": TenantDetails,
"year": 123,
"status": "CONCEPT",
"amountOfInvoices": 987,
"totalAmountWithTax": Money,
"totalAmountWithoutTax": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
invoiceYearlyStatistics
Description
List all yearly statistic for invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns a TenantInvoiceYearlyStatisticConnection!
Arguments
| Name | Description |
|---|---|
where - QueryInvoiceYearlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryInvoiceYearlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query invoiceYearlyStatistics(
$where: QueryInvoiceYearlyStatisticsWhereWhereConditions,
$orderBy: [QueryInvoiceYearlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
invoiceYearlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TenantInvoiceYearlyStatisticEdgeFragment
}
}
}
Variables
{
"where": QueryInvoiceYearlyStatisticsWhereWhereConditions,
"orderBy": [
QueryInvoiceYearlyStatisticsOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"invoiceYearlyStatistics": {
"pageInfo": PageInfo,
"edges": [TenantInvoiceYearlyStatisticEdge]
}
}
}
invoiceableCompanies
Use companiesInvoiceableOrganizationalComponents instead
Description
List organizational components for Invoicing Parent Selection.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns an OrganizationalComponentConnection!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
where - QueryInvoiceableCompaniesWhereWhereConditions
|
|
orderBy - [QueryInvoiceableCompaniesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query invoiceableCompanies(
$id: UUID!,
$where: QueryInvoiceableCompaniesWhereWhereConditions,
$orderBy: [QueryInvoiceableCompaniesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
invoiceableCompanies(
id: $id,
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...OrganizationalComponentEdgeFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"where": QueryInvoiceableCompaniesWhereWhereConditions,
"orderBy": [
QueryInvoiceableCompaniesOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"invoiceableCompanies": {
"pageInfo": PageInfo,
"edges": [OrganizationalComponentEdge]
}
}
}
invoices
Description
List all invoices.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns an InvoiceConnection!
Arguments
| Name | Description |
|---|---|
status - InvoiceStatusEnum
|
|
where - QueryInvoicesWhereWhereConditions
|
|
whereJson - InvoiceViaInput
|
|
orderBy - [QueryInvoicesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query invoices(
$status: InvoiceStatusEnum,
$where: QueryInvoicesWhereWhereConditions,
$whereJson: InvoiceViaInput,
$orderBy: [QueryInvoicesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
invoices(
status: $status,
where: $where,
whereJson: $whereJson,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...InvoiceEdgeFragment
}
}
}
Variables
{
"status": "CONCEPT",
"where": QueryInvoicesWhereWhereConditions,
"whereJson": InvoiceViaInput,
"orderBy": [QueryInvoicesOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"invoices": {
"pageInfo": PageInfo,
"edges": [InvoiceEdge]
}
}
}
invoicesExport
Description
Invoice Export by identifying attribute.
Roles:
- ROLE_INVOICE_ADMIN
Example
Query
query invoicesExport($id: UUID!) {
invoicesExport(id: $id) {
id
name
description
fileType
config {
...ExportConfigFragment
}
status
category
downloadUrl {
...FileFragment
}
records
fields
renames {
...FieldRenameFragment
}
filters {
...FilterFragment
}
createdBy {
...UserFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"invoicesExport": {
"id": 4,
"name": "xyz789",
"description": "xyz789",
"fileType": "CSV",
"config": ExportConfig,
"status": "PENDING",
"category": "INVOICES",
"downloadUrl": File,
"records": 123,
"fields": ["xyz789"],
"renames": [FieldRename],
"filters": [Filter],
"createdBy": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
invoicesExports
Description
List all invoice exports
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns an ExportConnection!
Arguments
| Name | Description |
|---|---|
where - QueryInvoicesExportsWhereWhereConditions
|
|
whereHas - QueryInvoicesExportsWhereHasWhereHasConditions
|
|
orderBy - [QueryInvoicesExportsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query invoicesExports(
$where: QueryInvoicesExportsWhereWhereConditions,
$whereHas: QueryInvoicesExportsWhereHasWhereHasConditions,
$orderBy: [QueryInvoicesExportsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
invoicesExports(
where: $where,
whereHas: $whereHas,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ExportEdgeFragment
}
}
}
Variables
{
"where": QueryInvoicesExportsWhereWhereConditions,
"whereHas": QueryInvoicesExportsWhereHasWhereHasConditions,
"orderBy": [QueryInvoicesExportsOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"invoicesExports": {
"pageInfo": PageInfo,
"edges": [ExportEdge]
}
}
}
invoicesOpenTransactionsForOrganizationalComponent
Description
List all open transactions for organizational component.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns [OpenTransactions]
Arguments
| Name | Description |
|---|---|
organizationalComponentId - UUID!
|
Example
Query
query invoicesOpenTransactionsForOrganizationalComponent($organizationalComponentId: UUID!) {
invoicesOpenTransactionsForOrganizationalComponent(organizationalComponentId: $organizationalComponentId) {
productType
totalPrice {
...MoneyFragment
}
}
}
Variables
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"invoicesOpenTransactionsForOrganizationalComponent": [
{
"productType": "xyz789",
"totalPrice": Money
}
]
}
}
kilometreCharge
use kilometreChargingGetCharge instead.
Description
Get Kilometre Charge by identifier.
Roles:
- ROLE_KILOMETRE_CHARGE_ADMIN
Response
Returns a KilometreCharge
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query kilometreCharge($id: UUID) {
kilometreCharge(id: $id) {
id
user {
...UserFragment
}
company {
...OrganizationalComponentFragment
}
tenant {
...TenantFragment
}
transactionId
amount {
...MoneyFragment
}
externalReference
provider
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"kilometreCharge": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"user": User,
"company": OrganizationalComponent,
"tenant": Tenant,
"transactionId": "xyz789",
"amount": Money,
"externalReference": "abc123",
"provider": "SATELLIC",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
kilometreCharges
use kilometreChargingGetCharges instead.
Description
List multiple kilometre charges.
Roles:
- ROLE_KILOMETRE_CHARGE_ADMIN
Response
Returns a KilometreChargeConnection!
Arguments
| Name | Description |
|---|---|
where - QueryKilometreChargesWhereWhereConditions
|
|
orderBy - [QueryKilometreChargesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query kilometreCharges(
$where: QueryKilometreChargesWhereWhereConditions,
$orderBy: [QueryKilometreChargesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
kilometreCharges(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...KilometreChargeEdgeFragment
}
}
}
Variables
{
"where": QueryKilometreChargesWhereWhereConditions,
"orderBy": [QueryKilometreChargesOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"kilometreCharges": {
"pageInfo": PageInfo,
"edges": [KilometreChargeEdge]
}
}
}
kilometreChargingGetCharge
Description
Get Kilometre Charge by identifier.
Roles:
- ROLE_KILOMETRE_CHARGE_ADMIN
Response
Returns a KilometreCharge
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query kilometreChargingGetCharge($id: UUID) {
kilometreChargingGetCharge(id: $id) {
id
user {
...UserFragment
}
company {
...OrganizationalComponentFragment
}
tenant {
...TenantFragment
}
transactionId
amount {
...MoneyFragment
}
externalReference
provider
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"kilometreChargingGetCharge": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"user": User,
"company": OrganizationalComponent,
"tenant": Tenant,
"transactionId": "abc123",
"amount": Money,
"externalReference": "abc123",
"provider": "SATELLIC",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
kilometreChargingGetCharges
Description
List multiple kilometre charges.
Roles:
- ROLE_KILOMETRE_CHARGE_ADMIN
Response
Returns a KilometreChargeConnection!
Arguments
| Name | Description |
|---|---|
where - QueryKilometreChargingGetChargesWhereWhereConditions
|
|
orderBy - [QueryKilometreChargingGetChargesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query kilometreChargingGetCharges(
$where: QueryKilometreChargingGetChargesWhereWhereConditions,
$orderBy: [QueryKilometreChargingGetChargesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
kilometreChargingGetCharges(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...KilometreChargeEdgeFragment
}
}
}
Variables
{
"where": QueryKilometreChargingGetChargesWhereWhereConditions,
"orderBy": [
QueryKilometreChargingGetChargesOrderByOrderByClause
],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"kilometreChargingGetCharges": {
"pageInfo": PageInfo,
"edges": [KilometreChargeEdge]
}
}
}
mandate
Use
paymentsMandate instead. Description
Get single mandate by id
Example
Query
query mandate($id: UUID) {
mandate(id: $id) {
id
metadata {
...ValueFragment
}
tenant {
...TenantFragment
}
user {
...UserFragment
}
company {
...OrganizationalComponentFragment
}
debtorSignDate
debtorMandate
paymentMethod
mandateEmail
pdf
status
origin
mandateCode
mandateType
mandateTemplate {
...MandateTemplateFragment
}
activeFrom
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"mandate": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"metadata": [Value],
"tenant": Tenant,
"user": User,
"company": OrganizationalComponent,
"debtorSignDate": DateTimeUtc,
"debtorMandate": "xyz789",
"paymentMethod": "DIRECT_DEBIT",
"mandateEmail": "abc123",
"pdf": "abc123",
"status": "PENDING",
"origin": "IMPORT",
"mandateCode": "xyz789",
"mandateType": "B2B",
"mandateTemplate": MandateTemplate,
"activeFrom": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
mandateTemplates
Use
paymentsMandateTemplates instead. Description
Get all mandate templates
Response
Returns a MandateTemplateConnection!
Arguments
| Name | Description |
|---|---|
where - QueryMandateTemplatesWhereWhereConditions
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query mandateTemplates(
$where: QueryMandateTemplatesWhereWhereConditions,
$first: Int!,
$after: String
) {
mandateTemplates(
where: $where,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MandateTemplateEdgeFragment
}
}
}
Variables
{
"where": QueryMandateTemplatesWhereWhereConditions,
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"mandateTemplates": {
"pageInfo": PageInfo,
"edges": [MandateTemplateEdge]
}
}
}
mandates
Use
paymentsMandates instead. Description
List all mandates
Response
Returns a MandateConnection!
Arguments
| Name | Description |
|---|---|
where - QueryMandatesWhereWhereConditions
|
|
orderBy - [QueryMandatesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query mandates(
$where: QueryMandatesWhereWhereConditions,
$orderBy: [QueryMandatesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
mandates(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MandateEdgeFragment
}
}
}
Variables
{
"where": QueryMandatesWhereWhereConditions,
"orderBy": [QueryMandatesOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"mandates": {
"pageInfo": PageInfo,
"edges": [MandateEdge]
}
}
}
me
Use userDailyStatistics instead
Description
Retrieve current logged in user
Response
Returns a User
Example
Query
query me {
me {
id
address {
...AddressFragment
}
invoiceAddress {
...AddressFragment
}
shippingAddresses {
...ShippingAddressFragment
}
emailVerifiedAt
twoFactorConfirmedAt
cards {
...CardFragment
}
favoriteChargeLocations {
...ChargeLocationFragment
}
pivot {
...OrganizationalComponentUserPivotFragment
}
organizationalComponents {
...OrganizationalComponentConnectionFragment
}
metadata {
...ValueFragment
}
favoriteParkingLocations {
...ParkingLocationFragment
}
mandate {
...MandateFragment
}
mandates {
...MandateFragment
}
priceModifications {
...PriceModificationFragment
}
roles {
...RoleFragment
}
tenant {
...TenantFragment
}
firstName
lastName
email
customerNumber
dateOfBirth
gender
company {
...CompanyFragment
}
locale
iban
bic
vatNumber
paymentMethod
billingPeriod
invoiceVia
invoiceEmail
paymentTerm
structuredReference {
...StructuredReferenceNumberFragment
}
externalReference
phoneNumbers {
...UserPhoneNumberFragment
}
termsOfAgreementAcceptedAt
termsAndConditionsApproval {
...UserTermsAndConditionsApprovalFragment
}
guarantees {
...GuaranteeFragment
}
deletedAt
disabledAt
disabledReason
disabledComment
deactivatedAt
createdAt
updatedAt
companies {
...CompanyConnectionFragment
}
}
}
Response
{
"data": {
"me": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"emailVerifiedAt": DateTimeUtc,
"twoFactorConfirmedAt": DateTimeUtc,
"cards": [Card],
"favoriteChargeLocations": [ChargeLocation],
"pivot": OrganizationalComponentUserPivot,
"organizationalComponents": OrganizationalComponentConnection,
"metadata": [Value],
"favoriteParkingLocations": [ParkingLocation],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification],
"roles": [Role],
"tenant": Tenant,
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789",
"customerNumber": "xyz789",
"dateOfBirth": "2007-12-03",
"gender": "MALE",
"company": Company,
"locale": "NL",
"iban": "abc123",
"bic": "xyz789",
"vatNumber": "xyz789",
"paymentMethod": "DIRECT_DEBIT",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"invoiceEmail": ["xyz789"],
"paymentTerm": 123,
"structuredReference": StructuredReferenceNumber,
"externalReference": "abc123",
"phoneNumbers": [UserPhoneNumber],
"termsOfAgreementAcceptedAt": DateTimeUtc,
"termsAndConditionsApproval": UserTermsAndConditionsApproval,
"guarantees": [Guarantee],
"deletedAt": DateTimeUtc,
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "abc123",
"deactivatedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"companies": CompanyConnection
}
}
}
metadata
Description
List all metadata
Roles:
- ROLE_METADATA_ADMIN
Response
Returns a MetadataConnection!
Arguments
| Name | Description |
|---|---|
where - QueryMetadataWhereWhereConditions
|
|
orderBy - [QueryMetadataOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query metadata(
$where: QueryMetadataWhereWhereConditions,
$orderBy: [QueryMetadataOrderByOrderByClause!],
$first: Int!,
$after: String
) {
metadata(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MetadataEdgeFragment
}
}
}
Variables
{
"where": QueryMetadataWhereWhereConditions,
"orderBy": [QueryMetadataOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"metadata": {
"pageInfo": PageInfo,
"edges": [MetadataEdge]
}
}
}
metadataEntities
Description
List all entities
Response
Returns [EntityType!]!
Example
Query
query metadataEntities {
metadataEntities
}
Response
{"data": {"metadataEntities": ["ORGANIZATIONAL_COMPONENT"]}}
metadataField
Description
Get single field by id
Roles:
- ROLE_FIELD_ADMIN
- ROLE_METADATA_ADMIN
Example
Query
query metadataField($id: UUID) {
metadataField(id: $id) {
id
tenant {
...TenantFragment
}
entityType
name
label
disabledAt
deletedAt
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"metadataField": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"entityType": "ORGANIZATIONAL_COMPONENT",
"name": "xyz789",
"label": "abc123",
"disabledAt": DateTimeUtc,
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
metadataFields
Description
List all fields
Roles:
- ROLE_FIELD_ADMIN
- ROLE_METADATA_ADMIN
Response
Returns [Field!]!
Arguments
| Name | Description |
|---|---|
orderBy - [QueryMetadataFieldsOrderByOrderByClause!]
|
|
entity_type - EntityType
|
Filters by id. Accepts SQL LIKE wildcards % and _. |
Example
Query
query metadataFields(
$orderBy: [QueryMetadataFieldsOrderByOrderByClause!],
$entity_type: EntityType
) {
metadataFields(
orderBy: $orderBy,
entity_type: $entity_type
) {
id
tenant {
...TenantFragment
}
entityType
name
label
disabledAt
deletedAt
createdAt
updatedAt
}
}
Variables
{
"orderBy": [QueryMetadataFieldsOrderByOrderByClause],
"entity_type": "ORGANIZATIONAL_COMPONENT"
}
Response
{
"data": {
"metadataFields": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"entityType": "ORGANIZATIONAL_COMPONENT",
"name": "abc123",
"label": "xyz789",
"disabledAt": DateTimeUtc,
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
]
}
}
metadataGetMetadata
Description
List all metadata
Roles:
- ROLE_METADATA_ADMIN
Response
Returns a MetadataConnection!
Arguments
| Name | Description |
|---|---|
where - QueryMetadataGetMetadataWhereWhereConditions
|
|
orderBy - [QueryMetadataGetMetadataOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query metadataGetMetadata(
$where: QueryMetadataGetMetadataWhereWhereConditions,
$orderBy: [QueryMetadataGetMetadataOrderByOrderByClause!],
$first: Int!,
$after: String
) {
metadataGetMetadata(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MetadataEdgeFragment
}
}
}
Variables
{
"where": QueryMetadataGetMetadataWhereWhereConditions,
"orderBy": [
QueryMetadataGetMetadataOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"metadataGetMetadata": {
"pageInfo": PageInfo,
"edges": [MetadataEdge]
}
}
}
openTransactionsForOrganizationalComponent
Use invoicesOpenTransactionsForOrganizationalComponent instead
Description
List all open transactions for organizational component.
Roles:
- ROLE_INVOICE_ADMIN
Response
Returns [OpenTransactions]
Arguments
| Name | Description |
|---|---|
organizationalComponentId - UUID!
|
Example
Query
query openTransactionsForOrganizationalComponent($organizationalComponentId: UUID!) {
openTransactionsForOrganizationalComponent(organizationalComponentId: $organizationalComponentId) {
productType
totalPrice {
...MoneyFragment
}
}
}
Variables
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"openTransactionsForOrganizationalComponent": [
{
"productType": "abc123",
"totalPrice": Money
}
]
}
}
order
use OrdersGetOrder instead.
Description
Find single order by Identifying attribute
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Example
Query
query order($id: UUID!) {
order(id: $id) {
id
orderNumber
address {
...OrderShippingAddressFragment
}
company {
...OrganizationalComponentFragment
}
user {
...UserFragment
}
status
comments {
...OrderCommentFragment
}
products {
...OrderProductFragment
}
productsCount
createdAt
updatedAt
lastOpenedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
lastOpenedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"order": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"orderNumber": 123,
"address": OrderShippingAddress,
"company": OrganizationalComponent,
"user": User,
"status": "DRAFT",
"comments": [OrderComment],
"products": [OrderProduct],
"productsCount": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"lastOpenedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"lastOpenedBy": User
}
}
}
orderProduct
use OrdersGetOrders instead.
Description
Find single product by Identifying attribute
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Response
Returns an OrderProduct!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Search by primary key |
Example
Query
query orderProduct($id: UUID!) {
orderProduct(id: $id) {
id
address {
...OrderShippingAddressFragment
}
order {
...OrderFragment
}
details {
... on CardProduct {
...CardProductFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"orderProduct": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": OrderShippingAddress,
"order": Order,
"details": CardProduct,
"createdBy": User,
"updatedBy": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
orders
use OrdersGetOrders instead.
Description
List of all orders
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Response
Returns an OrderConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrdersWhereWhereConditions
|
|
orderBy - [QueryOrdersOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query orders(
$where: QueryOrdersWhereWhereConditions,
$orderBy: [QueryOrdersOrderByOrderByClause!],
$first: Int!,
$after: String
) {
orders(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...OrderEdgeFragment
}
}
}
Variables
{
"where": QueryOrdersWhereWhereConditions,
"orderBy": [QueryOrdersOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"orders": {
"pageInfo": PageInfo,
"edges": [OrderEdge]
}
}
}
ordersGetOrder
Description
Find single order by Identifying attribute
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Example
Query
query ordersGetOrder($id: UUID!) {
ordersGetOrder(id: $id) {
id
orderNumber
address {
...OrderShippingAddressFragment
}
company {
...OrganizationalComponentFragment
}
user {
...UserFragment
}
status
comments {
...OrderCommentFragment
}
products {
...OrderProductFragment
}
productsCount
createdAt
updatedAt
lastOpenedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
lastOpenedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"ordersGetOrder": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"orderNumber": 987,
"address": OrderShippingAddress,
"company": OrganizationalComponent,
"user": User,
"status": "DRAFT",
"comments": [OrderComment],
"products": [OrderProduct],
"productsCount": 987,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"lastOpenedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"lastOpenedBy": User
}
}
}
ordersGetOrderProduct
Description
Find single product by Identifying attribute
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Response
Returns an OrderProduct!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Search by primary key |
Example
Query
query ordersGetOrderProduct($id: UUID!) {
ordersGetOrderProduct(id: $id) {
id
address {
...OrderShippingAddressFragment
}
order {
...OrderFragment
}
details {
... on CardProduct {
...CardProductFragment
}
}
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"ordersGetOrderProduct": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": OrderShippingAddress,
"order": Order,
"details": CardProduct,
"createdBy": User,
"updatedBy": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
ordersGetOrders
Description
List of all orders
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Response
Returns an OrderConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrdersGetOrdersWhereWhereConditions
|
|
orderBy - [QueryOrdersGetOrdersOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query ordersGetOrders(
$where: QueryOrdersGetOrdersWhereWhereConditions,
$orderBy: [QueryOrdersGetOrdersOrderByOrderByClause!],
$first: Int!,
$after: String
) {
ordersGetOrders(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...OrderEdgeFragment
}
}
}
Variables
{
"where": QueryOrdersGetOrdersWhereWhereConditions,
"orderBy": [QueryOrdersGetOrdersOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"ordersGetOrders": {
"pageInfo": PageInfo,
"edges": [OrderEdge]
}
}
}
organizationalComponent
Use companiesOrganizationalComponent instead
Description
Get single organizational component by UUID.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns an OrganizationalComponent
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query organizationalComponent($id: UUID!) {
organizationalComponent(id: $id) {
id
address {
...AddressFragment
}
invoiceAddress {
...AddressFragment
}
shippingAddresses {
...ShippingAddressFragment
}
chargeTokens {
...ChargeTokenFragment
}
chargeRecordsLatestWeeklyStatistics {
...CompanyWeeklyChargeStatisticsFragment
}
chargeRecordsWeeklyStatistics {
...CompanyWeeklyChargeStatisticsPaginatorFragment
}
chargeRecordsMonthlyStatistics {
...CompanyMonthlyChargeStatisticsPaginatorFragment
}
chargeRecordsYearlyStatistics {
...CompanyYearlyChargeStatisticsPaginatorFragment
}
tenant {
...TenantFragment
}
organizationalComponentType {
...OrganizationalComponentTypeFragment
}
name
email
phoneNumbers {
...ContactPersonPhoneNumberFragment
}
registrationNumber
customerNumber
naceCode
website
country
invoiced
vatNumber
iban
bic
billingPeriod
invoiceVia
paymentMethod
status
purchaseOrderNumber
externalReference
language
invoiceEmail
creditLimit {
...MoneyFragment
}
parent {
...OrganizationalComponentFragment
}
children {
...OrganizationalComponentFragment
}
segment {
...CompanySegmentFragment
}
contactPerson {
...OrganizationalComponentContactPersonFragment
}
creditCheck {
...CreditCheckFragment
}
guarantees {
...GuaranteeFragment
}
paymentTerm
requirements {
...RequirementFragment
}
inCompleteRequirements
contract {
...FileFragment
}
temporaryCreditLimit {
...TemporaryCreditLimitFragment
}
organizationHierarchy
structuredReference {
...StructuredReferenceNumberFragment
}
invoicableCompany {
...OrganizationalComponentFragment
}
invoiceableOrganizationalComponent {
...OrganizationalComponentFragment
}
isCreditCheckPossible
pivot {
...OrganizationalComponentUserPivotFragment
}
companyApproval {
...CompanyApprovalFragment
}
legalForm
tradeName
disabledAt
disabledReason
disabledComment
deletedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
employees {
...UserConnectionFragment
}
activatedAt
cards {
...CardFragment
}
fuelTransactionsLatestWeeklyStatistics {
...CompanyFuelWeeklyTransactionsFragment
}
fuelTransactionsWeeklyStatistics {
...CompanyFuelWeeklyTransactionsFragment
}
fuelTransactionsMonthlyStatistics {
...CompanyFuelMonthlyTransactionsFragment
}
fuelTransactionsYearlyStatistics {
...CompanyFuelYearlyTransactionsFragment
}
identificationNumbers {
...CompanyIdentificationNumberFragment
}
metadata {
...ValueFragment
}
mandate {
...MandateFragment
}
mandates {
...MandateFragment
}
priceModifications {
...PriceModificationFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"organizationalComponent": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"chargeTokens": [ChargeToken],
"chargeRecordsLatestWeeklyStatistics": CompanyWeeklyChargeStatistics,
"chargeRecordsWeeklyStatistics": CompanyWeeklyChargeStatisticsPaginator,
"chargeRecordsMonthlyStatistics": CompanyMonthlyChargeStatisticsPaginator,
"chargeRecordsYearlyStatistics": CompanyYearlyChargeStatisticsPaginator,
"tenant": Tenant,
"organizationalComponentType": OrganizationalComponentType,
"name": "xyz789",
"email": "abc123",
"phoneNumbers": [ContactPersonPhoneNumber],
"registrationNumber": "xyz789",
"customerNumber": "xyz789",
"naceCode": "abc123",
"website": "abc123",
"country": "AL",
"invoiced": false,
"vatNumber": "abc123",
"iban": "xyz789",
"bic": "abc123",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"paymentMethod": "DIRECT_DEBIT",
"status": "INCOMPLETE",
"purchaseOrderNumber": "xyz789",
"externalReference": "abc123",
"language": "NL",
"invoiceEmail": ["abc123"],
"creditLimit": Money,
"parent": OrganizationalComponent,
"children": [OrganizationalComponent],
"segment": CompanySegment,
"contactPerson": OrganizationalComponentContactPerson,
"creditCheck": CreditCheck,
"guarantees": [Guarantee],
"paymentTerm": 987,
"requirements": [Requirement],
"inCompleteRequirements": ["CREDIT_CHECK"],
"contract": File,
"temporaryCreditLimit": TemporaryCreditLimit,
"organizationHierarchy": {},
"structuredReference": StructuredReferenceNumber,
"invoicableCompany": OrganizationalComponent,
"invoiceableOrganizationalComponent": OrganizationalComponent,
"isCreditCheckPossible": false,
"pivot": OrganizationalComponentUserPivot,
"companyApproval": CompanyApproval,
"legalForm": "abc123",
"tradeName": "abc123",
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"employees": UserConnection,
"activatedAt": "2007-12-03T10:15:30Z",
"cards": [Card],
"fuelTransactionsLatestWeeklyStatistics": CompanyFuelWeeklyTransactions,
"fuelTransactionsWeeklyStatistics": [
CompanyFuelWeeklyTransactions
],
"fuelTransactionsMonthlyStatistics": [
CompanyFuelMonthlyTransactions
],
"fuelTransactionsYearlyStatistics": [
CompanyFuelYearlyTransactions
],
"identificationNumbers": [
CompanyIdentificationNumber
],
"metadata": [Value],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification]
}
}
}
organizationalComponentChargeRecordsMonthlyStatistics
Use ChargeRecordsMonthlyOrganizationalComponentStatistics instead
Description
Retrieve monthly statistics of charge records per company.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentChargeRecordsMonthlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponentChargeRecordsMonthlyStatistics(
$where: QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentChargeRecordsMonthlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponentChargeRecordsMonthlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyMonthlyChargeStatisticsEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"organizationalComponentChargeRecordsMonthlyStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyMonthlyChargeStatisticsEdge]
}
}
}
organizationalComponentChargeRecordsWeeklyStatistics
Use chargeRecordsWeeklyOrganizationalComponentStatistics instead
Description
Retrieve weekly statistics of charge records per company.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns a CompanyWeeklyChargeStatisticsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentChargeRecordsWeeklyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponentChargeRecordsWeeklyStatistics(
$where: QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentChargeRecordsWeeklyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponentChargeRecordsWeeklyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyWeeklyChargeStatisticsEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"organizationalComponentChargeRecordsWeeklyStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyWeeklyChargeStatisticsEdge]
}
}
}
organizationalComponentChargeRecordsYearlyStatistics
Use ChargeRecordsYearlyOrganizationalComponentStatistics instead
Description
Retrieve yearly statistics of charge records per company.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Response
Returns a CompanyYearlyChargeStatisticsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentChargeRecordsYearlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponentChargeRecordsYearlyStatistics(
$where: QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentChargeRecordsYearlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponentChargeRecordsYearlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyYearlyChargeStatisticsEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentChargeRecordsYearlyStatisticsOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"organizationalComponentChargeRecordsYearlyStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyYearlyChargeStatisticsEdge]
}
}
}
organizationalComponentFuelTransactionsMonthlyStatistics
Use fuelCardsOrganizationalComponentMonthlyTransactionStatistics instead
Description
List fuel card Monthly transactions
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponentFuelTransactionsMonthlyStatistics(
$where: QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponentFuelTransactionsMonthlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyFuelMonthlyTransactionsEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsOrderByOrderByClause
],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"organizationalComponentFuelTransactionsMonthlyStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyFuelMonthlyTransactionsEdge]
}
}
}
organizationalComponentFuelTransactionsWeeklyStatistics
Use fuelCardsOrganizationalComponentWeeklyTransactionStatistics instead
Description
List fuel card weekly transactions
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Returns a CompanyFuelWeeklyTransactionsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponentFuelTransactionsWeeklyStatistics(
$where: QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponentFuelTransactionsWeeklyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyFuelWeeklyTransactionsEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsOrderByOrderByClause
],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"organizationalComponentFuelTransactionsWeeklyStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyFuelWeeklyTransactionsEdge]
}
}
}
organizationalComponentFuelTransactionsYearlyStatistics
Use fuelCardsOrganizationalComponentYearlyTransactionStatistics instead
Description
List fuel card yearly transactions
Roles:
- ROLE_FUEL_CARD_ADMIN
Response
Returns a CompanyFuelYearlyTransactionsConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentFuelTransactionsYearlyStatisticsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponentFuelTransactionsYearlyStatistics(
$where: QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentFuelTransactionsYearlyStatisticsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponentFuelTransactionsYearlyStatistics(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...CompanyFuelYearlyTransactionsEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsOrderByOrderByClause
],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"organizationalComponentFuelTransactionsYearlyStatistics": {
"pageInfo": PageInfo,
"edges": [CompanyFuelYearlyTransactionsEdge]
}
}
}
organizationalComponentTypes
Use companiesOrganizationalComponentTypes instead
Description
List organizational component types.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Response
Returns [OrganizationalComponentType!]!
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentTypesWhereWhereConditions
|
|
orderBy - [QueryOrganizationalComponentTypesOrderByOrderByClause!]
|
Example
Query
query organizationalComponentTypes(
$where: QueryOrganizationalComponentTypesWhereWhereConditions,
$orderBy: [QueryOrganizationalComponentTypesOrderByOrderByClause!]
) {
organizationalComponentTypes(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
name
deletedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentTypesWhereWhereConditions,
"orderBy": [
QueryOrganizationalComponentTypesOrderByOrderByClause
]
}
Response
{
"data": {
"organizationalComponentTypes": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"name": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
]
}
}
organizationalComponents
Use companiesOrganizationalComponents instead
Description
Return a list of organizational components.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Response
Returns an OrganizationalComponentConnection!
Arguments
| Name | Description |
|---|---|
where - QueryOrganizationalComponentsWhereWhereConditions
|
|
whereHas - QueryOrganizationalComponentsWhereHasWhereHasConditions
|
|
orderBy - [QueryOrganizationalComponentsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query organizationalComponents(
$where: QueryOrganizationalComponentsWhereWhereConditions,
$whereHas: QueryOrganizationalComponentsWhereHasWhereHasConditions,
$orderBy: [QueryOrganizationalComponentsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
organizationalComponents(
where: $where,
whereHas: $whereHas,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...OrganizationalComponentEdgeFragment
}
}
}
Variables
{
"where": QueryOrganizationalComponentsWhereWhereConditions,
"whereHas": QueryOrganizationalComponentsWhereHasWhereHasConditions,
"orderBy": [
QueryOrganizationalComponentsOrderByOrderByClause
],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"organizationalComponents": {
"pageInfo": PageInfo,
"edges": [OrganizationalComponentEdge]
}
}
}
package
Use
productsPackage instead. Description
Get single package by id.
Roles:
- ROLE_PACKAGE_ADMIN
Response
Returns a ProductPackage
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query package($id: UUID) {
package(id: $id) {
id
tenant {
...TenantFragment
}
products {
...ProductFragment
}
name
description
price {
...MoneyFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"package": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"products": [Product],
"name": "xyz789",
"description": "xyz789",
"price": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
packages
Use
productsPackages instead. Description
List all packages.
Roles:
- ROLE_PACKAGE_ADMIN
Response
Returns a ProductPackageConnection!
Arguments
| Name | Description |
|---|---|
name - String
|
|
orderBy - [QueryPackagesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query packages(
$name: String,
$orderBy: [QueryPackagesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
packages(
name: $name,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ProductPackageEdgeFragment
}
}
}
Variables
{
"name": "xyz789",
"orderBy": [QueryPackagesOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"packages": {
"pageInfo": PageInfo,
"edges": [ProductPackageEdge]
}
}
}
parkingLocation
Description
Get parking location by id.
Response
Returns a ParkingLocation!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Search by parking location uid. |
Example
Query
query parkingLocation($id: UUID!) {
parkingLocation(id: $id) {
id
externalId
name
description
parkingEnabled
address {
...ParkingAddressFragment
}
provider {
...ParkingProviderFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"parkingLocation": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"name": "xyz789",
"description": "xyz789",
"parkingEnabled": false,
"address": ParkingAddress,
"provider": ParkingProvider
}
}
}
parkingLocations
Description
List of parking locations.
Response
Returns a ParkingLocationConnection!
Arguments
| Name | Description |
|---|---|
name - String
|
Filters by name. Accepts SQL LIKE wildcards % and _. |
description - String
|
Filters by description. Accepts SQL LIKE wildcards % and _. |
where - QueryParkingLocationsWhereWhereConditions
|
|
whereHas - QueryParkingLocationsWhereHasWhereHasConditions
|
|
orderBy - [QueryParkingLocationsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query parkingLocations(
$name: String,
$description: String,
$where: QueryParkingLocationsWhereWhereConditions,
$whereHas: QueryParkingLocationsWhereHasWhereHasConditions,
$orderBy: [QueryParkingLocationsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
parkingLocations(
name: $name,
description: $description,
where: $where,
whereHas: $whereHas,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ParkingLocationEdgeFragment
}
}
}
Variables
{
"name": "xyz789",
"description": "abc123",
"where": QueryParkingLocationsWhereWhereConditions,
"whereHas": QueryParkingLocationsWhereHasWhereHasConditions,
"orderBy": [QueryParkingLocationsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"parkingLocations": {
"pageInfo": PageInfo,
"edges": [ParkingLocationEdge]
}
}
}
parkingSession
Description
Find a single parking session.
Response
Returns a ParkingSession!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Search by parking session uid. |
Example
Query
query parkingSession($id: UUID!) {
parkingSession(id: $id) {
id
location {
...ParkingLocationFragment
}
vehicle {
...VehicleFragment
}
user {
...UserFragment
}
tenant {
...TenantFragment
}
cost {
...MoneyFragment
}
vat
startedAt
endedAt
cancelledAt
createdAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"parkingSession": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"location": ParkingLocation,
"vehicle": Vehicle,
"user": User,
"tenant": Tenant,
"cost": Money,
"vat": 123.45,
"startedAt": DateTimeUtc,
"endedAt": DateTimeUtc,
"cancelledAt": DateTimeUtc,
"createdAt": DateTimeUtc
}
}
}
parkingSessions
Response
Returns a ParkingSessionConnection!
Arguments
| Name | Description |
|---|---|
where - QueryParkingSessionsWhereWhereConditions
|
|
orderBy - [QueryParkingSessionsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query parkingSessions(
$where: QueryParkingSessionsWhereWhereConditions,
$orderBy: [QueryParkingSessionsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
parkingSessions(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ParkingSessionEdgeFragment
}
}
}
Variables
{
"where": QueryParkingSessionsWhereWhereConditions,
"orderBy": [QueryParkingSessionsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"parkingSessions": {
"pageInfo": PageInfo,
"edges": [ParkingSessionEdge]
}
}
}
paymentsGetOnboardingLinkForTenant
Description
Get onboarding link for tenant
Example
Query
query paymentsGetOnboardingLinkForTenant($id: UUID!) {
paymentsGetOnboardingLinkForTenant(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"paymentsGetOnboardingLinkForTenant": "abc123"
}
}
paymentsMandate
Description
Get single mandate by id
Example
Query
query paymentsMandate($id: UUID) {
paymentsMandate(id: $id) {
id
metadata {
...ValueFragment
}
tenant {
...TenantFragment
}
user {
...UserFragment
}
company {
...OrganizationalComponentFragment
}
debtorSignDate
debtorMandate
paymentMethod
mandateEmail
pdf
status
origin
mandateCode
mandateType
mandateTemplate {
...MandateTemplateFragment
}
activeFrom
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"paymentsMandate": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"metadata": [Value],
"tenant": Tenant,
"user": User,
"company": OrganizationalComponent,
"debtorSignDate": DateTimeUtc,
"debtorMandate": "xyz789",
"paymentMethod": "DIRECT_DEBIT",
"mandateEmail": "xyz789",
"pdf": "abc123",
"status": "PENDING",
"origin": "IMPORT",
"mandateCode": "xyz789",
"mandateType": "B2B",
"mandateTemplate": MandateTemplate,
"activeFrom": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
paymentsMandateTemplates
Description
Get all mandate templates
Response
Returns a MandateTemplateConnection!
Arguments
| Name | Description |
|---|---|
where - QueryPaymentsMandateTemplatesWhereWhereConditions
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query paymentsMandateTemplates(
$where: QueryPaymentsMandateTemplatesWhereWhereConditions,
$first: Int!,
$after: String
) {
paymentsMandateTemplates(
where: $where,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MandateTemplateEdgeFragment
}
}
}
Variables
{
"where": QueryPaymentsMandateTemplatesWhereWhereConditions,
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"paymentsMandateTemplates": {
"pageInfo": PageInfo,
"edges": [MandateTemplateEdge]
}
}
}
paymentsMandates
Description
List all mandates
Response
Returns a MandateConnection!
Arguments
| Name | Description |
|---|---|
where - QueryPaymentsMandatesWhereWhereConditions
|
|
orderBy - [QueryPaymentsMandatesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query paymentsMandates(
$where: QueryPaymentsMandatesWhereWhereConditions,
$orderBy: [QueryPaymentsMandatesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
paymentsMandates(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...MandateEdgeFragment
}
}
}
Variables
{
"where": QueryPaymentsMandatesWhereWhereConditions,
"orderBy": [QueryPaymentsMandatesOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"paymentsMandates": {
"pageInfo": PageInfo,
"edges": [MandateEdge]
}
}
}
paymentsSepaFile
Description
Get single sepa file by id
Example
Query
query paymentsSepaFile($id: UUID) {
paymentsSepaFile(id: $id) {
id
name
url
status
invoiceCount
createdAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"paymentsSepaFile": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"url": "xyz789",
"status": "abc123",
"invoiceCount": 123,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
paymentsSepaFiles
Description
List all sepa files
Response
Returns a SepaConnection!
Arguments
| Name | Description |
|---|---|
where - QueryPaymentsSepaFilesWhereWhereConditions
|
|
orderBy - [QueryPaymentsSepaFilesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query paymentsSepaFiles(
$where: QueryPaymentsSepaFilesWhereWhereConditions,
$orderBy: [QueryPaymentsSepaFilesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
paymentsSepaFiles(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...SepaEdgeFragment
}
}
}
Variables
{
"where": QueryPaymentsSepaFilesWhereWhereConditions,
"orderBy": [QueryPaymentsSepaFilesOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"paymentsSepaFiles": {
"pageInfo": PageInfo,
"edges": [SepaEdge]
}
}
}
priceModification
Description
Find a single price modification by an identifying attribute
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Response
Returns a PriceModification
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query priceModification($id: UUID!) {
priceModification(id: $id) {
id
conditions {
...ConditionFragment
}
tenant {
...TenantFragment
}
description
promoCode
associations {
...PriceModificationAssociationFragment
}
type
adjustmentType
scope
inverse
volumePriceModificationPeriod
isVolumePriceModificationEnabled
products {
...PriceModificationPerProductFragment
}
externalReference
startDate
endDate
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"priceModification": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"conditions": [Condition],
"tenant": Tenant,
"description": "abc123",
"promoCode": "xyz789",
"associations": [PriceModificationAssociation],
"type": "SELLING",
"adjustmentType": "MARGIN",
"scope": "PER_UNIT",
"inverse": false,
"volumePriceModificationPeriod": "MONTHLY",
"isVolumePriceModificationEnabled": false,
"products": [PriceModificationPerProduct],
"externalReference": "xyz789",
"startDate": DateTimeUtc,
"endDate": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
priceModifications
Description
List all price modifications
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Response
Returns a PriceModificationConnection!
Arguments
| Name | Description |
|---|---|
where - QueryPriceModificationsWhereWhereConditions
|
|
orderBy - [QueryPriceModificationsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query priceModifications(
$where: QueryPriceModificationsWhereWhereConditions,
$orderBy: [QueryPriceModificationsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
priceModifications(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...PriceModificationEdgeFragment
}
}
}
Variables
{
"where": QueryPriceModificationsWhereWhereConditions,
"orderBy": [
QueryPriceModificationsOrderByOrderByClause
],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"priceModifications": {
"pageInfo": PageInfo,
"edges": [PriceModificationEdge]
}
}
}
product
Use
productsGetProduct instead. Description
Get single product by id.
Response
Returns a Product
Example
Query
query product(
$id: UUID,
$trashed: Trashed
) {
product(
id: $id,
trashed: $trashed
) {
id
type
label
createdAt
updatedAt
provider
transactions {
...FuelTransactionFragment
}
gasStations {
...GasStationFragment
}
price {
...MoneyFragment
}
categories {
...ProductCategoryFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"trashed": "ONLY"
}
Response
{
"data": {
"product": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "abc123",
"label": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"provider": "LODDER",
"transactions": [FuelTransaction],
"gasStations": [GasStation],
"price": Money,
"categories": [ProductCategory]
}
}
}
products
Use
productsGetProducts instead. Description
List all products.
Response
Returns a ProductConnection!
Arguments
| Name | Description |
|---|---|
label - String
|
Filters by id. Accepts SQL LIKE wildcards % and _. |
orderBy - [QueryProductsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
trashed - Trashed
|
Allows to filter if trashed elements should be fetched. |
Example
Query
query products(
$label: String,
$orderBy: [QueryProductsOrderByOrderByClause!],
$first: Int!,
$after: String,
$trashed: Trashed
) {
products(
label: $label,
orderBy: $orderBy,
first: $first,
after: $after,
trashed: $trashed
) {
pageInfo {
...PageInfoFragment
}
edges {
...ProductEdgeFragment
}
}
}
Variables
{
"label": "abc123",
"orderBy": [QueryProductsOrderByOrderByClause],
"first": 123,
"after": "abc123",
"trashed": "ONLY"
}
Response
{
"data": {
"products": {
"pageInfo": PageInfo,
"edges": [ProductEdge]
}
}
}
productsCategories
Description
List all categories.
Response
Returns a ProductCategoryConnection!
Arguments
| Name | Description |
|---|---|
label - String
|
Filters by id. Accepts SQL LIKE wildcards % and _. |
orderBy - [QueryProductsCategoriesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query productsCategories(
$label: String,
$orderBy: [QueryProductsCategoriesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
productsCategories(
label: $label,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ProductCategoryEdgeFragment
}
}
}
Variables
{
"label": "xyz789",
"orderBy": [
QueryProductsCategoriesOrderByOrderByClause
],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"productsCategories": {
"pageInfo": PageInfo,
"edges": [ProductCategoryEdge]
}
}
}
productsCategory
Description
Get single category by id.
Response
Returns a ProductCategory
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query productsCategory($id: UUID) {
productsCategory(id: $id) {
id
label
products {
...ProductFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"productsCategory": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"label": "xyz789",
"products": [Product],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
productsGetProduct
Description
Get single product by id.
Response
Returns a Product
Example
Query
query productsGetProduct(
$id: UUID,
$trashed: Trashed
) {
productsGetProduct(
id: $id,
trashed: $trashed
) {
id
type
label
createdAt
updatedAt
provider
transactions {
...FuelTransactionFragment
}
gasStations {
...GasStationFragment
}
price {
...MoneyFragment
}
categories {
...ProductCategoryFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"trashed": "ONLY"
}
Response
{
"data": {
"productsGetProduct": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "xyz789",
"label": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"provider": "LODDER",
"transactions": [FuelTransaction],
"gasStations": [GasStation],
"price": Money,
"categories": [ProductCategory]
}
}
}
productsGetProducts
Description
List all products.
Response
Returns a ProductConnection!
Arguments
| Name | Description |
|---|---|
label - String
|
Filters by id. Accepts SQL LIKE wildcards % and _. |
orderBy - [QueryProductsGetProductsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
trashed - Trashed
|
Allows to filter if trashed elements should be fetched. |
Example
Query
query productsGetProducts(
$label: String,
$orderBy: [QueryProductsGetProductsOrderByOrderByClause!],
$first: Int!,
$after: String,
$trashed: Trashed
) {
productsGetProducts(
label: $label,
orderBy: $orderBy,
first: $first,
after: $after,
trashed: $trashed
) {
pageInfo {
...PageInfoFragment
}
edges {
...ProductEdgeFragment
}
}
}
Variables
{
"label": "xyz789",
"orderBy": [
QueryProductsGetProductsOrderByOrderByClause
],
"first": 987,
"after": "xyz789",
"trashed": "ONLY"
}
Response
{
"data": {
"productsGetProducts": {
"pageInfo": PageInfo,
"edges": [ProductEdge]
}
}
}
productsPackage
Description
Get single package by id.
Roles:
- ROLE_PACKAGE_ADMIN
Response
Returns a ProductPackage
Arguments
| Name | Description |
|---|---|
id - UUID
|
Search by primary key. |
Example
Query
query productsPackage($id: UUID) {
productsPackage(id: $id) {
id
tenant {
...TenantFragment
}
products {
...ProductFragment
}
name
description
price {
...MoneyFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"productsPackage": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"products": [Product],
"name": "xyz789",
"description": "xyz789",
"price": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
productsPackages
Description
List all packages.
Roles:
- ROLE_PACKAGE_ADMIN
Response
Returns a ProductPackageConnection!
Arguments
| Name | Description |
|---|---|
name - String
|
|
orderBy - [QueryProductsPackagesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query productsPackages(
$name: String,
$orderBy: [QueryProductsPackagesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
productsPackages(
name: $name,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ProductPackageEdgeFragment
}
}
}
Variables
{
"name": "abc123",
"orderBy": [QueryProductsPackagesOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"productsPackages": {
"pageInfo": PageInfo,
"edges": [ProductPackageEdge]
}
}
}
searchCompanyByRegistrationNumber
Use companiesSearchByRegistrationNumber instead
Description
Search company information by registration number.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INVALID_REGISTRATION_NUMBER
- INVALID_COMPANY_DATA
- COMPANY_NOT_FOUND
- INTERNAL_SERVER_ERROR
Response
Returns a SearchCompanyResponse!
Example
Query
query searchCompanyByRegistrationNumber(
$country: Country!,
$registrationNumber: String!
) {
searchCompanyByRegistrationNumber(
country: $country,
registrationNumber: $registrationNumber
) {
country
name
registrationNumber
website
contactPerson {
...SearchCompanyContactPersonFragment
}
address {
...SearchCompanyAddressFragment
}
}
}
Variables
{
"country": "AL",
"registrationNumber": "xyz789"
}
Response
{
"data": {
"searchCompanyByRegistrationNumber": {
"country": "AL",
"name": "abc123",
"registrationNumber": "xyz789",
"website": "abc123",
"contactPerson": SearchCompanyContactPerson,
"address": SearchCompanyAddress
}
}
}
sepaFile
Use
paymentsSepaFile instead. Description
Get single sepa file by id
Example
Query
query sepaFile($id: UUID) {
sepaFile(id: $id) {
id
name
url
status
invoiceCount
createdAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"sepaFile": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"url": "xyz789",
"status": "xyz789",
"invoiceCount": 987,
"createdAt": "2007-12-03T10:15:30Z"
}
}
}
sepaFiles
Use
paymentsSepaFiles instead. Description
List all sepa files
Response
Returns a SepaConnection!
Arguments
| Name | Description |
|---|---|
where - QuerySepaFilesWhereWhereConditions
|
|
orderBy - [QuerySepaFilesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query sepaFiles(
$where: QuerySepaFilesWhereWhereConditions,
$orderBy: [QuerySepaFilesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
sepaFiles(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...SepaEdgeFragment
}
}
}
Variables
{
"where": QuerySepaFilesWhereWhereConditions,
"orderBy": [QuerySepaFilesOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"sepaFiles": {
"pageInfo": PageInfo,
"edges": [SepaEdge]
}
}
}
settings
Use userSettings instead
Description
Retrieve user settings
Response
Returns a String
Example
Query
query settings {
settings
}
Response
{"data": {"settings": "xyz789"}}
shippingAddress
Use addressesGetShippingAddress instead
Description
Get single shipping address by ID
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Response
Returns a ShippingAddress
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query shippingAddress($id: UUID!) {
shippingAddress(id: $id) {
id
name
firstName
lastName
phoneNumber
gender
address {
...AddressFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"shippingAddress": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"phoneNumber": "abc123",
"gender": "MALE",
"address": Address
}
}
}
shippingAddresses
Use addressesGetShippingAddresses instead
Description
List all shipping addresses
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Response
Returns a ShippingAddressConnection!
Example
Query
query shippingAddresses(
$name: String,
$first_name: String,
$last_name: String,
$first: Int!,
$after: String
) {
shippingAddresses(
name: $name,
first_name: $first_name,
last_name: $last_name,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...ShippingAddressEdgeFragment
}
}
}
Variables
{
"name": "abc123",
"first_name": "abc123",
"last_name": "abc123",
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"shippingAddresses": {
"pageInfo": PageInfo,
"edges": [ShippingAddressEdge]
}
}
}
template
use cardsGetTemplate instead.
Description
Get single template by UUID
Roles:
- ROLE_TEMPLATE_ADMIN
Example
Query
query template($id: UUID!) {
template(id: $id) {
id
tenant {
...TenantFragment
}
label
description
limit {
...TemplateLimitFragment
}
chargePointOperatorPool {
...ChargePointOperatorPoolFragment
}
chargePointOperators {
...ChargePointOperatorFragment
}
fuelEnabled
chargingEnabled
products {
...ProductFragment
}
locations {
...CardLocationFragment
}
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"template": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"label": "abc123",
"description": "abc123",
"limit": TemplateLimit,
"chargePointOperatorPool": ChargePointOperatorPool,
"chargePointOperators": [ChargePointOperator],
"fuelEnabled": true,
"chargingEnabled": false,
"products": [Product],
"locations": [CardLocation],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
templates
use cardsGetTemplates instead.
Description
List templates.
Roles:
- ROLE_TEMPLATE_ADMIN
Response
Returns a TemplateConnection!
Arguments
| Name | Description |
|---|---|
where - QueryTemplatesWhereWhereConditions
|
|
orderBy - [QueryTemplatesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query templates(
$where: QueryTemplatesWhereWhereConditions,
$orderBy: [QueryTemplatesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
templates(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TemplateEdgeFragment
}
}
}
Variables
{
"where": QueryTemplatesWhereWhereConditions,
"orderBy": [QueryTemplatesOrderByOrderByClause],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"templates": {
"pageInfo": PageInfo,
"edges": [TemplateEdge]
}
}
}
tenant
Description
Find a single tenant by an identifying attribute
Example
Query
query tenant($id: UUID) {
tenant(id: $id) {
id
siteId
binRanges {
...BinRangeFragment
}
mandate {
...MandateFragment
}
mandates {
...MandateFragment
}
mandateTemplates {
...MandateTemplateFragment
}
name
priceModifications {
...PriceModificationFragment
}
productPackages {
...ProductPackageFragment
}
tag
registrationNumber
vatNumber
iban
bic
provider
country
logo
aboutUs
privacyPolicy
usesInvoice
phoneNumbers {
...PhoneNumberFragment
}
disabledAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
invoiceReminderDays
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"tenant": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"siteId": "xyz789",
"binRanges": [BinRange],
"mandate": [Mandate],
"mandates": [Mandate],
"mandateTemplates": [MandateTemplate],
"name": "xyz789",
"priceModifications": [PriceModification],
"productPackages": [ProductPackage],
"tag": "xyz789",
"registrationNumber": "xyz789",
"vatNumber": "xyz789",
"iban": "xyz789",
"bic": "abc123",
"provider": ["LODDER"],
"country": "AL",
"logo": "xyz789",
"aboutUs": "xyz789",
"privacyPolicy": "abc123",
"usesInvoice": true,
"phoneNumbers": [PhoneNumber],
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"invoiceReminderDays": 123
}
}
}
tenantTermsAndConditions
Description
List terms and conditions
Response
Returns a TermsAndConditionConnection!
Arguments
| Name | Description |
|---|---|
where - QueryTenantTermsAndConditionsWhereWhereConditions
|
|
orderBy - [QueryTenantTermsAndConditionsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query tenantTermsAndConditions(
$where: QueryTenantTermsAndConditionsWhereWhereConditions,
$orderBy: [QueryTenantTermsAndConditionsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
tenantTermsAndConditions(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TermsAndConditionEdgeFragment
}
}
}
Variables
{
"where": QueryTenantTermsAndConditionsWhereWhereConditions,
"orderBy": [
QueryTenantTermsAndConditionsOrderByOrderByClause
],
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"tenantTermsAndConditions": {
"pageInfo": PageInfo,
"edges": [TermsAndConditionEdge]
}
}
}
tenants
Description
List multiple tenants
Response
Returns a TenantConnection!
Arguments
| Name | Description |
|---|---|
orderBy - [QueryTenantsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query tenants(
$orderBy: [QueryTenantsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
tenants(
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TenantEdgeFragment
}
}
}
Variables
{
"orderBy": [QueryTenantsOrderByOrderByClause],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"tenants": {
"pageInfo": PageInfo,
"edges": [TenantEdge]
}
}
}
termsAndConditions
Use tenantTermsAndConditions instead
Description
List terms and conditions
Response
Returns a TermsAndConditionConnection!
Arguments
| Name | Description |
|---|---|
where - QueryTermsAndConditionsWhereWhereConditions
|
|
orderBy - [QueryTermsAndConditionsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query termsAndConditions(
$where: QueryTermsAndConditionsWhereWhereConditions,
$orderBy: [QueryTermsAndConditionsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
termsAndConditions(
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TermsAndConditionEdgeFragment
}
}
}
Variables
{
"where": QueryTermsAndConditionsWhereWhereConditions,
"orderBy": [
QueryTermsAndConditionsOrderByOrderByClause
],
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"termsAndConditions": {
"pageInfo": PageInfo,
"edges": [TermsAndConditionEdge]
}
}
}
transaction
Description
Find a single transaction by an identifying attribute
Roles:
- ROLE_TRANSACTION_ADMIN
Response
Returns a TransactionData!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
Example
Query
query transaction($id: UUID!) {
transaction(id: $id) {
id
type
transactionId
createdAt
updatedAt
amount
totalCost {
...MoneyFragment
}
service {
... on FuelCard {
...FuelCardFragment
}
... on ChargeToken {
...ChargeTokenFragment
}
... on Card {
...CardFragment
}
}
location {
... on ChargeLocation {
...ChargeLocationFragment
}
... on GasStation {
...GasStationFragment
}
}
mileage
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"transaction": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "FUEL",
"transactionId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"amount": 123.45,
"totalCost": Money,
"service": FuelCard,
"location": ChargeLocation,
"mileage": 987
}
}
}
transactionCompareStatisticsAmountDifference
Description
Compare Statistics Amount Difference between two periods
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a StatisticsDifference!
Arguments
| Name | Description |
|---|---|
firstStartDate - String!
|
|
firstEndDate - String!
|
|
secondStartDate - String!
|
|
secondEndDate - String!
|
|
transactionType - TransactionType
|
Example
Query
query transactionCompareStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$transactionType: TransactionType
) {
transactionCompareStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
transactionType: $transactionType
) {
amount
percentage
}
}
Variables
{
"firstStartDate": "abc123",
"firstEndDate": "abc123",
"secondStartDate": "abc123",
"secondEndDate": "abc123",
"transactionType": "FUEL"
}
Response
{
"data": {
"transactionCompareStatisticsAmountDifference": {
"amount": 987,
"percentage": 123.45
}
}
}
transactionDailyTransactionStatistic
Description
Retrieve daily transactions statistic by date, type and tenantId
Roles:
- ROLE_TRANSACTION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a DailyTransactionStatistic
Arguments
| Name | Description |
|---|---|
date - Date
|
|
transactionType - TransactionType
|
|
tenantId - String
|
Example
Query
query transactionDailyTransactionStatistic(
$date: Date,
$transactionType: TransactionType,
$tenantId: String
) {
transactionDailyTransactionStatistic(
date: $date,
transactionType: $transactionType,
tenantId: $tenantId
) {
id
company {
...OrganizationalComponentFragment
}
tenant {
...TenantFragment
}
date
transactionType
amount
}
}
Variables
{
"date": "2007-12-03",
"transactionType": "FUEL",
"tenantId": "xyz789"
}
Response
{
"data": {
"transactionDailyTransactionStatistic": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"tenant": Tenant,
"date": "2007-12-03",
"transactionType": "FUEL",
"amount": 123
}
}
}
transactionDailyTransactionStatistics
Description
Retrieve daily transactions statistics
Roles:
- ROLE_TRANSACTION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns [DailyTransactionStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryTransactionDailyTransactionStatisticsWhereWhereConditions
|
|
orderBy - [QueryTransactionDailyTransactionStatisticsOrderByOrderByClause!]
|
Example
Query
query transactionDailyTransactionStatistics(
$where: QueryTransactionDailyTransactionStatisticsWhereWhereConditions,
$orderBy: [QueryTransactionDailyTransactionStatisticsOrderByOrderByClause!]
) {
transactionDailyTransactionStatistics(
where: $where,
orderBy: $orderBy
) {
id
company {
...OrganizationalComponentFragment
}
tenant {
...TenantFragment
}
date
transactionType
amount
}
}
Variables
{
"where": QueryTransactionDailyTransactionStatisticsWhereWhereConditions,
"orderBy": [
QueryTransactionDailyTransactionStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"transactionDailyTransactionStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"tenant": Tenant,
"date": "2007-12-03",
"transactionType": "FUEL",
"amount": 987
}
]
}
}
transactions
Description
List multiple transactions
Roles:
- ROLE_TRANSACTION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a TransactionDataConnection!
Arguments
| Name | Description |
|---|---|
where - QueryTransactionsWhereWhereConditions
|
|
hasMorph - QueryTransactionsHasMorphWhereHasConditions
|
|
orderBy - [QueryTransactionsOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query transactions(
$where: QueryTransactionsWhereWhereConditions,
$hasMorph: QueryTransactionsHasMorphWhereHasConditions,
$orderBy: [QueryTransactionsOrderByOrderByClause!],
$first: Int!,
$after: String
) {
transactions(
where: $where,
hasMorph: $hasMorph,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...TransactionDataEdgeFragment
}
}
}
Variables
{
"where": QueryTransactionsWhereWhereConditions,
"hasMorph": QueryTransactionsHasMorphWhereHasConditions,
"orderBy": [QueryTransactionsOrderByOrderByClause],
"first": 123,
"after": "abc123"
}
Response
{
"data": {
"transactions": {
"pageInfo": PageInfo,
"edges": [TransactionDataEdge]
}
}
}
twoFactorAuthenticationCode
Use authTwoFactorAuthenticationCode instead
Description
Retrieve to factor authentication code
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a TwoFactorAuthenticationResponse!
Example
Query
query twoFactorAuthenticationCode {
twoFactorAuthenticationCode {
image
url
}
}
Response
{
"data": {
"twoFactorAuthenticationCode": {
"image": "xyz789",
"url": "abc123"
}
}
}
user
Description
Find a single user by an identifying attribute
Response
Returns a User
Example
Query
query user(
$id: UUID,
$email: String
) {
user(
id: $id,
email: $email
) {
id
address {
...AddressFragment
}
invoiceAddress {
...AddressFragment
}
shippingAddresses {
...ShippingAddressFragment
}
emailVerifiedAt
twoFactorConfirmedAt
cards {
...CardFragment
}
favoriteChargeLocations {
...ChargeLocationFragment
}
pivot {
...OrganizationalComponentUserPivotFragment
}
organizationalComponents {
...OrganizationalComponentConnectionFragment
}
metadata {
...ValueFragment
}
favoriteParkingLocations {
...ParkingLocationFragment
}
mandate {
...MandateFragment
}
mandates {
...MandateFragment
}
priceModifications {
...PriceModificationFragment
}
roles {
...RoleFragment
}
tenant {
...TenantFragment
}
firstName
lastName
email
customerNumber
dateOfBirth
gender
company {
...CompanyFragment
}
locale
iban
bic
vatNumber
paymentMethod
billingPeriod
invoiceVia
invoiceEmail
paymentTerm
structuredReference {
...StructuredReferenceNumberFragment
}
externalReference
phoneNumbers {
...UserPhoneNumberFragment
}
termsOfAgreementAcceptedAt
termsAndConditionsApproval {
...UserTermsAndConditionsApprovalFragment
}
guarantees {
...GuaranteeFragment
}
deletedAt
disabledAt
disabledReason
disabledComment
deactivatedAt
createdAt
updatedAt
companies {
...CompanyConnectionFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"email": "xyz789"
}
Response
{
"data": {
"user": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"emailVerifiedAt": DateTimeUtc,
"twoFactorConfirmedAt": DateTimeUtc,
"cards": [Card],
"favoriteChargeLocations": [ChargeLocation],
"pivot": OrganizationalComponentUserPivot,
"organizationalComponents": OrganizationalComponentConnection,
"metadata": [Value],
"favoriteParkingLocations": [ParkingLocation],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification],
"roles": [Role],
"tenant": Tenant,
"firstName": "xyz789",
"lastName": "abc123",
"email": "xyz789",
"customerNumber": "abc123",
"dateOfBirth": "2007-12-03",
"gender": "MALE",
"company": Company,
"locale": "NL",
"iban": "xyz789",
"bic": "xyz789",
"vatNumber": "xyz789",
"paymentMethod": "DIRECT_DEBIT",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"invoiceEmail": ["abc123"],
"paymentTerm": 123,
"structuredReference": StructuredReferenceNumber,
"externalReference": "xyz789",
"phoneNumbers": [UserPhoneNumber],
"termsOfAgreementAcceptedAt": DateTimeUtc,
"termsAndConditionsApproval": UserTermsAndConditionsApproval,
"guarantees": [Guarantee],
"deletedAt": DateTimeUtc,
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "xyz789",
"deactivatedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"companies": CompanyConnection
}
}
}
userAvailableCountries
Description
List users available countries
Response
Returns [CountryList!]!
Example
Query
query userAvailableCountries {
userAvailableCountries {
name
code
emoji
unicode
dialCode
image
}
}
Response
{
"data": {
"userAvailableCountries": [
{
"name": "abc123",
"code": "abc123",
"emoji": "xyz789",
"unicode": "xyz789",
"dialCode": "abc123",
"image": "abc123"
}
]
}
}
userCompareStatisticsAmountDifference
Description
Compare Statistics Amount Difference between two periods
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a StatisticsDifference!
Example
Query
query userCompareStatisticsAmountDifference(
$firstStartDate: String!,
$firstEndDate: String!,
$secondStartDate: String!,
$secondEndDate: String!,
$userType: UserType
) {
userCompareStatisticsAmountDifference(
firstStartDate: $firstStartDate,
firstEndDate: $firstEndDate,
secondStartDate: $secondStartDate,
secondEndDate: $secondEndDate,
userType: $userType
) {
amount
percentage
}
}
Variables
{
"firstStartDate": "abc123",
"firstEndDate": "xyz789",
"secondStartDate": "abc123",
"secondEndDate": "xyz789",
"userType": "ANONYMOUS"
}
Response
{
"data": {
"userCompareStatisticsAmountDifference": {
"amount": 987,
"percentage": 987.65
}
}
}
userDailyStatistic
Description
Retrieve daily user statistics by date and type
Response
Returns a DailyUserStatistic
Example
Query
query userDailyStatistic(
$date: Date,
$userType: UserType
) {
userDailyStatistic(
date: $date,
userType: $userType
) {
id
tenant {
...TenantFragment
}
date
userType
amount
}
}
Variables
{
"date": "2007-12-03",
"userType": "ANONYMOUS"
}
Response
{
"data": {
"userDailyStatistic": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"userType": "ANONYMOUS",
"amount": 123
}
}
}
userDailyStatistics
Description
Retrieve list of daily user statistics
Response
Returns [DailyUserStatistic]
Arguments
| Name | Description |
|---|---|
where - QueryUserDailyStatisticsWhereWhereConditions
|
|
orderBy - [QueryUserDailyStatisticsOrderByOrderByClause!]
|
Example
Query
query userDailyStatistics(
$where: QueryUserDailyStatisticsWhereWhereConditions,
$orderBy: [QueryUserDailyStatisticsOrderByOrderByClause!]
) {
userDailyStatistics(
where: $where,
orderBy: $orderBy
) {
id
tenant {
...TenantFragment
}
date
userType
amount
}
}
Variables
{
"where": QueryUserDailyStatisticsWhereWhereConditions,
"orderBy": [
QueryUserDailyStatisticsOrderByOrderByClause
]
}
Response
{
"data": {
"userDailyStatistics": [
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"userType": "ANONYMOUS",
"amount": 123
}
]
}
}
userMe
Description
Retrieve current logged in user
Response
Returns a User
Example
Query
query userMe {
userMe {
id
address {
...AddressFragment
}
invoiceAddress {
...AddressFragment
}
shippingAddresses {
...ShippingAddressFragment
}
emailVerifiedAt
twoFactorConfirmedAt
cards {
...CardFragment
}
favoriteChargeLocations {
...ChargeLocationFragment
}
pivot {
...OrganizationalComponentUserPivotFragment
}
organizationalComponents {
...OrganizationalComponentConnectionFragment
}
metadata {
...ValueFragment
}
favoriteParkingLocations {
...ParkingLocationFragment
}
mandate {
...MandateFragment
}
mandates {
...MandateFragment
}
priceModifications {
...PriceModificationFragment
}
roles {
...RoleFragment
}
tenant {
...TenantFragment
}
firstName
lastName
email
customerNumber
dateOfBirth
gender
company {
...CompanyFragment
}
locale
iban
bic
vatNumber
paymentMethod
billingPeriod
invoiceVia
invoiceEmail
paymentTerm
structuredReference {
...StructuredReferenceNumberFragment
}
externalReference
phoneNumbers {
...UserPhoneNumberFragment
}
termsOfAgreementAcceptedAt
termsAndConditionsApproval {
...UserTermsAndConditionsApprovalFragment
}
guarantees {
...GuaranteeFragment
}
deletedAt
disabledAt
disabledReason
disabledComment
deactivatedAt
createdAt
updatedAt
companies {
...CompanyConnectionFragment
}
}
}
Response
{
"data": {
"userMe": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"emailVerifiedAt": DateTimeUtc,
"twoFactorConfirmedAt": DateTimeUtc,
"cards": [Card],
"favoriteChargeLocations": [ChargeLocation],
"pivot": OrganizationalComponentUserPivot,
"organizationalComponents": OrganizationalComponentConnection,
"metadata": [Value],
"favoriteParkingLocations": [ParkingLocation],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification],
"roles": [Role],
"tenant": Tenant,
"firstName": "xyz789",
"lastName": "abc123",
"email": "xyz789",
"customerNumber": "xyz789",
"dateOfBirth": "2007-12-03",
"gender": "MALE",
"company": Company,
"locale": "NL",
"iban": "abc123",
"bic": "xyz789",
"vatNumber": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"invoiceEmail": ["abc123"],
"paymentTerm": 987,
"structuredReference": StructuredReferenceNumber,
"externalReference": "abc123",
"phoneNumbers": [UserPhoneNumber],
"termsOfAgreementAcceptedAt": DateTimeUtc,
"termsAndConditionsApproval": UserTermsAndConditionsApproval,
"guarantees": [Guarantee],
"deletedAt": DateTimeUtc,
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "xyz789",
"deactivatedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"companies": CompanyConnection
}
}
}
userSettings
Description
Retrieve user settings
Response
Returns a String
Example
Query
query userSettings {
userSettings
}
Response
{"data": {"userSettings": "abc123"}}
users
Description
List multiple users
Response
Returns a UserConnection!
Arguments
| Name | Description |
|---|---|
name - String
|
Filters by name. Accepts SQL LIKE wildcards % and _ |
where - QueryUsersWhereWhereConditions
|
|
orderBy - [QueryUsersOrderByOrderByClause!]
|
|
hasCompanies - QueryUsersHasCompaniesWhereHasConditions
|
|
searchDriver - String
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query users(
$name: String,
$where: QueryUsersWhereWhereConditions,
$orderBy: [QueryUsersOrderByOrderByClause!],
$hasCompanies: QueryUsersHasCompaniesWhereHasConditions,
$searchDriver: String,
$first: Int!,
$after: String
) {
users(
name: $name,
where: $where,
orderBy: $orderBy,
hasCompanies: $hasCompanies,
searchDriver: $searchDriver,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...UserEdgeFragment
}
}
}
Variables
{
"name": "xyz789",
"where": QueryUsersWhereWhereConditions,
"orderBy": [QueryUsersOrderByOrderByClause],
"hasCompanies": QueryUsersHasCompaniesWhereHasConditions,
"searchDriver": "xyz789",
"first": 987,
"after": "xyz789"
}
Response
{
"data": {
"users": {
"pageInfo": PageInfo,
"edges": [UserEdge]
}
}
}
vehicle
Description
Find a single user by an identifying attribute.
Example
Query
query vehicle($id: UUID) {
vehicle(id: $id) {
id
metadata {
...ValueFragment
}
licensePlate
user {
...UserFragment
}
company {
...OrganizationalComponentFragment
}
country
brand
model
buildYear
vin
mileage
color
body
verifiedAt
createdAt
updatedAt
createdBy {
...UserFragment
}
updatedBy {
...UserFragment
}
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"vehicle": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"metadata": [Value],
"licensePlate": "xyz789",
"user": User,
"company": OrganizationalComponent,
"country": "AL",
"brand": "abc123",
"model": "abc123",
"buildYear": 123,
"vin": "abc123",
"mileage": 987,
"color": "xyz789",
"body": "xyz789",
"verifiedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
}
}
vehicles
Description
List multiple users.
Response
Returns a VehicleConnection!
Arguments
| Name | Description |
|---|---|
verified - Verified
|
Default = WITHOUT |
where - QueryVehiclesWhereWhereConditions
|
|
orderBy - [QueryVehiclesOrderByOrderByClause!]
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query vehicles(
$verified: Verified,
$where: QueryVehiclesWhereWhereConditions,
$orderBy: [QueryVehiclesOrderByOrderByClause!],
$first: Int!,
$after: String
) {
vehicles(
verified: $verified,
where: $where,
orderBy: $orderBy,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...VehicleEdgeFragment
}
}
}
Variables
{
"verified": "WITHOUT",
"where": QueryVehiclesWhereWhereConditions,
"orderBy": [QueryVehiclesOrderByOrderByClause],
"first": 987,
"after": "abc123"
}
Response
{
"data": {
"vehicles": {
"pageInfo": PageInfo,
"edges": [VehicleEdge]
}
}
}
webhook
Example
Query
query webhook($id: UUID) {
webhook(id: $id) {
id
tenant {
...TenantFragment
}
topic
name
createdAt
updatedAt
}
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{
"data": {
"webhook": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"topic": "COMPANY_SEGMENT_CREATED",
"name": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
}
}
webhooks
Description
List of webhooks
Response
Returns a WebhookConnection!
Arguments
| Name | Description |
|---|---|
where - QueryWebhooksWhereWhereConditions
|
|
first - Int!
|
Limits number of fetched items. |
after - String
|
A cursor after which elements are returned. |
Example
Query
query webhooks(
$where: QueryWebhooksWhereWhereConditions,
$first: Int!,
$after: String
) {
webhooks(
where: $where,
first: $first,
after: $after
) {
pageInfo {
...PageInfoFragment
}
edges {
...WebhookEdgeFragment
}
}
}
Variables
{
"where": QueryWebhooksWhereWhereConditions,
"first": 123,
"after": "xyz789"
}
Response
{
"data": {
"webhooks": {
"pageInfo": PageInfo,
"edges": [WebhookEdge]
}
}
}
Mutations
activateCompany
Use expenseReportActivateCompany instead
Description
Activate a company
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_COMPANY
activateGasStation
use gasStationsActivate instead.
Description
Activates a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- GAS_STATION_ALREADY_ACTIVATED
- INTERNAL_SERVER_ERROR
addCardComment
use cardsAddComment instead.
Description
Add new comment to card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddCardCommentInput!
|
Example
Query
mutation addCardComment($input: AddCardCommentInput!) {
addCardComment(input: $input)
}
Variables
{"input": AddCardCommentInput}
Response
{
"data": {
"addCardComment": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addCardToOrder
use ordersAddCardToOrder instead.
Description
Add card to order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddCardToOrderInput!
|
Example
Query
mutation addCardToOrder($input: AddCardToOrderInput!) {
addCardToOrder(input: $input)
}
Variables
{"input": AddCardToOrderInput}
Response
{
"data": {
"addCardToOrder": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addChargeRecord
Use chargeRecordAddChargeRecord instead
Description
Add Transaction.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_RECORD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddChargeRecordInput!
|
Example
Query
mutation addChargeRecord($input: AddChargeRecordInput!) {
addChargeRecord(input: $input)
}
Variables
{"input": AddChargeRecordInput}
Response
{
"data": {
"addChargeRecord": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addChargeTokenToChargePointOperator
Use chargePointOperatorAddChargeToken instead
Description
Adds a charge token to a charge point operator
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- TOKEN_IS_PART_OF_CHARGE_POINT_OPERATOR_POOL
- TOKEN_ALREADY_ADDED_TO_CHARGE_POINT_OPERATOR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddChargeTokenToChargePointOperatorInput!
|
Example
Query
mutation addChargeTokenToChargePointOperator(
$id: UUID!,
$input: AddChargeTokenToChargePointOperatorInput!
) {
addChargeTokenToChargePointOperator(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddChargeTokenToChargePointOperatorInput
}
Response
{"data": {"addChargeTokenToChargePointOperator": false}}
addCompanyForExpenseTracking
Use expenseReportCreateCompany instead
Description
Add a new company for expense tracking.
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- COMPANY_ALREADY_EXISTS_WITH_GIVEN_VAT_NUMBER
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddCompanyForExpenseTrackingInput!
|
Example
Query
mutation addCompanyForExpenseTracking($input: AddCompanyForExpenseTrackingInput!) {
addCompanyForExpenseTracking(input: $input)
}
Variables
{"input": AddCompanyForExpenseTrackingInput}
Response
{
"data": {
"addCompanyForExpenseTracking": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addEfasDetails
use tenantAddEfasDetails instead.
Description
Add EFAS fuel card provider details
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddEfasDetailsInput
|
Example
Query
mutation addEfasDetails(
$id: UUID!,
$input: AddEfasDetailsInput
) {
addEfasDetails(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddEfasDetailsInput
}
Response
{"data": {"addEfasDetails": true}}
addEmablerSiteId
use tenantAddEmablerSiteId instead.
Description
Adds an Emabler site id to the tenant. Required for enabling MSP functionality
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddEmablerSiteIdInput
|
Example
Query
mutation addEmablerSiteId(
$id: UUID!,
$input: AddEmablerSiteIdInput
) {
addEmablerSiteId(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddEmablerSiteIdInput
}
Response
{"data": {"addEmablerSiteId": false}}
addExpenseReportTransaction
Use expenseReportAddTransaction instead
Description
Add Transaction to Expense Report
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TRANSACTION_ALREADY_EXISTS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddExpenseReportTransactionInput!
|
Example
Query
mutation addExpenseReportTransaction($input: AddExpenseReportTransactionInput!) {
addExpenseReportTransaction(input: $input)
}
Variables
{"input": AddExpenseReportTransactionInput}
Response
{
"data": {
"addExpenseReportTransaction": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addFuelTransaction
Use fuelCardAddTransaction instead
Description
Add Fuel Card Transaction
Roles:
- ROLE_FUEL_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TRANSACTION_ALREADY_EXISTS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddFuelTransactionInput!
|
Example
Query
mutation addFuelTransaction($input: AddFuelTransactionInput!) {
addFuelTransaction(input: $input)
}
Variables
{"input": AddFuelTransactionInput}
Response
{
"data": {
"addFuelTransaction": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addKilometreCharge
use kilometreChargingAddCharge instead.
Description
Add Kilometre Charge Transaction.
Roles:
- ROLE_KILOMETRE_CHARGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddKilometreChargeInput!
|
Example
Query
mutation addKilometreCharge($input: AddKilometreChargeInput!) {
addKilometreCharge(input: $input)
}
Variables
{"input": AddKilometreChargeInput}
Response
{
"data": {
"addKilometreCharge": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addMandateTemplate
use tenantAddMandateTemplate instead.
Description
Add Mandate Template
Possible error codes:
- UNIQUE_CONSTRAINT_VIOLATION
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - addMandateTemplateInput
|
Example
Query
mutation addMandateTemplate($input: addMandateTemplateInput) {
addMandateTemplate(input: $input)
}
Variables
{"input": addMandateTemplateInput}
Response
{
"data": {
"addMandateTemplate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addOrderComment
use ordersAddComment instead.
Description
Add new comment to order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddOrderCommentInput!
|
Example
Query
mutation addOrderComment($input: AddOrderCommentInput!) {
addOrderComment(input: $input)
}
Variables
{"input": AddOrderCommentInput}
Response
{
"data": {
"addOrderComment": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addPackageToOrder
use ordersAddPackage instead.
Description
Add package to order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddPackageToOrderInput!
|
Example
Query
mutation addPackageToOrder($input: AddPackageToOrderInput!) {
addPackageToOrder(input: $input)
}
Variables
{"input": AddPackageToOrderInput}
Response
{
"data": {
"addPackageToOrder": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addPhoneNumber
use userAddPhoneNumber instead
Description
Add phone number to the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - addPhoneNumberInput
|
Example
Query
mutation addPhoneNumber($input: addPhoneNumberInput) {
addPhoneNumber(input: $input)
}
Variables
{"input": addPhoneNumberInput}
Response
{"data": {"addPhoneNumber": "xyz789"}}
addPhoneNumberForTenant
use tenantAddPhoneNumber instead.
Description
Add phone number to tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- PHONE_NUMBER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - AddPhoneNumberForTenantInput
|
Example
Query
mutation addPhoneNumberForTenant($input: AddPhoneNumberForTenantInput) {
addPhoneNumberForTenant(input: $input)
}
Variables
{"input": AddPhoneNumberForTenantInput}
Response
{
"data": {
"addPhoneNumberForTenant": "xyz789"
}
}
addPrivacyPolicy
use tenantAddPrivacyPolicy instead.
Description
Add privacy policy to the Tenant
Roles:
- ROLE_TENANTS_ADMIN
- ROLE_TENANT_OWNER
Possible error codes:
- TENANT_ALREADY_HAS_PRIVACY_POLICY
- INTERNAL_SERVER_ERROR
Example
Query
mutation addPrivacyPolicy(
$id: UUID!,
$privacyPolicy: String!
) {
addPrivacyPolicy(
id: $id,
privacyPolicy: $privacyPolicy
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"privacyPolicy": "abc123"
}
Response
{"data": {"addPrivacyPolicy": true}}
addProductToCategory
Use
productsAddProductToCategory instead. Description
Add a product to a category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- PRODUCT_ALREADY_IN_CATEGORY
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddProductToCategoryInput!
|
Example
Query
mutation addProductToCategory(
$id: UUID!,
$input: AddProductToCategoryInput!
) {
addProductToCategory(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddProductToCategoryInput
}
Response
{"data": {"addProductToCategory": true}}
addProductToGasStation
use gasStationsAddProductToGasStation instead.
Description
Adds a product to a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddProductToGasStationInput!
|
Example
Query
mutation addProductToGasStation($input: AddProductToGasStationInput!) {
addProductToGasStation(input: $input)
}
Variables
{"input": AddProductToGasStationInput}
Response
{"data": {"addProductToGasStation": false}}
addRolesToUser
use rolesAddRolesToUser instead.
Description
Add roles to a user.
Roles:
ROLE_AUTH_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
userId - UUID!
|
|
input - AddRolesToUserInput!
|
Example
Query
mutation addRolesToUser(
$userId: UUID!,
$input: AddRolesToUserInput!
) {
addRolesToUser(
userId: $userId,
input: $input
)
}
Variables
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddRolesToUserInput
}
Response
{"data": {"addRolesToUser": true}}
addToFavorite
use userAddToFavorite instead
Description
Add favorite location to the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddToFavoriteInput
|
Example
Query
mutation addToFavorite($input: AddToFavoriteInput) {
addToFavorite(input: $input)
}
Variables
{"input": AddToFavoriteInput}
Response
{"data": {"addToFavorite": false}}
addTokenizedCardToCompany
Use expenseReportAddTokenizedCardToCompany instead
Description
Add tokenized card to existing company
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_COMPANY
- TOKEN_ALREADY_EXISTS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddTokenizedCardToCompanyInput!
|
Example
Query
mutation addTokenizedCardToCompany($input: AddTokenizedCardToCompanyInput!) {
addTokenizedCardToCompany(input: $input)
}
Variables
{"input": AddTokenizedCardToCompanyInput}
Response
{
"data": {
"addTokenizedCardToCompany": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addUserToOrganizationalComponent
Use companiesAddUserToOrganizationalComponent instead
Description
Add an user to Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_DOES_NOT_EXIST
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddUserOrganizationalComponentInput
|
Example
Query
mutation addUserToOrganizationalComponent(
$id: UUID!,
$input: AddUserOrganizationalComponentInput
) {
addUserToOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddUserOrganizationalComponentInput
}
Response
{"data": {"addUserToOrganizationalComponent": true}}
addUsersToRole
use rolesAddUsersToRole instead.
Description
Add users to a role.
Roles:
ROLE_AUTH_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
role - RoleEnum!
|
|
input - AddUsersToRoleInput!
|
Example
Query
mutation addUsersToRole(
$role: RoleEnum!,
$input: AddUsersToRoleInput!
) {
addUsersToRole(
role: $role,
input: $input
)
}
Variables
{"role": "ROLE_SUPER_ADMIN", "input": AddUsersToRoleInput}
Response
{"data": {"addUsersToRole": true}}
addVehicle
Description
Creates a vehicle for a user.
Possible error codes:
- INVALID_LICENSE_PLATE
- VEHICLE_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddVehicleInput!
|
Example
Query
mutation addVehicle($input: AddVehicleInput!) {
addVehicle(input: $input)
}
Variables
{"input": AddVehicleInput}
Response
{
"data": {
"addVehicle": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateAddressForGasStation
Description
Create address for gas station
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- GAS_STATION_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForGasStationInput!
|
Example
Query
mutation addressesCreateAddressForGasStation($input: CreateAddressForGasStationInput!) {
addressesCreateAddressForGasStation(input: $input)
}
Variables
{"input": CreateAddressForGasStationInput}
Response
{
"data": {
"addressesCreateAddressForGasStation": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateAddressForOrganizationalComponent
Description
Create Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesCreateAddressForOrganizationalComponent($input: CreateAddressForOrganizationalComponentInput!) {
addressesCreateAddressForOrganizationalComponent(input: $input)
}
Variables
{"input": CreateAddressForOrganizationalComponentInput}
Response
{
"data": {
"addressesCreateAddressForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateAddressForTenant
Description
Create address for tenant
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- TENANT_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForTenantInput!
|
Example
Query
mutation addressesCreateAddressForTenant($input: CreateAddressForTenantInput!) {
addressesCreateAddressForTenant(input: $input)
}
Variables
{"input": CreateAddressForTenantInput}
Response
{
"data": {
"addressesCreateAddressForTenant": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateAddressForUser
Description
Create Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- USER_LIVING_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForUserInput!
|
Example
Query
mutation addressesCreateAddressForUser($input: CreateAddressForUserInput!) {
addressesCreateAddressForUser(input: $input)
}
Variables
{"input": CreateAddressForUserInput}
Response
{
"data": {
"addressesCreateAddressForUser": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateInvoiceAddressForOrganizationalComponent
Description
Create Invoice Address for Company
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_INVOICE_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateInvoiceAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesCreateInvoiceAddressForOrganizationalComponent($input: CreateInvoiceAddressForOrganizationalComponentInput!) {
addressesCreateInvoiceAddressForOrganizationalComponent(input: $input)
}
Variables
{
"input": CreateInvoiceAddressForOrganizationalComponentInput
}
Response
{
"data": {
"addressesCreateInvoiceAddressForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateInvoiceAddressForUser
Description
Create Invoice Address for User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- USER_INVOICE_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - InvoiceAddressForUserInput!
|
Example
Query
mutation addressesCreateInvoiceAddressForUser($input: InvoiceAddressForUserInput!) {
addressesCreateInvoiceAddressForUser(input: $input)
}
Variables
{"input": InvoiceAddressForUserInput}
Response
{
"data": {
"addressesCreateInvoiceAddressForUser": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateShippingAddressForOrganizationalComponent
Description
Create Shipping Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ShippingAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesCreateShippingAddressForOrganizationalComponent($input: ShippingAddressForOrganizationalComponentInput!) {
addressesCreateShippingAddressForOrganizationalComponent(input: $input)
}
Variables
{"input": ShippingAddressForOrganizationalComponentInput}
Response
{
"data": {
"addressesCreateShippingAddressForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesCreateShippingAddressForUser
Description
Create Shipping Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ShippingAddressForUserInput!
|
Example
Query
mutation addressesCreateShippingAddressForUser($input: ShippingAddressForUserInput!) {
addressesCreateShippingAddressForUser(input: $input)
}
Variables
{"input": ShippingAddressForUserInput}
Response
{
"data": {
"addressesCreateShippingAddressForUser": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
addressesDeleteAddressForGasStation
Description
Delete Address For GasStation
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - deleteAddressForGasStationInput!
|
Example
Query
mutation addressesDeleteAddressForGasStation(
$id: UUID!,
$input: deleteAddressForGasStationInput!
) {
addressesDeleteAddressForGasStation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": deleteAddressForGasStationInput
}
Response
{"data": {"addressesDeleteAddressForGasStation": false}}
addressesDeleteAddressForOrganizationalComponent
Description
Delete Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ORGANIZATIONAL_COMPONENT_UPDATE_ADDRESS
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - deleteAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesDeleteAddressForOrganizationalComponent(
$id: UUID!,
$input: deleteAddressForOrganizationalComponentInput!
) {
addressesDeleteAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": deleteAddressForOrganizationalComponentInput
}
Response
{"data": {"addressesDeleteAddressForOrganizationalComponent": true}}
addressesDeleteAddressForTenant
Description
Delete Address For Tenant
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - deleteAddressForTenantInput!
|
Example
Query
mutation addressesDeleteAddressForTenant(
$id: UUID!,
$input: deleteAddressForTenantInput!
) {
addressesDeleteAddressForTenant(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": deleteAddressForTenantInput
}
Response
{"data": {"addressesDeleteAddressForTenant": true}}
addressesRemoveAddressForUser
Description
Remove Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UserRemoveAddressInput!
|
Example
Query
mutation addressesRemoveAddressForUser(
$id: UUID!,
$input: UserRemoveAddressInput!
) {
addressesRemoveAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UserRemoveAddressInput
}
Response
{"data": {"addressesRemoveAddressForUser": false}}
addressesRemoveShippingAddressForUser
Description
Remove Shipping Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UserRemoveAddressInput!
|
Example
Query
mutation addressesRemoveShippingAddressForUser(
$id: UUID!,
$input: UserRemoveAddressInput!
) {
addressesRemoveShippingAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UserRemoveAddressInput
}
Response
{"data": {"addressesRemoveShippingAddressForUser": true}}
addressesUpdateAddressForGasStation
Description
Update address For Gas Station
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForGasStationInput!
|
Example
Query
mutation addressesUpdateAddressForGasStation(
$id: UUID!,
$input: UpdateAddressForGasStationInput!
) {
addressesUpdateAddressForGasStation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForGasStationInput
}
Response
{"data": {"addressesUpdateAddressForGasStation": true}}
addressesUpdateAddressForOrganizationalComponent
Description
Update address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ORGANIZATIONAL_COMPONENT_UPDATE_ADDRESS
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesUpdateAddressForOrganizationalComponent(
$id: UUID!,
$input: UpdateAddressForOrganizationalComponentInput!
) {
addressesUpdateAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForOrganizationalComponentInput
}
Response
{"data": {"addressesUpdateAddressForOrganizationalComponent": true}}
addressesUpdateAddressForTenant
Description
Update address for tenant
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForTenantInput!
|
Example
Query
mutation addressesUpdateAddressForTenant(
$id: UUID!,
$input: UpdateAddressForTenantInput!
) {
addressesUpdateAddressForTenant(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForTenantInput
}
Response
{"data": {"addressesUpdateAddressForTenant": false}}
addressesUpdateAddressForUser
Description
Update Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForUserInput!
|
Example
Query
mutation addressesUpdateAddressForUser(
$id: UUID!,
$input: UpdateAddressForUserInput!
) {
addressesUpdateAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForUserInput
}
Response
{"data": {"addressesUpdateAddressForUser": true}}
addressesUpdateInvoiceAddressForOrganizationalComponent
Description
Update Invoice Address for Company
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateInvoiceAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesUpdateInvoiceAddressForOrganizationalComponent(
$id: UUID!,
$input: UpdateInvoiceAddressForOrganizationalComponentInput!
) {
addressesUpdateInvoiceAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateInvoiceAddressForOrganizationalComponentInput
}
Response
{"data": {"addressesUpdateInvoiceAddressForOrganizationalComponent": false}}
addressesUpdateInvoiceAddressForUser
Description
Update Invoice Address for User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - InvoiceAddressForUserInput!
|
Example
Query
mutation addressesUpdateInvoiceAddressForUser(
$id: UUID!,
$input: InvoiceAddressForUserInput!
) {
addressesUpdateInvoiceAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": InvoiceAddressForUserInput
}
Response
{"data": {"addressesUpdateInvoiceAddressForUser": true}}
addressesUpdateShippingAddressForOrganizationalComponent
Description
Update Shipping Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - ShippingAddressForOrganizationalComponentInput!
|
Example
Query
mutation addressesUpdateShippingAddressForOrganizationalComponent(
$id: UUID!,
$input: ShippingAddressForOrganizationalComponentInput!
) {
addressesUpdateShippingAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": ShippingAddressForOrganizationalComponentInput
}
Response
{"data": {"addressesUpdateShippingAddressForOrganizationalComponent": true}}
addressesUpdateShippingAddressForUser
Description
Update Shipping Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ADDRESS_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - ShippingAddressForUserInput!
|
Example
Query
mutation addressesUpdateShippingAddressForUser(
$id: UUID!,
$input: ShippingAddressForUserInput!
) {
addressesUpdateShippingAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": ShippingAddressForUserInput
}
Response
{"data": {"addressesUpdateShippingAddressForUser": true}}
attachPriceModificationToEntity
use priceModificationAttachToEntity instead.
Description
Attach price modification to an entity
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AttachPriceModificationToEntityInput
|
Example
Query
mutation attachPriceModificationToEntity(
$id: UUID!,
$input: AttachPriceModificationToEntityInput
) {
attachPriceModificationToEntity(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AttachPriceModificationToEntityInput
}
Response
{
"data": {
"attachPriceModificationToEntity": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
authConfirmTwoFactorAuthentication
Description
Confirms two factor authentication enabling process.
Possible error codes:
- TWO_FACTOR_AUTHENTICATION_NOT_ENABLED
- TWO_FACTOR_AUTHENTICATION_ALREADY_CONFIRMED
- INVALID_TWO_FACTOR_AUTHENTICATION_CODE
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ConfirmTwoFactorAuthenticationInput
|
Example
Query
mutation authConfirmTwoFactorAuthentication($input: ConfirmTwoFactorAuthenticationInput) {
authConfirmTwoFactorAuthentication(input: $input)
}
Variables
{"input": ConfirmTwoFactorAuthenticationInput}
Response
{"data": {"authConfirmTwoFactorAuthentication": false}}
authCreateUser
Description
Create user.
Possible error codes:
- USER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - CreateUser
|
Example
Query
mutation authCreateUser($input: CreateUser) {
authCreateUser(input: $input)
}
Variables
{"input": CreateUser}
Response
{"data": {"authCreateUser": "abc123"}}
authDisableTwoFactorAuthentication
Description
Starts process of disabling two factor authentication.
Possible error codes:
- TWO_FACTOR_AUTHENTICATION_NOT_ENABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Example
Query
mutation authDisableTwoFactorAuthentication {
authDisableTwoFactorAuthentication
}
Response
{"data": {"authDisableTwoFactorAuthentication": true}}
authEnableTwoFactorAuthentication
Description
Starts process of enabling two factor authentication.
Possible error codes:
- TWO_FACTOR_AUTHENTICATION_ALREADY_ENABLED
- INTERNAL_SERVER_ERROR
Response
Returns a TwoFactorAuthenticationResponse!
Example
Query
mutation authEnableTwoFactorAuthentication {
authEnableTwoFactorAuthentication {
image
url
}
}
Response
{
"data": {
"authEnableTwoFactorAuthentication": {
"image": "xyz789",
"url": "xyz789"
}
}
}
authLogout
Description
Invalidate access and refresh tokens of user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Example
Query
mutation authLogout {
authLogout
}
Response
{"data": {"authLogout": false}}
authUpdateEmail
Description
Initiates the process of updating the email address of the current user. The supplied email address will receive an email to confirm the change.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateEmailInput
|
Example
Query
mutation authUpdateEmail($input: UpdateEmailInput) {
authUpdateEmail(input: $input)
}
Variables
{"input": UpdateEmailInput}
Response
{"data": {"authUpdateEmail": false}}
authUpdatePassword
Description
Update Current User's Password
Possible error codes:
- PASSWORD_VALIDATION_ERROR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdatePasswordInput
|
Example
Query
mutation authUpdatePassword($input: UpdatePasswordInput) {
authUpdatePassword(input: $input)
}
Variables
{"input": UpdatePasswordInput}
Response
{"data": {"authUpdatePassword": true}}
cancelMandate
Use
paymentsCancelMandate instead. Description
Cancel a mandate
Roles:
- ROLE_MANDATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TWIKEY_CREDENTIALS_NOT_FOUND_FOR_THE_TENANT
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CancelMandateInput!
|
Example
Query
mutation cancelMandate(
$id: UUID!,
$input: CancelMandateInput!
) {
cancelMandate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CancelMandateInput
}
Response
{"data": {"cancelMandate": false}}
cancelParking
Description
Cancel existing Parking Session.
Possible error codes:
- UNABLE_TO_CANCEL_PARKING_SESSION
- INTERNAL_SERVER_ERROR
- SOAP_REQUEST_ERROR
cardsAddComment
Description
Add new comment to card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddCardCommentInput!
|
Example
Query
mutation cardsAddComment($input: AddCardCommentInput!) {
cardsAddComment(input: $input)
}
Variables
{"input": AddCardCommentInput}
Response
{
"data": {
"cardsAddComment": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
cardsChangePin
Description
Change pin on card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - ChangePinInput!
|
Example
Query
mutation cardsChangePin(
$id: UUID!,
$input: ChangePinInput!
) {
cardsChangePin(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": ChangePinInput
}
Response
{"data": {"cardsChangePin": false}}
cardsCreate
Description
Create card mutation.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_CREATION_IS_DISABLED_WHEN_GUARANTEE_NOT_VALID
- CARD_WITH_EXTERNAL_REFERENCE_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateCardInput!
|
Example
Query
mutation cardsCreate($input: CreateCardInput!) {
cardsCreate(input: $input)
}
Variables
{"input": CreateCardInput}
Response
{
"data": {
"cardsCreate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
cardsCreateReplacementCard
Description
Create Replacement Card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CreateReplacementCardInput!
|
Example
Query
mutation cardsCreateReplacementCard(
$id: UUID!,
$input: CreateReplacementCardInput!
) {
cardsCreateReplacementCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CreateReplacementCardInput
}
Response
{
"data": {
"cardsCreateReplacementCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
cardsCreateTemplate
Description
Create a template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateTemplateInput!
|
Example
Query
mutation cardsCreateTemplate($input: CreateTemplateInput!) {
cardsCreateTemplate(input: $input)
}
Variables
{"input": CreateTemplateInput}
Response
{
"data": {
"cardsCreateTemplate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
cardsDisable
Description
Disable a Card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - DisableCardInput
|
Example
Query
mutation cardsDisable(
$id: UUID!,
$input: DisableCardInput
) {
cardsDisable(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": DisableCardInput
}
Response
{"data": {"cardsDisable": true}}
cardsDisableCards
Description
Disable multiple Cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - [UUID!]!
|
|
input - DisableCardInput
|
Example
Query
mutation cardsDisableCards(
$id: [UUID!]!,
$input: DisableCardInput
) {
cardsDisableCards(
id: $id,
input: $input
)
}
Variables
{
"id": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"input": DisableCardInput
}
Response
{"data": {"cardsDisableCards": true}}
cardsDisableTemplate
Description
Disable a Template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- TEMPLATE_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
cardsEnable
Description
Enable a Card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_NOT_DISABLED
- INTERNAL_SERVER_ERROR
cardsEnableCards
Description
Enable multiple Cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_NOT_DISABLED
- INTERNAL_SERVER_ERROR
cardsEnableChargeTokenForCard
Description
Enable Charge token for card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - EnableChargeTokenForCardInput!
|
Example
Query
mutation cardsEnableChargeTokenForCard(
$id: UUID!,
$input: EnableChargeTokenForCardInput!
) {
cardsEnableChargeTokenForCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": EnableChargeTokenForCardInput
}
Response
{"data": {"cardsEnableChargeTokenForCard": false}}
cardsEnableFuelForCard
Description
Enable fuel for card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - EnableFuelForCardInput!
|
Example
Query
mutation cardsEnableFuelForCard(
$id: UUID!,
$input: EnableFuelForCardInput!
) {
cardsEnableFuelForCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": EnableFuelForCardInput
}
Response
{"data": {"cardsEnableFuelForCard": true}}
cardsEnableTemplate
Description
Enable a Template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- TEMPLATE_NOT_DISABLED
- INTERNAL_SERVER_ERROR
cardsImportCard
Description
Create card mutation for import cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_CREATION_IS_DISABLED_WHEN_GUARANTEE_NOT_VALID
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ImportCardInput!
|
Example
Query
mutation cardsImportCard($input: ImportCardInput!) {
cardsImportCard(input: $input)
}
Variables
{"input": ImportCardInput}
Response
{
"data": {
"cardsImportCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
cardsImportVirtualCard
Description
Import virtual card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ImportVirtualCardInput!
|
Example
Query
mutation cardsImportVirtualCard($input: ImportVirtualCardInput!) {
cardsImportVirtualCard(input: $input)
}
Variables
{"input": ImportVirtualCardInput}
Response
{
"data": {
"cardsImportVirtualCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
cardsImportVirtualCards
Description
Import multiple virtual cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns [UUID!]!
Arguments
| Name | Description |
|---|---|
input - [ImportVirtualCardInput!]!
|
Example
Query
mutation cardsImportVirtualCards($input: [ImportVirtualCardInput!]!) {
cardsImportVirtualCards(input: $input)
}
Variables
{"input": [ImportVirtualCardInput]}
Response
{
"data": {
"cardsImportVirtualCards": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
}
cardsMoveCardToTemplate
Description
Move card to a different Template.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- CARD_IS_ALREADY_ATTACH_TO_SAME_TEMPLATE
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - MoveCardToTemplateInput
|
Example
Query
mutation cardsMoveCardToTemplate(
$id: UUID!,
$input: MoveCardToTemplateInput
) {
cardsMoveCardToTemplate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": MoveCardToTemplateInput
}
Response
{"data": {"cardsMoveCardToTemplate": false}}
cardsRemoveComment
Description
remove comment from card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- COMMENT_ALREADY_REMOVED
cardsUpdate
Description
Update card mutation.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_WITH_EXTERNAL_REFERENCE_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCardInput!
|
Example
Query
mutation cardsUpdate(
$id: UUID!,
$input: UpdateCardInput!
) {
cardsUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCardInput
}
Response
{"data": {"cardsUpdate": true}}
cardsUpdateCardProducts
Description
Update card products
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCardProductsInput!
|
Example
Query
mutation cardsUpdateCardProducts(
$id: UUID!,
$input: UpdateCardProductsInput!
) {
cardsUpdateCardProducts(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCardProductsInput
}
Response
{"data": {"cardsUpdateCardProducts": false}}
cardsUpdateLimit
Description
Update card limit.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - FuelLimitInput!
|
Example
Query
mutation cardsUpdateLimit(
$id: UUID!,
$input: FuelLimitInput!
) {
cardsUpdateLimit(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": FuelLimitInput
}
Response
{"data": {"cardsUpdateLimit": false}}
cardsUpdateTemplate
Description
Update a template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateTemplateInput!
|
Example
Query
mutation cardsUpdateTemplate(
$id: UUID!,
$input: UpdateTemplateInput!
) {
cardsUpdateTemplate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateTemplateInput
}
Response
{"data": {"cardsUpdateTemplate": false}}
changeCardPin
use cardsChangePin instead.
Description
Change pin on card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - ChangePinInput!
|
Example
Query
mutation changeCardPin(
$id: UUID!,
$input: ChangePinInput!
) {
changeCardPin(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": ChangePinInput
}
Response
{"data": {"changeCardPin": true}}
chargePointOperatorAddChargeToken
Description
Adds a charge token to a charge point operator
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- TOKEN_IS_PART_OF_CHARGE_POINT_OPERATOR_POOL
- TOKEN_ALREADY_ADDED_TO_CHARGE_POINT_OPERATOR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddChargeTokenToChargePointOperatorInput!
|
Example
Query
mutation chargePointOperatorAddChargeToken(
$id: UUID!,
$input: AddChargeTokenToChargePointOperatorInput!
) {
chargePointOperatorAddChargeToken(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddChargeTokenToChargePointOperatorInput
}
Response
{"data": {"chargePointOperatorAddChargeToken": false}}
chargePointOperatorDisable
Description
Disables a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_POINT_OPERATOR_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
chargePointOperatorDisableChargeToken
Description
Disables a charge token for a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- TOKEN_IS_PART_OF_CHARGE_POINT_OPERATOR_POOL
- TOKEN_ALREADY_DISABLED_FOR_CHARGE_POINT_OPERATOR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - DisableChargeTokenForChargePointOperatorInput!
|
Example
Query
mutation chargePointOperatorDisableChargeToken(
$id: UUID!,
$input: DisableChargeTokenForChargePointOperatorInput!
) {
chargePointOperatorDisableChargeToken(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": DisableChargeTokenForChargePointOperatorInput
}
Response
{"data": {"chargePointOperatorDisableChargeToken": false}}
chargePointOperatorEnable
Description
Enables a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_POINT_OPERATOR_NOT_DISABLED
- INTERNAL_SERVER_ERROR
chargePointOperatorEnableChargeToken
Description
Enables a charge token for a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- TOKEN_IS_PART_OF_CHARGE_POINT_OPERATOR_POOL
- TOKEN_ALREADY_ENABLED_FOR_CHARGE_POINT_OPERATOR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - EnableChargeTokenForChargePointOperatorInput!
|
Example
Query
mutation chargePointOperatorEnableChargeToken(
$id: UUID!,
$input: EnableChargeTokenForChargePointOperatorInput!
) {
chargePointOperatorEnableChargeToken(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": EnableChargeTokenForChargePointOperatorInput
}
Response
{"data": {"chargePointOperatorEnableChargeToken": false}}
chargeRecordAdd
Description
Add Transaction.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_RECORD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddChargeRecordInput!
|
Example
Query
mutation chargeRecordAdd($input: AddChargeRecordInput!) {
chargeRecordAdd(input: $input)
}
Variables
{"input": AddChargeRecordInput}
Response
{
"data": {
"chargeRecordAdd": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
chargeStartCharging
Description
Start charging at a charge point location EVSE.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - StartChargingInput!
|
Example
Query
mutation chargeStartCharging($input: StartChargingInput!) {
chargeStartCharging(input: $input)
}
Variables
{"input": StartChargingInput}
Response
{
"data": {
"chargeStartCharging": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
chargeStopCharging
Description
Stop Charging at the charge point location EVSE based on session ID.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- CHARGING_ALREADY_STOPPED
chargeUnlockChargingConnector
Description
Request the charge location EVSE to unlock the connector.
This command is only allowed to be used by help desk operators at the eMSP. The command will never be available to the end user. The functionality is intended to be used in the rare situation that the connector is not unlocked successfully after a transaction is stopped.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
- ROLE_HELPDESK_OPERATOR
Possible error codes:
- INTERNAL_SERVER_ERROR
closeInvoices
Use invoicesCloseInvoice instead
Description
Close and finalize invoices
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - InvoiceIdInput!
|
Example
Query
mutation closeInvoices($input: InvoiceIdInput!) {
closeInvoices(input: $input)
}
Variables
{"input": InvoiceIdInput}
Response
{"data": {"closeInvoices": false}}
companiesAddUserToOrganizationalComponent
Description
Add an user to Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_DOES_NOT_EXIST
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddUserOrganizationalComponentInput
|
Example
Query
mutation companiesAddUserToOrganizationalComponent(
$id: UUID!,
$input: AddUserOrganizationalComponentInput
) {
companiesAddUserToOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddUserOrganizationalComponentInput
}
Response
{"data": {"companiesAddUserToOrganizationalComponent": false}}
companiesApproveTermsAndConditions
Description
Approve Terms And Conditions by Company
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ALREADY_APPROVED_TERMS_AND_CONDITIONS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CompanyApproveTermsAndConditionsInput!
|
Example
Query
mutation companiesApproveTermsAndConditions($input: CompanyApproveTermsAndConditionsInput!) {
companiesApproveTermsAndConditions(input: $input)
}
Variables
{"input": CompanyApproveTermsAndConditionsInput}
Response
{"data": {"companiesApproveTermsAndConditions": true}}
companiesCreateContactPersonForOrganizationalComponent
Description
Create contact person.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CONTACT_PERSON_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateContactPersonForOrganizationalComponentInput!
|
Example
Query
mutation companiesCreateContactPersonForOrganizationalComponent($input: CreateContactPersonForOrganizationalComponentInput!) {
companiesCreateContactPersonForOrganizationalComponent(input: $input)
}
Variables
{
"input": CreateContactPersonForOrganizationalComponentInput
}
Response
{
"data": {
"companiesCreateContactPersonForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
companiesCreateCreditCheck
Description
Create credit check
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CREDIT_CHECK_ALREADY_EXISTS_FOR_ORGANIZATIONAL_COMPONENT
- CREDIT_CHECK_IS_NOT_AVAILABLE_FOR_ORGANIZATIONAL_COMPONENT
- COUNTRY_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- REGISTRATION_NUMBER_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
companiesCreateGuarantee
Description
Create guarantee for organizational component
Roles:
- ROLE_GUARANTEE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateGuaranteeInput
|
Example
Query
mutation companiesCreateGuarantee($input: CreateGuaranteeInput) {
companiesCreateGuarantee(input: $input)
}
Variables
{"input": CreateGuaranteeInput}
Response
{
"data": {
"companiesCreateGuarantee": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
companiesCreateOrganizationalComponent
Description
Create a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateOrganizationalComponentInput!
|
Example
Query
mutation companiesCreateOrganizationalComponent($input: CreateOrganizationalComponentInput!) {
companiesCreateOrganizationalComponent(input: $input)
}
Variables
{"input": CreateOrganizationalComponentInput}
Response
{
"data": {
"companiesCreateOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
companiesCreateOrganizationalComponentType
Description
Create a Organizational component type.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_TYPE_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - OrganizationalComponentTypeInput!
|
Example
Query
mutation companiesCreateOrganizationalComponentType($input: OrganizationalComponentTypeInput!) {
companiesCreateOrganizationalComponentType(input: $input)
}
Variables
{"input": OrganizationalComponentTypeInput}
Response
{
"data": {
"companiesCreateOrganizationalComponentType": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
companiesCreateSegment
Description
Create a Company segment.
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Possible error codes:
- COMPANY_SEGMENT_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CompanySegmentInput!
|
Example
Query
mutation companiesCreateSegment($input: CompanySegmentInput!) {
companiesCreateSegment(input: $input)
}
Variables
{"input": CompanySegmentInput}
Response
{
"data": {
"companiesCreateSegment": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
companiesDeleteGuarantee
Description
Delete guarantee
Roles:
- ROLE_GUARANTEE_ADMIN
Possible error codes:
- GUARANTEE_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
companiesDeleteOrganizationalComponent
Description
Delete a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_IS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Example
Query
mutation companiesDeleteOrganizationalComponent($id: UUID!) {
companiesDeleteOrganizationalComponent(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"companiesDeleteOrganizationalComponent": true}}
companiesDeleteOrganizationalComponentType
Description
Delete a Organizational component type.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_IS_DELETED
- INTERNAL_SERVER_ERROR
Example
Query
mutation companiesDeleteOrganizationalComponentType($id: UUID!) {
companiesDeleteOrganizationalComponentType(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"companiesDeleteOrganizationalComponentType": true}}
companiesDeleteSegment
Description
Delete a Company segment.
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Possible error codes:
- COMPANY_SEGMENT_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
companiesDisableOrganizationalComponent
Description
Disable a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - OrganizationalComponentDisabledInput
|
Example
Query
mutation companiesDisableOrganizationalComponent(
$id: UUID!,
$input: OrganizationalComponentDisabledInput
) {
companiesDisableOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": OrganizationalComponentDisabledInput
}
Response
{"data": {"companiesDisableOrganizationalComponent": true}}
companiesEnableOrganizationalComponent
Description
Enable a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_NOT_DISABLED
- INTERNAL_SERVER_ERROR
Example
Query
mutation companiesEnableOrganizationalComponent($id: UUID!) {
companiesEnableOrganizationalComponent(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"companiesEnableOrganizationalComponent": true}}
companiesIncreaseCreditLimitTemporarily
Description
Increase credit limit temporarily
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - IncreaseCreditLimitTemporarilyInput
|
Example
Query
mutation companiesIncreaseCreditLimitTemporarily(
$id: UUID!,
$input: IncreaseCreditLimitTemporarilyInput
) {
companiesIncreaseCreditLimitTemporarily(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": IncreaseCreditLimitTemporarilyInput
}
Response
{
"data": {
"companiesIncreaseCreditLimitTemporarily": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
companiesRefreshCreditCheck
Description
Refresh credit check
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CREDIT_CHECK_IS_NOT_AVAILABLE_FOR_ORGANIZATIONAL_COMPONENT
- COUNTRY_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- REGISTRATION_NUMBER_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
companiesRemoveUserFromOrganizationalComponent
Description
Remove an user from Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- USER_IS_NOT_EMPLOYEE_OF_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - RemoveUserFromOrganizationalComponentInput
|
Example
Query
mutation companiesRemoveUserFromOrganizationalComponent(
$id: UUID!,
$input: RemoveUserFromOrganizationalComponentInput
) {
companiesRemoveUserFromOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": RemoveUserFromOrganizationalComponentInput
}
Response
{"data": {"companiesRemoveUserFromOrganizationalComponent": true}}
companiesUpdateContactPersonForOrganizationalComponent
Description
Update contact person.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateContactPersonForOrganizationalComponentInput!
|
Example
Query
mutation companiesUpdateContactPersonForOrganizationalComponent(
$id: UUID!,
$input: UpdateContactPersonForOrganizationalComponentInput!
) {
companiesUpdateContactPersonForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateContactPersonForOrganizationalComponentInput
}
Response
{"data": {"companiesUpdateContactPersonForOrganizationalComponent": false}}
companiesUpdateCreditLimitForOrganizationalComponent
Description
Update credit limit for organizational component
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCreditLimitForOrganizationalComponentInput
|
Example
Query
mutation companiesUpdateCreditLimitForOrganizationalComponent(
$id: UUID!,
$input: UpdateCreditLimitForOrganizationalComponentInput
) {
companiesUpdateCreditLimitForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCreditLimitForOrganizationalComponentInput
}
Response
{"data": {"companiesUpdateCreditLimitForOrganizationalComponent": false}}
companiesUpdateGuarantee
Description
Create guarantee for organizational component
Roles:
- ROLE_GUARANTEE_ADMIN
Possible error codes:
- GUARANTEE_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateGuaranteeInput
|
Example
Query
mutation companiesUpdateGuarantee(
$id: UUID!,
$input: UpdateGuaranteeInput
) {
companiesUpdateGuarantee(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateGuaranteeInput
}
Response
{"data": {"companiesUpdateGuarantee": false}}
companiesUpdateIdentificationNumberForKilometreCharge
Description
Update Company Identification Number For Kilometre Charge Provider. When calling this mutation the existing data will be overwritten.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCompanyIdentificationNumberInput
|
Example
Query
mutation companiesUpdateIdentificationNumberForKilometreCharge(
$id: UUID!,
$input: UpdateCompanyIdentificationNumberInput
) {
companiesUpdateIdentificationNumberForKilometreCharge(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCompanyIdentificationNumberInput
}
Response
{"data": {"companiesUpdateIdentificationNumberForKilometreCharge": true}}
companiesUpdateOrganizationalComponent
Description
Update a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INVALID_INVOICEABLE_COMPANY_ID
- INVALID_INVOICEABLE_COMPANY_ID_AS_SELF
- ORGANIZATIONAL_COMPONENT_ALREADY_DELETED
- ORGANIZATIONAL_COMPONENT_INVALID_UPLOAD_CONTRACT
- APPROVED_MANDATES_NOT_AVAILABLE
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateOrganizationalComponentInput
|
Example
Query
mutation companiesUpdateOrganizationalComponent(
$id: UUID!,
$input: UpdateOrganizationalComponentInput
) {
companiesUpdateOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateOrganizationalComponentInput
}
Response
{"data": {"companiesUpdateOrganizationalComponent": true}}
companiesUpdateOrganizationalComponentType
Description
Update a Organizational component type by ID.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_TYPE_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - OrganizationalComponentTypeInput!
|
Example
Query
mutation companiesUpdateOrganizationalComponentType(
$id: UUID!,
$input: OrganizationalComponentTypeInput!
) {
companiesUpdateOrganizationalComponentType(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": OrganizationalComponentTypeInput
}
Response
{"data": {"companiesUpdateOrganizationalComponentType": false}}
companyApproveTermsAndConditions
Use companiesApproveTermsAndConditions instead
Description
Approve Terms And Conditions by Company
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ALREADY_APPROVED_TERMS_AND_CONDITIONS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CompanyApproveTermsAndConditionsInput!
|
Example
Query
mutation companyApproveTermsAndConditions($input: CompanyApproveTermsAndConditionsInput!) {
companyApproveTermsAndConditions(input: $input)
}
Variables
{"input": CompanyApproveTermsAndConditionsInput}
Response
{"data": {"companyApproveTermsAndConditions": true}}
companyUpdateSegment
Description
Update a Company segment.
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Possible error codes:
- COMPANY_SEGMENT_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CompanySegmentInput!
|
Example
Query
mutation companyUpdateSegment(
$id: UUID!,
$input: CompanySegmentInput!
) {
companyUpdateSegment(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CompanySegmentInput
}
Response
{"data": {"companyUpdateSegment": false}}
confirmTwoFactorAuthentication
Use authConfirmTwoFactorAuthentication instead
Description
Confirms two factor authentication enabling process.
Possible error codes:
- TWO_FACTOR_AUTHENTICATION_NOT_ENABLED
- TWO_FACTOR_AUTHENTICATION_ALREADY_CONFIRMED
- INVALID_TWO_FACTOR_AUTHENTICATION_CODE
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - ConfirmTwoFactorAuthenticationInput
|
Example
Query
mutation confirmTwoFactorAuthentication($input: ConfirmTwoFactorAuthenticationInput) {
confirmTwoFactorAuthentication(input: $input)
}
Variables
{"input": ConfirmTwoFactorAuthenticationInput}
Response
{"data": {"confirmTwoFactorAuthentication": false}}
createAddressForGasStation
Use addressesCreateAddressForGasStation instead
Description
Create address for gas station
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- GAS_STATION_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForGasStationInput!
|
Example
Query
mutation createAddressForGasStation($input: CreateAddressForGasStationInput!) {
createAddressForGasStation(input: $input)
}
Variables
{"input": CreateAddressForGasStationInput}
Response
{
"data": {
"createAddressForGasStation": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createAddressForOrganizationalComponent
Use addressesCreateAddressForOrganizationalComponent instead
Description
Create Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForOrganizationalComponentInput!
|
Example
Query
mutation createAddressForOrganizationalComponent($input: CreateAddressForOrganizationalComponentInput!) {
createAddressForOrganizationalComponent(input: $input)
}
Variables
{"input": CreateAddressForOrganizationalComponentInput}
Response
{
"data": {
"createAddressForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createAddressForTenant
Use addressesCreateAddressForTenant instead
Description
Create address for tenant
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- TENANT_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForTenantInput!
|
Example
Query
mutation createAddressForTenant($input: CreateAddressForTenantInput!) {
createAddressForTenant(input: $input)
}
Variables
{"input": CreateAddressForTenantInput}
Response
{
"data": {
"createAddressForTenant": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createAddressForUser
Use addressesCreateAddressForUser instead
Description
Create Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- USER_LIVING_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateAddressForUserInput!
|
Example
Query
mutation createAddressForUser($input: CreateAddressForUserInput!) {
createAddressForUser(input: $input)
}
Variables
{"input": CreateAddressForUserInput}
Response
{
"data": {
"createAddressForUser": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createAnonymousUser
use userCreateAnonymous instead
Description
Create anonymous user
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - AnonymousUserInput
|
Example
Query
mutation createAnonymousUser($input: AnonymousUserInput) {
createAnonymousUser(input: $input)
}
Variables
{"input": AnonymousUserInput}
Response
{"data": {"createAnonymousUser": "abc123"}}
createCard
use cardsCreateCard instead.
Description
Create card mutation.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_CREATION_IS_DISABLED_WHEN_GUARANTEE_NOT_VALID
- CARD_WITH_EXTERNAL_REFERENCE_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateCardInput!
|
Example
Query
mutation createCard($input: CreateCardInput!) {
createCard(input: $input)
}
Variables
{"input": CreateCardInput}
Response
{
"data": {
"createCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createCategory
Use
productsCreateCategory instead. Description
Create a new category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- CATEGORY_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateCategoryInput!
|
Example
Query
mutation createCategory($input: CreateCategoryInput!) {
createCategory(input: $input)
}
Variables
{"input": CreateCategoryInput}
Response
{
"data": {
"createCategory": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createChargeToken
Create charge tokens through creating cards instead.
Description
Creates a charge token.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateChargeTokenInput!
|
Example
Query
mutation createChargeToken($input: CreateChargeTokenInput!) {
createChargeToken(input: $input)
}
Variables
{"input": CreateChargeTokenInput}
Response
{
"data": {
"createChargeToken": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createCompanySegment
Use companiesCreateSegment instead
Description
Create a Company segment.
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Possible error codes:
- COMPANY_SEGMENT_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CompanySegmentInput!
|
Example
Query
mutation createCompanySegment($input: CompanySegmentInput!) {
createCompanySegment(input: $input)
}
Variables
{"input": CompanySegmentInput}
Response
{
"data": {
"createCompanySegment": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createContactPersonForOrganizationalComponent
Use companiesCreateContactPersonForOrganizationalComponent instead
Description
Create contact person.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CONTACT_PERSON_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateContactPersonForOrganizationalComponentInput!
|
Example
Query
mutation createContactPersonForOrganizationalComponent($input: CreateContactPersonForOrganizationalComponentInput!) {
createContactPersonForOrganizationalComponent(input: $input)
}
Variables
{
"input": CreateContactPersonForOrganizationalComponentInput
}
Response
{
"data": {
"createContactPersonForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createCreditCheck
Use companiesCreateCreditCheck instead
Description
Create credit check
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- REGISTRATION_NUMBER_NOT_FOUND_FOR_ORGANIZATIONAL_COMPONENT
- CREDIT_CHECK_ALREADY_EXISTS_FOR_ORGANIZATIONAL_COMPONENT
- CREDIT_CHECK_IS_NOT_AVAILABLE_FOR_ORGANIZATIONAL_COMPONENT
- COUNTRY_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- REGISTRATION_NUMBER_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
createCreditInvoice
Use invoicesCreateCreditInvoice instead
Description
Create credit invoice.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - CreateCreditInvoiceInput!
|
Example
Query
mutation createCreditInvoice($input: CreateCreditInvoiceInput!) {
createCreditInvoice(input: $input)
}
Variables
{"input": CreateCreditInvoiceInput}
Response
{"data": {"createCreditInvoice": false}}
createExport
Use invoicesCreateExport instead
Description
Create export data.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INVALID_FIELDS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateExportInput!
|
Example
Query
mutation createExport($input: CreateExportInput!) {
createExport(input: $input)
}
Variables
{"input": CreateExportInput}
Response
{
"data": {
"createExport": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createField
use metadataCreateField instead.
Description
Create a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateFieldInput!
|
Example
Query
mutation createField($input: CreateFieldInput!) {
createField(input: $input)
}
Variables
{"input": CreateFieldInput}
Response
{
"data": {
"createField": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createGasStation
use gasStationsCreate instead.
Description
Creates a new gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_UUID
- INVALID_URL
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateGasStationInput!
|
Example
Query
mutation createGasStation($input: CreateGasStationInput!) {
createGasStation(input: $input)
}
Variables
{"input": CreateGasStationInput}
Response
{
"data": {
"createGasStation": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createGuarantee
Use companiesCreateGuarantee instead
Description
Create guarantee for organizational component
Roles:
- ROLE_GUARANTEE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateGuaranteeInput
|
Example
Query
mutation createGuarantee($input: CreateGuaranteeInput) {
createGuarantee(input: $input)
}
Variables
{"input": CreateGuaranteeInput}
Response
{
"data": {
"createGuarantee": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createHub
use hubCreate instead
Description
Create a new hub
Roles:
- ROLE_HUB_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateHubInput!
|
Example
Query
mutation createHub($input: CreateHubInput!) {
createHub(input: $input)
}
Variables
{"input": CreateHubInput}
Response
{
"data": {
"createHub": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createInvoiceAddressForOrganizationalComponent
Use addressesCreateInvoiceAddressForOrganizationalComponent instead
Description
Create Invoice Address for Company
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_INVOICE_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateInvoiceAddressForOrganizationalComponentInput!
|
Example
Query
mutation createInvoiceAddressForOrganizationalComponent($input: CreateInvoiceAddressForOrganizationalComponentInput!) {
createInvoiceAddressForOrganizationalComponent(input: $input)
}
Variables
{
"input": CreateInvoiceAddressForOrganizationalComponentInput
}
Response
{
"data": {
"createInvoiceAddressForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createInvoiceAddressForUser
Use addressesCreateInvoiceAddressForUser instead
Description
Create Invoice Address for User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- USER_INVOICE_ADDRESS_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - InvoiceAddressForUserInput!
|
Example
Query
mutation createInvoiceAddressForUser($input: InvoiceAddressForUserInput!) {
createInvoiceAddressForUser(input: $input)
}
Variables
{"input": InvoiceAddressForUserInput}
Response
{
"data": {
"createInvoiceAddressForUser": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createLegalEntity
Use
paymentsCreateLegalEntity instead. Description
Create a new legal entity for tenant
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CreateLegalEntityInput!
|
Example
Query
mutation createLegalEntity($input: CreateLegalEntityInput!) {
createLegalEntity(input: $input)
}
Variables
{"input": CreateLegalEntityInput}
Response
{"data": {"createLegalEntity": false}}
createMandateForOrganizationalComponent
Use
paymentsCreateMandateForOrganizationalComponent instead. Description
Create a new mandate
Roles:
- ROLE_MANDATE_ADMIN
Possible error codes:
- INVALID_UUID
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateMandateForOrganizationalComponentInput!
|
Example
Query
mutation createMandateForOrganizationalComponent($input: CreateMandateForOrganizationalComponentInput!) {
createMandateForOrganizationalComponent(input: $input)
}
Variables
{"input": CreateMandateForOrganizationalComponentInput}
Response
{
"data": {
"createMandateForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createOrder
use OrdersCreateOrder instead.
Description
Creates a new order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_CREATION_IS_DISABLED_DUE_TO_GUARANTEE_NOT_VALID
- ORDER_CREATION_INPUTS_ARE_NOT_VALID
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateOrderInput!
|
Example
Query
mutation createOrder($input: CreateOrderInput!) {
createOrder(input: $input)
}
Variables
{"input": CreateOrderInput}
Response
{
"data": {
"createOrder": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createOrganizationalComponent
Use companiesCreateOrganizationalComponent instead
Description
Create a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateOrganizationalComponentInput!
|
Example
Query
mutation createOrganizationalComponent($input: CreateOrganizationalComponentInput!) {
createOrganizationalComponent(input: $input)
}
Variables
{"input": CreateOrganizationalComponentInput}
Response
{
"data": {
"createOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createOrganizationalComponentType
Use companiesCreateOrganizationalComponentType instead
Description
Create a Organizational component type.
Roles:
*ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_TYPE_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - OrganizationalComponentTypeInput!
|
Example
Query
mutation createOrganizationalComponentType($input: OrganizationalComponentTypeInput!) {
createOrganizationalComponentType(input: $input)
}
Variables
{"input": OrganizationalComponentTypeInput}
Response
{
"data": {
"createOrganizationalComponentType": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createPackage
Use
productsCreatePackage instead. Description
Create a new package.
Roles:
- ROLE_PACKAGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreatePackageInput!
|
Example
Query
mutation createPackage($input: CreatePackageInput!) {
createPackage(input: $input)
}
Variables
{"input": CreatePackageInput}
Response
{
"data": {
"createPackage": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createPriceModification
use priceModificationCreate instead.
Description
Create a new Price Modification
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreatePriceModificationInput!
|
Example
Query
mutation createPriceModification($input: CreatePriceModificationInput!) {
createPriceModification(input: $input)
}
Variables
{"input": CreatePriceModificationInput}
Response
{
"data": {
"createPriceModification": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createProduct
Use
productsCreate instead. Description
Create a new product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateProductInput!
|
Example
Query
mutation createProduct($input: CreateProductInput!) {
createProduct(input: $input)
}
Variables
{"input": CreateProductInput}
Response
{
"data": {
"createProduct": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createReplacementCard
use cardsCreateReplacementCard instead.
Description
Create Replacement Card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CreateReplacementCardInput!
|
Example
Query
mutation createReplacementCard(
$id: UUID!,
$input: CreateReplacementCardInput!
) {
createReplacementCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CreateReplacementCardInput
}
Response
{
"data": {
"createReplacementCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createShippingAddressForOrganizationalComponent
Use addressesCreateShippingAddressForOrganizationalComponent instead
Description
Create Shipping Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ShippingAddressForOrganizationalComponentInput!
|
Example
Query
mutation createShippingAddressForOrganizationalComponent($input: ShippingAddressForOrganizationalComponentInput!) {
createShippingAddressForOrganizationalComponent(input: $input)
}
Variables
{"input": ShippingAddressForOrganizationalComponentInput}
Response
{
"data": {
"createShippingAddressForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createShippingAddressForUser
Use addressesCreateShippingAddressForUser instead
Description
Create Shipping Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ShippingAddressForUserInput!
|
Example
Query
mutation createShippingAddressForUser($input: ShippingAddressForUserInput!) {
createShippingAddressForUser(input: $input)
}
Variables
{"input": ShippingAddressForUserInput}
Response
{
"data": {
"createShippingAddressForUser": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createTemplate
use cardsCreateTemplate instead.
Description
Create a template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateTemplateInput!
|
Example
Query
mutation createTemplate($input: CreateTemplateInput!) {
createTemplate(input: $input)
}
Variables
{"input": CreateTemplateInput}
Response
{
"data": {
"createTemplate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createTenant
use tenantCreate instead.
Description
Creates the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateTenantInput!
|
Example
Query
mutation createTenant($input: CreateTenantInput!) {
createTenant(input: $input)
}
Variables
{"input": CreateTenantInput}
Response
{
"data": {
"createTenant": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createTermsAndConditions
use tenantCreateTermsAndConditions instead.
Description
Create Terms And Conditions entity for Tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TERMS_ALREADY_EXIST
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateTermsAndConditionsInput!
|
Example
Query
mutation createTermsAndConditions($input: CreateTermsAndConditionsInput!) {
createTermsAndConditions(input: $input)
}
Variables
{"input": CreateTermsAndConditionsInput}
Response
{
"data": {
"createTermsAndConditions": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
createUnauthenticatableUser
use userCreateUnauthenticated instead
Description
Create Unauthenticated user
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - CreateUnauthenticatableUser
|
Example
Query
mutation createUnauthenticatableUser($input: CreateUnauthenticatableUser) {
createUnauthenticatableUser(input: $input)
}
Variables
{"input": CreateUnauthenticatableUser}
Response
{
"data": {
"createUnauthenticatableUser": "abc123"
}
}
createUser
Use authCreateUser instead
Description
Create user.
Possible error codes:
- USER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - CreateUser
|
Example
Query
mutation createUser($input: CreateUser) {
createUser(input: $input)
}
Variables
{"input": CreateUser}
Response
{"data": {"createUser": "xyz789"}}
createUserWithVirtualCard
use userCreateWithVirtualCard instead
Description
Create anonymous user with virtual card
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - UserWithVirtualCardInput
|
Example
Query
mutation createUserWithVirtualCard($input: UserWithVirtualCardInput) {
createUserWithVirtualCard(input: $input)
}
Variables
{"input": UserWithVirtualCardInput}
Response
{
"data": {
"createUserWithVirtualCard": "abc123"
}
}
createWebhook
use webhookCreate instead
Description
Create Webhook mutation
Roles:
- ROLE_WEBHOOK_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a WebhookResponse!
Arguments
| Name | Description |
|---|---|
input - WebhookCreateInput!
|
Example
Query
mutation createWebhook($input: WebhookCreateInput!) {
createWebhook(input: $input) {
id
signature
}
}
Variables
{"input": WebhookCreateInput}
Response
{
"data": {
"createWebhook": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"signature": "abc123"
}
}
}
deactivateGasStation
use gasStationsDeactivate instead.
Description
Deactivates a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- GAS_STATION_ALREADY_DEACTIVATED
- INTERNAL_SERVER_ERROR
deactivateUser
use userDeactivate instead
Description
Deactivate user
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_DEACTIVATED
- INTERNAL_SERVER_ERROR
deleteAddressForGasStation
Use addressesDeleteAddressForGasStation instead
Description
Delete Address For GasStation
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - deleteAddressForGasStationInput!
|
Example
Query
mutation deleteAddressForGasStation(
$id: UUID!,
$input: deleteAddressForGasStationInput!
) {
deleteAddressForGasStation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": deleteAddressForGasStationInput
}
Response
{"data": {"deleteAddressForGasStation": true}}
deleteAddressForOrganizationalComponent
Use addressesDeleteAddressForOrganizationalComponent instead
Description
Delete Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ORGANIZATIONAL_COMPONENT_UPDATE_ADDRESS
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - deleteAddressForOrganizationalComponentInput!
|
Example
Query
mutation deleteAddressForOrganizationalComponent(
$id: UUID!,
$input: deleteAddressForOrganizationalComponentInput!
) {
deleteAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": deleteAddressForOrganizationalComponentInput
}
Response
{"data": {"deleteAddressForOrganizationalComponent": true}}
deleteAddressForTenant
Use addressesDeleteAddressForTenant instead
Description
Delete Address For Tenant
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - deleteAddressForTenantInput!
|
Example
Query
mutation deleteAddressForTenant(
$id: UUID!,
$input: deleteAddressForTenantInput!
) {
deleteAddressForTenant(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": deleteAddressForTenantInput
}
Response
{"data": {"deleteAddressForTenant": true}}
deleteAssociation
use priceModificationDeleteAssociation instead.
Description
Delete an existing price modification association
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
deleteCategory
Use
productsDeleteCategory instead. Description
Delete category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- CATEGORY_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteCompanySegment
Use companiesDeleteSegment instead
Description
Delete a Company segment.
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Possible error codes:
- COMPANY_SEGMENT_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteField
use metadataDeleteField instead.
Description
Delete a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_ALREADY_DELETED
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
deleteGasStation
use gasStationsDelete instead.
Description
Deletes a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- GAS_STATION_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteGuarantee
Use companiesDeleteGuarantee instead
Description
Delete guarantee
Roles:
- ROLE_GUARANTEE_ADMIN
Possible error codes:
- GUARANTEE_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteMetadata
use metadataDelete instead.
Description
Delete a metadata.
Roles:
- ROLE_METADATA_ADMIN
Possible error codes:
- METADATA_ALREADY_DELETED
- METADATA_NOT_FOUND
- INTERNAL_SERVER_ERROR
deleteOrganizationalComponent
Use companiesDeleteOrganizationalComponent instead
Description
Delete a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_IS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteOrganizationalComponentType
Use companiesDeleteOrganizationalComponentType instead
Description
Delete a Organizational component type.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_IS_DELETED
- INTERNAL_SERVER_ERROR
Example
Query
mutation deleteOrganizationalComponentType($id: UUID!) {
deleteOrganizationalComponentType(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"deleteOrganizationalComponentType": true}}
deletePackage
Use
productsDeletePackage instead. Description
Delete a package.
Roles:
- ROLE_PACKAGE_ADMIN
Possible error codes:
- PACKAGE_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deletePhoneNumber
use userDeletePhoneNumber instead
Description
delete phone number to the current authenticated user. Possible error codes:
- PHONE_NUMBER_ALREADY_DELETED
- PHONE_NUMBER_DOES_NOT_EXISTS
- INTERNAL_SERVER_ERROR
deletePhoneNumberForTenant
use tenantDeletePhoneNumber instead.
Description
Delete phone number of tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
deletePriceModification
use priceModificationDelete instead.
Description
Delete an existing Price Modification
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
deleteProduct
Use
productsDelete instead. Description
Delete a product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- PRODUCT_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteUser
use userDelete instead
Description
Deletes the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
deleteWebhook
use webhookDelete instead
Description
Delete Webhook mutation
Roles:
- ROLE_WEBHOOK_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- WEBHOOK_IS_ALREADY_DELETED
disableCard
use cardsDisable instead.
Description
Disable a Card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - DisableCardInput
|
Example
Query
mutation disableCard(
$id: UUID!,
$input: DisableCardInput
) {
disableCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": DisableCardInput
}
Response
{"data": {"disableCard": true}}
disableCards
use cardsDisableCards instead.
Description
Disable multiple Cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - [UUID!]!
|
|
input - DisableCardInput
|
Example
Query
mutation disableCards(
$id: [UUID!]!,
$input: DisableCardInput
) {
disableCards(
id: $id,
input: $input
)
}
Variables
{
"id": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"input": DisableCardInput
}
Response
{"data": {"disableCards": false}}
disableChargePointOperator
Description
Disables a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_POINT_OPERATOR_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
disableChargeToken
Disable charge tokens through disabling cards instead
Description
Disables a charge token
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_TOKEN_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
disableChargeTokenForChargePointOperator
Use chargePointOperatorDisableChargeToken instead
Description
Disables a charge token for a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- TOKEN_IS_PART_OF_CHARGE_POINT_OPERATOR_POOL
- TOKEN_ALREADY_DISABLED_FOR_CHARGE_POINT_OPERATOR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - DisableChargeTokenForChargePointOperatorInput!
|
Example
Query
mutation disableChargeTokenForChargePointOperator(
$id: UUID!,
$input: DisableChargeTokenForChargePointOperatorInput!
) {
disableChargeTokenForChargePointOperator(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": DisableChargeTokenForChargePointOperatorInput
}
Response
{"data": {"disableChargeTokenForChargePointOperator": true}}
disableField
use metadataDisableField instead.
Description
Disable a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_ALREADY_DISABLED
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
disableOrganizationalComponent
Use companiesDisableOrganizationalComponent instead
Description
Disable a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - OrganizationalComponentDisabledInput
|
Example
Query
mutation disableOrganizationalComponent(
$id: UUID!,
$input: OrganizationalComponentDisabledInput
) {
disableOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": OrganizationalComponentDisabledInput
}
Response
{"data": {"disableOrganizationalComponent": false}}
disableTemplate
use cardsDisableTemplate instead.
Description
Disable a Template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- TEMPLATE_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
disableTenant
use tenantDisable instead.
Description
Disables the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TENANT_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
disableTwoFactorAuthentication
Use authDisableTwoFactorAuthentication instead
Description
Starts process of disabling two factor authentication.
Possible error codes:
- TWO_FACTOR_AUTHENTICATION_NOT_ENABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Example
Query
mutation disableTwoFactorAuthentication {
disableTwoFactorAuthentication
}
Response
{"data": {"disableTwoFactorAuthentication": true}}
disableUser
use userDisable instead
Description
Disables the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UserDisabledInput!
|
Example
Query
mutation disableUser(
$id: UUID!,
$input: UserDisabledInput!
) {
disableUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UserDisabledInput
}
Response
{"data": {"disableUser": false}}
enableCard
use cardsEnable instead.
Description
Enable a Card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_NOT_DISABLED
- INTERNAL_SERVER_ERROR
enableCards
use cardsEnableCards instead.
Description
Enable multiple Cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- CARD_NOT_DISABLED
- INTERNAL_SERVER_ERROR
enableChargePointOperator
Use chargePointOperatorEnable instead
Description
Enables a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_POINT_OPERATOR_NOT_DISABLED
- INTERNAL_SERVER_ERROR
enableChargeToken
Enable charge tokens through enabling cards instead
Description
Enables a charge token
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- CHARGE_TOKEN_NOT_DISABLED
- INTERNAL_SERVER_ERROR
enableChargeTokenForCard
use cardsEnableChargeTokenForCard instead.
Description
Enable Charge token for card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - EnableChargeTokenForCardInput!
|
Example
Query
mutation enableChargeTokenForCard(
$id: UUID!,
$input: EnableChargeTokenForCardInput!
) {
enableChargeTokenForCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": EnableChargeTokenForCardInput
}
Response
{"data": {"enableChargeTokenForCard": true}}
enableChargeTokenForChargePointOperator
Use chargePointOperatorEnableChargeToken instead
Description
Enables a charge token for a charge point operator.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- TOKEN_IS_PART_OF_CHARGE_POINT_OPERATOR_POOL
- TOKEN_ALREADY_ENABLED_FOR_CHARGE_POINT_OPERATOR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - EnableChargeTokenForChargePointOperatorInput!
|
Example
Query
mutation enableChargeTokenForChargePointOperator(
$id: UUID!,
$input: EnableChargeTokenForChargePointOperatorInput!
) {
enableChargeTokenForChargePointOperator(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": EnableChargeTokenForChargePointOperatorInput
}
Response
{"data": {"enableChargeTokenForChargePointOperator": false}}
enableField
use metadataEnableField instead.
Description
Enable a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_NOT_DISABLED
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
enableFuelForCard
use cardsEnableFuelForCard instead.
Description
Enable fuel for card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - EnableFuelForCardInput!
|
Example
Query
mutation enableFuelForCard(
$id: UUID!,
$input: EnableFuelForCardInput!
) {
enableFuelForCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": EnableFuelForCardInput
}
Response
{"data": {"enableFuelForCard": true}}
enableOrganizationalComponent
Use companiesEnableOrganizationalComponent instead
Description
Enable a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_NOT_DISABLED
- INTERNAL_SERVER_ERROR
enableTemplate
use cardsEnableTemplate instead.
Description
Enable a Template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- TEMPLATE_NOT_DISABLED
- INTERNAL_SERVER_ERROR
enableTenant
use tenantEnable instead.
Description
Enables the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TENANT_ALREADY_ENABLED
- INTERNAL_SERVER_ERROR
enableTwoFactorAuthentication
Use authEnableTwoFactorAuthentication instead
Description
Starts process of enabling two factor authentication.
Possible error codes:
- TWO_FACTOR_AUTHENTICATION_ALREADY_ENABLED
- INTERNAL_SERVER_ERROR
Response
Returns a TwoFactorAuthenticationResponse!
Example
Query
mutation enableTwoFactorAuthentication {
enableTwoFactorAuthentication {
image
url
}
}
Response
{
"data": {
"enableTwoFactorAuthentication": {
"image": "xyz789",
"url": "abc123"
}
}
}
enableUser
use userEnable instead
Description
Enables the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_ENABLED
- INTERNAL_SERVER_ERROR
expenseReportActivateCompany
Description
Activate a company
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_COMPANY
expenseReportAddTokenizedCardToCompany
Description
Add tokenized card to existing company
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_COMPANY
- TOKEN_ALREADY_EXISTS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddTokenizedCardToCompanyInput!
|
Example
Query
mutation expenseReportAddTokenizedCardToCompany($input: AddTokenizedCardToCompanyInput!) {
expenseReportAddTokenizedCardToCompany(input: $input)
}
Variables
{"input": AddTokenizedCardToCompanyInput}
Response
{
"data": {
"expenseReportAddTokenizedCardToCompany": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
expenseReportAddTransaction
Description
Add Transaction to Expense Report
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TRANSACTION_ALREADY_EXISTS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddExpenseReportTransactionInput!
|
Example
Query
mutation expenseReportAddTransaction($input: AddExpenseReportTransactionInput!) {
expenseReportAddTransaction(input: $input)
}
Variables
{"input": AddExpenseReportTransactionInput}
Response
{
"data": {
"expenseReportAddTransaction": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
expenseReportCreateCompany
Description
Add a new company for expense tracking.
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- COMPANY_ALREADY_EXISTS_WITH_GIVEN_VAT_NUMBER
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddCompanyForExpenseTrackingInput!
|
Example
Query
mutation expenseReportCreateCompany($input: AddCompanyForExpenseTrackingInput!) {
expenseReportCreateCompany(input: $input)
}
Variables
{"input": AddCompanyForExpenseTrackingInput}
Response
{
"data": {
"expenseReportCreateCompany": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
expenseReportImportCard
Description
Import expense report card
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ImportExpenseReportCardInput!
|
Example
Query
mutation expenseReportImportCard($input: ImportExpenseReportCardInput!) {
expenseReportImportCard(input: $input)
}
Variables
{"input": ImportExpenseReportCardInput}
Response
{
"data": {
"expenseReportImportCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
expenseReportRemoveTokenizedCardFromCompany
Description
Remove existing tokenized card from company
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_DATA
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RemoveTokenizedCardFromCompanyInput!
|
Example
Query
mutation expenseReportRemoveTokenizedCardFromCompany($input: RemoveTokenizedCardFromCompanyInput!) {
expenseReportRemoveTokenizedCardFromCompany(input: $input)
}
Variables
{"input": RemoveTokenizedCardFromCompanyInput}
Response
{"data": {"expenseReportRemoveTokenizedCardFromCompany": true}}
expenseReportUpdateTokenizedCard
Description
Update existing tokenized card
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_DATA
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateTokenizedCardInput!
|
Example
Query
mutation expenseReportUpdateTokenizedCard($input: UpdateTokenizedCardInput!) {
expenseReportUpdateTokenizedCard(input: $input)
}
Variables
{"input": UpdateTokenizedCardInput}
Response
{"data": {"expenseReportUpdateTokenizedCard": false}}
fuelCardsAddTransaction
Description
Add Fuel Card Transaction
Roles:
- ROLE_FUEL_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TRANSACTION_ALREADY_EXISTS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddFuelTransactionInput!
|
Example
Query
mutation fuelCardsAddTransaction($input: AddFuelTransactionInput!) {
fuelCardsAddTransaction(input: $input)
}
Variables
{"input": AddFuelTransactionInput}
Response
{
"data": {
"fuelCardsAddTransaction": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
fuelCardsSendIFSFMessage
Description
Send IFSF message to EFAS
Roles:
- SEND_IFSF_MESSAGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- FUEL_CARD_NOT_FOUND
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - SendIFSFMessageInput!
|
Example
Query
mutation fuelCardsSendIFSFMessage($input: SendIFSFMessageInput!) {
fuelCardsSendIFSFMessage(input: $input)
}
Variables
{"input": SendIFSFMessageInput}
Response
{
"data": {
"fuelCardsSendIFSFMessage": "abc123"
}
}
gasStationsActivate
Description
Activates a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- GAS_STATION_ALREADY_ACTIVATED
- INTERNAL_SERVER_ERROR
gasStationsAddExternalId
Description
Add external id to a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddExternalIdToGasStationInput!
|
Example
Query
mutation gasStationsAddExternalId($input: AddExternalIdToGasStationInput!) {
gasStationsAddExternalId(input: $input)
}
Variables
{"input": AddExternalIdToGasStationInput}
Response
{"data": {"gasStationsAddExternalId": false}}
gasStationsAddProductToGasStation
Description
Adds a product to a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddProductToGasStationInput!
|
Example
Query
mutation gasStationsAddProductToGasStation($input: AddProductToGasStationInput!) {
gasStationsAddProductToGasStation(input: $input)
}
Variables
{"input": AddProductToGasStationInput}
Response
{"data": {"gasStationsAddProductToGasStation": false}}
gasStationsCreate
Description
Creates a new gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_UUID
- INVALID_URL
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateGasStationInput!
|
Example
Query
mutation gasStationsCreate($input: CreateGasStationInput!) {
gasStationsCreate(input: $input)
}
Variables
{"input": CreateGasStationInput}
Response
{
"data": {
"gasStationsCreate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
gasStationsDeactivate
Description
Deactivates a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- GAS_STATION_ALREADY_DEACTIVATED
- INTERNAL_SERVER_ERROR
gasStationsDelete
Description
Deletes a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- GAS_STATION_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
gasStationsUpdate
Description
Updates a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_UUID
- INVALID_URL
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateGasStationInput!
|
Example
Query
mutation gasStationsUpdate(
$id: UUID!,
$input: UpdateGasStationInput!
) {
gasStationsUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateGasStationInput
}
Response
{"data": {"gasStationsUpdate": false}}
hubCreate
Description
Create a new hub
Roles:
- ROLE_HUB_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateHubInput!
|
Example
Query
mutation hubCreate($input: CreateHubInput!) {
hubCreate(input: $input)
}
Variables
{"input": CreateHubInput}
Response
{
"data": {
"hubCreate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
hubUpdate
Description
Update a hub
Roles:
- ROLE_HUB_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateHubInput!
|
Example
Query
mutation hubUpdate(
$id: UUID!,
$input: UpdateHubInput!
) {
hubUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateHubInput
}
Response
{"data": {"hubUpdate": false}}
importCard
use cardsImportCard instead.
Description
Create card mutation for import cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_CREATION_IS_DISABLED_WHEN_GUARANTEE_NOT_VALID
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ImportCardInput!
|
Example
Query
mutation importCard($input: ImportCardInput!) {
importCard(input: $input)
}
Variables
{"input": ImportCardInput}
Response
{
"data": {
"importCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
importExpenseReportCard
Use expenseReportImportCard instead
Description
Import expense report card
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ImportExpenseReportCardInput!
|
Example
Query
mutation importExpenseReportCard($input: ImportExpenseReportCardInput!) {
importExpenseReportCard(input: $input)
}
Variables
{"input": ImportExpenseReportCardInput}
Response
{
"data": {
"importExpenseReportCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
importUser
use userImport instead
Description
Import new user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- PHONE_NUMBER_ALREADY_EXISTS
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ImportUserInput
|
Example
Query
mutation importUser($input: ImportUserInput) {
importUser(input: $input)
}
Variables
{"input": ImportUserInput}
Response
{"data": {"importUser": "abc123"}}
importVirtualCard
use cardsImportVirtualCard instead.
Description
Import virtual card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - ImportVirtualCardInput!
|
Example
Query
mutation importVirtualCard($input: ImportVirtualCardInput!) {
importVirtualCard(input: $input)
}
Variables
{"input": ImportVirtualCardInput}
Response
{
"data": {
"importVirtualCard": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
importVirtualCards
use cardsImportVirtualCards instead.
Description
Import multiple virtual cards.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns [UUID!]!
Arguments
| Name | Description |
|---|---|
input - [ImportVirtualCardInput!]!
|
Example
Query
mutation importVirtualCards($input: [ImportVirtualCardInput!]!) {
importVirtualCards(input: $input)
}
Variables
{"input": [ImportVirtualCardInput]}
Response
{
"data": {
"importVirtualCards": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
}
increaseCreditLimitTemporarily
Use companiesIncreaseCreditLimitTemporarily instead
Description
Increase credit limit temporarily
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - IncreaseCreditLimitTemporarilyInput
|
Example
Query
mutation increaseCreditLimitTemporarily(
$id: UUID!,
$input: IncreaseCreditLimitTemporarilyInput
) {
increaseCreditLimitTemporarily(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": IncreaseCreditLimitTemporarilyInput
}
Response
{
"data": {
"increaseCreditLimitTemporarily": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
invoicesCloseInvoice
Description
Close and finalize invoices
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - InvoiceIdInput!
|
Example
Query
mutation invoicesCloseInvoice($input: InvoiceIdInput!) {
invoicesCloseInvoice(input: $input)
}
Variables
{"input": InvoiceIdInput}
Response
{"data": {"invoicesCloseInvoice": true}}
invoicesCreateCreditInvoice
Description
Create credit invoice.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - CreateCreditInvoiceInput!
|
Example
Query
mutation invoicesCreateCreditInvoice($input: CreateCreditInvoiceInput!) {
invoicesCreateCreditInvoice(input: $input)
}
Variables
{"input": CreateCreditInvoiceInput}
Response
{"data": {"invoicesCreateCreditInvoice": false}}
invoicesCreateExport
Description
Create export data.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INVALID_FIELDS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateExportInput!
|
Example
Query
mutation invoicesCreateExport($input: CreateExportInput!) {
invoicesCreateExport(input: $input)
}
Variables
{"input": CreateExportInput}
Response
{
"data": {
"invoicesCreateExport": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
invoicesSend
Description
Send invoice by identifying attributes.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- SENDING_INVOICES_PARTIALLY_FAILED
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - InvoiceIdInput!
|
Example
Query
mutation invoicesSend($input: InvoiceIdInput!) {
invoicesSend(input: $input)
}
Variables
{"input": InvoiceIdInput}
Response
{"data": {"invoicesSend": true}}
invoicesUpdateStatusToAwaitingDirectDebit
Description
Update invoice status to awaiting direct debit.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Example
Query
mutation invoicesUpdateStatusToAwaitingDirectDebit($id: UUID!) {
invoicesUpdateStatusToAwaitingDirectDebit(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"invoicesUpdateStatusToAwaitingDirectDebit": false}}
invoicesUpdateStatusToPaid
Description
Update invoice status to Paid.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
invoicesUpdateStatusToPaymentFailed
Description
Update invoice status to payment failed.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Example
Query
mutation invoicesUpdateStatusToPaymentFailed($id: UUID!) {
invoicesUpdateStatusToPaymentFailed(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"invoicesUpdateStatusToPaymentFailed": true}}
kilometreChargingAddCharge
Description
Add Kilometre Charge Transaction.
Roles:
- ROLE_KILOMETRE_CHARGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddKilometreChargeInput!
|
Example
Query
mutation kilometreChargingAddCharge($input: AddKilometreChargeInput!) {
kilometreChargingAddCharge(input: $input)
}
Variables
{"input": AddKilometreChargeInput}
Response
{
"data": {
"kilometreChargingAddCharge": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
logout
Use authLogout instead
Description
Invalidate access and refresh tokens of user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Example
Query
mutation logout {
logout
}
Response
{"data": {"logout": false}}
metadataCreateField
Description
Create a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateFieldInput!
|
Example
Query
mutation metadataCreateField($input: CreateFieldInput!) {
metadataCreateField(input: $input)
}
Variables
{"input": CreateFieldInput}
Response
{
"data": {
"metadataCreateField": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
metadataDelete
Description
Delete a metadata.
Roles:
- ROLE_METADATA_ADMIN
Possible error codes:
- METADATA_ALREADY_DELETED
- METADATA_NOT_FOUND
- INTERNAL_SERVER_ERROR
metadataDeleteField
Description
Delete a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_ALREADY_DELETED
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
metadataDisableField
Description
Disable a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_ALREADY_DISABLED
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
metadataEnableField
Description
Enable a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_NOT_DISABLED
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
metadataSet
Description
Set metadata for entity.
Roles:
- ROLE_METADATA_ADMIN
Possible error codes:
- METADATA_NOT_FOUND_FOR_THE_TENANT
- FIELD_NOT_FOUND_IN_THE_GIVEN_NAME
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - MetadataInput!
|
Example
Query
mutation metadataSet($input: MetadataInput!) {
metadataSet(input: $input)
}
Variables
{"input": MetadataInput}
Response
{"data": {"metadataSet": false}}
metadataUpdateField
Description
Update a field
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateFieldInput
|
Example
Query
mutation metadataUpdateField(
$id: UUID!,
$input: UpdateFieldInput
) {
metadataUpdateField(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateFieldInput
}
Response
{"data": {"metadataUpdateField": false}}
moveCardToTemplate
use cardsMoveCardToTemplate instead.
Description
Move card to a different Template.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- CARD_IS_ALREADY_ATTACH_TO_SAME_TEMPLATE
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - MoveCardToTemplateInput
|
Example
Query
mutation moveCardToTemplate(
$id: UUID!,
$input: MoveCardToTemplateInput
) {
moveCardToTemplate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": MoveCardToTemplateInput
}
Response
{"data": {"moveCardToTemplate": false}}
ordersAddCardProduct
Description
Add card to order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddCardToOrderInput!
|
Example
Query
mutation ordersAddCardProduct($input: AddCardToOrderInput!) {
ordersAddCardProduct(input: $input)
}
Variables
{"input": AddCardToOrderInput}
Response
{
"data": {
"ordersAddCardProduct": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
ordersAddComment
Description
Add new comment to order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddOrderCommentInput!
|
Example
Query
mutation ordersAddComment($input: AddOrderCommentInput!) {
ordersAddComment(input: $input)
}
Variables
{"input": AddOrderCommentInput}
Response
{
"data": {
"ordersAddComment": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
ordersAddPackage
Description
Add package to order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - AddPackageToOrderInput!
|
Example
Query
mutation ordersAddPackage($input: AddPackageToOrderInput!) {
ordersAddPackage(input: $input)
}
Variables
{"input": AddPackageToOrderInput}
Response
{
"data": {
"ordersAddPackage": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
ordersCreateOrder
Description
Creates a new order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_CREATION_IS_DISABLED_DUE_TO_GUARANTEE_NOT_VALID
- ORDER_CREATION_INPUTS_ARE_NOT_VALID
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateOrderInput!
|
Example
Query
mutation ordersCreateOrder($input: CreateOrderInput!) {
ordersCreateOrder(input: $input)
}
Variables
{"input": CreateOrderInput}
Response
{
"data": {
"ordersCreateOrder": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
ordersRemoveCardProduct
Description
Remove Card Product from order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
ordersRemoveComment
Description
remove comment from order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- COMMENT_ALREADY_REMOVED
ordersUpdateCardChargeSettings
Description
Update Card Settings.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_IS_ALREADY_COMPLETED
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CardChargeSettingsInput!
|
Example
Query
mutation ordersUpdateCardChargeSettings(
$id: UUID!,
$input: CardChargeSettingsInput!
) {
ordersUpdateCardChargeSettings(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CardChargeSettingsInput
}
Response
{"data": {"ordersUpdateCardChargeSettings": false}}
ordersUpdateCardProduct
Description
Update Card of Order
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCardProductInput!
|
Example
Query
mutation ordersUpdateCardProduct(
$id: UUID!,
$input: UpdateCardProductInput!
) {
ordersUpdateCardProduct(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCardProductInput
}
Response
{"data": {"ordersUpdateCardProduct": true}}
ordersUpdateOrderLastOpenedDetail
Description
Update order last opened by.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
- ROLE_UPDATE_ORDER
Possible error codes:
- INTERNAL_SERVER_ERROR
Example
Query
mutation ordersUpdateOrderLastOpenedDetail($id: UUID!) {
ordersUpdateOrderLastOpenedDetail(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"ordersUpdateOrderLastOpenedDetail": true}}
ordersUpdateShippingAddress
Description
Update order shipping address.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
- ROLE_UPDATE_ORDER
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateOrderShippingAddressInput!
|
Example
Query
mutation ordersUpdateShippingAddress(
$id: UUID!,
$input: UpdateOrderShippingAddressInput!
) {
ordersUpdateShippingAddress(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateOrderShippingAddressInput
}
Response
{"data": {"ordersUpdateShippingAddress": true}}
ordersUpdateStatus
Description
Update order status.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_STATUS_UPDATE
- SETTINGS_NOT_ENABLED
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateOrderStatusInput!
|
Example
Query
mutation ordersUpdateStatus(
$id: UUID!,
$input: UpdateOrderStatusInput!
) {
ordersUpdateStatus(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateOrderStatusInput
}
Response
{"data": {"ordersUpdateStatus": true}}
paymentsCancelMandate
Description
Cancel a mandate
Roles:
- ROLE_MANDATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TWIKEY_CREDENTIALS_NOT_FOUND_FOR_THE_TENANT
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CancelMandateInput!
|
Example
Query
mutation paymentsCancelMandate(
$id: UUID!,
$input: CancelMandateInput!
) {
paymentsCancelMandate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CancelMandateInput
}
Response
{"data": {"paymentsCancelMandate": false}}
paymentsCreateLegalEntity
Description
Create a new legal entity for tenant
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - CreateLegalEntityInput!
|
Example
Query
mutation paymentsCreateLegalEntity($input: CreateLegalEntityInput!) {
paymentsCreateLegalEntity(input: $input)
}
Variables
{"input": CreateLegalEntityInput}
Response
{"data": {"paymentsCreateLegalEntity": true}}
paymentsCreateMandateForOrganizationalComponent
Description
Create a new mandate
Roles:
- ROLE_MANDATE_ADMIN
Possible error codes:
- INVALID_UUID
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateMandateForOrganizationalComponentInput!
|
Example
Query
mutation paymentsCreateMandateForOrganizationalComponent($input: CreateMandateForOrganizationalComponentInput!) {
paymentsCreateMandateForOrganizationalComponent(input: $input)
}
Variables
{"input": CreateMandateForOrganizationalComponentInput}
Response
{
"data": {
"paymentsCreateMandateForOrganizationalComponent": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
paymentsSendMandateInvite
Description
Invite a user/company to sign a mandate
Roles:
- ROLE_MANDATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TWIKEY_CREDENTIALS_NOT_FOUND_FOR_THE_TENANT
- TWIKEY_CT_ID_NOT_FOUND
- ENTITY_NOT_FOUND
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - SendMandateInviteInput!
|
Example
Query
mutation paymentsSendMandateInvite($input: SendMandateInviteInput!) {
paymentsSendMandateInvite(input: $input)
}
Variables
{"input": SendMandateInviteInput}
Response
{
"data": {
"paymentsSendMandateInvite": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
priceModificationAttachToEntity
Description
Attach price modification to an entity
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AttachPriceModificationToEntityInput
|
Example
Query
mutation priceModificationAttachToEntity(
$id: UUID!,
$input: AttachPriceModificationToEntityInput
) {
priceModificationAttachToEntity(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AttachPriceModificationToEntityInput
}
Response
{
"data": {
"priceModificationAttachToEntity": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
priceModificationCreate
Description
Create a new Price Modification
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreatePriceModificationInput!
|
Example
Query
mutation priceModificationCreate($input: CreatePriceModificationInput!) {
priceModificationCreate(input: $input)
}
Variables
{"input": CreatePriceModificationInput}
Response
{
"data": {
"priceModificationCreate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
priceModificationDelete
Description
Delete an existing Price Modification
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
priceModificationDeleteAssociation
Description
Delete an existing price modification association
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Example
Query
mutation priceModificationDeleteAssociation($id: UUID!) {
priceModificationDeleteAssociation(id: $id)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Response
{"data": {"priceModificationDeleteAssociation": true}}
priceModificationUpdate
Description
Update an existing Price Modification
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePriceModificationInput!
|
Example
Query
mutation priceModificationUpdate(
$id: UUID!,
$input: UpdatePriceModificationInput!
) {
priceModificationUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePriceModificationInput
}
Response
{"data": {"priceModificationUpdate": true}}
priceModificationUpdateAssociation
Description
Update an existing price modification association
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_ASSOCIATION
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePriceModificationAssociationInput
|
Example
Query
mutation priceModificationUpdateAssociation(
$id: UUID!,
$input: UpdatePriceModificationAssociationInput
) {
priceModificationUpdateAssociation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePriceModificationAssociationInput
}
Response
{"data": {"priceModificationUpdateAssociation": true}}
productsAddExternalId
Description
Add external id to a product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddExternalIdToProductInput!
|
Example
Query
mutation productsAddExternalId($input: AddExternalIdToProductInput!) {
productsAddExternalId(input: $input)
}
Variables
{"input": AddExternalIdToProductInput}
Response
{"data": {"productsAddExternalId": false}}
productsAddProductToCategory
Description
Add a product to a category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- PRODUCT_ALREADY_IN_CATEGORY
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddProductToCategoryInput!
|
Example
Query
mutation productsAddProductToCategory(
$id: UUID!,
$input: AddProductToCategoryInput!
) {
productsAddProductToCategory(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddProductToCategoryInput
}
Response
{"data": {"productsAddProductToCategory": true}}
productsCreate
Description
Create a new product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateProductInput!
|
Example
Query
mutation productsCreate($input: CreateProductInput!) {
productsCreate(input: $input)
}
Variables
{"input": CreateProductInput}
Response
{
"data": {
"productsCreate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
productsCreateCategory
Description
Create a new category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- CATEGORY_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateCategoryInput!
|
Example
Query
mutation productsCreateCategory($input: CreateCategoryInput!) {
productsCreateCategory(input: $input)
}
Variables
{"input": CreateCategoryInput}
Response
{
"data": {
"productsCreateCategory": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
productsCreatePackage
Description
Create a new package.
Roles:
- ROLE_PACKAGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreatePackageInput!
|
Example
Query
mutation productsCreatePackage($input: CreatePackageInput!) {
productsCreatePackage(input: $input)
}
Variables
{"input": CreatePackageInput}
Response
{
"data": {
"productsCreatePackage": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
productsDelete
Description
Delete a product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- PRODUCT_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
productsDeleteCategory
Description
Delete category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- CATEGORY_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
productsDeletePackage
Description
Delete a package.
Roles:
- ROLE_PACKAGE_ADMIN
Possible error codes:
- PACKAGE_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
productsRemoveProductFromCategory
Description
Remove a product from a category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- PRODUCT_NOT_IN_CATEGORY
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - RemoveProductFromCategoryInput!
|
Example
Query
mutation productsRemoveProductFromCategory(
$id: UUID!,
$input: RemoveProductFromCategoryInput!
) {
productsRemoveProductFromCategory(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": RemoveProductFromCategoryInput
}
Response
{"data": {"productsRemoveProductFromCategory": false}}
productsUpdate
Description
Update a product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateProductInput!
|
Example
Query
mutation productsUpdate(
$id: UUID!,
$input: UpdateProductInput!
) {
productsUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateProductInput
}
Response
{"data": {"productsUpdate": true}}
productsUpdateCategory
Description
Update category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- CATEGORY_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCategoryInput!
|
Example
Query
mutation productsUpdateCategory(
$id: UUID!,
$input: UpdateCategoryInput!
) {
productsUpdateCategory(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCategoryInput
}
Response
{"data": {"productsUpdateCategory": true}}
productsUpdatePackage
Description
Update a package.
Roles:
- ROLE_PACKAGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePackageInput!
|
Example
Query
mutation productsUpdatePackage(
$id: UUID!,
$input: UpdatePackageInput!
) {
productsUpdatePackage(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePackageInput
}
Response
{"data": {"productsUpdatePackage": true}}
refreshCreditCheck
Use companiesRefreshCreditCheck instead
Description
Refresh credit check
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- CREDIT_CHECK_IS_NOT_AVAILABLE_FOR_ORGANIZATIONAL_COMPONENT
- COUNTRY_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- REGISTRATION_NUMBER_UNKNOWN_FOR_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
removeAddressForUser
Use addressesRemoveAddressForUser instead
Description
Remove Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UserRemoveAddressInput!
|
Example
Query
mutation removeAddressForUser(
$id: UUID!,
$input: UserRemoveAddressInput!
) {
removeAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UserRemoveAddressInput
}
Response
{"data": {"removeAddressForUser": false}}
removeCardComment
use cardsRemoveComment instead.
Description
remove comment from card.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- COMMENT_ALREADY_REMOVED
removeFavorite
use userRemoveFavorite instead
Description
Remove favorite location from the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RemoveFavoriteInput
|
Example
Query
mutation removeFavorite($input: RemoveFavoriteInput) {
removeFavorite(input: $input)
}
Variables
{"input": RemoveFavoriteInput}
Response
{"data": {"removeFavorite": false}}
removeOrderComment
use ordersRemoveComment instead.
Description
remove comment from order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- COMMENT_ALREADY_REMOVED
removeProduct
use ordersRemoveCardProduct instead.
Description
Remove Card Product from order.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
removeProductFromCategory
Use
productsRemoveProductFromCategory instead. Description
Remove a product from a category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- PRODUCT_NOT_IN_CATEGORY
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - RemoveProductFromCategoryInput!
|
Example
Query
mutation removeProductFromCategory(
$id: UUID!,
$input: RemoveProductFromCategoryInput!
) {
removeProductFromCategory(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": RemoveProductFromCategoryInput
}
Response
{"data": {"removeProductFromCategory": true}}
removeShippingAddressForUser
Use addressesRemoveShippingAddressForUser instead
Description
Remove Shipping Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ADDRESS_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UserRemoveAddressInput!
|
Example
Query
mutation removeShippingAddressForUser(
$id: UUID!,
$input: UserRemoveAddressInput!
) {
removeShippingAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UserRemoveAddressInput
}
Response
{"data": {"removeShippingAddressForUser": false}}
removeTokenizedCardFromCompany
Use expenseReportRemoveTokenizedCardFromCompany instead
Description
Remove existing tokenized card from company
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_DATA
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RemoveTokenizedCardFromCompanyInput!
|
Example
Query
mutation removeTokenizedCardFromCompany($input: RemoveTokenizedCardFromCompanyInput!) {
removeTokenizedCardFromCompany(input: $input)
}
Variables
{"input": RemoveTokenizedCardFromCompanyInput}
Response
{"data": {"removeTokenizedCardFromCompany": true}}
removeUserFromOrganizationalComponent
Use companiesRemoveUserFromOrganizationalComponent instead
Description
Remove an user from Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- USER_IS_NOT_EMPLOYEE_OF_ORGANIZATIONAL_COMPONENT
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - RemoveUserFromOrganizationalComponentInput
|
Example
Query
mutation removeUserFromOrganizationalComponent(
$id: UUID!,
$input: RemoveUserFromOrganizationalComponentInput
) {
removeUserFromOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": RemoveUserFromOrganizationalComponentInput
}
Response
{"data": {"removeUserFromOrganizationalComponent": true}}
removeVehicle
Description
delete a vehicle for a user.
Possible error codes:
- VEHICLE_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
resendVerificationCode
use userResendVerificationCode instead
Description
Resend verification code to verify phone number of the current authenticated user.
Possible error codes:
- PHONE_NUMBER_ALREADY_VERIFIED
- INTERNAL_SERVER_ERROR
rolesAddRolesToUser
Description
Add roles to a user.
Roles:
ROLE_AUTH_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
userId - UUID!
|
|
input - AddRolesToUserInput!
|
Example
Query
mutation rolesAddRolesToUser(
$userId: UUID!,
$input: AddRolesToUserInput!
) {
rolesAddRolesToUser(
userId: $userId,
input: $input
)
}
Variables
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddRolesToUserInput
}
Response
{"data": {"rolesAddRolesToUser": false}}
rolesAddUsersToRole
Description
Add users to a role.
Roles:
ROLE_AUTH_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
role - RoleEnum!
|
|
input - AddUsersToRoleInput!
|
Example
Query
mutation rolesAddUsersToRole(
$role: RoleEnum!,
$input: AddUsersToRoleInput!
) {
rolesAddUsersToRole(
role: $role,
input: $input
)
}
Variables
{"role": "ROLE_SUPER_ADMIN", "input": AddUsersToRoleInput}
Response
{"data": {"rolesAddUsersToRole": false}}
sendIFSFMessage
Use fuelCardSendIFSFMessage instead
Description
Send IFSF message to EFAS
Roles:
- SEND_IFSF_MESSAGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- FUEL_CARD_NOT_FOUND
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - SendIFSFMessageInput!
|
Example
Query
mutation sendIFSFMessage($input: SendIFSFMessageInput!) {
sendIFSFMessage(input: $input)
}
Variables
{"input": SendIFSFMessageInput}
Response
{"data": {"sendIFSFMessage": "abc123"}}
sendInvoices
Use invoicesSend instead
Description
Send invoice by identifying attributes.
Roles:
- ROLE_INVOICE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- SENDING_INVOICES_PARTIALLY_FAILED
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - InvoiceIdInput!
|
Example
Query
mutation sendInvoices($input: InvoiceIdInput!) {
sendInvoices(input: $input)
}
Variables
{"input": InvoiceIdInput}
Response
{"data": {"sendInvoices": false}}
sendMandateInvite
Use
paymentsSendMandateInvite instead. Description
Invite a user/company to sign a mandate
Roles:
- ROLE_MANDATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- TWIKEY_CREDENTIALS_NOT_FOUND_FOR_THE_TENANT
- TWIKEY_CT_ID_NOT_FOUND
- ENTITY_NOT_FOUND
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - SendMandateInviteInput!
|
Example
Query
mutation sendMandateInvite($input: SendMandateInviteInput!) {
sendMandateInvite(input: $input)
}
Variables
{"input": SendMandateInviteInput}
Response
{
"data": {
"sendMandateInvite": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
setMetadata
use metadataSet instead.
Description
Set metadata for entity.
Roles:
- ROLE_METADATA_ADMIN
Possible error codes:
- METADATA_NOT_FOUND_FOR_THE_TENANT
- FIELD_NOT_FOUND_IN_THE_GIVEN_NAME
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
input - MetadataInput!
|
Example
Query
mutation setMetadata($input: MetadataInput!) {
setMetadata(input: $input)
}
Variables
{"input": MetadataInput}
Response
{"data": {"setMetadata": false}}
startCharging
Use chargeStartCharging instead
Description
Start charging at a charge point location EVSE.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - StartChargingInput!
|
Example
Query
mutation startCharging($input: StartChargingInput!) {
startCharging(input: $input)
}
Variables
{"input": StartChargingInput}
Response
{
"data": {
"startCharging": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
startGuestParking
Description
start a new Parking Session.
Possible error codes:
- UNABLE_TO_START_GUEST_PARKING_SESSION
- INTERNAL_SERVER_ERROR
- SOAP_REQUEST_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - StartGuestParkingInput!
|
Example
Query
mutation startGuestParking($input: StartGuestParkingInput!) {
startGuestParking(input: $input)
}
Variables
{"input": StartGuestParkingInput}
Response
{
"data": {
"startGuestParking": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
startParking
Description
start a new Parking Session.
Possible error codes:
- UNABLE_TO_START_PARKING_SESSION
- INTERNAL_SERVER_ERROR
- SOAP_REQUEST_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - StartParkingInput!
|
Example
Query
mutation startParking($input: StartParkingInput!) {
startParking(input: $input)
}
Variables
{"input": StartParkingInput}
Response
{
"data": {
"startParking": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
stopCharging
Use chargeStopCharging instead
Description
Stop Charging at the charge point location EVSE based on session ID.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- CHARGING_ALREADY_STOPPED
stopParking
Description
Stop existing Parking Session.
Possible error codes:
- UNABLE_TO_STOP_PARKING_SESSION
- INTERNAL_SERVER_ERROR
- SOAP_REQUEST_ERROR
tenantAddEfasDetails
Description
Add EFAS fuel card provider details
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddEfasDetailsInput
|
Example
Query
mutation tenantAddEfasDetails(
$id: UUID!,
$input: AddEfasDetailsInput
) {
tenantAddEfasDetails(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddEfasDetailsInput
}
Response
{"data": {"tenantAddEfasDetails": false}}
tenantAddEmablerSiteId
Description
Adds an Emabler site id to the tenant. Required for enabling MSP functionality
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - AddEmablerSiteIdInput
|
Example
Query
mutation tenantAddEmablerSiteId(
$id: UUID!,
$input: AddEmablerSiteIdInput
) {
tenantAddEmablerSiteId(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": AddEmablerSiteIdInput
}
Response
{"data": {"tenantAddEmablerSiteId": true}}
tenantAddMandateTemplate
Description
Add Mandate Template
Possible error codes:
- UNIQUE_CONSTRAINT_VIOLATION
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - addMandateTemplateInput
|
Example
Query
mutation tenantAddMandateTemplate($input: addMandateTemplateInput) {
tenantAddMandateTemplate(input: $input)
}
Variables
{"input": addMandateTemplateInput}
Response
{
"data": {
"tenantAddMandateTemplate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
tenantAddPhoneNumber
Description
Add phone number to tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- PHONE_NUMBER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - AddPhoneNumberForTenantInput
|
Example
Query
mutation tenantAddPhoneNumber($input: AddPhoneNumberForTenantInput) {
tenantAddPhoneNumber(input: $input)
}
Variables
{"input": AddPhoneNumberForTenantInput}
Response
{"data": {"tenantAddPhoneNumber": "xyz789"}}
tenantAddPrivacyPolicy
Description
Add privacy policy to the Tenant
Roles:
- ROLE_TENANTS_ADMIN
- ROLE_TENANT_OWNER
Possible error codes:
- TENANT_ALREADY_HAS_PRIVACY_POLICY
- INTERNAL_SERVER_ERROR
Example
Query
mutation tenantAddPrivacyPolicy(
$id: UUID!,
$privacyPolicy: String!
) {
tenantAddPrivacyPolicy(
id: $id,
privacyPolicy: $privacyPolicy
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"privacyPolicy": "xyz789"
}
Response
{"data": {"tenantAddPrivacyPolicy": true}}
tenantCreate
Description
Creates the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateTenantInput!
|
Example
Query
mutation tenantCreate($input: CreateTenantInput!) {
tenantCreate(input: $input)
}
Variables
{"input": CreateTenantInput}
Response
{
"data": {
"tenantCreate": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
tenantCreateTermsAndConditions
Description
Create Terms And Conditions entity for Tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TERMS_ALREADY_EXIST
- INTERNAL_SERVER_ERROR
Response
Returns a UUID!
Arguments
| Name | Description |
|---|---|
input - CreateTermsAndConditionsInput!
|
Example
Query
mutation tenantCreateTermsAndConditions($input: CreateTermsAndConditionsInput!) {
tenantCreateTermsAndConditions(input: $input)
}
Variables
{"input": CreateTermsAndConditionsInput}
Response
{
"data": {
"tenantCreateTermsAndConditions": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
}
tenantDeletePhoneNumber
Description
Delete phone number of tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
tenantDisable
Description
Disables the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TENANT_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
tenantEnable
Description
Enables the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TENANT_ALREADY_ENABLED
- INTERNAL_SERVER_ERROR
tenantUpdate
Description
Updates the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateTenantInput!
|
Example
Query
mutation tenantUpdate(
$id: UUID!,
$input: UpdateTenantInput!
) {
tenantUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateTenantInput
}
Response
{"data": {"tenantUpdate": true}}
tenantUpdateCustomerNumberConfiguration
Description
Update customer number configuration
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CustomerNumberConfigurationInput
|
Example
Query
mutation tenantUpdateCustomerNumberConfiguration(
$id: UUID!,
$input: CustomerNumberConfigurationInput
) {
tenantUpdateCustomerNumberConfiguration(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CustomerNumberConfigurationInput
}
Response
{"data": {"tenantUpdateCustomerNumberConfiguration": true}}
tenantUpdateInvoiceConfiguration
Description
Update Invoice Configuration
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - InvoiceConfigurationInput
|
Example
Query
mutation tenantUpdateInvoiceConfiguration(
$id: UUID!,
$input: InvoiceConfigurationInput
) {
tenantUpdateInvoiceConfiguration(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": InvoiceConfigurationInput
}
Response
{"data": {"tenantUpdateInvoiceConfiguration": true}}
tenantUpdateMandateTemplate
Description
Update Mandate Template
Possible error codes:
- UNIQUE_CONSTRAINT_VIOLATION
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - updateMandateTemplateInput
|
Example
Query
mutation tenantUpdateMandateTemplate($input: updateMandateTemplateInput) {
tenantUpdateMandateTemplate(input: $input)
}
Variables
{"input": updateMandateTemplateInput}
Response
{"data": {"tenantUpdateMandateTemplate": false}}
tenantUpdateMy
Description
Updates the tenant
Roles:
- ROLE_TENANT_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateMyTenantInput!
|
Example
Query
mutation tenantUpdateMy($input: UpdateMyTenantInput!) {
tenantUpdateMy(input: $input)
}
Variables
{"input": UpdateMyTenantInput}
Response
{"data": {"tenantUpdateMy": true}}
tenantUpdatePhoneNumber
Description
Update phone number of tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- PHONE_NUMBER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePhoneNumberForTenantInput
|
Example
Query
mutation tenantUpdatePhoneNumber(
$id: UUID!,
$input: UpdatePhoneNumberForTenantInput
) {
tenantUpdatePhoneNumber(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePhoneNumberForTenantInput
}
Response
{"data": {"tenantUpdatePhoneNumber": true}}
tenantUpdatePrivacyPolicy
Description
Update Tenant privacy policy
Roles:
- ROLE_TENANTS_ADMIN
- ROLE_TENANT_OWNER
Possible error codes:
- TENANT_DOES_NOT_HAVE_PRIVACY_POLICY
- INTERNAL_SERVER_ERROR
Example
Query
mutation tenantUpdatePrivacyPolicy(
$id: UUID!,
$privacyPolicy: String!
) {
tenantUpdatePrivacyPolicy(
id: $id,
privacyPolicy: $privacyPolicy
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"privacyPolicy": "abc123"
}
Response
{"data": {"tenantUpdatePrivacyPolicy": true}}
tenantUpdateTermsAndConditions
Description
Update Terms And Conditions entity for Tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TERMS_ALREADY_EXIST
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateTermsAndConditionsInput!
|
Example
Query
mutation tenantUpdateTermsAndConditions(
$id: UUID!,
$input: UpdateTermsAndConditionsInput!
) {
tenantUpdateTermsAndConditions(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateTermsAndConditionsInput
}
Response
{"data": {"tenantUpdateTermsAndConditions": false}}
tenantUploadLogo
Description
Uploads a logo for the tenant
Roles:
- ROLE_TENANTS_ADMIN
- ROLE_TENANT_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
unlockChargingConnector
Use chargeUnlockChargingConnector instead
Description
Request the charge location EVSE to unlock the connector.
This command is only allowed to be used by help desk operators at the eMSP. The command will never be available to the end user. The functionality is intended to be used in the rare situation that the connector is not unlocked successfully after a transaction is stopped.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
- ROLE_HELPDESK_OPERATOR
Possible error codes:
- INTERNAL_SERVER_ERROR
updateAddressForGasStation
Use addressesUpdateAddressForGasStation instead
Description
Update address For Gas Station
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForGasStationInput!
|
Example
Query
mutation updateAddressForGasStation(
$id: UUID!,
$input: UpdateAddressForGasStationInput!
) {
updateAddressForGasStation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForGasStationInput
}
Response
{"data": {"updateAddressForGasStation": true}}
updateAddressForOrganizationalComponent
Use addressesUpdateAddressForOrganizationalComponent instead
Description
Update address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ORGANIZATIONAL_COMPONENT_UPDATE_ADDRESS
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForOrganizationalComponentInput!
|
Example
Query
mutation updateAddressForOrganizationalComponent(
$id: UUID!,
$input: UpdateAddressForOrganizationalComponentInput!
) {
updateAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForOrganizationalComponentInput
}
Response
{"data": {"updateAddressForOrganizationalComponent": true}}
updateAddressForTenant
Use addressesUpdateAddressForTenant instead
Description
Update address for tenant
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForTenantInput!
|
Example
Query
mutation updateAddressForTenant(
$id: UUID!,
$input: UpdateAddressForTenantInput!
) {
updateAddressForTenant(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForTenantInput
}
Response
{"data": {"updateAddressForTenant": true}}
updateAddressForUser
Use addressesUpdateAddressForUser instead
Description
Update Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateAddressForUserInput!
|
Example
Query
mutation updateAddressForUser(
$id: UUID!,
$input: UpdateAddressForUserInput!
) {
updateAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateAddressForUserInput
}
Response
{"data": {"updateAddressForUser": true}}
updateCard
use cardsUpdate instead.
Description
Update card mutation.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INVALID_UUID
- CARD_WITH_EXTERNAL_REFERENCE_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCardInput!
|
Example
Query
mutation updateCard(
$id: UUID!,
$input: UpdateCardInput!
) {
updateCard(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCardInput
}
Response
{"data": {"updateCard": false}}
updateCardChargeSettings
use ordersUpdateCardChargeSettings instead.
Description
Update Card Settings.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_IS_ALREADY_COMPLETED
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CardChargeSettingsInput!
|
Example
Query
mutation updateCardChargeSettings(
$id: UUID!,
$input: CardChargeSettingsInput!
) {
updateCardChargeSettings(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CardChargeSettingsInput
}
Response
{"data": {"updateCardChargeSettings": true}}
updateCardLimit
use cardsUpdateLimit instead.
Description
Update card limit.
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - FuelLimitInput!
|
Example
Query
mutation updateCardLimit(
$id: UUID!,
$input: FuelLimitInput!
) {
updateCardLimit(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": FuelLimitInput
}
Response
{"data": {"updateCardLimit": true}}
updateCardProduct
use orderUpdateCardProduct instead.
Description
Update Card of Order
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCardProductInput!
|
Example
Query
mutation updateCardProduct(
$id: UUID!,
$input: UpdateCardProductInput!
) {
updateCardProduct(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCardProductInput
}
Response
{"data": {"updateCardProduct": false}}
updateCardProducts
use cardsUpdateCardProducts instead.
Description
Update card products
Roles:
- ROLE_CARD_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCardProductsInput!
|
Example
Query
mutation updateCardProducts(
$id: UUID!,
$input: UpdateCardProductsInput!
) {
updateCardProducts(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCardProductsInput
}
Response
{"data": {"updateCardProducts": true}}
updateCategory
Use
productsUpdateCategory instead. Description
Update category
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- CATEGORY_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCategoryInput!
|
Example
Query
mutation updateCategory(
$id: UUID!,
$input: UpdateCategoryInput!
) {
updateCategory(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCategoryInput
}
Response
{"data": {"updateCategory": false}}
updateChargeToken
Update charge tokens through updating cards instead.
Description
Updates a charge token.
Roles:
- ROLE_CHARGE_TOKEN_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateChargeTokenInput!
|
Example
Query
mutation updateChargeToken(
$id: UUID!,
$input: UpdateChargeTokenInput!
) {
updateChargeToken(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateChargeTokenInput
}
Response
{"data": {"updateChargeToken": false}}
updateCompanyIdentificationNumberForKilometreCharge
Use companiesUpdateIdentificationNumberForKilometreCharge instead
Description
Update Company Identification Number For Kilometre Charge Provider. When calling this mutation the existing data will be overwritten.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCompanyIdentificationNumberInput
|
Example
Query
mutation updateCompanyIdentificationNumberForKilometreCharge(
$id: UUID!,
$input: UpdateCompanyIdentificationNumberInput
) {
updateCompanyIdentificationNumberForKilometreCharge(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCompanyIdentificationNumberInput
}
Response
{"data": {"updateCompanyIdentificationNumberForKilometreCharge": true}}
updateCompanySegment
Use companiesUpdateSegment instead
Description
Update a Company segment.
Roles:
- ROLE_COMPANY_SEGMENT_ADMIN
Possible error codes:
- COMPANY_SEGMENT_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CompanySegmentInput!
|
Example
Query
mutation updateCompanySegment(
$id: UUID!,
$input: CompanySegmentInput!
) {
updateCompanySegment(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CompanySegmentInput
}
Response
{"data": {"updateCompanySegment": false}}
updateContactPersonForOrganizationalComponent
Use companiesUpdateContactPersonForOrganizationalComponent instead
Description
Update contact person.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateContactPersonForOrganizationalComponentInput!
|
Example
Query
mutation updateContactPersonForOrganizationalComponent(
$id: UUID!,
$input: UpdateContactPersonForOrganizationalComponentInput!
) {
updateContactPersonForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateContactPersonForOrganizationalComponentInput
}
Response
{"data": {"updateContactPersonForOrganizationalComponent": false}}
updateCreditLimitForOrganizationalComponent
Use companiesUpdateCreditLimitForOrganizationalComponent instead
Description
Update credit limit for organizational component
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateCreditLimitForOrganizationalComponentInput
|
Example
Query
mutation updateCreditLimitForOrganizationalComponent(
$id: UUID!,
$input: UpdateCreditLimitForOrganizationalComponentInput
) {
updateCreditLimitForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateCreditLimitForOrganizationalComponentInput
}
Response
{"data": {"updateCreditLimitForOrganizationalComponent": true}}
updateCurrentUser
use userUpdateCurrent instead
Description
Updates the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_VAT_NUMBER
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput
|
Example
Query
mutation updateCurrentUser($input: UpdateUserInput) {
updateCurrentUser(input: $input)
}
Variables
{"input": UpdateUserInput}
Response
{"data": {"updateCurrentUser": false}}
updateCustomerNumberConfiguration
use tenantUpdateCustomerNumberConfiguration instead.
Description
Update customer number configuration
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - CustomerNumberConfigurationInput
|
Example
Query
mutation updateCustomerNumberConfiguration(
$id: UUID!,
$input: CustomerNumberConfigurationInput
) {
updateCustomerNumberConfiguration(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": CustomerNumberConfigurationInput
}
Response
{"data": {"updateCustomerNumberConfiguration": true}}
updateEmail
Use authUpdateEmail instead
Description
Initiates the process of updating the email address of the current user. The supplied email address will receive an email to confirm the change.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateEmailInput
|
Example
Query
mutation updateEmail($input: UpdateEmailInput) {
updateEmail(input: $input)
}
Variables
{"input": UpdateEmailInput}
Response
{"data": {"updateEmail": false}}
updateField
use metadataUpdateField instead.
Description
Update a field.
Roles:
- ROLE_FIELD_ADMIN
Possible error codes:
- FIELD_NOT_FOUND
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateFieldInput
|
Example
Query
mutation updateField(
$id: UUID!,
$input: UpdateFieldInput
) {
updateField(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateFieldInput
}
Response
{"data": {"updateField": true}}
updateGasStation
use gasStationsUpdate instead.
Description
Updates a gas station.
Roles:
- ROLE_GAS_STATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_UUID
- INVALID_URL
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateGasStationInput!
|
Example
Query
mutation updateGasStation(
$id: UUID!,
$input: UpdateGasStationInput!
) {
updateGasStation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateGasStationInput
}
Response
{"data": {"updateGasStation": false}}
updateGuarantee
Use companiesUpdateGuarantee instead
Description
Create guarantee for organizational component
Roles:
- ROLE_GUARANTEE_ADMIN
Possible error codes:
- GUARANTEE_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateGuaranteeInput
|
Example
Query
mutation updateGuarantee(
$id: UUID!,
$input: UpdateGuaranteeInput
) {
updateGuarantee(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateGuaranteeInput
}
Response
{"data": {"updateGuarantee": false}}
updateHub
use hubUpdate instead
Description
Update a hub
Roles:
- ROLE_HUB_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateHubInput!
|
Example
Query
mutation updateHub(
$id: UUID!,
$input: UpdateHubInput!
) {
updateHub(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateHubInput
}
Response
{"data": {"updateHub": false}}
updateInvoiceAddressForOrganizationalComponent
Use addressesUpdateInvoiceAddressForOrganizationalComponent instead
Description
Update Invoice Address for Company
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateInvoiceAddressForOrganizationalComponentInput!
|
Example
Query
mutation updateInvoiceAddressForOrganizationalComponent(
$id: UUID!,
$input: UpdateInvoiceAddressForOrganizationalComponentInput!
) {
updateInvoiceAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateInvoiceAddressForOrganizationalComponentInput
}
Response
{"data": {"updateInvoiceAddressForOrganizationalComponent": true}}
updateInvoiceAddressForUser
Use addressesUpdateInvoiceAddressForUser instead
Description
Update Invoice Address for User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - InvoiceAddressForUserInput!
|
Example
Query
mutation updateInvoiceAddressForUser(
$id: UUID!,
$input: InvoiceAddressForUserInput!
) {
updateInvoiceAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": InvoiceAddressForUserInput
}
Response
{"data": {"updateInvoiceAddressForUser": false}}
updateInvoiceConfiguration
use tenantUpdateInvoiceConfiguration instead.
Description
Update Invoice Configuration
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - InvoiceConfigurationInput
|
Example
Query
mutation updateInvoiceConfiguration(
$id: UUID!,
$input: InvoiceConfigurationInput
) {
updateInvoiceConfiguration(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": InvoiceConfigurationInput
}
Response
{"data": {"updateInvoiceConfiguration": true}}
updateMandateTemplate
use tenantUpdateMandateTemplate instead.
Description
Update Mandate Template
Possible error codes:
- UNIQUE_CONSTRAINT_VIOLATION
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - updateMandateTemplateInput
|
Example
Query
mutation updateMandateTemplate($input: updateMandateTemplateInput) {
updateMandateTemplate(input: $input)
}
Variables
{"input": updateMandateTemplateInput}
Response
{"data": {"updateMandateTemplate": true}}
updateMyTenant
use tenantUpdateMy instead.
Description
Updates the tenant
Roles:
- ROLE_TENANT_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateMyTenantInput!
|
Example
Query
mutation updateMyTenant($input: UpdateMyTenantInput!) {
updateMyTenant(input: $input)
}
Variables
{"input": UpdateMyTenantInput}
Response
{"data": {"updateMyTenant": true}}
updateOrderLastOpenedDetail
use ordersUpdateOrderLastOpenedDetail instead.
Description
Update order last opened by.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
- ROLE_UPDATE_ORDER
Possible error codes:
- INTERNAL_SERVER_ERROR
updateOrderShippingAddress
use ordersUpdateShippingAddress instead.
Description
Update order shipping address.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
- ROLE_UPDATE_ORDER
Possible error codes:
- INTERNAL_SERVER_ERROR
- ORDER_NOT_IN_DRAFT_STATUS
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateOrderShippingAddressInput!
|
Example
Query
mutation updateOrderShippingAddress(
$id: UUID!,
$input: UpdateOrderShippingAddressInput!
) {
updateOrderShippingAddress(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateOrderShippingAddressInput
}
Response
{"data": {"updateOrderShippingAddress": true}}
updateOrderStatus
use ordersUpdateStatus instead.
Description
Update order status.
Roles:
- ROLE_ORDER_ADMIN
- ROLE_SUPER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_STATUS_UPDATE
- SETTINGS_NOT_ENABLED
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateOrderStatusInput!
|
Example
Query
mutation updateOrderStatus(
$id: UUID!,
$input: UpdateOrderStatusInput!
) {
updateOrderStatus(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateOrderStatusInput
}
Response
{"data": {"updateOrderStatus": true}}
updateOrganizationalComponent
Use companiesUpdateOrganizationalComponent instead
Description
Update a Organizational component.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_ADMIN
Possible error codes:
- INVALID_INVOICEABLE_COMPANY_ID
- INVALID_INVOICEABLE_COMPANY_ID_AS_SELF
- ORGANIZATIONAL_COMPONENT_ALREADY_DELETED
- ORGANIZATIONAL_COMPONENT_INVALID_UPLOAD_CONTRACT
- APPROVED_MANDATES_NOT_AVAILABLE
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateOrganizationalComponentInput
|
Example
Query
mutation updateOrganizationalComponent(
$id: UUID!,
$input: UpdateOrganizationalComponentInput
) {
updateOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateOrganizationalComponentInput
}
Response
{"data": {"updateOrganizationalComponent": false}}
updateOrganizationalComponentType
Use companiesUpdateOrganizationalComponentType instead
Description
Update a Organizational component type by ID.
Roles:
- ROLE_ORGANIZATIONAL_COMPONENT_TYPE_ADMIN
Possible error codes:
- ORGANIZATIONAL_COMPONENT_TYPE_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - OrganizationalComponentTypeInput!
|
Example
Query
mutation updateOrganizationalComponentType(
$id: UUID!,
$input: OrganizationalComponentTypeInput!
) {
updateOrganizationalComponentType(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": OrganizationalComponentTypeInput
}
Response
{"data": {"updateOrganizationalComponentType": false}}
updatePackage
Use
productsUpdatePackage instead. Description
Update a package.
Roles:
- ROLE_PACKAGE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePackageInput!
|
Example
Query
mutation updatePackage(
$id: UUID!,
$input: UpdatePackageInput!
) {
updatePackage(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePackageInput
}
Response
{"data": {"updatePackage": true}}
updatePassword
Use authUpdatePassword instead
Description
Update Current User's Password
Possible error codes:
- PASSWORD_VALIDATION_ERROR
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdatePasswordInput
|
Example
Query
mutation updatePassword($input: UpdatePasswordInput) {
updatePassword(input: $input)
}
Variables
{"input": UpdatePasswordInput}
Response
{"data": {"updatePassword": false}}
updatePhoneNumberForTenant
use tenantUpdatePhoneNumber instead.
Description
Update phone number of tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- PHONE_NUMBER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePhoneNumberForTenantInput
|
Example
Query
mutation updatePhoneNumberForTenant(
$id: UUID!,
$input: UpdatePhoneNumberForTenantInput
) {
updatePhoneNumberForTenant(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePhoneNumberForTenantInput
}
Response
{"data": {"updatePhoneNumberForTenant": true}}
updatePriceModification
use priceModificationUpdate instead.
Description
Update an existing Price Modification
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePriceModificationInput!
|
Example
Query
mutation updatePriceModification(
$id: UUID!,
$input: UpdatePriceModificationInput!
) {
updatePriceModification(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePriceModificationInput
}
Response
{"data": {"updatePriceModification": false}}
updatePriceModificationAssociation
use priceModificationUpdateAssociation instead.
Description
Update an existing price modification association
Roles:
- ROLE_PRICE_MODIFICATION_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_ASSOCIATION
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdatePriceModificationAssociationInput
|
Example
Query
mutation updatePriceModificationAssociation(
$id: UUID!,
$input: UpdatePriceModificationAssociationInput
) {
updatePriceModificationAssociation(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdatePriceModificationAssociationInput
}
Response
{"data": {"updatePriceModificationAssociation": false}}
updatePrivacyPolicy
use tenantUpdatePrivacyPolicy instead.
Description
Update Tenant privacy policy
Roles:
- ROLE_TENANTS_ADMIN
- ROLE_TENANT_OWNER
Possible error codes:
- TENANT_DOES_NOT_HAVE_PRIVACY_POLICY
- INTERNAL_SERVER_ERROR
Example
Query
mutation updatePrivacyPolicy(
$id: UUID!,
$privacyPolicy: String!
) {
updatePrivacyPolicy(
id: $id,
privacyPolicy: $privacyPolicy
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"privacyPolicy": "abc123"
}
Response
{"data": {"updatePrivacyPolicy": true}}
updateProduct
Use
productsUpdate instead. Description
Update a product.
Roles:
- ROLE_PRODUCT_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateProductInput!
|
Example
Query
mutation updateProduct(
$id: UUID!,
$input: UpdateProductInput!
) {
updateProduct(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateProductInput
}
Response
{"data": {"updateProduct": true}}
updateSettings
use userUpdateSettings instead
Description
Update Settings for user
Possible error codes:
- INTERNAL_SERVER_ERROR
updateShippingAddressForOrganizationalComponent
Use addressesUpdateShippingAddressForOrganizationalComponent instead
Description
Update Shipping Address For OrganizationalComponent
Roles:
- ROLE_ADDRESS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - ShippingAddressForOrganizationalComponentInput!
|
Example
Query
mutation updateShippingAddressForOrganizationalComponent(
$id: UUID!,
$input: ShippingAddressForOrganizationalComponentInput!
) {
updateShippingAddressForOrganizationalComponent(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": ShippingAddressForOrganizationalComponentInput
}
Response
{"data": {"updateShippingAddressForOrganizationalComponent": false}}
updateShippingAddressForUser
Use addressesUpdateShippingAddressForUser instead
Description
Update Shipping Address For User
Roles:
- ROLE_ADDRESS_ADMIN
- ROLE_ADDRESS_OWNER
Possible error codes:
- ADDRESS_IS_DELETED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - ShippingAddressForUserInput!
|
Example
Query
mutation updateShippingAddressForUser(
$id: UUID!,
$input: ShippingAddressForUserInput!
) {
updateShippingAddressForUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": ShippingAddressForUserInput
}
Response
{"data": {"updateShippingAddressForUser": false}}
updateTemplate
use cardsUpdateTemplate instead.
Description
Update a template.
Roles:
- ROLE_TEMPLATE_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateTemplateInput!
|
Example
Query
mutation updateTemplate(
$id: UUID!,
$input: UpdateTemplateInput!
) {
updateTemplate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateTemplateInput
}
Response
{"data": {"updateTemplate": false}}
updateTenant
use tenantUpdate instead.
Description
Updates the tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateTenantInput!
|
Example
Query
mutation updateTenant(
$id: UUID!,
$input: UpdateTenantInput!
) {
updateTenant(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateTenantInput
}
Response
{"data": {"updateTenant": false}}
updateTenantLogo
use tenantUploadLogo instead.
Description
Uploads a logo for the tenant
Roles:
- ROLE_TENANTS_ADMIN
- ROLE_TENANT_OWNER
Possible error codes:
- INTERNAL_SERVER_ERROR
updateTermsAndConditions
use tenantUpdateTermsAndConditions instead.
Description
Update Terms And Conditions entity for Tenant
Roles:
- ROLE_TENANTS_ADMIN
Possible error codes:
- TERMS_ALREADY_EXIST
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateTermsAndConditionsInput!
|
Example
Query
mutation updateTermsAndConditions(
$id: UUID!,
$input: UpdateTermsAndConditionsInput!
) {
updateTermsAndConditions(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateTermsAndConditionsInput
}
Response
{"data": {"updateTermsAndConditions": true}}
updateTokenizedCard
Use expenseReportUpdateTokenizedCard instead
Description
Update existing tokenized card
Roles:
- ROLE_EXPENSE_REPORTING_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_DATA
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateTokenizedCardInput!
|
Example
Query
mutation updateTokenizedCard($input: UpdateTokenizedCardInput!) {
updateTokenizedCard(input: $input)
}
Variables
{"input": UpdateTokenizedCardInput}
Response
{"data": {"updateTokenizedCard": false}}
updateUser
use userUpdate instead
Description
Updates the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_VAT_NUMBER
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateUserInput
|
Example
Query
mutation updateUser(
$id: UUID!,
$input: UpdateUserInput
) {
updateUser(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateUserInput
}
Response
{"data": {"updateUser": true}}
updateVehicle
Description
Updates a vehicle for a user.
Possible error codes:
- VEHICLE_INVALID_VIN_LENGTH
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateVehicleInput!
|
Example
Query
mutation updateVehicle(
$id: UUID!,
$input: UpdateVehicleInput!
) {
updateVehicle(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateVehicleInput
}
Response
{"data": {"updateVehicle": true}}
updateWebhook
use webhookUpdate instead
Description
Update Webhook mutation
Roles:
- ROLE_WEBHOOK_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR *WEBHOOK_IS_DELETED
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - WebhookUpdateInput
|
Example
Query
mutation updateWebhook(
$id: UUID!,
$input: WebhookUpdateInput
) {
updateWebhook(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": WebhookUpdateInput
}
Response
{"data": {"updateWebhook": true}}
userAddPhoneNumber
Description
Add phone number to the current authenticated user.
Possible error codes:
- PHONE_NUMBER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - addPhoneNumberInput
|
Example
Query
mutation userAddPhoneNumber($input: addPhoneNumberInput) {
userAddPhoneNumber(input: $input)
}
Variables
{"input": addPhoneNumberInput}
Response
{"data": {"userAddPhoneNumber": "xyz789"}}
userAddToFavorite
Description
Add favorite location to the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - AddToFavoriteInput
|
Example
Query
mutation userAddToFavorite($input: AddToFavoriteInput) {
userAddToFavorite(input: $input)
}
Variables
{"input": AddToFavoriteInput}
Response
{"data": {"userAddToFavorite": true}}
userApproveTermsAndConditions
Description
Approve Terms And Conditions by User
Possible error codes:
- USER_ALREADY_APPROVE
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UserApproveTermsAndConditionsInput!
|
Example
Query
mutation userApproveTermsAndConditions($input: UserApproveTermsAndConditionsInput!) {
userApproveTermsAndConditions(input: $input)
}
Variables
{"input": UserApproveTermsAndConditionsInput}
Response
{"data": {"userApproveTermsAndConditions": true}}
userCreateAnonymous
Description
Create anonymous user
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - AnonymousUserInput
|
Example
Query
mutation userCreateAnonymous($input: AnonymousUserInput) {
userCreateAnonymous(input: $input)
}
Variables
{"input": AnonymousUserInput}
Response
{"data": {"userCreateAnonymous": "abc123"}}
userCreateUnauthenticated
Description
Create Unauthenticated user
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_EXISTS
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - CreateUnauthenticatableUser
|
Example
Query
mutation userCreateUnauthenticated($input: CreateUnauthenticatableUser) {
userCreateUnauthenticated(input: $input)
}
Variables
{"input": CreateUnauthenticatableUser}
Response
{
"data": {
"userCreateUnauthenticated": "abc123"
}
}
userCreateWithVirtualCard
Description
Create anonymous user with virtual card
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - UserWithVirtualCardInput
|
Example
Query
mutation userCreateWithVirtualCard($input: UserWithVirtualCardInput) {
userCreateWithVirtualCard(input: $input)
}
Variables
{"input": UserWithVirtualCardInput}
Response
{
"data": {
"userCreateWithVirtualCard": "xyz789"
}
}
userDeactivate
Description
Deactivate user
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_DEACTIVATED
- INTERNAL_SERVER_ERROR
userDelete
Description
Deletes the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_DELETED
- INTERNAL_SERVER_ERROR
userDeletePhoneNumber
Description
delete phone number to the current authenticated user. Possible error codes:
- PHONE_NUMBER_ALREADY_DELETED
- PHONE_NUMBER_DOES_NOT_EXISTS
- INTERNAL_SERVER_ERROR
userDisable
Description
Disables the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- DISABLED_COMMENT_MISSING
- USER_ALREADY_DISABLED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UserDisabledInput!
|
Example
Query
mutation userDisable(
$id: UUID!,
$input: UserDisabledInput!
) {
userDisable(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UserDisabledInput
}
Response
{"data": {"userDisable": true}}
userEnable
Description
Enables the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- USER_ALREADY_ENABLED
- INTERNAL_SERVER_ERROR
userImport
Description
Import new user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- PHONE_NUMBER_ALREADY_EXISTS
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
input - ImportUserInput
|
Example
Query
mutation userImport($input: ImportUserInput) {
userImport(input: $input)
}
Variables
{"input": ImportUserInput}
Response
{"data": {"userImport": "xyz789"}}
userRemoveFavorite
Description
Remove favorite location from the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - RemoveFavoriteInput
|
Example
Query
mutation userRemoveFavorite($input: RemoveFavoriteInput) {
userRemoveFavorite(input: $input)
}
Variables
{"input": RemoveFavoriteInput}
Response
{"data": {"userRemoveFavorite": true}}
userResendVerificationCode
Description
Resend verification code to verify phone number of the current authenticated user.
Possible error codes:
- PHONE_NUMBER_ALREADY_VERIFIED
- INTERNAL_SERVER_ERROR
userUpdate
Description
Updates the user.
Roles:
- ROLE_USER_ADMIN
Possible error codes:
- APPROVED_MANDATES_NOT_AVAILABLE
- INVALID_VAT_NUMBER
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - UpdateUserInput
|
Example
Query
mutation userUpdate(
$id: UUID!,
$input: UpdateUserInput
) {
userUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": UpdateUserInput
}
Response
{"data": {"userUpdate": true}}
userUpdateCurrent
Description
Updates the current authenticated user.
Possible error codes:
- INTERNAL_SERVER_ERROR
- INVALID_VAT_NUMBER
- APPROVED_MANDATES_NOT_AVAILABLE
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
input - UpdateUserInput
|
Example
Query
mutation userUpdateCurrent($input: UpdateUserInput) {
userUpdateCurrent(input: $input)
}
Variables
{"input": UpdateUserInput}
Response
{"data": {"userUpdateCurrent": false}}
userUpdateSettings
Description
Update Settings for user
Possible error codes:
- INTERNAL_SERVER_ERROR
userVerifyPhoneNumber
Description
Verify phone number of the current authenticated user using code.
Possible error codes:
- PHONE_NUMBER_ALREADY_VERIFIED
- PHONE_NUMBER_WRONG_VERIFICATION_CODE
- PHONE_NUMBER_VERIFICATION_CODE_EXPIRED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - verifyPhoneNumberInput
|
Example
Query
mutation userVerifyPhoneNumber(
$id: UUID!,
$input: verifyPhoneNumberInput
) {
userVerifyPhoneNumber(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": verifyPhoneNumberInput
}
Response
{"data": {"userVerifyPhoneNumber": true}}
verifyPhoneNumber
use userVerifyPhoneNumber instead
Description
Verify phone number of the current authenticated user using code.
Possible error codes:
- PHONE_NUMBER_ALREADY_VERIFIED
- PHONE_NUMBER_WRONG_VERIFICATION_CODE
- PHONE_NUMBER_VERIFICATION_CODE_EXPIRED
- INTERNAL_SERVER_ERROR
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - verifyPhoneNumberInput
|
Example
Query
mutation verifyPhoneNumber(
$id: UUID!,
$input: verifyPhoneNumberInput
) {
verifyPhoneNumber(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": verifyPhoneNumberInput
}
Response
{"data": {"verifyPhoneNumber": true}}
webhookCreate
Description
Create Webhook mutation
Roles:
- ROLE_WEBHOOK_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
Response
Returns a WebhookResponse!
Arguments
| Name | Description |
|---|---|
input - WebhookCreateInput!
|
Example
Query
mutation webhookCreate($input: WebhookCreateInput!) {
webhookCreate(input: $input) {
id
signature
}
}
Variables
{"input": WebhookCreateInput}
Response
{
"data": {
"webhookCreate": {
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"signature": "abc123"
}
}
}
webhookDelete
Description
Delete Webhook mutation
Roles:
- ROLE_WEBHOOK_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- WEBHOOK_IS_ALREADY_DELETED
webhookUpdate
Description
Update Webhook mutation
Roles:
- ROLE_WEBHOOK_ADMIN
Possible error codes:
- INTERNAL_SERVER_ERROR
- WEBHOOK_IS_DELETED
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
id - UUID!
|
|
input - WebhookUpdateInput
|
Example
Query
mutation webhookUpdate(
$id: UUID!,
$input: WebhookUpdateInput
) {
webhookUpdate(
id: $id,
input: $input
)
}
Variables
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"input": WebhookUpdateInput
}
Response
{"data": {"webhookUpdate": false}}
Types
AddCardCommentInput
AddCardToOrderInput
Fields
| Input Field | Description |
|---|---|
orderId - UUID!
|
Order Id |
card - CardInput!
|
|
address - ShippingAddressInput
|
|
externalReference - String
|
External Reference number |
Example
{
"orderId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"card": CardInput,
"address": ShippingAddressInput,
"externalReference": "xyz789"
}
AddChargeRecordInput
Fields
| Input Field | Description |
|---|---|
chargePointOperatorId - UUID!
|
Charge point operator ID |
chargeTokenId - UUID
|
Charge token ID |
authMethod - AuthMethod!
|
Auth method |
currency - String!
|
currency |
id - UUID!
|
Charge record ID |
lastUpdated - DateTimeUtc!
|
Last updated |
startTime - DateTimeUtc!
|
Start date time |
endTime - DateTimeUtc!
|
Stop date time |
meterId - String
|
Meter ID |
totalCost - Float!
|
Total cost |
totalCostEuro - Float!
|
Total cost in euro |
totalEnergy - Float!
|
Total energy in kWh |
totalTime - Float!
|
Total time |
totalParkingTime - Float
|
Total parking time |
remark - String
|
Remark. an be used to provide addition human readable information to the Charge record. |
locationId - UUID!
|
Location ID of the Charge record. |
evseId - UUID!
|
EVSE ID of the Charge record. |
connectorId - UUID!
|
Connector ID of the Charge record. |
chargingPeriods - [ChargingPeriodInput!]!
|
Charging periods explaining the Charge record. |
tariffs - [TariffInput]
|
Tariff details at the time of the Charge record. |
Example
{
"chargePointOperatorId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"chargeTokenId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"authMethod": "AUTH_REQUEST",
"currency": "abc123",
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"lastUpdated": DateTimeUtc,
"startTime": DateTimeUtc,
"endTime": DateTimeUtc,
"meterId": "xyz789",
"totalCost": 987.65,
"totalCostEuro": 123.45,
"totalEnergy": 123.45,
"totalTime": 987.65,
"totalParkingTime": 987.65,
"remark": "xyz789",
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"evseId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"connectorId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"chargingPeriods": [ChargingPeriodInput],
"tariffs": [TariffInput]
}
AddChargeTokenToChargePointOperatorInput
Fields
| Input Field | Description |
|---|---|
chargePointOperatorId - UUID!
|
Charge point operator ID |
Example
{
"chargePointOperatorId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
AddCompanyForExpenseTrackingInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Company name |
vatNumber - String!
|
VAT number |
email - String!
|
Company email. Should be correct email format |
invoiceEmail - [String!]
|
Company invoice email. Should be correct email format |
invoiceTransmissionPreference - [InvoiceVia!]
|
Invoice transmission preference. See InvoiceVia enum |
language - Locale!
|
Locale Code. See Locale enum |
address - AddressInput!
|
Company address |
Example
{
"name": "xyz789",
"vatNumber": "abc123",
"email": "abc123",
"invoiceEmail": ["abc123"],
"invoiceTransmissionPreference": ["EMAIL"],
"language": "NL",
"address": AddressInput
}
AddEfasDetailsInput
Fields
| Input Field | Description |
|---|---|
cardProfileReference - String
|
Card profile reference |
cardBinRanges - [CardBinRanges]
|
Card Bin Ranges |
Example
{
"cardProfileReference": "xyz789",
"cardBinRanges": [CardBinRanges]
}
AddEmablerSiteIdInput
Fields
| Input Field | Description |
|---|---|
siteId - Int!
|
The id of the eMabler site |
Example
{"siteId": 987}
AddExpenseReportTransactionInput
Fields
| Input Field | Description |
|---|---|
externalReference - String!
|
Company External Reference and should be exists in companies table |
cardToken - String!
|
Card Token and must be exists in cards table |
transactionReferenceNumber - String!
|
Transaction Reference Number and should be unique |
cardNumber - String!
|
Card Number |
transactionDate - DateTime!
|
Transaction Date |
purchaseAmount - Int!
|
Transaction Amount |
redemptionAmount - Int!
|
Redemption Amount |
currency - String!
|
Transaction Currency |
quantity - Int!
|
Quantity of transaction |
productCode - String!
|
Product Code and should be exists in products table |
branchName - String!
|
Gas Station Branch Name and should be exists in gas_stations table |
taxRate - Float!
|
Tax Rate |
Example
{
"externalReference": "abc123",
"cardToken": "abc123",
"transactionReferenceNumber": "xyz789",
"cardNumber": "abc123",
"transactionDate": "2007-12-03T10:15:30Z",
"purchaseAmount": 123,
"redemptionAmount": 987,
"currency": "xyz789",
"quantity": 123,
"productCode": "xyz789",
"branchName": "xyz789",
"taxRate": 987.65
}
AddExternalIdToGasStationInput
Fields
| Input Field | Description |
|---|---|
gasStationId - UUID!
|
|
externalId - String!
|
|
provider - FuelCardProvider!
|
Example
{
"gasStationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "xyz789",
"provider": "EFAS"
}
AddExternalIdToProductInput
Fields
| Input Field | Description |
|---|---|
productId - UUID!
|
|
externalId - String!
|
|
provider - FuelCardProvider!
|
Example
{
"productId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "xyz789",
"provider": "EFAS"
}
AddFuelTransactionInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
The identifier |
fuelCardId - UUID!
|
Fuel card identifier |
deliveryDate - DateTimeUtc!
|
Delivery date in UTC |
deliveryTime - DateTimeUtc!
|
Delivery time in UTC |
locationId - UUID!
|
Gas station identifier |
productId - UUID!
|
Product identifier |
receiptNumber - String!
|
Receipt number |
volume - Float!
|
Volume in liters |
price - Float!
|
Price in euros |
mileage - Int
|
Mileage |
Example
{
"id": "xyz789",
"fuelCardId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"deliveryDate": DateTimeUtc,
"deliveryTime": DateTimeUtc,
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"productId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"receiptNumber": "xyz789",
"volume": 987.65,
"price": 987.65,
"mileage": 987
}
AddKilometreChargeInput
Example
{
"provider": "SATELLIC",
"sheetNumber": "xyz789",
"externalReference": "xyz789",
"amount": 123,
"currency": "abc123",
"paymentTransactionId": "xyz789",
"city": "abc123"
}
AddOrderCommentInput
AddPackageToOrderInput
AddPhoneNumberForTenantInput
Fields
| Input Field | Description |
|---|---|
phoneNumber - String!
|
Phone number |
phoneNumberType - PhoneNumberType!
|
Phone number type. See PhoneNumberType enum |
country - Country!
|
Country of the phone number |
Example
{
"phoneNumber": "xyz789",
"phoneNumberType": "LANDLINE",
"country": "AL"
}
AddProductToCategoryInput
Fields
| Input Field | Description |
|---|---|
productId - UUID!
|
Product id. Verify its existence in the products model. |
Example
{
"productId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
AddProductToGasStationInput
AddRolesToUserInput
Fields
| Input Field | Description |
|---|---|
roles - [RoleEnum!]
|
Array of predefined roles |
Example
{"roles": ["ROLE_SUPER_ADMIN"]}
AddToFavoriteInput
Fields
| Input Field | Description |
|---|---|
locationId - UUID!
|
Location id |
serviceType - FavoriteServiceType!
|
Location type |
Example
{
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"serviceType": "CHARGING"
}
AddTokenizedCardToCompanyInput
Fields
| Input Field | Description |
|---|---|
vatNumber - String!
|
VAT number |
tokenInfo - TokenInfoInput!
|
Card Token Information |
maskedBankNumber - String
|
Masked bank number |
Example
{
"vatNumber": "xyz789",
"tokenInfo": TokenInfoInput,
"maskedBankNumber": "abc123"
}
AddUserOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
employees - [EmployeeDetail!]!
|
List of employees to add to the organizational component |
Example
{"employees": [EmployeeDetail]}
AddUsersToRoleInput
Fields
| Input Field | Description |
|---|---|
users - [UUID!]
|
Array of internal UUIDs of users |
Example
{
"users": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
AddVehicleInput
Address
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The address identifier |
tenantId - UUID
|
The tenant identifier |
street - String!
|
Street |
houseNumber - String!
|
House number |
houseNumberAddition - String
|
House number addition |
postalCode - String!
|
Postal code |
city - String
|
City |
country - Country!
|
Country |
province - String
|
Province |
location - Coordinates
|
Location |
area - String
|
Area |
createdAt - DateTimeUtc!
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User!
|
Created by |
updatedBy - User!
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "xyz789",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "abc123",
"city": "abc123",
"country": "AL",
"province": "abc123",
"location": Coordinates,
"area": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
AddressConnection
Description
A paginated list of Address edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [AddressEdge!]!
|
A list of Address edges. |
Example
{
"pageInfo": PageInfo,
"edges": [AddressEdge]
}
AddressCoordinates
AddressDetails
Example
{
"street": "abc123",
"houseNumber": "xyz789",
"houseNumberAddition": "xyz789",
"postalCode": "xyz789",
"city": "xyz789",
"country": "xyz789"
}
AddressEdge
AddressInput
Example
{
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "xyz789",
"country": "AL",
"city": "xyz789"
}
AddressLookupInput
Example
{
"street": "xyz789",
"houseNumber": "xyz789",
"houseNumberAddition": "xyz789",
"postalCode": "abc123",
"country": "AL"
}
AddressLookupResponse
Alert
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier. Reference to Alerts service |
gasStations - [GasStation!]
|
List of gas stations alert belongs to |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"gasStations": [GasStation]
}
AnonymousUserInput
Fields
| Input Field | Description |
|---|---|
locale - Locale!
|
Locale |
paymentMethod - PaymentMethod!
|
Payment method |
tenantId - UUID!
|
Tenant |
Example
{
"locale": "NL",
"paymentMethod": "DIRECT_DEBIT",
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
AssociatedEntities
Fields
| Input Field | Description |
|---|---|
entityType - EntityModel!
|
Entity type. See EntityModel enum |
entityId - UUID!
|
Entity Id |
Example
{
"entityType": "COMPANY",
"entityId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Association
Types
| Union Types |
|---|
Example
FuelCard
AssociationType
Description
The type of association between entities and price modification
Values
| Enum Value | Description |
|---|---|
|
|
Price modification association is with single entity. |
|
|
Price modification association is with multiple entities. |
Example
"SINGLE"
AttachPriceModificationToEntityInput
Fields
| Input Field | Description |
|---|---|
associationType - AssociationType!
|
Association Type. See AssociationType enum |
associations - [AssociatedEntities!]!
|
Associations. Provide Array of Entity type and Entity Id |
Example
{
"associationType": "SINGLE",
"associations": [AssociatedEntities]
}
AuthMethod
Values
| Enum Value | Description |
|---|---|
|
|
Authentication request from the eMSP |
|
|
Whitelist used to authenticate, no request done to the eMSP |
Example
"AUTH_REQUEST"
BillingPeriod
Description
Invoice billing period.
Values
| Enum Value | Description |
|---|---|
|
|
Monthly billing period. Invoices will run on the first day of the new month. |
|
|
Weekly billing period. Invoices will run every 8th, 15th, 23rd and 1st. |
|
|
Biweekly billing period. Invoices will run every 15th and 1st. |
Example
"MONTHLY"
BinRange
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"binRangeStart": "xyz789",
"binRangeEnd": "abc123",
"binRangePrefix": 987,
"cardLength": 987,
"isActive": false
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Brand
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
BuilderInput
Fields
| Input Field | Description |
|---|---|
invoiceRows - Boolean
|
Invoice rows |
transactionBlocks - [TransactionBlockInput!]!
|
Invoice transaction blocks |
Example
{
"invoiceRows": false,
"transactionBlocks": [TransactionBlockInput]
}
CancelMandateInput
Fields
| Input Field | Description |
|---|---|
reason - String
|
The reason for cancelling the mandate |
Example
{"reason": "abc123"}
Card
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant
|
The tenant that the card belongs to. |
limit - TemplateLimit
|
Template's transactions/amount limits |
chargePointOperatorPool - ChargePointOperatorPool
|
The charge point operator pool that the card belongs to. |
chargePointOperators - [ChargePointOperator!]
|
The charge point operator that the card belongs to. |
template - Template
|
The template that the card belongs to. |
cardType - CardType!
|
Type of card |
company - OrganizationalComponent
|
The company that the card belongs to. |
companyName - String
|
Company Name |
user - User
|
The User that the card belongs to. |
vehicle - Vehicle
|
The vehicle that the card belongs to. |
externalReference - String
|
External reference number of card |
cardNumber - String
|
Card number generated |
associations - [Association!]
|
Associations of card ( Chargetoken/Fuel) |
products - [Product!]
|
Associated products of card |
locations - [CardLocation!]
|
locations of card |
comments - [CardComment]
|
Comments of card |
mileageRequired - Boolean!
|
Is mileage required at time of fueling |
driverCodeRequired - Boolean
|
Is driver code required at time of fueling |
tokenUid - String
|
Charge token UUID |
panNumber - String
|
PAN number of card |
order - Order
|
The order that the card belongs to. |
locale - String
|
Card's Locale |
disabledAt - DateTimeUtc
|
Disabled at |
createdAt - DateTimeUtc
|
Created At |
updatedAt - DateTimeUtc
|
Updated At |
token - String
|
Card token. |
maskedBankNumber - String
|
Masked card number. |
trackingStartsFrom - DateTimeUtc!
|
Tracking starts from date. |
metadata - [Value]
|
|
printInfo - PrintInfo
|
|
priceModifications - [PriceModification]!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"limit": TemplateLimit,
"chargePointOperatorPool": ChargePointOperatorPool,
"chargePointOperators": [ChargePointOperator],
"template": Template,
"cardType": "CHARGE",
"company": OrganizationalComponent,
"companyName": "abc123",
"user": User,
"vehicle": Vehicle,
"externalReference": "abc123",
"cardNumber": "abc123",
"associations": [FuelCard],
"products": [Product],
"locations": [CardLocation],
"comments": [CardComment],
"mileageRequired": false,
"driverCodeRequired": false,
"tokenUid": "abc123",
"panNumber": "xyz789",
"order": Order,
"locale": "abc123",
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"token": "abc123",
"maskedBankNumber": "abc123",
"trackingStartsFrom": DateTimeUtc,
"metadata": [Value],
"printInfo": PrintInfo,
"priceModifications": [PriceModification]
}
CardBinRanges
Example
{
"binRangeStart": "xyz789",
"binRangeEnd": "abc123",
"binRangePrefix": 987,
"cardLength": 987,
"isActive": false
}
CardChargeSettingsInput
Fields
| Input Field | Description |
|---|---|
charge - ChargeSettingsInput!
|
Example
{"charge": ChargeSettingsInput}
CardComment
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
card - Card!
|
Card for which comment belongs |
comment - String!
|
Comment |
createdAt - DateTimeUtc
|
Created at |
createdBy - User
|
Created by user |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"card": Card,
"comment": "abc123",
"createdAt": DateTimeUtc,
"createdBy": User
}
CardConnection
Description
A paginated list of Card edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CardEdge!]!
|
A list of Card edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CardEdge]
}
CardEdge
CardInput
Fields
| Input Field | Description |
|---|---|
templateId - UUID!
|
Card Template Id |
userId - UUID
|
User Id |
vehicleId - UUID
|
Vehicle Id |
packageId - UUID
|
Package Id |
printInfo - PrintInfoInput!
|
|
fuel - FuelSettingsInput
|
|
charge - ChargeSettingsInput
|
|
mileageRequired - Boolean
|
Mileage required |
comment - String
|
Comment |
Example
{
"templateId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"packageId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"printInfo": PrintInfoInput,
"fuel": FuelSettingsInput,
"charge": ChargeSettingsInput,
"mileageRequired": false,
"comment": "xyz789"
}
CardLocation
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
name - String!
|
Location name |
createdAt - DateTimeUtc
|
|
updatedAt - DateTimeUtc
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CardProduct
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
templateId - UUID!
|
The unique identifier of the Card template. |
template - Template!
|
Template type of Card |
userId - UUID
|
User Id |
user - User
|
User |
vehicleId - UUID
|
Vehicle Id |
vehicle - Vehicle
|
Vehicle |
printInfo - PrintInfo!
|
Print information of Card for printing purpose |
fuel - FuelSetting
|
Fuel settings for Fueling purpose |
charge - ChargeSetting
|
Charge settings for Charge |
mileageRequired - Boolean!
|
Mileage required at the time of Fueling |
card - Card
|
Card |
comment - String
|
Comment if any |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"templateId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"template": Template,
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"user": User,
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicle": Vehicle,
"printInfo": PrintInfo,
"fuel": FuelSetting,
"charge": ChargeSetting,
"mileageRequired": false,
"card": Card,
"comment": "xyz789"
}
CardStatisticsDifference
CardType
Description
Card type.
Values
| Enum Value | Description |
|---|---|
|
|
Charge token. |
|
|
Fuel card. |
|
|
Hybrid card. Capable of both Charging and Fuel. |
|
|
Legacy card. Can be used as a card type from legacy systems. |
|
|
Tokenized bank card. Used in expense reporting. |
|
|
Xtra card. |
|
|
Shell NFC card. |
|
|
Mobile fuel card. |
|
|
Mobile charge card. |
|
|
Open loop card. |
|
|
Legacy charge card. |
Example
"CHARGE"
CdrDimension
Description
The Charge Record Dimension is a representation of the OCPI CDR Dimension object.
See CdrDimension for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
type - ChargeRecordDimensionType!
|
Type of the dimension. See ChargeRecordDimensionType ENUM for possible values. |
volume - Float!
|
The volume of the dimension consumed. |
Example
{"type": "ENERGY", "volume": 123.45}
ChangePinInput
Fields
| Input Field | Description |
|---|---|
pin - String!
|
Card new pin 4 digits |
Example
{"pin": "abc123"}
ChargeConnector
Description
The ChargeConnector is a representation of the OCPI Connector object. A connector is the socket or cable available for the EV to use.
See Connector for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
externalId - String
|
ID of the connector as known by the charge point operator. |
evse - ChargeLocationEVSE!
|
EVSE this connector belongs to. |
standard - ConnectorType!
|
The standard of the installed connector. See ConnectorType enum. |
format - ConnectorFormat!
|
The format (socket/cable) of the installed connector. See ConnectorFormat enum. |
powerType - ConnectorPowerType!
|
type of electrical power supply. See ConnectorPowerType enum. |
voltage - Int!
|
Voltage of the connector in Volt. |
amperage - Int!
|
Maximum amperage of the connector in Ampere. |
tariff - ChargeTariff
|
Connector tariff |
kwh - Int
|
KWH output of the connector. |
lastUpdated - DateTimeUtc
|
Datetime the connector was last updated by the CPO. |
createdAt - DateTimeUtc
|
Datetime the connector was created in the system. This is not the same as the date the connector was created in the CPO system. |
updatedAt - DateTimeUtc
|
Datetime the connector was last updated in the system. This is not the same as the date the connector was last updated in the CPO system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "xyz789",
"evse": ChargeLocationEVSE,
"standard": "CHADEMO",
"format": "SOCKET",
"powerType": "AC_1_PHASE",
"voltage": 123,
"amperage": 123,
"tariff": ChargeTariff,
"kwh": 123,
"lastUpdated": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeLocation
Description
The ChargeLocation is a representation of the OCPI Location object.
See mod_locations for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
externalId - String
|
ID of the location as known by the charge point operator. |
chargePointOperator - ChargePointOperator!
|
Charge point operator this location belongs to. |
type - ChargeLocationType!
|
Type of location. See ChargeLocationType enum. |
name - String
|
Name of location |
address - String
|
Address of location. |
city - String
|
City of location. |
postalCode - String
|
Postal code of location. |
country - String
|
ISO 3166-1 alpha-3 code for the country of this location. |
coordinates - Coordinates!
|
Coordinates of location. The geodetic system to be used is WGS 84. |
evses - [ChargeLocationEVSE!]
|
EVSEs at this location. |
openingTimes - [ChargeLocationOpeningTimes!]
|
Opening times for this location. |
energyMix - ChargingEnergyMix
|
Energy mix of this location. |
operator - ChargeLocationBusinessDetails
|
Operator of this location. |
suboperator - ChargeLocationBusinessDetails
|
Suboperator of this location. |
owner - ChargeLocationBusinessDetails
|
Owner of this location |
timeZone - String
|
Time zone of the location. Examples: "Europe/Oslo", "Europe/Zurich". |
chargingWhenClosed - Boolean
|
Indicates if the location is still able to charge outside of opening hours of the location. |
isFavorited - Boolean
|
Indicates if this location has been marked favorite by the authenticated user. |
distance - Float
|
Distance to the search radius in meters. Null by default but will be set when using the searchRadius parameter in the chargeLocations parameter. |
lastUpdated - DateTimeUtc
|
Datetime the location was last updated by the CPO. |
createdAt - DateTimeUtc
|
Datetime the location was created in the system. This is not the same as the date the location was created in the CPO system. |
updatedAt - DateTimeUtc
|
Datetime the location was last updated in the system. This is not the same as the date the location was last updated in the CPO system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"chargePointOperator": ChargePointOperator,
"type": "ON_STREET",
"name": "abc123",
"address": "abc123",
"city": "abc123",
"postalCode": "abc123",
"country": "abc123",
"coordinates": Coordinates,
"evses": [ChargeLocationEVSE],
"openingTimes": [ChargeLocationOpeningTimes],
"energyMix": ChargingEnergyMix,
"operator": ChargeLocationBusinessDetails,
"suboperator": ChargeLocationBusinessDetails,
"owner": ChargeLocationBusinessDetails,
"timeZone": "abc123",
"chargingWhenClosed": false,
"isFavorited": false,
"distance": 123.45,
"lastUpdated": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeLocationBusinessDetails
Description
The Charge Location Business Details is a representation of the OCPI Business Details object. This object is used for the operator, suboperator and owner of the location.
See BusinessDetails for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
name - String
|
Name of the operator. |
website - String
|
Link to the operator's website. |
logo - ChargeLocationImage
|
Image link to the operator's logo. |
Example
{
"name": "xyz789",
"website": "abc123",
"logo": ChargeLocationImage
}
ChargeLocationConnection
Description
A paginated list of ChargeLocation edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ChargeLocationEdge!]!
|
A list of ChargeLocation edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ChargeLocationEdge]
}
ChargeLocationEVSE
Description
The ChargeLocationEVSE is a representation of the OCPI EVSE (electric vehicle supply equipment) object.
See EVSE for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
externalId - String
|
ID of the EVSE as known by the charge point operator. |
evseId - String
|
eMI3 standard version V1.0 compliant EVSE ID. |
location - ChargeLocation!
|
Charge location this EVSE belongs to. |
status - EvseStatus!
|
EVSE status. See EvseStatus enum. |
floorLevel - String
|
Indicates the level at which the EVSE is located. |
coordinates - Coordinates
|
EVSE coordinates. The geodetic system to be used is WGS 84. |
connectors - [ChargeConnector!]!
|
List of connectors available on the EVSE. |
capabilities - [EvseCapability!]!
|
List of functionalities that the EVSE is capable of. See EvseCapability enum. |
parkingRestrictions - [ChargingParkingRestriction!]
|
The restrictions that apply to the parking spot. |
lastUpdated - DateTimeUtc
|
Datetime the EVSE was last updated by the CPO. |
createdAt - DateTimeUtc
|
Datetime the EVSE was created in the system. This is not the same as the date the EVSE was created in the CPO system. |
updatedAt - DateTimeUtc
|
Datetime the EVSE was last updated in the system. This is not the same as the date the EVSE was last updated in the CPO system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"evseId": "abc123",
"location": ChargeLocation,
"status": "AVAILABLE",
"floorLevel": "xyz789",
"coordinates": Coordinates,
"connectors": [ChargeConnector],
"capabilities": [EvseCapability],
"parkingRestrictions": [ChargingParkingRestriction],
"lastUpdated": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeLocationEdge
Description
An edge that contains a node of type ChargeLocation and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ChargeLocation!
|
The ChargeLocation node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ChargeLocation,
"cursor": "abc123"
}
ChargeLocationGeoJson
Description
Charge Location GeoJSON response
Fields
| Field Name | Description |
|---|---|
type - String
|
Type of the GeoJSON object. Options: Feature and FeatureCollection |
features - [Features]
|
List of GeoJSON features |
Example
{
"type": "abc123",
"features": [Features]
}
ChargeLocationImage
Description
The Charge Location Image is a representation of the OCPI Image object.
See Image for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
url - String!
|
Image URL. |
thumbnail - String
|
Image thumbnail URL. |
type - String!
|
Image type like gif, jpeg, png, svg. |
category - ChargeLocationImageCategory!
|
Describes what the image is used for. See ChargeLocationImageCategory enum. |
width - Int
|
Image width the of full scale image. |
height - Int
|
Image height of the full scale image. |
Example
{
"url": "abc123",
"thumbnail": "abc123",
"type": "xyz789",
"category": "CHARGER",
"width": 123,
"height": 123
}
ChargeLocationImageCategory
Description
The charge location image category enum
Values
| Enum Value | Description |
|---|---|
|
|
Photo of the physical device that contains one or more EVSEs. |
|
|
Location entrance photo. Should show the car entrance to the location from street side. |
|
|
Location overview photo. |
|
|
logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information view |
|
|
logo of the charge points operator, for example a municipality, to be displayed with the EVSEs detailed information view or in lists and maps, if no networkLogo is present |
|
|
Other |
|
|
logo of the charge points owner, for example a local store, to be displayed with the EVSEs detailed information view |
Example
"CHARGER"
ChargeLocationOpeningTimes
Description
The Charge location opening times is a representation of the OCPI Hours object.
See Hours for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
location - ChargeLocation!
|
Charge location this opening times belongs to. |
weekday - Int
|
Number of day in the week, from Monday (1) till Sunday (7). |
startTime - DateTimeUtc
|
Begin of the opening time given in hours and minutes. Example: "07:00". |
endTime - String
|
End time of the opening time given in hours and minutes. Example: "21:00". |
twentyFourSeven - Boolean
|
True to represent 24 hours a day and 7 days a week. |
createdAt - DateTimeUtc
|
Datetime the connector was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the connector was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"location": ChargeLocation,
"weekday": 987,
"startTime": DateTimeUtc,
"endTime": "abc123",
"twentyFourSeven": false,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeLocationType
Values
| Enum Value | Description |
|---|---|
|
|
Parking in public space. |
|
|
Multistorey car park. |
|
|
Multistorey car park, mainly underground. |
|
|
A cleared area that is intended for parking vehicles, i.e. at super markets, bars etc. |
|
|
None of the given possibilities. |
|
|
Parking location type is not known by the operator (default). |
Example
"ON_STREET"
ChargePointOperator
Description
The charge point operator which we connected to through the OCPI specification.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
versions - [Version]
|
Available versions of the charge point operator. |
pivot - ChargePointOperatorTokenPivot
|
Pivot data between the charge point operator and the charge token |
chargePointOperatorPools - [ChargePointOperatorPool]
|
Charge point operator pools this charge point operator belongs to |
name - String!
|
Name of the charge point operator |
url - String!
|
URL of the charge point operator |
versionPath - String
|
The version path of the URL |
activeVersion - String
|
The active version of the charge point operator |
partyId - String!
|
CPO or eMSP ID of this party. (following the 15118 ISO standard). |
countryCode - String!
|
Country code of the country this party is operating in. |
disabledAt - DateTime
|
Datetime that the charge point operator was disabled. Null if enabled. |
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
tokens - ChargeTokenConnection!
|
Tokens known by the charge point operator |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"versions": [Version],
"pivot": ChargePointOperatorTokenPivot,
"chargePointOperatorPools": [ChargePointOperatorPool],
"name": "xyz789",
"url": "xyz789",
"versionPath": "xyz789",
"activeVersion": "xyz789",
"partyId": "xyz789",
"countryCode": "abc123",
"disabledAt": "2007-12-03T10:15:30Z",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"tokens": ChargeTokenConnection
}
ChargePointOperatorConnection
Description
A paginated list of ChargePointOperator edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ChargePointOperatorEdge!]!
|
A list of ChargePointOperator edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ChargePointOperatorEdge]
}
ChargePointOperatorEdge
Description
An edge that contains a node of type ChargePointOperator and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ChargePointOperator!
|
The ChargePointOperator node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ChargePointOperator,
"cursor": "xyz789"
}
ChargePointOperatorPool
Description
Charge point operator Pool
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the charge point operator pool. |
label - String!
|
Label of the charge point operator pool. |
chargePointOperators - [ChargePointOperator]
|
Charge point operators in the pool. |
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"label": "xyz789",
"chargePointOperators": [ChargePointOperator],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
ChargePointOperatorTokenPivot
Description
Pivot data between the charge token and the charge point operator
Fields
| Field Name | Description |
|---|---|
authId - String
|
Auth Id as known by the specific charge point operator |
visualNumber - String
|
The visual number as displayed on the token. |
disabledAt - DateTimeUtc
|
Whether the token is disabled at the charge point operator |
whitelist - WhitelistType!
|
Whitelist type of the token. See WhitelistType ENUM for possible values. |
syncedAt - DateTimeUtc
|
Whether the token has been synced to the charge point operator since the last changes |
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
Example
{
"authId": "abc123",
"visualNumber": "xyz789",
"disabledAt": DateTimeUtc,
"whitelist": "ALWAYS",
"syncedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
ChargePointTransaction
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the User. |
token - ChargeToken
|
The unique ID of the Token. |
charger - Charger!
|
|
tokenType - String
|
The token type |
tokenUid - String
|
The token type |
sessionId - UUID!
|
The unique ID of the Session. |
transactionId - String!
|
The unique ID of the transaction. |
contractId - String
|
The unique ID of the contract. |
chargerId - String!
|
The unique ID of the charge point. |
evseUid - String!
|
The unique UID of the charge point location evse. |
evseId - String!
|
The unique ID of the charge point location evse. |
socketId - Int
|
The number of the socket. |
externalTariffId - String
|
The unique ID of the external tariff. |
cdrTariffType - String
|
The tarriff type. |
startDate - DateTime!
|
The start date time of the transaction. |
endDate - DateTime!
|
The end date time of the transaction. |
lastUpdated - DateTime!
|
The last updated date time of the transaction. |
totalCostInclVat - Money
|
Total cost of the transaction including VAT. |
totalCostExclVat - Money
|
Total cost of the transaction excluding VAT. |
totalFixedCostInclVat - Money
|
Total fixed cost of the transaction including VAT. |
totalFixedCostExclVat - Money
|
Total fixed cost of the transaction excluding VAT. |
totalEnergyCostInclVat - Money
|
Total energy cost of the transaction including VAT. |
totalEnergyCostExclVat - Money
|
Total energy cost of the transaction excluding VAT. |
totalTimeCostInclVat - Money
|
Total time cost of the transaction including VAT. |
totalTimeCostExclVat - Money
|
Total time cost of the transaction excluding VAT. |
totalParkingTimeCostInclVat - Money
|
Total parking time cost of the transaction including VAT. |
totalParkingTimeCostExclVat - Money
|
Total parking time cost of the transaction excluding VAT. |
consumption - Float!
|
Total consumption in KWH. |
address - String!
|
The address of the charge point. |
city - String!
|
The city of the charge point. |
country - String!
|
The country of the charge point. ISO 3166-1 alpha-3. |
createdAt - DateTimeUtc
|
The date time the transaction was created in the database |
updatedAt - DateTimeUtc
|
The date time the transaction was last updated in the database |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"token": ChargeToken,
"charger": Charger,
"tokenType": "abc123",
"tokenUid": "xyz789",
"sessionId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"transactionId": "xyz789",
"contractId": "xyz789",
"chargerId": "abc123",
"evseUid": "abc123",
"evseId": "abc123",
"socketId": 123,
"externalTariffId": "xyz789",
"cdrTariffType": "xyz789",
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"lastUpdated": "2007-12-03T10:15:30Z",
"totalCostInclVat": Money,
"totalCostExclVat": Money,
"totalFixedCostInclVat": Money,
"totalFixedCostExclVat": Money,
"totalEnergyCostInclVat": Money,
"totalEnergyCostExclVat": Money,
"totalTimeCostInclVat": Money,
"totalTimeCostExclVat": Money,
"totalParkingTimeCostInclVat": Money,
"totalParkingTimeCostExclVat": Money,
"consumption": 987.65,
"address": "xyz789",
"city": "abc123",
"country": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargePointTransactionConnection
Description
A paginated list of ChargePointTransaction edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ChargePointTransactionEdge!]!
|
A list of ChargePointTransaction edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ChargePointTransactionEdge]
}
ChargePointTransactionEdge
Description
An edge that contains a node of type ChargePointTransaction and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ChargePointTransaction!
|
The ChargePointTransaction node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ChargePointTransaction,
"cursor": "abc123"
}
ChargePriceComponent
Description
The Charge Price Component is a representation of the OCPI Price Component object.
See PriceComponent for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the price component. |
tariffElement - ChargeTariffElement!
|
Tariff element this price component belongs to. |
type - TariffDimensionType!
|
Price component tariff dimension type. See TariffDimensionType enum. |
price - Float!
|
price per unit (excluding VAT) for this tariff dimension. |
stepSize - Int!
|
Minimum amount to be billed. This unit will be billed in this step_size blocks. |
createdAt - DateTimeUtc
|
Datetime the price component was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the price component was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tariffElement": ChargeTariffElement,
"type": "ENERGY",
"price": 987.65,
"stepSize": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeRecord
Description
The Charge record is a representation of the OCPI Charge record object with additions by our system.
See CDR for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
externalId - String!
|
The ID of the charge record as known by the charge point operator. |
startDate - DateTimeUtc!
|
Start date and time of the charging session. |
endDate - DateTimeUtc!
|
End date and time of the charging session. |
lastUpdated - DateTimeUtc!
|
The last updated date and time of the charge record by the charge point operator. |
token - ChargeToken!
|
The token this charge record is related to. |
chargePointOperator - ChargePointOperator!
|
The charge point operator this charge record is related to. |
location - ChargeLocation
|
The location this charge record is related to. |
evse - ChargeLocationEVSE
|
The Charge location EVSE this charge record is related to. |
connector - ChargeConnector
|
The Charge location connector this charge record is related to. |
totalCost - Money!
|
Total cost (excluding VAT) of the charging session. |
totalCostEur - Money!
|
Total cost (excluding VAT) of the charging session in EUR. |
totalEnergy - Float!
|
Total energy (in kWh) charged during the session. |
totalTime - Int!
|
Total time (in seconds) the vehicle was at the charge location. |
totalParkingTime - Int
|
Total time (in seconds) the vehicle spent parking at the charge location. |
chargingPeriods - [ChargingPeriod]
|
A list of charging periods explaining the cost of the Charge Record. |
tariffs - [ChargeRecordTariff]
|
List of relevant tariffs for the duration of this Charge Record |
createdAt - DateTimeUtc
|
Datetime the charge record was created in the system. This is not the same as the date the charge record was created in the CPO system. |
updatedAt - DateTimeUtc
|
Datetime the charge record was last updated in the system. This is not the same as the date the charge record was last updated in the CPO system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"startDate": DateTimeUtc,
"endDate": DateTimeUtc,
"lastUpdated": DateTimeUtc,
"token": ChargeToken,
"chargePointOperator": ChargePointOperator,
"location": ChargeLocation,
"evse": ChargeLocationEVSE,
"connector": ChargeConnector,
"totalCost": Money,
"totalCostEur": Money,
"totalEnergy": 123.45,
"totalTime": 987,
"totalParkingTime": 987,
"chargingPeriods": [ChargingPeriod],
"tariffs": [ChargeRecordTariff],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeRecordConnection
Description
A paginated list of ChargeRecord edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ChargeRecordEdge!]!
|
A list of ChargeRecord edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ChargeRecordEdge]
}
ChargeRecordDimensionType
Values
| Enum Value | Description |
|---|---|
|
|
defined in kWh, default step_size is 1 Wh |
|
|
flat fee, no unit |
|
|
defined in A (Ampere), Maximum current reached during charging session |
|
|
defined in A (Ampere), Minimum current used during charging session |
|
|
time not charging: defined in hours, default step_size is 1 second |
|
|
time charging: defined in hours, default step_size is 1 second |
Example
"ENERGY"
ChargeRecordEdge
Description
An edge that contains a node of type ChargeRecord and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ChargeRecord!
|
The ChargeRecord node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ChargeRecord,
"cursor": "xyz789"
}
ChargeRecordPriceComponent
Fields
| Field Name | Description |
|---|---|
type - TariffDimensionType!
|
Price component type. |
price - Float!
|
Price component price. |
stepSize - Int!
|
Price component step size. |
Example
{"type": "ENERGY", "price": 123.45, "stepSize": 123}
ChargeRecordTariff
Fields
| Field Name | Description |
|---|---|
id - String
|
The tariff external ID |
currency - String!
|
Currency of this tariff, ISO 4217 Code |
elements - [ChargeRecordTariffElement!]
|
Tariff price elements. |
Example
{
"id": "abc123",
"currency": "abc123",
"elements": [ChargeRecordTariffElement]
}
ChargeRecordTariffElement
Fields
| Field Name | Description |
|---|---|
priceComponents - [ChargeRecordPriceComponent]
|
Tariff element price components. |
restrictions - ChargeRecordTariffRestrictions
|
Tariff element restrictions. |
Example
{
"priceComponents": [ChargeRecordPriceComponent],
"restrictions": ChargeRecordTariffRestrictions
}
ChargeRecordTariffRestrictions
Fields
| Field Name | Description |
|---|---|
startTime - String
|
Start time of the tariff element given in hours and minutes. Example: "07:00". |
endTime - String
|
End time of the tariff element given in hours and minutes. Example: "21:00". |
startDate - String
|
Start date of the tariff element. Example: "2020-01-01". |
endDate - String
|
End date of the tariff element. Example: "2020-12-31". |
minKwh - Float
|
Minimum used energy in kWh |
maxKwh - Float
|
Maximum used energy in kWh |
minPower - Float
|
Min power in kW |
maxPower - Float
|
Max power in kW |
minDuration - Float
|
Min duration in seconds |
maxDuration - Float
|
Max duration in seconds |
dayOfWeek - [String!]
|
Days of the week this element applies to Use daysOfWeek instead. |
daysOfWeek - [String!]
|
Days of the week this element applies to |
Example
{
"startTime": "abc123",
"endTime": "abc123",
"startDate": "xyz789",
"endDate": "abc123",
"minKwh": 987.65,
"maxKwh": 123.45,
"minPower": 123.45,
"maxPower": 123.45,
"minDuration": 987.65,
"maxDuration": 123.45,
"dayOfWeek": ["xyz789"],
"daysOfWeek": ["xyz789"]
}
ChargeSetting
ChargeSettingsInput
ChargeTariff
Description
The Charge Tariff is a representation of the OCPI Tariff object.
See Tariff for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
externalId - String
|
ID of the tariff as known by the charge point operator. |
chargePointOperator - ChargePointOperator!
|
Charge point operator this tariff belongs to. |
currency - String!
|
Currency of this tariff, ISO 4217 Code |
tariffAltText - String
|
Tariff text |
tariffAltUrl - String
|
Tariff URL |
energyMix - ChargingEnergyMix
|
Energy mix of this tariff. |
connectors - [ChargeConnector!]
|
Charge Connectors this tariff belongs to. |
elements - [ChargeTariffElement!]
|
Tariff price elements. |
lastUpdated - DateTimeUtc
|
Datetime the tariff was last updated by the CPO. |
createdAt - DateTimeUtc
|
Datetime the tariff was created in the system. This is not the same as the date the tariff was created in the CPO system. |
updatedAt - DateTimeUtc
|
Datetime the tariff was last updated in the system. This is not the same as the date the tariff was last updated in the CPO system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "abc123",
"chargePointOperator": ChargePointOperator,
"currency": "xyz789",
"tariffAltText": "xyz789",
"tariffAltUrl": "xyz789",
"energyMix": ChargingEnergyMix,
"connectors": [ChargeConnector],
"elements": [ChargeTariffElement],
"lastUpdated": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeTariffElement
Description
The Charge Tariff element is a representation of the OCPI Tariff Element object combined with the Tariff Restrictions.
See TariffElement for details on the OCPI object structure. See TariffRestrictions for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tariff - ChargeTariff!
|
Tariff this element belongs to. |
startTime - DateTimeUtc
|
Start time of the tariff element given in hours and minutes. Example: "07:00". |
endTime - DateTimeUtc
|
End time of the tariff element given in hours and minutes. Example: "21:00". |
startDate - Date
|
Start date of the tariff element. Example: "2020-01-01". |
endDate - Date
|
End date of the tariff element. Example: "2020-12-31". |
minKwh - Float
|
Minimum used energy in kWh |
maxKwh - Float
|
Maximum used energy in kWh |
minPower - Float
|
Min power in kW |
maxPower - Float
|
Max power in kW |
minDuration - Float
|
Min duration in seconds |
maxDuration - Float
|
Max duration in seconds |
daysOfWeek - [String!]
|
Days of the week this element applies to |
priceComponents - [ChargePriceComponent!]
|
Tariff element price components. |
createdAt - DateTimeUtc
|
Datetime the tariff element was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the tariff element was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tariff": ChargeTariff,
"startTime": DateTimeUtc,
"endTime": DateTimeUtc,
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"minKwh": 987.65,
"maxKwh": 987.65,
"minPower": 123.45,
"maxPower": 987.65,
"minDuration": 987.65,
"maxDuration": 123.45,
"daysOfWeek": ["abc123"],
"priceComponents": [ChargePriceComponent],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargeToken
Description
The Charge Token is a representation of the OCPI Token object with additions by our system.
See Token for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant!
|
Tenant the charge token belongs to. |
user - User
|
User the charge token belongs to. |
company - OrganizationalComponent
|
Organizational component the charge token belongs to. Use organizationalComponent instead. |
organizationalComponent - OrganizationalComponent
|
Organizational component the charge token belongs to. |
card - Card!
|
Card the charge token belongs to. |
chargePointOperatorPool - ChargePointOperatorPool
|
Charge point operator pool the token belongs to. |
pivot - ChargePointOperatorTokenPivot
|
Pivot data between the charge token and the charge point operator |
tokenUid - String
|
The charge token token UID as known by the charge point operators. In most cases this is the RFID hidden ID as read by the RFID reader |
type - ChargeTokenType!
|
The type of the token. See ChargeTokenType ENUM for possible values. |
issuer - String!
|
Issuing company, most of the times the name of the company printed on the token (RFID card), not necessarily the eMSP. |
language - String!
|
Language Code ISO 639-1. Indicactes the language used on the chargers |
externalReference - String
|
External reference. Can be used as a reference to an external system |
lastChargingSession - DateTimeUtc
|
The last recorded charge session with this token. |
disabledAt - DateTimeUtc
|
Datetime that the token was disabled. Null if enabled. |
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
chargePointOperators - ChargePointOperatorConnection!
|
List of charge point operators the token belongs to. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"user": User,
"company": OrganizationalComponent,
"organizationalComponent": OrganizationalComponent,
"card": Card,
"chargePointOperatorPool": ChargePointOperatorPool,
"pivot": ChargePointOperatorTokenPivot,
"tokenUid": "abc123",
"type": "RFID",
"issuer": "xyz789",
"language": "abc123",
"externalReference": "xyz789",
"lastChargingSession": DateTimeUtc,
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"chargePointOperators": ChargePointOperatorConnection
}
ChargeTokenConnection
Description
A paginated list of ChargeToken edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ChargeTokenEdge!]!
|
A list of ChargeToken edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ChargeTokenEdge]
}
ChargeTokenEdge
Description
An edge that contains a node of type ChargeToken and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ChargeToken!
|
The ChargeToken node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ChargeToken,
"cursor": "xyz789"
}
ChargeTokenType
Values
| Enum Value | Description |
|---|---|
|
|
RFID token |
|
|
Other type of token |
Example
"RFID"
Charger
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the User. |
chargerId - String!
|
|
group - ChargerGroup!
|
|
name - String!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"chargerId": "abc123",
"group": ChargerGroup,
"name": "abc123"
}
ChargerGroup
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the User. |
parentId - ChargerGroup!
|
|
coordinates - Coordinates
|
|
timezone - String
|
|
name - String!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"parentId": ChargerGroup,
"coordinates": Coordinates,
"timezone": "xyz789",
"name": "abc123"
}
ChargingEnergyMix
Description
The Charge location energy mix is a representation of the OCPI Energy Mix object.
See EnergyMix for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
location - ChargeLocation
|
Location this energy mix belongs to. |
tariff - ChargeTariff
|
Tariff this energy mix belongs to. |
energySources - [ChargingEnergySource!]
|
Key-value pairs (enum + percentage) of energy sources of this location's tariff. |
environmentalImpacts - [ChargingEnvironmentalImpact!]
|
Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location's tariff. |
isGreenEnergy - Boolean
|
True if 100% from regenerative sources. (CO2 and nuclear waste is zero). |
supplierName - String
|
Name of the energy supplier. |
energyProductName - String
|
Name of the energy suppliers product/tariff plan. |
createdAt - DateTimeUtc
|
Datetime the energy mix was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the energy mix was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"location": ChargeLocation,
"tariff": ChargeTariff,
"energySources": [ChargingEnergySource],
"environmentalImpacts": [ChargingEnvironmentalImpact],
"isGreenEnergy": false,
"supplierName": "xyz789",
"energyProductName": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargingEnergySource
Description
The Charge location energy mix energy source is a representation of the OCPI Energy Source object.
See EnergySource for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
energyMix - ChargingEnergyMix!
|
Energy mix this energy source belongs to. |
source - EnergySourceCategory!
|
The type of the energy source. See EnergySourceCategory enum. |
percentage - Int!
|
Percentage of the energy source in the mix. |
createdAt - DateTimeUtc
|
Datetime the energy source was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the energy source was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"energyMix": ChargingEnergyMix,
"source": "NUCLEAR",
"percentage": 987,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargingEnvironmentalImpact
Description
The Charge location energy mix environmental impact is a representation of the OCPI Environmental Impact object.
See EnvironmentalImpact for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
energyMix - ChargingEnergyMix!
|
Energy mix this environmental impact belongs to. |
source - EnvironmentalImpactCategory!
|
The source category of the environmental impact. See EnvironmentalImpactCategory enum. |
amount - Float!
|
Environmental impact in grams/kwh. |
createdAt - DateTimeUtc
|
Datetime the environmental impact was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the environmental impact was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"energyMix": ChargingEnergyMix,
"source": "NUCLEAR_WASTE",
"amount": 987.65,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargingParkingRestriction
Description
The Charge location EVSE parking restrictions is a representation of the OCPI ParkingRestriction object.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
evse - ChargeLocationEVSE!
|
EVSE this parking restriction belongs to. |
restriction - EvseParkingRestriction!
|
Restriction to the parking spot. See EvseParkingRestriction enum. |
createdAt - DateTimeUtc
|
Datetime the parking restriction was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the parking restriction was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"evse": ChargeLocationEVSE,
"restriction": "EV_ONLY",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ChargingPeriod
Description
The Charging Period is a representation of the OCPI Charging period object.
See ChargingPeriod for details on the OCPI object structure.
Fields
| Field Name | Description |
|---|---|
startDateTime - DateTimeUtc!
|
Start date and time of the charging period. This period ends when a next period starts, the last period ends when the session ends. |
dimensions - [CdrDimension]
|
List of dimensions during this charging period. |
Example
{
"startDateTime": DateTimeUtc,
"dimensions": [CdrDimension]
}
ChargingPeriodInput
Fields
| Input Field | Description |
|---|---|
startDateTime - DateTimeUtc!
|
Start date time of the charging period |
dimensions - [DimensionInput!]!
|
Dimension of the charging period |
Example
{
"startDateTime": DateTimeUtc,
"dimensions": [DimensionInput]
}
CombinerInput
Fields
| Input Field | Description |
|---|---|
combiner - String
|
Combiner configuration |
Example
{"combiner": "abc123"}
Company
Fields
| Field Name | Description |
|---|---|
id - UUID
|
|
name - String
|
|
pivot - CompanyUserPivot
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"pivot": CompanyUserPivot
}
CompanyApproval
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
companyId - UUID!
|
Organizational component that has approved the terms and conditions. Use organizationalComponentId instead |
organizationalComponentId - UUID!
|
Organizational component that has approved the terms and conditions. |
isApproved - Boolean
|
Indication if the terms and conditions are approved. |
approvedByUser - String
|
User who approved the terms and conditions. |
approvedAt - DateTimeUtc
|
Date time when the terms and conditions were approved. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"isApproved": false,
"approvedByUser": "xyz789",
"approvedAt": DateTimeUtc
}
CompanyApproveTermsAndConditionsInput
CompanyConnection
Description
A paginated list of Company edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyEdge!]!
|
A list of Company edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyEdge]
}
CompanyDisabledReason
Description
Reasons why a company can be disabled.
Values
| Enum Value | Description |
|---|---|
|
|
The company has not provided the necessary legal documents. |
|
|
The company has violated the terms of service. |
|
|
The company has been suspected of fraud. |
|
|
The company has a poor credit history. |
|
|
The company has not been active for a long time. |
|
|
The company has been reported for abuse of resources. |
|
|
The company stopped the relationship with the client. |
|
|
The company requested to be disabled. |
|
|
The company has not paid the invoices. |
|
|
Other. |
Example
"LEGAL_COMPLIANCE"
CompanyEdge
CompanyFuelMonthlyTransactions
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID. |
company - OrganizationalComponent!
|
Company the statistic belongs to. |
month - Int!
|
Month Number |
year - Int!
|
Year Number |
volume - Float
|
Volume |
amount - Money
|
Amount |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "4",
"company": OrganizationalComponent,
"month": 987,
"year": 987,
"volume": 987.65,
"amount": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CompanyFuelMonthlyTransactionsConnection
Description
A paginated list of CompanyFuelMonthlyTransactions edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyFuelMonthlyTransactionsEdge!]!
|
A list of CompanyFuelMonthlyTransactions edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyFuelMonthlyTransactionsEdge]
}
CompanyFuelMonthlyTransactionsEdge
Description
An edge that contains a node of type CompanyFuelMonthlyTransactions and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanyFuelMonthlyTransactions!
|
The CompanyFuelMonthlyTransactions node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanyFuelMonthlyTransactions,
"cursor": "xyz789"
}
CompanyFuelWeeklyTransactions
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The identifier |
company - OrganizationalComponent!
|
Company the statistic belongs to |
volume - Float
|
Volume |
amount - Money
|
Amount |
transactions - Int!
|
Number of transactions |
week - Int!
|
Week |
year - Int!
|
Year |
amountOfTransactions - Int!
|
Amount of transactions |
averageTransactions - Int!
|
Average transactions per week |
lastTransactionDate - DateTimeUtc!
|
Last transaction date |
fromDate - DateTimeUtc!
|
From date |
toDate - DateTimeUtc!
|
To date |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": 4,
"company": OrganizationalComponent,
"volume": 123.45,
"amount": Money,
"transactions": 123,
"week": 123,
"year": 123,
"amountOfTransactions": 987,
"averageTransactions": 123,
"lastTransactionDate": DateTimeUtc,
"fromDate": DateTimeUtc,
"toDate": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CompanyFuelWeeklyTransactionsConnection
Description
A paginated list of CompanyFuelWeeklyTransactions edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyFuelWeeklyTransactionsEdge!]!
|
A list of CompanyFuelWeeklyTransactions edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyFuelWeeklyTransactionsEdge]
}
CompanyFuelWeeklyTransactionsEdge
Description
An edge that contains a node of type CompanyFuelWeeklyTransactions and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanyFuelWeeklyTransactions!
|
The CompanyFuelWeeklyTransactions node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanyFuelWeeklyTransactions,
"cursor": "abc123"
}
CompanyFuelYearlyTransactions
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID. |
company - OrganizationalComponent!
|
Company the statistic belongs to. |
year - Int!
|
Year Number |
volume - Float
|
Volume |
amount - Money
|
Amount |
createdAt - DateTimeUtc!
|
Created at |
updatedAt - DateTimeUtc!
|
Updated at |
Example
{
"id": "4",
"company": OrganizationalComponent,
"year": 123,
"volume": 123.45,
"amount": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CompanyFuelYearlyTransactionsConnection
Description
A paginated list of CompanyFuelYearlyTransactions edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyFuelYearlyTransactionsEdge!]!
|
A list of CompanyFuelYearlyTransactions edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyFuelYearlyTransactionsEdge]
}
CompanyFuelYearlyTransactionsEdge
Description
An edge that contains a node of type CompanyFuelYearlyTransactions and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanyFuelYearlyTransactions!
|
The CompanyFuelYearlyTransactions node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanyFuelYearlyTransactions,
"cursor": "xyz789"
}
CompanyIdentificationNumber
Fields
| Field Name | Description |
|---|---|
provider - KilometreChargingProvider
|
Charge provider |
identificationNumber - [String]
|
Identification number |
Example
{
"provider": "SATELLIC",
"identificationNumber": ["abc123"]
}
CompanyMonthlyChargeStatistics
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Internal ID used by the system. |
company - OrganizationalComponent!
|
Organizational component the statistic belongs to. Use organizationalComponent instead. |
organizationalComponent - OrganizationalComponent!
|
Organizational component the statistic belongs to. |
month - Int!
|
Month |
year - Int!
|
Year |
totalCharges - Int!
|
A Total count of Charges over the last month |
totalCost - Money!
|
A Total Cost of Charging over the last month |
totalEnergy - Float!
|
A Total Energy of Charging over the last month |
createdAt - DateTimeUtc
|
Datetime the entity was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the entity was last updated in the system. |
Example
{
"id": 4,
"company": OrganizationalComponent,
"organizationalComponent": OrganizationalComponent,
"month": 123,
"year": 987,
"totalCharges": 123,
"totalCost": Money,
"totalEnergy": 123.45,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CompanyMonthlyChargeStatisticsConnection
Description
A paginated list of CompanyMonthlyChargeStatistics edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyMonthlyChargeStatisticsEdge!]!
|
A list of CompanyMonthlyChargeStatistics edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyMonthlyChargeStatisticsEdge]
}
CompanyMonthlyChargeStatisticsEdge
Description
An edge that contains a node of type CompanyMonthlyChargeStatistics and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanyMonthlyChargeStatistics!
|
The CompanyMonthlyChargeStatistics node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanyMonthlyChargeStatistics,
"cursor": "abc123"
}
CompanyMonthlyChargeStatisticsPaginator
Description
A paginated list of CompanyMonthlyChargeStatistics items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [CompanyMonthlyChargeStatistics!]!
|
A list of CompanyMonthlyChargeStatistics items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [CompanyMonthlyChargeStatistics]
}
CompanySegment
Description
Company segments are a way to categorize companies.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant!
|
Tenant the company segment belongs to. |
name - String!
|
Name of the company segment. |
description - String
|
Description of the company segment. |
deletedAt - DateTimeUtc
|
Indication if the company segment is deleted. Null if not deleted. |
createdAt - DateTimeUtc
|
Date time when the company segment was created. |
updatedAt - DateTimeUtc
|
Date time when the company segment was last updated. |
createdBy - User
|
User who created the company segment. |
updatedBy - User
|
User who last updated the company segment. |
priceModifications - [PriceModification]!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"name": "xyz789",
"description": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"priceModifications": [PriceModification]
}
CompanySegmentConnection
Description
A paginated list of CompanySegment edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanySegmentEdge!]!
|
A list of CompanySegment edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanySegmentEdge]
}
CompanySegmentEdge
Description
An edge that contains a node of type CompanySegment and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanySegment!
|
The CompanySegment node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanySegment,
"cursor": "xyz789"
}
CompanySegmentInput
CompanyUserPivot
Fields
| Field Name | Description |
|---|---|
driverId - String
|
Example
{"driverId": "xyz789"}
CompanyWeeklyChargeStatistics
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Internal ID used by the system. |
company - OrganizationalComponent!
|
Organizational Component the statistic belongs to. Use organizationalComponent instead. |
organizationalComponent - OrganizationalComponent!
|
Organizational Component the statistic belongs to. |
week - Int!
|
Week number |
year - Int!
|
Year |
location - ChargeLocation
|
Last Charge Location the statistic belongs to. |
lastChargingDate - DateTimeUtc!
|
Date of last Charge Record. |
amountOfCharges - Int!
|
A Total count of Charges over the last week |
totalCost - Money!
|
A Total Cost of Charging over the last month |
totalEnergy - Float!
|
A Total Energy of Charging over the last month |
averageCharges - Int!
|
Average Charges per week |
createdAt - DateTimeUtc
|
Datetime the entity was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the entity was last updated in the system. |
Example
{
"id": "4",
"company": OrganizationalComponent,
"organizationalComponent": OrganizationalComponent,
"week": 987,
"year": 123,
"location": ChargeLocation,
"lastChargingDate": DateTimeUtc,
"amountOfCharges": 123,
"totalCost": Money,
"totalEnergy": 987.65,
"averageCharges": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CompanyWeeklyChargeStatisticsConnection
Description
A paginated list of CompanyWeeklyChargeStatistics edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyWeeklyChargeStatisticsEdge!]!
|
A list of CompanyWeeklyChargeStatistics edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyWeeklyChargeStatisticsEdge]
}
CompanyWeeklyChargeStatisticsEdge
Description
An edge that contains a node of type CompanyWeeklyChargeStatistics and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanyWeeklyChargeStatistics!
|
The CompanyWeeklyChargeStatistics node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanyWeeklyChargeStatistics,
"cursor": "abc123"
}
CompanyWeeklyChargeStatisticsPaginator
Description
A paginated list of CompanyWeeklyChargeStatistics items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [CompanyWeeklyChargeStatistics!]!
|
A list of CompanyWeeklyChargeStatistics items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [CompanyWeeklyChargeStatistics]
}
CompanyYearlyChargeStatistics
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Internal ID used by the system. |
company - OrganizationalComponent!
|
Company the statistic belongs to. |
year - Int!
|
Year |
totalCharges - Int!
|
A Total count of Charges over the last month |
totalCost - Money!
|
A Total Cost of Charging over the last month |
totalEnergy - Float!
|
A Total Energy of Charging over the last month |
createdAt - DateTimeUtc!
|
Datetime the entity was created in the system. |
updatedAt - DateTimeUtc!
|
Datetime the entity was last updated in the system. |
Example
{
"id": 4,
"company": OrganizationalComponent,
"year": 987,
"totalCharges": 123,
"totalCost": Money,
"totalEnergy": 123.45,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
CompanyYearlyChargeStatisticsConnection
Description
A paginated list of CompanyYearlyChargeStatistics edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [CompanyYearlyChargeStatisticsEdge!]!
|
A list of CompanyYearlyChargeStatistics edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CompanyYearlyChargeStatisticsEdge]
}
CompanyYearlyChargeStatisticsEdge
Description
An edge that contains a node of type CompanyYearlyChargeStatistics and a cursor.
Fields
| Field Name | Description |
|---|---|
node - CompanyYearlyChargeStatistics!
|
The CompanyYearlyChargeStatistics node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": CompanyYearlyChargeStatistics,
"cursor": "abc123"
}
CompanyYearlyChargeStatisticsPaginator
Description
A paginated list of CompanyYearlyChargeStatistics items.
Fields
| Field Name | Description |
|---|---|
paginatorInfo - PaginatorInfo!
|
Pagination information about the list of items. |
data - [CompanyYearlyChargeStatistics!]!
|
A list of CompanyYearlyChargeStatistics items. |
Example
{
"paginatorInfo": PaginatorInfo,
"data": [CompanyYearlyChargeStatistics]
}
Compartment
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
fuelTank - FuelTank!
|
|
siphon - Siphon
|
|
fuelStock - FuelStock
|
|
probes - [Probe!]
|
|
product - Product!
|
|
nozzles - [Nozzle!]
|
|
capacity - Int!
|
|
length - Int
|
In mm |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"fuelTank": FuelTank,
"siphon": Siphon,
"fuelStock": FuelStock,
"probes": [Probe],
"product": Product,
"nozzles": [Nozzle],
"capacity": 123,
"length": 987,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
Condition
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the condition. |
priceModification - PriceModification!
|
Price Modification |
description - String
|
Description |
class - ConditionClass!
|
Condition Class. See ConditionClass enum. |
amount - Float!
|
Amount |
inverse - Boolean!
|
Inverse. If true, the amount is addition to the price. |
priceType - PriceType!
|
Price Type. See PriceType enum. |
arguments - String
|
Arguments |
createdAt - DateTimeUtc!
|
Created At |
updatedAt - DateTimeUtc
|
Updated At |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"priceModification": PriceModification,
"description": "xyz789",
"class": "LESS",
"amount": 123.45,
"inverse": false,
"priceType": "SELLING",
"arguments": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ConditionClass
Description
The class of the conditions used in price modification
Values
| Enum Value | Description |
|---|---|
|
|
The condition is not less than the given value |
|
|
The condition is not more than the given value |
Example
"LESS"
ConditionInput
Fields
| Input Field | Description |
|---|---|
class - ConditionClass!
|
Claas. See ConditionClass enum |
amount - Float
|
Amount. Required in euros. |
inverse - Boolean
|
Inverse. Provide true if value should be addition to the price |
priceType - PriceType!
|
Price type, See PriceType enum |
Example
{"class": "LESS", "amount": 987.65, "inverse": false, "priceType": "SELLING"}
ConfirmTwoFactorAuthenticationInput
Fields
| Input Field | Description |
|---|---|
code - String!
|
The two factor authentication code. |
Example
{"code": "abc123"}
ConnectorFormat
Values
| Enum Value | Description |
|---|---|
|
|
The connector is a socket; the EV user needs to bring a fitting plug. |
|
|
The connector is an attached cable; the EV users car needs to have a fitting inlet. |
Example
"SOCKET"
ConnectorPowerType
Values
| Enum Value | Description |
|---|---|
|
|
AC mono phase. |
|
|
AC 2 phase. |
|
|
AC 3 phase. |
|
|
Direct current. |
Example
"AC_1_PHASE"
ConnectorType
Values
| Enum Value | Description |
|---|---|
|
|
The connector type is CHAdeMO, DC |
|
|
Standard/Domestic household, type "A", NEMA 1-15, 2 pins |
|
|
Standard/Domestic household, type "B", NEMA 5-15, 3 pins |
|
|
Standard/Domestic household, type "C", CEE 7/17, 2 pins |
|
|
Standard/Domestic household, type "D", 3 pin |
|
|
Standard/Domestic household, type "E", CEE 7/5 3 pins |
|
|
Standard/Domestic household, type "F", CEE 7/4, Schuko, 3 pins |
|
|
Standard/Domestic household, type "G", BS 1363, Commonwealth, 3 pins |
|
|
Standard/Domestic household, type "H", SI-32, 3 pins |
|
|
Standard/Domestic household, type "I", AS 3112, 3 pins |
|
|
Standard/Domestic household, type "J", SEV 1011, 3 pins |
|
|
Standard/Domestic household, type "K", DS 60884-2-D1, 3 pins |
|
|
Standard/Domestic household, type "L", CEI 23-16-VII, 3 pins |
|
|
IEC 60309-2 Industrial Connector single phase 16 Amperes (usually blue) |
|
|
IEC 60309-2 Industrial Connector three phase 16 Amperes (usually red) |
|
|
IEC 60309-2 Industrial Connector three phase 32 Amperes (usually red) |
|
|
IEC 60309-2 Industrial Connector three phase 64 Amperes (usually red) |
|
|
IEC 62196 Type 1 "SAE J1772" |
|
|
Combo Type 1 based, DC |
|
|
IEC 62196 Type 2 "Mennekes" |
|
|
Combo Type 2 based, DC |
|
|
IEC 62196 Type 3A |
|
|
IEC 62196 Type 3C "Scame" |
|
|
Tesla Connector "Roadster"-type (round, 4 pin) |
|
|
Tesla Connector "Model-S"-type (oval, 5 pin) |
Example
"CHADEMO"
ContactPersonPhoneNumber
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
type - PhoneNumberType!
|
Type of the phone number. See PhoneNumberType enum for possible values. |
country - Country!
|
Country code of the phone number. |
number - String
|
Phone number. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "LANDLINE",
"country": "AL",
"number": "abc123"
}
ContractType
Description
Contract types
Values
| Enum Value | Description |
|---|---|
|
|
Business to business |
|
|
Business to consumer |
Example
"B2B"
ContractTypeFeature
Description
Additional features with the contract.
Values
| Enum Value | Description |
|---|---|
|
|
Signing the contract means that the user or company agrees to the terms of the agreement. |
Example
"TERMS_OF_AGREEMENT"
Coordinates
Country
Description
Country codes.
Values
| Enum Value | Description |
|---|---|
|
|
Albania |
|
|
Austria |
|
|
Aland Islands |
|
|
Bosnia and Herzegovina |
|
|
Belgium |
|
|
Bulgaria |
|
|
Belarus |
|
|
Switzerland |
|
|
Cyprus |
|
|
Czech Republic |
|
|
Germany |
|
|
Denmark |
|
|
Estonia |
|
|
Spain |
|
|
Finland |
|
|
Faroe Islands |
|
|
France |
|
|
United Kingdom |
|
|
Gibraltar |
|
|
Greece |
|
|
Croatia |
|
|
Hungary |
|
|
Ireland |
|
|
Isle of Man |
|
|
Iceland |
|
|
Italy |
|
|
Jersey |
|
|
Liechtenstein |
|
|
Lithuania |
|
|
Luxembourg |
|
|
Latvia |
|
|
Monaco |
|
|
Moldova |
|
|
North Macedonia |
|
|
Malta |
|
|
Netherlands |
|
|
Norway |
|
|
Poland |
|
|
Portugal |
|
|
Romania |
|
|
Russia |
|
|
Sweden |
|
|
Slovenia |
|
|
Svalbard and Jan Mayen |
|
|
Slovakia |
|
|
San Marino |
|
|
Ukraine |
|
|
United States |
|
|
Vatican City |
Example
"AL"
CountryList
Description
List of countries
Fields
| Field Name | Description |
|---|---|
name - String!
|
The name of the country |
code - String!
|
The country code |
emoji - String!
|
The emoji picture of the country flag |
unicode - String!
|
The unicode of the country |
dialCode - String
|
The international dialing code of the country |
image - String!
|
The link to the image of country flag |
Example
{
"name": "abc123",
"code": "xyz789",
"emoji": "xyz789",
"unicode": "abc123",
"dialCode": "xyz789",
"image": "xyz789"
}
CreateAddressForGasStationInput
Fields
| Input Field | Description |
|---|---|
gasStationId - UUID!
|
Gas station id. |
street - String
|
Street name. Required for country BE. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
city - String!
|
City. |
Example
{
"gasStationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "xyz789",
"postalCode": "abc123",
"country": "AL",
"city": "abc123"
}
CreateAddressForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Organizational component id. |
street - String
|
Street name. Required for country BE. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
city - String!
|
City. |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "xyz789",
"country": "AL",
"city": "abc123"
}
CreateAddressForTenantInput
Fields
| Input Field | Description |
|---|---|
tenantId - UUID!
|
Tenant id. |
street - String
|
Street name. Required for country BE. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
city - String!
|
City. |
Example
{
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "xyz789",
"houseNumber": "xyz789",
"houseNumberAddition": "abc123",
"postalCode": "xyz789",
"country": "AL",
"city": "abc123"
}
CreateAddressForUserInput
Fields
| Input Field | Description |
|---|---|
userId - UUID!
|
User id. |
street - String
|
Street name. Required for country BE. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
city - String!
|
City. |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "xyz789",
"houseNumber": "abc123",
"houseNumberAddition": "xyz789",
"postalCode": "xyz789",
"country": "AL",
"city": "abc123"
}
CreateCardInput
Fields
| Input Field | Description |
|---|---|
type - CardType!
|
Type of Card |
externalReference - String
|
External reference number |
templateId - UUID!
|
Card Template UUID |
companyId - UUID
|
Company UUID |
userId - UUID
|
User UUID |
vehicleId - UUID
|
Vehicle UUID |
mileageRequired - Boolean
|
Is mileage required at time of fueling |
supports - [String]
|
Example
{
"type": "CHARGE",
"externalReference": "xyz789",
"templateId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"mileageRequired": true,
"supports": ["xyz789"]
}
CreateCategoryInput
Fields
| Input Field | Description |
|---|---|
label - String!
|
Label of the category |
Example
{"label": "abc123"}
CreateChargeTokenInput
Fields
| Input Field | Description |
|---|---|
tokenUid - String!
|
Charge token UID |
userId - UUID
|
User ID to link the token to |
companyId - UUID
|
Company ID to link the token to |
vehicleId - UUID
|
Vehicle ID to link the token to |
externalReference - String
|
External reference. Can be used as a reference to an external system |
chargePointOperators - [UUID!]
|
List of charge point operators to enable this token to. Can be omitted if chargePointOperatorPool is set |
chargePointOperatorPool - UUID
|
Charge point operator pool to enable this token to. Can be omitted if chargePointOperators is set |
Example
{
"tokenUid": "abc123",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalReference": "xyz789",
"chargePointOperators": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"chargePointOperatorPool": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
CreateContactPersonForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Organizational component ID |
firstName - String!
|
First name of the contact person |
lastName - String!
|
Last name of the contact person |
email - String!
|
Email address of the contact person. Input should be a valid email address |
phoneNumbers - [PhoneNumberInput!]!
|
Phone numbers of the contact person |
language - Locale!
|
Language of the contact person. See Locale enum. |
gender - Gender!
|
Gender of the contact person. See Gender enum. |
position - String
|
Position of the contact person within the organizational component. |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"firstName": "abc123",
"lastName": "abc123",
"email": "xyz789",
"phoneNumbers": [PhoneNumberInput],
"language": "NL",
"gender": "MALE",
"position": "abc123"
}
CreateCreditInvoiceInput
CreateExportInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name |
description - String
|
Description |
category - ExportCategory!
|
Category, See ExportCategory Enum |
fileType - ExportFileType!
|
File type, See ExportFileType Enum |
period - ExportPeriod
|
Export period, See ExportPeriod Enum |
startDate - DateTimeUtc!
|
Start date |
endDate - DateTimeUtc!
|
End date |
fields - [String!]
|
Fields |
renames - [FieldRenameInput!]
|
Field renames |
filters - [InvoiceStatusEnum!]
|
List of filters, See Invoice Status Enum |
Example
{
"name": "abc123",
"description": "xyz789",
"category": "INVOICES",
"fileType": "CSV",
"period": "LAST_MONTH",
"startDate": DateTimeUtc,
"endDate": DateTimeUtc,
"fields": ["xyz789"],
"renames": [FieldRenameInput],
"filters": ["CONCEPT"]
}
CreateFieldInput
Fields
| Input Field | Description |
|---|---|
entityType - EntityType!
|
Entity type. |
name - String!
|
Name. |
label - String!
|
Label. |
Example
{
"entityType": "ORGANIZATIONAL_COMPONENT",
"name": "abc123",
"label": "xyz789"
}
CreateGasStationInput
Example
{
"hubId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"brandId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"location": "xyz789",
"url": "abc123",
"isManned": true
}
CreateGuaranteeInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID
|
Organizational component ID |
userId - UUID
|
User ID |
guaranteeType - GuaranteeType!
|
Guarantee type. See GuaranteeType enum. |
amount - Int
|
Amount of the guarantee |
activeFrom - DateTimeUtc
|
Active from date of the guarantee |
fromImport - Boolean
|
Indication if the guarantee is from an import |
comment - String
|
Comment for the guarantee |
status - GuaranteeStatus!
|
Status of the guarantee. See GuaranteeStatus enum. |
pdf - String
|
PDF data which will be converted and stored as a file with file reference. |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"guaranteeType": "BANK",
"amount": 987,
"activeFrom": DateTimeUtc,
"fromImport": false,
"comment": "xyz789",
"status": "PENDING",
"pdf": "xyz789"
}
CreateHubInput
CreateInvoiceAddressForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Organizational component id. |
street - String
|
Street name. Required for country BE. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
city - String!
|
City. |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "xyz789",
"country": "AL",
"city": "abc123"
}
CreateLegalEntityInput
Fields
| Input Field | Description |
|---|---|
id - UUID!
|
Tenant ID. Verify its existence in the tenants model. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
CreateMandateForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
userId - UUID
|
User ID: If provided, verify its existence in the users model. |
organizationalComponentId - UUID
|
Organizational component id. |
debtorSignDate - Date!
|
The debtor sign date of the mandate |
debtorMandate - String!
|
The debtor mandate/mandate id of Twikey. |
activeFrom - Date!
|
Active from date |
origin - MandateOrigin!
|
Origin of Mandate |
status - MandateStatus
|
Status of the mandate |
mandateCode - String
|
Mandate code |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"debtorSignDate": "2007-12-03",
"debtorMandate": "xyz789",
"activeFrom": "2007-12-03",
"origin": "IMPORT",
"status": "PENDING",
"mandateCode": "abc123"
}
CreateOrderInput
Fields
| Input Field | Description |
|---|---|
companyId - UUID
|
Company ID |
userId - UUID
|
User Id |
address - ShippingAddressInput!
|
Shipping Address |
Example
{
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": ShippingAddressInput
}
CreateOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentTypeId - UUID!
|
Type of the organizational component. This should reference an existing organizational component type entity. |
name - String!
|
Name of the organizational component |
email - String
|
Email address of the organizational component. Input should be a valid email address |
phoneNumbers - [PhoneNumberInput!]
|
Phone numbers of the organizational component |
parentId - UUID
|
Parent organizational component ID |
segmentId - UUID
|
Segment ID of the organizational component |
website - String
|
Website of the organizational component |
country - Country!
|
Country of the organizational component |
registrationNumber - String
|
Registration number of the organizational component |
customerNumber - String
|
Customer number of the organizational component. If none is provided a number will be generated based on tenant generator settings. |
structuredReference - String
|
Structured reference used for bank transfers for organizational components from Belgium |
vatNumber - String
|
Vat number of the organizational component |
tradeName - String
|
Trade name of the organizational component |
legalForm - String
|
Legal form of the organizational component |
language - Locale
|
Language of the organizational component. See Locale enum. |
Example
{
"organizationalComponentTypeId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"email": "xyz789",
"phoneNumbers": [PhoneNumberInput],
"parentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"segmentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"website": "xyz789",
"country": "AL",
"registrationNumber": "abc123",
"customerNumber": "abc123",
"structuredReference": "xyz789",
"vatNumber": "xyz789",
"tradeName": "xyz789",
"legalForm": "xyz789",
"language": "NL"
}
CreatePackageInput
Example
{
"subscriptionPlanId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"description": "xyz789",
"price": 987,
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
CreatePriceModificationInput
Fields
| Input Field | Description |
|---|---|
description - String!
|
Description |
promoCode - String
|
Promo code. Must be unique or null |
externalReference - String
|
External reference |
type - PriceType!
|
Price type, See PriceType enum |
inverse - Boolean!
|
Inverse. Provide true if value should be addition to the price |
startDate - DateTime!
|
Start date |
endDate - DateTime
|
End date. Must be after start date or null |
adjustmentType - ModificationAdjustmentType!
|
Adjustment type, See ModificationAdjustmentType enum |
isVisibleToInvoice - Boolean!
|
Price modification visibility in invoice |
isVolumePriceModificationEnabled - Boolean!
|
Is Volume price modification enabled |
scope - PriceModificationScope!
|
Price modification scope, See PriceModificationScope enum |
period - VolumePriceModificationPeriod
|
Volume price modification period. Required if isVolumePriceModificationEnabled is true and see VolumePriceModificationPeriod enum |
perProductDetails - [PriceModificationPerProductDetailsInput!]!
|
Per product details |
conditions - [ConditionInput!]
|
Conditions |
Example
{
"description": "abc123",
"promoCode": "xyz789",
"externalReference": "abc123",
"type": "SELLING",
"inverse": false,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"adjustmentType": "MARGIN",
"isVisibleToInvoice": false,
"isVolumePriceModificationEnabled": false,
"scope": "PER_UNIT",
"period": "MONTHLY",
"perProductDetails": [
PriceModificationPerProductDetailsInput
],
"conditions": [ConditionInput]
}
CreateProductInput
CreateReplacementCardInput
Fields
| Input Field | Description |
|---|---|
type - CardType!
|
Type of card |
externalReference - String
|
External reference number |
templateId - UUID!
|
Template UUID |
companyId - UUID
|
Company UUID |
userId - UUID
|
User UUID |
vehicleId - UUID
|
Vehicle UUID |
mileageRequired - Boolean
|
Is mileage required at time of fueling |
disableLegacyCard - Boolean
|
Disable Legacy card if exists. |
Example
{
"type": "CHARGE",
"externalReference": "abc123",
"templateId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"mileageRequired": true,
"disableLegacyCard": true
}
CreateTemplateInput
Fields
| Input Field | Description |
|---|---|
label - String!
|
Template label |
description - String!
|
Template description |
products - [UUID!]!
|
Template's products |
locations - [UUID!]!
|
Locations |
limit - FuelLimitInput!
|
Daily/weekly/monthyl transactions/amount limits |
fuelEnabled - Boolean!
|
Is fuel capability enabled |
chargingEnabled - Boolean!
|
Is charge capability enabled |
chargePointOperators - [UUID!]
|
Charge point operators |
chargePointOperatorPool - UUID
|
Charge point operator pool |
Example
{
"label": "xyz789",
"description": "abc123",
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"locations": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"limit": FuelLimitInput,
"fuelEnabled": false,
"chargingEnabled": false,
"chargePointOperators": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"chargePointOperatorPool": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
CreateTenantInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the Tenant |
tag - String!
|
Identifier tag. Cannot be updated after creation. It will be saved in UPPER case |
usesInvoice - Boolean!
|
Flag indicating if the Tenant uses invoices |
country - Country
|
Country of the Tenant |
creditCheck - CreditCheckType
|
Credit check type. See CreditCheckType enum |
softLimit - Int
|
Soft limit |
hardLimit - Int
|
Hard limit |
invoiceReminderDays - Int
|
Invoice reminder days |
Example
{
"name": "abc123",
"tag": "xyz789",
"usesInvoice": true,
"country": "AL",
"creditCheck": "CREDIT_SAFE",
"softLimit": 987,
"hardLimit": 123,
"invoiceReminderDays": 123
}
CreateTermsAndConditionsInput
Fields
| Input Field | Description |
|---|---|
termsAndConditionsType - TermsAndConditionsType!
|
Terms and conditions type. See TermsAndConditionsType enum |
version - String!
|
Terms and conditions version of document |
content - String!
|
Terms and conditions content |
Example
{
"termsAndConditionsType": "B2B",
"version": "abc123",
"content": "xyz789"
}
CreateUnauthenticatableUser
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"email": "abc123",
"dateOfBirth": "2007-12-03",
"locale": "NL",
"gender": "MALE",
"externalReference": "xyz789",
"customerNumber": "xyz789"
}
CreateUser
Fields
| Input Field | Description |
|---|---|
email - String!
|
The email address. |
password - String!
|
The password. |
firstName - String!
|
The first name. |
lastName - String!
|
The last name. |
gender - Gender
|
User gender. See Gender enum. |
locale - Locale!
|
User locale. See Locale enum. |
postalCode - String
|
Postal code |
houseNumber - String
|
House number |
houseNumberAddition - String
|
House number addition |
street - String
|
Street |
city - String
|
City |
licensePlateNumber - String
|
License plate number of vehicle |
licensePlateCountry - String
|
Country of vehicle |
phoneNumbers - [addPhoneNumberAuthInput!]
|
Phone numbers |
Example
{
"email": "xyz789",
"password": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"gender": "MALE",
"locale": "NL",
"postalCode": "abc123",
"houseNumber": "xyz789",
"houseNumberAddition": "abc123",
"street": "abc123",
"city": "abc123",
"licensePlateNumber": "xyz789",
"licensePlateCountry": "xyz789",
"phoneNumbers": [addPhoneNumberAuthInput]
}
CreditCheck
Fields
| Field Name | Description |
|---|---|
status - CreditCheckStatus!
|
Status of the credit check. See CreditCheckStatus enum for possible values. |
report - CreditCheckReport
|
Report of the credit check. |
Example
{"status": "PENDING", "report": CreditCheckReport}
CreditCheckReport
Fields
| Field Name | Description |
|---|---|
creditRating - String!
|
Risk indicated in a score metric. Examples: A, B, C, D, E |
creditAdvice - Money!
|
Suggested credit limit advice based on check |
rating - String!
|
Risk indicated in a number. Example: 89 |
risk - String!
|
Risk indicated in human readable format. Example: Very low risk |
companyStatus - String!
|
Status of the organizational component as per credit report |
lastUpdated - DateTimeUtc!
|
Date time when the credit check was last updated by the external provider |
naceCode - NACECode!
|
NACE code of the organizational component |
employees - Int
|
Number of employees in the organizational component |
dateOfIncorporation - String!
|
Date of incorporation of the organizational component |
Example
{
"creditRating": "xyz789",
"creditAdvice": Money,
"rating": "xyz789",
"risk": "abc123",
"companyStatus": "xyz789",
"lastUpdated": DateTimeUtc,
"naceCode": NACECode,
"employees": 123,
"dateOfIncorporation": "abc123"
}
CreditCheckStatus
Values
| Enum Value | Description |
|---|---|
|
|
The credit check is pending. |
|
|
The credit check was canceled. |
|
|
The credit check has finished. |
|
|
The credit check has failed. |
Example
"PENDING"
CreditCheckType
Description
Credit check providers.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREDIT_SAFE"
CustomerNumberConfigurationInput
Fields
| Input Field | Description |
|---|---|
generator - CustomerNumberGeneratorType!
|
Customer number generator. See CustomerNumberGeneratorType enum |
prefix - String
|
Customer number prefix |
length - Int!
|
Customer number length |
Example
{
"generator": "INCREMENTING",
"prefix": "xyz789",
"length": 123
}
CustomerNumberGeneratorType
Values
| Enum Value | Description |
|---|---|
|
|
Example
"INCREMENTING"
DailyCardStatistic
DailyStatistic
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant!
|
Tenant the daily statistic belongs to. |
date - Date!
|
Date of the statistic. |
companyType - OrganizationalComponentStatisticType
|
Type of organizational component the statistic is for. Use organizationalComponentType instead |
organizationalComponentType - OrganizationalComponentStatisticType
|
Type of organizational component the statistic is for. Use organizationalComponentType instead |
amount - Int
|
Amount of organizational components |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"companyType": "COMPANY",
"organizationalComponentType": "COMPANY",
"amount": 987
}
DailyTransactionStatistic
Description
The transaction statistic data
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the transaction statistic |
company - OrganizationalComponent!
|
The related company |
tenant - Tenant!
|
The related tenant |
date - Date!
|
Date of the statistic |
transactionType - TransactionType!
|
The type of the transaction |
amount - Int
|
The amount of transactions |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"tenant": Tenant,
"date": "2007-12-03",
"transactionType": "FUEL",
"amount": 123
}
DailyUserStatistic
Description
The user statistic data
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"date": "2007-12-03",
"userType": "ANONYMOUS",
"amount": 123
}
Date
Description
A date string with format Y-m-d, e.g. 2011-05-23.
Example
"2007-12-03"
DateTime
Description
A datetime string with format Y-m-d H:i:s, e.g. 2018-05-23 13:43:32.
Example
"2007-12-03T10:15:30Z"
DateTimeUtc
Description
A datetime string in ISO 8601 format in UTC with nanoseconds YYYY-MM-DDTHH:mm:ss.SSSSSSZ, e.g. 2020-04-20T16:20:04.000000Z.
Example
DateTimeUtc
DayOfWeek
Values
| Enum Value | Description |
|---|---|
|
|
Monday |
|
|
Tuesday |
|
|
Wednesday |
|
|
Thursday |
|
|
Friday |
|
|
Saturday |
|
|
Sunday |
Example
"MONDAY"
DimensionInput
Fields
| Input Field | Description |
|---|---|
type - ChargeRecordDimensionType!
|
Dimension type |
volume - Int!
|
Dimension value |
Example
{"type": "ENERGY", "volume": 123}
DisableCardInput
Fields
| Input Field | Description |
|---|---|
reason - DisableReason
|
Reason for disabling card |
comment - String
|
Supported comment |
Example
{"reason": "LOST", "comment": "abc123"}
DisableChargeTokenForChargePointOperatorInput
Fields
| Input Field | Description |
|---|---|
chargePointOperatorId - UUID!
|
Charge point operator ID |
Example
{
"chargePointOperatorId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
DisableReason
Values
| Enum Value | Description |
|---|---|
|
|
disable card if lost |
|
|
disable card if stolen |
|
|
disable card if employee is not working with company |
|
|
disable card if credit limit exceeded |
|
|
any other reasn which is not listed |
|
|
disable card if user hard limit exceeded |
|
|
disable card if company is disabled |
|
|
disable card if user is disbaled |
Example
"LOST"
Disabled
Description
Specify if you want to include or exclude disabled results from a query.
Values
| Enum Value | Description |
|---|---|
|
|
Only return disabled results. |
|
|
Return both disabled and enabled results. |
|
|
Only return enabled results. |
Example
"ONLY"
EmployeeDetail
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"driverId": "abc123",
"isManager": true
}
EnableChargeTokenForCardInput
EnableChargeTokenForChargePointOperatorInput
Fields
| Input Field | Description |
|---|---|
chargePointOperatorId - UUID!
|
Charge point operator ID |
Example
{
"chargePointOperatorId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
EnableFuelForCardInput
Example
{
"provider": "LODDER",
"expiryYear": 123,
"expiryMonth": 987,
"pin": "abc123"
}
EnergyMixInput
Fields
| Input Field | Description |
|---|---|
isGreenEnergy - Boolean!
|
If the energy source is green |
supplierName - String
|
Supplier name |
energyProductName - String
|
Energy product name |
energySources - [EnergySourceInput]
|
Energy sources |
environImpact - [EnvironImpactInput]
|
Environmental impact |
Example
{
"isGreenEnergy": true,
"supplierName": "xyz789",
"energyProductName": "abc123",
"energySources": [EnergySourceInput],
"environImpact": [EnvironImpactInput]
}
EnergySourceCategory
Values
| Enum Value | Description |
|---|---|
|
|
Nuclear power sources. |
|
|
All kinds of fossil power sources. |
|
|
Fossil power from coal. |
|
|
Fossil power from gas. |
|
|
All kinds of regenerative power sources. |
|
|
Regenerative power from PV. |
|
|
Regenerative power from wind turbines. |
|
|
Regenerative power from water turbines |
Example
"NUCLEAR"
EnergySourceInput
Fields
| Input Field | Description |
|---|---|
source - EnergySourceCategory!
|
Energy source category |
percentage - Int!
|
Percentage of the energy source category |
Example
{"source": "NUCLEAR", "percentage": 987}
Entity
Types
| Union Types |
|---|
Example
User
EntityAssociation
EntityModel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY"
EntityType
Description
The entity type.
Values
| Enum Value | Description |
|---|---|
|
|
The entity type is an organizational component. |
|
|
The entity type is a user. |
|
|
The entity type is a vehicle. |
|
|
The entity type is a organizational component contact person. |
|
|
The entity type is a card. |
|
|
The entity type is a mandate. |
|
|
The entity type is a guarantee. |
Example
"ORGANIZATIONAL_COMPONENT"
EnvironImpactInput
Fields
| Input Field | Description |
|---|---|
source - EnvironmentalImpactCategory!
|
Environmental impact category |
amount - Float!
|
Environmental impact value of the category |
Example
{"source": "NUCLEAR_WASTE", "amount": 123.45}
EnvironmentalImpactCategory
Values
| Enum Value | Description |
|---|---|
|
|
Produced nuclear waste in gramms per kilowatthour. |
|
|
Exhausted carbon dioxide in gramms per kilowarrhour. |
Example
"NUCLEAR_WASTE"
EvseCapability
Description
The Charge location EVSE capabilities is a representation of the OCPI Capabilities object.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
evse - ChargeLocationEVSE!
|
EVSE this capability belongs to. |
capability - EvseCapabilityType!
|
Capability of the EVSE. See EvseCapabilityType enum. |
createdAt - DateTimeUtc
|
Datetime the capability was created in the system. |
updatedAt - DateTimeUtc
|
Datetime the capability was last updated in the system. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"evse": ChargeLocationEVSE,
"capability": "CHARGING_PROFILE_CAPABLE",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
EvseCapabilityType
Values
| Enum Value | Description |
|---|---|
|
|
The EVSE supports charging profiles. Sending Charging Profiles is not yet supported by OCPI. |
|
|
Charging at this EVSE can be payed with credit card. |
|
|
The EVSE can remotely be started/stopped. |
|
|
The EVSE can be reserved. |
|
|
Charging at this EVSE can be authorized with a RFID token |
|
|
Connectors have mechanical lock that can be requested by the eMSP to be unlocked. |
Example
"CHARGING_PROFILE_CAPABLE"
EvseColumns
Values
| Enum Value | Description |
|---|---|
|
|
Status of the EVSE |
Example
"STATUS"
EvseConnectorColumns
Values
| Enum Value | Description |
|---|---|
|
|
Type of the connector |
|
|
Maximum power of the connector |
|
|
Socket type of the connector |
|
|
Maximum current of the connector |
Example
"TYPE"
EvseParkingRestriction
Values
| Enum Value | Description |
|---|---|
|
|
Reserved parking spot for electric vehicles. |
|
|
Parking is only allowed while plugged in (charging). |
|
|
Reserved parking spot for disabled people with valid ID. |
|
|
Parking spot for customers/guests only, for example in case of a hotel or shop. |
|
|
Parking spot only suitable for (electric) motorcycles or scooters. |
Example
"EV_ONLY"
EvseStatus
Values
| Enum Value | Description |
|---|---|
|
|
The EVSE/Connector is able to start a new charging session. |
|
|
The EVSE/Connector is not accessible because of a physical barrier, i.e. a car. |
|
|
The EVSE/Connector is in use. |
|
|
The EVSE/Connector is not yet active or it is no longer available (deleted). |
|
|
The EVSE/Connector is currently out of order. |
|
|
The EVSE/Connector is planned, will be operating soon |
|
|
The EVSE/Connector/charge point is discontinued/removed. |
|
|
The EVSE/Connector is reserved for a particular EV driver and is unavailable for other drivers. |
|
|
No status information available. (Also used when offline). |
Example
"AVAILABLE"
ExpenseReport
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Unique identifier. |
expenseReportNumber - String!
|
Expense report number. |
tenantId - UUID!
|
Tenant identifier. |
company - OrganizationalComponent!
|
Company identifier. |
quantity - Float!
|
Quantity of transactions. |
taxRate - Float!
|
Tax rate. |
totalPrice - Money!
|
Total price |
subTotal - Money!
|
Subtotal. |
totalTax - Money!
|
Total tax. |
redemptionAmount - Money
|
Redemption amount. |
status - ExpenseReportStatus!
|
Status of the expense report. |
reportingPeriodEndDate - Date!
|
Reporting period End Date |
createdAt - DateTime!
|
Created At |
updatedAt - DateTime
|
Updated At |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"expenseReportNumber": "abc123",
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"company": OrganizationalComponent,
"quantity": 123.45,
"taxRate": 987.65,
"totalPrice": Money,
"subTotal": Money,
"totalTax": Money,
"redemptionAmount": Money,
"status": "OPEN",
"reportingPeriodEndDate": "2007-12-03",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
ExpenseReportConnection
Description
A paginated list of ExpenseReport edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ExpenseReportEdge!]!
|
A list of ExpenseReport edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ExpenseReportEdge]
}
ExpenseReportEdge
Description
An edge that contains a node of type ExpenseReport and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ExpenseReport!
|
The ExpenseReport node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ExpenseReport,
"cursor": "xyz789"
}
ExpenseReportStatus
Description
Expense Report Status
Values
| Enum Value | Description |
|---|---|
|
|
Report is open |
|
|
Report is closed |
Example
"OPEN"
Export
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier of the export. |
name - String!
|
Name of the export |
description - String
|
Description of the export |
fileType - ExportFileType!
|
File type of the export, See ExportFileType Enum. |
config - ExportConfig!
|
Export configuration, See ExportConfig Type. |
status - ExportStatus!
|
Export status, See ExportStatus Enum. |
category - ExportCategory!
|
Category of the export, See ExportCategory Enum. |
downloadUrl - File
|
Download URL of the export. |
records - Int!
|
Total records in the export. |
fields - [String!]!
|
Fields in the export. |
renames - [FieldRename!]!
|
Field renames in the export. |
filters - [Filter!]!
|
Filters in the export. |
createdBy - User!
|
Created by user. |
createdAt - DateTimeUtc!
|
Created at. |
updatedAt - DateTimeUtc!
|
Updated at. |
Example
{
"id": 4,
"name": "abc123",
"description": "abc123",
"fileType": "CSV",
"config": ExportConfig,
"status": "PENDING",
"category": "INVOICES",
"downloadUrl": File,
"records": 123,
"fields": ["abc123"],
"renames": [FieldRename],
"filters": [Filter],
"createdBy": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ExportCategory
Description
Export category
Values
| Enum Value | Description |
|---|---|
|
|
Invoices export |
|
|
Transactions export |
Example
"INVOICES"
ExportConfig
Fields
| Field Name | Description |
|---|---|
name - String!
|
Name |
category - ExportCategory!
|
Category, See ExportCategory Enum. |
fileType - ExportFileType!
|
File type, See ExportFileType Enum. |
period - ExportPeriod
|
Export period, See ExportPeriod Enum. |
startDate - DateTimeUtc!
|
Start date. |
endDate - DateTimeUtc!
|
End date. |
fields - [String!]!
|
List of all Fields. |
renames - [FieldRename!]!
|
List of all Field Renames. |
filters - [Filter!]!
|
List of all Filters. |
Example
{
"name": "abc123",
"category": "INVOICES",
"fileType": "CSV",
"period": "LAST_MONTH",
"startDate": DateTimeUtc,
"endDate": DateTimeUtc,
"fields": ["xyz789"],
"renames": [FieldRename],
"filters": [Filter]
}
ExportConnection
Description
A paginated list of Export edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ExportEdge!]!
|
A list of Export edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ExportEdge]
}
ExportEdge
ExportFileType
Description
Export file type
Values
| Enum Value | Description |
|---|---|
|
|
Export file type is Comma separated values |
|
|
Export file type is Excel |
Example
"CSV"
ExportPeriod
Description
Export period
Values
| Enum Value | Description |
|---|---|
|
|
Last month |
|
|
Last 30 days |
|
|
Current month |
|
|
Last year |
|
|
Current year |
Example
"LAST_MONTH"
ExportStatus
Description
Export status
Values
| Enum Value | Description |
|---|---|
|
|
Pending |
|
|
In progress |
|
|
Completed |
|
|
Failed |
Example
"PENDING"
Facility
Types
| Union Types |
|---|
Example
Shop
Fare
FavoriteServiceType
Description
Types of locations a user can favorite.
Values
| Enum Value | Description |
|---|---|
|
|
Favorite a charging location. |
|
|
Favorite a parking location. |
Example
"CHARGING"
Features
Fields
| Field Name | Description |
|---|---|
type - String
|
Type of the GeoJSON object. Options: Feature |
properties - Properties
|
Properties of the GeoJSON object |
geometry - Geometry
|
Geometry of the GeoJSON object |
id - String
|
ID of the GeoJSON object |
Example
{
"type": "xyz789",
"properties": Properties,
"geometry": Geometry,
"id": "abc123"
}
Field
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Field id. |
tenant - Tenant!
|
Tenant. |
entityType - EntityType!
|
Entity type. |
name - String!
|
Field name. |
label - String!
|
Label. |
disabledAt - DateTimeUtc
|
Disabled at. |
deletedAt - DateTimeUtc
|
Deleted at. |
createdAt - DateTimeUtc
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"entityType": "ORGANIZATIONAL_COMPONENT",
"name": "abc123",
"label": "abc123",
"disabledAt": DateTimeUtc,
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
FieldRename
FieldRenameInput
File
Fields
| Field Name | Description |
|---|---|
url - String!
|
Url of the file. |
Example
{"url": "xyz789"}
Filter
Fields
| Field Name | Description |
|---|---|
field - String!
|
Field name. |
value - String!
|
Value. |
operator - SQLOperator
|
Operator |
Example
{
"field": "xyz789",
"value": "abc123",
"operator": "EQ"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FuelCard
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
provider - Provider!
|
Provider of the card (e.g. Lodder / EFAS) |
limit - Limit
|
Limit of the card |
locations - [FuelLocation!]
|
Location |
transactions - [FuelTransaction!]
|
Transactions of this card |
cardNumber - String
|
Card number |
pan - String
|
PAN of the card |
company - OrganizationalComponent
|
Company the card belongs to |
user - User
|
User the card belongs to |
vehicle - Vehicle
|
Vehicle |
card - Card
|
Associated Card |
disabledAt - DateTimeUtc
|
Disabled at |
expiryYear - Int!
|
Expiry year |
expiryMonth - Int!
|
Expiry month |
notes - [String]
|
Notes |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"provider": "LODDER",
"limit": Limit,
"locations": [FuelLocation],
"transactions": [FuelTransaction],
"cardNumber": "xyz789",
"pan": "xyz789",
"company": OrganizationalComponent,
"user": User,
"vehicle": Vehicle,
"card": Card,
"disabledAt": DateTimeUtc,
"expiryYear": 123,
"expiryMonth": 123,
"notes": ["xyz789"],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
FuelCardConnection
Description
A paginated list of FuelCard edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [FuelCardEdge!]!
|
A list of FuelCard edges. |
Example
{
"pageInfo": PageInfo,
"edges": [FuelCardEdge]
}
FuelCardEdge
FuelCardProvider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"EFAS"
FuelLimitInput
Fields
| Input Field | Description |
|---|---|
dailyTransactions - Int!
|
Daily transactions limit |
weeklyTransactions - Int!
|
Weekly transactions limit |
monthlyTransactions - Int!
|
Monthly transactions limit |
dailyAmount - Int!
|
Daily amount limit |
weeklyAmount - Int!
|
Weekly amount limit |
monthlyAmount - Int!
|
Monthly amount limit |
maxPinAttempts - Int!
|
Max number of Pin attempts |
Example
{
"dailyTransactions": 987,
"weeklyTransactions": 987,
"monthlyTransactions": 123,
"dailyAmount": 123,
"weeklyAmount": 123,
"monthlyAmount": 123,
"maxPinAttempts": 123
}
FuelLocation
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
provider - Provider!
|
Provider of the card (e.g. Lodder / EFAS) |
fuelCards - [FuelCard!]
|
Fuel cards |
transactions - [FuelTransaction!]
|
Transactions of this location |
name - String
|
Name |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
disabledAt - DateTimeUtc
|
Disabled at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"provider": "LODDER",
"fuelCards": [FuelCard],
"transactions": [FuelTransaction],
"name": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"disabledAt": DateTimeUtc
}
FuelSetting
FuelSettingsInput
FuelStock
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
compartment - Compartment!
|
Reference to Product service |
product - Product!
|
Reference to Product service |
capacity - Int!
|
|
minimumLevel - Int
|
The minimum volume the fuel stock is allowed to have |
alertLevel - Int
|
The amount of volume to trigger an alarm |
length - Int
|
In mm |
awsId - Int
|
The amount of volume to trigger an alarm |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"compartment": Compartment,
"product": Product,
"capacity": 123,
"minimumLevel": 987,
"alertLevel": 987,
"length": 123,
"awsId": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
FuelTank
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
length - Int
|
In mm |
diameter - Int
|
In mm |
tiltPercentage - Int
|
Tilt percentage |
capacity - Int
|
Tank Capacity |
gasStation - GasStation!
|
Gas Station |
compartments - [Compartment!]
|
|
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"length": 987,
"diameter": 987,
"tiltPercentage": 123,
"capacity": 987,
"gasStation": GasStation,
"compartments": [Compartment],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
FuelTransaction
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
provider - Provider!
|
Provider of the card (e.g. Lodder / EFAS) |
fuelCard - FuelCard!
|
Fuel card |
gasStation - GasStation!
|
Fuel location |
product - Product!
|
Associated product |
location - GasStation!
|
Fuel Location |
receiptNumber - String!
|
Receipt number |
volume - Float!
|
Volume |
price - Money!
|
Price |
date - DateTimeUtc!
|
Transaction date |
mileage - Int
|
Vehicle mileage |
deliveryDate - DateTimeUtc!
|
Delivery date |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"provider": "LODDER",
"fuelCard": FuelCard,
"gasStation": GasStation,
"product": Product,
"location": GasStation,
"receiptNumber": "abc123",
"volume": 123.45,
"price": Money,
"date": DateTimeUtc,
"mileage": 123,
"deliveryDate": DateTimeUtc
}
GasStation
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
hub - Hub
|
Hubs service hub entity |
brand - Brand
|
Brand service brand entity |
address - Address
|
Address service address entity |
name - String
|
|
location - String!
|
Location (city / town) |
url - String!
|
Website for the gas station |
isManned - Boolean!
|
Flag if it's a self service gas station |
serviceIds - ServiceIds
|
|
deactivatedAt - DateTimeUtc
|
Date and time the gas station was disabled |
fuelTanks - [FuelTank!]
|
Number of fuel tanks gas station has |
alerts - [Alert!]
|
Any alerts |
openingHours - [OpeningHour!]
|
Opening hours |
paymentMethods - [TerminalPaymentMethod!]
|
Payment methods available at gas station |
products - [Product!]
|
Products available at gas station |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"hub": Hub,
"brand": Brand,
"address": Address,
"name": "abc123",
"location": "abc123",
"url": "abc123",
"isManned": false,
"serviceIds": ServiceIds,
"deactivatedAt": DateTimeUtc,
"fuelTanks": [FuelTank],
"alerts": [Alert],
"openingHours": [OpeningHour],
"paymentMethods": [TerminalPaymentMethod],
"products": [Product],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
GasStationConnection
Description
A paginated list of GasStation edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [GasStationEdge!]!
|
A list of GasStation edges. |
Example
{
"pageInfo": PageInfo,
"edges": [GasStationEdge]
}
GasStationEdge
Description
An edge that contains a node of type GasStation and a cursor.
Fields
| Field Name | Description |
|---|---|
node - GasStation!
|
The GasStation node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": GasStation,
"cursor": "abc123"
}
Gender
Description
Genders
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MALE"
Geometry
Guarantee
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant!
|
Tenant the guarantee belongs to. |
organizationalComponent - OrganizationalComponent
|
Organizational component the guarantee is for. |
user - User
|
User who the guarantee is for. |
guaranteeType - GuaranteeType
|
Type of the guarantee. See GuaranteeType enum for possible values. |
amount - Money!
|
Amount of the guarantee. |
dateInitiated - Date
|
Date time when the guarantee was initiated. |
activeFrom - DateTimeUtc
|
Date that the guarantee is active from. |
fromImport - Boolean
|
Indicates if the guarantee is from an import. |
comment - String
|
Comments stored with the guarantee. |
status - GuaranteeStatus!
|
Status of the guarantee. See GuaranteeStatus enum for possible values. |
pdf - File
|
PDF of the guarantee. |
createdAt - DateTimeUtc
|
Date time when the guarantee was created. |
updatedAt - DateTimeUtc
|
Date time when the guarantee was last updated. |
metadata - [Value]
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"organizationalComponent": OrganizationalComponent,
"user": User,
"guaranteeType": "BANK",
"amount": Money,
"dateInitiated": "2007-12-03",
"activeFrom": DateTimeUtc,
"fromImport": true,
"comment": "xyz789",
"status": "PENDING",
"pdf": File,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"metadata": [Value]
}
GuaranteeConnection
Description
A paginated list of Guarantee edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [GuaranteeEdge!]!
|
A list of Guarantee edges. |
Example
{
"pageInfo": PageInfo,
"edges": [GuaranteeEdge]
}
GuaranteeEdge
Description
An edge that contains a node of type Guarantee and a cursor.
Fields
| Field Name | Description |
|---|---|
node - Guarantee!
|
The Guarantee node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": Guarantee,
"cursor": "xyz789"
}
GuaranteeStatus
Description
Guarantee status
Values
| Enum Value | Description |
|---|---|
|
|
The guarantee is pending |
|
|
The guarantee is received |
|
|
The guarantee is restituted |
|
|
The guarantee is booked |
|
|
The guarantee is paid |
|
|
The guarantee is refused |
|
|
The guarantee is requested |
|
|
The guarantee is returned |
|
|
The guarantee is used |
Example
"PENDING"
GuaranteeType
Description
Guarantee type
Values
| Enum Value | Description |
|---|---|
|
|
Bank guarantee |
|
|
Guarantee provided through bank deposit |
|
|
Example
"BANK"
Hub
Description
A hub of facilities.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
tenant - Tenant
|
Tenant this hub belongs to |
gasStations - [GasStation!]
|
Gas stations at this hub |
name - String
|
Name of the hub |
facilities - [Facility]
|
Facilities available at this hub |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"gasStations": [GasStation],
"name": "xyz789",
"facilities": [Shop]
}
HubConnection
Description
A paginated list of Hub edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [HubEdge!]!
|
A list of Hub edges. |
Example
{
"pageInfo": PageInfo,
"edges": [HubEdge]
}
HubEdge
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
ImportCardInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Company UUID |
nameOnCard - String
|
Name on Card |
cardNumber - String!
|
Card number |
products - [UUID!]!
|
Array of Product UUID |
cardType - CardType!
|
Type of card |
vehicleId - UUID
|
Vehicle UUID |
limit - ImportCardLimitInput!
|
Card limit |
tokenUid - String
|
Charge token UUID |
panNumber - String
|
Pan number |
driverCodeRequired - Boolean!
|
Is driver code required at time of fueling |
mileageRequired - Boolean!
|
Is mileage required at time of fueling |
expirationMonth - Int!
|
Card expiration month between 1-12 |
expirationYear - Int!
|
Card expiration year 4 digits |
externalReference - String
|
External ref number |
locale - Locale
|
Locale |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"nameOnCard": "xyz789",
"cardNumber": "abc123",
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"cardType": "CHARGE",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"limit": ImportCardLimitInput,
"tokenUid": "abc123",
"panNumber": "xyz789",
"driverCodeRequired": true,
"mileageRequired": true,
"expirationMonth": 987,
"expirationYear": 987,
"externalReference": "abc123",
"locale": "NL"
}
ImportCardLimitInput
ImportExpenseReportCardInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Organizational Component ID |
nameOnCard - String
|
Card Holder Name |
cardNumber - String!
|
Card Number |
products - [UUID!]!
|
Array of Product ID |
cardType - CardType!
|
Card Type, see CardType enum |
vehicleId - UUID
|
Vehicle ID |
limit - ImportCardLimitInput!
|
Card Limit |
tokenUid - String
|
Card Token UID |
panNumber - String
|
Pan Number |
driverCodeRequired - Boolean!
|
Is Driver Code Required |
mileageRequired - Boolean!
|
Is Mileage Required |
expirationMonth - Int!
|
Card expiration month |
expirationYear - Int!
|
Card 4 digit expiration year |
externalReference - String
|
External Reference |
token - String
|
Token |
maskedBankNumber - String
|
Masked Bank Number |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"nameOnCard": "xyz789",
"cardNumber": "xyz789",
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"cardType": "CHARGE",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"limit": ImportCardLimitInput,
"tokenUid": "abc123",
"panNumber": "xyz789",
"driverCodeRequired": false,
"mileageRequired": true,
"expirationMonth": 987,
"expirationYear": 123,
"externalReference": "abc123",
"token": "xyz789",
"maskedBankNumber": "abc123"
}
ImportUserInput
Fields
| Input Field | Description |
|---|---|
firstName - String!
|
First name |
lastName - String!
|
Last name |
email - String
|
Email address |
dateOfBirth - Date
|
Date of birth |
locale - Locale!
|
Locale |
gender - Gender
|
Gender |
iban - String
|
IBAN |
bic - String
|
BIC |
paymentMethod - PaymentMethod
|
Payment method |
billingPeriod - BillingPeriod
|
Billing period |
invoiceVia - [InvoiceVia]
|
Invoice via |
invoiceEmail - [String]
|
Invoice email |
vatNumber - String
|
Vat Number |
externalReference - String
|
External reference |
customerNumber - String
|
Customer number |
phoneNumbers - [addPhoneNumberInput!]
|
Phone numbers |
status - UserStatus
|
Status |
Example
{
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"dateOfBirth": "2007-12-03",
"locale": "NL",
"gender": "MALE",
"iban": "abc123",
"bic": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"invoiceEmail": ["abc123"],
"vatNumber": "xyz789",
"externalReference": "abc123",
"customerNumber": "abc123",
"phoneNumbers": [addPhoneNumberInput],
"status": "INCOMPLETE"
}
ImportVirtualCardInput
Example
{
"externalReference": "xyz789",
"cardNumber": "xyz789",
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"disabled": false
}
IncreaseCreditLimitTemporarilyInput
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 - UUID!
|
The unique identifier of the invoice. |
invoiceNumber - String
|
The invoice number. |
parent - Invoice
|
Parent invoice reference. |
child - Invoice
|
Child invoice reference. |
address - AddressDetails!
|
Address details of the invoice. |
user - InvoiceOwner
|
Owner of the invoice, if invoice is B2C invoice. |
company - InvoiceOwner
|
Owner of the invoice, if invoice is B2B invoice. |
invoiceableCompanyId - UUID
|
Invoiceable company id, if self invoice is not invoiceable. |
invoiceableCompany - OrganizationalComponent
|
Invoiceable company, if self invoice is not invoiceable. |
totalTax - Money!
|
Total tax amount of the invoice. |
vatBreakdown - [VatBreakdown!]
|
VAT breakdown of the invoice. |
subTotal - Money!
|
Sub total of the invoice. |
totalPrice - Money!
|
Total price of the invoice. |
effectiveDiscount - Money
|
Effective discount of the invoice. |
effectiveMargin - Money
|
Effective margin of the invoice. |
status - InvoiceStatusEnum!
|
Invoice Status, See InvoiceStatus Enum. |
notes - String
|
Notes |
creditedBy - User
|
Credited by user reference, If invoice is credited. |
invoiceRows - [InvoiceRow]
|
List of invoice rows. |
transactionBlocks - [TransactionBlock]
|
List of transaction blocks. |
tenant - TenantDetails!
|
Tenant details. |
mandate - Mandate
|
Mandate details. |
invoiceCategory - InvoiceCategory
|
Invoice category, See InvoiceCategory Enum. |
invoiceType - InvoiceType
|
Invoice type, See InvoiceType Enum. |
dueDate - DateTimeUtc
|
Due date of the invoice. |
paymentDate - DateTimeUtc
|
Payment date of the invoice. |
invoiceDate - DateTimeUtc
|
Invoice date. |
paymentMethod - PaymentMethod
|
Payment method of the invoice, See PaymentMethod Enum. |
paymentCollectionDate - DateTimeUtc
|
Payment collection date. |
statementPeriod - StatementPeriod
|
Invoice Statement period. |
pdf - String
|
Invoice PDF. |
language - Locale
|
Language |
createdAt - DateTimeUtc!
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"invoiceNumber": "abc123",
"parent": Invoice,
"child": Invoice,
"address": AddressDetails,
"user": InvoiceOwner,
"company": InvoiceOwner,
"invoiceableCompanyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"invoiceableCompany": OrganizationalComponent,
"totalTax": Money,
"vatBreakdown": [VatBreakdown],
"subTotal": Money,
"totalPrice": Money,
"effectiveDiscount": Money,
"effectiveMargin": Money,
"status": "CONCEPT",
"notes": "xyz789",
"creditedBy": User,
"invoiceRows": [InvoiceRow],
"transactionBlocks": [TransactionBlock],
"tenant": TenantDetails,
"mandate": Mandate,
"invoiceCategory": "SETTLEMENT",
"invoiceType": "B2B_INVOICE",
"dueDate": DateTimeUtc,
"paymentDate": DateTimeUtc,
"invoiceDate": DateTimeUtc,
"paymentMethod": "DIRECT_DEBIT",
"paymentCollectionDate": DateTimeUtc,
"statementPeriod": StatementPeriod,
"pdf": "xyz789",
"language": "NL",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
InvoiceAddressForUserInput
Fields
| Input Field | Description |
|---|---|
userId - UUID!
|
User id. |
street - String
|
Street name. Required for country BE. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
city - String!
|
City. |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "xyz789",
"postalCode": "abc123",
"country": "AL",
"city": "abc123"
}
InvoiceCategory
Description
Invoice category
Values
| Enum Value | Description |
|---|---|
|
|
Settlement |
|
|
Invoice |
|
|
Credit |
Example
"SETTLEMENT"
InvoiceColumns
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INVOICE_DATE"
InvoiceConfigurationInput
Fields
| Input Field | Description |
|---|---|
builders - [BuilderInput!]!
|
Invoice builders configuration |
Example
{"builders": [BuilderInput]}
InvoiceConnection
Description
A paginated list of Invoice edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [InvoiceEdge!]!
|
A list of Invoice edges. |
Example
{
"pageInfo": PageInfo,
"edges": [InvoiceEdge]
}
InvoiceEdge
InvoiceIdInput
Fields
| Input Field | Description |
|---|---|
invoiceIds - [UUID!]!
|
List of invoice identifying attributes |
Example
{
"invoiceIds": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
InvoiceOwner
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Unique identifier of the owner. |
name - String!
|
Name of the owner. |
address - AddressDetails!
|
Address details of the owner. |
bic - String
|
BIC Number |
iban - String
|
IBAN Number |
email - String
|
|
vatNumber - String
|
VAT Number |
paymentMethod - String
|
Payment method |
deliveryMethod - [String]
|
Delivery method or Invoice Via |
structuredReference - String
|
Structured reference |
purchaseOrderNumber - String
|
Purchase order number |
customerNumber - String
|
Customer number |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"address": AddressDetails,
"bic": "xyz789",
"iban": "abc123",
"email": "abc123",
"vatNumber": "xyz789",
"paymentMethod": "xyz789",
"deliveryMethod": ["abc123"],
"structuredReference": "xyz789",
"purchaseOrderNumber": "xyz789",
"customerNumber": "abc123"
}
InvoiceRow
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Invoice row unique identifier. |
name - String!
|
Name |
totalPrice - Money!
|
Total price |
totalTax - Money!
|
Total tax |
quantity - Float!
|
Quantity |
taxRate - Float!
|
Tax rate |
productType - InvoiceTransactionType
|
Product type, See InvoiceTransactionType Enum. |
createdAt - DateTimeUtc!
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "abc123",
"totalPrice": Money,
"totalTax": Money,
"quantity": 987.65,
"taxRate": 987.65,
"productType": "CHARGE_TOKEN",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
InvoiceStatus
Description
Invoice status
Values
| Enum Value | Description |
|---|---|
|
|
Concept will be consider as an open invoice |
|
|
Final will be consider as close invoice |
|
|
Invoice is sent to customer |
|
|
Invoice is reminded |
|
|
Invoice is reminded twice |
|
|
Invoice is paid |
|
|
Invoice payment is failed |
|
|
Invoice is refunded |
|
|
Debt reminder |
|
|
Debt collection |
|
|
Invoice is uncollectible |
|
|
Invoice is in payment plan |
|
|
Invoice is credited |
|
|
Invoice is awaiting direct debit payment |
Example
"CONCEPT"
InvoiceStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONCEPT"
InvoiceTransaction
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Unique identifier of the transaction. |
name - InvoiceTransactionType!
|
Transaction type, See InvoiceTransactionType Enum. |
product - String
|
Processed product. |
productType - String
|
Product type. |
vehicle - VehicleDetails
|
Vehicle details. |
user - InvoiceOwner
|
User as an owner detail. |
description - String!
|
Description |
totalPrice - Money!
|
Total price of the transaction. |
totalTax - Money!
|
Total tax of the transaction. |
unitPrice - Money!
|
Unit price of the transaction. |
discount - Money
|
Discount of the transaction. |
margin - Money
|
Margin of the transaction. |
metadata - String
|
Metadata/additional related details of the transaction. |
location - Location
|
Location details. |
quantity - Float!
|
Quantity of the transaction. |
taxRate - Float!
|
Tax rate of the transaction. |
service - TransactionService!
|
Service for which transaction is created. |
createdAt - DateTimeUtc!
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "CHARGE_TOKEN",
"product": "xyz789",
"productType": "xyz789",
"vehicle": VehicleDetails,
"user": InvoiceOwner,
"description": "xyz789",
"totalPrice": Money,
"totalTax": Money,
"unitPrice": Money,
"discount": Money,
"margin": Money,
"metadata": "xyz789",
"location": Location,
"quantity": 123.45,
"taxRate": 123.45,
"service": FuelTransaction,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
InvoiceTransactionType
Description
Invoice transaction type
Values
| Enum Value | Description |
|---|---|
|
|
EV transaction |
|
|
Fuel transaction |
|
|
Parking transaction |
|
|
Toll transaction |
|
|
End of Day transaction |
|
|
Subscription |
Example
"CHARGE_TOKEN"
InvoiceType
Description
Invoice type
Values
| Enum Value | Description |
|---|---|
|
|
B2B invoice |
|
|
B2C invoice |
|
|
Tolling settlement invoice |
|
|
Credit invoice |
|
|
Cross acceptance invoice |
Example
"B2B_INVOICE"
InvoiceVia
Description
How invoices will be sent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Post |
|
|
E-invoicing |
Example
"EMAIL"
InvoiceViaInput
Fields
| Input Field | Description |
|---|---|
deliveryMethod - String!
|
Invoice delivery method which can be email, post or e_invoicing. |
Example
{"deliveryMethod": "abc123"}
JSON
Description
Arbitrary data encoded in JavaScript Object Notation. See https://www.json.org.
Example
{}
KilometreCharge
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal System UUID |
user - User
|
User for which charge belongs to |
company - OrganizationalComponent
|
Company for which charge belongs to |
tenant - Tenant!
|
Tenant |
transactionId - String!
|
Transaction Id |
amount - Money!
|
Transaction Amount |
externalReference - String
|
External Reference number |
provider - KilometreChargingProvider!
|
Charge service provider |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"user": User,
"company": OrganizationalComponent,
"tenant": Tenant,
"transactionId": "xyz789",
"amount": Money,
"externalReference": "abc123",
"provider": "SATELLIC",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
KilometreChargeConnection
Description
A paginated list of KilometreCharge edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [KilometreChargeEdge!]!
|
A list of KilometreCharge edges. |
Example
{
"pageInfo": PageInfo,
"edges": [KilometreChargeEdge]
}
KilometreChargeEdge
Description
An edge that contains a node of type KilometreCharge and a cursor.
Fields
| Field Name | Description |
|---|---|
node - KilometreCharge!
|
The KilometreCharge node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": KilometreCharge,
"cursor": "abc123"
}
KilometreChargeProvider
Description
Kilometre charging providers
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SATELLIC"
KilometreChargingProvider
Description
Kilometre charging providers
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SATELLIC"
Limit
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
description - String
|
Description of the limit |
dailyTransactions - Int!
|
Daily transactions |
weeklyTransactions - Int!
|
Weekly transactions |
monthlyTransactions - Int!
|
Monthly transactions |
dailyAmount - Int!
|
Daily amount limit |
weeklyAmount - Int!
|
Weekly amount limit |
monthlyAmount - Int!
|
Monthly amount limit |
maxPinAttempts - Int!
|
Max pin attempts |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"description": "xyz789",
"dailyTransactions": 987,
"weeklyTransactions": 987,
"monthlyTransactions": 123,
"dailyAmount": 987,
"weeklyAmount": 987,
"monthlyAmount": 123,
"maxPinAttempts": 987,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
Locale
Description
Locales
Values
| Enum Value | Description |
|---|---|
|
|
Dutch |
|
|
French |
|
|
English |
|
|
German |
Example
"NL"
Location
Fields
| Field Name | Description |
|---|---|
name - String
|
Location name |
address - AddressDetails
|
Address details of the location. |
Example
{
"name": "xyz789",
"address": AddressDetails
}
LocationColumns
Values
| Enum Value | Description |
|---|---|
|
|
Name of the charge location |
|
|
ID of the charge location as known by the charge point operator |
|
|
Type of the charge location |
|
|
Country of the charge location |
|
|
Operator name |
|
|
Suboperator name |
|
|
Owner name |
|
|
Address of the charge location |
|
|
City of the charge location |
|
|
Postal code of the charge location |
Example
"NAME"
LocationOrderByColumn
Values
| Enum Value | Description |
|---|---|
|
|
Name of the charge location |
|
|
Type of the charge location |
|
|
Country of the charge location |
|
|
Distance of charge location to the search radius center. Distance order property is only available in combination with searchRadius or searchBox |
|
|
Datetime the charge location was created in the system. |
|
|
Datetime the charge location was last updated in the system. |
Example
"NAME"
Mandate
Description
A Mandate
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the mandate. |
metadata - [Value]
|
|
tenant - Tenant!
|
The Tenant the mandate is related to. |
user - User
|
The user |
company - OrganizationalComponent
|
The company |
debtorSignDate - DateTimeUtc
|
The DebtorSignDate of the mandate |
debtorMandate - String
|
The unique mandate id |
paymentMethod - PaymentMethod
|
The payment method |
mandateEmail - String
|
The mandate email |
pdf - String
|
|
status - MandateStatus!
|
The status of the mandate |
origin - MandateOrigin
|
Origin of Mandate |
mandateCode - String
|
The mandate code |
mandateType - ContractType
|
The mandate type |
mandateTemplate - MandateTemplate
|
|
activeFrom - DateTimeUtc
|
From when the mandate is active |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"metadata": [Value],
"tenant": Tenant,
"user": User,
"company": OrganizationalComponent,
"debtorSignDate": DateTimeUtc,
"debtorMandate": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"mandateEmail": "xyz789",
"pdf": "xyz789",
"status": "PENDING",
"origin": "IMPORT",
"mandateCode": "abc123",
"mandateType": "B2B",
"mandateTemplate": MandateTemplate,
"activeFrom": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
MandateConnection
Description
A paginated list of Mandate edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [MandateEdge!]!
|
A list of Mandate edges. |
Example
{
"pageInfo": PageInfo,
"edges": [MandateEdge]
}
MandateEdge
MandateEntityType
Description
Mandate entity type
Values
| Enum Value | Description |
|---|---|
|
|
B2C mandate |
|
|
B2B mandate |
Example
"USER"
MandateOrigin
Description
Mandate origin
Values
| Enum Value | Description |
|---|---|
|
|
Manually imported mandates |
|
|
Mandates created through the Twikey platform |
Example
"IMPORT"
MandateStatus
Description
Mandate status
Values
| Enum Value | Description |
|---|---|
|
|
Mandate is pending |
|
|
Mandate is invited |
|
|
Mandate is signed |
|
|
Mandate is approved |
|
|
Mandate is rejected |
|
|
Mandate is cancelled |
Example
"PENDING"
MandateTemplate
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the mandate template. |
type - ContractType!
|
The type of contract, see ContractType enum |
externalId - String!
|
The external identifier of the mandate template. This is the identifier in Twikey. |
name - String!
|
The name of the mandate template. |
hasTermsOfAgreement - Boolean!
|
Indicates if signing the mandate means the user/company agrees to the terms of agreement. |
createdAt - DateTimeUtc
|
Date when the mandate template was created. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "B2B",
"externalId": "abc123",
"name": "abc123",
"hasTermsOfAgreement": true,
"createdAt": DateTimeUtc
}
MandateTemplateConnection
Description
A paginated list of MandateTemplate edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [MandateTemplateEdge!]!
|
A list of MandateTemplate edges. |
Example
{
"pageInfo": PageInfo,
"edges": [MandateTemplateEdge]
}
MandateTemplateEdge
Description
An edge that contains a node of type MandateTemplate and a cursor.
Fields
| Field Name | Description |
|---|---|
node - MandateTemplate!
|
The MandateTemplate node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": MandateTemplate,
"cursor": "abc123"
}
MetaDataInput
Fields
| Input Field | Description |
|---|---|
duration - Int
|
Example
{"duration": 123}
Metadata
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Metadata id. |
name - String!
|
Field name. |
value - String
|
Value. |
entity - Entity
|
Entity. |
createdAt - DateTimeUtc
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"value": "xyz789",
"entity": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
MetadataConnection
Description
A paginated list of Metadata edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [MetadataEdge!]!
|
A list of Metadata edges. |
Example
{
"pageInfo": PageInfo,
"edges": [MetadataEdge]
}
MetadataEdge
MetadataInput
Fields
| Input Field | Description |
|---|---|
entityId - UUID!
|
Entity id. |
entityType - EntityType!
|
Entity type. |
values - [ValueInput]!
|
Metadata values for the fields. |
Example
{
"entityId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"entityType": "ORGANIZATIONAL_COMPONENT",
"values": [ValueInput]
}
Mixed
Description
Loose type that allows any value. Be careful when passing in large Int or Float literals, as they may not be parsed correctly on the server side. Use String literals if you are dealing with really large numbers to be on the safe side.
Example
Mixed
ModificationAdjustmentType
Description
Determines how the modification will be applied
Values
| Enum Value | Description |
|---|---|
|
|
Addition to the price |
|
|
Discount to the price |
Example
"MARGIN"
Module
Description
The modules that have been implemented for this version.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
identifier - ModuleIdentifier!
|
The identifier of the module. See ModuleIdentifier ENUM for possible values. |
url - String!
|
The URL of the module. |
version - Version!
|
Version this module belongs to. |
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"identifier": "CREDENTIALS",
"url": "abc123",
"version": Version,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
ModuleIdentifier
Values
| Enum Value | Description |
|---|---|
|
|
The module for managing the credentials of the users |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREDENTIALS"
Money
MoveCardToTemplateInput
Fields
| Input Field | Description |
|---|---|
templateId - UUID!
|
Card template id |
Example
{
"templateId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
NACECode
Example
{
"code": "xyz789",
"description": "abc123",
"classification": "abc123",
"text": "abc123",
"isMainActivity": false
}
Nozzle
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
compartment - Compartment!
|
Reference to Product service |
product - Product!
|
Reference to Product service |
number - Int!
|
Nozzle serial number |
lonCode - String
|
The maximum volume of the compartment |
status - String
|
The amount of volume to trigger an alarm |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"compartment": Compartment,
"product": Product,
"number": 123,
"lonCode": "xyz789",
"status": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
OpenTransactions
OpeningHour
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier. Reference to Opening hours service |
gasStations - [GasStation!]
|
List of gas stations which has same opening hour |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"gasStations": [GasStation]
}
Order
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
orderNumber - Int!
|
Order number sequence |
address - OrderShippingAddress!
|
Order's shipping address |
company - OrganizationalComponent
|
Company to which order belongs |
user - User
|
User to which order belongs |
status - OrderStatus!
|
Order Status |
comments - [OrderComment]
|
Order's comments |
products - [OrderProduct]
|
Order's products |
productsCount - Int
|
Product Total |
createdAt - DateTimeUtc
|
Created At |
updatedAt - DateTimeUtc
|
Updated At |
lastOpenedAt - DateTimeUtc
|
Last Opened At |
createdBy - User
|
Created By |
updatedBy - User
|
Updated By |
lastOpenedBy - User
|
Last opened by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"orderNumber": 987,
"address": OrderShippingAddress,
"company": OrganizationalComponent,
"user": User,
"status": "DRAFT",
"comments": [OrderComment],
"products": [OrderProduct],
"productsCount": 987,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"lastOpenedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"lastOpenedBy": User
}
OrderComment
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
order - Order!
|
Order to which comment belongs |
comment - String!
|
Comment |
createdAt - DateTimeUtc
|
Created At |
createdBy - User
|
Created by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"order": Order,
"comment": "xyz789",
"createdAt": DateTimeUtc,
"createdBy": User
}
OrderConnection
Description
A paginated list of Order edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [OrderEdge!]!
|
A list of Order edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderEdge]
}
OrderEdge
OrderProduct
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
address - OrderShippingAddress
|
Product's shipping address |
order - Order!
|
Orders to which product belongs |
details - ProductAssociation!
|
Product association |
createdBy - User
|
Created By |
updatedBy - User
|
Updated By |
createdAt - DateTimeUtc
|
Created At |
updatedAt - DateTimeUtc
|
Updated At |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": OrderShippingAddress,
"order": Order,
"details": CardProduct,
"createdBy": User,
"updatedBy": User,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
OrderShippingAddress
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
firstName - String!
|
First name |
lastName - String!
|
Last Name |
phoneNumber - String
|
Phone number |
name - String
|
Name |
city - String!
|
City |
street - String
|
Street |
postalCode - String!
|
Postal code |
country - Country!
|
Country |
houseNumber - String!
|
House number |
houseNumberAddition - String
|
House number addition |
province - String
|
Province |
location - Coordinates
|
Location cordinates |
area - String
|
Area |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"firstName": "xyz789",
"lastName": "xyz789",
"phoneNumber": "abc123",
"name": "xyz789",
"city": "abc123",
"street": "xyz789",
"postalCode": "xyz789",
"country": "AL",
"houseNumber": "xyz789",
"houseNumberAddition": "xyz789",
"province": "xyz789",
"location": Coordinates,
"area": "abc123"
}
OrderStatus
Description
Order status
Values
| Enum Value | Description |
|---|---|
|
|
Order is in draft |
|
|
Order is approved |
|
|
Order is in review |
|
|
Cards within order are being printed. |
|
|
Order is rejected |
|
|
Order is completed |
Example
"DRAFT"
OrganizationalComponent
Description
Organizational component is the collective name for an part of the organization or the entire company itself. Using organizational component types a hierarchy can be created of companies, locations, departments.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
address - Address
|
|
invoiceAddress - Address
|
|
shippingAddresses - [ShippingAddress]
|
|
chargeTokens - [ChargeToken]
|
Charge tokens owned by the organizational component. |
chargeRecordsLatestWeeklyStatistics - CompanyWeeklyChargeStatistics
|
Latest weekly charge records statistics for the organizational component. |
chargeRecordsWeeklyStatistics - CompanyWeeklyChargeStatisticsPaginator!
|
List of weekly charge records statistics for the organizational component. |
chargeRecordsMonthlyStatistics - CompanyMonthlyChargeStatisticsPaginator!
|
List of monthly charge records statistics for the organizational component. |
chargeRecordsYearlyStatistics - CompanyYearlyChargeStatisticsPaginator!
|
List of yearly charge records statistics for the organizational component. |
tenant - Tenant!
|
Tenant the organizational component belongs to. |
organizationalComponentType - OrganizationalComponentType!
|
Type of the organizational component. |
name - String!
|
Name of the organizational component. |
email - String
|
Email address of the organizational component. |
phoneNumbers - [ContactPersonPhoneNumber!]!
|
Phone numbers of the organizational component. |
registrationNumber - String
|
Registration number of the organizational component. |
customerNumber - String
|
Customer number of the organizational component. |
naceCode - String
|
NACE code of the organizational component. |
website - String
|
Website of the organizational component. |
country - Country!
|
Country of the organizational component. |
invoiced - Boolean!
|
Indication if the organizational component is invoiced. |
vatNumber - String
|
Vat number of the organizational component. |
iban - String
|
IBAN number of the organizational component. |
bic - String
|
BIC number of the organizational component. |
billingPeriod - BillingPeriod
|
Billing period of the organizational component. |
invoiceVia - [InvoiceVia!]
|
Method of sending invoices to the organizational component. |
paymentMethod - PaymentMethod
|
Payment method of the organizational component. |
status - OrganizationalComponentStatusType!
|
Status of the organizational component. |
purchaseOrderNumber - String
|
Purchase order number of the organizational component. |
externalReference - String
|
External reference of the organizational component. Can be used to reference the company to an external system. |
language - Locale
|
Language of the organizational component. |
invoiceEmail - [String!]!
|
Email to send invoices to if email was selected as invoice via. |
creditLimit - Money
|
Credit limit of the organizational component. |
parent - OrganizationalComponent
|
Parent organizational component. |
children - [OrganizationalComponent]
|
Children organizational components. |
segment - CompanySegment
|
Company segment of the organizational component. |
contactPerson - OrganizationalComponentContactPerson
|
Contact person of the organizational component. |
creditCheck - CreditCheck
|
Credit check of the organizational component. |
guarantees - [Guarantee]
|
Guarantees this organizational component has. |
paymentTerm - Int
|
Payment term of the organizational component. |
requirements - [Requirement!]
|
Requirements before this organizational component is considered status complete. |
inCompleteRequirements - [RequirementType!]
|
Requirements that are not yet completed. |
contract - File
|
Contract with the organizational component. |
temporaryCreditLimit - TemporaryCreditLimit
|
Temporary credit limit of the organizational component. |
organizationHierarchy - JSON
|
JSON structure of the entire organizational component hierarchy. Starting from the root. |
structuredReference - StructuredReferenceNumber
|
Structured reference used for bank transfers for organizational components from Belgium |
invoicableCompany - OrganizationalComponent
|
Organizational component to invoice if current organizational component is not invoicable. Use invoiceableOrganizationalComponent instead |
invoiceableOrganizationalComponent - OrganizationalComponent
|
Organizational component to invoice if current organizational component is not invoicable. |
isCreditCheckPossible - Boolean!
|
Indication if a credit check is possible for this organizational component. |
pivot - OrganizationalComponentUserPivot
|
Employee data between the organizational component and the user. This property is only available when querying through a user. |
companyApproval - CompanyApproval
|
Indication if terms and conditions are approved by the organizational component. |
legalForm - String
|
Legal form of the organizational component. |
tradeName - String
|
Trade name of the organizational component. |
disabledAt - DateTimeUtc
|
Indication if the organizational component is disabled. Null if not disabled |
disabledReason - CompanyDisabledReason
|
Reason why the organizational component is disabled. |
disabledComment - String
|
Comment why the organizational component is disabled. |
deletedAt - DateTimeUtc
|
Indication if the organizational component is deleted. Null if not deleted. |
createdAt - DateTimeUtc
|
Date time when the organizational component was created. |
updatedAt - DateTimeUtc
|
Date time when the organizational component was last updated. |
createdBy - User
|
User who created the organizational component. |
updatedBy - User
|
User who last updated the organizational component. |
employees - UserConnection!
|
Employees within the organizational component. |
activatedAt - DateTime
|
Activated at datetime. |
cards - [Card!]
|
Array of all cards associated with the organizational component. |
fuelTransactionsLatestWeeklyStatistics - CompanyFuelWeeklyTransactions
|
Latest Transaction of weekly statistics |
fuelTransactionsWeeklyStatistics - [CompanyFuelWeeklyTransactions]
|
Transactions of weekly statistics |
fuelTransactionsMonthlyStatistics - [CompanyFuelMonthlyTransactions]
|
Transactions of monthly statistics |
fuelTransactionsYearlyStatistics - [CompanyFuelYearlyTransactions]
|
Transactions of yearly statistics |
identificationNumbers - [CompanyIdentificationNumber]
|
Company Identification numbers |
metadata - [Value]
|
|
mandate - [Mandate!]
|
Returns a list of mandates Use mandates instead |
mandates - [Mandate!]
|
Returns a list of mandates |
priceModifications - [PriceModification]!
|
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"chargeTokens": [ChargeToken],
"chargeRecordsLatestWeeklyStatistics": CompanyWeeklyChargeStatistics,
"chargeRecordsWeeklyStatistics": CompanyWeeklyChargeStatisticsPaginator,
"chargeRecordsMonthlyStatistics": CompanyMonthlyChargeStatisticsPaginator,
"chargeRecordsYearlyStatistics": CompanyYearlyChargeStatisticsPaginator,
"tenant": Tenant,
"organizationalComponentType": OrganizationalComponentType,
"name": "abc123",
"email": "xyz789",
"phoneNumbers": [ContactPersonPhoneNumber],
"registrationNumber": "abc123",
"customerNumber": "xyz789",
"naceCode": "xyz789",
"website": "abc123",
"country": "AL",
"invoiced": true,
"vatNumber": "xyz789",
"iban": "xyz789",
"bic": "abc123",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"paymentMethod": "DIRECT_DEBIT",
"status": "INCOMPLETE",
"purchaseOrderNumber": "xyz789",
"externalReference": "xyz789",
"language": "NL",
"invoiceEmail": ["xyz789"],
"creditLimit": Money,
"parent": OrganizationalComponent,
"children": [OrganizationalComponent],
"segment": CompanySegment,
"contactPerson": OrganizationalComponentContactPerson,
"creditCheck": CreditCheck,
"guarantees": [Guarantee],
"paymentTerm": 123,
"requirements": [Requirement],
"inCompleteRequirements": ["CREDIT_CHECK"],
"contract": File,
"temporaryCreditLimit": TemporaryCreditLimit,
"organizationHierarchy": {},
"structuredReference": StructuredReferenceNumber,
"invoicableCompany": OrganizationalComponent,
"invoiceableOrganizationalComponent": OrganizationalComponent,
"isCreditCheckPossible": true,
"pivot": OrganizationalComponentUserPivot,
"companyApproval": CompanyApproval,
"legalForm": "abc123",
"tradeName": "xyz789",
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"employees": UserConnection,
"activatedAt": "2007-12-03T10:15:30Z",
"cards": [Card],
"fuelTransactionsLatestWeeklyStatistics": CompanyFuelWeeklyTransactions,
"fuelTransactionsWeeklyStatistics": [
CompanyFuelWeeklyTransactions
],
"fuelTransactionsMonthlyStatistics": [
CompanyFuelMonthlyTransactions
],
"fuelTransactionsYearlyStatistics": [
CompanyFuelYearlyTransactions
],
"identificationNumbers": [CompanyIdentificationNumber],
"metadata": [Value],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification]
}
OrganizationalComponentConnection
Description
A paginated list of OrganizationalComponent edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [OrganizationalComponentEdge!]!
|
A list of OrganizationalComponent edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrganizationalComponentEdge]
}
OrganizationalComponentContactPerson
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
firstName - String!
|
First name of the contact person. |
lastName - String!
|
Last name of the contact person. |
email - String
|
Email address of the contact person. |
gender - Gender!
|
Gender of the contact person. |
phoneNumbers - [ContactPersonPhoneNumber!]!
|
Phone numbers of the contact person. |
language - Locale!
|
Language of the contact person. |
createdAt - DateTimeUtc
|
Date time when the contact person was created. |
updatedAt - DateTimeUtc
|
Date time when the contact person was last updated. |
createdBy - User
|
User who created the contact person. |
updatedBy - User
|
User who last updated the contact person. |
metadata - [Value]
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"firstName": "abc123",
"lastName": "abc123",
"email": "xyz789",
"gender": "MALE",
"phoneNumbers": [ContactPersonPhoneNumber],
"language": "NL",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"metadata": [Value]
}
OrganizationalComponentDisabledInput
Fields
| Input Field | Description |
|---|---|
disabledReason - CompanyDisabledReason!
|
Reason why the organizational component is disabled. See CompanyDisabledReason enum. |
disabledComment - String
|
Optional comment for the reason why the organizational component is disabled |
Example
{
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "abc123"
}
OrganizationalComponentEdge
Description
An edge that contains a node of type OrganizationalComponent and a cursor.
Fields
| Field Name | Description |
|---|---|
node - OrganizationalComponent!
|
The OrganizationalComponent node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": OrganizationalComponent,
"cursor": "xyz789"
}
OrganizationalComponentStatisticType
Description
Organizational component statistic type.
Values
| Enum Value | Description |
|---|---|
|
|
Default organizational component. |
|
|
Organizational component created for expense reporting. |
Example
"COMPANY"
OrganizationalComponentStatusType
Description
Status of an organizational component
Values
| Enum Value | Description |
|---|---|
|
|
The organizational component is incomplete |
|
|
The organizational component is complete |
|
|
The organizational component is disabled |
|
|
The organizational component has exceeded its credit limit |
Example
"INCOMPLETE"
OrganizationalComponentType
Description
Organizational component types are a way to indicate what type a organizational component is. By default the types "Company", "Location" and "Department" are created.
Organizational component type "Company" is a system type and cannot be updated or deleted. Based on this value an organizational component may have additional requirements.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant!
|
Tenant the organizational component type belongs to. |
name - String!
|
Name of the organizational component type. |
deletedAt - DateTimeUtc
|
Indication if the organizational component type is deleted. Null if not deleted. |
createdAt - DateTimeUtc
|
Date time when the organizational component type was created. |
updatedAt - DateTimeUtc
|
Date time when the organizational component type was last updated. |
createdBy - User
|
User who created the organizational component type. |
updatedBy - User
|
User who last updated the organizational component type. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"name": "xyz789",
"deletedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
OrganizationalComponentTypeInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the organizational component type to create |
Example
{"name": "xyz789"}
OrganizationalComponentUserPivot
Fields
| Field Name | Description |
|---|---|
isManager - Boolean!
|
Indication if the user is manager of the organizational component. |
driverId - String
|
Driver id of the employee. Can be used as extra check when authorizing fuel visits in EFAS. |
createdAt - DateTimeUtc
|
Date time when the user was added to the organizational component. |
updatedAt - DateTimeUtc
|
Date time when the user was last updated in the organizational component. |
createdBy - User
|
User who added the user to the organizational component. |
updatedBy - User
|
User who last updated the user in the organizational component. |
Example
{
"isManager": false,
"driverId": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
PageInfo
Description
Information about pagination using a Relay style cursor connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
The cursor to continue paginating backwards. |
endCursor - String
|
The cursor to continue paginating forwards. |
total - Int!
|
Total number of nodes in the paginated connection. |
count - Int!
|
Number of nodes in the current page. |
currentPage - Int!
|
Index of the current page. |
lastPage - Int!
|
Index of the last available page. |
Example
{
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123",
"endCursor": "abc123",
"total": 123,
"count": 987,
"currentPage": 987,
"lastPage": 987
}
PaginatorInfo
Description
Information about pagination using a fully featured paginator.
Fields
| Field Name | Description |
|---|---|
count - Int!
|
Number of items in the current page. |
currentPage - Int!
|
Index of the current page. |
firstItem - Int
|
Index of the first item in the current page. |
hasMorePages - Boolean!
|
Are there more pages after this one? |
lastItem - Int
|
Index of the last item in the current page. |
lastPage - Int!
|
Index of the last available page. |
perPage - Int!
|
Number of items per page. |
total - Int!
|
Number of total available items. |
Example
{
"count": 123,
"currentPage": 987,
"firstItem": 123,
"hasMorePages": true,
"lastItem": 123,
"lastPage": 987,
"perPage": 123,
"total": 123
}
ParkingAddress
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"street": "xyz789",
"streetNumber": "xyz789",
"postalCode": "abc123",
"city": "xyz789",
"country": "AL",
"province": "xyz789"
}
ParkingCosts
Fields
| Field Name | Description |
|---|---|
areaManagerId - Int!
|
|
areaId - String!
|
|
calculatedAmount - String
|
|
calculatedVAT - String
|
|
specifCalcAmountList - [ParkingSpecificAmountList]
|
Example
{
"areaManagerId": 123,
"areaId": "xyz789",
"calculatedAmount": "xyz789",
"calculatedVAT": "xyz789",
"specifCalcAmountList": [ParkingSpecificAmountList]
}
ParkingFareInfo
ParkingLocation
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
externalId - String
|
|
name - String
|
|
description - String
|
|
parkingEnabled - Boolean
|
|
address - ParkingAddress
|
|
provider - ParkingProvider
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"externalId": "xyz789",
"name": "xyz789",
"description": "abc123",
"parkingEnabled": false,
"address": ParkingAddress,
"provider": ParkingProvider
}
ParkingLocationConnection
Description
A paginated list of ParkingLocation edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ParkingLocationEdge!]!
|
A list of ParkingLocation edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ParkingLocationEdge]
}
ParkingLocationEdge
Description
An edge that contains a node of type ParkingLocation and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ParkingLocation!
|
The ParkingLocation node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ParkingLocation,
"cursor": "abc123"
}
ParkingProvider
ParkingSession
Description
Parking Session
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
location - ParkingLocation
|
|
vehicle - Vehicle
|
|
user - User
|
|
tenant - Tenant
|
|
cost - Money
|
|
vat - Float
|
|
startedAt - DateTimeUtc!
|
|
endedAt - DateTimeUtc
|
|
cancelledAt - DateTimeUtc
|
|
createdAt - DateTimeUtc!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"location": ParkingLocation,
"vehicle": Vehicle,
"user": User,
"tenant": Tenant,
"cost": Money,
"vat": 987.65,
"startedAt": DateTimeUtc,
"endedAt": DateTimeUtc,
"cancelledAt": DateTimeUtc,
"createdAt": DateTimeUtc
}
ParkingSessionConnection
Description
A paginated list of ParkingSession edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ParkingSessionEdge!]!
|
A list of ParkingSession edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ParkingSessionEdge]
}
ParkingSessionEdge
Description
An edge that contains a node of type ParkingSession and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ParkingSession!
|
The ParkingSession node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ParkingSession,
"cursor": "abc123"
}
ParkingSpecificAmountList
Example
{
"regulationId": "xyz789",
"startTimeApplied": "2007-12-03T10:15:30Z",
"endTimeApplied": "2007-12-03T10:15:30Z",
"amountFraction": "abc123",
"VATAmountFraction": "xyz789"
}
PaymentMethod
Description
Payment method
Values
| Enum Value | Description |
|---|---|
|
|
Payment through direct debit |
|
|
Payment through invoice |
|
|
Payment through e-invoicing |
Example
"DIRECT_DEBIT"
PhoneNumber
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the phone number. |
country - Country
|
Country of the phone number |
type - PhoneNumberType
|
Type of the phone number. See PhoneNumberType enum. |
number - String
|
Phone number |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"country": "AL",
"type": "LANDLINE",
"number": "abc123"
}
PhoneNumberInput
Fields
| Input Field | Description |
|---|---|
number - String!
|
Phone number |
type - PhoneNumberType!
|
Phone number type. See PhoneNumberType enum. |
country - Country!
|
Country code of the phone number |
Example
{
"number": "abc123",
"type": "LANDLINE",
"country": "AL"
}
PhoneNumberType
Description
Phone number type
Values
| Enum Value | Description |
|---|---|
|
|
Landline phone number |
|
|
Mobile phone number |
|
|
Fax number |
Example
"LANDLINE"
PriceComponentInput
Fields
| Input Field | Description |
|---|---|
type - TariffDimensionType!
|
Price component type |
price - Float!
|
Price component price |
stepSize - Int!
|
Price component step size |
Example
{"type": "ENERGY", "price": 987.65, "stepSize": 987}
PriceModification
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the price modification. |
conditions - [Condition]
|
Conditions that must be met for the price modification to be applied. |
tenant - Tenant!
|
The tenant that the price modification belongs to. |
description - String!
|
Description |
promoCode - String
|
Promo Code |
associations - [PriceModificationAssociation]
|
Associations with other entities. |
type - PriceType!
|
Type. See PriceType enum. |
adjustmentType - ModificationAdjustmentType!
|
Adjustment type. See ModificationAdjustmentType enum. |
scope - PriceModificationScope!
|
Scope. See PriceModificationScope enum. |
inverse - Boolean!
|
Inverse |
volumePriceModificationPeriod - VolumePriceModificationPeriod
|
Volume Price Modification Period. See VolumePriceModificationPeriod enum. |
isVolumePriceModificationEnabled - Boolean!
|
Is Volume Price Modification Enabled |
products - [PriceModificationPerProduct!]
|
Products that the price modification applies to. |
externalReference - String
|
External Reference |
startDate - DateTimeUtc
|
Start Date |
endDate - DateTimeUtc
|
End Date |
createdAt - DateTimeUtc!
|
Created At |
updatedAt - DateTimeUtc
|
Updated At |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"conditions": [Condition],
"tenant": Tenant,
"description": "xyz789",
"promoCode": "abc123",
"associations": [PriceModificationAssociation],
"type": "SELLING",
"adjustmentType": "MARGIN",
"scope": "PER_UNIT",
"inverse": false,
"volumePriceModificationPeriod": "MONTHLY",
"isVolumePriceModificationEnabled": true,
"products": [PriceModificationPerProduct],
"externalReference": "xyz789",
"startDate": DateTimeUtc,
"endDate": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
PriceModificationAssociation
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the price modification association. |
associationType - AssociationType!
|
Association Type. See AssociationType enum. |
associatedEntities - [EntityAssociation!]
|
Associated Entities |
createdAt - DateTimeUtc!
|
Created At |
updatedAt - DateTimeUtc
|
Updated At |
deletedAt - DateTimeUtc
|
Deleted At |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"associationType": "SINGLE",
"associatedEntities": [EntityAssociation],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"deletedAt": DateTimeUtc
}
PriceModificationConnection
Description
A paginated list of PriceModification edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [PriceModificationEdge!]!
|
A list of PriceModification edges. |
Example
{
"pageInfo": PageInfo,
"edges": [PriceModificationEdge]
}
PriceModificationEdge
Description
An edge that contains a node of type PriceModification and a cursor.
Fields
| Field Name | Description |
|---|---|
node - PriceModification!
|
The PriceModification node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": PriceModification,
"cursor": "xyz789"
}
PriceModificationMethod
Description
Price modification method
Values
| Enum Value | Description |
|---|---|
|
|
Price modification in percentage |
|
|
Price modification in fixed amount |
Example
"PERCENTAGE"
PriceModificationPerProduct
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the price modification per product. |
name - String!
|
Product Name |
pivot - ProductPivot!
|
Pivot Data to identify the price modification info for the product. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"pivot": ProductPivot
}
PriceModificationPerProductDetailsInfoInput
Fields
| Input Field | Description |
|---|---|
method - PriceModificationMethod!
|
Method. See PriceModificationMethod enum |
minVolume - Int
|
minimum volume. Required if method is VOLUME |
maxVolume - Int
|
maximum volume. Required if method is VOLUME |
value - Float!
|
Value. Required in euros. |
Example
{"method": "PERCENTAGE", "minVolume": 987, "maxVolume": 987, "value": 123.45}
PriceModificationPerProductDetailsInput
Fields
| Input Field | Description |
|---|---|
productId - UUID!
|
Product id |
info - [PriceModificationPerProductDetailsInfoInput!]!
|
Price modification per product details info |
Example
{
"productId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"info": [PriceModificationPerProductDetailsInfoInput]
}
PriceModificationScope
Description
Scope of price modification
Values
| Enum Value | Description |
|---|---|
|
|
Price modification will be applied to per unit price |
|
|
Price modification will be applied to total price |
Example
"PER_UNIT"
PriceType
Description
The type of price on which the price modification will be applied
Values
| Enum Value | Description |
|---|---|
|
|
Pump Price |
|
|
Government Price |
|
|
Purchased Price |
Example
"SELLING"
PrintInfo
PrintInfoInput
Probe
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
compartment - Compartment!
|
Reference to Product service |
height - Int!
|
|
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"compartment": Compartment,
"height": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
Product
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
type - String!
|
Type of Product |
label - String!
|
Label |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
provider - Provider!
|
Provider of the card (e.g. Lodder / EFAS) |
transactions - [FuelTransaction!]
|
Transactions of this product |
gasStations - [GasStation!]
|
Gas stations that have this product |
price - Money!
|
Price of the product |
categories - [ProductCategory!]
|
Categories |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "xyz789",
"label": "xyz789",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"provider": "LODDER",
"transactions": [FuelTransaction],
"gasStations": [GasStation],
"price": Money,
"categories": [ProductCategory]
}
ProductAssociation
Types
| Union Types |
|---|
Example
CardProduct
ProductCategory
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
label - String!
|
Label of the category |
products - [Product!]
|
Products |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"label": "abc123",
"products": [Product],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ProductCategoryConnection
Description
A paginated list of ProductCategory edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ProductCategoryEdge!]!
|
A list of ProductCategory edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductCategoryEdge]
}
ProductCategoryEdge
Description
An edge that contains a node of type ProductCategory and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ProductCategory!
|
The ProductCategory node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ProductCategory,
"cursor": "xyz789"
}
ProductConnection
Description
A paginated list of Product edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ProductEdge!]!
|
A list of Product edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductEdge]
}
ProductEdge
ProductPackage
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
tenant - Tenant!
|
Tenant |
products - [Product!]!
|
Products |
name - String!
|
Name of the package |
description - String
|
Description of the package |
price - Money!
|
Price of the package |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"products": [Product],
"name": "abc123",
"description": "abc123",
"price": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
ProductPackageConnection
Description
A paginated list of ProductPackage edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ProductPackageEdge!]!
|
A list of ProductPackage edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductPackageEdge]
}
ProductPackageEdge
Description
An edge that contains a node of type ProductPackage and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ProductPackage!
|
The ProductPackage node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ProductPackage,
"cursor": "abc123"
}
ProductPivot
Fields
| Field Name | Description |
|---|---|
minVolume - Int
|
Minimum Volume if applicable |
maxVolume - Int
|
Maximum Volume if applicable |
method - PriceModificationMethod!
|
Method. See PriceModificationMethod enum. |
value - Float!
|
Value In Euros |
Example
{"minVolume": 123, "maxVolume": 123, "method": "PERCENTAGE", "value": 123.45}
Properties
Fields
| Field Name | Description |
|---|---|
cluster - Boolean
|
Indicates if the feature response is a cluster |
clusterId - String
|
Cluster ID |
pointCount - String
|
Amount of charge locations within the cluster |
pointCountAbbreviated - String
|
Amount of charge locations within the cluster human readable. |
status - String
|
Status of the charge location |
Example
{
"cluster": true,
"clusterId": "abc123",
"pointCount": "abc123",
"pointCountAbbreviated": "abc123",
"status": "xyz789"
}
Provider
Description
The type of the fuel card provider
Values
| Enum Value | Description |
|---|---|
|
|
Lodder provider. |
|
|
EFAS provider. |
Example
"LODDER"
QueryCardsGetCardsOrderByColumn
Description
Allowed column names for Query.cardsGetCards.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISABLED_AT"
QueryCardsGetCardsOrderByOrderByClause
Description
Order by clause for Query.cardsGetCards.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCardsGetCardsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DISABLED_AT", "order": "ASC"}
QueryCardsGetCardsWhereColumn
Description
Allowed column names for Query.cardsGetCards.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
QueryCardsGetCardsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query cardsGetCards.
Fields
| Input Field | Description |
|---|---|
column - QueryCardsGetCardsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCardsGetCardsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCardsGetCardsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCardsGetCardsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "CREATED_AT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryCardsGetCardsWhereWhereConditions],
"OR": [QueryCardsGetCardsWhereWhereConditions],
"HAS": QueryCardsGetCardsWhereWhereConditionsRelation
}
QueryCardsGetCardsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query cardsGetCards.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCardsGetCardsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryCardsGetCardsWhereWhereConditions
}
QueryCardsGetTemplatesOrderByColumn
Description
Allowed column names for Query.cardsGetTemplates.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISABLED_AT"
QueryCardsGetTemplatesOrderByOrderByClause
Description
Order by clause for Query.cardsGetTemplates.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCardsGetTemplatesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DISABLED_AT", "order": "ASC"}
QueryCardsGetTemplatesWhereColumn
Description
Allowed column names for Query.cardsGetTemplates.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
QueryCardsGetTemplatesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query cardsGetTemplates.
Fields
| Input Field | Description |
|---|---|
column - QueryCardsGetTemplatesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCardsGetTemplatesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCardsGetTemplatesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCardsGetTemplatesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "CREATED_AT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryCardsGetTemplatesWhereWhereConditions],
"OR": [QueryCardsGetTemplatesWhereWhereConditions],
"HAS": QueryCardsGetTemplatesWhereWhereConditionsRelation
}
QueryCardsGetTemplatesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query cardsGetTemplates.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCardsGetTemplatesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryCardsGetTemplatesWhereWhereConditions
}
QueryCardsOrderByColumn
Description
Allowed column names for Query.cards.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISABLED_AT"
QueryCardsOrderByOrderByClause
Description
Order by clause for Query.cards.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCardsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DISABLED_AT", "order": "ASC"}
QueryCardsWhereColumn
Description
Allowed column names for Query.cards.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
QueryCardsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query cards.
Fields
| Input Field | Description |
|---|---|
column - QueryCardsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCardsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCardsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCardsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "CREATED_AT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryCardsWhereWhereConditions],
"OR": [QueryCardsWhereWhereConditions],
"HAS": QueryCardsWhereWhereConditionsRelation
}
QueryCardsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query cards.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCardsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryCardsWhereWhereConditions
}
QueryCategoriesOrderByColumn
Description
Allowed column names for Query.categories.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryCategoriesOrderByOrderByClause
Description
Order by clause for Query.categories.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCategoriesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ID", "order": "ASC"}
QueryChargeLocationsGeoJsonHasEvsesCapabilitiesColumn
Description
Allowed column names for Query.chargeLocationsGeoJson.hasEvsesCapabilities.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"CAPABILITY"
QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions
Description
Dynamic WHERE conditions for the hasEvsesCapabilities argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeLocationsGeoJsonHasEvsesCapabilitiesColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "CAPABILITY",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions
],
"OR": [
QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions
],
"HAS": QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditionsRelation
}
QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasEvsesCapabilities argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryChargeLocationsGeoJsonHasEvsesCapabilitiesWhereHasConditions
}
QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions
Description
Dynamic WHERE conditions for the hasEvsesConnectors argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
column - EvseConnectorColumns
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TYPE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions
],
"OR": [
QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions
],
"HAS": QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditionsRelation
}
QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasEvsesConnectors argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryChargeLocationsGeoJsonHasEvsesConnectorsWhereHasConditions
}
QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions
Description
Dynamic WHERE conditions for the hasEvses argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
column - EvseColumns
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsGeoJsonHasEvsesWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "STATUS",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions
],
"OR": [
QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions
],
"HAS": QueryChargeLocationsGeoJsonHasEvsesWhereHasConditionsRelation
}
QueryChargeLocationsGeoJsonHasEvsesWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasEvses argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeLocationsGeoJsonHasEvsesWhereHasConditions
}
QueryChargeLocationsGeoJsonWhereHasColumn
Description
Allowed column names for Query.chargeLocationsGeoJson.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ID"
QueryChargeLocationsGeoJsonWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeLocationsGeoJsonWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsGeoJsonWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsGeoJsonWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsGeoJsonWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeLocationsGeoJsonWhereHasWhereHasConditions
],
"OR": [
QueryChargeLocationsGeoJsonWhereHasWhereHasConditions
],
"HAS": QueryChargeLocationsGeoJsonWhereHasWhereHasConditionsRelation
}
QueryChargeLocationsGeoJsonWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query chargeLocationsGeoJson.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsGeoJsonWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeLocationsGeoJsonWhereHasWhereHasConditions
}
QueryChargeLocationsHasEvsesConnectorsWhereHasConditions
Description
Dynamic WHERE conditions for the hasEvsesConnectors argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
column - EvseConnectorColumns
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsHasEvsesConnectorsWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsHasEvsesConnectorsWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsHasEvsesConnectorsWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TYPE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeLocationsHasEvsesConnectorsWhereHasConditions
],
"OR": [
QueryChargeLocationsHasEvsesConnectorsWhereHasConditions
],
"HAS": QueryChargeLocationsHasEvsesConnectorsWhereHasConditionsRelation
}
QueryChargeLocationsHasEvsesConnectorsWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasEvsesConnectors argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsHasEvsesConnectorsWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryChargeLocationsHasEvsesConnectorsWhereHasConditions
}
QueryChargeLocationsHasEvsesWhereHasConditions
Description
Dynamic WHERE conditions for the hasEvses argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
column - EvseColumns
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsHasEvsesWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsHasEvsesWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsHasEvsesWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "STATUS",
"operator": "EQ",
"value": Mixed,
"AND": [QueryChargeLocationsHasEvsesWhereHasConditions],
"OR": [QueryChargeLocationsHasEvsesWhereHasConditions],
"HAS": QueryChargeLocationsHasEvsesWhereHasConditionsRelation
}
QueryChargeLocationsHasEvsesWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasEvses argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsHasEvsesWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeLocationsHasEvsesWhereHasConditions
}
QueryChargeLocationsOrderByOrderByClause
Description
Order by clause for Query.chargeLocations.orderBy.
Fields
| Input Field | Description |
|---|---|
column - LocationOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryChargeLocationsWhereHasColumn
Description
Allowed column names for Query.chargeLocations.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ID"
QueryChargeLocationsWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeLocationsWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryChargeLocationsWhereHasWhereHasConditions],
"OR": [QueryChargeLocationsWhereHasWhereHasConditions],
"HAS": QueryChargeLocationsWhereHasWhereHasConditionsRelation
}
QueryChargeLocationsWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeLocationsWhereHasWhereHasConditions
}
QueryChargeLocationsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
column - LocationColumns
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeLocationsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeLocationsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeLocationsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryChargeLocationsWhereWhereConditions],
"OR": [QueryChargeLocationsWhereWhereConditions],
"HAS": QueryChargeLocationsWhereWhereConditionsRelation
}
QueryChargeLocationsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargeLocations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeLocationsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeLocationsWhereWhereConditions
}
QueryChargePointOperatorTransactionsWhereColumn
Description
Allowed column names for Query.chargePointOperatorTransactions.where.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"LAST_UPDATED"
QueryChargePointOperatorTransactionsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargePointOperatorTransactions.
Fields
| Input Field | Description |
|---|---|
column - QueryChargePointOperatorTransactionsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargePointOperatorTransactionsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargePointOperatorTransactionsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargePointOperatorTransactionsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "LAST_UPDATED",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargePointOperatorTransactionsWhereWhereConditions
],
"OR": [
QueryChargePointOperatorTransactionsWhereWhereConditions
],
"HAS": QueryChargePointOperatorTransactionsWhereWhereConditionsRelation
}
QueryChargePointOperatorTransactionsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargePointOperatorTransactions.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargePointOperatorTransactionsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryChargePointOperatorTransactionsWhereWhereConditions
}
QueryChargePointOperatorsWhereColumn
Description
Allowed column names for Query.chargePointOperators.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryChargePointOperatorsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargePointOperators.
Fields
| Input Field | Description |
|---|---|
column - QueryChargePointOperatorsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargePointOperatorsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargePointOperatorsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargePointOperatorsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryChargePointOperatorsWhereWhereConditions],
"OR": [QueryChargePointOperatorsWhereWhereConditions],
"HAS": QueryChargePointOperatorsWhereWhereConditionsRelation
}
QueryChargePointOperatorsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargePointOperators.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargePointOperatorsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryChargePointOperatorsWhereWhereConditions
}
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsOrderByColumn
Description
Allowed column names for Query.chargeRecordsMonthlyOrganizationalComponentStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsOrderByOrderByClause
Description
Order by clause for Query.chargeRecordsMonthlyOrganizationalComponentStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsMonthlyOrganizationalComponentStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereColumn
Description
Allowed column names for Query.chargeRecordsMonthlyOrganizationalComponentStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargeRecordsMonthlyOrganizationalComponentStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions
],
"OR": [
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions
],
"HAS": QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditionsRelation
}
QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargeRecordsMonthlyOrganizationalComponentStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeRecordsMonthlyOrganizationalComponentStatisticsWhereWhereConditions
}
QueryChargeRecordsOrderByColumn
Description
Allowed column names for Query.chargeRecords.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"USER_ID"
QueryChargeRecordsOrderByOrderByClause
Description
Order by clause for Query.chargeRecords.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "USER_ID", "order": "ASC"}
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsOrderByColumn
Description
Allowed column names for Query.chargeRecordsWeeklyOrganizationalComponentStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsOrderByOrderByClause
Description
Order by clause for Query.chargeRecordsWeeklyOrganizationalComponentStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsWeeklyOrganizationalComponentStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereColumn
Description
Allowed column names for Query.chargeRecordsWeeklyOrganizationalComponentStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargeRecordsWeeklyOrganizationalComponentStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions
],
"OR": [
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions
],
"HAS": QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditionsRelation
}
QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargeRecordsWeeklyOrganizationalComponentStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryChargeRecordsWeeklyOrganizationalComponentStatisticsWhereWhereConditions
}
QueryChargeRecordsWhereColumn
Description
Allowed column names for Query.chargeRecords.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"USER_ID"
QueryChargeRecordsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargeRecords.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeRecordsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeRecordsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeRecordsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "USER_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryChargeRecordsWhereWhereConditions],
"OR": [QueryChargeRecordsWhereWhereConditions],
"HAS": QueryChargeRecordsWhereWhereConditionsRelation
}
QueryChargeRecordsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargeRecords.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeRecordsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryChargeRecordsWhereWhereConditions
}
QueryChargeRecordsYearlyOrganizationalComponentStatisticsOrderByColumn
Description
Allowed column names for Query.chargeRecordsYearlyOrganizationalComponentStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryChargeRecordsYearlyOrganizationalComponentStatisticsOrderByOrderByClause
Description
Order by clause for Query.chargeRecordsYearlyOrganizationalComponentStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsYearlyOrganizationalComponentStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereColumn
Description
Allowed column names for Query.chargeRecordsYearlyOrganizationalComponentStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargeRecordsYearlyOrganizationalComponentStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions
],
"OR": [
QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions
],
"HAS": QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditionsRelation
}
QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargeRecordsYearlyOrganizationalComponentStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeRecordsYearlyOrganizationalComponentStatisticsWhereWhereConditions
}
QueryChargeTokensOrderByColumn
Description
Allowed column names for Query.chargeTokens.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VEHICLE_ID"
QueryChargeTokensOrderByOrderByClause
Description
Order by clause for Query.chargeTokens.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeTokensOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "VEHICLE_ID", "order": "ASC"}
QueryChargeTokensWhereColumn
Description
Allowed column names for Query.chargeTokens.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VEHICLE_ID"
QueryChargeTokensWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query chargeTokens.
Fields
| Input Field | Description |
|---|---|
column - QueryChargeTokensWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryChargeTokensWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryChargeTokensWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryChargeTokensWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "VEHICLE_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryChargeTokensWhereWhereConditions],
"OR": [QueryChargeTokensWhereWhereConditions],
"HAS": QueryChargeTokensWhereWhereConditionsRelation
}
QueryChargeTokensWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query chargeTokens.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryChargeTokensWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryChargeTokensWhereWhereConditions
}
QueryCompaniesDailyStatisticsOrderByColumn
Description
Allowed column names for Query.companiesDailyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DATE"
QueryCompaniesDailyStatisticsOrderByOrderByClause
Description
Order by clause for Query.companiesDailyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesDailyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DATE", "order": "ASC"}
QueryCompaniesDailyStatisticsWhereColumn
Description
Allowed column names for Query.companiesDailyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE"
QueryCompaniesDailyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companiesDailyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesDailyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesDailyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesDailyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesDailyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryCompaniesDailyStatisticsWhereWhereConditions
],
"OR": [
QueryCompaniesDailyStatisticsWhereWhereConditions
],
"HAS": QueryCompaniesDailyStatisticsWhereWhereConditionsRelation
}
QueryCompaniesDailyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companiesDailyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesDailyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryCompaniesDailyStatisticsWhereWhereConditions
}
QueryCompaniesGuaranteesOrderByColumn
Description
Allowed column names for Query.companiesGuarantees.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMOUNT"
QueryCompaniesGuaranteesOrderByOrderByClause
Description
Order by clause for Query.companiesGuarantees.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesGuaranteesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "AMOUNT", "order": "ASC"}
QueryCompaniesGuaranteesWhereColumn
Description
Allowed column names for Query.companiesGuarantees.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMOUNT"
QueryCompaniesGuaranteesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companiesGuarantees.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesGuaranteesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesGuaranteesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesGuaranteesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesGuaranteesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "AMOUNT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryCompaniesGuaranteesWhereWhereConditions],
"OR": [QueryCompaniesGuaranteesWhereWhereConditions],
"HAS": QueryCompaniesGuaranteesWhereWhereConditionsRelation
}
QueryCompaniesGuaranteesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companiesGuarantees.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesGuaranteesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryCompaniesGuaranteesWhereWhereConditions
}
QueryCompaniesInvoiceableOrganizationalComponentsOrderByColumn
Description
Allowed column names for Query.companiesInvoiceableOrganizationalComponents.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesInvoiceableOrganizationalComponentsOrderByOrderByClause
Description
Order by clause for Query.companiesInvoiceableOrganizationalComponents.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesInvoiceableOrganizationalComponentsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryCompaniesInvoiceableOrganizationalComponentsWhereColumn
Description
Allowed column names for Query.companiesInvoiceableOrganizationalComponents.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companiesInvoiceableOrganizationalComponents.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesInvoiceableOrganizationalComponentsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions
],
"OR": [
QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions
],
"HAS": QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditionsRelation
}
QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companiesInvoiceableOrganizationalComponents.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryCompaniesInvoiceableOrganizationalComponentsWhereWhereConditions
}
QueryCompaniesOrganizationalComponentTypesOrderByColumn
Description
Allowed column names for Query.companiesOrganizationalComponentTypes.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesOrganizationalComponentTypesOrderByOrderByClause
Description
Order by clause for Query.companiesOrganizationalComponentTypes.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesOrganizationalComponentTypesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryCompaniesOrganizationalComponentTypesWhereColumn
Description
Allowed column names for Query.companiesOrganizationalComponentTypes.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesOrganizationalComponentTypesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companiesOrganizationalComponentTypes.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesOrganizationalComponentTypesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesOrganizationalComponentTypesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesOrganizationalComponentTypesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesOrganizationalComponentTypesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryCompaniesOrganizationalComponentTypesWhereWhereConditions
],
"OR": [
QueryCompaniesOrganizationalComponentTypesWhereWhereConditions
],
"HAS": QueryCompaniesOrganizationalComponentTypesWhereWhereConditionsRelation
}
QueryCompaniesOrganizationalComponentTypesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companiesOrganizationalComponentTypes.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesOrganizationalComponentTypesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryCompaniesOrganizationalComponentTypesWhereWhereConditions
}
QueryCompaniesOrganizationalComponentsOrderByColumn
Description
Allowed column names for Query.companiesOrganizationalComponents.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesOrganizationalComponentsOrderByOrderByClause
Description
Order by clause for Query.companiesOrganizationalComponents.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesOrganizationalComponentsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryCompaniesOrganizationalComponentsWhereColumn
Description
Allowed column names for Query.companiesOrganizationalComponents.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesOrganizationalComponentsWhereHasColumn
Description
Allowed column names for Query.companiesOrganizationalComponents.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ID"
QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query companiesOrganizationalComponents.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesOrganizationalComponentsWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions
],
"OR": [
QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions
],
"HAS": QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditionsRelation
}
QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query companiesOrganizationalComponents.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryCompaniesOrganizationalComponentsWhereHasWhereHasConditions
}
QueryCompaniesOrganizationalComponentsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companiesOrganizationalComponents.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesOrganizationalComponentsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesOrganizationalComponentsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesOrganizationalComponentsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesOrganizationalComponentsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryCompaniesOrganizationalComponentsWhereWhereConditions
],
"OR": [
QueryCompaniesOrganizationalComponentsWhereWhereConditions
],
"HAS": QueryCompaniesOrganizationalComponentsWhereWhereConditionsRelation
}
QueryCompaniesOrganizationalComponentsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companiesOrganizationalComponents.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesOrganizationalComponentsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryCompaniesOrganizationalComponentsWhereWhereConditions
}
QueryCompaniesSegmentsOrderByColumn
Description
Allowed column names for Query.companiesSegments.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesSegmentsOrderByOrderByClause
Description
Order by clause for Query.companiesSegments.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesSegmentsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryCompaniesSegmentsWhereColumn
Description
Allowed column names for Query.companiesSegments.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompaniesSegmentsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companiesSegments.
Fields
| Input Field | Description |
|---|---|
column - QueryCompaniesSegmentsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompaniesSegmentsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompaniesSegmentsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompaniesSegmentsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryCompaniesSegmentsWhereWhereConditions],
"OR": [QueryCompaniesSegmentsWhereWhereConditions],
"HAS": QueryCompaniesSegmentsWhereWhereConditionsRelation
}
QueryCompaniesSegmentsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companiesSegments.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompaniesSegmentsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryCompaniesSegmentsWhereWhereConditions
}
QueryCompanySegmentsOrderByColumn
Description
Allowed column names for Query.companySegments.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompanySegmentsOrderByOrderByClause
Description
Order by clause for Query.companySegments.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryCompanySegmentsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryCompanySegmentsWhereColumn
Description
Allowed column names for Query.companySegments.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryCompanySegmentsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query companySegments.
Fields
| Input Field | Description |
|---|---|
column - QueryCompanySegmentsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryCompanySegmentsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryCompanySegmentsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryCompanySegmentsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryCompanySegmentsWhereWhereConditions],
"OR": [QueryCompanySegmentsWhereWhereConditions],
"HAS": QueryCompanySegmentsWhereWhereConditionsRelation
}
QueryCompanySegmentsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query companySegments.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryCompanySegmentsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryCompanySegmentsWhereWhereConditions
}
QueryDailyCardStatisticsOrderByColumn
Description
Allowed column names for Query.dailyCardStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DATE"
QueryDailyCardStatisticsOrderByOrderByClause
Description
Order by clause for Query.dailyCardStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyCardStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DATE", "order": "ASC"}
QueryDailyCardStatisticsWhereColumn
Description
Allowed column names for Query.dailyCardStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE"
QueryDailyCardStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query dailyCardStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyCardStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryDailyCardStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryDailyCardStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryDailyCardStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryDailyCardStatisticsWhereWhereConditions],
"OR": [QueryDailyCardStatisticsWhereWhereConditions],
"HAS": QueryDailyCardStatisticsWhereWhereConditionsRelation
}
QueryDailyCardStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query dailyCardStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryDailyCardStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryDailyCardStatisticsWhereWhereConditions
}
QueryDailyCompanyStatisticsOrderByColumn
Description
Allowed column names for Query.dailyCompanyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DATE"
QueryDailyCompanyStatisticsOrderByOrderByClause
Description
Order by clause for Query.dailyCompanyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyCompanyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DATE", "order": "ASC"}
QueryDailyCompanyStatisticsWhereColumn
Description
Allowed column names for Query.dailyCompanyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE"
QueryDailyCompanyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query dailyCompanyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyCompanyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryDailyCompanyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryDailyCompanyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryDailyCompanyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryDailyCompanyStatisticsWhereWhereConditions
],
"OR": [QueryDailyCompanyStatisticsWhereWhereConditions],
"HAS": QueryDailyCompanyStatisticsWhereWhereConditionsRelation
}
QueryDailyCompanyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query dailyCompanyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryDailyCompanyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryDailyCompanyStatisticsWhereWhereConditions
}
QueryDailyTransactionStatisticsOrderByColumn
Description
Allowed column names for Query.dailyTransactionStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TENANT_ID"
QueryDailyTransactionStatisticsOrderByOrderByClause
Description
Order by clause for Query.dailyTransactionStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyTransactionStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryDailyTransactionStatisticsWhereColumn
Description
Allowed column names for Query.dailyTransactionStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DATE"
QueryDailyTransactionStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query dailyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyTransactionStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryDailyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryDailyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryDailyTransactionStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryDailyTransactionStatisticsWhereWhereConditions
],
"OR": [
QueryDailyTransactionStatisticsWhereWhereConditions
],
"HAS": QueryDailyTransactionStatisticsWhereWhereConditionsRelation
}
QueryDailyTransactionStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query dailyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryDailyTransactionStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryDailyTransactionStatisticsWhereWhereConditions
}
QueryDailyUserStatisticsOrderByColumn
Description
Allowed column names for Query.dailyUserStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DATE"
QueryDailyUserStatisticsOrderByOrderByClause
Description
Order by clause for Query.dailyUserStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyUserStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DATE", "order": "ASC"}
QueryDailyUserStatisticsWhereColumn
Description
Allowed column names for Query.dailyUserStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE"
QueryDailyUserStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query dailyUserStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryDailyUserStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryDailyUserStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryDailyUserStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryDailyUserStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryDailyUserStatisticsWhereWhereConditions],
"OR": [QueryDailyUserStatisticsWhereWhereConditions],
"HAS": QueryDailyUserStatisticsWhereWhereConditionsRelation
}
QueryDailyUserStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query dailyUserStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryDailyUserStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryDailyUserStatisticsWhereWhereConditions
}
QueryExpenseReportsOrderByColumn
Description
Allowed column names for Query.expenseReports.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXPENSE_REPORT_NUMBER"
QueryExpenseReportsOrderByOrderByClause
Description
Order by clause for Query.expenseReports.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryExpenseReportsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "EXPENSE_REPORT_NUMBER", "order": "ASC"}
QueryExpenseReportsWhereColumn
Description
Allowed column names for Query.expenseReports.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXPENSE_REPORT_NUMBER"
QueryExpenseReportsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query expenseReports.
Fields
| Input Field | Description |
|---|---|
column - QueryExpenseReportsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryExpenseReportsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryExpenseReportsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryExpenseReportsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "EXPENSE_REPORT_NUMBER",
"operator": "EQ",
"value": Mixed,
"AND": [QueryExpenseReportsWhereWhereConditions],
"OR": [QueryExpenseReportsWhereWhereConditions],
"HAS": QueryExpenseReportsWhereWhereConditionsRelation
}
QueryExpenseReportsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query expenseReports.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryExpenseReportsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryExpenseReportsWhereWhereConditions
}
QueryExportsOrderByColumn
Description
Allowed column names for Query.exports.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryExportsOrderByOrderByClause
Description
Order by clause for Query.exports.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryExportsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryExportsWhereColumn
Description
Allowed column names for Query.exports.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryExportsWhereHasColumn
Description
Allowed column names for Query.exports.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ID"
QueryExportsWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query exports.
Fields
| Input Field | Description |
|---|---|
column - QueryExportsWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryExportsWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryExportsWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryExportsWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryExportsWhereHasWhereHasConditions],
"OR": [QueryExportsWhereHasWhereHasConditions],
"HAS": QueryExportsWhereHasWhereHasConditionsRelation
}
QueryExportsWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query exports.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryExportsWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryExportsWhereHasWhereHasConditions
}
QueryExportsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query exports.
Fields
| Input Field | Description |
|---|---|
column - QueryExportsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryExportsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryExportsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryExportsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryExportsWhereWhereConditions],
"OR": [QueryExportsWhereWhereConditions],
"HAS": QueryExportsWhereWhereConditionsRelation
}
QueryExportsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query exports.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryExportsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryExportsWhereWhereConditions
}
QueryFieldsOrderByColumn
Description
Allowed column names for Query.fields.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTITY_TYPE"
QueryFieldsOrderByOrderByClause
Description
Order by clause for Query.fields.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryFieldsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ENTITY_TYPE", "order": "ASC"}
QueryFuelCardsOrderByColumn
Description
Allowed column names for Query.fuelCards.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARD_NUMBER"
QueryFuelCardsOrderByOrderByClause
Description
Order by clause for Query.fuelCards.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "CARD_NUMBER", "order": "ASC"}
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsOrderByColumn
Description
Allowed column names for Query.fuelCardsOrganizationalComponentMonthlyTransactionStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsOrderByOrderByClause
Description
Order by clause for Query.fuelCardsOrganizationalComponentMonthlyTransactionStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereColumn
Description
Allowed column names for Query.fuelCardsOrganizationalComponentMonthlyTransactionStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query fuelCardsOrganizationalComponentMonthlyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions
],
"OR": [
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions
],
"HAS": QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditionsRelation
}
QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query fuelCardsOrganizationalComponentMonthlyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryFuelCardsOrganizationalComponentMonthlyTransactionStatisticsWhereWhereConditions
}
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsOrderByColumn
Description
Allowed column names for Query.fuelCardsOrganizationalComponentWeeklyTransactionStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsOrderByOrderByClause
Description
Order by clause for Query.fuelCardsOrganizationalComponentWeeklyTransactionStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereColumn
Description
Allowed column names for Query.fuelCardsOrganizationalComponentWeeklyTransactionStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query fuelCardsOrganizationalComponentWeeklyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions
],
"OR": [
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions
],
"HAS": QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditionsRelation
}
QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query fuelCardsOrganizationalComponentWeeklyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryFuelCardsOrganizationalComponentWeeklyTransactionStatisticsWhereWhereConditions
}
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsOrderByColumn
Description
Allowed column names for Query.fuelCardsOrganizationalComponentYearlyTransactionStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsOrderByOrderByClause
Description
Order by clause for Query.fuelCardsOrganizationalComponentYearlyTransactionStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereColumn
Description
Allowed column names for Query.fuelCardsOrganizationalComponentYearlyTransactionStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query fuelCardsOrganizationalComponentYearlyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions
],
"OR": [
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions
],
"HAS": QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditionsRelation
}
QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query fuelCardsOrganizationalComponentYearlyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryFuelCardsOrganizationalComponentYearlyTransactionStatisticsWhereWhereConditions
}
QueryFuelCardsWhereColumn
Description
Allowed column names for Query.fuelCards.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARD_NUMBER"
QueryFuelCardsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query fuelCards.
Fields
| Input Field | Description |
|---|---|
column - QueryFuelCardsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryFuelCardsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryFuelCardsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryFuelCardsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "CARD_NUMBER",
"operator": "EQ",
"value": Mixed,
"AND": [QueryFuelCardsWhereWhereConditions],
"OR": [QueryFuelCardsWhereWhereConditions],
"HAS": QueryFuelCardsWhereWhereConditionsRelation
}
QueryFuelCardsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query fuelCards.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryFuelCardsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryFuelCardsWhereWhereConditions
}
QueryGasStationsGetStationsOrderByColumn
Description
Allowed column names for Query.gasStationsGetStations.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryGasStationsGetStationsOrderByOrderByClause
Description
Order by clause for Query.gasStationsGetStations.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryGasStationsGetStationsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryGasStationsGetStationsWhereColumn
Description
Allowed column names for Query.gasStationsGetStations.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryGasStationsGetStationsWhereProductsColumn
Description
Allowed column names for Query.gasStationsGetStations.whereProducts.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ID"
QueryGasStationsGetStationsWhereProductsWhereHasConditions
Description
Dynamic WHERE conditions for the whereProducts argument of the query gasStationsGetStations.
Fields
| Input Field | Description |
|---|---|
column - QueryGasStationsGetStationsWhereProductsColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryGasStationsGetStationsWhereProductsWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryGasStationsGetStationsWhereProductsWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryGasStationsGetStationsWhereProductsWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryGasStationsGetStationsWhereProductsWhereHasConditions
],
"OR": [
QueryGasStationsGetStationsWhereProductsWhereHasConditions
],
"HAS": QueryGasStationsGetStationsWhereProductsWhereHasConditionsRelation
}
QueryGasStationsGetStationsWhereProductsWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereProducts argument of the query gasStationsGetStations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryGasStationsGetStationsWhereProductsWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryGasStationsGetStationsWhereProductsWhereHasConditions
}
QueryGasStationsGetStationsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query gasStationsGetStations.
Fields
| Input Field | Description |
|---|---|
column - QueryGasStationsGetStationsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryGasStationsGetStationsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryGasStationsGetStationsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryGasStationsGetStationsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryGasStationsGetStationsWhereWhereConditions
],
"OR": [QueryGasStationsGetStationsWhereWhereConditions],
"HAS": QueryGasStationsGetStationsWhereWhereConditionsRelation
}
QueryGasStationsGetStationsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query gasStationsGetStations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryGasStationsGetStationsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryGasStationsGetStationsWhereWhereConditions
}
QueryGasStationsOrderByColumn
Description
Allowed column names for Query.gasStations.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryGasStationsOrderByOrderByClause
Description
Order by clause for Query.gasStations.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryGasStationsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryGasStationsWhereColumn
Description
Allowed column names for Query.gasStations.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryGasStationsWhereProductsColumn
Description
Allowed column names for Query.gasStations.whereProducts.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ID"
QueryGasStationsWhereProductsWhereHasConditions
Description
Dynamic WHERE conditions for the whereProducts argument of the query gasStations.
Fields
| Input Field | Description |
|---|---|
column - QueryGasStationsWhereProductsColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryGasStationsWhereProductsWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryGasStationsWhereProductsWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryGasStationsWhereProductsWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryGasStationsWhereProductsWhereHasConditions
],
"OR": [QueryGasStationsWhereProductsWhereHasConditions],
"HAS": QueryGasStationsWhereProductsWhereHasConditionsRelation
}
QueryGasStationsWhereProductsWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereProducts argument of the query gasStations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryGasStationsWhereProductsWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryGasStationsWhereProductsWhereHasConditions
}
QueryGasStationsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query gasStations.
Fields
| Input Field | Description |
|---|---|
column - QueryGasStationsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryGasStationsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryGasStationsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryGasStationsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryGasStationsWhereWhereConditions],
"OR": [QueryGasStationsWhereWhereConditions],
"HAS": QueryGasStationsWhereWhereConditionsRelation
}
QueryGasStationsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query gasStations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryGasStationsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryGasStationsWhereWhereConditions
}
QueryGuaranteesOrderByColumn
Description
Allowed column names for Query.guarantees.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMOUNT"
QueryGuaranteesOrderByOrderByClause
Description
Order by clause for Query.guarantees.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryGuaranteesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "AMOUNT", "order": "ASC"}
QueryGuaranteesWhereColumn
Description
Allowed column names for Query.guarantees.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AMOUNT"
QueryGuaranteesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query guarantees.
Fields
| Input Field | Description |
|---|---|
column - QueryGuaranteesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryGuaranteesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryGuaranteesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryGuaranteesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "AMOUNT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryGuaranteesWhereWhereConditions],
"OR": [QueryGuaranteesWhereWhereConditions],
"HAS": QueryGuaranteesWhereWhereConditionsRelation
}
QueryGuaranteesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query guarantees.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryGuaranteesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryGuaranteesWhereWhereConditions
}
QueryInvoiceMonthlyStatisticWhereColumn
Description
Allowed column names for Query.invoiceMonthlyStatistic.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceMonthlyStatisticWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceMonthlyStatistic.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceMonthlyStatisticWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceMonthlyStatisticWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceMonthlyStatisticWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceMonthlyStatisticWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryInvoiceMonthlyStatisticWhereWhereConditions
],
"OR": [
QueryInvoiceMonthlyStatisticWhereWhereConditions
],
"HAS": QueryInvoiceMonthlyStatisticWhereWhereConditionsRelation
}
QueryInvoiceMonthlyStatisticWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceMonthlyStatistic.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceMonthlyStatisticWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoiceMonthlyStatisticWhereWhereConditions
}
QueryInvoiceMonthlyStatisticsOrderByColumn
Description
Allowed column names for Query.invoiceMonthlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceMonthlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.invoiceMonthlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceMonthlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryInvoiceMonthlyStatisticsWhereColumn
Description
Allowed column names for Query.invoiceMonthlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceMonthlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceMonthlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceMonthlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceMonthlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceMonthlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceMonthlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryInvoiceMonthlyStatisticsWhereWhereConditions
],
"OR": [
QueryInvoiceMonthlyStatisticsWhereWhereConditions
],
"HAS": QueryInvoiceMonthlyStatisticsWhereWhereConditionsRelation
}
QueryInvoiceMonthlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceMonthlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceMonthlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryInvoiceMonthlyStatisticsWhereWhereConditions
}
QueryInvoiceQuarterlyStatisticWhereColumn
Description
Allowed column names for Query.invoiceQuarterlyStatistic.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceQuarterlyStatisticWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceQuarterlyStatistic.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceQuarterlyStatisticWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceQuarterlyStatisticWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceQuarterlyStatisticWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceQuarterlyStatisticWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryInvoiceQuarterlyStatisticWhereWhereConditions
],
"OR": [
QueryInvoiceQuarterlyStatisticWhereWhereConditions
],
"HAS": QueryInvoiceQuarterlyStatisticWhereWhereConditionsRelation
}
QueryInvoiceQuarterlyStatisticWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceQuarterlyStatistic.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceQuarterlyStatisticWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoiceQuarterlyStatisticWhereWhereConditions
}
QueryInvoiceQuarterlyStatisticsOrderByColumn
Description
Allowed column names for Query.invoiceQuarterlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceQuarterlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.invoiceQuarterlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceQuarterlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryInvoiceQuarterlyStatisticsWhereColumn
Description
Allowed column names for Query.invoiceQuarterlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceQuarterlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceQuarterlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceQuarterlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceQuarterlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceQuarterlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceQuarterlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryInvoiceQuarterlyStatisticsWhereWhereConditions
],
"OR": [
QueryInvoiceQuarterlyStatisticsWhereWhereConditions
],
"HAS": QueryInvoiceQuarterlyStatisticsWhereWhereConditionsRelation
}
QueryInvoiceQuarterlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceQuarterlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceQuarterlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoiceQuarterlyStatisticsWhereWhereConditions
}
QueryInvoiceYearlyStatisticWhereColumn
Description
Allowed column names for Query.invoiceYearlyStatistic.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceYearlyStatisticWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceYearlyStatistic.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceYearlyStatisticWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceYearlyStatisticWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceYearlyStatisticWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceYearlyStatisticWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryInvoiceYearlyStatisticWhereWhereConditions
],
"OR": [QueryInvoiceYearlyStatisticWhereWhereConditions],
"HAS": QueryInvoiceYearlyStatisticWhereWhereConditionsRelation
}
QueryInvoiceYearlyStatisticWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceYearlyStatistic.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceYearlyStatisticWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoiceYearlyStatisticWhereWhereConditions
}
QueryInvoiceYearlyStatisticsOrderByColumn
Description
Allowed column names for Query.invoiceYearlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceYearlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.invoiceYearlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceYearlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryInvoiceYearlyStatisticsWhereColumn
Description
Allowed column names for Query.invoiceYearlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryInvoiceYearlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceYearlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceYearlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceYearlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceYearlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceYearlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryInvoiceYearlyStatisticsWhereWhereConditions
],
"OR": [
QueryInvoiceYearlyStatisticsWhereWhereConditions
],
"HAS": QueryInvoiceYearlyStatisticsWhereWhereConditionsRelation
}
QueryInvoiceYearlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceYearlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceYearlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryInvoiceYearlyStatisticsWhereWhereConditions
}
QueryInvoiceableCompaniesOrderByColumn
Description
Allowed column names for Query.invoiceableCompanies.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryInvoiceableCompaniesOrderByOrderByClause
Description
Order by clause for Query.invoiceableCompanies.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceableCompaniesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryInvoiceableCompaniesWhereColumn
Description
Allowed column names for Query.invoiceableCompanies.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryInvoiceableCompaniesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoiceableCompanies.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoiceableCompaniesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoiceableCompaniesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoiceableCompaniesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoiceableCompaniesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryInvoiceableCompaniesWhereWhereConditions],
"OR": [QueryInvoiceableCompaniesWhereWhereConditions],
"HAS": QueryInvoiceableCompaniesWhereWhereConditionsRelation
}
QueryInvoiceableCompaniesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoiceableCompanies.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoiceableCompaniesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoiceableCompaniesWhereWhereConditions
}
QueryInvoicesExportsOrderByColumn
Description
Allowed column names for Query.invoicesExports.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryInvoicesExportsOrderByOrderByClause
Description
Order by clause for Query.invoicesExports.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoicesExportsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryInvoicesExportsWhereColumn
Description
Allowed column names for Query.invoicesExports.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryInvoicesExportsWhereHasColumn
Description
Allowed column names for Query.invoicesExports.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ID"
QueryInvoicesExportsWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query invoicesExports.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoicesExportsWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoicesExportsWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoicesExportsWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoicesExportsWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryInvoicesExportsWhereHasWhereHasConditions],
"OR": [QueryInvoicesExportsWhereHasWhereHasConditions],
"HAS": QueryInvoicesExportsWhereHasWhereHasConditionsRelation
}
QueryInvoicesExportsWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query invoicesExports.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoicesExportsWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryInvoicesExportsWhereHasWhereHasConditions
}
QueryInvoicesExportsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoicesExports.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoicesExportsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoicesExportsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoicesExportsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoicesExportsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryInvoicesExportsWhereWhereConditions],
"OR": [QueryInvoicesExportsWhereWhereConditions],
"HAS": QueryInvoicesExportsWhereWhereConditionsRelation
}
QueryInvoicesExportsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoicesExports.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoicesExportsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoicesExportsWhereWhereConditions
}
QueryInvoicesOrderByColumn
Description
Allowed column names for Query.invoices.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INVOICE_NUMBER"
QueryInvoicesOrderByOrderByClause
Description
Order by clause for Query.invoices.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryInvoicesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "INVOICE_NUMBER", "order": "ASC"}
QueryInvoicesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query invoices.
Fields
| Input Field | Description |
|---|---|
column - InvoiceColumns
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryInvoicesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryInvoicesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryInvoicesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "INVOICE_DATE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryInvoicesWhereWhereConditions],
"OR": [QueryInvoicesWhereWhereConditions],
"HAS": QueryInvoicesWhereWhereConditionsRelation
}
QueryInvoicesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query invoices.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryInvoicesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryInvoicesWhereWhereConditions
}
QueryKilometreChargesOrderByColumn
Description
Allowed column names for Query.kilometreCharges.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXTERNAL_REFERENCE"
QueryKilometreChargesOrderByOrderByClause
Description
Order by clause for Query.kilometreCharges.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryKilometreChargesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "EXTERNAL_REFERENCE", "order": "ASC"}
QueryKilometreChargesWhereColumn
Description
Allowed column names for Query.kilometreCharges.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXTERNAL_REFERENCE"
QueryKilometreChargesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query kilometreCharges.
Fields
| Input Field | Description |
|---|---|
column - QueryKilometreChargesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryKilometreChargesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryKilometreChargesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryKilometreChargesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "EXTERNAL_REFERENCE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryKilometreChargesWhereWhereConditions],
"OR": [QueryKilometreChargesWhereWhereConditions],
"HAS": QueryKilometreChargesWhereWhereConditionsRelation
}
QueryKilometreChargesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query kilometreCharges.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryKilometreChargesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryKilometreChargesWhereWhereConditions
}
QueryKilometreChargingGetChargesOrderByColumn
Description
Allowed column names for Query.kilometreChargingGetCharges.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXTERNAL_REFERENCE"
QueryKilometreChargingGetChargesOrderByOrderByClause
Description
Order by clause for Query.kilometreChargingGetCharges.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryKilometreChargingGetChargesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "EXTERNAL_REFERENCE", "order": "ASC"}
QueryKilometreChargingGetChargesWhereColumn
Description
Allowed column names for Query.kilometreChargingGetCharges.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXTERNAL_REFERENCE"
QueryKilometreChargingGetChargesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query kilometreChargingGetCharges.
Fields
| Input Field | Description |
|---|---|
column - QueryKilometreChargingGetChargesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryKilometreChargingGetChargesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryKilometreChargingGetChargesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryKilometreChargingGetChargesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "EXTERNAL_REFERENCE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryKilometreChargingGetChargesWhereWhereConditions
],
"OR": [
QueryKilometreChargingGetChargesWhereWhereConditions
],
"HAS": QueryKilometreChargingGetChargesWhereWhereConditionsRelation
}
QueryKilometreChargingGetChargesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query kilometreChargingGetCharges.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryKilometreChargingGetChargesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryKilometreChargingGetChargesWhereWhereConditions
}
QueryMandateTemplatesWhereColumn
Description
Allowed column names for Query.mandateTemplates.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TYPE"
QueryMandateTemplatesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query mandateTemplates.
Fields
| Input Field | Description |
|---|---|
column - QueryMandateTemplatesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryMandateTemplatesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryMandateTemplatesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryMandateTemplatesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TYPE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryMandateTemplatesWhereWhereConditions],
"OR": [QueryMandateTemplatesWhereWhereConditions],
"HAS": QueryMandateTemplatesWhereWhereConditionsRelation
}
QueryMandateTemplatesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query mandateTemplates.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryMandateTemplatesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryMandateTemplatesWhereWhereConditions
}
QueryMandatesOrderByColumn
Description
Allowed column names for Query.mandates.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"USER_ID"
QueryMandatesOrderByOrderByClause
Description
Order by clause for Query.mandates.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryMandatesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "USER_ID", "order": "ASC"}
QueryMandatesWhereColumn
Description
Allowed column names for Query.mandates.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"USER_ID"
QueryMandatesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query mandates.
Fields
| Input Field | Description |
|---|---|
column - QueryMandatesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryMandatesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryMandatesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryMandatesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "USER_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryMandatesWhereWhereConditions],
"OR": [QueryMandatesWhereWhereConditions],
"HAS": QueryMandatesWhereWhereConditionsRelation
}
QueryMandatesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query mandates.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryMandatesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryMandatesWhereWhereConditions
}
QueryMetadataFieldsOrderByColumn
Description
Allowed column names for Query.metadataFields.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTITY_TYPE"
QueryMetadataFieldsOrderByOrderByClause
Description
Order by clause for Query.metadataFields.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryMetadataFieldsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ENTITY_TYPE", "order": "ASC"}
QueryMetadataGetMetadataOrderByColumn
Description
Allowed column names for Query.metadataGetMetadata.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTITY_TYPE"
QueryMetadataGetMetadataOrderByOrderByClause
Description
Order by clause for Query.metadataGetMetadata.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryMetadataGetMetadataOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ENTITY_TYPE", "order": "ASC"}
QueryMetadataGetMetadataWhereColumn
Description
Allowed column names for Query.metadataGetMetadata.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTITY_TYPE"
QueryMetadataGetMetadataWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query metadataGetMetadata.
Fields
| Input Field | Description |
|---|---|
column - QueryMetadataGetMetadataWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryMetadataGetMetadataWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryMetadataGetMetadataWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryMetadataGetMetadataWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ENTITY_TYPE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryMetadataGetMetadataWhereWhereConditions],
"OR": [QueryMetadataGetMetadataWhereWhereConditions],
"HAS": QueryMetadataGetMetadataWhereWhereConditionsRelation
}
QueryMetadataGetMetadataWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query metadataGetMetadata.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryMetadataGetMetadataWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryMetadataGetMetadataWhereWhereConditions
}
QueryMetadataOrderByColumn
Description
Allowed column names for Query.metadata.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTITY_TYPE"
QueryMetadataOrderByOrderByClause
Description
Order by clause for Query.metadata.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryMetadataOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ENTITY_TYPE", "order": "ASC"}
QueryMetadataWhereColumn
Description
Allowed column names for Query.metadata.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ENTITY_TYPE"
QueryMetadataWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query metadata.
Fields
| Input Field | Description |
|---|---|
column - QueryMetadataWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryMetadataWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryMetadataWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryMetadataWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ENTITY_TYPE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryMetadataWhereWhereConditions],
"OR": [QueryMetadataWhereWhereConditions],
"HAS": QueryMetadataWhereWhereConditionsRelation
}
QueryMetadataWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query metadata.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryMetadataWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryMetadataWhereWhereConditions
}
QueryOrdersGetOrdersOrderByColumn
Description
Allowed column names for Query.ordersGetOrders.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORDER_NUMBER"
QueryOrdersGetOrdersOrderByOrderByClause
Description
Order by clause for Query.ordersGetOrders.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrdersGetOrdersOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ORDER_NUMBER", "order": "ASC"}
QueryOrdersGetOrdersWhereColumn
Description
Allowed column names for Query.ordersGetOrders.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrdersGetOrdersWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query ordersGetOrders.
Fields
| Input Field | Description |
|---|---|
column - QueryOrdersGetOrdersWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrdersGetOrdersWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrdersGetOrdersWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrdersGetOrdersWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryOrdersGetOrdersWhereWhereConditions],
"OR": [QueryOrdersGetOrdersWhereWhereConditions],
"HAS": QueryOrdersGetOrdersWhereWhereConditionsRelation
}
QueryOrdersGetOrdersWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query ordersGetOrders.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrdersGetOrdersWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryOrdersGetOrdersWhereWhereConditions
}
QueryOrdersOrderByColumn
Description
Allowed column names for Query.orders.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ORDER_NUMBER"
QueryOrdersOrderByOrderByClause
Description
Order by clause for Query.orders.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrdersOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ORDER_NUMBER", "order": "ASC"}
QueryOrdersWhereColumn
Description
Allowed column names for Query.orders.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrdersWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query orders.
Fields
| Input Field | Description |
|---|---|
column - QueryOrdersWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrdersWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrdersWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrdersWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryOrdersWhereWhereConditions],
"OR": [QueryOrdersWhereWhereConditions],
"HAS": QueryOrdersWhereWhereConditionsRelation
}
QueryOrdersWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query orders.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrdersWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryOrdersWhereWhereConditions
}
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsOrderByColumn
Description
Allowed column names for Query.organizationalComponentChargeRecordsMonthlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentChargeRecordsMonthlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentChargeRecordsMonthlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereColumn
Description
Allowed column names for Query.organizationalComponentChargeRecordsMonthlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentChargeRecordsMonthlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditionsRelation
}
QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentChargeRecordsMonthlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryOrganizationalComponentChargeRecordsMonthlyStatisticsWhereWhereConditions
}
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsOrderByColumn
Description
Allowed column names for Query.organizationalComponentChargeRecordsWeeklyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentChargeRecordsWeeklyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentChargeRecordsWeeklyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereColumn
Description
Allowed column names for Query.organizationalComponentChargeRecordsWeeklyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentChargeRecordsWeeklyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditionsRelation
}
QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentChargeRecordsWeeklyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryOrganizationalComponentChargeRecordsWeeklyStatisticsWhereWhereConditions
}
QueryOrganizationalComponentChargeRecordsYearlyStatisticsOrderByColumn
Description
Allowed column names for Query.organizationalComponentChargeRecordsYearlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentChargeRecordsYearlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentChargeRecordsYearlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentChargeRecordsYearlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereColumn
Description
Allowed column names for Query.organizationalComponentChargeRecordsYearlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentChargeRecordsYearlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditionsRelation
}
QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentChargeRecordsYearlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryOrganizationalComponentChargeRecordsYearlyStatisticsWhereWhereConditions
}
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsOrderByColumn
Description
Allowed column names for Query.organizationalComponentFuelTransactionsMonthlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentFuelTransactionsMonthlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereColumn
Description
Allowed column names for Query.organizationalComponentFuelTransactionsMonthlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentFuelTransactionsMonthlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditionsRelation
}
QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentFuelTransactionsMonthlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryOrganizationalComponentFuelTransactionsMonthlyStatisticsWhereWhereConditions
}
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsOrderByColumn
Description
Allowed column names for Query.organizationalComponentFuelTransactionsWeeklyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentFuelTransactionsWeeklyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereColumn
Description
Allowed column names for Query.organizationalComponentFuelTransactionsWeeklyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentFuelTransactionsWeeklyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditionsRelation
}
QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentFuelTransactionsWeeklyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryOrganizationalComponentFuelTransactionsWeeklyStatisticsWhereWhereConditions
}
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsOrderByColumn
Description
Allowed column names for Query.organizationalComponentFuelTransactionsYearlyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentFuelTransactionsYearlyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentFuelTransactionsYearlyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "COMPANY_ID", "order": "ASC"}
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereColumn
Description
Allowed column names for Query.organizationalComponentFuelTransactionsYearlyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMPANY_ID"
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentFuelTransactionsYearlyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditionsRelation
}
QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentFuelTransactionsYearlyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryOrganizationalComponentFuelTransactionsYearlyStatisticsWhereWhereConditions
}
QueryOrganizationalComponentTypesOrderByColumn
Description
Allowed column names for Query.organizationalComponentTypes.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryOrganizationalComponentTypesOrderByOrderByClause
Description
Order by clause for Query.organizationalComponentTypes.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentTypesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryOrganizationalComponentTypesWhereColumn
Description
Allowed column names for Query.organizationalComponentTypes.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryOrganizationalComponentTypesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponentTypes.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentTypesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentTypesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentTypesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentTypesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentTypesWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentTypesWhereWhereConditions
],
"HAS": QueryOrganizationalComponentTypesWhereWhereConditionsRelation
}
QueryOrganizationalComponentTypesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponentTypes.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentTypesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryOrganizationalComponentTypesWhereWhereConditions
}
QueryOrganizationalComponentsOrderByColumn
Description
Allowed column names for Query.organizationalComponents.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryOrganizationalComponentsOrderByOrderByClause
Description
Order by clause for Query.organizationalComponents.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryOrganizationalComponentsWhereColumn
Description
Allowed column names for Query.organizationalComponents.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryOrganizationalComponentsWhereHasColumn
Description
Allowed column names for Query.organizationalComponents.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ID"
QueryOrganizationalComponentsWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query organizationalComponents.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentsWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentsWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentsWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentsWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentsWhereHasWhereHasConditions
],
"OR": [
QueryOrganizationalComponentsWhereHasWhereHasConditions
],
"HAS": QueryOrganizationalComponentsWhereHasWhereHasConditionsRelation
}
QueryOrganizationalComponentsWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query organizationalComponents.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentsWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryOrganizationalComponentsWhereHasWhereHasConditions
}
QueryOrganizationalComponentsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query organizationalComponents.
Fields
| Input Field | Description |
|---|---|
column - QueryOrganizationalComponentsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryOrganizationalComponentsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryOrganizationalComponentsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryOrganizationalComponentsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryOrganizationalComponentsWhereWhereConditions
],
"OR": [
QueryOrganizationalComponentsWhereWhereConditions
],
"HAS": QueryOrganizationalComponentsWhereWhereConditionsRelation
}
QueryOrganizationalComponentsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query organizationalComponents.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryOrganizationalComponentsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryOrganizationalComponentsWhereWhereConditions
}
QueryPackagesOrderByColumn
Description
Allowed column names for Query.packages.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryPackagesOrderByOrderByClause
Description
Order by clause for Query.packages.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryPackagesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryParkingLocationsOrderByColumn
Description
Allowed column names for Query.parkingLocations.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PROVIDER_ID"
QueryParkingLocationsOrderByOrderByClause
Description
Order by clause for Query.parkingLocations.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryParkingLocationsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "PROVIDER_ID", "order": "ASC"}
QueryParkingLocationsWhereColumn
Description
Allowed column names for Query.parkingLocations.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXTERNAL_ID"
QueryParkingLocationsWhereHasColumn
Description
Allowed column names for Query.parkingLocations.whereHas.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"POSTAL_CODE"
QueryParkingLocationsWhereHasWhereHasConditions
Description
Dynamic WHERE conditions for the whereHas argument of the query parkingLocations.
Fields
| Input Field | Description |
|---|---|
column - QueryParkingLocationsWhereHasColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryParkingLocationsWhereHasWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryParkingLocationsWhereHasWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryParkingLocationsWhereHasWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "POSTAL_CODE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryParkingLocationsWhereHasWhereHasConditions
],
"OR": [QueryParkingLocationsWhereHasWhereHasConditions],
"HAS": QueryParkingLocationsWhereHasWhereHasConditionsRelation
}
QueryParkingLocationsWhereHasWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the whereHas argument of the query parkingLocations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryParkingLocationsWhereHasWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryParkingLocationsWhereHasWhereHasConditions
}
QueryParkingLocationsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query parkingLocations.
Fields
| Input Field | Description |
|---|---|
column - QueryParkingLocationsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryParkingLocationsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryParkingLocationsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryParkingLocationsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "EXTERNAL_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryParkingLocationsWhereWhereConditions],
"OR": [QueryParkingLocationsWhereWhereConditions],
"HAS": QueryParkingLocationsWhereWhereConditionsRelation
}
QueryParkingLocationsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query parkingLocations.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryParkingLocationsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryParkingLocationsWhereWhereConditions
}
QueryParkingSessionsOrderByColumn
Description
Allowed column names for Query.parkingSessions.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"STARTED_AT"
QueryParkingSessionsOrderByOrderByClause
Description
Order by clause for Query.parkingSessions.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryParkingSessionsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "STARTED_AT", "order": "ASC"}
QueryParkingSessionsWhereColumn
Description
Allowed column names for Query.parkingSessions.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STARTED_AT"
QueryParkingSessionsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query parkingSessions.
Fields
| Input Field | Description |
|---|---|
column - QueryParkingSessionsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryParkingSessionsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryParkingSessionsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryParkingSessionsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "STARTED_AT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryParkingSessionsWhereWhereConditions],
"OR": [QueryParkingSessionsWhereWhereConditions],
"HAS": QueryParkingSessionsWhereWhereConditionsRelation
}
QueryParkingSessionsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query parkingSessions.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryParkingSessionsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryParkingSessionsWhereWhereConditions
}
QueryPaymentsMandateTemplatesWhereColumn
Description
Allowed column names for Query.paymentsMandateTemplates.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TYPE"
QueryPaymentsMandateTemplatesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query paymentsMandateTemplates.
Fields
| Input Field | Description |
|---|---|
column - QueryPaymentsMandateTemplatesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryPaymentsMandateTemplatesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryPaymentsMandateTemplatesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryPaymentsMandateTemplatesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TYPE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryPaymentsMandateTemplatesWhereWhereConditions
],
"OR": [
QueryPaymentsMandateTemplatesWhereWhereConditions
],
"HAS": QueryPaymentsMandateTemplatesWhereWhereConditionsRelation
}
QueryPaymentsMandateTemplatesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query paymentsMandateTemplates.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryPaymentsMandateTemplatesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryPaymentsMandateTemplatesWhereWhereConditions
}
QueryPaymentsMandatesOrderByColumn
Description
Allowed column names for Query.paymentsMandates.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"USER_ID"
QueryPaymentsMandatesOrderByOrderByClause
Description
Order by clause for Query.paymentsMandates.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryPaymentsMandatesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "USER_ID", "order": "ASC"}
QueryPaymentsMandatesWhereColumn
Description
Allowed column names for Query.paymentsMandates.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"USER_ID"
QueryPaymentsMandatesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query paymentsMandates.
Fields
| Input Field | Description |
|---|---|
column - QueryPaymentsMandatesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryPaymentsMandatesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryPaymentsMandatesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryPaymentsMandatesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "USER_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryPaymentsMandatesWhereWhereConditions],
"OR": [QueryPaymentsMandatesWhereWhereConditions],
"HAS": QueryPaymentsMandatesWhereWhereConditionsRelation
}
QueryPaymentsMandatesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query paymentsMandates.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryPaymentsMandatesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryPaymentsMandatesWhereWhereConditions
}
QueryPaymentsSepaFilesOrderByColumn
Description
Allowed column names for Query.paymentsSepaFiles.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryPaymentsSepaFilesOrderByOrderByClause
Description
Order by clause for Query.paymentsSepaFiles.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryPaymentsSepaFilesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QueryPaymentsSepaFilesWhereColumn
Description
Allowed column names for Query.paymentsSepaFiles.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NAME"
QueryPaymentsSepaFilesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query paymentsSepaFiles.
Fields
| Input Field | Description |
|---|---|
column - QueryPaymentsSepaFilesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryPaymentsSepaFilesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryPaymentsSepaFilesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryPaymentsSepaFilesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryPaymentsSepaFilesWhereWhereConditions],
"OR": [QueryPaymentsSepaFilesWhereWhereConditions],
"HAS": QueryPaymentsSepaFilesWhereWhereConditionsRelation
}
QueryPaymentsSepaFilesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query paymentsSepaFiles.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryPaymentsSepaFilesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryPaymentsSepaFilesWhereWhereConditions
}
QueryPriceModificationsOrderByColumn
Description
Allowed column names for Query.priceModifications.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"START_DATE"
QueryPriceModificationsOrderByOrderByClause
Description
Order by clause for Query.priceModifications.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryPriceModificationsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "START_DATE", "order": "ASC"}
QueryPriceModificationsWhereColumn
Description
Allowed column names for Query.priceModifications.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DESCRIPTION"
QueryPriceModificationsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query priceModifications.
Fields
| Input Field | Description |
|---|---|
column - QueryPriceModificationsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryPriceModificationsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryPriceModificationsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryPriceModificationsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DESCRIPTION",
"operator": "EQ",
"value": Mixed,
"AND": [QueryPriceModificationsWhereWhereConditions],
"OR": [QueryPriceModificationsWhereWhereConditions],
"HAS": QueryPriceModificationsWhereWhereConditionsRelation
}
QueryPriceModificationsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query priceModifications.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryPriceModificationsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryPriceModificationsWhereWhereConditions
}
QueryProductsCategoriesOrderByColumn
Description
Allowed column names for Query.productsCategories.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryProductsCategoriesOrderByOrderByClause
Description
Order by clause for Query.productsCategories.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryProductsCategoriesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ID", "order": "ASC"}
QueryProductsGetProductsOrderByColumn
Description
Allowed column names for Query.productsGetProducts.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryProductsGetProductsOrderByOrderByClause
Description
Order by clause for Query.productsGetProducts.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryProductsGetProductsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ID", "order": "ASC"}
QueryProductsOrderByColumn
Description
Allowed column names for Query.products.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryProductsOrderByOrderByClause
Description
Order by clause for Query.products.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryProductsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ID", "order": "ASC"}
QueryProductsPackagesOrderByColumn
Description
Allowed column names for Query.productsPackages.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryProductsPackagesOrderByOrderByClause
Description
Order by clause for Query.productsPackages.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryProductsPackagesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QuerySepaFilesOrderByColumn
Description
Allowed column names for Query.sepaFiles.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QuerySepaFilesOrderByOrderByClause
Description
Order by clause for Query.sepaFiles.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QuerySepaFilesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "NAME", "order": "ASC"}
QuerySepaFilesWhereColumn
Description
Allowed column names for Query.sepaFiles.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NAME"
QuerySepaFilesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query sepaFiles.
Fields
| Input Field | Description |
|---|---|
column - QuerySepaFilesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QuerySepaFilesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QuerySepaFilesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QuerySepaFilesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QuerySepaFilesWhereWhereConditions],
"OR": [QuerySepaFilesWhereWhereConditions],
"HAS": QuerySepaFilesWhereWhereConditionsRelation
}
QuerySepaFilesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query sepaFiles.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QuerySepaFilesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QuerySepaFilesWhereWhereConditions
}
QueryTemplatesOrderByColumn
Description
Allowed column names for Query.templates.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DISABLED_AT"
QueryTemplatesOrderByOrderByClause
Description
Order by clause for Query.templates.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryTemplatesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DISABLED_AT", "order": "ASC"}
QueryTemplatesWhereColumn
Description
Allowed column names for Query.templates.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
QueryTemplatesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query templates.
Fields
| Input Field | Description |
|---|---|
column - QueryTemplatesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryTemplatesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryTemplatesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryTemplatesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "CREATED_AT",
"operator": "EQ",
"value": Mixed,
"AND": [QueryTemplatesWhereWhereConditions],
"OR": [QueryTemplatesWhereWhereConditions],
"HAS": QueryTemplatesWhereWhereConditionsRelation
}
QueryTemplatesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query templates.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryTemplatesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryTemplatesWhereWhereConditions
}
QueryTenantTermsAndConditionsOrderByColumn
Description
Allowed column names for Query.tenantTermsAndConditions.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryTenantTermsAndConditionsOrderByOrderByClause
Description
Order by clause for Query.tenantTermsAndConditions.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryTenantTermsAndConditionsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryTenantTermsAndConditionsWhereColumn
Description
Allowed column names for Query.tenantTermsAndConditions.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryTenantTermsAndConditionsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query tenantTermsAndConditions.
Fields
| Input Field | Description |
|---|---|
column - QueryTenantTermsAndConditionsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryTenantTermsAndConditionsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryTenantTermsAndConditionsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryTenantTermsAndConditionsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryTenantTermsAndConditionsWhereWhereConditions
],
"OR": [
QueryTenantTermsAndConditionsWhereWhereConditions
],
"HAS": QueryTenantTermsAndConditionsWhereWhereConditionsRelation
}
QueryTenantTermsAndConditionsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query tenantTermsAndConditions.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryTenantTermsAndConditionsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryTenantTermsAndConditionsWhereWhereConditions
}
QueryTenantsOrderByColumn
Description
Allowed column names for Query.tenants.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ID"
QueryTenantsOrderByOrderByClause
Description
Order by clause for Query.tenants.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryTenantsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "ID", "order": "ASC"}
QueryTermsAndConditionsOrderByColumn
Description
Allowed column names for Query.termsAndConditions.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryTermsAndConditionsOrderByOrderByClause
Description
Order by clause for Query.termsAndConditions.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryTermsAndConditionsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryTermsAndConditionsWhereColumn
Description
Allowed column names for Query.termsAndConditions.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TENANT_ID"
QueryTermsAndConditionsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query termsAndConditions.
Fields
| Input Field | Description |
|---|---|
column - QueryTermsAndConditionsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryTermsAndConditionsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryTermsAndConditionsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryTermsAndConditionsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TENANT_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryTermsAndConditionsWhereWhereConditions],
"OR": [QueryTermsAndConditionsWhereWhereConditions],
"HAS": QueryTermsAndConditionsWhereWhereConditionsRelation
}
QueryTermsAndConditionsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query termsAndConditions.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryTermsAndConditionsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 123,
"condition": QueryTermsAndConditionsWhereWhereConditions
}
QueryTransactionDailyTransactionStatisticsOrderByColumn
Description
Allowed column names for Query.transactionDailyTransactionStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"TENANT_ID"
QueryTransactionDailyTransactionStatisticsOrderByOrderByClause
Description
Order by clause for Query.transactionDailyTransactionStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryTransactionDailyTransactionStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "TENANT_ID", "order": "ASC"}
QueryTransactionDailyTransactionStatisticsWhereColumn
Description
Allowed column names for Query.transactionDailyTransactionStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DATE"
QueryTransactionDailyTransactionStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query transactionDailyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryTransactionDailyTransactionStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryTransactionDailyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryTransactionDailyTransactionStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryTransactionDailyTransactionStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [
QueryTransactionDailyTransactionStatisticsWhereWhereConditions
],
"OR": [
QueryTransactionDailyTransactionStatisticsWhereWhereConditions
],
"HAS": QueryTransactionDailyTransactionStatisticsWhereWhereConditionsRelation
}
QueryTransactionDailyTransactionStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query transactionDailyTransactionStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryTransactionDailyTransactionStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryTransactionDailyTransactionStatisticsWhereWhereConditions
}
QueryTransactionsHasMorphColumn
Description
Allowed column names for Query.transactions.hasMorph.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryTransactionsHasMorphWhereHasConditions
Description
Dynamic WHERE conditions for the hasMorph argument of the query transactions.
Fields
| Input Field | Description |
|---|---|
column - QueryTransactionsHasMorphColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryTransactionsHasMorphWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryTransactionsHasMorphWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryTransactionsHasMorphWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryTransactionsHasMorphWhereHasConditions],
"OR": [QueryTransactionsHasMorphWhereHasConditions],
"HAS": QueryTransactionsHasMorphWhereHasConditionsRelation
}
QueryTransactionsHasMorphWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasMorph argument of the query transactions.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryTransactionsHasMorphWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryTransactionsHasMorphWhereHasConditions
}
QueryTransactionsOrderByColumn
Description
Allowed column names for Query.transactions.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
QueryTransactionsOrderByOrderByClause
Description
Order by clause for Query.transactions.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryTransactionsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "CREATED_AT", "order": "ASC"}
QueryTransactionsWhereColumn
Description
Allowed column names for Query.transactions.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TRANSACTION_ID"
QueryTransactionsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query transactions.
Fields
| Input Field | Description |
|---|---|
column - QueryTransactionsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryTransactionsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryTransactionsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryTransactionsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "TRANSACTION_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryTransactionsWhereWhereConditions],
"OR": [QueryTransactionsWhereWhereConditions],
"HAS": QueryTransactionsWhereWhereConditionsRelation
}
QueryTransactionsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query transactions.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryTransactionsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryTransactionsWhereWhereConditions
}
QueryUserDailyStatisticsOrderByColumn
Description
Allowed column names for Query.userDailyStatistics.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"DATE"
QueryUserDailyStatisticsOrderByOrderByClause
Description
Order by clause for Query.userDailyStatistics.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryUserDailyStatisticsOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "DATE", "order": "ASC"}
QueryUserDailyStatisticsWhereColumn
Description
Allowed column names for Query.userDailyStatistics.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DATE"
QueryUserDailyStatisticsWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query userDailyStatistics.
Fields
| Input Field | Description |
|---|---|
column - QueryUserDailyStatisticsWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryUserDailyStatisticsWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryUserDailyStatisticsWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryUserDailyStatisticsWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "DATE",
"operator": "EQ",
"value": Mixed,
"AND": [QueryUserDailyStatisticsWhereWhereConditions],
"OR": [QueryUserDailyStatisticsWhereWhereConditions],
"HAS": QueryUserDailyStatisticsWhereWhereConditionsRelation
}
QueryUserDailyStatisticsWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query userDailyStatistics.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryUserDailyStatisticsWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 987,
"condition": QueryUserDailyStatisticsWhereWhereConditions
}
QueryUsersHasCompaniesColumn
Description
Allowed column names for Query.users.hasCompanies.
Values
| Enum Value | Description |
|---|---|
|
|
Example
"ID"
QueryUsersHasCompaniesWhereHasConditions
Description
Dynamic WHERE conditions for the hasCompanies argument of the query users.
Fields
| Input Field | Description |
|---|---|
column - QueryUsersHasCompaniesColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryUsersHasCompaniesWhereHasConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryUsersHasCompaniesWhereHasConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryUsersHasCompaniesWhereHasConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryUsersHasCompaniesWhereHasConditions],
"OR": [QueryUsersHasCompaniesWhereHasConditions],
"HAS": QueryUsersHasCompaniesWhereHasConditionsRelation
}
QueryUsersHasCompaniesWhereHasConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the hasCompanies argument of the query users.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryUsersHasCompaniesWhereHasConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryUsersHasCompaniesWhereHasConditions
}
QueryUsersOrderByColumn
Description
Allowed column names for Query.users.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIRST_NAME"
QueryUsersOrderByOrderByClause
Description
Order by clause for Query.users.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryUsersOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "FIRST_NAME", "order": "ASC"}
QueryUsersWhereColumn
Description
Allowed column names for Query.users.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIRST_NAME"
QueryUsersWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query users.
Fields
| Input Field | Description |
|---|---|
column - QueryUsersWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryUsersWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryUsersWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryUsersWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "FIRST_NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryUsersWhereWhereConditions],
"OR": [QueryUsersWhereWhereConditions],
"HAS": QueryUsersWhereWhereConditionsRelation
}
QueryUsersWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query users.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryUsersWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryUsersWhereWhereConditions
}
QueryVehiclesOrderByColumn
Description
Allowed column names for Query.vehicles.orderBy.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"LICENSE_PLATE"
QueryVehiclesOrderByOrderByClause
Description
Order by clause for Query.vehicles.orderBy.
Fields
| Input Field | Description |
|---|---|
column - QueryVehiclesOrderByColumn!
|
The column that is used for ordering. |
order - SortOrder!
|
The direction that is used for ordering. |
Example
{"column": "LICENSE_PLATE", "order": "ASC"}
QueryVehiclesWhereColumn
Description
Allowed column names for Query.vehicles.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_ID"
QueryVehiclesWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query vehicles.
Fields
| Input Field | Description |
|---|---|
column - QueryVehiclesWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryVehiclesWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryVehiclesWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryVehiclesWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "COMPANY_ID",
"operator": "EQ",
"value": Mixed,
"AND": [QueryVehiclesWhereWhereConditions],
"OR": [QueryVehiclesWhereWhereConditions],
"HAS": QueryVehiclesWhereWhereConditionsRelation
}
QueryVehiclesWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query vehicles.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryVehiclesWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "abc123",
"operator": "EQ",
"amount": 987,
"condition": QueryVehiclesWhereWhereConditions
}
QueryWebhooksWhereColumn
Description
Allowed column names for Query.webhooks.where.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NAME"
QueryWebhooksWhereWhereConditions
Description
Dynamic WHERE conditions for the where argument of the query webhooks.
Fields
| Input Field | Description |
|---|---|
column - QueryWebhooksWhereColumn
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [QueryWebhooksWhereWhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [QueryWebhooksWhereWhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - QueryWebhooksWhereWhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "NAME",
"operator": "EQ",
"value": Mixed,
"AND": [QueryWebhooksWhereWhereConditions],
"OR": [QueryWebhooksWhereWhereConditions],
"HAS": QueryWebhooksWhereWhereConditionsRelation
}
QueryWebhooksWhereWhereConditionsRelation
Description
Dynamic HAS conditions for WHERE conditions for the where argument of the query webhooks.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - QueryWebhooksWhereWhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": QueryWebhooksWhereWhereConditions
}
RemoveFavoriteInput
Fields
| Input Field | Description |
|---|---|
locationId - UUID!
|
Location id |
serviceType - FavoriteServiceType!
|
Location type |
Example
{
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"serviceType": "CHARGING"
}
RemoveProductFromCategoryInput
Fields
| Input Field | Description |
|---|---|
productId - UUID!
|
Product id. Verify its existence in the products model. |
Example
{
"productId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
RemoveTokenizedCardFromCompanyInput
RemoveUserFromOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
userId - UUID!
|
Employee to remove as employee from the organizational component |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Requirement
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
type - RequirementType!
|
Type of requirement. See RequirementType enum for possible values. |
createdAt - DateTime
|
Date time when the requirement was created. |
updatedAt - DateTime
|
Date time when the requirement was last updated. |
completedBy - User
|
User who completed the requirement. |
completedAt - DateTime
|
Date time when the requirement was completed. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "CREDIT_CHECK",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"completedBy": User,
"completedAt": "2007-12-03T10:15:30Z"
}
RequirementType
Values
| Enum Value | Description |
|---|---|
|
|
Organizational component requires a credit check |
|
|
Organizational component requires a contract to be signed |
|
|
Organizational component requires payment details |
Example
"CREDIT_CHECK"
Role
Fields
| Field Name | Description |
|---|---|
id - String!
|
The role identifier |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
RoleEnum
Description
Available roles
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ROLE_SUPER_ADMIN"
SQLOperator
Description
The available SQL operators that are used to filter query results.
Values
| Enum Value | Description |
|---|---|
|
|
Equal operator (=) |
|
|
Not equal operator (!=) |
|
|
Greater than operator (>) |
|
|
Greater than or equal operator (>=) |
|
|
Less than operator (<) |
|
|
Less than or equal operator (<=) |
|
|
Simple pattern matching (LIKE) |
|
|
Negation of simple pattern matching (NOT LIKE) |
|
|
Whether a value is within a set of values (IN) |
|
|
Whether a value is not within a set of values (NOT IN) |
|
|
Whether a value is within a range of values (BETWEEN) |
|
|
Whether a value is not within a range of values (NOT BETWEEN) |
|
|
Whether a value is null (IS NULL) |
|
|
Whether a value is not null (IS NOT NULL) |
Example
"EQ"
SearchBoxInput
Description
Use to create a bounding box to search for charge locations
Fields
| Input Field | Description |
|---|---|
topLeft - AddressCoordinates!
|
Top left coordinates of the bounding box |
topRight - AddressCoordinates!
|
Top right coordinates of the bounding box |
bottomRight - AddressCoordinates!
|
Bottom right coordinates of the bounding box |
bottomLeft - AddressCoordinates!
|
Bottom left coordinates of the bounding box |
Example
{
"topLeft": AddressCoordinates,
"topRight": AddressCoordinates,
"bottomRight": AddressCoordinates,
"bottomLeft": AddressCoordinates
}
SearchCompanyAddress
Fields
| Field Name | Description |
|---|---|
country - Country!
|
Country of the address. |
street - String
|
Street of the address. |
houseNumber - String
|
House number of the address. |
houseNumberAddition - String
|
House number addition of the address. |
postalCode - String
|
Postal code of the address. |
city - String
|
City of the address. |
Example
{
"country": "AL",
"street": "abc123",
"houseNumber": "xyz789",
"houseNumberAddition": "xyz789",
"postalCode": "abc123",
"city": "xyz789"
}
SearchCompanyContactPerson
Fields
| Field Name | Description |
|---|---|
firstName - String!
|
First name of the contact person. |
lastName - String!
|
Last name of the contact person. |
email - String
|
Email address of the contact person. |
phoneNumber - String
|
Phone number of the contact person. Use phoneNumbers instead |
phoneNumbers - [ContactPersonPhoneNumber]
|
Phone numbers of the contact person. |
Example
{
"firstName": "abc123",
"lastName": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"phoneNumbers": [ContactPersonPhoneNumber]
}
SearchCompanyResponse
Fields
| Field Name | Description |
|---|---|
country - Country!
|
Country of the company. |
name - String!
|
Name of the company. |
registrationNumber - String!
|
Registration number of the company. |
website - String
|
Website of the company. |
contactPerson - SearchCompanyContactPerson
|
Contact person of the company. |
address - SearchCompanyAddress
|
Address of the company. |
Example
{
"country": "AL",
"name": "xyz789",
"registrationNumber": "abc123",
"website": "abc123",
"contactPerson": SearchCompanyContactPerson,
"address": SearchCompanyAddress
}
SearchRadiusInput
SendIFSFMessageInput
SendMandateInviteInput
Fields
| Input Field | Description |
|---|---|
entityId - UUID!
|
Entity id. |
entityType - MandateEntityType!
|
Entity type. |
mandateEmail - String!
|
Mandate email. It should be a valid email. |
mandateTemplateId - UUID!
|
Mandate template id. Verify its existence in the mandate_templates model. |
Example
{
"entityId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"entityType": "USER",
"mandateEmail": "abc123",
"mandateTemplateId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Sepa
Description
A Sep file
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"url": "xyz789",
"status": "abc123",
"invoiceCount": 987,
"createdAt": "2007-12-03T10:15:30Z"
}
SepaConnection
Description
A paginated list of Sepa edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [SepaEdge!]!
|
A list of Sepa edges. |
Example
{
"pageInfo": PageInfo,
"edges": [SepaEdge]
}
SepaEdge
Service
Types
| Union Types |
|---|
Example
FuelCard
ServiceIdInput
ServiceIds
ShippingAddress
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"phoneNumber": "abc123",
"gender": "MALE",
"address": Address
}
ShippingAddressConnection
Description
A paginated list of ShippingAddress edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [ShippingAddressEdge!]!
|
A list of ShippingAddress edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ShippingAddressEdge]
}
ShippingAddressEdge
Description
An edge that contains a node of type ShippingAddress and a cursor.
Fields
| Field Name | Description |
|---|---|
node - ShippingAddress!
|
The ShippingAddress node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": ShippingAddress,
"cursor": "abc123"
}
ShippingAddressForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Organizational component id. |
name - String
|
Name. |
firstName - String!
|
First name. |
lastName - String!
|
Last name. |
phoneNumber - String
|
Phone number. |
gender - Gender!
|
Gender. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. |
country - Country!
|
Country. |
street - String
|
Street name. Required for country BE. |
city - String!
|
City. |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"phoneNumber": "xyz789",
"gender": "MALE",
"houseNumber": "xyz789",
"houseNumberAddition": "abc123",
"postalCode": "abc123",
"country": "AL",
"street": "abc123",
"city": "xyz789"
}
ShippingAddressForUserInput
Fields
| Input Field | Description |
|---|---|
userId - UUID!
|
User id. |
name - String
|
Name. |
firstName - String!
|
First name. |
lastName - String!
|
Last name. |
phoneNumber - String
|
Phone number. |
gender - Gender!
|
Gender. |
houseNumber - String!
|
House number. |
houseNumberAddition - String
|
House number addition. |
postalCode - String!
|
Postal code. Required for country. |
country - Country!
|
Country. |
street - String
|
Street name. Required for country BE. |
city - String!
|
City. |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"phoneNumber": "xyz789",
"gender": "MALE",
"houseNumber": "xyz789",
"houseNumberAddition": "xyz789",
"postalCode": "xyz789",
"country": "AL",
"street": "abc123",
"city": "abc123"
}
ShippingAddressInput
Fields
| Input Field | Description |
|---|---|
street - String
|
Street name required for Belgium only |
houseNumber - String!
|
House number |
houseNumberAddition - String
|
House number addition |
postalCode - String!
|
Postal code |
country - Country!
|
Country |
city - String!
|
City |
name - String
|
Name |
firstName - String
|
First Name |
lastName - String
|
Last name |
phoneNumber - String
|
Phone Number |
Example
{
"street": "xyz789",
"houseNumber": "xyz789",
"houseNumberAddition": "abc123",
"postalCode": "xyz789",
"country": "AL",
"city": "xyz789",
"name": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"phoneNumber": "abc123"
}
Shop
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Siphon
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
compartment - [Compartment!]
|
|
height - Int
|
Height inn mm |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
createdBy - User
|
Created by |
updatedBy - User
|
Updated by |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"compartment": [Compartment],
"height": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
SortOrder
Description
Directions for ordering a list of records.
Values
| Enum Value | Description |
|---|---|
|
|
Sort records in ascending order. |
|
|
Sort records in descending order. |
Example
"ASC"
StartChargingInput
Fields
| Input Field | Description |
|---|---|
evseId - UUID!
|
Charge point operator EVSE ID to start charging at |
Example
{
"evseId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
StartGuestParkingInput
StartParkingInput
Fields
| Input Field | Description |
|---|---|
locationId - UUID!
|
|
vehicleId - UUID!
|
|
metaData - MetaDataInput
|
Example
{
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"metaData": MetaDataInput
}
StatementPeriod
Fields
| Field Name | Description |
|---|---|
start - DateTimeUtc!
|
Start date of the statement period. |
end - DateTimeUtc!
|
End date of the statement period. |
Example
{
"start": DateTimeUtc,
"end": DateTimeUtc
}
StatisticsDifference
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"
StructuredReferenceNumber
TariffAltTextInput
TariffDimensionType
Values
| Enum Value | Description |
|---|---|
|
|
defined in kWh, step_size multiplier: 1 Wh |
|
|
flat fee, no unit |
|
|
time not charging: defined in hours, step_size multiplier: 1 second |
|
|
time charging: defined in hours, step_size multiplier: 1 second |
|
|
Session time charging: defined in hours, step_size multiplier: 1 second |
Example
"ENERGY"
TariffElementInput
Fields
| Input Field | Description |
|---|---|
priceComponents - [PriceComponentInput!]!
|
Tariff price components |
restrictions - TariffRestrictionInput
|
Tariff restrictions |
Example
{
"priceComponents": [PriceComponentInput],
"restrictions": TariffRestrictionInput
}
TariffInput
Fields
| Input Field | Description |
|---|---|
id - String!
|
Tariff ID |
currency - String!
|
Currency |
lastUpdated - DateTimeUtc!
|
Last updated |
elements - [TariffElementInput!]!
|
Tariff elements |
tariffAltText - [TariffAltTextInput]
|
Tariff description |
tariffAltUrl - String
|
Tariff url |
energyMix - EnergyMixInput
|
Tariff energy mix details |
Example
{
"id": "abc123",
"currency": "xyz789",
"lastUpdated": DateTimeUtc,
"elements": [TariffElementInput],
"tariffAltText": [TariffAltTextInput],
"tariffAltUrl": "abc123",
"energyMix": EnergyMixInput
}
TariffRestrictionInput
Fields
| Input Field | Description |
|---|---|
startTime - DateTimeUtc
|
Start time of the restriction |
endTime - DateTimeUtc
|
End time of the restriction |
startDate - String
|
Start date of the restriction |
endDate - String
|
End date of the restriction |
minKwh - Float
|
Minimum energy in kWh |
maxKwh - Float
|
Maximum energy in kWh |
minPower - Float
|
Minimum power in kW |
maxPower - Float
|
Maximum power in kW |
minDuration - Int
|
Minimum duration in seconds |
maxDuration - Int
|
Maximum duration in seconds |
dayOfWeek - [DayOfWeek]
|
Day of week. See DayOfWeek enum for possible values |
Example
{
"startTime": DateTimeUtc,
"endTime": DateTimeUtc,
"startDate": "xyz789",
"endDate": "abc123",
"minKwh": 987.65,
"maxKwh": 987.65,
"minPower": 987.65,
"maxPower": 987.65,
"minDuration": 987,
"maxDuration": 987,
"dayOfWeek": ["MONDAY"]
}
Template
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
tenant - Tenant
|
The tenant that the card belongs to. |
label - String!
|
Template's label |
description - String!
|
Description |
limit - TemplateLimit!
|
Template's limits |
chargePointOperatorPool - ChargePointOperatorPool
|
The charge point operator pool that the template belongs to. |
chargePointOperators - [ChargePointOperator!]
|
The charge point operator that the template belongs to. |
fuelEnabled - Boolean!
|
Fuel capability enabled/disabled |
chargingEnabled - Boolean!
|
Charging capability enabled/disabled |
products - [Product!]
|
Associated Products |
locations - [CardLocation!]
|
Associated locations |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"label": "abc123",
"description": "abc123",
"limit": TemplateLimit,
"chargePointOperatorPool": ChargePointOperatorPool,
"chargePointOperators": [ChargePointOperator],
"fuelEnabled": false,
"chargingEnabled": false,
"products": [Product],
"locations": [CardLocation],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
TemplateConnection
Description
A paginated list of Template edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TemplateEdge!]!
|
A list of Template edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TemplateEdge]
}
TemplateEdge
TemplateLimit
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
dailyTransactions - Int!
|
Daily transactions limit |
weeklyTransactions - Int!
|
Weekly transactions limit |
monthlyTransactions - Int!
|
Monthly transactions limit |
dailyAmount - Int!
|
Daily transactions Amount limit |
weeklyAmount - Int!
|
Weekly transactions Amount limit |
monthlyAmount - Int!
|
Monthly transactions Amount limit |
maxPinAttempts - Int!
|
Maximum number of Pin attempts |
createdAt - DateTimeUtc
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"dailyTransactions": 123,
"weeklyTransactions": 123,
"monthlyTransactions": 987,
"dailyAmount": 987,
"weeklyAmount": 987,
"monthlyAmount": 987,
"maxPinAttempts": 123,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
TemporaryCreditLimit
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
organizationalComponent - OrganizationalComponent
|
Organizational component the temporary credit limit is for. |
originalCreditLimit - Money!
|
Original credit limit. |
newCreditLimit - Money!
|
New credit limit. |
expiryDate - DateTimeUtc!
|
Date time the temporary credit limit expires. |
createdAt - DateTimeUtc
|
Date time when the temporary credit limit was created. |
updatedAt - DateTimeUtc
|
Date time when the temporary credit limit was last updated. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"organizationalComponent": OrganizationalComponent,
"originalCreditLimit": Money,
"newCreditLimit": Money,
"expiryDate": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
Tenant
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier |
siteId - String!
|
Site Id as known in Emabler |
binRanges - [BinRange!]
|
EFAS bin ranges |
mandate - [Mandate!]
|
Returns a list of mandates Use mandates instead |
mandates - [Mandate!]
|
Returns a list of mandates |
mandateTemplates - [MandateTemplate!]
|
Returns a list of mandate templates. These templates are used to when inviting for signing a mandate. |
name - String!
|
Name of the Tenant |
priceModifications - [PriceModification]!
|
|
productPackages - [ProductPackage!]
|
Packages belonging to this tenant |
tag - String!
|
Identifier tag. Cannot be updated after creation. It will be saved in UPPER case |
registrationNumber - String
|
Registration number of the Tenant |
vatNumber - String
|
VAT number of the Tenant |
iban - String
|
IBAN of the Tenant |
bic - String
|
BIC of the Tenant |
provider - [Provider]
|
Provider. See Provider enum. |
country - Country
|
Country of the Tenant |
logo - String
|
Logo of the Tenant |
aboutUs - String
|
About us |
privacyPolicy - String
|
Privacy policy |
usesInvoice - Boolean!
|
Flag indicating if the Tenant uses invoices |
phoneNumbers - [PhoneNumber!]!
|
Phone numbers |
disabledAt - DateTimeUtc
|
Date and time the Tenant was disabled |
createdAt - DateTimeUtc
|
Datetime of creation |
updatedAt - DateTimeUtc
|
Datetime of last update |
createdBy - User
|
Creator of the tenant |
updatedBy - User
|
Last updater of the tenant |
invoiceReminderDays - Int
|
Reminder for invoice expiration |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"siteId": "xyz789",
"binRanges": [BinRange],
"mandate": [Mandate],
"mandates": [Mandate],
"mandateTemplates": [MandateTemplate],
"name": "abc123",
"priceModifications": [PriceModification],
"productPackages": [ProductPackage],
"tag": "xyz789",
"registrationNumber": "xyz789",
"vatNumber": "abc123",
"iban": "abc123",
"bic": "xyz789",
"provider": ["LODDER"],
"country": "AL",
"logo": "xyz789",
"aboutUs": "abc123",
"privacyPolicy": "xyz789",
"usesInvoice": false,
"phoneNumbers": [PhoneNumber],
"disabledAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User,
"invoiceReminderDays": 123
}
TenantConnection
Description
A paginated list of Tenant edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TenantEdge!]!
|
A list of Tenant edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TenantEdge]
}
TenantDetails
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Unique identifier of the tenant. |
name - String!
|
Name of the tenant. |
address - AddressDetails!
|
Address details of the tenant. |
metadata - TenantMetadata!
|
Metadata/additional details of the tenant. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"address": AddressDetails,
"metadata": TenantMetadata
}
TenantEdge
TenantInvoiceMonthlyStatistic
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique identifier of the monthly statistic. |
tenant - TenantDetails!
|
Tenant details. |
month - Int!
|
Month Number. |
year - Int!
|
Year Number. |
status - InvoiceStatus!
|
Invoice status, See InvoiceStatus Enum. |
amountOfInvoices - Int
|
Amount of invoices. |
totalAmountWithTax - Money!
|
Total amount with tax. |
totalAmountWithoutTax - Money!
|
Total amount without tax. |
createdAt - DateTimeUtc
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": 123,
"tenant": TenantDetails,
"month": 987,
"year": 123,
"status": "CONCEPT",
"amountOfInvoices": 987,
"totalAmountWithTax": Money,
"totalAmountWithoutTax": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
TenantInvoiceMonthlyStatisticConnection
Description
A paginated list of TenantInvoiceMonthlyStatistic edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TenantInvoiceMonthlyStatisticEdge!]!
|
A list of TenantInvoiceMonthlyStatistic edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TenantInvoiceMonthlyStatisticEdge]
}
TenantInvoiceMonthlyStatisticEdge
Description
An edge that contains a node of type TenantInvoiceMonthlyStatistic and a cursor.
Fields
| Field Name | Description |
|---|---|
node - TenantInvoiceMonthlyStatistic!
|
The TenantInvoiceMonthlyStatistic node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": TenantInvoiceMonthlyStatistic,
"cursor": "abc123"
}
TenantInvoiceQuarterlyStatistic
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique identifier of the quarterly statistic. |
tenant - TenantDetails!
|
Tenant details. |
quarter - Int!
|
Quarter Number. |
year - Int!
|
Year Number. |
status - InvoiceStatus!
|
Invoice status, See InvoiceStatus Enum. |
amountOfInvoices - Int
|
Amount of invoices. |
totalAmountWithTax - Money!
|
Total amount with tax. |
totalAmountWithoutTax - Money!
|
Total amount without tax. |
createdAt - DateTimeUtc
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": 987,
"tenant": TenantDetails,
"quarter": 987,
"year": 987,
"status": "CONCEPT",
"amountOfInvoices": 987,
"totalAmountWithTax": Money,
"totalAmountWithoutTax": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
TenantInvoiceQuarterlyStatisticConnection
Description
A paginated list of TenantInvoiceQuarterlyStatistic edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TenantInvoiceQuarterlyStatisticEdge!]!
|
A list of TenantInvoiceQuarterlyStatistic edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TenantInvoiceQuarterlyStatisticEdge]
}
TenantInvoiceQuarterlyStatisticEdge
Description
An edge that contains a node of type TenantInvoiceQuarterlyStatistic and a cursor.
Fields
| Field Name | Description |
|---|---|
node - TenantInvoiceQuarterlyStatistic!
|
The TenantInvoiceQuarterlyStatistic node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": TenantInvoiceQuarterlyStatistic,
"cursor": "abc123"
}
TenantInvoiceYearlyStatistic
Fields
| Field Name | Description |
|---|---|
id - Int
|
Unique identifier of the yearly statistic. |
tenant - TenantDetails!
|
Tenant details. |
year - Int!
|
Year Number. |
status - InvoiceStatus!
|
Invoice status, See InvoiceStatus Enum. |
amountOfInvoices - Int
|
Amount of invoices. |
totalAmountWithTax - Money!
|
Total amount with tax. |
totalAmountWithoutTax - Money!
|
Total amount without tax. |
createdAt - DateTimeUtc
|
Created at. |
updatedAt - DateTimeUtc
|
Updated at. |
Example
{
"id": 123,
"tenant": TenantDetails,
"year": 987,
"status": "CONCEPT",
"amountOfInvoices": 123,
"totalAmountWithTax": Money,
"totalAmountWithoutTax": Money,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
TenantInvoiceYearlyStatisticConnection
Description
A paginated list of TenantInvoiceYearlyStatistic edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TenantInvoiceYearlyStatisticEdge!]!
|
A list of TenantInvoiceYearlyStatistic edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TenantInvoiceYearlyStatisticEdge]
}
TenantInvoiceYearlyStatisticEdge
Description
An edge that contains a node of type TenantInvoiceYearlyStatistic and a cursor.
Fields
| Field Name | Description |
|---|---|
node - TenantInvoiceYearlyStatistic!
|
The TenantInvoiceYearlyStatistic node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": TenantInvoiceYearlyStatistic,
"cursor": "abc123"
}
TenantMetadata
TerminalPaymentMethod
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The identifier. Reference to Payment Methods service |
gasStations - [GasStation!]
|
List of gas stations which has terminal payment method |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"gasStations": [GasStation]
}
TermsAndCondition
Description
The data of the terms and conditions
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
companyApprovals - [CompanyApproval]
|
Organizational components that have approved the terms and conditions Use organizationalComponentApprovals instead |
organizationalComponentApprovals - [CompanyApproval]
|
Organizational components that have approved the terms and conditions |
tenant - Tenant!
|
Data of the tenant |
type - TermsAndConditionsType!
|
Type of the terms and conditions. See TermsAndConditionsType enum. |
version - String!
|
Version of the terms and conditions |
content - String!
|
Content of the terms and conditions |
isActive - Boolean!
|
Flag indicating if the terms and conditions are active |
disabledAt - DateTimeUtc
|
Date and time the terms and conditions were disabled |
deletedAt - DateTimeUtc
|
Datetime of deletion |
userApprovals - [UserApproval]
|
All users who approved the terms and conditions |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"companyApprovals": [CompanyApproval],
"organizationalComponentApprovals": [CompanyApproval],
"tenant": Tenant,
"type": "B2B",
"version": "abc123",
"content": "abc123",
"isActive": false,
"disabledAt": DateTimeUtc,
"deletedAt": DateTimeUtc,
"userApprovals": [UserApproval]
}
TermsAndConditionConnection
Description
A paginated list of TermsAndCondition edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TermsAndConditionEdge!]!
|
A list of TermsAndCondition edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TermsAndConditionEdge]
}
TermsAndConditionEdge
Description
An edge that contains a node of type TermsAndCondition and a cursor.
Fields
| Field Name | Description |
|---|---|
node - TermsAndCondition!
|
The TermsAndCondition node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": TermsAndCondition,
"cursor": "xyz789"
}
TermsAndConditionsType
Description
Terms and conditions type
Values
| Enum Value | Description |
|---|---|
|
|
B2B terms and conditions |
|
|
B2C terms and conditions |
Example
"B2B"
Timestampable
Fields
| Field Name | Description |
|---|---|
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
Possible Types
| Timestampable Types |
|---|
Example
{
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
TokenInfoInput
TransactionBlock
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Unique identifier of the transaction block. |
invoice - Invoice!
|
Invoice reference. |
description - String!
|
Description |
transactions - [InvoiceTransaction]
|
List of all associated transactions. |
createdAt - DateTimeUtc!
|
Created at |
updatedAt - DateTimeUtc
|
Updated at |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"invoice": Invoice,
"description": "xyz789",
"transactions": [InvoiceTransaction],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
TransactionBlockInput
Fields
| Input Field | Description |
|---|---|
parking - CombinerInput
|
Parking combiner configuration |
fuelCard - CombinerInput
|
Fuel card combiner configuration |
chargeRecords - CombinerInput
|
Charge records combiner configuration |
eod - CombinerInput
|
Eod combiner configuration |
kilometreCharge - CombinerInput
|
Kilometre charge combiner configuration |
Example
{
"parking": CombinerInput,
"fuelCard": CombinerInput,
"chargeRecords": CombinerInput,
"eod": CombinerInput,
"kilometreCharge": CombinerInput
}
TransactionData
Description
Data of the transaction
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the transaction |
type - TransactionType
|
The type of the transaction |
transactionId - String!
|
External transaction id |
createdAt - DateTime!
|
Date of the transaction creation |
updatedAt - DateTime!
|
Date of the transaction update |
amount - Float!
|
The amount of the transaction |
totalCost - Money!
|
The total cost of the transaction |
service - Service!
|
Type of the service to which the transaction belongs |
location - TransactionLocation!
|
The location of the transaction |
mileage - Int
|
The mileage of the vehicle |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "FUEL",
"transactionId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z",
"amount": 987.65,
"totalCost": Money,
"service": FuelCard,
"location": ChargeLocation,
"mileage": 123
}
TransactionDataConnection
Description
A paginated list of TransactionData edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [TransactionDataEdge!]!
|
A list of TransactionData edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TransactionDataEdge]
}
TransactionDataEdge
Description
An edge that contains a node of type TransactionData and a cursor.
Fields
| Field Name | Description |
|---|---|
node - TransactionData!
|
The TransactionData node. |
cursor - String!
|
A unique cursor that can be used for pagination. |
Example
{
"node": TransactionData,
"cursor": "abc123"
}
TransactionLocation
Types
| Union Types |
|---|
Example
ChargeLocation
TransactionService
Types
| Union Types |
|---|
Example
FuelTransaction
TransactionType
Description
The type of a transaction
Values
| Enum Value | Description |
|---|---|
|
|
A transaction for fuel |
|
|
A transaction for charging |
Example
"FUEL"
Trashed
Description
Specify if you want to include or exclude trashed results from a query.
Values
| Enum Value | Description |
|---|---|
|
|
Only return trashed results. |
|
|
Return both trashed and non-trashed results. |
|
|
Only return non-trashed results. |
Example
"ONLY"
TwoFactorAuthenticationResponse
UUID
Example
"caa70eb8-e49f-47e8-aedf-950626c699fc"
UpdateAddressForGasStationInput
Example
{
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "abc123",
"country": "AL",
"city": "xyz789"
}
UpdateAddressForOrganizationalComponentInput
Example
{
"street": "xyz789",
"houseNumber": "abc123",
"houseNumberAddition": "xyz789",
"postalCode": "xyz789",
"country": "AL",
"city": "abc123"
}
UpdateAddressForTenantInput
Example
{
"street": "xyz789",
"houseNumber": "abc123",
"houseNumberAddition": "xyz789",
"postalCode": "xyz789",
"country": "AL",
"city": "xyz789"
}
UpdateAddressForUserInput
Example
{
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "abc123",
"postalCode": "abc123",
"country": "AL",
"city": "abc123"
}
UpdateCardInput
Fields
| Input Field | Description |
|---|---|
companyId - UUID
|
Company UUID |
userId - UUID
|
User UUID |
vehicleId - UUID
|
Vehicle UUID |
type - CardType
|
Type of Card |
mileageRequired - Boolean
|
Is mileage required at time of fueling |
expiryMonth - Int
|
Card expiry month between 1-12 |
expiryYear - Int
|
Card expiry year in 4 digits |
externalReference - String
|
External reference number |
Example
{
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vehicleId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"type": "CHARGE",
"mileageRequired": false,
"expiryMonth": 123,
"expiryYear": 123,
"externalReference": "abc123"
}
UpdateCardProductInput
Fields
| Input Field | Description |
|---|---|
card - CardInput!
|
|
address - ShippingAddressInput
|
Example
{
"card": CardInput,
"address": ShippingAddressInput
}
UpdateCardProductsInput
Fields
| Input Field | Description |
|---|---|
products - [UUID!]!
|
Array of product ids |
Example
{
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
UpdateCategoryInput
Fields
| Input Field | Description |
|---|---|
label - String!
|
Label of the category |
Example
{"label": "abc123"}
UpdateChargeTokenInput
Fields
| Input Field | Description |
|---|---|
externalReference - String
|
External reference. Can be used as a reference to an external system |
chargePointOperators - [UUID!]
|
List of charge point operators to enable this token to. Can be omitted if chargePointOperatorPool is set |
chargePointOperatorPool - UUID
|
Charge point operator pool to enable this token to. Can be omitted if chargePointOperators is set |
Example
{
"externalReference": "abc123",
"chargePointOperators": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"chargePointOperatorPool": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
UpdateCompanyIdentificationNumberInput
Fields
| Input Field | Description |
|---|---|
identificationNumber - [String!]!
|
Identification numbers to link to the Kilometre charge provider |
provider - KilometreChargeProvider!
|
Kilometre charge provider related to this identification number. See KilometreChargeProvider enum. |
Example
{
"identificationNumber": ["abc123"],
"provider": "SATELLIC"
}
UpdateContactPersonForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
firstName - String
|
First name of the contact person |
lastName - String
|
Last name of the contact person |
email - String
|
Email address of the contact person. Input should be a valid email address |
phoneNumbers - [PhoneNumberInput!]!
|
Phone numbers of the contact person |
language - Locale
|
Language of the contact person. See Locale enum. |
gender - Gender!
|
Gender of the contact person. See Gender enum. |
position - String
|
Position of the contact person within the organizational component. |
Example
{
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789",
"phoneNumbers": [PhoneNumberInput],
"language": "NL",
"gender": "MALE",
"position": "xyz789"
}
UpdateCreditLimitForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
creditLimit - String!
|
New credit limit for the organizational component |
Example
{"creditLimit": "xyz789"}
UpdateEmailInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
The new email. |
Example
{"email": "abc123"}
UpdateFieldInput
Fields
| Input Field | Description |
|---|---|
entityType - EntityType!
|
Entity type. |
label - String!
|
Label. |
Example
{
"entityType": "ORGANIZATIONAL_COMPONENT",
"label": "abc123"
}
UpdateGasStationInput
Fields
| Input Field | Description |
|---|---|
hubId - UUID!
|
Reference to Hubs service |
brandId - UUID!
|
Reference to Brands service |
name - String!
|
|
location - String!
|
Location (city / town) |
url - String!
|
Website for the gas station |
isManned - Boolean!
|
Flag if it's a self service gas station |
serviceIds - ServiceIdInput
|
Example
{
"hubId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"brandId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"location": "abc123",
"url": "xyz789",
"isManned": false,
"serviceIds": ServiceIdInput
}
UpdateGuaranteeInput
Fields
| Input Field | Description |
|---|---|
guaranteeType - GuaranteeType!
|
Guarantee type. See GuaranteeType enum. |
amount - Int
|
Amount of the guarantee |
activeFrom - DateTimeUtc
|
Active from date of the guarantee |
fromImport - Boolean
|
Indication if the guarantee is from an import |
comment - String
|
Comment for the guarantee |
status - GuaranteeStatus
|
Status of the guarantee. See GuaranteeStatus enum. |
pdf - String
|
PDF data which will be converted and stored as a file with file reference. |
Example
{
"guaranteeType": "BANK",
"amount": 987,
"activeFrom": DateTimeUtc,
"fromImport": true,
"comment": "xyz789",
"status": "PENDING",
"pdf": "xyz789"
}
UpdateHubInput
UpdateInvoiceAddressForOrganizationalComponentInput
Example
{
"street": "abc123",
"houseNumber": "abc123",
"houseNumberAddition": "xyz789",
"postalCode": "abc123",
"country": "AL",
"city": "xyz789"
}
UpdateMyTenantInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the Tenant |
country - Country
|
Country of the Tenant |
registrationNumber - String
|
Registration number of the Tenant |
vatNumber - String
|
VAT number of the Tenant |
iban - String
|
IBAN of the Tenant |
bic - String
|
BIC of the Tenant |
invoiceReminderDays - Int
|
Invoice reminder days |
Example
{
"name": "abc123",
"country": "AL",
"registrationNumber": "abc123",
"vatNumber": "xyz789",
"iban": "abc123",
"bic": "xyz789",
"invoiceReminderDays": 123
}
UpdateOrderShippingAddressInput
Fields
| Input Field | Description |
|---|---|
address - ShippingAddressInput!
|
Example
{"address": ShippingAddressInput}
UpdateOrderStatusInput
Fields
| Input Field | Description |
|---|---|
status - OrderStatus!
|
Example
{"status": "DRAFT"}
UpdateOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentTypeId - UUID
|
Type of the organizational component. This should reference an existing organizational component type entity. |
name - String
|
Name of the organizational component |
email - String
|
Email address of the organizational component. Input should be a valid email address |
phoneNumbers - [PhoneNumberInput!]
|
Phone numbers of the organizational component |
parentId - UUID
|
Parent organizational component ID |
segmentId - UUID
|
Segment ID of the organizational component |
website - String
|
Website of the organizational component |
invoiced - Boolean
|
Indication if transactions of this organizational component should be invoiced |
invoiceableCompanyId - UUID
|
If this organizational component is not invoiced it is possible to set a parent to be invoiced instead. |
vatNumber - String
|
Vat number of the organizational component |
iban - String
|
Iban of the organizational component |
bic - String
|
Bic of the organizational component |
billingPeriod - BillingPeriod
|
Billing period of the organizational component. See BillingPeriod enum. |
invoiceVia - [InvoiceVia]
|
Setting of how invoices should be sent to the organizational component. See InvoiceVia enum. |
paymentMethod - PaymentMethod
|
Payment method of the organizational component. See PaymentMethod enum. |
invoiceEmail - [String]
|
Email addresses to send invoices to if invoice via is set to email |
status - OrganizationalComponentStatusType
|
Status of the organizational component. See OrganizationalComponentStatusType enum. |
language - Locale
|
Language of the organizational component. See Locale enum. |
purchaseOrderNumber - String
|
Purchase order number of the organizational component |
externalReference - String
|
External reference of the organizational component. Can be used to reference to an external system. |
paymentTerm - Int
|
Payment term of the organizational component |
customerNumber - String
|
Customer number of the organizational component. |
structuredReference - String
|
Structured reference used for bank transfers for organizational components from Belgium |
creditLimit - Int
|
Credit limit of the organizational component |
registrationNumber - String
|
Registration number of the organizational component |
tradeName - String
|
Trade name of the organizational component |
legalForm - String
|
Legal form of the organizational component |
Example
{
"organizationalComponentTypeId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"email": "xyz789",
"phoneNumbers": [PhoneNumberInput],
"parentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"segmentId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"website": "xyz789",
"invoiced": false,
"invoiceableCompanyId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"vatNumber": "abc123",
"iban": "abc123",
"bic": "xyz789",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"paymentMethod": "DIRECT_DEBIT",
"invoiceEmail": ["abc123"],
"status": "INCOMPLETE",
"language": "NL",
"purchaseOrderNumber": "xyz789",
"externalReference": "xyz789",
"paymentTerm": 987,
"customerNumber": "xyz789",
"structuredReference": "abc123",
"creditLimit": 123,
"registrationNumber": "xyz789",
"tradeName": "xyz789",
"legalForm": "xyz789"
}
UpdatePackageInput
Example
{
"subscriptionPlanId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"description": "abc123",
"price": 123,
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
]
}
UpdatePasswordInput
UpdatePhoneNumberForTenantInput
Fields
| Input Field | Description |
|---|---|
phoneNumber - String
|
Phone number |
phoneNumberType - PhoneNumberType
|
Phone number type. See PhoneNumberType enum |
country - Country
|
Country of the phone number |
Example
{
"phoneNumber": "xyz789",
"phoneNumberType": "LANDLINE",
"country": "AL"
}
UpdatePriceModificationAssociationInput
Fields
| Input Field | Description |
|---|---|
associationType - AssociationType!
|
Association Type. See AssociationType enum |
associations - [AssociatedEntities!]!
|
Associations. Provide Array of Entity type and Entity Id |
Example
{
"associationType": "SINGLE",
"associations": [AssociatedEntities]
}
UpdatePriceModificationInput
Fields
| Input Field | Description |
|---|---|
description - String
|
Description |
promoCode - String
|
Promo code. Must be unique or null |
externalReference - String
|
External reference |
type - PriceType
|
Price type, See PriceType enum |
inverse - Boolean
|
Inverse. Provide true if value should be addition to the price |
startDate - DateTime
|
Start date |
endDate - DateTime
|
End date. Must be after start date or null |
adjustmentType - ModificationAdjustmentType
|
Adjustment type, See ModificationAdjustmentType enum |
isVisibleToInvoice - Boolean
|
Price modification visibility in invoice |
isVolumePriceModificationEnabled - Boolean
|
Is Volume price modification enabled |
scope - PriceModificationScope
|
Price modification scope, See PriceModificationScope enum |
period - VolumePriceModificationPeriod
|
Volume price modification period. Required if isVolumePriceModificationEnabled is true and see VolumePriceModificationPeriod enum |
perProductDetails - [PriceModificationPerProductDetailsInput!]
|
Per product details |
conditions - [ConditionInput!]
|
Conditions |
Example
{
"description": "xyz789",
"promoCode": "abc123",
"externalReference": "xyz789",
"type": "SELLING",
"inverse": false,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z",
"adjustmentType": "MARGIN",
"isVisibleToInvoice": false,
"isVolumePriceModificationEnabled": true,
"scope": "PER_UNIT",
"period": "MONTHLY",
"perProductDetails": [
PriceModificationPerProductDetailsInput
],
"conditions": [ConditionInput]
}
UpdateProductInput
UpdateTemplateInput
Fields
| Input Field | Description |
|---|---|
label - String!
|
Template label |
description - String!
|
Template description |
products - [UUID!]!
|
Template's products |
locations - [UUID!]!
|
Locations |
limit - FuelLimitInput!
|
Daily/weekly/monthyl transactions/amount limits |
fuelEnabled - Boolean!
|
Is fuel capability enabled |
chargingEnabled - Boolean!
|
Is charge capability enabled |
chargePointOperators - [UUID!]
|
Charge point operators |
chargePointOperatorPool - UUID
|
Charge point operator pool |
allowUpdateOnAssociatedCards - Boolean!
|
Allow updates to associated cards in case of change in template |
Example
{
"label": "xyz789",
"description": "xyz789",
"products": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"locations": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"limit": FuelLimitInput,
"fuelEnabled": false,
"chargingEnabled": false,
"chargePointOperators": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"chargePointOperatorPool": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"allowUpdateOnAssociatedCards": false
}
UpdateTenantInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the Tenant |
usesInvoice - Boolean!
|
Flag indicating if the Tenant uses invoices |
country - Country
|
Country of the Tenant |
registrationNumber - String
|
Registration number of the Tenant |
vatNumber - String
|
VAT number of the Tenant |
iban - String
|
IBAN of the Tenant |
bic - String
|
BIC of the Tenant |
creditCheck - CreditCheckType
|
Credit check type. See CreditCheckType enum |
isAutoCreditCheckNeededOnCompanyCreate - Boolean
|
Flag indicating if the Tenant is using auto credit check on company create |
twikeyContracts - [UUID!]
|
The unique identifier of the twikey contracts |
twikeyUrl - String
|
The twikey url |
twikeyApiKey - String
|
The twikey api key |
aboutUs - String
|
The information about us |
softLimit - Int
|
Soft limit |
hardLimit - Int
|
Hard limit |
provider - [Provider]
|
Provider. See Provider enum. |
invoiceReminderDays - Int
|
Invoice reminder days |
Example
{
"name": "xyz789",
"usesInvoice": false,
"country": "AL",
"registrationNumber": "abc123",
"vatNumber": "abc123",
"iban": "xyz789",
"bic": "xyz789",
"creditCheck": "CREDIT_SAFE",
"isAutoCreditCheckNeededOnCompanyCreate": true,
"twikeyContracts": [
"caa70eb8-e49f-47e8-aedf-950626c699fc"
],
"twikeyUrl": "abc123",
"twikeyApiKey": "abc123",
"aboutUs": "xyz789",
"softLimit": 123,
"hardLimit": 123,
"provider": ["LODDER"],
"invoiceReminderDays": 987
}
UpdateTermsAndConditionsInput
Fields
| Input Field | Description |
|---|---|
termsAndConditionsType - TermsAndConditionsType
|
Terms and conditions type. See TermsAndConditionsType enum |
content - String
|
Terms and conditions version of document |
isActive - Boolean
|
Flag indicating if the terms and conditions are active |
Example
{
"termsAndConditionsType": "B2B",
"content": "abc123",
"isActive": false
}
UpdateTokenizedCardInput
Fields
| Input Field | Description |
|---|---|
vatNumber - String!
|
VAT number |
tokenInfo - TokenInfoInput!
|
Card token information |
Example
{
"vatNumber": "xyz789",
"tokenInfo": TokenInfoInput
}
UpdateUserInput
Fields
| Input Field | Description |
|---|---|
firstName - String
|
First name |
lastName - String
|
Last name |
dateOfBirth - Date
|
Date of birth |
locale - Locale
|
Locale |
gender - Gender
|
Gender |
iban - String
|
IBAN |
bic - String
|
BIC |
paymentMethod - PaymentMethod
|
Payment method |
billingPeriod - BillingPeriod
|
Billing period |
invoiceVia - [InvoiceVia]
|
Invoice via |
invoiceEmail - [String]
|
Invoice email |
vatNumber - String
|
Vat Number |
customerNumber - String
|
Customer number |
externalReference - String
|
External reference |
phoneNumbers - [addPhoneNumberInput!]
|
Phone numbers |
paymentTerm - Int
|
Payment term |
status - UserStatus
|
Status |
structuredReference - String
|
Structured reference |
email - String
|
Email address |
Example
{
"firstName": "abc123",
"lastName": "abc123",
"dateOfBirth": "2007-12-03",
"locale": "NL",
"gender": "MALE",
"iban": "xyz789",
"bic": "xyz789",
"paymentMethod": "DIRECT_DEBIT",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"invoiceEmail": ["abc123"],
"vatNumber": "xyz789",
"customerNumber": "xyz789",
"externalReference": "xyz789",
"phoneNumbers": [addPhoneNumberInput],
"paymentTerm": 987,
"status": "INCOMPLETE",
"structuredReference": "abc123",
"email": "abc123"
}
UpdateVehicleInput
User
Description
Account of a person who utilizes this application
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the user. |
address - Address
|
|
invoiceAddress - Address
|
|
shippingAddresses - [ShippingAddress]
|
|
emailVerifiedAt - DateTimeUtc
|
Date time the email was verified |
twoFactorConfirmedAt - DateTimeUtc
|
Date time two factor authentication was confirmed |
cards - [Card]
|
|
favoriteChargeLocations - [ChargeLocation]
|
Favorite charge locations of the user. |
pivot - OrganizationalComponentUserPivot
|
Employee data between the user and the organizational component |
organizationalComponents - OrganizationalComponentConnection!
|
Organizational components the user is employee of |
metadata - [Value]
|
|
favoriteParkingLocations - [ParkingLocation]
|
|
mandate - [Mandate!]
|
Returns a list of mandates Use mandates instead |
mandates - [Mandate!]
|
Returns a list of mandates |
priceModifications - [PriceModification]!
|
|
roles - [Role!]
|
User roles Will be changed to an enum |
tenant - Tenant!
|
UUID reference to the tenant |
firstName - String!
|
First name |
lastName - String!
|
Last name |
email - String
|
Unique email address |
customerNumber - String
|
Customer Number |
dateOfBirth - Date
|
Date of birth |
gender - Gender
|
Gender |
company - Company
|
UUID reference to the tenant |
locale - Locale!
|
User locale |
iban - String
|
IBAN |
bic - String
|
BIC |
vatNumber - String
|
Vat Number |
paymentMethod - PaymentMethod
|
Payment method |
billingPeriod - BillingPeriod
|
Billing period |
invoiceVia - [InvoiceVia]
|
Invoice via |
invoiceEmail - [String]
|
Invoice email |
paymentTerm - Int
|
Payment term |
structuredReference - StructuredReferenceNumber
|
Structured Reference |
externalReference - String
|
External reference |
phoneNumbers - [UserPhoneNumber]
|
Phone numbers |
termsOfAgreementAcceptedAt - DateTimeUtc
|
When the user accepted terms of agreement Use termsAndConditionsApproval.approvedAt instead |
termsAndConditionsApproval - UserTermsAndConditionsApproval
|
When the users approve Terms And Conditions |
guarantees - [Guarantee]
|
Guarantees |
deletedAt - DateTimeUtc
|
When the user was deleted |
disabledAt - DateTimeUtc
|
When the user was disabled |
disabledReason - UserDisabledReason
|
Reason for disablement |
disabledComment - String
|
Additional comment on Disablement |
deactivatedAt - DateTimeUtc
|
When the user was deactivated. |
createdAt - DateTimeUtc
|
Datetime of creation |
updatedAt - DateTimeUtc
|
Datetime of last update |
companies - CompanyConnection!
|
Users company |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"address": Address,
"invoiceAddress": Address,
"shippingAddresses": [ShippingAddress],
"emailVerifiedAt": DateTimeUtc,
"twoFactorConfirmedAt": DateTimeUtc,
"cards": [Card],
"favoriteChargeLocations": [ChargeLocation],
"pivot": OrganizationalComponentUserPivot,
"organizationalComponents": OrganizationalComponentConnection,
"metadata": [Value],
"favoriteParkingLocations": [ParkingLocation],
"mandate": [Mandate],
"mandates": [Mandate],
"priceModifications": [PriceModification],
"roles": [Role],
"tenant": Tenant,
"firstName": "xyz789",
"lastName": "xyz789",
"email": "abc123",
"customerNumber": "xyz789",
"dateOfBirth": "2007-12-03",
"gender": "MALE",
"company": Company,
"locale": "NL",
"iban": "abc123",
"bic": "xyz789",
"vatNumber": "abc123",
"paymentMethod": "DIRECT_DEBIT",
"billingPeriod": "MONTHLY",
"invoiceVia": ["EMAIL"],
"invoiceEmail": ["abc123"],
"paymentTerm": 123,
"structuredReference": StructuredReferenceNumber,
"externalReference": "xyz789",
"phoneNumbers": [UserPhoneNumber],
"termsOfAgreementAcceptedAt": DateTimeUtc,
"termsAndConditionsApproval": UserTermsAndConditionsApproval,
"guarantees": [Guarantee],
"deletedAt": DateTimeUtc,
"disabledAt": DateTimeUtc,
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "abc123",
"deactivatedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"companies": CompanyConnection
}
UserApproval
Description
User approval data
Fields
| Field Name | Description |
|---|---|
userId - UUID!
|
The unique identifier of the user |
approvedAt - DateTimeUtc
|
When the user approved the terms and conditions |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"approvedAt": DateTimeUtc
}
UserApproveTermsAndConditionsInput
UserConnection
Description
A paginated list of User edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [UserEdge!]!
|
A list of User edges. |
Example
{
"pageInfo": PageInfo,
"edges": [UserEdge]
}
UserDisabledInput
Fields
| Input Field | Description |
|---|---|
disabledReason - UserDisabledReason!
|
The reason for disabling the user |
disabledComment - String
|
The comment for disabling the user |
Example
{
"disabledReason": "LEGAL_COMPLIANCE",
"disabledComment": "abc123"
}
UserDisabledReason
Description
User disabled reason
Values
| Enum Value | Description |
|---|---|
|
|
Legal compliance |
|
|
Terms violation |
|
|
Fraud suspicion |
|
|
Poor credit history |
|
|
Inactive account |
|
|
Resource abuse |
|
|
Terminated relationship |
|
|
Non-payment |
|
|
Other |
Example
"LEGAL_COMPLIANCE"
UserEdge
UserMetadataInput
UserPhoneNumber
Description
User phone number data
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the phone number |
user - User!
|
Related user |
type - PhoneNumberType!
|
The type of the phone number |
country - Country!
|
The phone number country |
number - String!
|
The phone number |
verified - DateTimeUtc
|
Date of verification the phone number |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"user": User,
"type": "LANDLINE",
"country": "AL",
"number": "xyz789",
"verified": DateTimeUtc
}
UserRemoveAddressInput
Fields
| Input Field | Description |
|---|---|
userId - UUID!
|
User id. |
Example
{
"userId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
UserStatus
Description
The status of a user
Values
| Enum Value | Description |
|---|---|
|
|
Incomplete status |
|
|
Complete status |
|
|
Disabled status |
|
|
Credit limit exceeded status |
Example
"INCOMPLETE"
UserTermsAndConditionsApproval
Description
The data of the user terms and conditions approval
Fields
| Field Name | Description |
|---|---|
termsAndConditions - TermsAndCondition
|
Terms and conditions data |
approvedAt - DateTimeUtc
|
When the user approved the terms and conditions |
Example
{
"termsAndConditions": TermsAndCondition,
"approvedAt": DateTimeUtc
}
UserType
Description
The type of a user
Values
| Enum Value | Description |
|---|---|
|
|
Anonymous type |
|
|
Registered type |
|
|
Unauthenticated type |
Example
"ANONYMOUS"
UserWithVirtualCardInput
Fields
| Input Field | Description |
|---|---|
metadata - [UserMetadataInput]!
|
Metadata fields |
virtualCards - [VirtualCardsInput]!
|
VirtualCards |
companyId - UUID!
|
CompanyId |
Example
{
"metadata": [UserMetadataInput],
"virtualCards": [VirtualCardsInput],
"companyId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Value
ValueInput
VatBreakdown
Vehicle
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique ID of the User. |
metadata - [Value]
|
|
licensePlate - String!
|
License plate |
user - User
|
User the vehicle belongs to |
company - OrganizationalComponent
|
Company the vehicle belongs to |
country - Country!
|
Country the vehicle is from |
brand - String
|
Brand of the vehicle |
model - String
|
Model of the vehicle |
buildYear - Int
|
Build year of the vehicle |
vin - String
|
VIN of the vehicle |
mileage - Int
|
Mileage of the vehicle |
color - String
|
Color of the vehicle |
body - String
|
Body type of the vehicle |
verifiedAt - DateTimeUtc
|
Datetime the vehicle was validated by the user |
createdAt - DateTimeUtc
|
Datetime the vehicle was added |
updatedAt - DateTimeUtc
|
Datetime the vehicle was last updated |
createdBy - User
|
User that created the vehicle |
updatedBy - User
|
User that last updated the vehicle |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"metadata": [Value],
"licensePlate": "xyz789",
"user": User,
"company": OrganizationalComponent,
"country": "AL",
"brand": "abc123",
"model": "xyz789",
"buildYear": 123,
"vin": "abc123",
"mileage": 987,
"color": "xyz789",
"body": "xyz789",
"verifiedAt": DateTimeUtc,
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
VehicleConnection
Description
A paginated list of Vehicle edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [VehicleEdge!]!
|
A list of Vehicle edges. |
Example
{
"pageInfo": PageInfo,
"edges": [VehicleEdge]
}
VehicleDetails
VehicleEdge
Verified
Description
Specify if you want to include or exclude verified results from a query.
Values
| Enum Value | Description |
|---|---|
|
|
Only return unverified results. |
|
|
Return both verified and unverified results. |
|
|
Only return verified results. |
Example
"ONLY"
Version
Description
The versions that this charge point operator supports.
Current possible versions:
- 2.1.1
- 2.2
- 2.2.1 (latest)
The API currently only supports version 2.1.1
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Internal UUID used by the system. |
version - String!
|
The OCPI version number. |
url - String!
|
The URL of the version. |
chargePointOperator - ChargePointOperator!
|
The charge point operator this version belongs to |
modules - [Module]
|
The modules this version supports. |
createdAt - DateTimeUtc
|
The date and time the entity was created. |
updatedAt - DateTimeUtc
|
The date and time the entity was last updated. |
createdBy - User
|
The user who created the entity. |
updatedBy - User
|
The user who last updated the entity. |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"version": "xyz789",
"url": "abc123",
"chargePointOperator": ChargePointOperator,
"modules": [Module],
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc,
"createdBy": User,
"updatedBy": User
}
VirtualCardsInput
VolumePriceModificationPeriod
Description
The period of volume type price modification
Values
| Enum Value | Description |
|---|---|
|
|
Price modification value will be considered based on volume consumption in last month |
|
|
Price modification value will be considered based on volume consumption in last year |
Example
"MONTHLY"
Wash
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
Webhook
Description
Data of the webhook
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
The unique identifier of the webhook |
tenant - Tenant!
|
Related tenant |
topic - WebhookTopic!
|
Webhook topic |
name - String!
|
Webhook name |
createdAt - DateTimeUtc
|
Datetime of creation |
updatedAt - DateTimeUtc
|
Datetime of last update |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"tenant": Tenant,
"topic": "COMPANY_SEGMENT_CREATED",
"name": "abc123",
"createdAt": DateTimeUtc,
"updatedAt": DateTimeUtc
}
WebhookConnection
Description
A paginated list of Webhook edges.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination information about the list of edges. |
edges - [WebhookEdge!]!
|
A list of Webhook edges. |
Example
{
"pageInfo": PageInfo,
"edges": [WebhookEdge]
}
WebhookCreateInput
Fields
| Input Field | Description |
|---|---|
topic - WebhookTopic!
|
Webhook topic |
url - String!
|
Webhook url |
name - String!
|
Webhook name |
Example
{
"topic": "COMPANY_SEGMENT_CREATED",
"url": "abc123",
"name": "xyz789"
}
WebhookEdge
WebhookResponse
WebhookTopic
Description
Webhook topics
Values
| Enum Value | Description |
|---|---|
|
|
Webhook executed on organizational component segment created events |
|
|
Webhook executed on organizational component segment updated events |
|
|
Webhook executed on organizational component segment deleted events |
|
|
Webhook executed on organizational component created/imported events |
|
|
Webhook executed on organizational component updated events |
|
|
Webhook executed on organizational component deleted events |
|
|
Webhook executed when a contact person is added to an organizational component |
|
|
Webhook executed when a contact person is updated from an organizational component |
|
|
Webhook executed on user created/imported events |
|
|
Webhook executed on user updated events |
|
|
Webhook executed on user deleted events |
|
|
Webhook executed on order created events |
|
|
Webhook executed on order updated events. This includes status updates. |
|
|
Webhook executed on invoice created events |
|
|
Webhook executed on invoice updated events. This includes status updates. |
|
|
Webhook executed on card created events |
|
|
Webhook executed on card updated events |
Example
"COMPANY_SEGMENT_CREATED"
WebhookUpdateInput
WhereConditions
Description
Dynamic WHERE conditions for queries.
Fields
| Input Field | Description |
|---|---|
column - String
|
The column that is used for the condition. |
operator - SQLOperator
|
The operator that is used for the condition. Default = EQ |
value - Mixed
|
The value that is used for the condition. |
AND - [WhereConditions!]
|
A set of conditions that requires all conditions to match. |
OR - [WhereConditions!]
|
A set of conditions that requires at least one condition to match. |
HAS - WhereConditionsRelation
|
Check whether a relation exists. Extra conditions or a minimum amount can be applied. |
Example
{
"column": "xyz789",
"operator": "EQ",
"value": Mixed,
"AND": [WhereConditions],
"OR": [WhereConditions],
"HAS": WhereConditionsRelation
}
WhereConditionsRelation
Description
Dynamic HAS conditions for WHERE condition queries.
Fields
| Input Field | Description |
|---|---|
relation - String!
|
The relation that is checked. |
operator - SQLOperator
|
The comparison operator to test against the amount. Default = GTE |
amount - Int
|
The amount to test. Default = 1 |
condition - WhereConditions
|
Additional condition logic. |
Example
{
"relation": "xyz789",
"operator": "EQ",
"amount": 123,
"condition": WhereConditions
}
WhitelistType
Values
| Enum Value | Description |
|---|---|
|
|
Token always has to be whitelisted, realtime authorization is not possible/allowed. |
|
|
It is allowed to whitelist the token, realtime authorization is also allowed. |
|
|
Whitelisting is only allowed when CPO cannot reach the eMSP (communication between CPO and eMSP is offline) |
|
|
Whitelisting is forbidden, only realtime authorization is allowed. Token should always be authorized by the eMSP. |
Example
"ALWAYS"
addMandateTemplateInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
Name of the Mandate Template |
type - ContractType!
|
Type of the Mandate Template. See ContractType enum |
externalId - String!
|
External id of the Mandate Template |
features - [ContractTypeFeature!]
|
Features of the Mandate Template |
Example
{
"name": "xyz789",
"type": "B2B",
"externalId": "abc123",
"features": ["TERMS_OF_AGREEMENT"]
}
addPhoneNumberAuthInput
Fields
| Input Field | Description |
|---|---|
number - String!
|
Phone number |
type - PhoneNumberType!
|
Phone number type. See PhoneNumberType enum. |
country - Country!
|
Country of phone number |
Example
{
"number": "xyz789",
"type": "LANDLINE",
"country": "AL"
}
addPhoneNumberInput
Fields
| Input Field | Description |
|---|---|
number - String!
|
Phone number |
type - PhoneNumberType!
|
Type |
country - Country!
|
Country |
Example
{
"number": "xyz789",
"type": "LANDLINE",
"country": "AL"
}
deleteAddressForGasStationInput
Fields
| Input Field | Description |
|---|---|
gasStationId - UUID!
|
Gas station id. |
Example
{
"gasStationId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
deleteAddressForOrganizationalComponentInput
Fields
| Input Field | Description |
|---|---|
organizationalComponentId - UUID!
|
Organizational component id. |
Example
{
"organizationalComponentId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
deleteAddressForTenantInput
Fields
| Input Field | Description |
|---|---|
tenantId - UUID!
|
Tenant id. |
Example
{
"tenantId": "caa70eb8-e49f-47e8-aedf-950626c699fc"
}
getParkingCostInput
Fields
| Input Field | Description |
|---|---|
locationId - UUID!
|
|
startTime - DateTimeUtc!
|
|
endTime - DateTimeUtc!
|
Example
{
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"startTime": DateTimeUtc,
"endTime": DateTimeUtc
}
getParkingFareInfoInput
Fields
| Input Field | Description |
|---|---|
locationId - UUID!
|
|
startTime - DateTimeUtc!
|
Example
{
"locationId": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"startTime": DateTimeUtc
}
updateMandateTemplateInput
Fields
| Input Field | Description |
|---|---|
id - UUID!
|
Identifier of the Mandate Template |
name - String!
|
Name of the Mandate Template |
type - ContractType!
|
Type of the Mandate Template. See ContractType enum |
externalId - String!
|
External id of the Mandate Template |
features - [ContractTypeFeature!]
|
Features of the Mandate Template |
Example
{
"id": "caa70eb8-e49f-47e8-aedf-950626c699fc",
"name": "xyz789",
"type": "B2B",
"externalId": "xyz789",
"features": ["TERMS_OF_AGREEMENT"]
}
verifyPhoneNumberInput
Fields
| Input Field | Description |
|---|---|
code - String
|
Verification code |
Example
{"code": "abc123"}