Tabs Classes (QBO only) API

The Classes (QBO only) API from Tabs — 1 operation(s) for classes (qbo only).

OpenAPI Specification

tabs-classes-qbo-only-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Tabs External Billing Terms Classes (QBO only) API
  description: ''
  version: 1.0.0
  contact: {}
  x-apievangelist:
    generated: '2026-07-21'
    method: searched
    source: https://docs.tabsplatform.com/reference (OpenAPI definitions embedded per-operation in the ReadMe reference pages, merged; index at https://docs.tabsplatform.com/llms.txt)
    source_pages: 93
servers:
- url: https://integrators.prod.api.tabsplatform.com
security:
- custom-header: []
tags:
- name: Classes (QBO only)
paths:
  /v3/classes:
    get:
      description: Class comes from QBO only, and can be populated on an obligation. This does not apply to NS users
      operationId: IntegratorsApiClassesController_getClasses
      parameters: []
      responses:
        '200':
          description: Get QBO Classes
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/IntegratorsApiResponse'
                - properties:
                    payload:
                      properties:
                        data:
                          type: array
                          items:
                            $ref: '#/components/schemas/ClassModelDto'
      summary: List classes
      tags:
      - Classes (QBO only)
components:
  schemas:
    IntegratorsApiError:
      type: object
      properties:
        code:
          type: number
          description: API response code
        message:
          type: string
          description: API response message
        details:
          type: object
          description: Additional details about the error
      required:
      - code
      - message
    IntegratorsApiResponse:
      type: object
      properties:
        payload:
          type: object
          description: Response payload, will be empty when success is false
        success:
          type: boolean
          description: Boolean with true=success, false=failure
        message:
          type: string
          description: Plain-text description of the result
        error:
          description: json element with any error messages or warnings
          allOf:
          - $ref: '#/components/schemas/IntegratorsApiError'
      required:
      - payload
      - success
      - message
      - error
    ClassModelDto:
      type: object
      properties:
        id:
          type: string
          description: The ID of the class model
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: The name of the class model
          example: Class Model 1
        externalId:
          type: string
          description: The external ID of the class model
          example: '123'
      required:
      - id
      - name
      - externalId
  securitySchemes:
    custom-header:
      type: apiKey
      name: Authorization
      in: header