Path parameters

• familyId string Required

  Family ID

Query parameters

• enrolments array[object] Required

  Enrolments

  Hide enrolments attributes Show enrolments attributes object

  • classId string Required
  • studentId string Required
• trials array[object] Required

  Trials

  Hide trials attributes Show trials attributes object

  • classId string Required
  • studentId string Required
  • trialAt string(date) Required
  • time string Required

Responses

• 200 application/json

  successful operation

  Hide response attributes Show response attributes object

  • registrationFees array[object] Required

    Registration Fee Quote schema

    Hide registrationFees attributes Show registrationFees attributes object

    • name string Required

      Registration fee name

    • registrationFeeId string Required

      Registration fee ID

    • subTotal integer Required

      Sub total

    • total integer Required

      Total

    • taxTotal integer Required

      Tax total

  • seasons array[object] Required

    Quote schema

    Hide seasons attributes Show seasons attributes object

    • familyId string Required

      Family ID

    • season object Required

      Season schema

      Hide season attributes Show season attributes object

      • id string Required

        id

      • companyId string Required

        Company ID

      • name string Required

        Name

      • startAt string(date) Required

        Start At

      • endAt string(date) Required

        End At

      • registrationOpen boolean Required

        Whether Registration is currently open

      • registrationStatus string Required

        Values are never, open, closed, or ended.

      • enableRegistrationFees boolean Required

        Whether company registration fees are enabled for this season

      • registrationFeeDto object | null Required

        Registration Fee schema

        Hide registrationFeeDto attributes Show registrationFeeDto attributes object | null

        • id string Required

          Registration fee ID

        • name string Required

          Name

        • amount integer Required

          Amount

        • maxAmountPerFamily integer | null Required

          Max Amount Per Family

        • repetitionInterval string Required

          Values are one-off, annual, or per-season.

        • dueDate string(date) | null Required

          Due Date

        • proRated boolean

          Whether the registration fee can be pro-rated

        • taxRate object | null Required

          Tax Rate schema

          Hide taxRate attributes Show taxRate attributes object | null

          • id string Required

            id

          • rate number(float) Required

            Tax Rate (percent) with 3 decimal places

          • label string Required

            Label

          • isDefault boolean Required

            Is Default

        • archivedAt string(date-time) | null Required

          Archived At

      • registrationFee integer Required

        Registration fee

      • registrationFeeTaxRateId string | null Required

        Registration Fee Tax Rate ID

      • hasMaxRegistrationFee boolean Required

        Whether there is a maximum registration fee

      • maxRegistrationFee integer | null Required

        Maximum registration fee per Family

      • pricingScheme string Required

        Values are none, class-count, or total-duration.

      • pricingModel string Required

        Values are per-lesson, per-month, or per-season.

      • pricingPlans array[object] Required

        Pricing plan schema

        Hide pricingPlans attributes Show pricingPlans attributes object

        • id string Required

          Pricing plan ID

        • seasonId string Required

          Season ID

        • pricingModel string Required

          Values are per-lesson, per-month, or per-season.

        • firstPaymentDate string(date) Required

          First payment date

        • numberOfInstallments integer Required

          Number of installments

        • type string Required

          Values are monthly or one-off.

        • paymentDay integer | null Required

          Payment day

        • discount number | null Required
        • billingTiming string | null Required

          Values are advance, during, or arrears.

        • enabled boolean Required

          Whether the pricing plan is enabled

      • additionalFees array[object] Required

        Additional fees

        Fee for entity

        Hide additionalFees attributes Show additionalFees attributes object

        • id string Required

          Make up lesson ID

        • companyId string Required

          Company ID

        • entityId string Required

          The entity ID

        • description string Required

          The description of the fee

        • amount integer Required

          The amount of fee

        • maxAmountPerFamily integer | null Required

          The maximum amount per family

        • taxRateId string | null Required

          Tax rate ID

      • createdAt string(date-time) Required

        Created at date

      • updatedAt string(date-time) | null Required

        Updated at date

      • archivedAt string(date-time) | null Required

        Archived at date

    • enabledPricingPlans array[object] Required

      Pricing plan schema

      Hide enabledPricingPlans attributes Show enabledPricingPlans attributes object

      • id string Required

        Pricing plan ID

      • seasonId string Required

        Season ID

      • pricingModel string Required

        Values are per-lesson, per-month, or per-season.

      • firstPaymentDate string(date) Required

        First payment date

      • numberOfInstallments integer Required

        Number of installments

      • type string Required

        Values are monthly or one-off.

      • paymentDay integer | null Required

        Payment day

      • discount number | null Required
      • billingTiming string | null Required

        Values are advance, during, or arrears.

      • enabled boolean Required

        Whether the pricing plan is enabled

    • description string Required

      Description

    • date string(date) Required

      Date

    • subtotal integer Required

      Subtotal

    • discountTotal integer Required

      Discount total

    • taxTotal integer Required

      Tax total

    • total integer Required

      Total

    • items array[object] Required

      Items

      Bill Item schema

      Hide items attributes Show items attributes object

      • description string Required

        Description

      • type string Required

        Values are manual-debit, tax, additional-fee, registration-fee, tuition, trial, refund, payment-auto-failed, payment-auto-failed-reversal, discount-credit, payment-manual, discount, discount-tax, credit-note, manual-debit-credit, tax-credit, registration-fee-credit, tuition-credit, trial-credit, payment-auto, payment-pending-card, fee-class-manager, or fee-company.

      • subtotal integer Required

        Subtotal

      • discountTotal integer Required

        Discount total

      • taxTotal integer | null Required

        Tax total

      • taxDescription string | null Required

        Tax description

      • total integer Required

        Total

      • discounts array[object] Required

        Taxes

        Bill Item Discount schema

        Hide discounts attributes Show discounts attributes object

        • description string Required

          Description

        • total integer Required

          Total

        • amount integer Required

          Amount

        • taxAmount integer | null Required

          Tax amount

    • taxes array[object] Required

      Taxes

      Bill Item Tax schema

      Hide taxes attributes Show taxes attributes object

      • description string Required

        Description

      • amount integer Required

        Amount

    • remainingInstalments integer Required

      Remaining instalments

    • proRatedTotal integer | null Required

      Pro-rated total (if different from total)

  • summary object Required
    Hide summary attributes Show summary attributes object

    • subTotal integer

      Sub total

    • total integer

      Total

    • taxTotal integer

      Tax total

    • discountTotal integer

      Discount total

    • proRatedTotal integer

      Pro-rated total

• 403 application/json

  Not authorized

  Hide response attributes Show response attributes object

  Error schema

  • statusCode number Required

    Status Code

  • messages array[string] Required

    List of error messages

  • exception object

    Exception

• 404 application/json

  Not found

  Hide response attributes Show response attributes object

  Error schema

  • statusCode number Required

    Status Code

  • messages array[string] Required

    List of error messages

  • exception object

    Exception