Docs home

Student Fees Summary

Returns one student's fee summary in your current organization: total fees, amount paid, overdue and outstanding, and each instalment invoice with its status. Use it to show a student's dues in another system.

GET/student/booking/stats
Student Fees Summary
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/student/booking/stats?user_id=<userid>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
  "code": 200,
  "message": "Success",
  "student": {
    "user_id": "168506",
    "name": "Hemal Patel",
    "total_fees": 280,
    "paid": 120,
    "overdue": 160,
    "outstanding": 160,
    "currency": "$",
    "invoices": [
      {
        "invoice_id": 12058,
        "due_date": 1739836800,
        "currency": "$",
        "amount": 10,
        "status": "paid",
        "name": "Full Payment 1"
      },
      {
        "invoice_id": 12066,
        "due_date": 1745280000,
        "currency": "$",
        "amount": 110,
        "status": "paid",
        "name": ""
      },
      {
        "invoice_id": 12067,
        "due_date": 1744070400,
        "currency": "$",
        "amount": 120,
        "status": "pending",
        "name": ""
      },
      {
        "invoice_id": 12068,
        "due_date": 1744070400,
        "currency": "$",
        "amount": 10,
        "status": "pending",
        "name": "Full Payment 1"
      },
      {
        "invoice_id": 12069,
        "due_date": 1744070400,
        "currency": "$",
        "amount": 30,
        "status": "pending",
        "name": "sdfdsf"
      }
    ]
  }
}

Access: Institute admins only. The student must belong to the organization in your ORGID header.

Query parameters
user_idintegerrequired
The student.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
studentobject
Show child attributesHide child attributes
Example: 168506
Instalment name
Example: Hemal Patel
Example: 280
Example: 120
Due and unpaid now
Example: 160
All unpaid
Example: 160
Symbol, - if the student has no fees
Example: $
Show child attributesHide child attributes
Example: 12058
Unix timestamp
Example: 1739836800
Symbol, - if the student has no fees
Example: $
Example: 10
paid or pending
Example: paid
Instalment name
Example: Full Payment 1

Notes: Archived students come back with zero amounts and no invoices. If the student isn't in your organization, the response has code "Error" and the message "You Dont have permission to access this data". Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI