Hrm Payroll

Function-calling namespace: hrmPayroll

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.

`addBonus`

Source: backend/endpoints/hrm-payroll/add-bonus

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeePayrollId`	`string`	Yes	-
`amount`	`number`	Yes	-
`reason`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmPayroll",
  "apiName": "addBonus",
  "data": {
    "organizationId": "org_123",
    "employeePayrollId": "employeepayroll_123",
    "amount": 1,
    "reason": "value"
  }
}'

Response Data Format

Field	Type	Required	Constraints
`success`	`boolean`	No	-
`message`	`string`	No	-
`payroll`	`object`	No	nullable
`items`	`array<object>`	No	-

Response Data Format Nested Structures

`payroll`

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`payrollRunId`	`string`	No	-
`employeeId`	`string`	No	-
`payrollYear`	`integer`	No	-
`payrollMonth`	`integer`	No	-
`totalDays`	`integer`	No	-
`presentDays`	`integer`	No	-
`absentDays`	`integer`	No	-
`lateDays`	`integer`	No	-
`halfDays`	`integer`	No	-
`grossSalary`	`number`	No	-
`statutoryDeductionAmount`	`number`	No	-
`otherDeductionAmount`	`number`	No	-
`otherDeductionReason`	`string`	No	-
`deductionAmount`	`number`	No	-
`netSalary`	`number`	No	-
`status`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`items[]` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`componentName`	`string`	No	-
`amount`	`number`	No	-
`reason`	`string`	No	-
`createdBy`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "success": true,
  "message": "value",
  "payroll": {
    "id": "id_123",
    "organizationId": "org_123",
    "payrollRunId": "payrollrun_123",
    "employeeId": "employee_123",
    "payrollYear": 1,
    "payrollMonth": 1,
    "totalDays": 1,
    "presentDays": 1,
    "absentDays": 1,
    "lateDays": 1,
    "halfDays": 1,
    "grossSalary": 1,
    "statutoryDeductionAmount": 1,
    "otherDeductionAmount": 1,
    "otherDeductionReason": "value",
    "deductionAmount": 1,
    "netSalary": 1,
    "status": "scheduled",
    "generatedAt": 1710201600000,
    "createdAt": 1710201600000,
    "updatedAt": 1710201600000
  },
  "items": [
    {
      "type": "general",
      "componentName": "value",
      "amount": 1,
      "reason": "value",
      "createdBy": "value",
      "createdAt": 1710201600000
    }
  ]
}

Example Response

{
  "status": "ok",
  "data": {
    "success": true,
    "message": "value",
    "payroll": {
      "id": "id_123",
      "organizationId": "org_123",
      "payrollRunId": "payrollrun_123",
      "employeeId": "employee_123",
      "payrollYear": 1,
      "payrollMonth": 1,
      "totalDays": 1,
      "presentDays": 1,
      "absentDays": 1,
      "lateDays": 1,
      "halfDays": 1,
      "grossSalary": 1,
      "statutoryDeductionAmount": 1,
      "otherDeductionAmount": 1,
      "otherDeductionReason": "value",
      "deductionAmount": 1,
      "netSalary": 1,
      "status": "scheduled",
      "generatedAt": 1710201600000,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "items": [
      {
        "type": "general",
        "componentName": "value",
        "amount": 1,
        "reason": "value",
        "createdBy": "value",
        "createdAt": 1710201600000
      }
    ]
  }
}

`addOtherDeduction`

Source: backend/endpoints/hrm-payroll/add-other-deduction

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeePayrollId`	`string`	Yes	-
`amount`	`number`	Yes	-
`reason`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmPayroll",
  "apiName": "addOtherDeduction",
  "data": {
    "organizationId": "org_123",
    "employeePayrollId": "employeepayroll_123",
    "amount": 1,
    "reason": "value"
  }
}'

Response Data Format

Field	Type	Required	Constraints
`success`	`boolean`	No	-
`message`	`string`	No	-
`payroll`	`object`	No	nullable
`items`	`array<object>`	No	-

