Skip to content

Payloom API

Statutory payroll across 17 countries, from one engine. Every rate checked and effective-dated, every payslip reproducible.

The Payloom API is a versioned REST surface for the systems around payroll: your HRIS, your accounting stack, your data warehouse. Authenticate with an organization API key, and the key is the tenant, so there is no organization parameter anywhere.

Run a month

Create and calculate pay runs, add one-off earnings such as overtime and bonuses, then read payslips and their PDFs, payment batches and statutory filings in each authority’s own format.

Keep your people in step

Employees, departments, positions and locations, pay history, archive and restore, on the same records the console uses.

Leave and deductions

Book leave for a person to decide, read balances and holidays, and set up loans and other company deductions that wait for the employee’s agreement.

Close the books

Export the GL journal as a numbered, logged journal, read the balance held at Payloom and its ledger, and record payments made to tax authorities.

Hear about it

Signed webhooks for runs, payslips, employees, leave, invoices, expense claims, deductions and payments, retried until they arrive and repeatable for 90 days.

Money that never lies

Amounts are always an object: an integer minor unit and an ISO currency code. No floats, no rounding surprises.

  • Money is an object, {"amount_minor": 500838, "currency": "GHS"}. amount_minor is an integer in the currency’s minor unit (pesewas, cents, kobo). Zero-decimal currencies such as XOF have a 1:1 minor unit.
  • A key feeds and reads; people decide. You can create and calculate a run, add earnings, book leave and set up a deduction, but approving a run, leave, an invoice or a claim, and moving money, happen in the console, because each is recorded against a person and an API key is not one.

Start with the Quickstart, or read the API preview: the organization your key belongs to, generated from the same contract the API is tested against.

The full API reference, the webhooks and the playground are for Payloom’s partners and need a partner username and password. To get one, write to hello@usepayloom.com.