Prorate a partial paycheck API

Prorates a period salary for a mid-period hire or termination by daily rate over calendar or working days, returning prorated pay and amount withheld. Answers 'How much for a partial pay period?', 'What is the prorated salary?'.

Price$0.02per request

MethodPOST

Route/v1/finance/paycheck-proration

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

payrollprorationproratesalarypartial-periodhronboardingpay

API URLhttps://x402.hexl.dev/v1/finance/paycheck-proration

Integration docs

Example request

{
  "periodSalary": 3000,
  "totalDaysInPeriod": 30,
  "daysWorked": 18
}

Example response

{
  "periodSalary": 3000,
  "basis": "calendar",
  "totalDaysInPeriod": 30,
  "daysWorked": 18,
  "dailyRate": 100,
  "fractionWorked": 0.6,
  "proratedPay": 1800,
  "withheldFromFullPeriod": 1200,
  "interpretation": "18 of 30 calendar days worked = 60% of the period; prorated pay $1800."
}

Input schema

{
  "type": "object",
  "required": [
    "periodSalary",
    "totalDaysInPeriod",
    "daysWorked"
  ],
  "properties": {
    "periodSalary": {
      "type": "number",
      "examples": [
        3000
      ]
    },
    "basis": {
      "type": "string",
      "enum": [
        "calendar",
        "working"
      ],
      "examples": [
        "calendar"
      ]
    },
    "totalDaysInPeriod": {
      "type": "number",
      "examples": [
        30
      ]
    },
    "daysWorked": {
      "type": "number",
      "examples": [
        18
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}