• Authentication
  • postLogin with email and password
  • postLogin with SSO token
  • postRefresh access token
  • postLogout and invalidate token
  • postRegister a new account
  • postRequest a password reset email
  • postSet a new password using a reset code
  • postChange password using current password (authenticated)
  • postVerify email address with token
  • postGet a short-lived mapping service token
• Users
  • getGet the authenticated user's profile
  • patchUpdate the authenticated user's profile
  • getList users for the current client
  • patchUpdate a user's roles or display name
  • delRemove a user from the current client
  • getList pending invitations
  • postInvite a user to the client account
  • getGet invitation details by code (public)
  • postAccept a client invitation
  • postDecline a client invitation
  • postResend a pending invitation email
  • postRevoke a pending invitation
• Clients
  • getList client accounts accessible to the authenticated user
  • patchUpdate the current client's settings
  • getGet a specific client by ID
  • postSubmit a contact form enquiry (public)
• Vehicles
  • getList vehicles
  • getGet vehicle category reference data (public)
  • postLook up vehicle details from a registration number
  • getSearch for a matching reference vehicle specification
• Assets
  • getList assets
  • postCreate a new asset
  • patchUpdate an asset
  • delDelete an asset
  • postExport assets as CSV
  • postProcess a CSV asset upload
  • postLink assets together or retrieve linked assets
  • postGet asset apportionment data for a date range
• Documents
  • getGet a pre-signed S3 URL for uploading a file
  • getGet a pre-signed S3 URL for downloading a file
  • getCheck whether a thumbnail has been generated for a file
  • postStart an OCR/data extraction job for an uploaded document
  • postAnalyse the structure of an uploaded spreadsheet
  • postApply user corrections to a document extraction job
  • getList document extraction jobs
  • getGet a specific extraction job
  • delDelete an extraction job
  • getGet distinct values for a column in an extracted spreadsheet
  • getGet available document source types
• Fuel Accounting
  • getGet supported fuel type definitions
  • getGet available transaction type options
  • getGet current and historical FTC fuel rates
  • getList fuel cards
  • postCreate a fuel card entry
  • patchUpdate a fuel card
  • delDelete a fuel card
  • getList fuel acquisition records
  • postCreate a new fuel acquisition record from an extraction job
  • getGet the most recent fuel acquisition record
  • getGet a specific acquisition record
  • delDelete an acquisition record
  • getGet line items for an acquisition record
  • getGet extracted line items from a document job
  • postGet transaction matching suggestions for a job
  • patchUpdate a transaction match for a job
  • getList FTC reports
  • postCreate a new FTC report
  • getGet a specific FTC report
  • putUpdate an FTC report
  • delDelete an FTC report
  • getGet a download URL for the FTC report PDF
  • getGet a download URL for the FTC audit package ZIP
  • postGet a grouped summary of filtered fuel transaction line items
  • postGet detailed rows within a specific group of filtered line items
  • postGet filtered fuel transaction line items
  • postExport filtered line items as CSV
  • postDownload a monthly fuel template CSV
• Analytics
  • postGet scoreboard summary metrics for a date range
  • getGet fuel cost analysis for a date range
  • postAnalyse fuel price ranges across a date range
  • getGet fleet-level analytics for a date range
  • getGet calendar view of fleet activity data
  • getGet a quick-view summary for an acquisition record
  • getGet AI-generated summaries for an acquisition record
  • getGet monthly time-series data for a date range
  • postGet flagged trips matching filter criteria
  • patchSet the approval status of a single flagged trip
  • postSet approval status for multiple flagged trips at once
  • postAI chat completions for data analysis
• Emissions
  • getList emissions reports
  • postCreate a new emissions report
  • getGet a specific emissions report
  • putUpdate an emissions report
  • delDelete an emissions report
  • patchMark an emissions report as finalised or un-finalised
  • getList all supported emissions standards
  • getGet details for a specific emissions standard
• Areas
  • getList custom geographic areas for the current client
  • postCreate a new custom area from a GeoJSON feature collection
  • getGet a specific custom area (GeoJSON with Accept header)
  • putUpdate a custom area
  • delDelete a custom area
• Billing
  • getGet available subscription plans (public)
  • getGet the billing address for the current client
  • putCreate or update the billing address
  • getGet a Stripe payment intent for a new subscription
  • getGet the current active subscription
  • postCancel the active subscription
  • getGet a link to the Stripe billing portal
  • getGet the latest custom quote for the current client
  • postCreate a custom pricing quote
  • getGet the latest GPS connection request
  • postCreate a GPS connection request
• Reports
  • getGet FTC report data for a date range
  • getGet FTC trip details for a device
  • getList scheduled FTC report files
  • getGet a download URL for a scheduled FTC report file
  • getList audit report files
  • getGet a download URL for an audit report file
  • postQueue generation of a new scheduled FTC report
• Reference Data
  • getList all user roles
  • getList FTC fuel tax credit rates
  • getList auxiliary fuel use categories (safe harbour)
  • getList business fuel use types
  • getList available auxiliary fuel calculation methods

API docs by Redocly](https://redocly.com/redoc/)

Prism API (1.0.0)

Download OpenAPI specification: Download

URL: https://nuonic.com.au

The Prism API provides programmatic access to fleet fuel management, fuel tax credits, emissions reporting, analytics, and asset management capabilities.

All endpoints (except those marked public) require a Bearer token obtained via the /auth/v1/login-cognito endpoint. Pass the token in the Authorization header as Bearer <token>.

Most endpoints also require a prism-client-id header identifying the client account context for the request.

tag/Authentication Authentication

Login, token refresh, password management, and signup

tag/Authentication/operation/loginCognito Login with email and password

Request Body schema: application/json required

Responses

200

Successful login

Response Schema: application/json

401

Invalid credentials

post/auth/v1/login-cognito

Production

https://api.prismapp.com.au/auth/v1/login-cognito

Request samples

• Payload

Content type

application/json

Copy

`{"email": "user@example.com",

"password": "pa$$word"

}`

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"access_token": "string",

"refresh_token": "string",

"token_type": "Bearer",

"expires_in": 3600

},

