FoxInsights (Preview)

Bring FoxInsights tank data into your flows and business apps. Get devices, fill levels and the latest readings, trigger orders or alerts when a tank runs low, and keep partners, customers, products and tank settings in sync with your ERP or CRM.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name FoxInsights Partner Support
URL https://www.foxinsights.ai/en/contact
Email partner-support@foxinsights.ai
Connector Metadata
Publisher FoxInsights
Website https://www.foxinsights.ai
Privacy policy https://www.foxinsights.ai/en/privacy
Categories Internet of Things;Data

FoxInsights

Bring FoxInsights tank data into Power Automate, Power Apps and Copilot Studio, and through them into Dynamics 365. Get devices, fill levels and the latest readings, trigger orders or alerts when a tank runs low, and keep partners, customers, products and tank settings in sync with your ERP or CRM.

Publisher: FoxInsights

Prerequisites

  • A FoxInsights partner account with the Partner API enabled. Contact partner-support@foxinsights.ai to enable it.
  • Partner API credentials (Client ID and Client secret), created in the FoxInsights portal under Settings > Partner API.

Supported Operations

Partners

  • List partners: the partner that owns the credentials and all sub-partners as a flat list.
  • Get partner tree: the same partners as a nested tree.
  • Get partner / Search partners by internal ID.
  • Create partner, Rename partner, Update partner internal ID, Set partner notification emails, Set partner products.

Devices

  • Get partner devices: devices of one partner with current fill level and latest measurement. Devices of sub-partners are not included.
  • Get device, Get user devices, Search devices by internal ID, Search devices by company, Get device cancellation state.
  • Update device name and notes, Update device address, Set device labels, Update device notifications, Lock or unlock device, Move device to partner, Change device product, Cancel device contract.
  • Set custom tank, Set catalogue tank, Set silo, Delete tank configuration.

End customers

  • Get user, Get user by email, Search users by internal ID, Search users by custom field.
  • Create user, Update user, Assign device to user, Unassign device from user.

Products

  • Search products by code, Get product types, Get predefined tank types.
  • Create product, Update product.

Obtaining Credentials

  1. Sign in to the FoxInsights portal as a partner administrator.
  2. Open Settings > Partner API and select New credentials.
  3. Copy the Client ID and Client secret. The secret is shown only once.

The credentials give access to the partner that created them and all of its sub-partners. Create separate credentials for each integration so they can be revoked independently.

Getting Started

  1. Create a connection with the Client ID and Client secret. The connector requests access tokens automatically; no token has to be entered or renewed.
  2. Add List partners to a flow and loop over the result with Apply to each.
  3. Inside the loop, add Get partner devices with the partner ID from the loop.
  4. Map the device fields to the target system, for example a Dataverse table or a Business Central record, keyed by Hardware ID.

Known Issues and Limitations

  • Device lists are returned per partner without paging. To cover a partner tree, call Get partner devices for each partner from List partners.
  • Only the latest measurement is available; there is no measurement history.
  • Measured at is the time of the latest reliable measurement, not the time of the last sync. A device without a measurement has no Measured at; its fill level can be reported as 0, so check Measured at before using the fill level.
  • Fill levels can exceed 100 percent.
  • Set device labels, Set partner notification emails and Set partner products replace the whole list.
  • Unassign device from user deletes the device address and tank settings unless Keep device settings is set.
  • Create partner, Create user and Create product are not safe to retry: a repeated call creates a duplicate or fails.
  • Cancel device contract cannot be undone through the connector.
  • Rate limits of the Partner API apply per credentials; a 429 response means the limit was reached.

Frequently asked questions

Does the connector store FoxInsights data?

No. Each action reads or writes FoxInsights data at the time it runs.

Can one connection see several partners?

Yes. A connection sees the partner that created the credentials and all of its sub-partners.

Where do I get help?

Contact partner-support@foxinsights.ai.

Deployment Instructions

Deploy the connector as a custom connector with the Power Platform CLI:

pac connector create --api-definition-file apiDefinition.swagger.json --api-properties-file apiProperties.json --script-file script.csx

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Client ID securestring Client ID of the Partner API credentials created in FoxInsights under Settings > Partner API True
Client secret securestring Client secret of the Partner API credentials True

Actions

