MODULE GUIDE · 11 OCT 2026

Library & circulation

Maintain titles and copies, lend books, manage reservations and handle fines.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

Book catalogue

Copy availability

Issue and return

Renewal

Reservations

Library policy

Fine collection and waiver

BEFORE YOU BEGIN

Access & setup

Intended access: Super Admin, School Admin, Principal, Vice Principal, Management, Librarian.

An assigned school account with the required permissions.
The academic, student or staff setup used by this workflow.

Required permission keys

library:viewlibrary:createlibrary:updatelibrary:deletelibrary: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

01
Create a title and its physical copies
An assigned school account with the required permissions.
02
Check borrower eligibility and issue an available copy
Copy availability is part of the documented workflow.
03
Return or renew the loan and review reservations
Issue and return is part of the documented workflow.
04
Review overdue items and any permitted fine action
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.

Field	Declared type	Input
`title`	string	Required by declaration
`author`	string	Optional
`publisher`	string	Optional
`isbn`	string	Optional
`category`	string	Optional
`edition`	string	Optional
`rackNo`	string	Optional
`price`	number	Optional
`id`	string	Optional
`version`	string	Optional
`reason`	string	Optional
`bookId`	string	Required by declaration
`barcode`	string	Required by declaration
`status`	string	Optional
`copyId`	string	Required by declaration
`dueDate`	string	Optional
`condition`	string	Required by declaration
`additionalCharge`	number	Optional
`loanDays`	number	Optional
`finePerDay`	number	Optional
`graceDays`	number	Optional
`maxBooksPerBorrower`	number	Optional
`maxFinePerIssue`	number	Optional
`blockIssueOverDues`	number	Optional

CURRENT BEHAVIOUR

Rules & current limits

Availability, borrower policy and reservation rules affect issue/renewal. A fine record is distinct from a fee gateway payment.

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 library & circulation

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.

24 source-declared operations

GET/api/v1/library/workspace

Workspace

library:view

GET/api/v1/library/books

Books

library:view

GET/api/v1/library/copies

Copies

library:view

GET/api/v1/library/issues

Issues

library:view

GET/api/v1/library/overdue

Overdue

library:view

POST/api/v1/library/books

Book

library:create

Declared request fields: title (required), author (optional), publisher (optional), isbn (optional), category (optional), edition (optional), rackNo (optional), price (optional).

PATCH/api/v1/library/books/:id

Edit Book

library:update

Declared request fields: title (required), author (optional), publisher (optional), isbn (optional), category (optional), edition (optional), rackNo (optional), price (optional).

DELETE/api/v1/library/books/:id

Delete Book

library:delete

Declared request fields: id (optional), version (optional), reason (optional).

POST/api/v1/library/copies

Copy

library:create

Declared request fields: bookId (required), barcode (required), status (optional).

PATCH/api/v1/library/copies/:id

Edit Copy

library:update

Declared request fields: bookId (required), barcode (required), status (optional).

DELETE/api/v1/library/copies/:id

Delete Copy

library:delete

Declared request fields: id (optional), version (optional), reason (optional).

POST/api/v1/library/issues

Issue

library:create

Declared request fields: copyId (required), dueDate (optional).

POST/api/v1/library/issues/:id/return

Return Book

library:update

Declared request fields: condition (required), additionalCharge (optional).

POST/api/v1/library/issues/:id/renew

Renew

library:update

Declared request fields: id (optional), version (optional), reason (optional).

POST/api/v1/library/issues/:id/remind

Remind

library:update

POST/api/v1/library/reservations

Reserve

library:create

Declared request fields: bookId (required).

POST/api/v1/library/reservations/:id/cancel

Cancel

library:update

Declared request fields: id (optional), version (optional), reason (optional).

GET/api/v1/library/policy

Policy

library:view

PATCH/api/v1/library/policy

Set Policy

library:manage

Declared request fields: loanDays (optional), finePerDay (optional), graceDays (optional), maxBooksPerBorrower (optional), maxFinePerIssue (optional), blockIssueOverDues (optional), maxRenewals (optional), renewDays (optional).

GET/api/v1/library/fines/outstanding

Outstanding

library:view

GET/api/v1/library/issues/:id/fine

Summary

library:view

POST/api/v1/library/issues/:id/fine/collect

Collect

library:update

Declared request fields: amount (optional), method (optional), note (optional).

POST/api/v1/library/issues/:id/fine/waive

Waive

library:manage

Declared request fields: amount (optional), method (optional), note (optional).

POST/api/v1/library/fines/:id/void

Void

library:manage

Declared request fields: amount (optional), method (optional), note (optional).

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

Library & circulation

What you can do

Book catalogue

Copy availability

Issue and return

Renewal

Reservations

Library policy

Fine collection and waiver

Access & setup

How the workflow works

Create a title and its physical copies

Check borrower eligibility and issue an available copy

Return or renew the loan and review reservations

Review overdue items and any permitted fine action

Request fields to understand

Rules & current limits

Try library & circulation

API & permissions reference

Open the actual application

Keep exploring