Iris API Reference

Customer API - Introduction

The Trackunit Customer API is a REST API that enables customers of Trackunit to create & manage information about their own customers inside the Trackunit system.

📘

IrisX customers can also access data connected to Customer(s) via the GraphQL API

Via the Public GraphQL API, you can utilize query capabilities to fetch data connected to customer(s) and other domains which would be multiple separate calls in the REST APIs. Additionally you can perform mutations to modify data associated with customer(s). Explore the GraphQL schema through our GraphQL Explorer. Learn more about the IrisX subscription.

The Customer API is designed to facilitate the seamless management of customer data within the Trackunit ecosystem. This API empowers developers to interact with customer information, including details about customers, their associated contacts and asset assignments.

Customer in this context, is defined as the customer of Trackunit's customer, which opens up another dimension for businesses to model not only their relationship with their own customers but also those customers contacts and asset assignments.

Concepts

The customer API is built on the following concepts

  • A customer is a registration of a business relationship with another legal entity.
  • A customer contact is a registration of a way to get in contact with this entity. It is not necessarily a person, as it can also be a call center or a department.
  • A customer asset is represents a relationship between the customer and the asset. Fx. an asset being rented to that customer or an asset assign to undergo service by a service provider.

Extending the Data Model

Missing any fields needed to define your customers perfectly? Custom fields provide a way to define new fields in the Trackunit data model. Allowing to extend and customize Trackunit Manager. Currently we support extending the data model of assets, accounts, groups, sites, customers and rental contracts with new fields.

📘

Subscription requirement

IrisX is required to create and change custom field definitions. Learn more about the IrisX subscription

  1. To define a custom field, you first need to add a definition using the Custom Fields Definitions API.
  2. Use the Custom Fields Values API to set values on your defined custom fields.
  • Specify the entityId for your query. Depending on which domain type you are interested in, this can be an assetId, accountId, groupId, siteId, customerId or rentalContractId.