Response Data Format Nested Structures

`payroll`

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`payrollRunId`	`string`	No	-
`employeeId`	`string`	No	-
`payrollYear`	`integer`	No	-
`payrollMonth`	`integer`	No	-
`totalDays`	`integer`	No	-
`presentDays`	`integer`	No	-
`absentDays`	`integer`	No	-
`lateDays`	`integer`	No	-
`halfDays`	`integer`	No	-
`grossSalary`	`number`	No	-
`statutoryDeductionAmount`	`number`	No	-
`otherDeductionAmount`	`number`	No	-
`otherDeductionReason`	`string`	No	-
`deductionAmount`	`number`	No	-
`netSalary`	`number`	No	-
`status`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`items[]` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`componentName`	`string`	No	-
`amount`	`number`	No	-
`reason`	`string`	No	-
`createdBy`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "success": true,
  "message": "value",
  "payroll": {
    "id": "id_123",
    "organizationId": "org_123",
    "payrollRunId": "payrollrun_123",
    "employeeId": "employee_123",
    "payrollYear": 1,
    "payrollMonth": 1,
    "totalDays": 1,
    "presentDays": 1,
    "absentDays": 1,
    "lateDays": 1,
    "halfDays": 1,
    "grossSalary": 1,
    "statutoryDeductionAmount": 1,
    "otherDeductionAmount": 1,
    "otherDeductionReason": "value",
    "deductionAmount": 1,
    "netSalary": 1,
    "status": "scheduled",
    "generatedAt": 1710201600000,
    "createdAt": 1710201600000,
    "updatedAt": 1710201600000
  },
  "items": [
    {
      "type": "general",
      "componentName": "value",
      "amount": 1,
      "reason": "value",
      "createdBy": "value",
      "createdAt": 1710201600000
    }
  ]
}

Example Response

{
  "status": "ok",
  "data": {
    "success": true,
    "message": "value",
    "payroll": {
      "id": "id_123",
      "organizationId": "org_123",
      "payrollRunId": "payrollrun_123",
      "employeeId": "employee_123",
      "payrollYear": 1,
      "payrollMonth": 1,
      "totalDays": 1,
      "presentDays": 1,
      "absentDays": 1,
      "lateDays": 1,
      "halfDays": 1,
      "grossSalary": 1,
      "statutoryDeductionAmount": 1,
      "otherDeductionAmount": 1,
      "otherDeductionReason": "value",
      "deductionAmount": 1,
      "netSalary": 1,
      "status": "scheduled",
      "generatedAt": 1710201600000,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "items": [
      {
        "type": "general",
        "componentName": "value",
        "amount": 1,
        "reason": "value",
        "createdBy": "value",
        "createdAt": 1710201600000
      }
    ]
  }
}

`approve`

Source: backend/endpoints/hrm-payroll/approve

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`payrollRunId`	`string`	Yes	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`message`	`string`	No	-

Response Data Format Example

{
  "message": "value"
}

Example Response

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

`deleteEmployeePayroll`

Source: backend/endpoints/hrm-payroll/delete-employee-payroll

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeePayrollId`	`string`	Yes	-
`reason`	`string`	Yes	-

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmPayroll",
  "apiName": "deleteEmployeePayroll",
  "data": {
    "organizationId": "org_123",
    "employeePayrollId": "employee_payroll_123",
    "reason": "Incorrect salary generated"
  }
}'

Response Data Format

Field	Type	Required	Constraints
`success`	`boolean`	No	-
`message`	`string`	No	-

Response Data Format Example

{
  "success": true,
  "message": "value"
}

Example Response

{
  "status": "ok",
  "data": {
    "success": true,
    "message": "value"
  }
}

`exportExcel`

Source: backend/endpoints/hrm-payroll/export-excel

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`year`	`integer`	Yes	-
`month`	`integer`	No	1-12

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`message`	`string`	No	-

Response Data Format Example

{
  "message": "value"
}

Example Response

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

`exportPdf`

Source: backend/endpoints/hrm-payroll/export-pdf

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeeId`	`string`	No	-
`year`	`integer`	Yes	-
`month`	`integer`	Yes	1-12

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`message`	`string`	No	-

Response Data Format Example

{
  "message": "value"
}

Example Response

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

`generate`

Source: backend/endpoints/hrm-payroll/generate

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`year`	`integer`	Yes	-
`month`	`integer`	Yes	1-12

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`payrollYear`	`integer`	No	-
`payrollMonth`	`integer`	No	-
`totalEmployees`	`integer`	No	-
`grossAmount`	`number`	No	-
`deductionAmount`	`number`	No	-
`netAmount`	`number`	No	-
`status`	`string`	No	-
`generatedBy`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp
`approvedBy`	`string`	No	-
`approvedAt`	`integer`	No	unix-ms timestamp; nullable
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "id": "id_123",
  "organizationId": "org_123",
  "payrollYear": 1,
  "payrollMonth": 1,
  "totalEmployees": 1,
  "grossAmount": 1,
  "deductionAmount": 1,
  "netAmount": 1,
  "status": "scheduled",
  "generatedBy": "value",
  "generatedAt": 1710201600000,
  "approvedBy": "value",
  "approvedAt": 1710201600000,
  "createdAt": 1710201600000,
  "updatedAt": 1710201600000
}

