Skip to main content
Every service in this reference has its own OpenAPI specification, rendered in the sidebar. For convenience, we also publish a single combined specification that bundles all of them — rewritten to one gateway base URL — so you can import the whole API in one step.

​
Download

Download the combined OpenAPI bundle

A single .zip containing the combined spec in both JSON (flowpayroll-openapi.json) and YAML (flowpayroll-openapi.yaml). Use the JSON for Postman and Insomnia.
In the combined file, every path is namespaced with its service prefix (for example /v1/billing/clients, /v2/pension/...) and the single server is set to the gateway:

​
Import into Postman

1

Download and unzip

Download flowpayroll-openapi.zip and extract flowpayroll-openapi.json.
2

Import

In Postman, click Import, drop in flowpayroll-openapi.json, and choose OpenAPI 3.0 when prompted. Postman generates a collection covering every endpoint.
3

Set the base URL

Postman creates a baseUrl variable from the server. Point it at sandbox or live as needed.
4

Add your token

Add an X-Auth-Token header at the collection level using a token from the token endpoint. Optionally add a User-Id header.
Prefer Insomnia or another tool? Import the same flowpayroll-openapi.json (or the YAML). Any OpenAPI 3.0-aware client will read it.

​
Browsing individual services

Prefer one service at a time? Every service is rendered in the API reference sidebar — open the group you need and you’ll get the full request/response schema and a built-in playground for each endpoint: The combined download above already includes every one of these services, so you only need it if you want the entire surface in a single file.
The combined bundle is regenerated from the per-service specs. If an endpoint ever differs between the two, the per-service spec is the source of truth.