AVKUL ERPDocs
MODULE GUIDE · 11 OCT 2026

Payroll & salary structures

Prepare salary structures, process payroll, review approvals and maintain salary slips.

Try guided demo →Download guide ↓
Payroll & salary structures — illustrated workflow banner
OVERVIEW

What you can do

01

Salary structures

02

Payroll processing

03

Approval

04

Mark paid

05

Salary slips

06

PDF generation

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

  • An assigned school account with the required permissions.
  • The academic, student or staff setup used by this workflow.
Required permission keys
payroll:viewpayroll:createpayroll:updatepayroll:deletepayroll:manage

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

STEP BY STEP

How the workflow works

  1. 01

    Create the applicable salary structure

    An assigned school account with the required permissions.

  2. 02

    Process payroll for the selected period

    Payroll processing is part of the documented workflow.

  3. 03

    Review calculations and approve the run

    Approval is part of the documented workflow.

  4. 04

    Record payment status and review salary slips

    Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

FieldDeclared typeInput
namestringRequired by declaration
staffIdstringOptional
basicnumberRequired by declaration
componentsJsonSalaryComponentDto[]Optional
ctcnumberOptional
effectiveFromstringOptional
isActivebooleanOptional
monthnumberRequired by declaration
yearnumberRequired by declaration
applyLossOfPaybooleanOptional
paidDaysnumberOptional
loanRecoverynumberOptional
taxnumberOptional
CURRENT BEHAVIOUR

Rules & current limits

  • Marking payroll paid records an administrative state; this feature does not by itself transfer money to a bank.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

LEARN BY DOING

Try payroll & salary structures

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →
FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

12 source-declared operations
GET/api/v1/hr/salary-structures

List Structures

payroll:view
POST/api/v1/hr/salary-structures

Create Structure

payroll:create

Declared request fields: name (required), staffId (optional), basic (required), componentsJson (optional), ctc (optional), effectiveFrom (optional), isActive (optional).

PATCH/api/v1/hr/salary-structures/:id

Update Structure

payroll:update
DELETE/api/v1/hr/salary-structures/:id

Remove Structure

payroll:delete
GET/api/v1/hr/payrolls

List Payrolls

payroll:view
GET/api/v1/hr/payrolls/:id

Get Payroll

payroll:view
POST/api/v1/hr/payrolls/process

Process Payroll

payroll:manage

Declared request fields: month (required), year (required), applyLossOfPay (optional).

POST/api/v1/hr/payrolls/:id/approve

Approve Payroll

payroll:manage
POST/api/v1/hr/payrolls/:id/mark-paid

Mark Paid

payroll:manage
GET/api/v1/hr/salary-slips

List Slips

payroll:view
PATCH/api/v1/hr/salary-slips/:id

Update Slip

payroll:update

Declared request fields: paidDays (optional), loanRecovery (optional), tax (optional).

POST/api/v1/hr/salary-slips/:id/generate-pdf

Generate Slip Pdf

payroll:view

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/school/payrollOpen ↗

Keep exploring

Screen guidePayroll & salary structures →