"size": 0,

"total": 0

}`

tag/Authentication/operation/loginSso Login with SSO token

Request Body schema: application/json required

Responses

200

Successful SSO login

Response Schema: application/json

post/auth/v1/login-sso

Production

https://api.prismapp.com.au/auth/v1/login-sso

Request samples

• Payload

Content type

application/json

Copy

`{"token": "string"

}`

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"access_token": "string",

"refresh_token": "string",

"token_type": "Bearer",

"expires_in": 3600

},

"size": 0,

"total": 0

}`

tag/Authentication/operation/refreshCognito Refresh access token

Request Body schema: application/json required

Responses

200

New access token issued

Response Schema: application/json

post/auth/v1/refresh-cognito

Production

https://api.prismapp.com.au/auth/v1/refresh-cognito

Request samples

• Payload

Content type

application/json

Copy

`{"refresh_token": "string",

"sub": "string"

}`

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"access_token": "string",

"refresh_token": "string",

"token_type": "Bearer",

"expires_in": 3600

},

"size": 0,

"total": 0

}`

tag/Authentication/operation/logout Logout and invalidate token

Authorizations:

bearerAuth

Responses

200

Logged out successfully

Response Schema: application/json

post/auth/v1/logout

Production

https://api.prismapp.com.au/auth/v1/logout

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Authentication/operation/signup Register a new account

Request Body schema: application/json required

Responses

200

Account created

Response Schema: application/json

post/auth/v1/signup

Production

https://api.prismapp.com.au/auth/v1/signup

Request samples

• Payload

Content type

application/json

Copy

`{"contact_name": "string",

"email": "user@example.com",

"password": "pa$$word",

"business_name": "string",

"timezone": "Australia/Sydney",

"invite_code": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Authentication/operation/forgotPassword Request a password reset email

Request Body schema: application/json required

Responses

200

Reset email sent

Response Schema: application/json

post/auth/v1/forgot-password

Production

https://api.prismapp.com.au/auth/v1/forgot-password

Request samples

• Payload

Content type

application/json

Copy

`{"email": "user@example.com"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Authentication/operation/changePassword Set a new password using a reset code

Request Body schema: application/json required

Responses

200

Password changed

Response Schema: application/json

post/auth/v1/change-password

Production

https://api.prismapp.com.au/auth/v1/change-password

Request samples

• Payload

Content type

application/json

Copy

`{"email": "user@example.com",

"password": "pa$$word",

"code": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Authentication/operation/setPassword Change password using current password (authenticated)

Authorizations:

bearerAuth

Request Body schema: application/json required

Responses

200

Password updated

Response Schema: application/json

post/auth/v1/set-password

Production

https://api.prismapp.com.au/auth/v1/set-password

Request samples

• Payload

Content type

application/json

Copy

`{"old_password": "pa$$word",

"new_password": "pa$$word"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Authentication/operation/verifyEmail Verify email address with token

Request Body schema: application/json required

Responses

200

Email verified

Response Schema: application/json

post/auth/v1/verify-email

Production

https://api.prismapp.com.au/auth/v1/verify-email

Request samples

• Payload

Content type

application/json

Copy

`{"token": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Authentication/operation/getMaptileToken Get a short-lived mapping service token

Authorizations:

bearerAuth

Responses

200

Maptile token

Response Schema: application/json

post/auth/v1/maptile-token

Production

https://api.prismapp.com.au/auth/v1/maptile-token

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"token": "string"

},

"size": 0,

"total": 0

}`

tag/Users Users

User profiles, roles, and invitation management

tag/Users/operation/getProfile Get the authenticated user's profile

Authorizations:

bearerAuth

header Parameters

Responses

200

User profile

Response Schema: application/json

get/users/v1/profile

Production

https://api.prismapp.com.au/users/v1/profile

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"user_id": "string",

"email": "user@example.com",

"nickname": "string",

"contact_name": "string",

"roles": ["string"

],

"client_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"user_metadata": { }

},

"size": 0,

"total": 0

}`

tag/Users/operation/updateUserProfile Update the authenticated user's profile

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Profile updated

Response Schema: application/json

patch/users/v1/profile

Production

https://api.prismapp.com.au/users/v1/profile

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"nickname": "string",

"contact_name": "string",

"user_metadata": { }

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/getUsers List users for the current client

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Paginated user list

Response Schema: application/json

get/users/v1

Production

https://api.prismapp.com.au/users/v1

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"user_id": "string",

"email": "user@example.com",

"nickname": "string",

"contact_name": "string",

"roles": ["string"

],

"client_id": "string",

"created_at": "2019-08-24T14:15:22Z",

"user_metadata": { }

}

],

"size": 0,

"total": 0

}`

tag/Users/operation/updateUser Update a user's roles or display name

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

Responses

200

User updated

Response Schema: application/json

patch/users/v1/{user_id}

Production

https://api.prismapp.com.au/users/v1/{user\_id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"nickname": "string",

"roles": ["string"

]

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/deleteUser Remove a user from the current client

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

User removed

Response Schema: application/json

delete/users/v1/{user_id}

Production

https://api.prismapp.com.au/users/v1/{user\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/getInvitations List pending invitations

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Paginated invitation list

Response Schema: application/json

get/users/v1/invitations

Production

https://api.prismapp.com.au/users/v1/invitations

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"invitation_id": "string",

"email": "user@example.com",

"status": "pending",

"created_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Users/operation/inviteUser Invite a user to the client account

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Invitation sent

Response Schema: application/json

post/users/v1/invitations

Production

https://api.prismapp.com.au/users/v1/invitations

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"email": "user@example.com",

"nickname": "string",

"roles": ["string"

]

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/getInvitationDetails Get invitation details by code (public)

path Parameters

Responses

200

Invitation details

Response Schema: application/json

get/users/v1/invitations/{invite_code}

Production

https://api.prismapp.com.au/users/v1/invitations/{invite\_code}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"invitation_id": "string",

"email": "user@example.com",

"status": "pending",

"created_at": "2019-08-24T14:15:22Z",

"expires_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Users/operation/acceptInvitation Accept a client invitation

Authorizations:

bearerAuth

path Parameters

Responses

200

Invitation accepted

Response Schema: application/json

post/users/v1/invitations/{invite_code}/accept

Production

https://api.prismapp.com.au/users/v1/invitations/{invite\_code}/accept

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/declineInvitation Decline a client invitation

Authorizations:

bearerAuth

path Parameters

Responses

200

Invitation declined

Response Schema: application/json

post/users/v1/invitations/{invite_code}/decline

Production

https://api.prismapp.com.au/users/v1/invitations/{invite\_code}/decline

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/resendInvitation Resend a pending invitation email

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Invitation resent

Response Schema: application/json

post/users/v1/invitations/id/{invitation_id}/resend

Production

https://api.prismapp.com.au/users/v1/invitations/id/{invitation\_id}/resend

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Users/operation/revokeInvitation Revoke a pending invitation

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Invitation revoked

Response Schema: application/json

post/users/v1/invitations/id/{invitation_id}/revoke

Production

https://api.prismapp.com.au/users/v1/invitations/id/{invitation\_id}/revoke

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Clients Clients

Client account management

tag/Clients/operation/getClients List client accounts accessible to the authenticated user

Authorizations:

bearerAuth

query Parameters

Responses

200

Client list

Response Schema: application/json

get/clients/v1

Production

https://api.prismapp.com.au/clients/v1

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"client_id": "string",

"name": "string",

"abn": "string",

"timezone": "string",

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Clients/operation/updateClient Update the current client's settings

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Client updated

Response Schema: application/json

patch/clients/v1

Production

https://api.prismapp.com.au/clients/v1

Request samples

• Payload

Content type

application/json

Copy

`{"client_id": "string",

"name": "string",

"abn": "string",

"timezone": "string",

"created_at": "2019-08-24T14:15:22Z"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Clients/operation/getClient Get a specific client by ID

Authorizations:

bearerAuth

path Parameters

Responses

200

Client details

Response Schema: application/json

get/clients/v1/{client_id}

Production

https://api.prismapp.com.au/clients/v1/{client\_id}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"client_id": "string",

"name": "string",

"abn": "string",

"timezone": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Clients/operation/submitContactForm Submit a contact form enquiry (public)

Request Body schema: application/json required

Responses

200

Enquiry submitted

Response Schema: application/json

post/clients/v1/contact

Production

https://api.prismapp.com.au/clients/v1/contact

Request samples

• Payload

Content type

application/json

Copy

`{"name": "string",

"email": "user@example.com",

"phone": "string",

"enquiry": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Vehicles Vehicles

Fleet vehicle registry and reference data

tag/Vehicles/operation/getVehicles List vehicles

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Vehicle list

Response Schema: application/json

get/vehicles/v1

Production

https://api.prismapp.com.au/vehicles/v1

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"vehicle_id": "string",

"registration": "string",

"make": "string",

"model": "string",

"variant": "string",

"fuel_type": "string",

"category": "string",

"active": true

}

],

"size": 0,

"total": 0

}`

tag/Vehicles/operation/getVehicleCategories Get vehicle category reference data (public)

Responses

200

Vehicle categories

Response Schema: application/json

get/vehicles/v1/categories

Production

https://api.prismapp.com.au/vehicles/v1/categories

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Vehicles/operation/regoLookup Look up vehicle details from a registration number

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Vehicle registration details

Response Schema: application/json

post/vehicles/v1/rego-lookup

Production

https://api.prismapp.com.au/vehicles/v1/rego-lookup

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Vehicles/operation/searchVehicleMatch Search for a matching reference vehicle specification

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Matching vehicle specifications

Response Schema: application/json

get/vehicles/v1/match

Production

https://api.prismapp.com.au/vehicles/v1/match

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets Assets

Asset management (equipment, machinery)

tag/Assets/operation/getAssets List assets

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Asset list

Response Schema: application/json

get/asset/v1

Production

https://api.prismapp.com.au/asset/v1

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"asset_id": "string",

"name": "string",

"description": "string",

"asset_type": "string",

"active": true,

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Assets/operation/createAsset Create a new asset

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Asset created

Response Schema: application/json

post/asset/v1

Production

https://api.prismapp.com.au/asset/v1

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"data": {"asset": {"asset_id": "string",

"name": "string",

"description": "string",

"asset_type": "string",

"active": true,

"created_at": "2019-08-24T14:15:22Z"

}

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets/operation/patchAsset Update an asset

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Asset updated

Response Schema: application/json

patch/asset/v1/{asset_id}

Production

https://api.prismapp.com.au/asset/v1/{asset\_id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"data": {"asset": {"asset_id": "string",

"name": "string",

"description": "string",

"asset_type": "string",

"active": true,

"created_at": "2019-08-24T14:15:22Z"

}

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets/operation/deleteAsset Delete an asset

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Asset deleted

Response Schema: application/json

delete/asset/v1/{asset_id}

Production

https://api.prismapp.com.au/asset/v1/{asset\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets/operation/exportAssetsCsv Export assets as CSV

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

CSV file contents or presigned URL

Response Schema: application/json

post/asset/v1/csv

Production

https://api.prismapp.com.au/asset/v1/csv

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets/operation/processAssetCsvUpload Process a CSV asset upload

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

CSV processed

Response Schema: application/json

post/asset/v1/csv/process

Production

https://api.prismapp.com.au/asset/v1/csv/process

Request samples

• Payload

Content type

application/json

Copy

`{"s3_key": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets/operation/linkAssets Link assets together or retrieve linked assets

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Linked assets

Response Schema: application/json

post/asset/v1/link

Production

https://api.prismapp.com.au/asset/v1/link

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Assets/operation/getAssetApportionments Get asset apportionment data for a date range

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Apportionment data

Response Schema: application/json

post/asset/v1/asset-apportionment

Production

https://api.prismapp.com.au/asset/v1/asset-apportionment

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"asset_ids": ["string"

]

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Documents Documents

File upload, document processing, and data extraction jobs

tag/Documents/operation/getUploadUrl Get a pre-signed S3 URL for uploading a file

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Pre-signed upload URL

Response Schema: application/json

get/documents/v1/upload-url

Production

https://api.prismapp.com.au/documents/v1/upload-url

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"url": "http://example.com",

"s3_key": "string"

},

"size": 0,

"total": 0

}`

tag/Documents/operation/getDownloadUrl Get a pre-signed S3 URL for downloading a file

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Pre-signed download URL

Response Schema: application/json

get/documents/v1/download-url

Production

https://api.prismapp.com.au/documents/v1/download-url

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"url": "http://example.com"

},

