> ## Documentation Index
> Fetch the complete documentation index at: https://docs.classquill.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Parent Balance

> What a parent owes and has paid, summed across their org-linked children's
invoices. Returns 404 if the parent has no students in this org.



## OpenAPI

````yaml /openapi.json get /v1/parents/{parent_id}/balance
openapi: 3.1.0
info:
  title: EquateIt Public API
  description: >-
    REST API for EquateIt tutoring organisations. Pipe your sessions, invoices,
    payments, tutor earnings, students, and more into your own tools. Most
    endpoints are reads; a focused set of writes (each gated by a *:write scope)
    create or update data, including creating student/tutor/parent accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the EquateIt app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/parents/{parent_id}/balance:
    get:
      tags:
        - Students & Parents
      summary: Parent Balance
      description: >-
        What a parent owes and has paid, summed across their org-linked
        children's

        invoices. Returns 404 if the parent has no students in this org.
      operationId: parent_balance_v1_parents__parent_id__balance_get
      parameters:
        - name: parent_id
          in: path
          required: true
          schema:
            type: string
            title: Parent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParentBalance'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ParentBalance:
      properties:
        parent_id:
          type: string
          title: Parent Id
        total_invoiced_cents:
          type: integer
          title: Total Invoiced Cents
          default: 0
        total_paid_cents:
          type: integer
          title: Total Paid Cents
          default: 0
        outstanding_cents:
          type: integer
          title: Outstanding Cents
          default: 0
        open_invoices_count:
          type: integer
          title: Open Invoices Count
          default: 0
      type: object
      required:
        - parent_id
      title: ParentBalance
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````