> ## 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.

# Tutor Earnings

> Earnings for one tutor over an optional date range — the payroll/Xero figure.

`earned_cents` is what the tutor is owed for their sessions; `paid_out_cents`
is what's been paid out; `unpaid_cents` is the difference. Scoped to this org's
sessions only. Returns 404 if the tutor isn't an accepted member of this org.



## OpenAPI

````yaml /openapi.json get /v1/tutors/{tutor_id}/earnings
openapi: 3.1.0
info:
  title: ClassQuill Public API
  description: >-
    REST API for ClassQuill 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 ClassQuill 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/tutors/{tutor_id}/earnings:
    get:
      tags:
        - Tutors
      summary: Tutor Earnings
      description: >-
        Earnings for one tutor over an optional date range — the payroll/Xero
        figure.


        `earned_cents` is what the tutor is owed for their sessions;
        `paid_out_cents`

        is what's been paid out; `unpaid_cents` is the difference. Scoped to
        this org's

        sessions only. Returns 404 if the tutor isn't an accepted member of this
        org.
      operationId: tutor_earnings_v1_tutors__tutor_id__earnings_get
      parameters:
        - name: tutor_id
          in: path
          required: true
          schema:
            type: string
            description: Tutor UUID
            title: Tutor Id
          description: Tutor UUID
        - name: from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Session starts_at >= ISO date
            title: From
          description: Session starts_at >= ISO date
        - name: to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Session starts_at <= ISO date
            title: To
          description: Session starts_at <= ISO date
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TutorEarnings'
        '401':
          description: Missing, malformed, revoked, or expired credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The credential lacks the scope this endpoint requires.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            Not found — the record doesn't exist or belongs to another
            organisation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation error — `error.details.errors` lists the fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limit exceeded — honour Retry-After and the RateLimit-*
            headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    TutorEarnings:
      properties:
        tutor_id:
          type: string
          title: Tutor Id
        sessions_count:
          type: integer
          title: Sessions Count
          default: 0
        period_start:
          anyOf:
            - type: string
            - type: 'null'
          title: Period Start
        period_end:
          anyOf:
            - type: string
            - type: 'null'
          title: Period End
        earned_cents:
          type: integer
          title: Earned Cents
          default: 0
        paid_out_cents:
          type: integer
          title: Paid Out Cents
          default: 0
        unpaid_cents:
          type: integer
          title: Unpaid Cents
          default: 0
      type: object
      required:
        - tutor_id
      title: TutorEarnings
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    ApiErrorBody:
      description: The `error` object every /v1 error response carries.
      properties:
        code:
          description: >-
            Stable machine-readable error code: bad_request, unauthorized,
            forbidden, not_found, conflict, validation_error, rate_limited, or
            internal_error.
          examples:
            - not_found
          title: Code
          type: string
        message:
          description: Human-readable explanation, safe to surface to end users.
          examples:
            - Session not found
          title: Message
          type: string
        status:
          description: The HTTP status code, repeated in the body.
          examples:
            - 404
          title: Status
          type: integer
        details:
          additionalProperties: true
          description: >-
            Error-specific context. 422 carries the field errors under `errors`;
            429 carries `retry_after_seconds`.
          title: Details
          type: object
      required:
        - code
        - message
        - status
      title: ApiErrorBody
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.