Responses

• 200 application/json

  successful operation

  Hide response attributes Show response 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 Required

    Registration Fee schema

    Hide registrationFeeDto attributes Show registrationFeeDto attributes object

    • 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 Required

      Tax Rate schema

      Hide taxRate attributes Show taxRate attributes object

      • 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 one-off, monthly, fortnightly, weekly, or custom.

    • discount number Required
    • enabled boolean Required

      Whether the pricing plan is enabled

    • installmentDates array[string(date-time)] | null Required

      Custom installment dates for custom pricing plans

  • 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

    • proRated boolean Required

      Whether the fee is prorated based on season duration

    • 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

• 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

• 422 application/json

  Validation error

  Hide response attributes Show response attributes object

  • statusCode number Required

    Status Code

  • messages array[string] Required

    List of error messages

  • exception object

    Exception