Add Staff Employment History

POST

https://api.salaryboxapp.com/v2/customer/v1/staff/:salarybox_id/employment-history

POST

/v2/customer/v1/staff/:salarybox_id/employment-history

curl -X POST https://api.salaryboxapp.com/v2/customer/v1/staff/ABCDEFGHIJ/employment-history \
     -H "Authorization: Api-Key  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "company_name": "Globex Pvt Ltd",
  "designation": "Analyst",
  "joining_date": "2022-04-01",
  "leaving_date": "2025-03-31",
  "salary": 45000,
  "company_gst": "24AAACB5343E1Z7",
  "currency": "INR"
}'

{
  "message": "Employment history added successfully",
  "status": true,
  "data": {
    "salarybox_id": "ABCDEFGHIJ",
    "company_name": "Globex Pvt Ltd",
    "designation": "Analyst",
    "joining_date": "2022-04-01",
    "leaving_date": "2025-03-31",
    "salary": "45000.00",
    "currency": "INR",
    "company_gst": "24AAACB5343E1Z7"
  }
}

Adds one past job to a staff member’s employment history. Shared rules: see Writing Data.

salarybox_id goes in the URL path, not the body.
Each call adds a new entry.
Dates can’t be in the future, and the leaving date can’t be before the joining date.
salary is returned as a string with 2 decimals, or null.
Editing an entry is not available; correct it in the SalaryBox app. Use List Staff Employment History to read entries back.

Custom role needs: staff_details:edit.

Authentication

AuthorizationApi-Key

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

Path parameters

salarybox_idstringRequired

SalaryBox ID of the staff member.

Request

This endpoint expects an object.

company_namestringRequired1-255 characters

Previous employer (extra spaces around it are trimmed).

designationstringOptional1-100 characters

Job title held there (up to 100 characters).

joining_datedateOptional

YYYY-MM-DD; not in the future.

leaving_datedateOptional

YYYY-MM-DD; not in the future and not before joining_date.

salarydoubleOptional>=0

A number (not text), 0 or more, up to 2 decimal places and 12 digits in total.

company_gststringOptional

A valid GSTIN, for example 24AAACB5343E1Z7 (upper-cased for you).

currencyenumOptional

Response

The employment history entry was added.

messagestring

statusboolean

dataobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error