Skip to navigation

AssignFees

View as Markdown

Bulk Assign Fees to Students

Input variables

  • studentIds

    • array of student period ids (the ids returned by GetPeriodStudents, not student record ids)
  • feesIds

    • array of applicable fees ids
  • installmentPlan (1 | 2 | 3)

    • 1 = apply all installments from the fee start date

    • 2 = apply installments from next month

    • 3 = apply installments from this month

Headers

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional

Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.

schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Request

This endpoint expects an object.
studentIdslist of integersRequired
feesIdslist of integersRequired
installmentPlanintegerRequired

Response headers

ExpiresstringOptional
Cache-ControlstringOptional
Access-Control-Allow-HeadersstringOptional
X-XSS-ProtectionstringOptional
PragmastringOptional
Access-Control-Allow-MethodsstringOptional
X-Frame-OptionsstringOptional
Access-Control-Expose-HeadersstringOptional
Access-Control-Allow-OriginstringOptional
Access-Control-Allow-CredentialsstringOptional
X-Content-Type-OptionsstringOptional
Access-Control-Max-AgestringOptional

Response

OK