Fetch Salary Breakdown | SalaryBox

{
  "data": [
    {
      "salarybox_id": "EMP001",
      "employee_id": "CMP-001",
      "name": "Jane Doe",
      "branches": [
        "HQ"
      ],
      "departments": [
        "Engineering"
      ],
      "period": {
        "from_date": "2026-01-01",
        "to_date": "2026-01-31"
      },
      "earnings": {
        "basic_salary": "25000.00",
        "fixed_allowances": "12500.00",
        "allowance": "0.00",
        "bonus": "0.00",
        "overtime": "0.00",
        "workbasis": "0.00",
        "incentive": "0.00",
        "reimbursement": "0.00"
      },
      "deductions": {
        "employee_pf": "1800.00",
        "employee_esi": "0.00",
        "professional_tax": "200.00",
        "labour_welfare_fund": "0.00",
        "admin_edli_deduction": "0.00",
        "fixed_deductions": "0.00",
        "total_tds": "0.00",
        "penalty": "0.00",
        "late_fine": "0.00",
        "early_fine": "0.00",
        "loan_debit": "0.00"
      },
      "employer_pf": "1800.00",
      "employer_esi": "0.00",
      "employer_labour_welfare_fund": "0.00",
      "total_earnings": "37500.00",
      "total_deductions": "2000.00",
      "gross_salary": "37500.00",
      "net_salary": "35500.00"
    }
  ],
  "message": "Success",
  "status": true,
  "count": 40,
  "prev": null,
  "next": "https://.../fetch-salary-breakdown?page=2",
  "rate_limit": [
    "0/1 requests remaining per 10 seconds",
    "2/3 requests remaining per 5 minutes",
    "9/10 requests remaining per 1 hour"
  ]
}

Returns the computed salary breakdown per employee for the given month. Requires an active Payroll Pro entitlement.

Rate limited to 1 request per 10 seconds, 3 per 5 minutes, and 10 per hour, on top of the shared 5000/day API key limit — computing this response can be expensive, so budget one call per payroll month.

The month’s roster includes employees who left during that month, so their final settlement is returned. Employees who left before the month’s attendance cycle began, or who join after it ends, are excluded.

Returns the computed salary breakdown per employee for the given month. Requires an active Payroll Pro entitlement. Rate limited to 1 request per 10 seconds, 3 per 5 minutes, and 10 per hour, on top of the shared 5000/day API key limit — computing this response can be expensive, so budget one call per payroll month. The month's roster includes employees who left during that month, so their final settlement is returned. Employees who left before the month's attendance cycle began, or who join after it ends, are excluded.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

monthstringRequired

Month (YYYY-MM). Always resolves to the full calendar month.

salarybox_idslist of stringsOptional

Repeatable. Filters to specific employees.

pageintegerOptional

Page number to fetch. Defaults to 1.

page_sizeintegerOptional

Number of results per page. Defaults to 10. Maximum 10.

Response

Payroll for the month is computed; the page is returned.

datalist of objects

messagestring

statusboolean

countinteger

prevstring or null

nextstring or null

rate_limitlist of stringsOptional

$	curl -G https://api.salaryboxapp.com/v2/customer/v1/payroll/fetch-salary-breakdown \
>	-H "Authorization: Api-Key <apiKey>" \
>	-d month=month