Conventions

Datasources or Platforms

Datasources are what we call the various sources of incomes users may have. This may be payroll platforms, driving and delivery platforms as well as freelance platforms. Rollee will collect and process data and service this data to our customers. (contact rollee support to have the list of supported datasources).

Companies

As a client that manages one or several companies, you register these companies in the API and then you can connect accounts (from a datasource) for each of them. This will allow you to request data from the users later.

Company accounts

Company Accounts represent the links between a company and a datasource. Companies can have multiple company accounts if they exist in multiple datasources . Each account is also identified with a UUID.

Users

Users are members (employees, drivers, etc) of a particular company. Each user represents a physical person and has a unique UUID which will be used in the API's responses.

User Accounts

User Accounts represent the links between a user and a datasource. A user can have multiple accounts if he exists in multiple datasources . Each user account is also identified with a UUID.

Endpoints

Endpoints are business entities under which sets of data are organized and served by the API.
For example, the profile endpoint serves data about the identity of users.

Dates and IDs

Some conventions used throughout our API and documentation are:

• All date-times are returned as strings in RFC 3339 order in UTC Timezone, like: 2021-06-30 14:30:00 UTC
• All IDs are represented as UUIDs, e.g., `01234567-89ab-cdef-0123-456789abcdef