Skip to navigation

CreateFees

View as Markdown

Creates new School Fees

Input variables

  • json representation of new School Fee
    • type (application | school)
      • to select whether you are creating an application fee or a school fee
    • period (oneoff | monthly | periodically)
      • to select the recurring mode of the fee
    • cost
    • description
    • startDate
      • when will be the first installment
    • interval (0.5 | 1 | 2 | 3 | 4 | 5 | 6)
      • the recurrence interval (in months)
    • duration
      • number of the recurrences
    • schoolPeriodId
      • the id of the School Period you are creating the fee

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.
costintegerRequired
startDatedateRequired
descriptionstringRequired
schoolPeriodIdintegerRequired
durationintegerRequired
typestringRequired
periodstringRequired
intervalintegerRequired

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
idinteger
descriptionstring
costinteger
durationinteger
intervalinteger
startDatedate
periodstring
typestring
schoolPeriodIdinteger