API / Take-home pay
UK take-home pay API
Short answer
Send a salary and get back what someone takes home: income tax (Scottish and Welsh rates too), National Insurance, every student loan plan, pensions, salary sacrifice, bonuses and the High Income Child Benefit Charge, for every pay period of the year.
- Each pay period runs through PAYE, NI and student loans exactly as payroll software does, then the year adds up, so a bonus month shows the tax a real payslip would.
- Gross from net finds the lowest salary that reaches a take-home target, for job boards and net-pay offers.
- Tax codes are derived for you, or used as given: S and C prefixes, K codes, BR, D0, D1, NT and week 1/month 1.
Endpoints
POST /v1/take-homeGross pay to take-home, every periodPOST /v1/gross-from-netThe salary for a take-home targetGET /v1/tax-codes/{code}What a tax code means (no key)
Try a request
Money is pounds and pence. Every response carries the tax year, the engine and HMRC test data that produced it, the assumptions and the gov.uk sources.
curl https://api.checktakehomepay.co.uk/v1/take-home \
-H "Authorization: Bearer $CHECKTAKEHOMEPAY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"gross": {
"amount": 45000,
"per": "year"
},
"region": "england",
"student_loans": [
"plan_2"
],
"pension": {
"method": "salary_sacrifice",
"percent": 5,
"basis": "qualifying_earnings"
}
}'Questions
Is take-home worked out per pay period or as a year divided by 12?
Per pay period, the way payroll does it, then added up. That is why a monthly year frees £12,579.12 on 1257L, not £12,570, and why a bonus month shows more tax and NI than the others.
Does it handle Scotland and Wales?
Yes: Scotland’s six bands and Wales’s rates, from the region or from an S or C tax code.
Put it in your software
Every endpoint on every plan, from the free one up.