"size": 0,

"total": 0

}`

tag/Documents/operation/thumbnailExists Check whether a thumbnail has been generated for a file

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Thumbnail existence flag

Response Schema: application/json

get/documents/v1/thumbnail-exists

Production

https://api.prismapp.com.au/documents/v1/thumbnail-exists

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"exists": true

},

"size": 0,

"total": 0

}`

tag/Documents/operation/analyseDocument Start an OCR/data extraction job for an uploaded document

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Extraction job created

Response Schema: application/json

post/documents/v1/analyse

Production

https://api.prismapp.com.au/documents/v1/analyse

Request samples

• Payload

Content type

application/json

Copy

`{"s3_key": "string"

}`

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"job_id": "string",

"status": "string",

"source": "string",

"filename": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Documents/operation/analyseSpreadsheet Analyse the structure of an uploaded spreadsheet

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Spreadsheet analysis result

Response Schema: application/json

post/documents/v1/analyse-spreadsheet/{job_id}

Production

https://api.prismapp.com.au/documents/v1/analyse-spreadsheet/{job\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Documents/operation/applyUserInputToJob Apply user corrections to a document extraction job

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

object

Responses

200

User input applied

Response Schema: application/json

post/documents/v1/jobs/{job_id}/apply-user-input

Production

https://api.prismapp.com.au/documents/v1/jobs/{job\_id}/apply-user-input

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Documents/operation/listDocumentExtractionJobs List document extraction jobs

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Extraction job list

Response Schema: application/json

get/documents/v1/jobs

Production

https://api.prismapp.com.au/documents/v1/jobs

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"job_id": "string",

"status": "string",

"source": "string",

"filename": "string",

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Documents/operation/getDocumentExtractionJob Get a specific extraction job

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Extraction job details

Response Schema: application/json

get/documents/v1/jobs/{job_id}

Production

https://api.prismapp.com.au/documents/v1/jobs/{job\_id}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"job_id": "string",

"status": "string",

"source": "string",

"filename": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Documents/operation/deleteDocumentExtractionJob Delete an extraction job

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Job deleted

Response Schema: application/json

delete/documents/v1/jobs/{job_id}

Production

https://api.prismapp.com.au/documents/v1/jobs/{job\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Documents/operation/getJobSheetDistinctValues Get distinct values for a column in an extracted spreadsheet

Authorizations:

bearerAuth

path Parameters

query Parameters

header Parameters

Responses

200

Distinct column values

Response Schema: application/json

get/documents/v1/jobs/{job_id}/sheet-distinct-values

Production

https://api.prismapp.com.au/documents/v1/jobs/{job\_id}/sheet-distinct-values

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Documents/operation/getDocumentSources Get available document source types

Authorizations:

bearerAuth

header Parameters

Responses

200

Document sources

Response Schema: application/json

get/documents/v1/sources

Production

https://api.prismapp.com.au/documents/v1/sources

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting Fuel Accounting

Fuel acquisition records, FTC reports, transaction filtering, and fuel cards

tag/Fuel-Accounting/operation/getFuelTypes Get supported fuel type definitions

Authorizations:

bearerAuth

header Parameters

Responses

200

Fuel type list

Response Schema: application/json

get/fuel-accounting/v1/fuel-types

Production

https://api.prismapp.com.au/fuel-accounting/v1/fuel-types

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getTransactionTypes Get available transaction type options

Authorizations:

bearerAuth

header Parameters

Responses

200

Transaction types

Response Schema: application/json

get/fuel-accounting/v1/transaction-types

Production

https://api.prismapp.com.au/fuel-accounting/v1/transaction-types

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFTCRates Get current and historical FTC fuel rates

Authorizations:

bearerAuth

header Parameters

Responses

200

FTC rate table

Response Schema: application/json

get/fuel-accounting/v1/ftc-rate

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-rate

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFuelCards List fuel cards

Authorizations:

bearerAuth

header Parameters

Responses

200

Fuel card list

Response Schema: application/json

get/fuel-accounting/v1/fuel-card

Production

https://api.prismapp.com.au/fuel-accounting/v1/fuel-card

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"card_id": "string",

"card_number": "string",

"card_name": "string",

"provider": "string",

"active": true

}

],

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/createFuelCard Create a fuel card entry

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Fuel card created

Response Schema: application/json

post/fuel-accounting/v1/fuel-card

Production