Assign device to user

Assigns a device to an end customer.

Cancel device contract

Marks the device contract for cancellation on the given date.

Change device product

Changes the product stored in the device's tank or silo.

Create partner

Creates a sub-partner. Not safe to retry: a repeated call creates a second partner.

Create product

Creates a product. Not safe to retry: a repeated call creates a second product.

Create user

Creates an end customer. Not safe to retry: a repeated call fails or creates a duplicate.

Delete tank configuration

Removes the tank or silo configuration of the device; fill levels are not computed until a new configuration is set.

Get device

Returns one device by its hardware ID, with its current fill level and latest measurement.

Get device cancellation state

Returns whether the device contract is cancelled or marked for cancellation and from when it can be cancelled.

Get partner

Returns one partner with its internal ID, products and notification e-mail addresses.

Get partner devices

Returns the devices that belong directly to one partner, with their current fill level and latest measurement. Devices of sub-partners are not included.

Get partner tree

Returns the partner that owns the connection credentials together with all of its sub-partners as a nested tree. Use 'List partners' to loop over partners in a flow.

Get predefined tank types

Returns the catalogue tank types available for a product.

Get product types

Returns all product types with their default settings.

Get user

Returns one end customer.

Get user by email

Returns the end customer with the given e-mail address.

Get user devices

Returns the devices assigned to one end customer, with their current fill level and latest measurement.

List partners

Returns the partner that owns the connection credentials and all of its sub-partners as a flat list, ready for 'Apply to each'.

Lock or unlock device

Locks or unlocks the device configuration for end customers.

Move device to partner

Moves the device to another partner within the accessible partner tree.

Rename partner

Changes the partner name.

Search devices by company

Returns the devices whose address company matches the given name.

Search devices by internal ID

Returns the devices with the given partner-specific internal ID.

Search partners by internal ID

Returns the partners with the given internal ID.

Search products by code

Returns the products with the given product code.

Search users by custom field

Returns the end customers whose custom field has the given value.

Search users by internal ID

Returns the end customers with the given internal ID.

Set catalogue tank

Configures the device for a catalogue tank type (see 'Get predefined tank types'); replaces any previous tank or silo configuration.

Set custom tank

Configures the device for a tank described by its dimensions; replaces any previous tank or silo configuration.

Set device labels

Replaces all labels of the device with the given list; labels not in the list are removed.

Set partner notification emails

Replaces the list of e-mail addresses that receive partner notifications.

Set partner products

Replaces the list of products assigned to the partner.

Set silo

Configures the device for a silo; replaces any previous tank or silo configuration.

Unassign device from user

Removes a device from an end customer. Without Keep device settings, the device address and tank settings are deleted.

Update device address

Replaces the device address.

Update device name and notes

Replaces the device name, internal ID and partner notes.

Update device notifications

Sets the fill levels at which the info and alert notifications are sent.

Update partner internal ID

Changes the partner's internal ID.

Update product

Replaces all fields of a product.

Update user

Replaces all fields of an end customer; fields left empty are cleared.

Assign device to user

Assigns a device to an end customer.

Parameters

Name Key Required Type Description
User ID
userId True string

ID of the end customer.

Hardware ID
hwid True string
Keep device settings
keepData True boolean

Yes to keep the device's address and tank settings.

Returns

Body
Device

Cancel device contract

Marks the device contract for cancellation on the given date.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Cancel at year
year True integer
Cancel at month
month True integer
Cancel at day
day True integer

Returns

Change device product

Changes the product stored in the device's tank or silo.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Product ID
productId True string

ID of the new product.

Returns

Body
Device

Create partner

Creates a sub-partner. Not safe to retry: a repeated call creates a second partner.

Parameters

Name Key Required Type Description
Partner name
name True string
Partner internal ID
internalId string
Parent partner
parentId True string

Partner under which the new partner is created.

Product IDs
productIds True array of string

Products assigned to the new partner.

Returns

Body
Partner

Create product

Creates a product. Not safe to retry: a repeated call creates a second product.

Parameters

Name Key Required Type Description
Product name
name True string
Product code
code True string
Product type
type True string
Density (kg per L)
densityKgpl double
Image URL
imageUrl True string

Image URL; take it from 'Get product types'.

Measurement interval
measurementInterval True integer

Take the default from 'Get product types'.

Safety margin
safetyMargin True double

Take the default from 'Get product types'.

100 percent basis
displayAs100Percent True string
Partner IDs
partnerIds True array of string

Partners the product is assigned to.

Offline notification enabled
enabled boolean
Offline notification first count
countFirst integer
Offline notification second count
countSecond integer
Offline notification recurring count
countRecurring integer
Metering hour
hour integer
Metering minute
minute integer

Returns

Body
Product

Create user

Creates an end customer. Not safe to retry: a repeated call fails or creates a duplicate.

Parameters

Name Key Required Type Description
Email
email True string
First name
firstName True string
Last name
lastName True string
Title
title string
Phone
phone string
Company name
companyName True string

Company name; may be empty.

Company position
companyPosition string
Street
street string
Postal code
zipCode string
City
city string
Country
country True string

Country as ISO 3166-1 alpha-2 code.

Locale
locale True string

Language and region, e.g. de-DE.

Role
role True string

USER for private customers, B2B_CUSTOMER / B2B_ADMIN for business customers.

User internal ID
internalId string
User partner
partnerId string

Partner the user belongs to.

Custom fields
customFields True object

Custom fields as a JSON object of name/value pairs; use {} for none.

Returns

Body
User

Delete tank configuration

Removes the tank or silo configuration of the device; fill levels are not computed until a new configuration is set.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Returns

Body
Device

Get device

Returns one device by its hardware ID, with its current fill level and latest measurement.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Returns

Body
Device

Get device cancellation state

Returns whether the device contract is cancelled or marked for cancellation and from when it can be cancelled.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device.

Returns

Get partner

Returns one partner with its internal ID, products and notification e-mail addresses.

Parameters

Name Key Required Type Description
Partner
partnerId True string

Partner to return.

Returns

Body
Partner

Get partner devices

Returns the devices that belong directly to one partner, with their current fill level and latest measurement. Devices of sub-partners are not included.

Parameters

Name Key Required Type Description
Partner
partnerId True string

Partner whose own devices are returned.

Returns

response
array of Device

Get partner tree

Returns the partner that owns the connection credentials together with all of its sub-partners as a nested tree. Use 'List partners' to loop over partners in a flow.

Returns

Get predefined tank types

Returns the catalogue tank types available for a product.

Parameters

Name Key Required Type Description
Product ID
productId True string

ID of the product.

Returns

Get product types

Returns all product types with their default settings.

Returns

Get user

Returns one end customer.

Parameters

Name Key Required Type Description
User ID
userId True string

ID of the end customer.

Returns

Body
User

Get user by email

Returns the end customer with the given e-mail address.

Parameters

Name Key Required Type Description
Email
email True string

E-mail address of the end customer.

Returns

Body
User

Get user devices

Returns the devices assigned to one end customer, with their current fill level and latest measurement.

Parameters

Name Key Required Type Description
User ID
userId True string

ID of the end customer.

Returns

response
array of Device

List partners

Returns the partner that owns the connection credentials and all of its sub-partners as a flat list, ready for 'Apply to each'.

Returns

Lock or unlock device

Locks or unlocks the device configuration for end customers.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Locked
isLocked True boolean

Yes to lock the configuration for end customers.

Returns

Body
Device

Move device to partner

Moves the device to another partner within the accessible partner tree.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Target partner
partnerId True string

Partner to move the device to.

Returns

Body
Device

Rename partner

Changes the partner name.

Parameters

Name Key Required Type Description
Partner
partnerId True string

Partner to change.

New partner name
name True string

Returns

Body
Partner

Search devices by company

Returns the devices whose address company matches the given name.

Parameters

Name Key Required Type Description
Company
company True string

Company name in the device address.

Returns

response
array of Device

Search devices by internal ID

Returns the devices with the given partner-specific internal ID.

Parameters

Name Key Required Type Description
Internal ID
internalId True string

Partner's own ID for the device.

Returns

response
array of Device

Search partners by internal ID

Returns the partners with the given internal ID.

Parameters

Name Key Required Type Description
Internal ID
internalId True string

Internal ID of the partner.

Returns

response
array of Partner

Search products by code

Returns the products with the given product code.

Parameters

Name Key Required Type Description
Product code
productCode True string

Product code.

Returns

response
array of Product

Search users by custom field

Returns the end customers whose custom field has the given value.

Parameters

Name Key Required Type Description
Custom field name
fieldName True string

Name of the custom field.

Custom field value
fieldValue True string

Value to search for.

Returns

response
array of User

Search users by internal ID

Returns the end customers with the given internal ID.

Parameters

Name Key Required Type Description
Internal ID
internalId True string

Internal ID of the end customer.

Returns

response
array of User

Set catalogue tank

Configures the device for a catalogue tank type (see 'Get predefined tank types'); replaces any previous tank or silo configuration.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Tank type ID
storageTypeId True string

Catalogue tank type ID from 'Get predefined tank types'.

Number of tanks
storageCount True integer

Number of connected tanks of this type.

Sensor offset (cm)
offsetTopCm True double
Mounting type
mountingType True string

How the sensor is mounted.

Product ID
productId True string

ID of the stored product.

Returns

Body
Device

Set custom tank

Configures the device for a tank described by its dimensions; replaces any previous tank or silo configuration.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Tank height (cm)
heightCm True double
Sensor offset (cm)
offsetCm True double

Distance between sensor and tank top.

Tank volume (L)
volumeL True integer
Volume is usable volume
isUsableVolume True boolean

Yes if the volume is the usable volume, no if it is the total volume.

Tank shape
shape True string

VERTICAL_CYLINDER is stored as sent but reported as SQUARED.

Mounting type
mountingType True string

How the sensor is mounted.

Product ID
productId True string

ID of the stored product.

Returns

Body
Device

Set device labels

Replaces all labels of the device with the given list; labels not in the list are removed.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Labels
labels True array of string

Complete list of labels; replaces the current labels.

Returns

Body
Device

Set partner notification emails

Replaces the list of e-mail addresses that receive partner notifications.

Parameters

Name Key Required Type Description
Partner
partnerId True string

Partner to change.

Notification emails
notificationEmails True array of string

Complete list; replaces the current addresses.

Returns

Body
Partner

Set partner products

Replaces the list of products assigned to the partner.

Parameters

Name Key Required Type Description
Partner
partnerId True string

Partner to change.

Product IDs
productIds True array of string

Complete list; replaces the current products.

Returns

Body
Partner

Set silo

Configures the device for a silo; replaces any previous tank or silo configuration.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Silo height (cm)
heightCm True double
Silo width (cm)
widthCm True double
Silo length (cm)
lengthCm True double
Silo top offset (cm)
offsetTopCm True double
Silo side offset (cm)
offsetSideCm True double
Silo store type
storeType True string
Silo mounting
mounting True string
Silo capacity (kg)
massKg True integer
Product ID
productId True string

ID of the stored product.

Returns

Body
Device

Unassign device from user

Removes a device from an end customer. Without Keep device settings, the device address and tank settings are deleted.

Parameters

Name Key Required Type Description
User ID
userId True string

ID of the end customer.

Hardware ID
hwid True string
Keep device settings
keepData boolean

Yes to keep the device's address and tank settings; default no deletes them.

Returns

Body
Device

Update device address

Replaces the device address.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Company
company True string

Company; may be empty.

Street
streetLines True string

Street and house number.

Postal code
zipCode True string

Postal code.

City
city True string

City.

Country
country True string

Country as ISO 3166-1 alpha-2 code.

Returns

Body
Device

Update device name and notes

Replaces the device name, internal ID and partner notes.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Device name
name string

Device name; leave empty to clear.

Internal ID
internalId True string

Partner's own ID for the device; empty string clears it.

Partner notes
partnerNotes True string

Partner notes; empty string clears them.

Returns

Body
Device

Update device notifications

Sets the fill levels at which the info and alert notifications are sent.

Parameters

Name Key Required Type Description
Hardware ID
hwid True string

Hardware ID of the device, printed on the sensor.

Info notification enabled
notificationInfoEnabled True boolean
Info notification level (percent)
notificationInfoPercentage True integer

Fill level in percent (0-100) that triggers the info notification.

Alert notification enabled
notificationAlertEnabled True boolean
Alert notification level (percent)
notificationAlertPercentage True integer

Fill level in percent (0-100) that triggers the alert notification.

Returns

Body
Device

Update partner internal ID

Changes the partner's internal ID.

Parameters

Name Key Required Type Description
Partner
partnerId True string

Partner to change.

New partner internal ID
internalId True string

Returns

Body
Partner

Update product

Replaces all fields of a product.

Parameters

Name Key Required Type Description
Product ID
productId True string

ID of the product.

Product name
name True string
Product code
code True string
Product type
type True string
Density (kg per L)
densityKgpl double
Image URL
imageUrl True string

Image URL; take it from 'Get product types'.

Measurement interval
measurementInterval True integer

Take the default from 'Get product types'.

Safety margin
safetyMargin True double

Take the default from 'Get product types'.

100 percent basis
displayAs100Percent True string
Partner IDs
partnerIds True array of string

Partners the product is assigned to.

Offline notification enabled
enabled boolean
Offline notification first count
countFirst integer
Offline notification second count
countSecond integer
Offline notification recurring count
countRecurring integer
Metering hour
hour integer
Metering minute
minute integer

Returns

Body
Product

Update user

Replaces all fields of an end customer; fields left empty are cleared.

Parameters

Name Key Required Type Description
User ID
userId True string

ID of the end customer.

Email
email True string
First name
firstName True string
Last name
lastName True string
Title
title string
Phone
phone string
Company name
companyName True string

Company name; may be empty.

Company position
companyPosition string
Street
street string
Postal code
zipCode string
City
city string
Country
country True string

Country as ISO 3166-1 alpha-2 code.

Locale
locale True string

Language and region, e.g. de-DE.

Role
role True string

USER for private customers, B2B_CUSTOMER / B2B_ADMIN for business customers.

User internal ID
internalId string
User partner
partnerId string

Partner the user belongs to.

Custom fields
customFields True object

Custom fields as a JSON object of name/value pairs; use {} for none.

Returns

Body
User

Definitions

Partner

Name Path Type Description
Partner ID
id uuid

Partner ID.

Partner internal ID
internalId string

Partner's internal ID.

Partner name
name string

Partner name.

Products
products array of PartnerProduct

Products assigned to the partner.

Notification emails
notificationEmails array of string

E-mail addresses that receive partner notifications.

User

Name Path Type Description
User ID
id uuid

User ID.

User internal ID
internalId string

Partner's own ID for the end customer.

User partner ID
partnerId uuid

ID of the partner the user belongs to.

Email
email string

E-mail address.

Phone
phone string

Phone number.

Title
title string

Title.

First name
firstName string

First name.

Last name
lastName string

Last name.

Company name
companyName string

Company name.

Company position
companyPosition string

Position in the company, e.g. MANAGEMENT, SALES, DISPATCHING.

Street
street string

Street and house number.

Postal code
zipCode string

Postal code.

City
city string

City.

Country
country string

Country as ISO 3166-1 alpha-2 code.

Locale
locale string

Language and region, e.g. de-DE.

Role
role string

Role, e.g. USER, B2B_CUSTOMER, B2B_ADMIN.

Custom fields
customFields object

Partner-defined custom fields as name/value pairs.

Product

Name Path Type Description
Product ID
id uuid

Product ID.

Product name
name string

Product name.

Product code
code string

Product code.

Product type
type string

Product type, e.g. HEATING_OIL, DIESEL, LPG, PELLETS.

Is collecting
isCollecting boolean

Whether the product is collected (e.g. waste oil) instead of consumed.

Density (kg per L)
densityKgpl double

Density in kg per litre.

Measurement interval
measurementInterval integer

Measurement interval.

100 percent basis
displayAs100Percent string

Which capacity counts as 100 percent: USABLE_VOLUME or TOTAL_VOLUME.

Safety margin
safetyMargin double

Safety margin.

Image URL
imageUrl string

Product image URL.

Partner IDs
partnerIds array of uuid

Partners the product is assigned to.

Offline notification enabled
offlineNotification.enabled boolean
Offline notification first count
offlineNotification.countFirst integer
Offline notification second count
offlineNotification.countSecond integer
Offline notification recurring count
offlineNotification.countRecurring integer
Default quality index
qualityList.defaultIndex integer
default
qualityList.default ProductQuality
Qualities
qualityList.items array of ProductQuality
Metering hour
meteringTime.hour integer
Metering minute
meteringTime.minute integer
Metering second
meteringTime.second integer
Metering nanosecond
meteringTime.nano integer

