API Documentation

Integrate UAE gratuity calculations into your own applications using our REST API.

Calculate Gratuity

POST /api/calculate

Request Body (JSON)

{
  "basic_salary": 10000,
  "start_date": "2019-03-15",
  "end_date": "2026-03-12",
  "contract_type": "limited",
  "reason": "resignation"
}

Parameters

Field Type Required Description
basic_salary number Yes Monthly basic salary in AED (min: 1)
start_date string Yes Employment start date (YYYY-MM-DD)
end_date string Yes Last working day (YYYY-MM-DD)
contract_type string Yes limited or unlimited
reason string Yes resignation, termination, or end_of_contract

Response Example

{
  "basic_salary": 10000,
  "daily_salary": 333.33,
  "start_date": "2019-03-15",
  "end_date": "2026-03-12",
  "service_years": 6,
  "service_months": 11,
  "service_days": 25,
  "total_years": 6.9897,
  "contract_type": "limited",
  "reason": "resignation",
  "breakdown": [
    {
      "period": "First 3 years",
      "rate": "1/3 × 21 days basic salary per year",
      "amount": 6999.93
    },
    {
      "period": "2 years (3-5 year bracket)",
      "rate": "2/3 × 21 days basic salary per year",
      "amount": 9333.24
    },
    {
      "period": "1.9897 years (5+ year bracket)",
      "rate": "Full 21 days basic salary per year",
      "amount": 13927.77
    }
  ],
  "total_gratuity": 30260.94,
  "currency": "AED"
}

cURL Example

curl -X POST https://gratuity.codefounders.tech/api/calculate \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "basic_salary": 10000,
    "start_date": "2019-03-15",
    "end_date": "2026-03-12",
    "contract_type": "limited",
    "reason": "resignation"
  }'

🔑

API Keys — Coming Soon

We're working on API key authentication for production use with rate limiting and usage analytics. For now, the API is free and open for reasonable use.

← Back to Calculator