Update Student Booking Details
Changes the instalment plan of a learner's course purchase: add, edit or delete instalments, change the admission date, or change the selected subjects. Use it when you renegotiate a learner's fee schedule.
POST
/student/configurefeesUpdate Student Booking Details
curl --request POST \
--url 'https://<your-api-host>/nuSource/api/v1/student/configurefees' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>' \
--form 'JSONString={"fees_template_id":8,"payment_id":6277,"institution_bundle_id":363,"installments":[{"invoice_id":8860,"instalment_name":"Full+Fees","old_instalment":1,"part_amount":100,"final_amount":100,"discount":0,"part_date":1714348800,"part_formatted_date":"29/04/2024","usd_part_amount":0,"is_pmt":false,"is_igst":0,"igst_per":0,"cgst_per":0,"sgst_per":0,"igst_amount":0,"cgst_amount":0,"sgst_amount":0,"pre_gst_amount":"100.00","enable_gst":0,"place_of_supply":"","isEdit":1,"currency_id":49}],"date_of_admission":1714435200,"course_ids":[],"place_of_supply":"","update_payment_scheme":0}'{
"code": 200,
"message": "Success"
}Access: Institute admins and admins, plus custom roles that can create learners or admissions.
Request body: form-data with one field, JSONString, containing this JSON:
Body
JSONStringThe purchase (
payment_id from the learner's purchase list).Instalments to add, change or delete (fields below). Instalments you don't send are left as they are.
date_of_admissionUnix timestamp
New admission (enrollment) date.
place_of_supplystring
GST place of supply for new instalments.
course_idsarray of integers
Replaces the subjects selected for this enrollment. Send
[] to clear them.fees_template_idinteger
New fee template to record for the purchase (used with
update_payment_scheme).update_payment_schemeinteger
1 saves fees_template_id on the purchase when new instalments are added.Fields in each installments object:
| Name | Required | Type | Description |
|---|---|---|---|
| invoice_id | For existing instalments | integer | Instalment to change or delete. Leave out (or 0) to add a new one. |
| currency_id | Yes (except when deleting) | integer | Must be the purchase's currency. |
| part_amount | For new and unpaid instalments | number | Instalment amount. |
| part_date | Yes (except when deleting) | Unix timestamp | Due date (also used as the invoice date). |
| instalment_name | Yes (except when deleting) | string | Name shown on the invoice. |
| discount | No | number | Discount on this instalment. |
| is_deleted | No | integer | 1 deletes the instalment. |
| part_id | When deleting a zero-amount instalment | integer | Zero-amount instalments have no invoice; delete them by part_id. |
| enable_gst, is_igst, igst_per, igst_amount, cgst_per, cgst_amount, sgst_per, sgst_amount | No | number | GST settings and amounts for the invoice. |
| is_autodebit, is_recurring_part | No | integer | Must match the purchase's existing setting. |
| old_instalment | No | integer | 1 with no invoice_id: the row is skipped. |
Notes:
- An unpaid instalment can be fully edited. Once any payment is recorded against it, only its date, name and GST settings change.
- Deleting an instalment that already has payments fails: "Payment has already been associated to the invoice. Please delete the payments before deleting the invoice."
- Other errors: "Invalid currency.", "Invalid installment" (auto-debit or recurring mismatch), "Installment not found".
- Rate limit: 30 requests per minute; going over locks you out for 30 minutes.