EndpointsHrm Employee Statutory Deductions

Hrm Employee Statutory Deductions

Function-calling namespace: hrmEmployeeStatutoryDeductions

  • Base URL: https://api.aivida.in
  • Engine endpoint: POST /api
  • Auth: private API; Stack access token is required.
  • Send token in header: x-stack-access-token: <access_token> (or Authorization: Bearer <access_token>).
  • Allowed roles: platform_admin, hr.
  • Missing or invalid token returns 401; authenticated users without an allowed role return 403.

create

Source: backend/endpoints/hrm-employee-statutory-deductions/create

Input Fields

FieldTypeRequiredConstraints
organizationIdstringNo-
employeeIdstringNo-
pfEnabledbooleanNo-
pfTypestringNo-
pfPercentagenumberNo-
esiEnabledbooleanNo-
esiTypestringNo-
esiPercentagenumberNo-
tdsEnabledbooleanNo-
tdsPercentagenumberNo-
professionalTaxEnabledbooleanNo-
professionalTaxAmountnumberNo-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmEmployeeStatutoryDeductions",
  "apiName": "create",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

getByEmployee

Source: backend/endpoints/hrm-employee-statutory-deductions/get-by-employee

Input Fields

FieldTypeRequiredConstraints
organizationIdstringNo-
employeeIdstringNo-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmEmployeeStatutoryDeductions",
  "apiName": "getByEmployee",
  "data": {
    "organizationId": "org_123"
  }
}'

Example Response

{ "status": "ok", "data": {} }

update

Source: backend/endpoints/hrm-employee-statutory-deductions/update

Input schema type: deductions.InputSchema

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmEmployeeStatutoryDeductions",
  "apiName": "update",
  "data": {}
}'

Example Response

{ "status": "ok", "data": {} }