Example Response

{
  "status": "ok",
  "data": {
    "id": "id_123",
    "organizationId": "org_123",
    "payrollYear": 1,
    "payrollMonth": 1,
    "totalEmployees": 1,
    "grossAmount": 1,
    "deductionAmount": 1,
    "netAmount": 1,
    "status": "scheduled",
    "generatedBy": "value",
    "generatedAt": 1710201600000,
    "approvedBy": "value",
    "approvedAt": 1710201600000,
    "createdAt": 1710201600000,
    "updatedAt": 1710201600000
  }
}

`getByMonth`

Source: backend/endpoints/hrm-payroll/get-by-month

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`year`	`integer`	Yes	-
`month`	`integer`	Yes	1-12
`search`	`string`	No	-
`departmentId`	`string`	No	-
`designationId`	`string`	No	-
`page`	`integer`	No	default: 1
`pageSize`	`integer`	No	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`items`	`array<object>`	No	-
`total`	`integer`	No	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-
`totalPages`	`integer`	No	-

Response Data Format Nested Structures

`items[]` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`payrollRunId`	`string`	No	-
`employeeId`	`string`	No	-
`employeeCode`	`string`	No	-
`employeeName`	`string`	No	-
`departmentId`	`string`	No	-
`department`	`string`	No	-
`designationId`	`string`	No	-
`designation`	`string`	No	-
`totalDays`	`integer`	No	-
`presentDays`	`integer`	No	-
`absentDays`	`integer`	No	-
`lateDays`	`integer`	No	-
`halfDays`	`integer`	No	-
`grossSalary`	`number`	No	-
`deductionAmount`	`number`	No	-
`netSalary`	`number`	No	-
`status`	`string`	No	-

Response Data Format Example