ProductQuality

Name Path Type Description
Quality ID
id uuid
Quality name
name string
Quality code
code string

ProductType

Name Path Type Description
Product type
type string

Product type, e.g. HEATING_OIL, DIESEL, LPG, PELLETS.

Default density (kg per L)
defaultDensityKgpl double

Default density in kg per litre.

Default measurement interval
measurementInterval integer
Default safety margin
safetyMargin double
Default 100 percent basis
displayAs100Percent string

USABLE_VOLUME or TOTAL_VOLUME.

Image URL
imageUrl string

PredefinedTankTypes

Name Path Type Description
Tank types
types array of TankPredefinedType

Catalogue tank types.

CancellationState

Name Path Type Description
Hardware ID
hwid string

Hardware ID of the device.

Is cancelled
isCancelled boolean

Whether the device contract is cancelled.

Cancellable after year
cancellableAfter.year integer
Cancellable after month
cancellableAfter.month integer
Cancellable after day
cancellableAfter.day integer
Cancellation year
markedForCancellationOn.year integer
Cancellation month
markedForCancellationOn.month integer
Cancellation day
markedForCancellationOn.day integer

CancelDeviceRequest

Name Path Type Description
Cancel at year
cancelAt.year integer
Cancel at month
cancelAt.month integer
Cancel at day
cancelAt.day integer

PartnerTree

Name Path Type Description
Partner ID
id uuid

Partner ID.

Partner name
name string

Partner name.

Products
products array of PartnerProduct

Products assigned to the partner.

Subpartners
children array of object

Sub-partners, each with the same structure as the partner.

items
children object

PartnerListItem

Name Path Type Description
Partner ID
id uuid

Partner ID.

Partner name
name string

Partner name.

Parent partner ID
parentId uuid

ID of the parent partner; empty for the partner that owns the credentials.

Depth
depth integer

Level in the partner tree; 0 for the partner that owns the credentials.

Products
products array of PartnerProduct

Products assigned to the partner.

PartnerProduct

Name Path Type Description
Product ID
id uuid

Product ID.

Product name
name string

Product name.

Product code
code string

Product code.

Product type
type string

Product type, e.g. HEATING_OIL.

Device

Name Path Type Description
Hardware ID
hwid string

Hardware ID of the device; stable key for the device.

Device name
name string

Device name.

Partner ID
partnerId uuid

ID of the partner the device belongs to.

Internal ID
internalId string

Partner's own ID for the device; may be empty and is not guaranteed to be unique.

Partner notes
partnerNotes string

Partner notes.

Product ID
productId uuid

ID of the stored product.

Product code
productCode string

Code of the stored product.

User ID
userId uuid

ID of the end customer the device is assigned to.

Has service agreement
hasServiceAgreement boolean

Whether the end customer has a service agreement.

Maintenance state
maintenanceState string

Maintenance state: UNKNOWN, OK, COMPLAINED, SENT_BACK, RECEIVED, CHECKED or DEFECT.

address
address Address
Max volume (legacy)
maxVolume integer

Legacy maximum volume in litres; use Usable quantity / Total quantity instead.

lastMetering
lastMetering Metering

Latest reliable measurement; empty when the device has not measured yet.

Info notification enabled
notificationInfoEnabled boolean

Whether the info notification is enabled.

Info notification level (percent)
notificationInfoPercentage integer

Fill level in percent that triggers the info notification.

Alert notification enabled
notificationAlertEnabled boolean

Whether the alert notification is enabled.

Alert notification level (percent)
notificationAlertPercentage integer

Fill level in percent that triggers the alert notification.

Is locked
isLocked boolean

Whether the device configuration is locked.

computed
computed ComputedStorage

Fill level computed from the storage configuration; empty when the device has no storage configured.

tankCustom
tankCustom TankCustom

Custom tank configuration.

silo
silo Silo

Silo configuration.

tankPredefined
tankPredefined TankPredefined

Predefined (catalogue) tank configuration.

salesAssistantPrediction
salesAssistantPrediction SalesPrediction

Sales assistant order prediction.

Labels
labels array of string

