PHPackages                             crmleaf/roi-calculator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. crmleaf/roi-calculator

ActiveLibrary

crmleaf/roi-calculator
======================

Quantify the return on moving off manual payroll.

v1.0.0(today)00[1 PRs](https://github.com/CrmLeaf/roi-calculator/pulls)MITPHPPHP ^8.2CI passing

Since Aug 14Pushed todayCompare

[ Source](https://github.com/CrmLeaf/roi-calculator)[ Packagist](https://packagist.org/packages/crmleaf/roi-calculator)[ Docs](https://www.indpayroll.com/free-tools/roi-calculator)[ RSS](/packages/crmleaf-roi-calculator/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (5)Versions (3)Used By (0)

Payroll ROI Calculator
======================

[](#payroll-roi-calculator)

Quantify the return on moving off manual payroll.

Turns "payroll takes us two days a month" into a number a finance director can sign off, with the assumptions visible rather than buried in a vendor slide.

One of the [CRMLeaf payroll tools](https://github.com/crmleaf). The arithmetic and the dated statutory rate tables live in [`crmleaf/payroll-core`](https://github.com/crmleaf/payroll-core); this package is the thin skin that makes one calculator installable, mountable and embeddable on its own.

Note

A wrong figure or an out-of-date rate is almost always a [`payroll-core`](https://github.com/crmleaf/payroll-core/issues) matter, since that is where the tables live. Anything about this tool's routes, views or browser asset belongs here.

Install
-------

[](#install)

**Composer** - Laravel auto-discovers the service provider, so this is the whole setup:

```
composer require crmleaf/roi-calculator
```

**npm** - the same calculation, re-exported from `@crmleaf/payroll-js` so you can install this one tool and nothing else:

```
npm install @crmleaf/roi-calculator
```

Note

Not on npm yet. The script-tag route below needs no registry and works today. Installing this package straight from git will not resolve `@crmleaf/payroll-js`, which is not published yet either.

**A plain script tag** - no build step, no bundler, no server. Build the browser bundle once and serve the file yourself:

```

const result = CrmleafPayroll.roi({
  employeeCount: 250,
  hourlyRate: 900,
  hoursPerCycleManual: 24,
  softwareAnnualCost: 180000,
});
console.log(result.explain);

```

`payroll.min.js` is the single-file browser build. Get it by running `npm run build` in [`@crmleaf/payroll-js`](https://github.com/crmleaf/payroll-js) and copying `dist/payroll.min.js`into whatever your site serves as static assets.

> A hosted CDN build is coming soon, which will reduce this to a single URL. Serving the file yourself works today and keeps working afterwards - it is the only option that needs no third-party request, so plenty of projects will want to stay on it.

### See it working first

[](#see-it-working-first)

`demo/index.html` in this repository is a working copy of Payroll ROI Calculator in one file: the form, the calculation and the working, with no build step and no server. Drop `payroll.min.js` beside it and open it from disk.

```
cp /path/to/payroll-js/dist/payroll.min.js demo/
open demo/index.html
```

Nothing on that page reaches the network, which is the point: it is a calculator people paste salary figures into.

Use it
------

[](#use-it)

**Plain PHP**, no framework and no container:

```
use Crmleaf\Payroll\Calculators\RoiCalculator;
use Crmleaf\Payroll\Money;

$result = (new RoiCalculator())->calculate(
    employeeCount: 250,
    hourlyRate: Money::fromRupees(900),
    hoursPerCycleManual: 24,
    softwareAnnualCost: Money::fromRupees(180_000),
);

echo $result->explain();      // the formula with the real operands in it
echo $result->workings();     // every step, one per line, with its citation
print_r($result->toArray());  // snake_case, ready for JSON
```

**Laravel** - resolve it from the container, or type-hint it anywhere:

```
use Crmleaf\Payroll\Calculators\RoiCalculator;

public function show(RoiCalculator $calculator)
{
    return $calculator->calculate(
        employeeCount: 250,
        hourlyRate: Money::fromRupees(900),
        hoursPerCycleManual: 24,
        softwareAnnualCost: Money::fromRupees(180_000),
    )->toArray();
}
```

**Blade** - one component, no controller:

```

```

**HTTP** - off by default. Publish the config and turn the route on:

```
php artisan vendor:publish --tag=roi-calculator-config
```

```
// config/roi-calculator.php
'route' => ['enabled' => true, 'prefix' => 'tools'],
```

```
curl -X POST https://example.test/tools/roi-calculator \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"employee_count":250,"hourly_rate":900,"hours_per_cycle_manual":24,"software_annual_cost":180000}'
```

The JSON response carries the figures, the working and the statutory citations:

```
{
  "tool": "roi-calculator",
  "data": { "…": "every figure, snake_case, with a *_formatted twin" },
  "explain": "the formula with the real operands substituted",
  "working": [{ "label": "…", "amount": 0, "formula": "…", "citation": "…" }],
  "citations": ["…"]
}
```

**JavaScript**:

```
import { roi } from '@crmleaf/roi-calculator';

const result = roi({
  employeeCount: 250,
  hourlyRate: 900,
  hoursPerCycleManual: 24,
  softwareAnnualCost: 180000,
});
```

No server needed
----------------

[](#no-server-needed)

The maths here is arithmetic over versioned rate tables, so it runs anywhere. The published asset binds the markup and computes in the browser:

```
php artisan vendor:publish --tag=roi-calculator-assets
```

```

   …

```

If the browser build is absent the script does nothing and the form posts to the server instead, so the page works either way.

Inputs
------

[](#inputs)

FieldTypeRequiredDefaultNotes`employee_count`integerYes`250``hourly_rate`money (₹)Yes`900``hours_per_cycle_manual`numberYes`24``cycles_per_year`integerNo`12``software_annual_cost`money (₹)No`180000``automation_efficiency`numberNo`0.8`A fraction between 0 and 1. 0.8 means eight hours in ten disappear.`penalty_cost_per_year`money (₹)No-`error_cost_per_year`money (₹)No-Optional fields you leave out are omitted from the call entirely, so the calculator's own documented defaults apply.

What the model assumes
----------------------

[](#what-the-model-assumes)

Not a statutory calculation. It values the hours a payroll cycle takes at the loaded cost of the people doing it, nets off the software, and adds back the penalties and corrections that manual processing tends to produce.

Rates are data, not code: they live in dated tables with a cited source in `crmleaf/payroll-core`, so a rate change is a new dated entry rather than an edit to a constant.

Important

This package implements our reading of the applicable statutes and is provided without warranty. It is a calculation library, not tax advice. Verify against your own compliance obligations before relying on the output for statutory filing.

Publishing
----------

[](#publishing)

TagPublishes`roi-calculator-config``config/roi-calculator.php``roi-calculator-views``resources/views/vendor/roi-calculator``roi-calculator-assets``public/vendor/roi-calculator`Licence
-------

[](#licence)

[MIT](LICENSE) © CRMLeaf. Use it commercially, embed it, fork it.

###  Health Score

40

—

FairBetter than 86% of packages

Maintenance100

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

0d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/315788704?v=4)[crmleaf](/maintainers/crmleaf)[@CrmLeaf](https://github.com/CrmLeaf)

---

Top Contributors

[![andolasoftuser196](https://avatars.githubusercontent.com/u/145565449?v=4)](https://github.com/andolasoftuser196 "andolasoftuser196 (8 commits)")

---

Tags

automationbusiness-casepayrollroiautomationpayrollroibusiness-case

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/crmleaf-roi-calculator/health.svg)

```
[![Health](https://phpackages.com/badges/crmleaf-roi-calculator/health.svg)](https://phpackages.com/packages/crmleaf-roi-calculator)
```

###  Alternatives

[rector/rector

Instant Upgrade and Automated Refactoring of any PHP code

10.4k145.3M11.3k](/packages/rector-rector)[symplify/easy-coding-standard

Use Coding Standard with 0-knowledge of PHP-CS-Fixer and PHP\_CodeSniffer

1.6k38.3M2.1k](/packages/symplify-easy-coding-standard)[nategood/commando

PHP CLI Commando Style

8013.4M40](/packages/nategood-commando)[magento/magento2-functional-testing-framework

Magento2 Functional Testing Framework

15312.2M36](/packages/magento-magento2-functional-testing-framework)[ssch/typo3-rector

Instant fixes for your TYPO3 PHP code by using Rector.

2613.3M487](/packages/ssch-typo3-rector)[activecampaign/api-php

Official PHP wrapper for the ActiveCampaign API.

1162.4M14](/packages/activecampaign-api-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
