canonical: https://jentic.com/apis/hiflow.net/hiflow

# Hiflow API

Jentic publishes the only available OpenAPI specification for Hiflow API, keeping it validated and agent-ready. Hiflow is a French project and service management platform that lets freelancers and small agencies track customers, jobs, estimates, invoices, timesheets, and activity in one place. The API exposes 26 endpoints across customers, estimates, invoices, jobs, tasks, timesheets, trackers, users, and reports, all secured with a JWT bearer token obtained through a login operation. Agents can use it to automate quoting, invoicing, and time tracking workflows tied to a specific Hiflow account subdomain.

## For AI agents

Manage customers, estimates, invoices, jobs, tasks, and timesheets in a Hiflow account. Authenticates with a JWT bearer token requested via the login endpoint.

## Scope

Does not handle bank reconciliation, tax filing, or payroll - use for project, estimate, invoice, and timesheet management within a Hiflow account only.

## Capabilities

- Authenticate against a Hiflow account and request a fresh JWT via /login and `/login/requesttoken`
- Create, update, and list customer records with full CRUD on /customer and `/customer/{id}`
- Draft and revise client estimates through /estimate before converting them to invoices
- Issue invoices and pull historic invoice records from /invoice for billing reconciliation
- Track jobs and the tasks underneath them so agents can report on project progress
- Log timesheet entries and tracker activity to capture billable hours per job
- Pull activity and report endpoints to summarise team workload over a period

## Use cases

### Freelancer Quote-to-Invoice Automation

Freelancers and small agencies use Hiflow to move from a client enquiry to a paid invoice without leaving the platform. Agents can create the customer, draft an estimate via /estimate, convert accepted estimates into invoices via /invoice, and track payment status. The 26-endpoint surface covers the full lifecycle for a single Hiflow account subdomain.

Example prompt: Create a customer record for Acme Ltd, draft an estimate for two consulting days at 800 EUR each, and on acceptance issue the corresponding invoice via /invoice.

### Project Time Tracking and Reporting

Agencies bill by the hour and need accurate timesheet records per job. Hiflow exposes /job, /timesheet, and /tracker endpoints so an agent can open a job, log time as it is worked, and pull /reports to produce a weekly utilisation summary. This avoids a separate time-tracking tool and keeps billable hours linked to the invoiceable job record.

Example prompt: Log 4.5 hours against job ID 1287 for today and then retrieve the weekly activity report for the current user.

### Customer Data Sync to External CRM

Teams running a separate CRM alongside Hiflow need customer data to stay aligned. Agents can list customers via GET /customer, diff against the CRM, and use POST or PUT /customer to push corrections back. Because the API requires a JWT issued per Hiflow subdomain, credential isolation per account is straightforward.

Example prompt: List all Hiflow customers modified since yesterday and upsert each one into the connected CRM.

### AI Agent Bookkeeping Assistant

An AI agent can act as a back-office assistant for a freelancer using Hiflow. Through Jentic, the agent searches for an operation by intent, loads the JSON schema, and executes the call with the user's vault-stored Hiflow JWT. Common tasks include drafting invoices from a chat prompt, chasing unpaid invoices, and summarising the previous month's activity.

Example prompt: When the user says 'invoice Acme for last week', search Jentic for 'create invoice in Hiflow', load the schema, and execute POST /invoice with the matched line items.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/login` | Login to obtain a JWT bearer token |
| POST | `/login/requesttoken` | Request a refreshed JWT token |
| GET | `/customer` | List customer records |
| POST | `/customer` | Create a customer |
| POST | `/estimate` | Create an estimate |
| POST | `/invoice` | Create an invoice |
| POST | `/job` | Create a job |

## Key resources

- **Customers** — Create, update, list, and delete customer records that anchor estimates and invoices.
- **Estimates** — Draft and revise client quotes that can be converted into invoices.
- **Invoices** — Issue and list invoices tied to customers and jobs.
- **Jobs and Tasks** — Track work items and the tasks beneath them for billing.
- **Timesheets and Trackers** — Log and report on time spent against jobs.
- **Reports and Activity** — Pull aggregated activity and report data for utilisation summaries.

## Why Jentic

- **Setup:** Wiring the Hiflow API by hand means logging in for a JWT, refreshing it through `/login/requesttoken`, sending it as a bearer token, and templating your account subdomain into the host. Through Jentic you install once, import the Hiflow API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Hiflow carries the target in the request body for its create operations, so scoping stays at the operation level: limit the agent to the operations it needs, such as creating an estimate or reading customers. You choose that set, so a broader operation like creating an invoice or a job is only available if you include it.
- **Credential handling:** Your Hiflow login credentials and the resulting JWT are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an invoice in Hiflow', and Jentic returns the matching Hiflow operation with its input schema so the agent calls POST /invoice without browsing the reference docs.

## Related APIs

- **Invoice Ninja API** — Open-source invoicing and time-tracking platform with a broader REST surface than Hiflow.
- **Xero Accounting API** — Full double-entry accounting platform; pair with Hiflow for proper bookkeeping after invoicing.
- **Zoho CRM API** — Mid-market CRM that complements Hiflow's lighter customer record model.

## FAQ

### Why is there no official OpenAPI spec for Hiflow API?

Hiflow does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Hiflow API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Hiflow API use?

The Hiflow API uses HTTP bearer authentication with a JWT. Call POST /login with your Hiflow credentials to receive a token, then send it in the Authorization header on every other request. Through Jentic, your Hiflow credentials are stored in your Jentic One instance and the JWT is fetched and rotated for the agent automatically.

### Can I create invoices and estimates through the Hiflow API?

Yes. POST /estimate creates a client estimate and POST /invoice issues an invoice; both can be retrieved with the corresponding GET endpoints and updated via PUT. Estimates are typically created first and then converted into invoices once the client accepts.

### What are the rate limits for the Hiflow API?

The Hiflow OpenAPI specification does not declare rate limits. Hiflow is a per-account hosted product, so practical limits are tied to your account plan. Build retry-with-backoff into long-running sync jobs and consult Hiflow support for the limits applied to your subdomain.

### How do I list a customer's invoices through Jentic?

Search Jentic for 'list Hiflow invoices', load the schema for GET /invoice, and execute the call with the customer filter. Example: pip install jentic, then await client.search('list invoices in Hiflow') followed by client.execute() with the returned operation id.

### Does the Hiflow API support multiple accounts?

Yes. The base URL contains a {account} placeholder so each Hiflow subdomain has its own host. Configure the account value alongside the JWT when registering credentials in Jentic so the agent calls the correct tenant.

### Can I limit what my agent is allowed to do with the Hiflow API?

Yes. Because you run Jentic One yourself, your own rules decide which Hiflow operations and credentials the agent can use, and scoping happens at the operation level since Hiflow carries the target in each request body. You choose the exact set the agent may call, for example reading customers with GET /customer and drafting quotes with POST /estimate, while leaving broader actions like issuing an invoice with POST /invoice or creating a job with POST /job out unless you include them. The stored Hiflow login credentials and JWT are injected only for the operations you permit.
