Hiflow API (1.0.0)

Download OpenAPI specification:

Documentation OpenAPI Hiflow for interaction with the Hiflow modules and access to data.
Before using our API, you have to create an API key. This can be done in the « Parameters » module. Documentation can be found here (in French): Créer une clé d'API

Customers

Get list of customers

This route returns a list of customers.

Authorizations:

BearerAuth

query Parameters

search

string

Search string, applied on the name

Responses

Create a customer

Authorizations:

BearerAuth

Responses

Update a customer

Authorizations:

BearerAuth

Responses

Get a specific customer

This route returns the information of a customer based on the provided ID.

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the customer to retrieve

Responses

Delete a customer

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the customer to delete

Responses

Estimates

Get list of estimates

This route returns a list of estimates.

Authorizations:

BearerAuth

Responses

Create an estimate

Authorizations:

BearerAuth

Responses

Update an estimate

Authorizations:

BearerAuth

Responses

Get a specific estimate

This route returns the information of an estimate based on the provided ID.

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the estimate to retrieve

Responses

Delete an estimate

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the estimate to delete

Responses

Invoices

Get list of invoices

This route returns a list of invoices.

Authorizations:

BearerAuth

Responses

Create an invoice

Authorizations:

BearerAuth

Responses

Get a specific invoice

This route returns the information of an invoice based on the provided ID.

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the invoice to retrieve

Responses

Delete an invoice

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the invoice to delete

Responses

Items

Create an item

Authorizations:

BearerAuth

Responses

Jobs

Get list of jobs

This route returns a list of jobs.

Authorizations:

BearerAuth

query Parameters

id_statuses	Array of integers The id of the project status for which you want to retrieve the projects (can be an array)
id_customers	Array of integers The id of the customer for which you want to retrieve the projects (can be an array)
search	string Search string, applied on the name

Responses

Create a job

Authorizations:

BearerAuth

Responses

Update a job

Authorizations:

BearerAuth

Responses

Get a specific job

This route returns the information of a job based on the provided ID.

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the job to retrieve

Responses

Delete a job

Authorizations:

BearerAuth

path Parameters

id

required

integer

The ID of the job to delete

Responses

Authentication

Authenticate a user

Responses

Reports

Generate a report

Authorizations:

BearerAuth

Responses

Tasks

Get list of tasks

Authorizations:

BearerAuth

Responses

Create a task

Authorizations:

BearerAuth

Responses

Update a task

Authorizations:

BearerAuth

Responses

Timesheets

Get list of timesheet entries

Authorizations:

BearerAuth

query Parameters

date_start	string <date> Start date for the selection of the timesheet entries
date_end	string <date> End date for the selection of the timesheet entries
id_customer	Array of integers The id of the customer for which you want to retrieve the timesheet entries (can be an array)
id_user	Array of integers The id of the user for which you want to retrieve the timesheet entries (can be an array)
id_trackers	Array of integers The id of the tracker for which you want to retrieve the timesheet entries (can be an array)