AVKUL ERPDocs
MODULE GUIDE · 11 OCT 2026

Approval workflows

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

Try guided demo →Download guide ↓
Approval workflows — illustrated workflow banner
OVERVIEW

What you can do

01

Workflow definitions

02

Approval steps

03

Pending for me

04

Instance detail

05

Approve/reject

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
settings:viewsettings:createsettings:updatesettings:delete

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 a workflow definition and its ordered steps

    An assigned school account with the required permissions.

  2. 02

    Review the workflow linked to the business record

    Approval steps is part of the documented workflow.

  3. 03

    The current approver opens their pending queue

    Pending for me is part of the documented workflow.

  4. 04

    Record the decision and inspect the next step

    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
decision'APPROVED' | 'REJECTED'Required by declaration
remarkstringOptional
namestringOptional
entityTypestringRequired by declaration
descriptionstringOptional
stepsWorkflowStepDto[]Optional
isActivebooleanOptional
CURRENT BEHAVIOUR

Rules & current limits

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

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 approval workflows

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.

8 source-declared operations
GET/api/v1/workflows/pending-for-me

Approvals waiting on me right now

Authenticated scope and endpoint-specific rules
POST/api/v1/workflows/instances/:id/decide

Approve or reject my current step

Authenticated scope and endpoint-specific rules

Declared request fields: decision (required), remark (optional).

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

Declared request fields: name (required), entityType (required), description (optional), steps (required).

PATCH/api/v1/workflows/:id

Update

settings:update

Declared request fields: name (optional), description (optional), isActive (optional), steps (optional).

DELETE/api/v1/workflows/:id

Remove

settings:delete

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/workflowsOpen ↗

Keep exploring

Screen guideApproval workflows →