> ## 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: 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/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
            title: Tutor Id
        - 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'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
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
    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_...`

````