Documentation

Everything you need
to run Heimdallone.

Guides, API references and integration patterns for operators, developers and finance teams.

⌘K
Quick start

Run your first pay run in 5 minutes

Spin up a sandbox tenant, import 12 sample employees from Horilla, and compute a Guyana September pay run end-to-end.

1Create a workspace — pick your countries (GY / TT / BB / JM…).
2Connect Horilla — paste your read-only Postgres URL.
3Pin a country profile — pick the gazetted version effective for the period.
4Compute — Heimdallone returns the gross-to-net breakdown per employee.
5Approve & commit — audit ledger seals the run.
Open quick-start guide SDK reference
// Compute a Guyana September pay run
import { Heimdallone } from "@heimdallone/sdk";

const hd = new Heimdallone({
  tenant: "atlas-shipping",
  apiKey: process.env.HEIMDALL_KEY,
});

const run = await hd.payroll.compute({
  country: "GY",
  period:  "2026-09",
  profile: "gy.v2026.1",
});

console.log(run.net);
// → { GYD: 184_720_400, employees: 728 }

Browse by topic

184 articles across 9 categories
View all topics

Changelog

View all
Sep 27
NewGuyana profile v2026.2 staged
NIS rate change effective 1 Oct (5.6 → 6.0%) staged for review. No active runs affected.
Sep 24
ImprovedFaster pay-run commit
Bulk-commit window cut from 8s → 2.4s on 1,500-employee runs. No schema change.
Sep 22
NewBank file: Republic Bank Trinidad (RBT)
Added native export for RBT format alongside RBL, RBC and NCB.
Sep 18
FixEffective-date split on mid-period hires
Resolved off-by-one in pro-rated NIS contributions when an employee starts on a Sunday.
Sep 15
NewJamaica TRN validation API
Validate Tax Registration Numbers at employee creation; surfaces blocking pay-run errors early.

Need help?

Skip the search — talk to a human.