# Approval workflows

Configure approval chains and let the responsible approver act on the current step.

Category: People
Guide: https://avkul.in/docs/guides/module-workflow/
Guided sample demo: https://avkul.in/docs/demo/module-workflow/
Snapshot: 11 October 2026

## Features

- Workflow definitions
- Approval steps
- Pending for me
- Instance detail
- Approve/reject

## Access and 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.

Permission keys: settings:view, settings:create, settings:update, settings:delete

## Workflow

1. Create a workflow definition and its ordered steps.
2. Review the workflow linked to the business record.
3. The current approver opens their pending queue.
4. Record the decision and inspect the next step.

## Fields and controls

- decision ('APPROVED' | 'REJECTED', declared required)
- remark (string, optional)
- name (string, optional)
- entityType (string, declared required)
- description (string, optional)
- steps (WorkflowStepDto[], optional)
- isActive (boolean, optional)

## Current limits

- Approval is limited to the current eligible approver; it is separate from directly editing the source business record.

## Actual application access

- https://avkul.in/en/school/workflows

## API reference

- GET /api/v1/workflows/pending-for-me — Approvals waiting on me right now; Authenticated scope
- POST /api/v1/workflows/instances/:id/decide — Approve or reject my current step; Authenticated scope
- GET /api/v1/workflows/instances/:id — Get Instance; settings:view
- GET /api/v1/workflows/for-entity — Approval chains attached to one record; settings:view
- GET /api/v1/workflows — List; settings:view
- POST /api/v1/workflows — Create; settings:create
- PATCH /api/v1/workflows/:id — Update; settings:update
- DELETE /api/v1/workflows/:id — Remove; settings:delete

## Demo access

No login is required for the guided sample demo. Its fictional records and actions stay in this browser tab; they do not modify ERP records or send messages/payments. An assigned account is required for the actual ERP links.

Source inventory checked on 11 October 2026. This source inventory is not a certification of every external provider or device flow.