Labels assigned to the device.

Address

Name Path Type Description
Address company
company string

Company.

Address street
streetLines string

Street and house number.

Address city
city string

City.

Address postal code
zipCode string

Postal code.

Address country
country string

Country as ISO 3166-1 alpha-2 code.

Metering

Latest reliable measurement; empty when the device has not measured yet.

Name Path Type Description
Measured quantity (L)
quantity integer

Measured quantity in litres.

Measured quantity unit
quantityUnit string

Unit of the measured quantity.

Measured at (Unix seconds)
timestamp integer

Measurement time as Unix seconds.

Measured at
measuredAt date-time

Measurement time in UTC, derived from the Unix timestamp of the latest measurement.

estimatedForecastDate
estimatedForecastDate LocalDate

Estimated date when the storage needs a refill.

Battery level
batteryLevel string

Battery level: FULL, GOOD, MEDIUM, WARNING or CRITICAL.

Signal strength
signalStrength string

Signal strength: VERY_WEAK, WEAK, GOOD or EXCELLENT.

Raw distance (cm)
distanceCm double

Raw measured distance in cm.

Raw pressure (Pa)
pressurePa double

Raw measured pressure in Pa.

Raw angle (deg)
angleDeg double

Raw measured angle in degrees.

ComputedStorage

Fill level computed from the storage configuration; empty when the device has no storage configured.

Name Path Type Description
currentQuantity
currentQuantity Quantity
Fill level (percent)
percentage integer

Fill level in percent; check Measured at, a device without a measurement can report 0.

usableQuantity
usableQuantity Quantity
totalQuantity
totalQuantity Quantity
Product safety margin
productSafetyMargin double

Product safety margin.

100 percent basis
displayAs100Percent string

Which capacity counts as 100 percent: USABLE_VOLUME or TOTAL_VOLUME.

Product name
productName string

Stored product.

Is collecting product
isCollectingProduct boolean

Whether the storage collects product (e.g. waste oil) instead of consuming it.

Quantity

Name Path Type Description
Value
value integer

Quantity.

Unit
unit string

Unit: L or kg.

LocalDate

Estimated date when the storage needs a refill.

Name Path Type Description
Forecast year
year integer
Forecast month
month integer
Forecast day
day integer

SalesPrediction

Sales assistant order prediction.

Name Path Type Description
Order probability (raw)
indexRaw double

Raw order probability index.

Order probability
index string

Order probability: VERY_HIGH, HIGH, MEDIUM or LOW.

quantity
quantity Quantity

TankCustom

Custom tank configuration.

Name Path Type Description
Tank height (cm)
heightCm double
Sensor offset (cm)
offsetCm double
Tank volume (L)
volumeL integer
Usable volume (L)
usableVolumeL integer
Volume is usable volume
isUsableVolume boolean
Tank shape
shape string

SQUARED, ROUNDED or CYLINDER.

Mounting type
mountingType string

ADHESIVE or SCREW.

Tank product ID
productId uuid

TankPredefined

Predefined (catalogue) tank configuration.

Name Path Type Description
Sensor offset (cm)
offsetTopCm double
Number of tanks
storageCount integer
Mounting type
mountingType string

ADHESIVE or SCREW.

Tank product ID
productId uuid
type
type TankPredefinedType

TankPredefinedType

Name Path Type Description
Tank type ID
id uuid
Tank manufacturer
manufacturerName string
Tank type
typeName string
Tank type height (cm)
totalHeightCm double
Tank type top offset (cm)
offsetTopInternalCm double
Tank type bottom offset (cm)
offsetBottomCm double
totalQuantity
totalQuantity Quantity

Silo

Silo configuration.

Name Path Type Description
Silo height (cm)
heightCm double
Silo width (cm)
widthCm double
Silo length (cm)
lengthCm double
Silo top offset (cm)
offsetTopCm double
Silo side offset (cm)
offsetSideCm double
Silo store type
storeType string

SACK_SILO, BUNKER_CONVEYOR or BUNKER_PROBE.

Silo mounting
mounting string

CEILING_VERTICAL, CEILING_DIAGONAL, PIPE_DIAGONAL or PIPE_VERTICAL.

Silo capacity (kg)
massKg integer
Silo product ID
productId uuid