https://api.prismapp.com.au/fuel-accounting/v1/fuel-card

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"data": {"card_number": "string",

"card_name": "string",

"provider": "string"

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/patchFuelCard Update a fuel card

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

object

Responses

200

Fuel card updated

Response Schema: application/json

patch/fuel-accounting/v1/fuel-card/{card_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/fuel-card/{card\_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/deleteFuelCard Delete a fuel card

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Fuel card deleted

Response Schema: application/json

delete/fuel-accounting/v1/fuel-card/{card_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/fuel-card/{card\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/listAcquisitionRecords List fuel acquisition records

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Acquisition record list

Response Schema: application/json

get/fuel-accounting/v1/acquisition-record

Production

https://api.prismapp.com.au/fuel-accounting/v1/acquisition-record

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"acquisition_record_id": "string",

"job_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"status": "string",

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/createAcquisitionRecord Create a new fuel acquisition record from an extraction job

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Acquisition record created

Response Schema: application/json

post/fuel-accounting/v1/acquisition-record

Production

https://api.prismapp.com.au/fuel-accounting/v1/acquisition-record

Request samples

• Payload

Content type

application/json

Copy

`{"job_id": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getLatestAcquisitionRecord Get the most recent fuel acquisition record

Authorizations:

bearerAuth

header Parameters

Responses

200

Latest acquisition record

Response Schema: application/json

get/fuel-accounting/v1/acquisition-record/latest

Production

https://api.prismapp.com.au/fuel-accounting/v1/acquisition-record/latest

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"acquisition_record_id": "string",

"job_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"status": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getAcquisitionRecord Get a specific acquisition record

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Acquisition record

Response Schema: application/json

get/fuel-accounting/v1/acquisition-record/{record_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/acquisition-record/{record\_id}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"acquisition_record_id": "string",

"job_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"status": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/deleteAcquisitionRecord Delete an acquisition record

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Record deleted

Response Schema: application/json

delete/fuel-accounting/v1/acquisition-record/{record_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/acquisition-record/{record\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getLineItemsForAcquisitionRecord Get line items for an acquisition record

Authorizations:

bearerAuth

path Parameters

query Parameters

header Parameters

Responses

200

Line items for the record

Response Schema: application/json

get/fuel-accounting/v1/acquisition-record-line-item/{record_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/acquisition-record-line-item/{record\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getJobLineItems Get extracted line items from a document job

Authorizations:

bearerAuth

path Parameters

query Parameters

header Parameters

Responses

200

Extracted line items

Response Schema: application/json

get/fuel-accounting/v1/document-extraction-job-line-item/{job_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/document-extraction-job-line-item/{job\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getTransactionMatch Get transaction matching suggestions for a job

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Match suggestions

Response Schema: application/json

post/fuel-accounting/v1/match/{job_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/match/{job\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/updateTransactionMatch Update a transaction match for a job

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Match updated

Response Schema: application/json

patch/fuel-accounting/v1/match/{job_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/match/{job\_id}

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"update": {"transaction_index": 0,

"new_asset": "string",

"asset_id": "string",

"fuel_type": "string",

"always_link_by_id": true,

"always_link_by_card": true,

"exclude_row": true

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFtcReports List FTC reports

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

FTC report list

Response Schema: application/json

get/fuel-accounting/v1/ftc-report

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"ftc_report_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"status": "string",

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/createFtcReport Create a new FTC report

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

FTC report created

Response Schema: application/json

post/fuel-accounting/v1/ftc-report

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"ftc_report_data": {"from_date": "2019-08-24",

"to_date": "2019-08-24"

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFtcReport Get a specific FTC report

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

FTC report details

Response Schema: application/json

get/fuel-accounting/v1/ftc-report/{ftc_report_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report/{ftc\_report\_id}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"ftc_report_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"status": "string",

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/updateFtcReport Update an FTC report

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

object

Responses

200

FTC report updated

Response Schema: application/json

put/fuel-accounting/v1/ftc-report/{ftc_report_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report/{ftc\_report\_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/deleteFtcReport Delete an FTC report

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Report deleted

Response Schema: application/json

delete/fuel-accounting/v1/ftc-report/{ftc_report_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report/{ftc\_report\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFtcReportPdfUrl Get a download URL for the FTC report PDF

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

PDF download URL

Response Schema: application/json

get/fuel-accounting/v1/ftc-report/pdf/{ftc_report_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report/pdf/{ftc\_report\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFtcAuditPackUrl Get a download URL for the FTC audit package ZIP

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

ZIP download URL

Response Schema: application/json

get/fuel-accounting/v1/ftc-report/zip/{ftc_report_id}

Production

https://api.prismapp.com.au/fuel-accounting/v1/ftc-report/zip/{ftc\_report\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getGroupedLineItemSummary Get a grouped summary of filtered fuel transaction line items

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Grouped summary

Response Schema: application/json

post/fuel-accounting/v1/filtered-line-item/grouped-summary

Production

https://api.prismapp.com.au/fuel-accounting/v1/filtered-line-item/grouped-summary

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"fuel_type_ids": ["string"

],

"card_ids": ["string"

],

"asset_ids": ["string"

],

"transaction_types": ["string"

],

"sources": ["string"

],

"connected": true,

"group_by": "string",

"summarise_by": "string",

"offset": 0,

"pagesize": 50

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getGroupedLineItemDetails Get detailed rows within a specific group of filtered line items

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Grouped detail rows

Response Schema: application/json

post/fuel-accounting/v1/filtered-line-item/grouped-details

Production

https://api.prismapp.com.au/fuel-accounting/v1/filtered-line-item/grouped-details

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"fuel_type_ids": ["string"

],

"card_ids": ["string"

],

"asset_ids": ["string"

],

"transaction_types": ["string"

],

"sources": ["string"

],

"connected": true,

"group_by": "string",

"summarise_by": "string",

"offset": 0,

"pagesize": 50,

"group_key": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getFilteredLineItems Get filtered fuel transaction line items

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Filtered line items

Response Schema: application/json

post/fuel-accounting/v1/filtered-line-item

Production

https://api.prismapp.com.au/fuel-accounting/v1/filtered-line-item

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"fuel_type_ids": ["string"

],

"card_ids": ["string"

],

"asset_ids": ["string"

],

"transaction_types": ["string"

],

"sources": ["string"

],

"connected": true,

"group_by": "string",

"summarise_by": "string",

"offset": 0,

"pagesize": 50

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/exportFilteredLineItemsCsv Export filtered line items as CSV

Authorizations:

bearerAuth

query Parameters

header Parameters

Request Body schema: application/json required

Responses

200

CSV download URL or content

Response Schema: application/json

post/fuel-accounting/v1/filtered-line-item/csv

Production

https://api.prismapp.com.au/fuel-accounting/v1/filtered-line-item/csv

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"fuel_type_ids": ["string"

],

"card_ids": ["string"

],

"asset_ids": ["string"

],

"transaction_types": ["string"

],

"sources": ["string"

],

"connected": true,

"group_by": "string",

"summarise_by": "string",

"offset": 0,

"pagesize": 50

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Fuel-Accounting/operation/getMonthlyFuelTemplateCsv Download a monthly fuel template CSV

Authorizations:

bearerAuth

query Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Monthly CSV template

Response Schema: application/json

post/fuel-accounting/v1/monthly-fuel-csv

Production

https://api.prismapp.com.au/fuel-accounting/v1/monthly-fuel-csv

Request samples

• Payload

Content type

application/json

Copy

`{"month_start_date": "2019-08-24"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics Analytics

Fleet analytics, scoreboard metrics, fuel cost analysis, and AI summaries

tag/Analytics/operation/getScoreboardAnalysis Get scoreboard summary metrics for a date range

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Scoreboard metrics

Response Schema: application/json

post/analytics/v1/scoreboard-analysis

Production

https://api.prismapp.com.au/analytics/v1/scoreboard-analysis

Request samples

• Payload

Content type

application/json

Copy

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"fuel_type": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getFuelCostAnalysis Get fuel cost analysis for a date range

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Fuel cost analysis

Response Schema: application/json

get/analytics/v1/fuel-cost-analysis

Production

https://api.prismapp.com.au/analytics/v1/fuel-cost-analysis

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getPriceRangeAnalysis Analyse fuel price ranges across a date range

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Price range analysis

Response Schema: application/json

post/analytics/v1/price-range-analysis

Production

https://api.prismapp.com.au/analytics/v1/price-range-analysis

Request samples

• Payload

Content type

application/json

Copy

`{"start_date": "2019-08-24",

"end_date": "2019-08-24",

"lense": "string",

"fuel_type": "string"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getFleetAnalytics Get fleet-level analytics for a date range

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Fleet analytics

Response Schema: application/json

get/analytics/v1/fleet-analytics

Production

https://api.prismapp.com.au/analytics/v1/fleet-analytics

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getFleetAnalysisCalendarView Get calendar view of fleet activity data

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Calendar view data

Response Schema: application/json

get/analytics/v1/fleet-analysis/calendar-view

Production

https://api.prismapp.com.au/analytics/v1/fleet-analysis/calendar-view

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getQuickViewAnalysis Get a quick-view summary for an acquisition record

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Quick view summary

Response Schema: application/json

get/analytics/v1/quick-view-analysis

Production

https://api.prismapp.com.au/analytics/v1/quick-view-analysis

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getAISummaries Get AI-generated summaries for an acquisition record

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

AI summaries

Response Schema: application/json

get/analytics/v1/ai-summaries

Production

https://api.prismapp.com.au/analytics/v1/ai-summaries

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getMonthlySeries Get monthly time-series data for a date range

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Monthly series data

Response Schema: application/json

get/analytics/v1/monthly-series

Production

https://api.prismapp.com.au/analytics/v1/monthly-series

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/getFlaggedTrips Get flagged trips matching filter criteria

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Flagged trips

Response Schema: application/json

post/analytics/v1/flagged-trip

Production

https://api.prismapp.com.au/analytics/v1/flagged-trip

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"start_time": "2019-08-24T14:15:22Z",

"end_time": "2019-08-24T14:15:22Z",

"filters": { },

"approval_status": "pending",

"selected_filter_name": "string",

"summary": true,

"offset": 0,

"pagesize": 0

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/setTripApprovalStatus Set the approval status of a single flagged trip

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Trip status updated

Response Schema: application/json

patch/analytics/v1/flagged-trip/{trip_id}

Production

https://api.prismapp.com.au/analytics/v1/flagged-trip/{trip\_id}

Request samples

• Payload

Content type

application/json

Copy

`{"approval_status": "approved"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/setTripApprovalStatusBulk Set approval status for multiple flagged trips at once

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Trips updated

Response Schema: application/json

post/analytics/v1/flagged-trip/bulk

Production

https://api.prismapp.com.au/analytics/v1/flagged-trip/bulk

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"ids": ["string"

],

"approval_status": "approved"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Analytics/operation/chatCompletions AI chat completions for data analysis

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Chat completion response

Response Schema: application/json

post/analytics/v1/ai/chat/completions

Production

https://api.prismapp.com.au/analytics/v1/ai/chat/completions

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"model": "string",

"temperature": 2,

"messages": [{"role": "system",

"content": "string"

}

]

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Emissions Emissions

Emissions reports and standards

tag/Emissions/operation/getEmissionsReports List emissions reports

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Emissions report list

Response Schema: application/json

get/emissions/v1/emissions-report

Production

https://api.prismapp.com.au/emissions/v1/emissions-report

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"emissions_report_id": "string",

"emissions_standard_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"finalised": true,

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Emissions/operation/createEmissionsReport Create a new emissions report

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Emissions report created

Response Schema: application/json

post/emissions/v1/emissions-report

Production

https://api.prismapp.com.au/emissions/v1/emissions-report

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"emissions_standard_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"local_from_date": "2019-08-24",

"local_to_date": "2019-08-24",

"excluded_acquisition_line_item_ids": ["string"

]

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Emissions/operation/getEmissionsReport Get a specific emissions report

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Emissions report

Response Schema: application/json

get/emissions/v1/emissions-report/{emissions_report_id}

Production

https://api.prismapp.com.au/emissions/v1/emissions-report/{emissions\_report\_id}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"emissions_report_id": "string",

"emissions_standard_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"finalised": true,

"created_at": "2019-08-24T14:15:22Z"

},

"size": 0,

"total": 0

}`

tag/Emissions/operation/updateEmissionsReport Update an emissions report

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Report updated

Response Schema: application/json

put/emissions/v1/emissions-report/{emissions_report_id}

Production

https://api.prismapp.com.au/emissions/v1/emissions-report/{emissions\_report\_id}

Request samples

• Payload

Content type

application/json

Copy

`{"emissions_report_id": "string",

"emissions_standard_id": "string",

"from_date": "2019-08-24",

"to_date": "2019-08-24",

"finalised": true,

"created_at": "2019-08-24T14:15:22Z"

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Emissions/operation/deleteEmissionsReport Delete an emissions report

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Report deleted

Response Schema: application/json

delete/emissions/v1/emissions-report/{emissions_report_id}

Production

https://api.prismapp.com.au/emissions/v1/emissions-report/{emissions\_report\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Emissions/operation/setEmissionsReportFinalised Mark an emissions report as finalised or un-finalised

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

Responses

200

Finalised status updated

Response Schema: application/json

patch/emissions/v1/emissions-report/{emissions_report_id}/finalised

Production

https://api.prismapp.com.au/emissions/v1/emissions-report/{emissions\_report\_id}/finalised

Request samples

• Payload

Content type

application/json

Copy

`{"finalised": true

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Emissions/operation/getEmissionsStandards List all supported emissions standards

Authorizations:

bearerAuth

header Parameters

Responses

200

Emissions standards

Response Schema: application/json

get/emissions/v1/standards

Production

https://api.prismapp.com.au/emissions/v1/standards

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Emissions/operation/getEmissionsStandard Get details for a specific emissions standard

Authorizations:

bearerAuth

path Parameters

query Parameters

header Parameters

Responses

200

Emissions standard details

Response Schema: application/json

get/emissions/v1/standards/{standard_id}

Production

https://api.prismapp.com.au/emissions/v1/standards/{standard\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Areas Areas

Custom geographic area management

tag/Areas/operation/listCustomAreas List custom geographic areas for the current client

Authorizations:

bearerAuth

header Parameters

Responses

200

Custom area list

Response Schema: application/json

get/areas/v1

Production

https://api.prismapp.com.au/areas/v1

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"custom_area_id": "string",

"name": "string",

"area_type": "string",

"created_at": "2019-08-24T14:15:22Z"

}

],

"size": 0,

"total": 0

}`

tag/Areas/operation/createCustomArea Create a new custom area from a GeoJSON feature collection

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

object

GeoJSON FeatureCollection with custom area properties

Responses

200

Custom area created

Response Schema: application/json

post/areas/v1

Production

https://api.prismapp.com.au/areas/v1

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Areas/operation/getCustomArea Get a specific custom area (GeoJSON with Accept header)

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Custom area details

Response Schema: application/json

get/areas/v1/{custom_area_id}

Production

https://api.prismapp.com.au/areas/v1/{custom\_area\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Areas/operation/updateCustomArea Update a custom area

Authorizations:

bearerAuth

path Parameters

header Parameters

Request Body schema: application/json required

object

GeoJSON FeatureCollection with updated area properties

Responses

200

Custom area updated

Response Schema: application/json

put/areas/v1/{custom_area_id}

Production

https://api.prismapp.com.au/areas/v1/{custom\_area\_id}

Request samples

• Payload

Content type

application/json

Copy

{ }

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Areas/operation/deleteCustomArea Delete a custom area

Authorizations:

bearerAuth

path Parameters

header Parameters

Responses

200

Custom area deleted

Response Schema: application/json

delete/areas/v1/{custom_area_id}

Production

https://api.prismapp.com.au/areas/v1/{custom\_area\_id}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing Billing

Subscription plans, payments, and billing management

tag/Billing/operation/getBillingPlans Get available subscription plans (public)

Responses

200

Available plans

Response Schema: application/json

get/billing/v1/plans

Production

https://api.prismapp.com.au/billing/v1/plans

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": [{"plan_id": "string",

"name": "string",

"price": 0,

"billing_frequency": "monthly",

"features": ["string"

]

}

],

"size": 0,

"total": 0

}`

tag/Billing/operation/getBillingAddress Get the billing address for the current client

Authorizations:

bearerAuth

header Parameters

Responses

200

Billing address

Response Schema: application/json

get/billing/v1/address

Production

https://api.prismapp.com.au/billing/v1/address

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/createOrUpdateBillingAddress Create or update the billing address

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Billing address saved

Response Schema: application/json

put/billing/v1/address

Production

https://api.prismapp.com.au/billing/v1/address

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"data": {"line1": "string",

"line2": "string",

"city": "string",

"state": "string",

"postcode": "string",

"country": "string"

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/getPaymentIntent Get a Stripe payment intent for a new subscription

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Payment intent client secret

Response Schema: application/json

get/billing/v1/payment/intent

Production

https://api.prismapp.com.au/billing/v1/payment/intent

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/getActiveSubscription Get the current active subscription

Authorizations:

bearerAuth

header Parameters

Responses

200

Active subscription

Response Schema: application/json

get/billing/v1/subscription

Production

https://api.prismapp.com.au/billing/v1/subscription

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/cancelSubscription Cancel the active subscription

Authorizations:

bearerAuth

header Parameters

Responses

200

Subscription cancelled

Response Schema: application/json

post/billing/v1/subscription/cancel

Production

https://api.prismapp.com.au/billing/v1/subscription/cancel

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/getBillingPortal Get a link to the Stripe billing portal

Authorizations:

bearerAuth

header Parameters

Responses

200

Billing portal URL

Response Schema: application/json

get/billing/v1/portal

Production

https://api.prismapp.com.au/billing/v1/portal

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"status": 200,

"message": "string",

"data": {"url": "http://example.com"

},

"size": 0,

"total": 0

}`

tag/Billing/operation/getLatestQuote Get the latest custom quote for the current client

Authorizations:

bearerAuth

header Parameters

Responses

200

Latest quote

Response Schema: application/json

get/billing/v1/quote/latest

Production

https://api.prismapp.com.au/billing/v1/quote/latest

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/createQuote Create a custom pricing quote

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

Quote created

Response Schema: application/json

post/billing/v1/quote

Production

https://api.prismapp.com.au/billing/v1/quote

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"quote": {"client_id": "string",

"price": 0,

"billing_frequency": "monthly",

"payment_method": "string"

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/getLatestGpsRequest Get the latest GPS connection request

Authorizations:

bearerAuth

header Parameters

Responses

200

Latest GPS request

Response Schema: application/json

get/billing/v1/gps-request/latest

Production

https://api.prismapp.com.au/billing/v1/gps-request/latest

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Billing/operation/createGpsRequest Create a GPS connection request

Authorizations:

bearerAuth

header Parameters

Request Body schema: application/json required

Responses

200

GPS request created

Response Schema: application/json

post/billing/v1/gps-request

Production

https://api.prismapp.com.au/billing/v1/gps-request

Request samples

• Payload

Content type

application/json

Copy Expand all Collapse all

`{"request": {"provider": "string",

"vehicle_count": 0,

"notes": "string"

}

}`

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports Reports

FTC trip reports and scheduled report file generation

tag/Reports/operation/getFtcReportData Get FTC report data for a date range

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

FTC report data

Response Schema: application/json

get/reports/v1/ftc-report

Production

https://api.prismapp.com.au/reports/v1/ftc-report

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports/operation/getFtcTrips Get FTC trip details for a device

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

FTC trip details

Response Schema: application/json

get/reports/v1/ftc-trips

Production

https://api.prismapp.com.au/reports/v1/ftc-trips

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports/operation/listScheduledFtcReports List scheduled FTC report files

Authorizations:

bearerAuth

header Parameters

Responses

200

Scheduled report file list

Response Schema: application/json

get/report-files/v1

Production

https://api.prismapp.com.au/report-files/v1

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports/operation/downloadScheduledFtcReport Get a download URL for a scheduled FTC report file

Authorizations:

bearerAuth

path Parameters

query Parameters

header Parameters

Responses

200

Download URL

Response Schema: application/json

get/report-files/v1/{report_name}

Production

https://api.prismapp.com.au/report-files/v1/{report\_name}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports/operation/listAuditReports List audit report files

Authorizations:

bearerAuth

header Parameters

Responses

200

Audit report file list

Response Schema: application/json

get/report-files/v1/audit

Production

https://api.prismapp.com.au/report-files/v1/audit

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports/operation/downloadAuditReport Get a download URL for an audit report file

Authorizations:

bearerAuth

path Parameters

query Parameters

header Parameters

Responses

200

Download URL

Response Schema: application/json

get/report-files/v1/audit/{report_name}

Production

https://api.prismapp.com.au/report-files/v1/audit/{report\_name}

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reports/operation/generateScheduledFtcReport Queue generation of a new scheduled FTC report

Authorizations:

bearerAuth

query Parameters

header Parameters

Responses

200

Report generation queued

Response Schema: application/json

post/report-files/v1/generate

Production

https://api.prismapp.com.au/report-files/v1/generate

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reference-Data Reference Data

Lookup tables — roles, FTC rates, fuel use categories

tag/Reference-Data/operation/getRoles List all user roles

Authorizations:

bearerAuth

header Parameters

Responses

200

Role list

Response Schema: application/json

get/refs/v1/roles

Production

https://api.prismapp.com.au/refs/v1/roles

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reference-Data/operation/getFtcRates List FTC fuel tax credit rates

Authorizations:

bearerAuth

header Parameters

Responses

200

FTC rate table

Response Schema: application/json

get/refs/v1/ftc-rates

Production

https://api.prismapp.com.au/refs/v1/ftc-rates

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reference-Data/operation/getAuxiliaryFuelUses List auxiliary fuel use categories (safe harbour)

Authorizations:

bearerAuth

header Parameters

Responses

200

Auxiliary fuel use categories

Response Schema: application/json

get/refs/v1/auxiliary-fuel-uses

Production

https://api.prismapp.com.au/refs/v1/auxiliary-fuel-uses

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reference-Data/operation/getBusinessFuelUses List business fuel use types

Authorizations:

bearerAuth

header Parameters

Responses

200

Business fuel use types

Response Schema: application/json

get/refs/v1/business-fuel-uses

Production

https://api.prismapp.com.au/refs/v1/business-fuel-uses

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`

tag/Reference-Data/operation/getAuxiliaryFuelMethods List available auxiliary fuel calculation methods

Authorizations:

bearerAuth

header Parameters

Responses

200

Auxiliary fuel methods

Response Schema: application/json

get/refs/v1/auxiliary-fuel-methods

Production

https://api.prismapp.com.au/refs/v1/auxiliary-fuel-methods

Response samples

• 200

Content type

application/json

Copy

`{"status": 200,

"message": "string",

"data": null,

"size": 0,

"total": 0

}`