{
  "items": [
    {
      "id": "id_123",
      "payrollRunId": "payrollrun_123",
      "employeeId": "employee_123",
      "employeeCode": "value",
      "employeeName": "value",
      "departmentId": "department_123",
      "department": "value",
      "designationId": "designation_123",
      "designation": "value",
      "totalDays": 1,
      "presentDays": 1,
      "absentDays": 1,
      "lateDays": 1,
      "halfDays": 1,
      "grossSalary": 1,
      "deductionAmount": 1,
      "netSalary": 1,
      "status": "scheduled"
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example Response

{
  "status": "ok",
  "data": {
    "items": [
      {
        "id": "id_123",
        "payrollRunId": "payrollrun_123",
        "employeeId": "employee_123",
        "employeeCode": "value",
        "employeeName": "value",
        "departmentId": "department_123",
        "department": "value",
        "designationId": "designation_123",
        "designation": "value",
        "totalDays": 1,
        "presentDays": 1,
        "absentDays": 1,
        "lateDays": 1,
        "halfDays": 1,
        "grossSalary": 1,
        "deductionAmount": 1,
        "netSalary": 1,
        "status": "scheduled"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

`getEmployeePayslip`

Source: backend/endpoints/hrm-payroll/get-employee-payslip

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeeId`	`string`	Yes	-
`year`	`integer`	Yes	-
`month`	`integer`	Yes	1-12

Example Request

curl -X POST https://api.aivida.in/api \
  -H "Content-Type: application/json" \
  -H "x-stack-access-token: <access_token>" \
  -d '{
  "namespace": "hrmPayroll",
  "apiName": "getEmployeePayslip",
  "data": {
    "organizationId": "org_123",
    "employeeId": "emp_123",
    "year": 2026,
    "month": 5
  }
}'

Response Data Format

Field	Type	Required	Constraints
`payrollRunId`	`string`	No	-
`employeePayrollId`	`string`	No	-
`organizationId`	`string`	No	-
`employeeId`	`string`	No	-
`employeeCode`	`string`	No	-
`employeeName`	`string`	No	-
`department`	`string`	No	-
`designation`	`string`	No	-
`year`	`integer`	No	-
`month`	`integer`	No	-
`monthName`	`string`	No	-
`attendance`	`object`	No	-
`earnings`	`array<object>`	No	-
`deductions`	`array<object>`	No	-
`grossSalary`	`number`	No	-
`deductionAmount`	`number`	No	-
`netSalary`	`number`	No	-
`status`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp

Response Data Format Nested Structures

`attendance`

Field	Type	Required	Constraints
`totalDays`	`integer`	No	-
`presentDays`	`integer`	No	-
`absentDays`	`integer`	No	-
`lateDays`	`integer`	No	-
`halfDays`	`integer`	No	-

`earnings[]` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`employeePayrollId`	`string`	No	-
`componentType`	`string`	No	-
`componentName`	`string`	No	-
`amount`	`number`	No	-
`referenceType`	`string`	No	-
`referenceId`	`string`	No	-
`remarks`	`string`	No	-
`createdBy`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`deductions[]` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`employeePayrollId`	`string`	No	-
`componentType`	`string`	No	-
`componentName`	`string`	No	-
`amount`	`number`	No	-
`referenceType`	`string`	No	-
`referenceId`	`string`	No	-
`remarks`	`string`	No	-
`createdBy`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "payrollRunId": "payrollrun_123",
  "employeePayrollId": "employeepayroll_123",
  "organizationId": "org_123",
  "employeeId": "employee_123",
  "employeeCode": "value",
  "employeeName": "value",
  "department": "value",
  "designation": "value",
  "year": 1,
  "month": 1,
  "monthName": "value",
  "attendance": {
    "totalDays": 1,
    "presentDays": 1,
    "absentDays": 1,
    "lateDays": 1,
    "halfDays": 1
  },
  "earnings": [
    {
      "id": "id_123",
      "organizationId": "org_123",
      "employeePayrollId": "employeepayroll_123",
      "componentType": "general",
      "componentName": "value",
      "amount": 1,
      "referenceType": "general",
      "referenceId": "reference_123",
      "remarks": "value",
      "createdBy": "value",
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    }
  ],
  "deductions": [
    {
      "id": "id_123",
      "organizationId": "org_123",
      "employeePayrollId": "employeepayroll_123",
      "componentType": "general",
      "componentName": "value",
      "amount": 1,
      "referenceType": "general",
      "referenceId": "reference_123",
      "remarks": "value",
      "createdBy": "value",
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    }
  ],
  "grossSalary": 1,
  "deductionAmount": 1,
  "netSalary": 1,
  "status": "scheduled",
  "generatedAt": 1710201600000
}

Example Response

{
  "status": "ok",
  "data": {
    "payrollRunId": "payrollrun_123",
    "employeePayrollId": "employeepayroll_123",
    "organizationId": "org_123",
    "employeeId": "employee_123",
    "employeeCode": "value",
    "employeeName": "value",
    "department": "value",
    "designation": "value",
    "year": 1,
    "month": 1,
    "monthName": "value",
    "attendance": {
      "totalDays": 1,
      "presentDays": 1,
      "absentDays": 1,
      "lateDays": 1,
      "halfDays": 1
    },
    "earnings": [
      {
        "id": "id_123",
        "organizationId": "org_123",
        "employeePayrollId": "employeepayroll_123",
        "componentType": "general",
        "componentName": "value",
        "amount": 1,
        "referenceType": "general",
        "referenceId": "reference_123",
        "remarks": "value",
        "createdBy": "value",
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      }
    ],
    "deductions": [
      {
        "id": "id_123",
        "organizationId": "org_123",
        "employeePayrollId": "employeepayroll_123",
        "componentType": "general",
        "componentName": "value",
        "amount": 1,
        "referenceType": "general",
        "referenceId": "reference_123",
        "remarks": "value",
        "createdBy": "value",
        "createdAt": 1710201600000,
        "updatedAt": 1710201600000
      }
    ],
    "grossSalary": 1,
    "deductionAmount": 1,
    "netSalary": 1,
    "status": "scheduled",
    "generatedAt": 1710201600000
  }
}

`getPayrollAdjustments`

Source: backend/endpoints/hrm-payroll/get-payroll-adjustments

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeePayrollId`	`string`	Yes	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`success`	`boolean`	No	-
`message`	`string`	No	-
`payroll`	`object`	No	nullable
`items`	`array<object>`	No	-

Response Data Format Nested Structures

`payroll`

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`payrollRunId`	`string`	No	-
`employeeId`	`string`	No	-
`payrollYear`	`integer`	No	-
`payrollMonth`	`integer`	No	-
`totalDays`	`integer`	No	-
`presentDays`	`integer`	No	-
`absentDays`	`integer`	No	-
`lateDays`	`integer`	No	-
`halfDays`	`integer`	No	-
`grossSalary`	`number`	No	-
`statutoryDeductionAmount`	`number`	No	-
`otherDeductionAmount`	`number`	No	-
`otherDeductionReason`	`string`	No	-
`deductionAmount`	`number`	No	-
`netSalary`	`number`	No	-
`status`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`items[]` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`componentName`	`string`	No	-
`amount`	`number`	No	-
`reason`	`string`	No	-
`createdBy`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "success": true,
  "message": "value",
  "payroll": {
    "id": "id_123",
    "organizationId": "org_123",
    "payrollRunId": "payrollrun_123",
    "employeeId": "employee_123",
    "payrollYear": 1,
    "payrollMonth": 1,
    "totalDays": 1,
    "presentDays": 1,
    "absentDays": 1,
    "lateDays": 1,
    "halfDays": 1,
    "grossSalary": 1,
    "statutoryDeductionAmount": 1,
    "otherDeductionAmount": 1,
    "otherDeductionReason": "value",
    "deductionAmount": 1,
    "netSalary": 1,
    "status": "scheduled",
    "generatedAt": 1710201600000,
    "createdAt": 1710201600000,
    "updatedAt": 1710201600000
  },
  "items": [
    {
      "type": "general",
      "componentName": "value",
      "amount": 1,
      "reason": "value",
      "createdBy": "value",
      "createdAt": 1710201600000
    }
  ]
}

Example Response

{
  "status": "ok",
  "data": {
    "success": true,
    "message": "value",
    "payroll": {
      "id": "id_123",
      "organizationId": "org_123",
      "payrollRunId": "payrollrun_123",
      "employeeId": "employee_123",
      "payrollYear": 1,
      "payrollMonth": 1,
      "totalDays": 1,
      "presentDays": 1,
      "absentDays": 1,
      "lateDays": 1,
      "halfDays": 1,
      "grossSalary": 1,
      "statutoryDeductionAmount": 1,
      "otherDeductionAmount": 1,
      "otherDeductionReason": "value",
      "deductionAmount": 1,
      "netSalary": 1,
      "status": "scheduled",
      "generatedAt": 1710201600000,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "items": [
      {
        "type": "general",
        "componentName": "value",
        "amount": 1,
        "reason": "value",
        "createdBy": "value",
        "createdAt": 1710201600000
      }
    ]
  }
}

`list`

Source: backend/endpoints/hrm-payroll/list

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`year`	`integer`	Yes	-
`page`	`integer`	No	default: 1
`pageSize`	`integer`	No	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`items`	`array<object>`	No	-
`total`	`integer`	No	-
`page`	`integer`	No	-
`pageSize`	`integer`	No	-
`totalPages`	`integer`	No	-

Response Data Format Nested Structures

`items[]` item

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`month`	`string`	No	-
`monthNumber`	`integer`	No	-
`year`	`integer`	No	-
`days`	`integer`	No	-
`grossAmount`	`number`	No	-
`deductionAmount`	`number`	No	-
`netAmount`	`number`	No	-
`totalEmployees`	`integer`	No	-
`status`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "items": [
    {
      "id": "id_123",
      "organizationId": "org_123",
      "month": "value",
      "monthNumber": 1,
      "year": 1,
      "days": 1,
      "grossAmount": 1,
      "deductionAmount": 1,
      "netAmount": 1,
      "totalEmployees": 1,
      "status": "scheduled",
      "generatedAt": 1710201600000
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "totalPages": 1
}

Example Response

{
  "status": "ok",
  "data": {
    "items": [
      {
        "id": "id_123",
        "organizationId": "org_123",
        "month": "value",
        "monthNumber": 1,
        "year": 1,
        "days": 1,
        "grossAmount": 1,
        "deductionAmount": 1,
        "netAmount": 1,
        "totalEmployees": 1,
        "status": "scheduled",
        "generatedAt": 1710201600000
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1
  }
}

`lock`

Source: backend/endpoints/hrm-payroll/lock

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`payrollRunId`	`string`	Yes	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`message`	`string`	No	-

Response Data Format Example

{
  "message": "value"
}

Example Response

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

`markPaid`

Source: backend/endpoints/hrm-payroll/mark-paid

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`payrollRunId`	`string`	Yes	-
`employeePayrollIds`	`array<string>`	No	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`message`	`string`	No	-

Response Data Format Example

{
  "message": "value"
}

Example Response

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

`regenerateEmployeePayroll`

Source: backend/endpoints/hrm-payroll/regenerate-employee-payroll

Input Fields

Field	Type	Required	Constraints
`organizationId`	`string`	Yes	-
`employeePayrollId`	`string`	Yes	-

Example Request

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

Response Data Format

Field	Type	Required	Constraints
`success`	`boolean`	No	-
`message`	`string`	No	-
`payroll`	`object`	No	nullable
`items`	`array<object>`	No	-

Response Data Format Nested Structures

`payroll`

Field	Type	Required	Constraints
`id`	`string`	No	-
`organizationId`	`string`	No	-
`payrollRunId`	`string`	No	-
`employeeId`	`string`	No	-
`payrollYear`	`integer`	No	-
`payrollMonth`	`integer`	No	-
`totalDays`	`integer`	No	-
`presentDays`	`integer`	No	-
`absentDays`	`integer`	No	-
`lateDays`	`integer`	No	-
`halfDays`	`integer`	No	-
`grossSalary`	`number`	No	-
`statutoryDeductionAmount`	`number`	No	-
`otherDeductionAmount`	`number`	No	-
`otherDeductionReason`	`string`	No	-
`deductionAmount`	`number`	No	-
`netSalary`	`number`	No	-
`status`	`string`	No	-
`generatedAt`	`integer`	No	unix-ms timestamp
`createdAt`	`integer`	No	unix-ms timestamp
`updatedAt`	`integer`	No	unix-ms timestamp

`items[]` item

Field	Type	Required	Constraints
`type`	`string`	No	-
`componentName`	`string`	No	-
`amount`	`number`	No	-
`reason`	`string`	No	-
`createdBy`	`string`	No	-
`createdAt`	`integer`	No	unix-ms timestamp

Response Data Format Example

{
  "success": true,
  "message": "value",
  "payroll": {
    "id": "id_123",
    "organizationId": "org_123",
    "payrollRunId": "payrollrun_123",
    "employeeId": "employee_123",
    "payrollYear": 1,
    "payrollMonth": 1,
    "totalDays": 1,
    "presentDays": 1,
    "absentDays": 1,
    "lateDays": 1,
    "halfDays": 1,
    "grossSalary": 1,
    "statutoryDeductionAmount": 1,
    "otherDeductionAmount": 1,
    "otherDeductionReason": "value",
    "deductionAmount": 1,
    "netSalary": 1,
    "status": "scheduled",
    "generatedAt": 1710201600000,
    "createdAt": 1710201600000,
    "updatedAt": 1710201600000
  },
  "items": [
    {
      "type": "general",
      "componentName": "value",
      "amount": 1,
      "reason": "value",
      "createdBy": "value",
      "createdAt": 1710201600000
    }
  ]
}

Example Response

{
  "status": "ok",
  "data": {
    "success": true,
    "message": "value",
    "payroll": {
      "id": "id_123",
      "organizationId": "org_123",
      "payrollRunId": "payrollrun_123",
      "employeeId": "employee_123",
      "payrollYear": 1,
      "payrollMonth": 1,
      "totalDays": 1,
      "presentDays": 1,
      "absentDays": 1,
      "lateDays": 1,
      "halfDays": 1,
      "grossSalary": 1,
      "statutoryDeductionAmount": 1,
      "otherDeductionAmount": 1,
      "otherDeductionReason": "value",
      "deductionAmount": 1,
      "netSalary": 1,
      "status": "scheduled",
      "generatedAt": 1710201600000,
      "createdAt": 1710201600000,
      "updatedAt": 1710201600000
    },
    "items": [
      {
        "type": "general",
        "componentName": "value",
        "amount": 1,
        "reason": "value",
        "createdBy": "value",
        "createdAt": 1710201600000
      }
    ]
  }
}

Hrm Leave Policies Hrm Shift Assignments

Hrm Payroll

addBonus

Input Fields

Example Request

Response Data Format

Response Data Format Nested Structures

payroll

items[] item

Response Data Format Example

Example Response

addOtherDeduction

Input Fields

Example Request

Response Data Format

Response Data Format Nested Structures

payroll

items[] item

Response Data Format Example

Example Response

approve

Input Fields

Example Request

Response Data Format

Response Data Format Example

Example Response

deleteEmployeePayroll

Input Fields

Example Request

Response Data Format

Response Data Format Example

Example Response

exportExcel

Input Fields

Example Request

Response Data Format

Response Data Format Example

Example Response

exportPdf

Input Fields

Example Request

Response Data Format

Response Data Format Example

Example Response

generate

Input Fields

Example Request

Response Data Format

Response Data Format Example

Example Response

getByMonth

Input Fields

Example Request

Response Data Format

Response Data Format Nested Structures

items[] item

Response Data Format Example

Example Response

getEmployeePayslip

Input Fields

Example Request

Response Data Format

Response Data Format Nested Structures

attendance

earnings[] item

deductions[] item

Response Data Format Example

Example Response

getPayrollAdjustments

Input Fields

Example Request

Response Data Format

Response Data Format Nested Structures

payroll

items[] item

Response Data Format Example

Example Response

list

Input Fields

Example Request

Response Data Format

`addBonus`

`payroll`

`items[]` item

`addOtherDeduction`

`payroll`

`items[]` item

`approve`

`deleteEmployeePayroll`

`exportExcel`

`exportPdf`

`generate`

`getByMonth`

`items[]` item

`getEmployeePayslip`

`attendance`

`earnings[]` item

`deductions[]` item

`getPayrollAdjustments`

`payroll`

`items[]` item

`list`

`items[]` item

`lock`

`markPaid`

`regenerateEmployeePayroll`

`payroll`

`items[]` item