Driversnote API
Welcome to the Driversnote Public API. It is a GraphQL API, so you send a POST request with the exact query or mutation you need and receive only the fields you ask for.
Send requests to https://api.driversnote.com/v1/driversnote with Content-Type: application/json and your API key in the x-api-key header.
API key
You can create or rotate an API key in your Driversnote account. The API key lets you access everything the user that provisions the API key has access to.
This means that if you want to access for example reports submitted to your team, you need to make sure that the user that provisions the API key is an admin or manager on the team.
Core Resources
- Trips are mileage records. They are private to the user that tracks them.
- Reports collect trips for reimbursement or tax documentation. They are private, but can be shared externally or submitted to a team.
- Teams typically represents a group of coworkers that tracks trips in a uniform manner and submits reports to team managers.
- Locations are saved places used on trips to help determine their purpose.
- Organisations are called workplaces in the UI. Note that what is called "Organisations" in the UI is called "ParentTeams" in the API.
- Vehicles are the vehicles used for trips. Odometer readings and distance specific rates are scoped to vehicles.
- Tags help categorise trips and reports.
Request Shape
POST /v1/driversnote HTTP/1.1
Host: api.driversnote.com
Content-Type: application/json
x-api-key: YOUR_API_KEY
{
"query": "query { vehicles(first: 10) { nodes { id name } } }"
}
Examples
Categorise Trips
First, fetch the trips you want to categorise.
Request
{
"query": "query TripsToCategorise(: ISO8601Date!, : ISO8601Date!) {
trips(startDate: , endDate: , first: 50) {
nodes {
id
startAt
stopAt
routeOrigin
tripType {
id
name
}
tags {
id
name
}
}
}
}
",
"variables": {
"startDate": "2026-01-01",
"endDate": "2026-01-31"
}
}
Response
{
"data": {
"trips": {
"nodes": [
{
"id": "trip_123",
"startAt": "2026-01-06T08:15:00Z",
"stopAt": "2026-01-06T08:42:00Z",
"routeOrigin": "gps",
"tripType": { "id": "business", "name": "Business" },
"tags": []
}
]
}
}
}
Then update each trip with the right trip type and tags.
Request
{
"query": "mutation CategoriseTrip(: ID!, : ID!, : [ID!]) {
tripUpdate(
input: {
id:
attributes: { tripTypeId: , tagIds: }
markAsReviewed: true
}
) {
trip {
id
reviewStatus
tripType {
id
name
}
tags {
id
name
}
}
}
}
",
"variables": {
"id": "trip_123",
"tripTypeId": "business",
"tagIds": ["tag_client_visit"]
}
}
Response
{
"data": {
"tripUpdate": {
"trip": {
"id": "trip_123",
"reviewStatus": "done",
"tripType": { "id": "business", "name": "Business" },
"tags": [{ "id": "tag_client_visit", "name": "Client visit" }]
}
}
}
}
Create a Report
Request
{
"query": "mutation CreateReport(
: ID!
: ID!
: ISO8601Date!
: ISO8601Date!
) {
reportCreate(
input: {
vehicleId:
organisationId:
startDate:
endDate:
showOdometer: false
}
) {
report {
id
title
startDate
endDate
totalDistance
totalAmount
pdfUrl
excelUrl
}
}
}
",
"variables": {
"vehicleId": "vehicle_123",
"organisationId": "organisation_123",
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"tagIds": ["tag_client_visit"]
}
}
Response
{
"data": {
"reportCreate": {
"report": {
"id": "report_123",
"title": "January 2026",
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"totalDistance": 428,
"totalAmount": 312.44,
"pdfUrl": "https://api.driversnote.com/...",
"excelUrl": "https://api.driversnote.com/..."
}
}
}
}
Fetch Team Reports
Request
{
"query": "query TeamReports(
: ID!
: ISO8601Date!
: ISO8601Date!
) {
teamReports(
teamId:
startDate:
endDate:
first: 20
) {
nodes {
id
state
stateLabel
teamMember {
id
userName
userEmail
}
report {
id
title
startDate
endDate
totalDistance
totalAmount
pdfUrl
}
}
}
}
",
"variables": {
"teamId": "team_123",
"startDate": "2026-01-01",
"endDate": "2026-01-31"
}
}
Response
{
"data": {
"teamReports": {
"nodes": [
{
"id": "team_report_123",
"state": "submitted",
"stateLabel": "Submitted",
"teamMember": {
"id": "team_member_123",
"userName": "Alex Driver",
"userEmail": "alex@example.com"
},
"report": {
"id": "report_123",
"title": "January 2026",
"startDate": "2026-01-01",
"endDate": "2026-01-31",
"totalDistance": 428,
"totalAmount": 312.44,
"pdfUrl": "https://api.driversnote.com/..."
}
}
]
}
}
}
API Endpoints
https://api.driversnote.com/v1/driversnote
Queries
companyInfo
Response
Returns a CompanyInfo!
Example
Query
query companyInfo {
companyInfo {
infoEmail
name
phoneNumber
phoneNumberRaw
}
}
Response
{
"data": {
"companyInfo": {
"infoEmail": "abc123",
"name": "xyz789",
"phoneNumber": "xyz789",
"phoneNumberRaw": "xyz789"
}
}
}
contacts
Description
Returns the Contacts for the User
Response
Returns a ContactConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query contacts(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
contacts(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...ContactEdgeFragment
}
nodes {
...ContactFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123
}
Response
{
"data": {
"contacts": {
"edges": [ContactEdge],
"nodes": [Contact],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
contactsMostRecentlyUsed
Description
Returns the most recently used Contacts for the User
Response
Returns a ContactConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query contactsMostRecentlyUsed(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
contactsMostRecentlyUsed(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...ContactEdgeFragment
}
nodes {
...ContactFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123
}
Response
{
"data": {
"contactsMostRecentlyUsed": {
"edges": [ContactEdge],
"nodes": [Contact],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
}
}
countries
Description
List of Countries
Response
Returns a CountryConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query countries(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
countries(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...CountryEdgeFragment
}
nodes {
...CountryFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"countries": {
"edges": [CountryEdge],
"nodes": [Country],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
country
Description
Returns a Country
Example
Query
query country($id: ID!) {
country(id: $id) {
allowRegistrationNoAlt
boundingBox {
...BoundingBoxFragment
}
currency
currencyFormat {
...CurrencyFormatFragment
}
dateFormat {
...DateFormatFragment
}
distanceUnit
id
name
requiresCustomerRegistrationNo
requiresUserAddress
requiresUserRegistrationNo
shippingMethods {
...ShippingMethodConnectionFragment
}
standardRates {
...RateConnectionFragment
}
states {
...EnumerizeConnectionFragment
}
taxYearEnd
taxYearStart
tripTypes {
...TripTypeConnectionFragment
}
vatChargingEnabled
vatRate
vehicleTypes {
...VehicleTypeConnectionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"country": {
"allowRegistrationNoAlt": true,
"boundingBox": BoundingBox,
"currency": "xyz789",
"currencyFormat": CurrencyFormat,
"dateFormat": DateFormat,
"distanceUnit": "xyz789",
"id": "abc123",
"name": "abc123",
"requiresCustomerRegistrationNo": true,
"requiresUserAddress": false,
"requiresUserRegistrationNo": false,
"shippingMethods": ShippingMethodConnection,
"standardRates": RateConnection,
"states": EnumerizeConnection,
"taxYearEnd": ISO8601Date,
"taxYearStart": ISO8601Date,
"tripTypes": TripTypeConnection,
"vatChargingEnabled": false,
"vatRate": 123.45,
"vehicleTypes": VehicleTypeConnection
}
}
}
csvImportFile
Description
Returns a CsvImportFile by a UUID
Response
Returns a CsvImportFile!
Arguments
| Name | Description |
|---|---|
id - ID!
|
UUID |
Example
Query
query csvImportFile($id: ID!) {
csvImportFile(id: $id) {
createdAt
creatorId
errorCode
id
parentTeamId
progress
resource
rows {
...CsvImportRowConnectionFragment
}
status
updatedAt
}
}
Variables
{"id": "4"}
Response
{
"data": {
"csvImportFile": {
"createdAt": ISO8601DateTime,
"creatorId": 4,
"errorCode": "invalid_csv",
"id": "4",
"parentTeamId": 4,
"progress": 987,
"resource": "abc123",
"rows": CsvImportRowConnection,
"status": "imported",
"updatedAt": ISO8601DateTime
}
}
}
locales
Description
List of locales
Response
Returns [Enumerize!]!
Example
Query
query locales {
locales {
default
id
name
}
}
Response
{
"data": {
"locales": [
{
"default": false,
"id": "4",
"name": "abc123"
}
]
}
}
location
Description
Returns a Location by a UUID
Example
Query
query location($id: ID!) {
location(id: $id) {
address
country {
...CountryFragment
}
dataSource
formattedAddress
id
isPinPosition
lat
lon
name
parentTeamId
postalDistrictString
sourceDataId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"location": {
"address": "xyz789",
"country": Country,
"dataSource": "xyz789",
"formattedAddress": "abc123",
"id": 4,
"isPinPosition": true,
"lat": 987.65,
"lon": 987.65,
"name": "abc123",
"parentTeamId": 4,
"postalDistrictString": "abc123",
"sourceDataId": "xyz789"
}
}
}
locations
Description
Returns the Locations for the User
Response
Returns a LocationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
parentTeamId - ID
|
Filter locations by parent team |
searchPhrase - String
|
Will search for locations which contains the search phrase |
Example
Query
query locations(
$after: String,
$before: String,
$first: Int,
$last: Int,
$parentTeamId: ID,
$searchPhrase: String
) {
locations(
after: $after,
before: $before,
first: $first,
last: $last,
parentTeamId: $parentTeamId,
searchPhrase: $searchPhrase
) {
edges {
...LocationEdgeFragment
}
nodes {
...LocationFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 987,
"parentTeamId": 4,
"searchPhrase": "xyz789"
}
Response
{
"data": {
"locations": {
"edges": [LocationEdge],
"nodes": [Location],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
odometerReading
Description
Returns the Odometer Reading for the ID
Response
Returns an OdometerReading!
Arguments
| Name | Description |
|---|---|
id - ID!
|
UUID |
Example
Query
query odometerReading($id: ID!) {
odometerReading(id: $id) {
id
isInconsistent
readAt
reading
vehicle {
...VehicleFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"odometerReading": {
"id": "4",
"isInconsistent": false,
"readAt": ISO8601DateTime,
"reading": {},
"vehicle": Vehicle
}
}
}
odometerReadings
Description
Returns the Odometer Readings for the Vehicle
Response
Returns an OdometerReadingConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
vehicleId - ID
|
Vehicle ID |
Example
Query
query odometerReadings(
$after: String,
$before: String,
$first: Int,
$last: Int,
$vehicleId: ID
) {
odometerReadings(
after: $after,
before: $before,
first: $first,
last: $last,
vehicleId: $vehicleId
) {
edges {
...OdometerReadingEdgeFragment
}
nodes {
...OdometerReadingFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"vehicleId": "4"
}
Response
{
"data": {
"odometerReadings": {
"edges": [OdometerReadingEdge],
"nodes": [OdometerReading],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
}
}
odometerUsages
Description
Returns options for Odometer Usage on a Vehicle
Response
Returns [Enumerize!]!
Example
Query
query odometerUsages {
odometerUsages {
default
id
name
}
}
Response
{
"data": {
"odometerUsages": [
{
"default": false,
"id": "4",
"name": "abc123"
}
]
}
}
organisation
Description
Returns an Organisation by a UUID
Response
Returns an Organisation!
Arguments
| Name | Description |
|---|---|
id - ID!
|
UUID |
Example
Query
query organisation($id: ID!) {
organisation(id: $id) {
address
currentUserRole {
...RoleFragment
}
id
isArchived
isCalculatingReimbursement
isCurrentlySelected
name
permissions
rates {
...RateConnectionFragment
}
reimbursementMethod {
...ReimbursementMethodFragment
}
reimbursementMethodValue
reimbursementMethods {
...ReimbursementMethodConnectionFragment
}
reportingPeriodSetting {
...ReportingPeriodSettingFragment
}
reportingSetting {
...ReportingSettingFragment
}
tagCategories {
...TagCategoryConnectionFragment
}
teams {
...TeamConnectionFragment
}
trips {
...TripConnectionFragment
}
userRoles {
...RoleConnectionFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"organisation": {
"address": "xyz789",
"currentUserRole": Role,
"id": 4,
"isArchived": false,
"isCalculatingReimbursement": false,
"isCurrentlySelected": true,
"name": "abc123",
"permissions": ["ARCHIVE"],
"rates": RateConnection,
"reimbursementMethod": ReimbursementMethod,
"reimbursementMethodValue": "xyz789",
"reimbursementMethods": ReimbursementMethodConnection,
"reportingPeriodSetting": ReportingPeriodSetting,
"reportingSetting": ReportingSetting,
"tagCategories": TagCategoryConnection,
"teams": TeamConnection,
"trips": TripConnection,
"userRoles": RoleConnection
}
}
}
organisations
Description
Returns the Organisations for the User
Response
Returns an OrganisationConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
excludeTeamOrganisationsIfAdmin - Boolean
|
Filter team organisations if the user is admin. |
first - Int
|
Returns the first n elements from the list. |
hasReimbursementMethod - Boolean
|
Will filter organisations by reimbursement method presence. |
includeParentTeamOrganisations - Boolean
|
Include organisations without role but through a parent team. |
isArchived - Boolean
|
Filter organisations whether they are archived or not. |
last - Int
|
Returns the last n elements from the list. |
roleType - String
|
Will filter organisations by the users role. |
Example
Query
query organisations(
$after: String,
$before: String,
$excludeTeamOrganisationsIfAdmin: Boolean,
$first: Int,
$hasReimbursementMethod: Boolean,
$includeParentTeamOrganisations: Boolean,
$isArchived: Boolean,
$last: Int,
$roleType: String
) {
organisations(
after: $after,
before: $before,
excludeTeamOrganisationsIfAdmin: $excludeTeamOrganisationsIfAdmin,
first: $first,
hasReimbursementMethod: $hasReimbursementMethod,
includeParentTeamOrganisations: $includeParentTeamOrganisations,
isArchived: $isArchived,
last: $last,
roleType: $roleType
) {
edges {
...OrganisationEdgeFragment
}
nodes {
...OrganisationFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"excludeTeamOrganisationsIfAdmin": true,
"first": 987,
"hasReimbursementMethod": true,
"includeParentTeamOrganisations": true,
"isArchived": false,
"last": 987,
"roleType": "abc123"
}
Response
{
"data": {
"organisations": {
"edges": [OrganisationEdge],
"nodes": [Organisation],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
}
}
previewReport
Description
Returns a preview of a Report by given parameters
Response
Returns a ReportPreview!
Arguments
| Name | Description |
|---|---|
endDate - ISO8601Date!
|
Maximum date for Trips |
organisationId - ID!
|
Organisation ID |
showOdometer - Boolean!
|
Show Odometer readings |
startDate - ISO8601Date!
|
Minimum date for Trips |
tagIds - [ID!]
|
Tags to filter by.If specified, a trip must be tagged with at least one of the tags to be included in the report.If not specified, all trips are included. |
tripTypeId - String
|
TripType ID |
vehicleId - ID!
|
Vehicle ID |
Example
Query
query previewReport(
$endDate: ISO8601Date!,
$organisationId: ID!,
$showOdometer: Boolean!,
$startDate: ISO8601Date!,
$tagIds: [ID!],
$tripTypeId: String,
$vehicleId: ID!
) {
previewReport(
endDate: $endDate,
organisationId: $organisationId,
showOdometer: $showOdometer,
startDate: $startDate,
tagIds: $tagIds,
tripTypeId: $tripTypeId,
vehicleId: $vehicleId
) {
endDate
hasArchivedTrips
hasDoubleReportedTrips
hasOdometerInconsistencies
hasOdometerMissing
hasPassedMonthlyLimit
hasProvisionalRate
hasReimbursementMethod
odometerInconsistencies {
...OdometerInconsistencyFragment
}
organisation {
...OrganisationFragment
}
reimbursementMethod
showOdometer
startDate
summaryItems {
...ReportPreviewSummaryItemConnectionFragment
}
tripType {
...TripTypeFragment
}
trips {
...TripConnectionFragment
}
vehicle {
...VehicleFragment
}
}
}
Variables
{
"endDate": ISO8601Date,
"organisationId": "4",
"showOdometer": false,
"startDate": ISO8601Date,
"tagIds": [4],
"tripTypeId": "abc123",
"vehicleId": "4"
}
Response
{
"data": {
"previewReport": {
"endDate": ISO8601Date,
"hasArchivedTrips": true,
"hasDoubleReportedTrips": true,
"hasOdometerInconsistencies": true,
"hasOdometerMissing": true,
"hasPassedMonthlyLimit": true,
"hasProvisionalRate": false,
"hasReimbursementMethod": false,
"odometerInconsistencies": [OdometerInconsistency],
"organisation": Organisation,
"reimbursementMethod": "abc123",
"showOdometer": true,
"startDate": ISO8601Date,
"summaryItems": ReportPreviewSummaryItemConnection,
"tripType": TripType,
"trips": TripConnection,
"vehicle": Vehicle
}
}
}
rates
Description
Returns matching Rates
Response
Returns a RateConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
date - ISO8601Date
|
Date for matching rates |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
organisationId - ID!
|
Organisation ID |
tripTypeId - String
|
TripType ID |
vehicleId - ID!
|
VehicleType ID |
Example
Query
query rates(
$after: String,
$before: String,
$date: ISO8601Date,
$first: Int,
$last: Int,
$organisationId: ID!,
$tripTypeId: String,
$vehicleId: ID!
) {
rates(
after: $after,
before: $before,
date: $date,
first: $first,
last: $last,
organisationId: $organisationId,
tripTypeId: $tripTypeId,
vehicleId: $vehicleId
) {
edges {
...RateEdgeFragment
}
nodes {
...RateFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"date": ISO8601Date,
"first": 123,
"last": 987,
"organisationId": "4",
"tripTypeId": "xyz789",
"vehicleId": 4
}
Response
{
"data": {
"rates": {
"edges": [RateEdge],
"nodes": [Rate],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
}
}
reimbursementMethods
Description
Returns options for ReimbursementMethods for an Organisation
Response
Returns [ReimbursementMethod!]!
Example
Query
query reimbursementMethods {
reimbursementMethods {
default
description
id
name
ratesEmpty
title
}
}
Response
{
"data": {
"reimbursementMethods": [
{
"default": false,
"description": "abc123",
"id": "4",
"name": "abc123",
"ratesEmpty": "xyz789",
"title": "abc123"
}
]
}
}
report
Description
Returns a Report by a UUID
Example
Query
query report($id: ID!) {
report(id: $id) {
createdAt
currency
deletedAt
distanceUnit
duplicateTeamReportTripCount
endDate
excelUrl
hasProvisionalRate
id
integrationActivities {
...IntegrationActivityConnectionFragment
}
isMasked
isReplaced
name
organisation {
...OrganisationFragment
}
organisationAddress
organisationName
outOfScopeReportItems {
...ReportItemConnectionFragment
}
outdatedReportItems {
...ReportItemConnectionFragment
}
pdfUrl
reimbursementMethod
replacedReportId
reportActivities {
...ReportActivityConnectionFragment
}
reportItem {
...ReportItemFragment
}
reportItems {
...ReportItemConnectionFragment
}
reportSettings {
...ReportSettingFragment
}
reportShares {
...ReportShareConnectionFragment
}
reportSummaryItems {
...ReportSummaryItemConnectionFragment
}
showOdometer
startDate
submitOptions {
...SubmitOptionsFragment
}
tags {
...TagConnectionFragment
}
teamReport {
...TeamReportFragment
}
timeZone
title
totalAmount
totalDistance
tripReportIssuesCount
tripTypes {
...TripTypeFragment
}
tripsMissing {
...TripConnectionFragment
}
updatedAt
user {
...TrustedUserFragment
}
userAddress
userName
userRegistrationNo
vehicle {
...VehicleFragment
}
vehicleLicensePlate
vehicleName
}
}
Variables
{"id": 4}
Response
{
"data": {
"report": {
"createdAt": ISO8601DateTime,
"currency": "xyz789",
"deletedAt": ISO8601DateTime,
"distanceUnit": "abc123",
"duplicateTeamReportTripCount": 987,
"endDate": "xyz789",
"excelUrl": "xyz789",
"hasProvisionalRate": false,
"id": "4",
"integrationActivities": IntegrationActivityConnection,
"isMasked": true,
"isReplaced": true,
"name": "abc123",
"organisation": Organisation,
"organisationAddress": "xyz789",
"organisationName": "abc123",
"outOfScopeReportItems": ReportItemConnection,
"outdatedReportItems": ReportItemConnection,
"pdfUrl": "xyz789",
"reimbursementMethod": "abc123",
"replacedReportId": "xyz789",
"reportActivities": ReportActivityConnection,
"reportItem": ReportItem,
"reportItems": ReportItemConnection,
"reportSettings": ReportSetting,
"reportShares": ReportShareConnection,
"reportSummaryItems": ReportSummaryItemConnection,
"showOdometer": true,
"startDate": "abc123",
"submitOptions": SubmitOptions,
"tags": TagConnection,
"teamReport": TeamReport,
"timeZone": "xyz789",
"title": "xyz789",
"totalAmount": 987.65,
"totalDistance": 123,
"tripReportIssuesCount": 123,
"tripTypes": [TripType],
"tripsMissing": TripConnection,
"updatedAt": ISO8601DateTime,
"user": TrustedUser,
"userAddress": "abc123",
"userName": "abc123",
"userRegistrationNo": "xyz789",
"vehicle": Vehicle,
"vehicleLicensePlate": "xyz789",
"vehicleName": "xyz789"
}
}
}
reportPublic
Description
Returns a Report and an optionally related Report Share by a given Token UUID
Response
Returns a ReportPublic
Arguments
| Name | Description |
|---|---|
tokenId - ID!
|
Token UUID |
Example
Query
query reportPublic($tokenId: ID!) {
reportPublic(tokenId: $tokenId) {
excelUrl
id
isDeleted
isReplaced
report {
...ReportFragment
}
reportShare {
...ReportShareFragment
}
}
}
Variables
{"tokenId": "4"}
Response
{
"data": {
"reportPublic": {
"excelUrl": "xyz789",
"id": "4",
"isDeleted": true,
"isReplaced": true,
"report": Report,
"reportShare": ReportShare
}
}
}
reportingPeriodCalculation
Description
Calculates Reporting Periods
Response
Returns a ReportingPeriodCalculation!
Arguments
| Name | Description |
|---|---|
interval - String!
|
Interval of the Reporting Period |
startOn - ISO8601Date!
|
From which day should the Reporting Period begin |
Example
Query
query reportingPeriodCalculation(
$interval: String!,
$startOn: ISO8601Date!
) {
reportingPeriodCalculation(
interval: $interval,
startOn: $startOn
) {
periodEndOn
periodStartOn
}
}
Variables
{
"interval": "xyz789",
"startOn": ISO8601Date
}
Response
{
"data": {
"reportingPeriodCalculation": {
"periodEndOn": ISO8601Date,
"periodStartOn": ISO8601Date
}
}
}
reportingPeriodIntervals
Description
Returns options for Reporting Period intervals on an Organisation
Response
Returns [Enumerize!]!
Example
Query
query reportingPeriodIntervals {
reportingPeriodIntervals {
default
id
name
}
}
Response
{
"data": {
"reportingPeriodIntervals": [
{
"default": true,
"id": 4,
"name": "abc123"
}
]
}
}
reports
Description
Returns a list of the the current Users Reports
Response
Returns a ReportConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query reports(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
reports(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...ReportEdgeFragment
}
nodes {
...ReportFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"last": 987
}
Response
{
"data": {
"reports": {
"edges": [ReportEdge],
"nodes": [Report],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
standardRates
Description
Returns matching Standard Rates
Response
Returns a RateConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
countryId - ID!
|
Country ID |
date - ISO8601Date
|
Date for matching rates |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
sortBy - [QueryStandardRatesSortBy!]
|
Fields to sort the result by |
vehicleTypeId - ID!
|
VehicleType ID |
Example
Query
query standardRates(
$after: String,
$before: String,
$countryId: ID!,
$date: ISO8601Date,
$first: Int,
$last: Int,
$sortBy: [QueryStandardRatesSortBy!],
$vehicleTypeId: ID!
) {
standardRates(
after: $after,
before: $before,
countryId: $countryId,
date: $date,
first: $first,
last: $last,
sortBy: $sortBy,
vehicleTypeId: $vehicleTypeId
) {
edges {
...RateEdgeFragment
}
nodes {
...RateFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"countryId": 4,
"date": ISO8601Date,
"first": 987,
"last": 987,
"sortBy": [QueryStandardRatesSortBy],
"vehicleTypeId": 4
}
Response
{
"data": {
"standardRates": {
"edges": [RateEdge],
"nodes": [Rate],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
}
}
storedAttachment
Description
Returns details about a stored file
Response
Returns a StoredAttachment!
Arguments
| Name | Description |
|---|---|
attachmentName - StoredAttachmentName!
|
Attachment on the model, ie. pdf_file |
scopeId - ID!
|
UUID of the given scope, or access token for ReportShare |
scopeName - StoredAttachmentModel!
|
Relevant scope, ie. Report, TeamReport or ReportShare |
Example
Query
query storedAttachment(
$attachmentName: StoredAttachmentName!,
$scopeId: ID!,
$scopeName: StoredAttachmentModel!
) {
storedAttachment(
attachmentName: $attachmentName,
scopeId: $scopeId,
scopeName: $scopeName
) {
attachmentName
attachmentUrl
report {
...ReportFragment
}
scopeId
scopeName
}
}
Variables
{
"attachmentName": "pdf_file",
"scopeId": "4",
"scopeName": "Report"
}
Response
{
"data": {
"storedAttachment": {
"attachmentName": "pdf_file",
"attachmentUrl": "xyz789",
"report": Report,
"scopeId": "4",
"scopeName": "Report"
}
}
}
tagCategoriesDefault
Description
Get default tag categories
Response
Returns a TagCategoryConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query tagCategoriesDefault(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
tagCategoriesDefault(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...TagCategoryEdgeFragment
}
nodes {
...TagCategoryFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "abc123",
"first": 987,
"last": 123
}
Response
{
"data": {
"tagCategoriesDefault": {
"edges": [TagCategoryEdge],
"nodes": [TagCategory],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
team
Description
Returns a Team
Example
Query
query team($id: ID) {
team(id: $id) {
currentTeamMember {
...TeamMemberFragment
}
customerPermissions
hasCustomer
id
invitationLinks {
...InvitationLinkConnectionFragment
}
name
organisations {
...OrganisationConnectionFragment
}
pendingTeamMembers {
...InvitationConnectionFragment
}
permissions
teamMembers {
...TeamMemberConnectionFragment
}
teamMembersWithoutTeamReport {
...TeamMemberConnectionFragment
}
teamOrganisations {
...TeamOrganisationConnectionFragment
}
teamSubscription {
...TeamSubscriptionFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"team": {
"currentTeamMember": TeamMember,
"customerPermissions": ["ARCHIVE"],
"hasCustomer": false,
"id": "4",
"invitationLinks": InvitationLinkConnection,
"name": "xyz789",
"organisations": OrganisationConnection,
"pendingTeamMembers": InvitationConnection,
"permissions": ["ARCHIVE"],
"teamMembers": TeamMemberConnection,
"teamMembersWithoutTeamReport": TeamMemberConnection,
"teamOrganisations": TeamOrganisationConnection,
"teamSubscription": TeamSubscription
}
}
}
teamMembers
Description
Returns a list of team members for the user id
Response
Returns [TeamMember!]!
Arguments
| Name | Description |
|---|---|
userId - ID!
|
Example
Query
query teamMembers($userId: ID!) {
teamMembers(userId: $userId) {
id
isDeleted
isLastAdmin
isManagerOrAdmin
permissions
role
team {
...TeamFragment
}
userEmail
userHasLicense
userHasTeamLicense
userId
userLastLogin
userName
}
}
Variables
{"userId": "4"}
Response
{
"data": {
"teamMembers": [
{
"id": "4",
"isDeleted": false,
"isLastAdmin": true,
"isManagerOrAdmin": true,
"permissions": ["ARCHIVE"],
"role": "abc123",
"team": Team,
"userEmail": "xyz789",
"userHasLicense": true,
"userHasTeamLicense": false,
"userId": "xyz789",
"userLastLogin": ISO8601DateTime,
"userName": "xyz789"
}
]
}
}
teamReport
Description
Returns a Team Report by a UUID
Response
Returns a TeamReport!
Arguments
| Name | Description |
|---|---|
id - ID!
|
UUID |
Example
Query
query teamReport($id: ID!) {
teamReport(id: $id) {
id
report {
...ReportFragment
}
reviewer {
...ReviewerFragment
}
state
stateLabel
team {
...TeamFragment
}
teamMember {
...TeamMemberFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"teamReport": {
"id": 4,
"report": Report,
"reviewer": Reviewer,
"state": "abc123",
"stateLabel": "abc123",
"team": Team,
"teamMember": TeamMember
}
}
}
teamReportStates
Description
Returns a list of states for Team Reports
Response
Returns [TeamReportState!]!
Example
Query
query teamReportStates {
teamReportStates {
id
label
}
}
Response
{
"data": {
"teamReportStates": [
{
"id": "abc123",
"label": "abc123"
}
]
}
}
teamReports
Description
Returns a list of Teams current Team Reports
Response
Returns a TeamReportConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
endDate - ISO8601Date
|
Filter by Report end date |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
reviewerId - ID
|
Filter by Reviewer Team Member ID |
startDate - ISO8601Date
|
Filter by Report start date |
state - String
|
Filter by Team Report state |
teamId - ID
|
Team ID (defaults to first team) |
teamMemberId - ID
|
Filter by Team Member ID |
Example
Query
query teamReports(
$after: String,
$before: String,
$endDate: ISO8601Date,
$first: Int,
$last: Int,
$reviewerId: ID,
$startDate: ISO8601Date,
$state: String,
$teamId: ID,
$teamMemberId: ID
) {
teamReports(
after: $after,
before: $before,
endDate: $endDate,
first: $first,
last: $last,
reviewerId: $reviewerId,
startDate: $startDate,
state: $state,
teamId: $teamId,
teamMemberId: $teamMemberId
) {
edges {
...TeamReportEdgeFragment
}
nodes {
...TeamReportFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "xyz789",
"endDate": ISO8601Date,
"first": 123,
"last": 123,
"reviewerId": "4",
"startDate": ISO8601Date,
"state": "abc123",
"teamId": "4",
"teamMemberId": "4"
}
Response
{
"data": {
"teamReports": {
"edges": [TeamReportEdge],
"nodes": [TeamReport],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
teams
Description
Returns a list of the the current Users Teams
Response
Returns a TeamConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query teams(
$after: String,
$before: String,
$first: Int,
$last: Int
) {
teams(
after: $after,
before: $before,
first: $first,
last: $last
) {
edges {
...TeamEdgeFragment
}
nodes {
...TeamFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "xyz789",
"before": "xyz789",
"first": 987,
"last": 123
}
Response
{
"data": {
"teams": {
"edges": [TeamEdge],
"nodes": [Team],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
}
}
timeZones
Description
List of time zones
Response
Returns [Enumerize!]!
Example
Query
query timeZones {
timeZones {
default
id
name
}
}
Response
{
"data": {
"timeZones": [
{
"default": true,
"id": 4,
"name": "xyz789"
}
]
}
}
trips
Description
Returns the Trips for the User
Response
Returns a TripConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
endDate - ISO8601Date!
|
Maximum date for Trips |
first - Int
|
Returns the first n elements from the list. |
last - Int
|
Returns the last n elements from the list. |
organisationId - ID
|
Organisation ID |
startDate - ISO8601Date!
|
Minimum date for Trips |
tripTypeId - ID
|
Trip Type ID |
vehicleId - ID
|
Vehicle ID |
Example
Query
query trips(
$after: String,
$before: String,
$endDate: ISO8601Date!,
$first: Int,
$last: Int,
$organisationId: ID,
$startDate: ISO8601Date!,
$tripTypeId: ID,
$vehicleId: ID
) {
trips(
after: $after,
before: $before,
endDate: $endDate,
first: $first,
last: $last,
organisationId: $organisationId,
startDate: $startDate,
tripTypeId: $tripTypeId,
vehicleId: $vehicleId
) {
edges {
...TripEdgeFragment
}
nodes {
...TripFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"endDate": ISO8601Date,
"first": 123,
"last": 123,
"organisationId": "4",
"startDate": ISO8601Date,
"tripTypeId": 4,
"vehicleId": "4"
}
Response
{
"data": {
"trips": {
"edges": [TripEdge],
"nodes": [Trip],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
unreportedTripsOverview
Description
Returns an overview of unreported trips for the user
Response
Returns an UnreportedTripsOverview
Example
Query
query unreportedTripsOverview {
unreportedTripsOverview {
amount
date
distance
}
}
Response
{
"data": {
"unreportedTripsOverview": {
"amount": 123.45,
"date": ISO8601Date,
"distance": 987
}
}
}
vehicle
Description
Returns the Vehicle
Example
Query
query vehicle($id: ID) {
vehicle(id: $id) {
country {
...CountryFragment
}
devices {
...DeviceConnectionFragment
}
id
isArchived
isCurrentlySelected
licensePlate
name
odometerReadings {
...OdometerReadingConnectionFragment
}
odometerUsage {
...EnumerizeFragment
}
tripTypes {
...TripTypeFragment
}
trips {
...TripConnectionFragment
}
vehicleType {
...VehicleTypeFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"vehicle": {
"country": Country,
"devices": DeviceConnection,
"id": 4,
"isArchived": false,
"isCurrentlySelected": false,
"licensePlate": "abc123",
"name": "abc123",
"odometerReadings": OdometerReadingConnection,
"odometerUsage": Enumerize,
"tripTypes": [TripType],
"trips": TripConnection,
"vehicleType": VehicleType
}
}
}
vehicles
Description
Returns the Vehicles for the User
Response
Returns a VehicleConnection!
Arguments
| Name | Description |
|---|---|
after - String
|
Returns the elements in the list that come after the specified cursor. |
before - String
|
Returns the elements in the list that come before the specified cursor. |
first - Int
|
Returns the first n elements from the list. |
isArchived - Boolean
|
Filter vehicles whether they are archived or not. |
last - Int
|
Returns the last n elements from the list. |
Example
Query
query vehicles(
$after: String,
$before: String,
$first: Int,
$isArchived: Boolean,
$last: Int
) {
vehicles(
after: $after,
before: $before,
first: $first,
isArchived: $isArchived,
last: $last
) {
edges {
...VehicleEdgeFragment
}
nodes {
...VehicleFragment
}
pageInfo {
...PageInfoFragment
}
queriedAt
totalCount
}
}
Variables
{
"after": "abc123",
"before": "abc123",
"first": 987,
"isArchived": true,
"last": 123
}
Response
{
"data": {
"vehicles": {
"edges": [VehicleEdge],
"nodes": [Vehicle],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
}
}
Mutations
contactCreate
Response
Returns a ContactCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - ContactCreateMutationInput!
|
Parameters for ContactCreateMutation |
Example
Query
mutation contactCreate($input: ContactCreateMutationInput!) {
contactCreate(input: $input) {
clientMutationId
contact {
...ContactFragment
}
}
}
Variables
{"input": ContactCreateMutationInput}
Response
{
"data": {
"contactCreate": {
"clientMutationId": "abc123",
"contact": Contact
}
}
}
csvImportFileCreate
Response
Returns a CsvImportFileCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - CsvImportFileCreateMutationInput!
|
Parameters for CsvImportFileCreateMutation |
Example
Query
mutation csvImportFileCreate($input: CsvImportFileCreateMutationInput!) {
csvImportFileCreate(input: $input) {
clientMutationId
csvImportFile {
...CsvImportFileFragment
}
}
}
Variables
{"input": CsvImportFileCreateMutationInput}
Response
{
"data": {
"csvImportFileCreate": {
"clientMutationId": "xyz789",
"csvImportFile": CsvImportFile
}
}
}
csvImportFileImport
Response
Returns a CsvImportFileImportMutationPayload
Arguments
| Name | Description |
|---|---|
input - CsvImportFileImportMutationInput!
|
Parameters for CsvImportFileImportMutation |
Example
Query
mutation csvImportFileImport($input: CsvImportFileImportMutationInput!) {
csvImportFileImport(input: $input) {
clientMutationId
csvImportFile {
...CsvImportFileFragment
}
}
}
Variables
{"input": CsvImportFileImportMutationInput}
Response
{
"data": {
"csvImportFileImport": {
"clientMutationId": "abc123",
"csvImportFile": CsvImportFile
}
}
}
locationCreate
Response
Returns a LocationCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - LocationCreateMutationInput!
|
Parameters for LocationCreateMutation |
Example
Query
mutation locationCreate($input: LocationCreateMutationInput!) {
locationCreate(input: $input) {
clientMutationId
location {
...LocationFragment
}
}
}
Variables
{"input": LocationCreateMutationInput}
Response
{
"data": {
"locationCreate": {
"clientMutationId": "xyz789",
"location": Location
}
}
}
locationDelete
Response
Returns a LocationDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - LocationDeleteMutationInput!
|
Parameters for LocationDeleteMutation |
Example
Query
mutation locationDelete($input: LocationDeleteMutationInput!) {
locationDelete(input: $input) {
clientMutationId
location {
...LocationFragment
}
}
}
Variables
{"input": LocationDeleteMutationInput}
Response
{
"data": {
"locationDelete": {
"clientMutationId": "abc123",
"location": Location
}
}
}
locationUpdate
Response
Returns a LocationUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - LocationUpdateMutationInput!
|
Parameters for LocationUpdateMutation |
Example
Query
mutation locationUpdate($input: LocationUpdateMutationInput!) {
locationUpdate(input: $input) {
clientMutationId
location {
...LocationFragment
}
}
}
Variables
{"input": LocationUpdateMutationInput}
Response
{
"data": {
"locationUpdate": {
"clientMutationId": "xyz789",
"location": Location
}
}
}
odometerReadingCreate
Response
Returns an OdometerReadingCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - OdometerReadingCreateMutationInput!
|
Parameters for OdometerReadingCreateMutation |
Example
Query
mutation odometerReadingCreate($input: OdometerReadingCreateMutationInput!) {
odometerReadingCreate(input: $input) {
clientMutationId
odometerReading {
...OdometerReadingFragment
}
}
}
Variables
{"input": OdometerReadingCreateMutationInput}
Response
{
"data": {
"odometerReadingCreate": {
"clientMutationId": "abc123",
"odometerReading": OdometerReading
}
}
}
odometerReadingDelete
Response
Returns an OdometerReadingDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - OdometerReadingDeleteMutationInput!
|
Parameters for OdometerReadingDeleteMutation |
Example
Query
mutation odometerReadingDelete($input: OdometerReadingDeleteMutationInput!) {
odometerReadingDelete(input: $input) {
clientMutationId
odometerReading {
...OdometerReadingFragment
}
}
}
Variables
{"input": OdometerReadingDeleteMutationInput}
Response
{
"data": {
"odometerReadingDelete": {
"clientMutationId": "xyz789",
"odometerReading": OdometerReading
}
}
}
odometerReadingUpdate
Response
Returns an OdometerReadingUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - OdometerReadingUpdateMutationInput!
|
Parameters for OdometerReadingUpdateMutation |
Example
Query
mutation odometerReadingUpdate($input: OdometerReadingUpdateMutationInput!) {
odometerReadingUpdate(input: $input) {
clientMutationId
odometerReading {
...OdometerReadingFragment
}
}
}
Variables
{"input": OdometerReadingUpdateMutationInput}
Response
{
"data": {
"odometerReadingUpdate": {
"clientMutationId": "abc123",
"odometerReading": OdometerReading
}
}
}
organisationArchive
Response
Returns an OrganisationArchiveMutationPayload
Arguments
| Name | Description |
|---|---|
input - OrganisationArchiveMutationInput!
|
Parameters for OrganisationArchiveMutation |
Example
Query
mutation organisationArchive($input: OrganisationArchiveMutationInput!) {
organisationArchive(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": OrganisationArchiveMutationInput}
Response
{
"data": {
"organisationArchive": {
"clientMutationId": "abc123",
"organisation": Organisation
}
}
}
organisationCreate
Response
Returns an OrganisationCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - OrganisationCreateMutationInput!
|
Parameters for OrganisationCreateMutation |
Example
Query
mutation organisationCreate($input: OrganisationCreateMutationInput!) {
organisationCreate(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": OrganisationCreateMutationInput}
Response
{
"data": {
"organisationCreate": {
"clientMutationId": "abc123",
"organisation": Organisation
}
}
}
organisationDelete
Response
Returns an OrganisationDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - OrganisationDeleteMutationInput!
|
Parameters for OrganisationDeleteMutation |
Example
Query
mutation organisationDelete($input: OrganisationDeleteMutationInput!) {
organisationDelete(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": OrganisationDeleteMutationInput}
Response
{
"data": {
"organisationDelete": {
"clientMutationId": "xyz789",
"organisation": Organisation
}
}
}
organisationUnarchive
Response
Returns an OrganisationUnarchiveMutationPayload
Arguments
| Name | Description |
|---|---|
input - OrganisationUnarchiveMutationInput!
|
Parameters for OrganisationUnarchiveMutation |
Example
Query
mutation organisationUnarchive($input: OrganisationUnarchiveMutationInput!) {
organisationUnarchive(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": OrganisationUnarchiveMutationInput}
Response
{
"data": {
"organisationUnarchive": {
"clientMutationId": "abc123",
"organisation": Organisation
}
}
}
organisationUpdate
Response
Returns an OrganisationUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - OrganisationUpdateMutationInput!
|
Parameters for OrganisationUpdateMutation |
Example
Query
mutation organisationUpdate($input: OrganisationUpdateMutationInput!) {
organisationUpdate(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": OrganisationUpdateMutationInput}
Response
{
"data": {
"organisationUpdate": {
"clientMutationId": "abc123",
"organisation": Organisation
}
}
}
rateCreate
Response
Returns a RateCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - RateCreateMutationInput!
|
Parameters for RateCreateMutation |
Example
Query
mutation rateCreate($input: RateCreateMutationInput!) {
rateCreate(input: $input) {
clientMutationId
rate {
...RateFragment
}
}
}
Variables
{"input": RateCreateMutationInput}
Response
{
"data": {
"rateCreate": {
"clientMutationId": "xyz789",
"rate": Rate
}
}
}
rateDelete
Response
Returns a RateDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - RateDeleteMutationInput!
|
Parameters for RateDeleteMutation |
Example
Query
mutation rateDelete($input: RateDeleteMutationInput!) {
rateDelete(input: $input) {
clientMutationId
rate {
...RateFragment
}
}
}
Variables
{"input": RateDeleteMutationInput}
Response
{
"data": {
"rateDelete": {
"clientMutationId": "abc123",
"rate": Rate
}
}
}
rateUpdate
Response
Returns a RateUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - RateUpdateMutationInput!
|
Parameters for RateUpdateMutation |
Example
Query
mutation rateUpdate($input: RateUpdateMutationInput!) {
rateUpdate(input: $input) {
clientMutationId
rate {
...RateFragment
}
}
}
Variables
{"input": RateUpdateMutationInput}
Response
{
"data": {
"rateUpdate": {
"clientMutationId": "xyz789",
"rate": Rate
}
}
}
reportCreate
Response
Returns a ReportCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - ReportCreateMutationInput!
|
Parameters for ReportCreateMutation |
Example
Query
mutation reportCreate($input: ReportCreateMutationInput!) {
reportCreate(input: $input) {
clientMutationId
report {
...ReportFragment
}
}
}
Variables
{"input": ReportCreateMutationInput}
Response
{
"data": {
"reportCreate": {
"clientMutationId": "xyz789",
"report": Report
}
}
}
reportDelete
Response
Returns a ReportDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - ReportDeleteMutationInput!
|
Parameters for ReportDeleteMutation |
Example
Query
mutation reportDelete($input: ReportDeleteMutationInput!) {
reportDelete(input: $input) {
clientMutationId
report {
...ReportFragment
}
}
}
Variables
{"input": ReportDeleteMutationInput}
Response
{
"data": {
"reportDelete": {
"clientMutationId": "abc123",
"report": Report
}
}
}
reportReplace
Response
Returns a ReportReplaceMutationPayload
Arguments
| Name | Description |
|---|---|
input - ReportReplaceMutationInput!
|
Parameters for ReportReplaceMutation |
Example
Query
mutation reportReplace($input: ReportReplaceMutationInput!) {
reportReplace(input: $input) {
clientMutationId
report {
...ReportFragment
}
}
}
Variables
{"input": ReportReplaceMutationInput}
Response
{
"data": {
"reportReplace": {
"clientMutationId": "xyz789",
"report": Report
}
}
}
reportUpdate
Response
Returns a ReportUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - ReportUpdateMutationInput!
|
Parameters for ReportUpdateMutation |
Example
Query
mutation reportUpdate($input: ReportUpdateMutationInput!) {
reportUpdate(input: $input) {
clientMutationId
report {
...ReportFragment
}
}
}
Variables
{"input": ReportUpdateMutationInput}
Response
{
"data": {
"reportUpdate": {
"clientMutationId": "xyz789",
"report": Report
}
}
}
reportingSettingUpdate
Response
Returns a ReportingSettingUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - ReportingSettingUpdateMutationInput!
|
Parameters for ReportingSettingUpdateMutation |
Example
Query
mutation reportingSettingUpdate($input: ReportingSettingUpdateMutationInput!) {
reportingSettingUpdate(input: $input) {
clientMutationId
reportingSetting {
...ReportingSettingFragment
}
}
}
Variables
{"input": ReportingSettingUpdateMutationInput}
Response
{
"data": {
"reportingSettingUpdate": {
"clientMutationId": "xyz789",
"reportingSetting": ReportingSetting
}
}
}
tagCategoryCreate
Response
Returns a TagCategoryCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TagCategoryCreateMutationInput!
|
Parameters for TagCategoryCreateMutation |
Example
Query
mutation tagCategoryCreate($input: TagCategoryCreateMutationInput!) {
tagCategoryCreate(input: $input) {
clientMutationId
tagCategory {
...TagCategoryFragment
}
}
}
Variables
{"input": TagCategoryCreateMutationInput}
Response
{
"data": {
"tagCategoryCreate": {
"clientMutationId": "xyz789",
"tagCategory": TagCategory
}
}
}
tagCategoryDelete
Response
Returns a TagCategoryDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TagCategoryDeleteMutationInput!
|
Parameters for TagCategoryDeleteMutation |
Example
Query
mutation tagCategoryDelete($input: TagCategoryDeleteMutationInput!) {
tagCategoryDelete(input: $input) {
clientMutationId
tagCategory {
...TagCategoryFragment
}
}
}
Variables
{"input": TagCategoryDeleteMutationInput}
Response
{
"data": {
"tagCategoryDelete": {
"clientMutationId": "abc123",
"tagCategory": TagCategory
}
}
}
tagCategoryUpdate
Response
Returns a TagCategoryUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TagCategoryUpdateMutationInput!
|
Parameters for TagCategoryUpdateMutation |
Example
Query
mutation tagCategoryUpdate($input: TagCategoryUpdateMutationInput!) {
tagCategoryUpdate(input: $input) {
clientMutationId
tagCategory {
...TagCategoryFragment
}
}
}
Variables
{"input": TagCategoryUpdateMutationInput}
Response
{
"data": {
"tagCategoryUpdate": {
"clientMutationId": "abc123",
"tagCategory": TagCategory
}
}
}
tagCreate
Response
Returns a TagCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TagCreateMutationInput!
|
Parameters for TagCreateMutation |
Example
Query
mutation tagCreate($input: TagCreateMutationInput!) {
tagCreate(input: $input) {
clientMutationId
tag {
...TagFragment
}
}
}
Variables
{"input": TagCreateMutationInput}
Response
{
"data": {
"tagCreate": {
"clientMutationId": "abc123",
"tag": Tag
}
}
}
tagDelete
Response
Returns a TagDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TagDeleteMutationInput!
|
Parameters for TagDeleteMutation |
Example
Query
mutation tagDelete($input: TagDeleteMutationInput!) {
tagDelete(input: $input) {
clientMutationId
tag {
...TagFragment
}
}
}
Variables
{"input": TagDeleteMutationInput}
Response
{
"data": {
"tagDelete": {
"clientMutationId": "abc123",
"tag": Tag
}
}
}
tagUpdate
Response
Returns a TagUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TagUpdateMutationInput!
|
Parameters for TagUpdateMutation |
Example
Query
mutation tagUpdate($input: TagUpdateMutationInput!) {
tagUpdate(input: $input) {
clientMutationId
tag {
...TagFragment
}
}
}
Variables
{"input": TagUpdateMutationInput}
Response
{
"data": {
"tagUpdate": {
"clientMutationId": "xyz789",
"tag": Tag
}
}
}
teamCreate
Response
Returns a TeamCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamCreateMutationInput!
|
Parameters for TeamCreateMutation |
Example
Query
mutation teamCreate($input: TeamCreateMutationInput!) {
teamCreate(input: $input) {
clientMutationId
team {
...TeamFragment
}
}
}
Variables
{"input": TeamCreateMutationInput}
Response
{
"data": {
"teamCreate": {
"clientMutationId": "xyz789",
"team": Team
}
}
}
teamDelete
Response
Returns a TeamDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamDeleteMutationInput!
|
Parameters for TeamDeleteMutation |
Example
Query
mutation teamDelete($input: TeamDeleteMutationInput!) {
teamDelete(input: $input) {
clientMutationId
team {
...TeamFragment
}
}
}
Variables
{"input": TeamDeleteMutationInput}
Response
{
"data": {
"teamDelete": {
"clientMutationId": "xyz789",
"team": Team
}
}
}
teamInvite
Response
Returns a TeamInviteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamInviteMutationInput!
|
Parameters for TeamInviteMutation |
Example
Query
mutation teamInvite($input: TeamInviteMutationInput!) {
teamInvite(input: $input) {
clientMutationId
invitation {
...InvitationFragment
}
}
}
Variables
{"input": TeamInviteMutationInput}
Response
{
"data": {
"teamInvite": {
"clientMutationId": "abc123",
"invitation": Invitation
}
}
}
teamInviteDelete
Response
Returns a TeamInviteDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamInviteDeleteMutationInput!
|
Parameters for TeamInviteDeleteMutation |
Example
Query
mutation teamInviteDelete($input: TeamInviteDeleteMutationInput!) {
teamInviteDelete(input: $input) {
clientMutationId
invitation {
...InvitationFragment
}
}
}
Variables
{"input": TeamInviteDeleteMutationInput}
Response
{
"data": {
"teamInviteDelete": {
"clientMutationId": "abc123",
"invitation": Invitation
}
}
}
teamInviteResend
Response
Returns a TeamInviteResendMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamInviteResendMutationInput!
|
Parameters for TeamInviteResendMutation |
Example
Query
mutation teamInviteResend($input: TeamInviteResendMutationInput!) {
teamInviteResend(input: $input) {
clientMutationId
invitation {
...InvitationFragment
}
}
}
Variables
{"input": TeamInviteResendMutationInput}
Response
{
"data": {
"teamInviteResend": {
"clientMutationId": "abc123",
"invitation": Invitation
}
}
}
teamMemberBulkUpsert
Response
Returns a TeamMemberBulkUpsertMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamMemberBulkUpsertMutationInput!
|
Parameters for TeamMemberBulkUpsertMutation |
Example
Query
mutation teamMemberBulkUpsert($input: TeamMemberBulkUpsertMutationInput!) {
teamMemberBulkUpsert(input: $input) {
clientMutationId
teamMembers {
...TeamMemberFragment
}
}
}
Variables
{"input": TeamMemberBulkUpsertMutationInput}
Response
{
"data": {
"teamMemberBulkUpsert": {
"clientMutationId": "xyz789",
"teamMembers": [TeamMember]
}
}
}
teamMemberDelete
Response
Returns a TeamMemberDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamMemberDeleteMutationInput!
|
Parameters for TeamMemberDeleteMutation |
Example
Query
mutation teamMemberDelete($input: TeamMemberDeleteMutationInput!) {
teamMemberDelete(input: $input) {
clientMutationId
teamMember {
...TeamMemberFragment
}
}
}
Variables
{"input": TeamMemberDeleteMutationInput}
Response
{
"data": {
"teamMemberDelete": {
"clientMutationId": "abc123",
"teamMember": TeamMember
}
}
}
teamMemberUpdateRole
Response
Returns a TeamMemberUpdateRoleMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamMemberUpdateRoleMutationInput!
|
Parameters for TeamMemberUpdateRoleMutation |
Example
Query
mutation teamMemberUpdateRole($input: TeamMemberUpdateRoleMutationInput!) {
teamMemberUpdateRole(input: $input) {
clientMutationId
teamMember {
...TeamMemberFragment
}
}
}
Variables
{"input": TeamMemberUpdateRoleMutationInput}
Response
{
"data": {
"teamMemberUpdateRole": {
"clientMutationId": "abc123",
"teamMember": TeamMember
}
}
}
teamMemberUpsert
Response
Returns a TeamMemberUpsertMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamMemberUpsertMutationInput!
|
Parameters for TeamMemberUpsertMutation |
Example
Query
mutation teamMemberUpsert($input: TeamMemberUpsertMutationInput!) {
teamMemberUpsert(input: $input) {
clientMutationId
teamMember {
...TeamMemberFragment
}
}
}
Variables
{"input": TeamMemberUpsertMutationInput}
Response
{
"data": {
"teamMemberUpsert": {
"clientMutationId": "xyz789",
"teamMember": TeamMember
}
}
}
teamReportApprove
Response
Returns a TeamReportApproveMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamReportApproveMutationInput!
|
Parameters for TeamReportApproveMutation |
Example
Query
mutation teamReportApprove($input: TeamReportApproveMutationInput!) {
teamReportApprove(input: $input) {
clientMutationId
teamReport {
...TeamReportFragment
}
}
}
Variables
{"input": TeamReportApproveMutationInput}
Response
{
"data": {
"teamReportApprove": {
"clientMutationId": "abc123",
"teamReport": TeamReport
}
}
}
teamReportProcess
Response
Returns a TeamReportProcessMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamReportProcessMutationInput!
|
Parameters for TeamReportProcessMutation |
Example
Query
mutation teamReportProcess($input: TeamReportProcessMutationInput!) {
teamReportProcess(input: $input) {
clientMutationId
teamReport {
...TeamReportFragment
}
}
}
Variables
{"input": TeamReportProcessMutationInput}
Response
{
"data": {
"teamReportProcess": {
"clientMutationId": "abc123",
"teamReport": TeamReport
}
}
}
teamReportReject
Response
Returns a TeamReportRejectMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamReportRejectMutationInput!
|
Parameters for TeamReportRejectMutation |
Example
Query
mutation teamReportReject($input: TeamReportRejectMutationInput!) {
teamReportReject(input: $input) {
clientMutationId
teamReport {
...TeamReportFragment
}
}
}
Variables
{"input": TeamReportRejectMutationInput}
Response
{
"data": {
"teamReportReject": {
"clientMutationId": "abc123",
"teamReport": TeamReport
}
}
}
teamReportSubmit
Response
Returns a TeamReportSubmitMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamReportSubmitMutationInput!
|
Parameters for TeamReportSubmitMutation |
Example
Query
mutation teamReportSubmit($input: TeamReportSubmitMutationInput!) {
teamReportSubmit(input: $input) {
clientMutationId
teamReport {
...TeamReportFragment
}
}
}
Variables
{"input": TeamReportSubmitMutationInput}
Response
{
"data": {
"teamReportSubmit": {
"clientMutationId": "xyz789",
"teamReport": TeamReport
}
}
}
teamReportWithdraw
Response
Returns a TeamReportWithdrawMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamReportWithdrawMutationInput!
|
Parameters for TeamReportWithdrawMutation |
Example
Query
mutation teamReportWithdraw($input: TeamReportWithdrawMutationInput!) {
teamReportWithdraw(input: $input) {
clientMutationId
teamReport {
...TeamReportFragment
}
}
}
Variables
{"input": TeamReportWithdrawMutationInput}
Response
{
"data": {
"teamReportWithdraw": {
"clientMutationId": "xyz789",
"teamReport": TeamReport
}
}
}
teamUpdate
Response
Returns a TeamUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TeamUpdateMutationInput!
|
Parameters for TeamUpdateMutation |
Example
Query
mutation teamUpdate($input: TeamUpdateMutationInput!) {
teamUpdate(input: $input) {
clientMutationId
team {
...TeamFragment
}
}
}
Variables
{"input": TeamUpdateMutationInput}
Response
{
"data": {
"teamUpdate": {
"clientMutationId": "abc123",
"team": Team
}
}
}
tripBulkDelete
Response
Returns a TripBulkDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripBulkDeleteMutationInput!
|
Parameters for TripBulkDeleteMutation |
Example
Query
mutation tripBulkDelete($input: TripBulkDeleteMutationInput!) {
tripBulkDelete(input: $input) {
clientMutationId
trips {
...TripConnectionFragment
}
}
}
Variables
{"input": TripBulkDeleteMutationInput}
Response
{
"data": {
"tripBulkDelete": {
"clientMutationId": "xyz789",
"trips": TripConnection
}
}
}
tripBulkRestore
Response
Returns a TripBulkRestoreMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripBulkRestoreMutationInput!
|
Parameters for TripBulkRestoreMutation |
Example
Query
mutation tripBulkRestore($input: TripBulkRestoreMutationInput!) {
tripBulkRestore(input: $input) {
clientMutationId
trips {
...TripConnectionFragment
}
}
}
Variables
{"input": TripBulkRestoreMutationInput}
Response
{
"data": {
"tripBulkRestore": {
"clientMutationId": "abc123",
"trips": TripConnection
}
}
}
tripBulkUpdate
Response
Returns a TripBulkUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripBulkUpdateMutationInput!
|
Parameters for TripBulkUpdateMutation |
Example
Query
mutation tripBulkUpdate($input: TripBulkUpdateMutationInput!) {
tripBulkUpdate(input: $input) {
clientMutationId
trips {
...TripConnectionFragment
}
}
}
Variables
{"input": TripBulkUpdateMutationInput}
Response
{
"data": {
"tripBulkUpdate": {
"clientMutationId": "xyz789",
"trips": TripConnection
}
}
}
tripCreate
Response
Returns a TripCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripCreateMutationInput!
|
Parameters for TripCreateMutation |
Example
Query
mutation tripCreate($input: TripCreateMutationInput!) {
tripCreate(input: $input) {
clientMutationId
trip {
...TripFragment
}
}
}
Variables
{"input": TripCreateMutationInput}
Response
{
"data": {
"tripCreate": {
"clientMutationId": "xyz789",
"trip": Trip
}
}
}
tripDelete
Response
Returns a TripDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripDeleteMutationInput!
|
Parameters for TripDeleteMutation |
Example
Query
mutation tripDelete($input: TripDeleteMutationInput!) {
tripDelete(input: $input) {
clientMutationId
trip {
...TripFragment
}
}
}
Variables
{"input": TripDeleteMutationInput}
Response
{
"data": {
"tripDelete": {
"clientMutationId": "abc123",
"trip": Trip
}
}
}
tripRestore
Response
Returns a TripRestoreMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripRestoreMutationInput!
|
Parameters for TripRestoreMutation |
Example
Query
mutation tripRestore($input: TripRestoreMutationInput!) {
tripRestore(input: $input) {
clientMutationId
trip {
...TripFragment
}
}
}
Variables
{"input": TripRestoreMutationInput}
Response
{
"data": {
"tripRestore": {
"clientMutationId": "abc123",
"trip": Trip
}
}
}
tripUpdate
Response
Returns a TripUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - TripUpdateMutationInput!
|
Parameters for TripUpdateMutation |
Example
Query
mutation tripUpdate($input: TripUpdateMutationInput!) {
tripUpdate(input: $input) {
clientMutationId
trip {
...TripFragment
}
}
}
Variables
{"input": TripUpdateMutationInput}
Response
{
"data": {
"tripUpdate": {
"clientMutationId": "abc123",
"trip": Trip
}
}
}
vehicleArchive
Response
Returns a VehicleArchiveMutationPayload
Arguments
| Name | Description |
|---|---|
input - VehicleArchiveMutationInput!
|
Parameters for VehicleArchiveMutation |
Example
Query
mutation vehicleArchive($input: VehicleArchiveMutationInput!) {
vehicleArchive(input: $input) {
clientMutationId
vehicle {
...VehicleFragment
}
}
}
Variables
{"input": VehicleArchiveMutationInput}
Response
{
"data": {
"vehicleArchive": {
"clientMutationId": "xyz789",
"vehicle": Vehicle
}
}
}
vehicleCreate
Response
Returns a VehicleCreateMutationPayload
Arguments
| Name | Description |
|---|---|
input - VehicleCreateMutationInput!
|
Parameters for VehicleCreateMutation |
Example
Query
mutation vehicleCreate($input: VehicleCreateMutationInput!) {
vehicleCreate(input: $input) {
clientMutationId
vehicle {
...VehicleFragment
}
}
}
Variables
{"input": VehicleCreateMutationInput}
Response
{
"data": {
"vehicleCreate": {
"clientMutationId": "xyz789",
"vehicle": Vehicle
}
}
}
vehicleDelete
Response
Returns a VehicleDeleteMutationPayload
Arguments
| Name | Description |
|---|---|
input - VehicleDeleteMutationInput!
|
Parameters for VehicleDeleteMutation |
Example
Query
mutation vehicleDelete($input: VehicleDeleteMutationInput!) {
vehicleDelete(input: $input) {
clientMutationId
vehicle {
...VehicleFragment
}
}
}
Variables
{"input": VehicleDeleteMutationInput}
Response
{
"data": {
"vehicleDelete": {
"clientMutationId": "abc123",
"vehicle": Vehicle
}
}
}
vehicleUnarchive
Response
Returns a VehicleUnarchiveMutationPayload
Arguments
| Name | Description |
|---|---|
input - VehicleUnarchiveMutationInput!
|
Parameters for VehicleUnarchiveMutation |
Example
Query
mutation vehicleUnarchive($input: VehicleUnarchiveMutationInput!) {
vehicleUnarchive(input: $input) {
clientMutationId
vehicle {
...VehicleFragment
}
}
}
Variables
{"input": VehicleUnarchiveMutationInput}
Response
{
"data": {
"vehicleUnarchive": {
"clientMutationId": "xyz789",
"vehicle": Vehicle
}
}
}
vehicleUpdate
Response
Returns a VehicleUpdateMutationPayload
Arguments
| Name | Description |
|---|---|
input - VehicleUpdateMutationInput!
|
Parameters for VehicleUpdateMutation |
Example
Query
mutation vehicleUpdate($input: VehicleUpdateMutationInput!) {
vehicleUpdate(input: $input) {
clientMutationId
vehicle {
...VehicleFragment
}
}
}
Variables
{"input": VehicleUpdateMutationInput}
Response
{
"data": {
"vehicleUpdate": {
"clientMutationId": "abc123",
"vehicle": Vehicle
}
}
}
Types
BigInt
Description
Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it's encoded as a string.
Example
{}
Boolean
Description
The Boolean scalar type represents true or false.
BoundingBox
Fields
| Field Name | Description |
|---|---|
ne - Coordinate!
|
|
sw - Coordinate!
|
Example
{"ne": Coordinate, "sw": Coordinate}
CompanyInfo
Contact
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creationContext - CreationContext!
|
|
email - String
|
|
id - ID!
|
|
isTeamMember - Boolean!
|
|
name - String
|
|
role - String
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"creationContext": "report_share",
"email": "abc123",
"id": "4",
"isTeamMember": false,
"name": "abc123",
"role": "xyz789",
"updatedAt": ISO8601DateTime
}
ContactConnection
Description
The connection type for Contact.
Fields
| Field Name | Description |
|---|---|
edges - [ContactEdge]
|
A list of edges. |
nodes - [Contact]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ContactEdge],
"nodes": [Contact],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
ContactCreateAttributes
Description
Attributes for creating a Contact
Fields
| Input Field | Description |
|---|---|
creationContext - CreationContext!
|
|
email - String!
|
|
name - String!
|
|
role - String
|
Example
{
"creationContext": "report_share",
"email": "xyz789",
"name": "abc123",
"role": "abc123"
}
ContactCreateMutationInput
Description
Autogenerated input type of ContactCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - ContactCreateAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"attributes": ContactCreateAttributes,
"clientMutationId": "xyz789"
}
ContactCreateMutationPayload
ContactEdge
Coordinate
Country
Fields
| Field Name | Description |
|---|---|
allowRegistrationNoAlt - Boolean!
|
|
boundingBox - BoundingBox
|
|
currency - String!
|
|
currencyFormat - CurrencyFormat!
|
|
dateFormat - DateFormat!
|
|
distanceUnit - String!
|
|
id - String!
|
|
name - String!
|
|
requiresCustomerRegistrationNo - Boolean!
|
|
requiresUserAddress - Boolean!
|
|
requiresUserRegistrationNo - Boolean!
|
|
shippingMethods - ShippingMethodConnection!
|
|
standardRates - RateConnection!
|
|
Arguments
|
|
states - EnumerizeConnection!
|
|
taxYearEnd - ISO8601Date!
|
|
taxYearStart - ISO8601Date!
|
|
tripTypes - TripTypeConnection!
|
|
vatChargingEnabled - Boolean!
|
|
vatRate - Float!
|
|
vehicleTypes - VehicleTypeConnection!
|
|
Example
{
"allowRegistrationNoAlt": false,
"boundingBox": BoundingBox,
"currency": "abc123",
"currencyFormat": CurrencyFormat,
"dateFormat": DateFormat,
"distanceUnit": "xyz789",
"id": "abc123",
"name": "xyz789",
"requiresCustomerRegistrationNo": false,
"requiresUserAddress": false,
"requiresUserRegistrationNo": true,
"shippingMethods": ShippingMethodConnection,
"standardRates": RateConnection,
"states": EnumerizeConnection,
"taxYearEnd": ISO8601Date,
"taxYearStart": ISO8601Date,
"tripTypes": TripTypeConnection,
"vatChargingEnabled": true,
"vatRate": 987.65,
"vehicleTypes": VehicleTypeConnection
}
CountryConnection
Description
The connection type for Country.
Fields
| Field Name | Description |
|---|---|
edges - [CountryEdge]
|
A list of edges. |
nodes - [Country]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [CountryEdge],
"nodes": [Country],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
CountryEdge
CountryStandardRatesSortBy
CreationContext
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"report_share"
CsvImportFile
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creatorId - ID!
|
|
errorCode - CsvImportFileErrorCode
|
|
id - ID!
|
|
parentTeamId - ID!
|
|
progress - Int
|
Percentage of work done. Is only present if status is 'validating' or 'importing' |
resource - String!
|
|
rows - CsvImportRowConnection
|
|
status - CsvImportFileStatus!
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"createdAt": ISO8601DateTime,
"creatorId": "4",
"errorCode": "invalid_csv",
"id": "4",
"parentTeamId": "4",
"progress": 987,
"resource": "xyz789",
"rows": CsvImportRowConnection,
"status": "imported",
"updatedAt": ISO8601DateTime
}
CsvImportFileCreateMutationInput
Description
Autogenerated input type of CsvImportFileCreateMutation
Example
{
"clientMutationId": "xyz789",
"fileContent": "abc123",
"parentTeamId": 4,
"resource": "xyz789"
}
CsvImportFileCreateMutationPayload
Description
Autogenerated return type of CsvImportFileCreateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
csvImportFile - CsvImportFile
|
Example
{
"clientMutationId": "abc123",
"csvImportFile": CsvImportFile
}
CsvImportFileErrorCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"invalid_csv"
CsvImportFileImportMutationInput
CsvImportFileImportMutationPayload
Description
Autogenerated return type of CsvImportFileImportMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
csvImportFile - CsvImportFile
|
Example
{
"clientMutationId": "xyz789",
"csvImportFile": CsvImportFile
}
CsvImportFileStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"imported"
CsvImportRow
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
fileId - ID!
|
|
id - ID!
|
|
localizedErrors - JSON
|
|
processedData - JSON
|
|
rawData - JSON
|
|
rowIndex - Int!
|
|
status - CsvImportRowStatus!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"fileId": "4",
"id": 4,
"localizedErrors": {},
"processedData": {},
"rawData": {},
"rowIndex": 123,
"status": "import_failed",
"updatedAt": ISO8601DateTime
}
CsvImportRowConnection
Description
The connection type for CsvImportRow.
Fields
| Field Name | Description |
|---|---|
edges - [CsvImportRowEdge]
|
A list of edges. |
nodes - [CsvImportRow]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [CsvImportRowEdge],
"nodes": [CsvImportRow],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
CsvImportRowEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - CsvImportRow
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": CsvImportRow
}
CsvImportRowStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"import_failed"
CurrencyFormat
DateFormat
Fields
| Field Name | Description |
|---|---|
js - String!
|
This is not reliable, use locale to figure it out instead |
Example
{"js": "abc123"}
Device
DeviceConnection
Description
The connection type for Device.
Fields
| Field Name | Description |
|---|---|
edges - [DeviceEdge]
|
A list of edges. |
nodes - [Device]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [DeviceEdge],
"nodes": [Device],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
DeviceEdge
Enumerize
EnumerizeConnection
Description
The connection type for Enumerize.
Fields
| Field Name | Description |
|---|---|
edges - [EnumerizeEdge]
|
A list of edges. |
nodes - [Enumerize]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [EnumerizeEdge],
"nodes": [Enumerize],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
EnumerizeEdge
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
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"
ISO8601Date
Description
ISO8601 format restricted to the years between and including 1000 and 9999
Example
ISO8601Date
ISO8601DateTime
Description
ISO8601 format restricted to the years between and including 1000 and 9999
Example
ISO8601DateTime
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
IntegrationActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
text - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"text": "abc123",
"updatedAt": ISO8601DateTime
}
IntegrationActivityConnection
Description
The connection type for IntegrationActivity.
Fields
| Field Name | Description |
|---|---|
edges - [IntegrationActivityEdge]
|
A list of edges. |
nodes - [IntegrationActivity]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [IntegrationActivityEdge],
"nodes": [IntegrationActivity],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
IntegrationActivityEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - IntegrationActivity
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": IntegrationActivity
}
Invitation
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
recipientEmail - String!
|
|
recipientName - String
|
|
roleType - Enumerize!
|
|
roleTypeValue - TeamMemberRole!
|
Example
{
"id": 4,
"recipientEmail": "abc123",
"recipientName": "abc123",
"roleType": Enumerize,
"roleTypeValue": "admin"
}
InvitationConnection
Description
The connection type for Invitation.
Fields
| Field Name | Description |
|---|---|
edges - [InvitationEdge]
|
A list of edges. |
nodes - [Invitation]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [InvitationEdge],
"nodes": [Invitation],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
InvitationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Invitation
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": Invitation
}
InvitationLink
Fields
| Field Name | Description |
|---|---|
creator - PublicUser
|
|
id - ID!
|
|
roleType - String!
|
|
team - Team!
|
|
token - String!
|
Example
{
"creator": PublicUser,
"id": "4",
"roleType": "xyz789",
"team": Team,
"token": "abc123"
}
InvitationLinkConnection
Description
The connection type for InvitationLink.
Fields
| Field Name | Description |
|---|---|
edges - [InvitationLinkEdge]
|
A list of edges. |
nodes - [InvitationLink]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [InvitationLinkEdge],
"nodes": [InvitationLink],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
InvitationLinkEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - InvitationLink
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": InvitationLink
}
JSON
Description
Represents untyped JSON
Example
{}
Location
Example
{
"address": "abc123",
"country": Country,
"dataSource": "xyz789",
"formattedAddress": "abc123",
"id": "4",
"isPinPosition": false,
"lat": 987.65,
"lon": 123.45,
"name": "xyz789",
"parentTeamId": 4,
"postalDistrictString": "xyz789",
"sourceDataId": "xyz789"
}
LocationAttributes
Description
Attributes for creating or updating an Location
Example
{
"address": "abc123",
"countryId": "xyz789",
"dataSource": "xyz789",
"formattedAddress": "abc123",
"isPinPosition": false,
"lat": 987.65,
"lon": 987.65,
"name": "xyz789",
"postalDistrictString": "abc123",
"sourceDataId": "abc123"
}
LocationConnection
Description
The connection type for Location.
Fields
| Field Name | Description |
|---|---|
edges - [LocationEdge]
|
A list of edges. |
nodes - [Location]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [LocationEdge],
"nodes": [Location],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
LocationCreateMutationInput
Description
Autogenerated input type of LocationCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - LocationAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
parentTeamId - ID
|
Example
{
"attributes": LocationAttributes,
"clientMutationId": "abc123",
"parentTeamId": "4"
}
LocationCreateMutationPayload
LocationDeleteMutationInput
LocationDeleteMutationPayload
LocationEdge
LocationUpdateMutationInput
Description
Autogenerated input type of LocationUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - LocationAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": LocationAttributes,
"clientMutationId": "xyz789",
"id": 4
}
LocationUpdateMutationPayload
OdometerInconsistency
Fields
| Field Name | Description |
|---|---|
distanceDeviation - BigInt
|
|
startReading - OdometerReading!
|
|
stopReading - OdometerReading!
|
Example
{
"distanceDeviation": {},
"startReading": OdometerReading,
"stopReading": OdometerReading
}
OdometerReading
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
isInconsistent - Boolean
|
|
readAt - ISO8601DateTime!
|
|
reading - BigInt!
|
|
vehicle - Vehicle!
|
Example
{
"id": 4,
"isInconsistent": true,
"readAt": ISO8601DateTime,
"reading": {},
"vehicle": Vehicle
}
OdometerReadingAttributes
OdometerReadingConnection
Description
The connection type for OdometerReading.
Fields
| Field Name | Description |
|---|---|
edges - [OdometerReadingEdge]
|
A list of edges. |
nodes - [OdometerReading]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [OdometerReadingEdge],
"nodes": [OdometerReading],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
OdometerReadingCreateMutationInput
Description
Autogenerated input type of OdometerReadingCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - OdometerReadingAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"attributes": OdometerReadingAttributes,
"clientMutationId": "xyz789"
}
OdometerReadingCreateMutationPayload
Description
Autogenerated return type of OdometerReadingCreateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
odometerReading - OdometerReading
|
Example
{
"clientMutationId": "abc123",
"odometerReading": OdometerReading
}
OdometerReadingDeleteMutationInput
OdometerReadingDeleteMutationPayload
Description
Autogenerated return type of OdometerReadingDeleteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
odometerReading - OdometerReading
|
Example
{
"clientMutationId": "xyz789",
"odometerReading": OdometerReading
}
OdometerReadingEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - OdometerReading
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": OdometerReading
}
OdometerReadingUpdateMutationInput
Description
Autogenerated input type of OdometerReadingUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - OdometerReadingAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": OdometerReadingAttributes,
"clientMutationId": "xyz789",
"id": 4
}
OdometerReadingUpdateMutationPayload
Description
Autogenerated return type of OdometerReadingUpdateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
odometerReading - OdometerReading
|
Example
{
"clientMutationId": "xyz789",
"odometerReading": OdometerReading
}
Organisation
Fields
| Field Name | Description |
|---|---|
address - String
|
|
currentUserRole - Role
|
|
id - ID!
|
|
isArchived - Boolean
|
|
isCalculatingReimbursement - Boolean
|
|
isCurrentlySelected - Boolean!
|
Organisation currently selected in Session |
name - String
|
|
permissions - [Permission!]!
|
|
rates - RateConnection!
|
|
reimbursementMethod - ReimbursementMethod
|
|
reimbursementMethodValue - String
|
|
reimbursementMethods - ReimbursementMethodConnection!
|
Use reimbursementMethods in root Query |
reportingPeriodSetting - ReportingPeriodSetting
|
Use reportingSetting instead |
reportingSetting - ReportingSetting
|
|
tagCategories - TagCategoryConnection!
|
|
Arguments
|
|
teams - TeamConnection!
|
|
trips - TripConnection!
|
The Users trips on the Organisation |
userRoles - RoleConnection!
|
|
Example
{
"address": "xyz789",
"currentUserRole": Role,
"id": "4",
"isArchived": false,
"isCalculatingReimbursement": true,
"isCurrentlySelected": false,
"name": "xyz789",
"permissions": ["ARCHIVE"],
"rates": RateConnection,
"reimbursementMethod": ReimbursementMethod,
"reimbursementMethodValue": "abc123",
"reimbursementMethods": ReimbursementMethodConnection,
"reportingPeriodSetting": ReportingPeriodSetting,
"reportingSetting": ReportingSetting,
"tagCategories": TagCategoryConnection,
"teams": TeamConnection,
"trips": TripConnection,
"userRoles": RoleConnection
}
OrganisationArchiveMutationInput
OrganisationArchiveMutationPayload
Description
Autogenerated return type of OrganisationArchiveMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation
|
Example
{
"clientMutationId": "xyz789",
"organisation": Organisation
}
OrganisationAttributes
OrganisationConnection
Description
The connection type for Organisation.
Fields
| Field Name | Description |
|---|---|
edges - [OrganisationEdge]
|
A list of edges. |
nodes - [Organisation]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [OrganisationEdge],
"nodes": [Organisation],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
OrganisationCreateMutationInput
Description
Autogenerated input type of OrganisationCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - OrganisationAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"attributes": OrganisationAttributes,
"clientMutationId": "xyz789"
}
OrganisationCreateMutationPayload
Description
Autogenerated return type of OrganisationCreateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation
|
Example
{
"clientMutationId": "xyz789",
"organisation": Organisation
}
OrganisationDeleteMutationInput
OrganisationDeleteMutationPayload
Description
Autogenerated return type of OrganisationDeleteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation
|
Example
{
"clientMutationId": "xyz789",
"organisation": Organisation
}
OrganisationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - Organisation
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": Organisation
}
OrganisationTagCategoriesSortBy
OrganisationUnarchiveMutationInput
OrganisationUnarchiveMutationPayload
Description
Autogenerated return type of OrganisationUnarchiveMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation
|
Example
{
"clientMutationId": "abc123",
"organisation": Organisation
}
OrganisationUpdateMutationInput
Description
Autogenerated input type of OrganisationUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - OrganisationAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID
|
Example
{
"attributes": OrganisationAttributes,
"clientMutationId": "xyz789",
"id": "4"
}
OrganisationUpdateMutationPayload
Description
Autogenerated return type of OrganisationUpdateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation
|
Example
{
"clientMutationId": "xyz789",
"organisation": Organisation
}
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
endCursor - String
|
When paginating forwards, the cursor to continue. |
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
Example
{
"endCursor": "abc123",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789"
}
ParanoiaDeleted
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"only_deleted"
Permission
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARCHIVE"
PublicUser
QueryStandardRatesSortBy
Rate
Fields
| Field Name | Description |
|---|---|
amount - Float!
|
|
country - Country!
|
|
dateMax - ISO8601Date!
|
|
dateMin - ISO8601Date!
|
|
distanceMax - Int
|
|
distanceMin - Int
|
|
distanceName - String
|
|
id - String!
|
|
isProvisional - Boolean!
|
|
name - String!
|
|
organisation - Organisation
|
|
tripType - TripType!
|
|
vehicleType - VehicleType
|
Example
{
"amount": 123.45,
"country": Country,
"dateMax": ISO8601Date,
"dateMin": ISO8601Date,
"distanceMax": 987,
"distanceMin": 123,
"distanceName": "abc123",
"id": "xyz789",
"isProvisional": false,
"name": "abc123",
"organisation": Organisation,
"tripType": TripType,
"vehicleType": VehicleType
}
RateAttributes
Description
Attributes for creating or updating a Rate
Example
{
"amount": 987.65,
"countryId": "abc123",
"dateMax": "xyz789",
"dateMin": "xyz789",
"distanceMax": 987,
"distanceMin": 987,
"tripTypeId": "xyz789",
"vehicleTypeId": "abc123"
}
RateConnection
Description
The connection type for Rate.
Fields
| Field Name | Description |
|---|---|
edges - [RateEdge]
|
A list of edges. |
nodes - [Rate]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [RateEdge],
"nodes": [Rate],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
RateCreateMutationInput
Description
Autogenerated input type of RateCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - RateAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisationId - ID
|
Example
{
"attributes": RateAttributes,
"clientMutationId": "xyz789",
"organisationId": "4"
}
RateCreateMutationPayload
RateDeleteMutationInput
RateDeleteMutationPayload
RateEdge
RateUpdateMutationInput
Description
Autogenerated input type of RateUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - RateAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": RateAttributes,
"clientMutationId": "xyz789",
"id": 4
}
RateUpdateMutationPayload
ReimbursementMethod
ReimbursementMethodConnection
Description
The connection type for ReimbursementMethod.
Fields
| Field Name | Description |
|---|---|
edges - [ReimbursementMethodEdge]
|
A list of edges. |
nodes - [ReimbursementMethod]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReimbursementMethodEdge],
"nodes": [ReimbursementMethod],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
ReimbursementMethodEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ReimbursementMethod
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": ReimbursementMethod
}
Report
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
currency - String
|
|
deletedAt - ISO8601DateTime
|
|
distanceUnit - String
|
|
duplicateTeamReportTripCount - Int!
|
|
endDate - String
|
|
excelUrl - String
|
|
hasProvisionalRate - Boolean!
|
|
id - ID!
|
|
integrationActivities - IntegrationActivityConnection!
|
|
isMasked - Boolean!
|
|
isReplaced - Boolean
|
|
name - String
|
|
organisation - Organisation
|
You should use the organisation_* fields instead, unless you need the id |
organisationAddress - String
|
|
organisationName - String
|
|
outOfScopeReportItems - ReportItemConnection!
|
|
outdatedReportItems - ReportItemConnection!
|
|
pdfUrl - String
|
|
reimbursementMethod - String
|
|
replacedReportId - String
|
|
reportActivities - ReportActivityConnection!
|
|
reportItem - ReportItem
|
|
Arguments
|
|
reportItems - ReportItemConnection!
|
|
reportSettings - ReportSetting
|
|
reportShares - ReportShareConnection!
|
|
reportSummaryItems - ReportSummaryItemConnection!
|
|
showOdometer - Boolean
|
|
startDate - String
|
|
submitOptions - SubmitOptions
|
Avoid using it in lists to minimize load costs. |
tags - TagConnection!
|
|
teamReport - TeamReport
|
|
timeZone - String
|
|
title - String
|
|
totalAmount - Float
|
|
totalDistance - Int
|
|
tripReportIssuesCount - Int!
|
|
tripTypes - [TripType!]!
|
|
tripsMissing - TripConnection!
|
|
updatedAt - ISO8601DateTime!
|
|
user - TrustedUser
|
You should use the user_* fields instead, unless you need the id |
userAddress - String
|
|
userName - String
|
|
userRegistrationNo - String
|
|
vehicle - Vehicle
|
You should use the vehicle_* fields instead, unless you need the id |
vehicleLicensePlate - String
|
|
vehicleName - String
|
|
Example
{
"createdAt": ISO8601DateTime,
"currency": "abc123",
"deletedAt": ISO8601DateTime,
"distanceUnit": "abc123",
"duplicateTeamReportTripCount": 987,
"endDate": "abc123",
"excelUrl": "xyz789",
"hasProvisionalRate": true,
"id": 4,
"integrationActivities": IntegrationActivityConnection,
"isMasked": false,
"isReplaced": false,
"name": "xyz789",
"organisation": Organisation,
"organisationAddress": "xyz789",
"organisationName": "xyz789",
"outOfScopeReportItems": ReportItemConnection,
"outdatedReportItems": ReportItemConnection,
"pdfUrl": "xyz789",
"reimbursementMethod": "abc123",
"replacedReportId": "abc123",
"reportActivities": ReportActivityConnection,
"reportItem": ReportItem,
"reportItems": ReportItemConnection,
"reportSettings": ReportSetting,
"reportShares": ReportShareConnection,
"reportSummaryItems": ReportSummaryItemConnection,
"showOdometer": false,
"startDate": "xyz789",
"submitOptions": SubmitOptions,
"tags": TagConnection,
"teamReport": TeamReport,
"timeZone": "abc123",
"title": "xyz789",
"totalAmount": 123.45,
"totalDistance": 987,
"tripReportIssuesCount": 123,
"tripTypes": [TripType],
"tripsMissing": TripConnection,
"updatedAt": ISO8601DateTime,
"user": TrustedUser,
"userAddress": "abc123",
"userName": "xyz789",
"userRegistrationNo": "xyz789",
"vehicle": Vehicle,
"vehicleLicensePlate": "abc123",
"vehicleName": "abc123"
}
ReportActivity
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
event - String!
|
|
id - ID!
|
|
report - Report!
|
|
text - String
|
|
updatedAt - ISO8601DateTime!
|
|
user - PublicUser
|
Example
{
"createdAt": ISO8601DateTime,
"event": "abc123",
"id": 4,
"report": Report,
"text": "xyz789",
"updatedAt": ISO8601DateTime,
"user": PublicUser
}
ReportActivityConnection
Description
The connection type for ReportActivity.
Fields
| Field Name | Description |
|---|---|
edges - [ReportActivityEdge]
|
A list of edges. |
nodes - [ReportActivity]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReportActivityEdge],
"nodes": [ReportActivity],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
ReportActivityEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ReportActivity
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ReportActivity
}
ReportAttributes
Description
Attributes for creating or updating an Report
Fields
| Input Field | Description |
|---|---|
title - String
|
Example
{"title": "xyz789"}
ReportConnection
Description
The connection type for Report.
Fields
| Field Name | Description |
|---|---|
edges - [ReportEdge]
|
A list of edges. |
nodes - [Report]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReportEdge],
"nodes": [Report],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
ReportCreateMutationInput
Description
Autogenerated input type of ReportCreateMutation
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
endDate - ISO8601Date!
|
|
organisationId - ID!
|
|
showOdometer - Boolean!
|
|
startDate - ISO8601Date!
|
|
tagIds - [ID!]
|
|
tripTypeId - String
|
|
vehicleId - ID!
|
Example
{
"clientMutationId": "xyz789",
"endDate": ISO8601Date,
"organisationId": "4",
"showOdometer": false,
"startDate": ISO8601Date,
"tagIds": ["4"],
"tripTypeId": "xyz789",
"vehicleId": "4"
}
ReportCreateMutationPayload
ReportDeleteMutationInput
ReportDeleteMutationPayload
ReportEdge
ReportItem
Fields
| Field Name | Description |
|---|---|
comment - String
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
distance - Int
|
|
hasDuplicateTeamReportTrip - Boolean!
|
|
id - ID!
|
|
isGpsTracked - Boolean
|
|
isMasked - Boolean!
|
|
isTripMasked - Boolean!
|
|
outOfScope - Boolean!
|
|
outdated - Boolean!
|
|
reportItemReimbursements - [ReportItemReimbursement!]!
|
|
routePolyline - String
|
Avoid using it in lists to minimize load costs. |
startAt - ISO8601DateTime
|
|
startLocationAddress - String
|
|
startLocationCountryId - String
|
|
startLocationName - String
|
|
startLocationParentTeamId - ID
|
|
startLocationPlaceholder - String
|
|
startLocationPostalDisctrictString - String
|
|
startOdometerReading - BigInt
|
|
stopAt - ISO8601DateTime
|
|
stopLocationAddress - String
|
|
stopLocationCountryId - String
|
|
stopLocationName - String
|
|
stopLocationParentTeamId - ID
|
|
stopLocationPlaceholder - String
|
|
stopLocationPostalDisctrictString - String
|
|
stopOdometerReading - BigInt
|
|
tags - TagConnection!
|
|
Arguments
|
|
totalAmount - Float
|
|
tripIssues - [TripReportIssue!]!
|
|
tripTypeLabel - String
|
|
tripTypeName - String
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"comment": "xyz789",
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"distance": 987,
"hasDuplicateTeamReportTrip": false,
"id": "4",
"isGpsTracked": false,
"isMasked": true,
"isTripMasked": true,
"outOfScope": true,
"outdated": false,
"reportItemReimbursements": [ReportItemReimbursement],
"routePolyline": "xyz789",
"startAt": ISO8601DateTime,
"startLocationAddress": "abc123",
"startLocationCountryId": "abc123",
"startLocationName": "xyz789",
"startLocationParentTeamId": 4,
"startLocationPlaceholder": "xyz789",
"startLocationPostalDisctrictString": "abc123",
"startOdometerReading": {},
"stopAt": ISO8601DateTime,
"stopLocationAddress": "abc123",
"stopLocationCountryId": "abc123",
"stopLocationName": "xyz789",
"stopLocationParentTeamId": "4",
"stopLocationPlaceholder": "abc123",
"stopLocationPostalDisctrictString": "xyz789",
"stopOdometerReading": {},
"tags": TagConnection,
"totalAmount": 123.45,
"tripIssues": [TripReportIssue],
"tripTypeLabel": "abc123",
"tripTypeName": "abc123",
"updatedAt": ISO8601DateTime
}
ReportItemConnection
Description
The connection type for ReportItem.
Fields
| Field Name | Description |
|---|---|
edges - [ReportItemEdge]
|
A list of edges. |
nodes - [ReportItem]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReportItemEdge],
"nodes": [ReportItem],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
ReportItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ReportItem
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": ReportItem
}
ReportItemReimbursement
ReportItemTagsSortBy
ReportPreview
Fields
| Field Name | Description |
|---|---|
endDate - ISO8601Date!
|
|
hasArchivedTrips - Boolean!
|
|
hasDoubleReportedTrips - Boolean!
|
|
hasOdometerInconsistencies - Boolean!
|
|
hasOdometerMissing - Boolean!
|
|
hasPassedMonthlyLimit - Boolean!
|
|
hasProvisionalRate - Boolean!
|
|
hasReimbursementMethod - Boolean!
|
|
odometerInconsistencies - [OdometerInconsistency!]!
|
|
organisation - Organisation!
|
|
reimbursementMethod - String
|
|
showOdometer - Boolean!
|
|
startDate - ISO8601Date!
|
|
summaryItems - ReportPreviewSummaryItemConnection!
|
|
tripType - TripType
|
|
trips - TripConnection
|
|
vehicle - Vehicle!
|
|
Example
{
"endDate": ISO8601Date,
"hasArchivedTrips": false,
"hasDoubleReportedTrips": true,
"hasOdometerInconsistencies": true,
"hasOdometerMissing": true,
"hasPassedMonthlyLimit": true,
"hasProvisionalRate": false,
"hasReimbursementMethod": false,
"odometerInconsistencies": [OdometerInconsistency],
"organisation": Organisation,
"reimbursementMethod": "xyz789",
"showOdometer": true,
"startDate": ISO8601Date,
"summaryItems": ReportPreviewSummaryItemConnection,
"tripType": TripType,
"trips": TripConnection,
"vehicle": Vehicle
}
ReportPreviewSummaryItem
Example
{
"amount": 987.65,
"description": "abc123",
"distance": 123,
"percentage": 123.45,
"priority": 987,
"rate": Rate,
"tripType": Trip,
"type": "abc123"
}
ReportPreviewSummaryItemConnection
Description
The connection type for ReportPreviewSummaryItem.
Fields
| Field Name | Description |
|---|---|
edges - [ReportPreviewSummaryItemEdge]
|
A list of edges. |
nodes - [ReportPreviewSummaryItem]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReportPreviewSummaryItemEdge],
"nodes": [ReportPreviewSummaryItem],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
ReportPreviewSummaryItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ReportPreviewSummaryItem
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ReportPreviewSummaryItem
}
ReportPublic
ReportReplaceMutationInput
ReportReplaceMutationPayload
ReportSetting
Fields
| Field Name | Description |
|---|---|
enforcePeriodsEnabled - Boolean!
|
|
id - ID!
|
|
tripEditLogEnabled - Boolean!
|
|
tripIssueDistanceMaxExceededEnabled - Boolean!
|
|
tripIssueDistanceMaxExceededValue - Int
|
|
tripIssueHomeLocationEnabled - Boolean!
|
|
tripIssueOutsideWorkhoursEnabled - Boolean!
|
|
tripIssueOutsideWorkhoursEndTime - String
|
|
tripIssueOutsideWorkhoursStartTime - String
|
|
tripMaskingEnabled - Boolean!
|
|
tripOriginEnabled - Boolean!
|
|
tripRequireCommentsEnabled - Boolean!
|
|
tripRequireTagsEnabled - Boolean!
|
|
tripRouteEnabled - Boolean!
|
|
tripTimesEnabled - Boolean!
|
Example
{
"enforcePeriodsEnabled": true,
"id": "4",
"tripEditLogEnabled": true,
"tripIssueDistanceMaxExceededEnabled": true,
"tripIssueDistanceMaxExceededValue": 987,
"tripIssueHomeLocationEnabled": true,
"tripIssueOutsideWorkhoursEnabled": false,
"tripIssueOutsideWorkhoursEndTime": "abc123",
"tripIssueOutsideWorkhoursStartTime": "abc123",
"tripMaskingEnabled": true,
"tripOriginEnabled": true,
"tripRequireCommentsEnabled": false,
"tripRequireTagsEnabled": false,
"tripRouteEnabled": true,
"tripTimesEnabled": true
}
ReportSummaryItem
Fields
| Field Name | Description |
|---|---|
amount - Float
|
|
createdAt - ISO8601DateTime!
|
|
description - String
|
|
distance - Int
|
|
id - ID!
|
|
isMasked - Boolean!
|
|
percentage - Float
|
|
priority - Int
|
|
rateAmount - Float
|
|
rateName - String
|
|
summaryType - String
|
|
tripTypeLabel - String
|
|
tripTypeName - String
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"amount": 123.45,
"createdAt": ISO8601DateTime,
"description": "abc123",
"distance": 123,
"id": 4,
"isMasked": true,
"percentage": 987.65,
"priority": 987,
"rateAmount": 123.45,
"rateName": "abc123",
"summaryType": "abc123",
"tripTypeLabel": "abc123",
"tripTypeName": "xyz789",
"updatedAt": ISO8601DateTime
}
ReportSummaryItemConnection
Description
The connection type for ReportSummaryItem.
Fields
| Field Name | Description |
|---|---|
edges - [ReportSummaryItemEdge]
|
A list of edges. |
nodes - [ReportSummaryItem]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReportSummaryItemEdge],
"nodes": [ReportSummaryItem],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
ReportSummaryItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ReportSummaryItem
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ReportSummaryItem
}
ReportUpdateMutationInput
Description
Autogenerated input type of ReportUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - ReportAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": ReportAttributes,
"clientMutationId": "abc123",
"id": "4"
}
ReportUpdateMutationPayload
ReportingPeriodCalculation
Fields
| Field Name | Description |
|---|---|
periodEndOn - ISO8601Date!
|
|
periodStartOn - ISO8601Date!
|
Example
{
"periodEndOn": ISO8601Date,
"periodStartOn": ISO8601Date
}
ReportingPeriodCalculationConnection
Description
The connection type for ReportingPeriodCalculation.
Fields
| Field Name | Description |
|---|---|
edges - [ReportingPeriodCalculationEdge]
|
A list of edges. |
nodes - [ReportingPeriodCalculation]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ReportingPeriodCalculationEdge],
"nodes": [ReportingPeriodCalculation],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
ReportingPeriodCalculationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ReportingPeriodCalculation
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": ReportingPeriodCalculation
}
ReportingPeriodSetting
Fields
| Field Name | Description |
|---|---|
approvalDeadlineDays - Int
|
|
approvalDeadlineEnabled - Boolean!
|
|
currentPeriod - ReportingPeriodCalculation!
|
|
customAddress - String
|
|
customDetailsEnabled - Boolean!
|
|
customName - String
|
|
enforcePeriodsEnabled - Boolean!
|
|
id - ID!
|
|
intervalValue - String!
|
|
organisation - Organisation!
|
|
periodEmailReminderEnabled - Boolean!
|
|
periodInterval - Enumerize!
|
|
periodIntervalValue - String!
|
|
periodStartOn - ISO8601Date!
|
|
periods - ReportingPeriodCalculationConnection!
|
|
submissionDeadlineDays - Int
|
|
submissionDeadlineEnabled - Boolean!
|
|
tripEditLogEnabled - Boolean!
|
|
tripIssueDistanceMaxExceededEnabled - Boolean!
|
|
tripIssueDistanceMaxExceededValue - Int
|
|
tripIssueHomeLocationEnabled - Boolean!
|
|
tripIssueOutsideWorkhoursEnabled - Boolean!
|
|
tripIssueOutsideWorkhoursEndTime - String
|
|
tripIssueOutsideWorkhoursStartTime - String
|
|
tripMaskingEnabled - Boolean!
|
|
tripOriginEnabled - Boolean!
|
|
tripRequireCommentsEnabled - Boolean!
|
|
tripRequireTagsEnabled - Boolean!
|
|
tripRouteEnabled - Boolean!
|
|
tripTimesEnabled - Boolean!
|
|
Example
{
"approvalDeadlineDays": 987,
"approvalDeadlineEnabled": false,
"currentPeriod": ReportingPeriodCalculation,
"customAddress": "xyz789",
"customDetailsEnabled": true,
"customName": "xyz789",
"enforcePeriodsEnabled": false,
"id": 4,
"intervalValue": "abc123",
"organisation": Organisation,
"periodEmailReminderEnabled": true,
"periodInterval": Enumerize,
"periodIntervalValue": "abc123",
"periodStartOn": ISO8601Date,
"periods": ReportingPeriodCalculationConnection,
"submissionDeadlineDays": 987,
"submissionDeadlineEnabled": true,
"tripEditLogEnabled": false,
"tripIssueDistanceMaxExceededEnabled": false,
"tripIssueDistanceMaxExceededValue": 987,
"tripIssueHomeLocationEnabled": true,
"tripIssueOutsideWorkhoursEnabled": false,
"tripIssueOutsideWorkhoursEndTime": "abc123",
"tripIssueOutsideWorkhoursStartTime": "abc123",
"tripMaskingEnabled": false,
"tripOriginEnabled": true,
"tripRequireCommentsEnabled": true,
"tripRequireTagsEnabled": false,
"tripRouteEnabled": true,
"tripTimesEnabled": false
}
ReportingSetting
Fields
| Field Name | Description |
|---|---|
approvalDeadlineDays - Int
|
|
approvalDeadlineEnabled - Boolean!
|
|
currentPeriod - ReportingPeriodCalculation!
|
|
customAddress - String
|
|
customDetailsEnabled - Boolean!
|
|
customName - String
|
|
enforcePeriodsEnabled - Boolean!
|
|
id - ID!
|
|
organisation - Organisation!
|
|
periodEmailReminderEnabled - Boolean!
|
|
periodInterval - Enumerize!
|
|
periodIntervalValue - String!
|
|
periodStartOn - ISO8601Date!
|
|
periods - ReportingPeriodCalculationConnection!
|
|
submissionDeadlineDays - Int
|
|
submissionDeadlineEnabled - Boolean!
|
|
tripEditLogEnabled - Boolean!
|
|
tripIssueDistanceMaxExceededEnabled - Boolean!
|
|
tripIssueDistanceMaxExceededValue - Int
|
|
tripIssueHomeLocationEnabled - Boolean!
|
|
tripIssueOutsideWorkhoursEnabled - Boolean!
|
|
tripIssueOutsideWorkhoursEndTime - String
|
|
tripIssueOutsideWorkhoursStartTime - String
|
|
tripMaskingEnabled - Boolean!
|
|
tripOriginEnabled - Boolean!
|
|
tripRequireCommentsEnabled - Boolean!
|
|
tripRequireTagsEnabled - Boolean!
|
|
tripRouteEnabled - Boolean!
|
|
tripTimesEnabled - Boolean!
|
|
Example
{
"approvalDeadlineDays": 123,
"approvalDeadlineEnabled": true,
"currentPeriod": ReportingPeriodCalculation,
"customAddress": "abc123",
"customDetailsEnabled": true,
"customName": "xyz789",
"enforcePeriodsEnabled": true,
"id": "4",
"organisation": Organisation,
"periodEmailReminderEnabled": true,
"periodInterval": Enumerize,
"periodIntervalValue": "xyz789",
"periodStartOn": ISO8601Date,
"periods": ReportingPeriodCalculationConnection,
"submissionDeadlineDays": 123,
"submissionDeadlineEnabled": false,
"tripEditLogEnabled": true,
"tripIssueDistanceMaxExceededEnabled": true,
"tripIssueDistanceMaxExceededValue": 987,
"tripIssueHomeLocationEnabled": true,
"tripIssueOutsideWorkhoursEnabled": true,
"tripIssueOutsideWorkhoursEndTime": "abc123",
"tripIssueOutsideWorkhoursStartTime": "abc123",
"tripMaskingEnabled": false,
"tripOriginEnabled": false,
"tripRequireCommentsEnabled": false,
"tripRequireTagsEnabled": false,
"tripRouteEnabled": true,
"tripTimesEnabled": false
}
ReportingSettingAttributes
Description
Attributes for creating or updating ReportingSettings
Fields
| Input Field | Description |
|---|---|
approvalDeadlineDays - Int
|
|
approvalDeadlineEnabled - Boolean
|
|
customAddress - String
|
|
customDetailsEnabled - Boolean
|
|
customName - String
|
|
enforcePeriodsEnabled - Boolean
|
|
periodEmailReminderEnabled - Boolean
|
|
periodInterval - String
|
|
periodStartOn - ISO8601Date
|
|
submissionDeadlineDays - Int
|
|
submissionDeadlineEnabled - Boolean
|
|
tripEditLogEnabled - Boolean
|
|
tripIssueDistanceMaxExceededEnabled - Boolean
|
|
tripIssueDistanceMaxExceededValue - Int
|
|
tripIssueHomeLocationEnabled - Boolean
|
|
tripIssueOutsideWorkhoursEnabled - Boolean
|
|
tripIssueOutsideWorkhoursEndTime - String
|
|
tripIssueOutsideWorkhoursStartTime - String
|
|
tripMaskingEnabled - Boolean
|
|
tripOriginEnabled - Boolean
|
|
tripRequireCommentsEnabled - Boolean
|
|
tripRequireTagsEnabled - Boolean
|
|
tripRouteEnabled - Boolean
|
|
tripTimesEnabled - Boolean
|
Example
{
"approvalDeadlineDays": 987,
"approvalDeadlineEnabled": true,
"customAddress": "xyz789",
"customDetailsEnabled": true,
"customName": "xyz789",
"enforcePeriodsEnabled": false,
"periodEmailReminderEnabled": false,
"periodInterval": "xyz789",
"periodStartOn": ISO8601Date,
"submissionDeadlineDays": 123,
"submissionDeadlineEnabled": true,
"tripEditLogEnabled": false,
"tripIssueDistanceMaxExceededEnabled": true,
"tripIssueDistanceMaxExceededValue": 123,
"tripIssueHomeLocationEnabled": true,
"tripIssueOutsideWorkhoursEnabled": true,
"tripIssueOutsideWorkhoursEndTime": "xyz789",
"tripIssueOutsideWorkhoursStartTime": "abc123",
"tripMaskingEnabled": true,
"tripOriginEnabled": true,
"tripRequireCommentsEnabled": true,
"tripRequireTagsEnabled": true,
"tripRouteEnabled": false,
"tripTimesEnabled": false
}
ReportingSettingUpdateMutationInput
Description
Autogenerated input type of ReportingSettingUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - ReportingSettingAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": ReportingSettingAttributes,
"clientMutationId": "xyz789",
"id": 4
}
ReportingSettingUpdateMutationPayload
Description
Autogenerated return type of ReportingSettingUpdateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
reportingSetting - ReportingSetting
|
Example
{
"clientMutationId": "abc123",
"reportingSetting": ReportingSetting
}
Reviewer
Role
Fields
| Field Name | Description |
|---|---|
id - String!
|
|
isLastAdmin - Boolean!
|
|
roleType - RoleType!
|
|
user - TrustedUser!
|
Example
{
"id": "xyz789",
"isLastAdmin": false,
"roleType": "admin",
"user": TrustedUser
}
RoleConnection
Description
The connection type for Role.
Fields
| Field Name | Description |
|---|---|
edges - [RoleEdge]
|
A list of edges. |
nodes - [Role]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [RoleEdge],
"nodes": [Role],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
RoleEdge
RoleType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"admin"
ShippingMethod
ShippingMethodConnection
Description
The connection type for ShippingMethod.
Fields
| Field Name | Description |
|---|---|
edges - [ShippingMethodEdge]
|
A list of edges. |
nodes - [ShippingMethod]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [ShippingMethodEdge],
"nodes": [ShippingMethod],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
ShippingMethodEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - ShippingMethod
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": ShippingMethod
}
SortOrder
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"asc"
StoredAttachment
Fields
| Field Name | Description |
|---|---|
attachmentName - StoredAttachmentName!
|
|
attachmentUrl - String
|
|
report - Report
|
|
scopeId - ID!
|
|
scopeName - StoredAttachmentModel!
|
Example
{
"attachmentName": "pdf_file",
"attachmentUrl": "xyz789",
"report": Report,
"scopeId": "4",
"scopeName": "Report"
}
StoredAttachmentModel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Report"
StoredAttachmentName
Values
| Enum Value | Description |
|---|---|
|
|
Example
"pdf_file"
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
"xyz789"
SubmitOptions
Tag
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
isInUse - Boolean!
|
|
name - String!
|
|
tagCategoryId - ID!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"isInUse": false,
"name": "abc123",
"tagCategoryId": 4,
"updatedAt": ISO8601DateTime
}
TagCategory
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
name - String!
|
|
organisationId - ID
|
|
tags - TagConnection!
|
|
Arguments
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"name": "xyz789",
"organisationId": 4,
"tags": TagConnection,
"updatedAt": ISO8601DateTime
}
TagCategoryConnection
Description
The connection type for TagCategory.
Fields
| Field Name | Description |
|---|---|
edges - [TagCategoryEdge]
|
A list of edges. |
nodes - [TagCategory]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TagCategoryEdge],
"nodes": [TagCategory],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
TagCategoryCreateMutationInput
TagCategoryCreateMutationPayload
Description
Autogenerated return type of TagCategoryCreateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
tagCategory - TagCategory
|
Example
{
"clientMutationId": "abc123",
"tagCategory": TagCategory
}
TagCategoryDeleteMutationInput
TagCategoryDeleteMutationPayload
Description
Autogenerated return type of TagCategoryDeleteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
tagCategory - TagCategory
|
Example
{
"clientMutationId": "abc123",
"tagCategory": TagCategory
}
TagCategoryEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TagCategory
|
The item at the end of the edge. |
Example
{
"cursor": "abc123",
"node": TagCategory
}
TagCategoryTagsSortBy
TagCategoryUpdateMutationInput
Description
Autogenerated input type of TagCategoryUpdateMutation
Example
{
"clientMutationId": "xyz789",
"id": "4",
"name": "abc123",
"organisationId": 4
}
TagCategoryUpdateMutationPayload
Description
Autogenerated return type of TagCategoryUpdateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
tagCategory - TagCategory
|
Example
{
"clientMutationId": "abc123",
"tagCategory": TagCategory
}
TagConnection
Description
The connection type for Tag.
Fields
| Field Name | Description |
|---|---|
edges - [TagEdge]
|
A list of edges. |
nodes - [Tag]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TagEdge],
"nodes": [Tag],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
TagCreateMutationInput
Description
Autogenerated input type of TagCreateMutation
Example
{
"clientMutationId": "xyz789",
"name": "abc123",
"organisationId": "4",
"tagCategoryId": 4
}
TagCreateMutationPayload
TagDeleteMutationInput
TagDeleteMutationPayload
TagEdge
TagUpdateMutationInput
Description
Autogenerated input type of TagUpdateMutation
Example
{
"clientMutationId": "abc123",
"id": "4",
"name": "xyz789",
"organisationId": "4",
"tagCategoryId": "4"
}
TagUpdateMutationPayload
Team
Fields
| Field Name | Description |
|---|---|
currentTeamMember - TeamMember
|
|
customerPermissions - [Permission!]!
|
|
hasCustomer - Boolean!
|
|
id - ID!
|
|
invitationLinks - InvitationLinkConnection
|
|
name - String!
|
|
organisations - OrganisationConnection!
|
|
pendingTeamMembers - InvitationConnection!
|
|
permissions - [Permission!]!
|
|
teamMembers - TeamMemberConnection!
|
|
Arguments
|
|
teamMembersWithoutTeamReport - TeamMemberConnection!
|
|
Arguments
|
|
teamOrganisations - TeamOrganisationConnection!
|
|
teamSubscription - TeamSubscription!
|
|
Example
{
"currentTeamMember": TeamMember,
"customerPermissions": ["ARCHIVE"],
"hasCustomer": true,
"id": "4",
"invitationLinks": InvitationLinkConnection,
"name": "abc123",
"organisations": OrganisationConnection,
"pendingTeamMembers": InvitationConnection,
"permissions": ["ARCHIVE"],
"teamMembers": TeamMemberConnection,
"teamMembersWithoutTeamReport": TeamMemberConnection,
"teamOrganisations": TeamOrganisationConnection,
"teamSubscription": TeamSubscription
}
TeamAttributes
Description
Attributes for creating or updating a Team
Fields
| Input Field | Description |
|---|---|
name - String!
|
Example
{"name": "abc123"}
TeamConnection
Description
The connection type for Team.
Fields
| Field Name | Description |
|---|---|
edges - [TeamEdge]
|
A list of edges. |
nodes - [Team]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TeamEdge],
"nodes": [Team],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
TeamCreateMutationInput
Description
Autogenerated input type of TeamCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamAttributes!
|
All attributes except name will be ignored if parent_team_id is provided |
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisationId - ID
|
Ignored if parent_team_id is provided. Otherwise if provided, the team will be associated with the organisation |
parentTeamId - ID
|
If provided, the team will be created as a child of the parent team |
reimbursementMethod - String
|
Ignored if parent_team_id is provided. Otherwise if provided, the reimbursement method to use for the team organisation association |
Example
{
"attributes": TeamAttributes,
"clientMutationId": "abc123",
"organisationId": 4,
"parentTeamId": "4",
"reimbursementMethod": "abc123"
}
TeamCreateMutationPayload
TeamDeleteMutationInput
TeamDeleteMutationPayload
TeamEdge
TeamInviteAttributes
Description
Attributes for inviting a User to a Team
Fields
| Input Field | Description |
|---|---|
email - String!
|
|
name - String!
|
|
roleType - TeamMemberRole
|
Example
{
"email": "xyz789",
"name": "abc123",
"roleType": "admin"
}
TeamInviteDeleteMutationInput
TeamInviteDeleteMutationPayload
Description
Autogenerated return type of TeamInviteDeleteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
invitation - Invitation
|
Example
{
"clientMutationId": "xyz789",
"invitation": Invitation
}
TeamInviteMutationInput
Description
Autogenerated input type of TeamInviteMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamInviteAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID
|
Example
{
"attributes": TeamInviteAttributes,
"clientMutationId": "xyz789",
"id": "4"
}
TeamInviteMutationPayload
Description
Autogenerated return type of TeamInviteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
invitation - Invitation
|
Example
{
"clientMutationId": "abc123",
"invitation": Invitation
}
TeamInviteResendMutationInput
TeamInviteResendMutationPayload
Description
Autogenerated return type of TeamInviteResendMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
invitation - Invitation
|
Example
{
"clientMutationId": "abc123",
"invitation": Invitation
}
TeamMember
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
isDeleted - Boolean!
|
|
isLastAdmin - Boolean!
|
|
isManagerOrAdmin - Boolean!
|
|
permissions - [Permission!]!
|
|
role - String!
|
|
team - Team!
|
|
userEmail - String
|
|
userHasLicense - Boolean
|
|
userHasTeamLicense - Boolean
|
|
userId - String!
|
|
userLastLogin - ISO8601DateTime
|
|
userName - String
|
Example
{
"id": 4,
"isDeleted": false,
"isLastAdmin": true,
"isManagerOrAdmin": false,
"permissions": ["ARCHIVE"],
"role": "abc123",
"team": Team,
"userEmail": "xyz789",
"userHasLicense": false,
"userHasTeamLicense": false,
"userId": "xyz789",
"userLastLogin": ISO8601DateTime,
"userName": "xyz789"
}
TeamMemberBulkUpsertMutationInput
Description
Autogenerated input type of TeamMemberBulkUpsertMutation
Fields
| Input Field | Description |
|---|---|
attributesList - [TeamMemberUpsertAttributes!]!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
userId - ID!
|
Example
{
"attributesList": [TeamMemberUpsertAttributes],
"clientMutationId": "abc123",
"userId": "4"
}
TeamMemberBulkUpsertMutationPayload
Description
Autogenerated return type of TeamMemberBulkUpsertMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamMembers - [TeamMember!]!
|
Example
{
"clientMutationId": "xyz789",
"teamMembers": [TeamMember]
}
TeamMemberConnection
Description
The connection type for TeamMember.
Fields
| Field Name | Description |
|---|---|
edges - [TeamMemberEdge]
|
A list of edges. |
nodes - [TeamMember]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TeamMemberEdge],
"nodes": [TeamMember],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
TeamMemberDeleteMutationInput
TeamMemberDeleteMutationPayload
Description
Autogenerated return type of TeamMemberDeleteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamMember - TeamMember
|
Example
{
"clientMutationId": "xyz789",
"teamMember": TeamMember
}
TeamMemberEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TeamMember
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": TeamMember
}
TeamMemberRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"admin"
TeamMemberUpdateRoleMutationInput
TeamMemberUpdateRoleMutationPayload
Description
Autogenerated return type of TeamMemberUpdateRoleMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamMember - TeamMember
|
Example
{
"clientMutationId": "xyz789",
"teamMember": TeamMember
}
TeamMemberUpsertAttributes
TeamMemberUpsertMutationInput
Description
Autogenerated input type of TeamMemberUpsertMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamMemberUpsertAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
userId - ID!
|
Example
{
"attributes": TeamMemberUpsertAttributes,
"clientMutationId": "xyz789",
"userId": "4"
}
TeamMemberUpsertMutationPayload
Description
Autogenerated return type of TeamMemberUpsertMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamMember - TeamMember!
|
Example
{
"clientMutationId": "abc123",
"teamMember": TeamMember
}
TeamOrganisation
TeamOrganisationConnection
Description
The connection type for TeamOrganisation.
Fields
| Field Name | Description |
|---|---|
edges - [TeamOrganisationEdge]
|
A list of edges. |
nodes - [TeamOrganisation]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TeamOrganisationEdge],
"nodes": [TeamOrganisation],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
TeamOrganisationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TeamOrganisation
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": TeamOrganisation
}
TeamReport
TeamReportApproveMutationInput
Description
Autogenerated input type of TeamReportApproveMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamReportAttributes
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID
|
Example
{
"attributes": TeamReportAttributes,
"clientMutationId": "xyz789",
"id": 4
}
TeamReportApproveMutationPayload
Description
Autogenerated return type of TeamReportApproveMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamReport - TeamReport!
|
Example
{
"clientMutationId": "abc123",
"teamReport": TeamReport
}
TeamReportAttributes
TeamReportConnection
Description
The connection type for TeamReport.
Fields
| Field Name | Description |
|---|---|
edges - [TeamReportEdge]
|
A list of edges. |
nodes - [TeamReport]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TeamReportEdge],
"nodes": [TeamReport],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}
TeamReportEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - TeamReport
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": TeamReport
}
TeamReportProcessMutationInput
Description
Autogenerated input type of TeamReportProcessMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamReportAttributes
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID
|
Example
{
"attributes": TeamReportAttributes,
"clientMutationId": "xyz789",
"id": 4
}
TeamReportProcessMutationPayload
Description
Autogenerated return type of TeamReportProcessMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamReport - TeamReport!
|
Example
{
"clientMutationId": "abc123",
"teamReport": TeamReport
}
TeamReportRejectMutationInput
Description
Autogenerated input type of TeamReportRejectMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamReportAttributes
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID
|
Example
{
"attributes": TeamReportAttributes,
"clientMutationId": "xyz789",
"id": 4
}
TeamReportRejectMutationPayload
Description
Autogenerated return type of TeamReportRejectMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamReport - TeamReport!
|
Example
{
"clientMutationId": "xyz789",
"teamReport": TeamReport
}
TeamReportState
TeamReportSubmitMutationInput
Description
Autogenerated input type of TeamReportSubmitMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamReportAttributes
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
reportId - ID!
|
|
teamId - ID!
|
Example
{
"attributes": TeamReportAttributes,
"clientMutationId": "abc123",
"reportId": 4,
"teamId": "4"
}
TeamReportSubmitMutationPayload
Description
Autogenerated return type of TeamReportSubmitMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamReport - TeamReport!
|
Example
{
"clientMutationId": "xyz789",
"teamReport": TeamReport
}
TeamReportWithdrawMutationInput
TeamReportWithdrawMutationPayload
Description
Autogenerated return type of TeamReportWithdrawMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
teamReport - TeamReport!
|
Example
{
"clientMutationId": "abc123",
"teamReport": TeamReport
}
TeamSubscription
TeamUpdateMutationInput
Description
Autogenerated input type of TeamUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - TeamAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": TeamAttributes,
"clientMutationId": "abc123",
"id": 4
}
TeamUpdateMutationPayload
Trip
Fields
| Field Name | Description |
|---|---|
amount - Float
|
|
appVersion - Int
|
|
comment - String
|
|
createdAt - ISO8601DateTime!
|
|
deletedAt - ISO8601DateTime
|
|
distance - Int
|
|
hasDuplicateTeamReportTrip - Boolean!
|
|
id - ID!
|
|
isArchived - Boolean!
|
|
isDeleted - Boolean!
|
|
isGpsTracked - Boolean!
|
|
isPendingReview - Boolean!
|
|
monthlyLimitPassed - Boolean
|
|
organisation - Organisation!
|
|
os - String
|
|
osVersion - Int
|
|
outdatedReportItems - ReportItemConnection!
|
|
phoneModel - String
|
|
previousOdometerReading - OdometerReading
|
|
reimbursements - [TripReimbursement!]
|
|
reportItems - ReportItemConnection!
|
|
reviewStatus - TripReviewStatusEnum
|
|
reviewedAt - ISO8601DateTime
|
|
routeOrigin - String
|
|
routePolyline - String
|
|
startAt - ISO8601DateTime
|
|
startLat - Float
|
|
startLocation - Location
|
|
startLocationPlaceholder - String
|
|
startLon - Float
|
|
startOdometerReading - BigInt
|
|
startedBy - Int
|
|
stopAt - ISO8601DateTime
|
|
stopLat - Float
|
|
stopLocation - Location
|
|
stopLocationPlaceholder - String
|
|
stopLon - Float
|
|
stopOdometerReading - BigInt
|
|
stoppedBy - Int
|
|
tags - [Tag!]!
|
|
tripReportIssues - [TripReportIssue!]!
|
|
tripType - TripType!
|
|
updatedAt - ISO8601DateTime!
|
|
vehicle - Vehicle!
|
|
versions - VersionConnection!
|
|
Example
{
"amount": 987.65,
"appVersion": 987,
"comment": "abc123",
"createdAt": ISO8601DateTime,
"deletedAt": ISO8601DateTime,
"distance": 987,
"hasDuplicateTeamReportTrip": true,
"id": 4,
"isArchived": false,
"isDeleted": false,
"isGpsTracked": false,
"isPendingReview": false,
"monthlyLimitPassed": false,
"organisation": Organisation,
"os": "xyz789",
"osVersion": 123,
"outdatedReportItems": ReportItemConnection,
"phoneModel": "xyz789",
"previousOdometerReading": OdometerReading,
"reimbursements": [TripReimbursement],
"reportItems": ReportItemConnection,
"reviewStatus": "done",
"reviewedAt": ISO8601DateTime,
"routeOrigin": "abc123",
"routePolyline": "xyz789",
"startAt": ISO8601DateTime,
"startLat": 987.65,
"startLocation": Location,
"startLocationPlaceholder": "xyz789",
"startLon": 987.65,
"startOdometerReading": {},
"startedBy": 987,
"stopAt": ISO8601DateTime,
"stopLat": 123.45,
"stopLocation": Location,
"stopLocationPlaceholder": "xyz789",
"stopLon": 987.65,
"stopOdometerReading": {},
"stoppedBy": 123,
"tags": [Tag],
"tripReportIssues": [TripReportIssue],
"tripType": TripType,
"updatedAt": ISO8601DateTime,
"vehicle": Vehicle,
"versions": VersionConnection
}
TripAttributes
Description
Attributes for creating or updating a Trip
Fields
| Input Field | Description |
|---|---|
appVersion - Int
|
|
comment - String
|
|
distance - Int
|
|
organisationId - ID
|
|
os - String
|
|
osVersion - Int
|
|
phoneModel - String
|
|
reviewStatus - TripReviewStatusEnum
|
|
route - [TripRouteCoordinateAttributes!]
|
|
routeOrigin - String
|
|
startAt - ISO8601DateTime
|
|
startLocationId - ID
|
|
startLocationPlaceholder - String
|
|
startedBy - Int
|
|
stopAt - ISO8601DateTime
|
|
stopLocationId - ID
|
|
stopLocationPlaceholder - String
|
|
stoppedBy - Int
|
|
tagIds - [ID!]
|
|
tripTypeId - ID
|
|
vehicleId - ID
|
Example
{
"appVersion": 123,
"comment": "xyz789",
"distance": 987,
"organisationId": "4",
"os": "xyz789",
"osVersion": 987,
"phoneModel": "abc123",
"reviewStatus": "done",
"route": [TripRouteCoordinateAttributes],
"routeOrigin": "abc123",
"startAt": ISO8601DateTime,
"startLocationId": "4",
"startLocationPlaceholder": "abc123",
"startedBy": 123,
"stopAt": ISO8601DateTime,
"stopLocationId": 4,
"stopLocationPlaceholder": "xyz789",
"stoppedBy": 987,
"tagIds": ["4"],
"tripTypeId": 4,
"vehicleId": 4
}
TripBulkAttributes
Description
Attributes for bulk updating a Trip
Example
{
"comment": "abc123",
"organisationId": "4",
"startLocationId": 4,
"stopLocationId": 4,
"tagId": "4",
"tagOrganisationId": "4",
"tripTypeId": "4",
"vehicleId": "4"
}
TripBulkDeleteMutationInput
TripBulkDeleteMutationPayload
Description
Autogenerated return type of TripBulkDeleteMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
trips - TripConnection
|
|
Example
{
"clientMutationId": "xyz789",
"trips": TripConnection
}
TripBulkRestoreMutationInput
TripBulkRestoreMutationPayload
Description
Autogenerated return type of TripBulkRestoreMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
trips - TripConnection
|
|
Example
{
"clientMutationId": "abc123",
"trips": TripConnection
}
TripBulkUpdateMutationInput
Description
Autogenerated input type of TripBulkUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - TripBulkAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
ids - [ID!]!
|
String array with trip ids |
markAsReviewed - Boolean
|
Mark the trips state as reviewed |
Example
{
"attributes": TripBulkAttributes,
"clientMutationId": "xyz789",
"ids": [4],
"markAsReviewed": false
}
TripBulkUpdateMutationPayload
Description
Autogenerated return type of TripBulkUpdateMutation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
trips - TripConnection
|
|
Example
{
"clientMutationId": "abc123",
"trips": TripConnection
}
TripConnection
Description
The connection type for Trip.
Fields
| Field Name | Description |
|---|---|
edges - [TripEdge]
|
A list of edges. |
nodes - [Trip]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TripEdge],
"nodes": [Trip],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
TripCreateMutationInput
Description
Autogenerated input type of TripCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - TripAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"attributes": TripAttributes,
"clientMutationId": "abc123"
}
TripCreateMutationPayload
TripDeleteMutationInput
TripDeleteMutationPayload
TripEdge
TripReimbursement
TripReportIssue
Fields
| Field Name | Description |
|---|---|
description - String!
|
|
key - String!
|
|
kind - TripReportIssueKind
|
Example
{
"description": "xyz789",
"key": "abc123",
"kind": "danger"
}
TripReportIssueKind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"danger"
TripRestoreMutationInput
TripRestoreMutationPayload
TripReviewStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"done"
TripRouteCoordinateAttributes
Description
Attributes for an individual coordinate when inputting the route of a trip
Example
{
"accuracy": 123.45,
"invalid": 987,
"lat": 123.45,
"lon": 123.45,
"note": "xyz789",
"speed": 123.45,
"time": "abc123"
}
TripType
TripTypeConnection
Description
The connection type for TripType.
Fields
| Field Name | Description |
|---|---|
edges - [TripTypeEdge]
|
A list of edges. |
nodes - [TripType]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [TripTypeEdge],
"nodes": [TripType],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
TripTypeEdge
TripUpdateMutationInput
Description
Autogenerated input type of TripUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - TripAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
|
markAsReviewed - Boolean
|
Mark the trips state as reviewed |
Example
{
"attributes": TripAttributes,
"clientMutationId": "abc123",
"id": "4",
"markAsReviewed": true
}
TripUpdateMutationPayload
TrustedUser
UnreportedTripsOverview
Fields
| Field Name | Description |
|---|---|
amount - Float
|
|
date - ISO8601Date
|
|
distance - Int
|
Example
{"amount": 987.65, "date": ISO8601Date, "distance": 123}
Vehicle
Fields
| Field Name | Description |
|---|---|
country - Country!
|
|
devices - DeviceConnection!
|
|
id - ID!
|
|
isArchived - Boolean
|
|
isCurrentlySelected - Boolean!
|
Vehicle currently selected in Session |
licensePlate - String
|
|
name - String
|
|
odometerReadings - OdometerReadingConnection!
|
|
odometerUsage - Enumerize!
|
|
tripTypes - [TripType!]!
|
Get TripTypes from Country instead |
trips - TripConnection!
|
|
vehicleType - VehicleType!
|
|
Example
{
"country": Country,
"devices": DeviceConnection,
"id": 4,
"isArchived": true,
"isCurrentlySelected": false,
"licensePlate": "xyz789",
"name": "abc123",
"odometerReadings": OdometerReadingConnection,
"odometerUsage": Enumerize,
"tripTypes": [TripType],
"trips": TripConnection,
"vehicleType": VehicleType
}
VehicleArchiveMutationInput
VehicleArchiveMutationPayload
VehicleConnection
Description
The connection type for Vehicle.
Fields
| Field Name | Description |
|---|---|
edges - [VehicleEdge]
|
A list of edges. |
nodes - [Vehicle]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [VehicleEdge],
"nodes": [Vehicle],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
VehicleCreateAttributes
Description
Attributes for creating a Vehicle
Example
{
"countryId": "xyz789",
"licensePlate": "abc123",
"name": "abc123",
"odometerUsage": "xyz789",
"vehicleTypeId": "4"
}
VehicleCreateMutationInput
Description
Autogenerated input type of VehicleCreateMutation
Fields
| Input Field | Description |
|---|---|
attributes - VehicleCreateAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
Example
{
"attributes": VehicleCreateAttributes,
"clientMutationId": "xyz789"
}
VehicleCreateMutationPayload
VehicleDeleteMutationInput
VehicleDeleteMutationPayload
VehicleEdge
VehicleType
VehicleTypeConnection
Description
The connection type for VehicleType.
Fields
| Field Name | Description |
|---|---|
edges - [VehicleTypeEdge]
|
A list of edges. |
nodes - [VehicleType]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [VehicleTypeEdge],
"nodes": [VehicleType],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 123
}
VehicleTypeEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
cursor - String!
|
A cursor for use in pagination. |
node - VehicleType
|
The item at the end of the edge. |
Example
{
"cursor": "xyz789",
"node": VehicleType
}
VehicleUnarchiveMutationInput
VehicleUnarchiveMutationPayload
VehicleUpdateAttributes
Description
Attributes for updating a Vehicle
Example
{
"countryId": "xyz789",
"licensePlate": "abc123",
"name": "abc123",
"odometerUsage": "abc123",
"reimbursementMethod": "abc123",
"vehicleTypeId": 987
}
VehicleUpdateMutationInput
Description
Autogenerated input type of VehicleUpdateMutation
Fields
| Input Field | Description |
|---|---|
attributes - VehicleUpdateAttributes!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
Example
{
"attributes": VehicleUpdateAttributes,
"clientMutationId": "abc123",
"id": "4"
}
VehicleUpdateMutationPayload
Version
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
objectChanges - String
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"objectChanges": "xyz789",
"updatedAt": ISO8601DateTime
}
VersionConnection
Description
The connection type for Version.
Fields
| Field Name | Description |
|---|---|
edges - [VersionEdge]
|
A list of edges. |
nodes - [Version]
|
A list of nodes. |
pageInfo - PageInfo!
|
Information to aid in pagination. |
queriedAt - ISO8601DateTime!
|
Use before edges to get an start-time or after to get an end-time |
totalCount - Int!
|
Example
{
"edges": [VersionEdge],
"nodes": [Version],
"pageInfo": PageInfo,
"queriedAt": ISO8601DateTime,
"totalCount": 987
}