Payroll Engine API

OpenAPI and clients

Everything in the reference is generated from an OpenAPI 3.1 description, which you are free to take and build from. It is the same file our own documentation reads.

File	What it is
/openapi/payroll-engine/openapi.yaml	The entry point - info, servers, security, tags, path index, webhook events.
/openapi/payroll-engine/components/	Schemas, shared parameters and shared responses.
/openapi/payroll-engine/paths/	One file per domain: employees, payroll runs, statutory, and the rest.
/openapi.json	A different, smaller thing: the marketing site's two public form endpoints.

Validate and read it locally

bash

curl -O https://www.indpayroll.com/openapi/payroll-engine/openapi.yaml

npx @redocly/cli lint openapi.yaml
npx @redocly/cli preview-docs openapi.yaml

Bundle it into one file

The spec is split across files, which most tools read directly. Bundle it when a tool wants a single document - a client generator, or an import into Postman or Insomnia.

bash

npx @redocly/cli bundle openapi.yaml -o indpayroll-payroll-engine.yaml

npx @openapitools/openapi-generator-cli generate \
  -i indpayroll-payroll-engine.yaml \
  -g typescript-fetch \
  -o ./indpayroll-client

No official SDK yetA generated client is the supported path today. If you would rather we shipped a package for your language, tell us - the list of asks is what decides the order.

Versioning

API reference