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

# Create an AddOn for a Company

> Create an `AddOn` for a `Company`



## OpenAPI

````yaml /api-reference/openapi.json post /v1/companies/{company-id}/add_ons
openapi: 3.0.3
info:
  title: Horizon API V1
  version: '1.0'
  contact:
    name: Tread
    url: https://tread.io
    email: developers@tread.io
  description: >-
    This is the Version 1 implementation.


    When in doubt we default to the practices outlined
    [here](https://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#advanced-queries)
  license:
    name: Private
    url: https://tread.io
servers:
  - description: production
    url: https://api.tread-horizon.com
security:
  - bearerAuth: []
tags:
  - name: Projects
  - name: Orders
  - name: Loads
  - name: Jobs
  - name: JobAssignments
  - name: ApprovalAssignments
  - name: Equipment
  - name: FuelSurcharges
  - name: Materials
  - name: Accounts
  - name: Tickets
  - name: Users
  - name: Sites
  - name: Companies
  - name: Departments
  - name: Rates
  - name: Services
  - name: EquipmentType
  - name: FileAttachments
  - name: MaterialType
  - name: LineItemType
  - name: DriverStateEvent
  - name: Authentication
  - name: IamRoles
  - name: Typeaheads
  - name: Integrations
  - name: Reflection
  - name: LoadCycles
  - name: AddOns
  - name: ServiceClass
  - name: Invoices
  - name: JobSummaries
  - name: LoadSummaries
  - name: CompanyShares
  - name: UserDevicePermission
  - name: Drivers
  - name: Settlements
  - name: LocationHistories
  - name: Telematics
  - name: OmniReports
  - name: DriverDays
  - name: Agave
  - name: AddOnCharges
  - name: ResourceUsageLogs
  - name: ResourceScopes
  - name: TravelledDistances
  - name: MaterialRates
  - name: CompanyDayJobStats
  - name: KMLFiles
  - name: AutoAddOnAssignments
  - name: SiteRateSchedules
  - name: TwilioIntegrations
  - name: Foremen
  - name: AccountExternalTruckIdentifier
  - name: GeofenceTriggers
  - name: Labels
  - name: Compliance
  - name: ComplianceDocuments
paths:
  /v1/companies/{company-id}/add_ons:
    parameters:
      - schema:
          type: string
        name: company-id
        in: path
        required: true
        description: Company ID
      - $ref: '#/components/parameters/Accept-Language'
    post:
      tags:
        - AddOns
      summary: Create an AddOn for a Company
      description: Create an `AddOn` for a `Company`
      operationId: post-v1-companies-company-id-add_ons
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOn-Create'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/AddOn-Read'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '403':
          $ref: '#/components/responses/Error'
        '406':
          $ref: '#/components/responses/Error'
        '415':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/ModelError'
components:
  parameters:
    Accept-Language:
      name: Accept-Language
      in: header
      schema:
        type: string
        default: en
        example: en
      description: >-
        The Accept-Language request HTTP header indicates the natural language
        and locale that the client prefers. 
  schemas:
    AddOn-Create:
      title: AddOn-Create
      x-stoplight:
        id: o1ksmtglap661
      type: object
      required:
        - name
        - add_on_types
      properties:
        name:
          type: string
          x-stoplight:
            id: cl67dsx43nmu0
        cost_rate_value:
          type: number
          x-stoplight:
            id: 8js81cp6tx9v8
          description: The cost rate or buy price of the add on.
          nullable: true
        revenue_rate_value:
          type: number
          x-stoplight:
            id: 8bzixu62d0ste
          description: The revenue rate or sell price of the add on.
        revenue_cost_rate_type:
          $ref: '#/components/schemas/AddOnRateType'
        add_on_types:
          type: array
          x-stoplight:
            id: v579mppyl55o8
          items:
            $ref: '#/components/schemas/AddOnType'
        quantity:
          type: number
          x-stoplight:
            id: hrcd34s69tbga
        external_id:
          type: string
          x-stoplight:
            id: nzp3xodjxp6hi
          nullable: true
        percentage:
          type: number
          x-stoplight:
            id: 7vjgltw0fe1mf
          description: '`RatePercentTotal` specific field'
          minimum: -100
          maximum: 100
        accounting_id:
          type: string
          x-stoplight:
            id: tq2drhrlerp5u
          nullable: true
        rate:
          type: number
          x-stoplight:
            id: v9fh5ndjeowwc
          deprecated: true
          description: Deprecated in favor of `revenue_rate_value`.
        add_on_rate_type:
          $ref: '#/components/schemas/AddOnRateType'
          deprecated: true
          description: Deprecated in favor of `revenue_cost_rate_type`.
        fuel_surcharge_schedule_id:
          type: string
          x-stoplight:
            id: rl4h6y4fwbfhc
          format: uuid
          nullable: true
        taxable:
          x-stoplight:
            id: f6h8j0m2n4q6s
          type: boolean
          default: false
          description: Whether this add-on is eligible for taxation
      additionalProperties: false
    AddOn-Read:
      title: AddOn-Read
      x-stoplight:
        id: pv5vims1nc6wu
      allOf:
        - $ref: '#/components/schemas/Identifier'
        - type: object
          required:
            - name
            - add_on_types
            - quantity
            - cost_rate_value
            - revenue_rate_value
            - revenue_cost_rate_type
            - external_id
            - percentage
            - company
            - accounting_id
            - rate
            - add_on_rate_type
            - taxable
          properties:
            name:
              type: string
              x-stoplight:
                id: qmldk5115vb6g
            add_on_types:
              type: array
              x-stoplight:
                id: 00d1prh7o0dn0
              items:
                $ref: '#/components/schemas/AddOnType'
            quantity:
              type: string
              x-stoplight:
                id: etwqachefxyi2
            cost_rate_value:
              type: string
              x-stoplight:
                id: 02z1yb6pwqgiw
              description: The cost rate or buy price of the add on
              nullable: true
            revenue_rate_value:
              type: string
              x-stoplight:
                id: pq16i16y4jqig
              description: The revenue rate or sell price of the add on
            revenue_cost_rate_type:
              $ref: '#/components/schemas/AddOnRateType'
            external_id:
              type: string
              x-stoplight:
                id: loqwlx3ud5ar3
              nullable: true
            percentage:
              type: string
              x-stoplight:
                id: vv7o18vi8pzce
            company:
              $ref: '#/components/schemas/Company-Read-Nested'
            accounting_id:
              type: string
              x-stoplight:
                id: t76oqekhuly4n
              nullable: true
            rate:
              type: string
              x-stoplight:
                id: 3b7ro6cldcik7
              deprecated: true
              description: Deprecated in favor of `revenue_rate_value`.
            add_on_rate_type:
              $ref: '#/components/schemas/AddOnRateType'
              deprecated: true
              description: Deprecated in favor of `revenue_cost_rate_type`.
            fuel_surcharge_schedule:
              $ref: '#/components/schemas/FuelSurchargeSchedule-Read-Nested'
            taxable:
              x-stoplight:
                id: u8w0y2b4d6g9i
              type: boolean
              default: false
              description: Whether this add-on is eligible for taxation
        - $ref: '#/components/schemas/Timestamps'
    AddOnRateType:
      title: AddOnRateType
      x-stoplight:
        id: 1c3m0qj0ofdao
      enum:
        - RateForEach
        - RatePercentOfTotal
        - PerLoad
        - FuelSurcharge
      example: RateForEach
      default: RateForEach
    AddOnType:
      title: AddOnType
      x-stoplight:
        id: d2h2dx8n8qui8
      enum:
        - driver_pay
        - invoicing
        - job
        - settlement
        - driver_day
      example: driver_pay
      default: driver_pay
    Identifier:
      title: Identifier
      x-stoplight:
        id: gnd39lue5v7ol
      type: object
      required:
        - id
      properties:
        id:
          type: string
          x-stoplight:
            id: 2e38hjk4zd58m
          format: uuid
      additionalProperties: false
    Company-Read-Nested:
      title: Company-Read-Nested
      x-stoplight:
        id: cb2kn77qmf1l7
      description: Compact Company model for nested reads.
      allOf:
        - $ref: '#/components/schemas/Identifier'
          x-stoplight:
            id: jwsufva4znm91
        - $ref: '#/components/schemas/TreadId'
        - type: object
          properties:
            legal_name:
              type: string
              x-stoplight:
                id: yc10t8hieecwk
              description: The Company's name. Must be globally unique.
            company_type:
              $ref: '#/components/schemas/CompanyType'
          required:
            - legal_name
            - company_type
    FuelSurchargeSchedule-Read-Nested:
      title: FuelSurchargeSchedule-Read-Nested
      x-stoplight:
        id: cfxi1bfv03rdl
      allOf:
        - $ref: '#/components/schemas/Identifier'
        - type: object
          x-stoplight:
            id: ug5goi9re1abe
          required:
            - name
          properties:
            name:
              type: string
              x-stoplight:
                id: 2izdii9s4bcmr
    Timestamps:
      title: Timestamps
      x-stoplight:
        id: t82ecgfu0oj00
      type: object
      required:
        - created_at
        - updated_at
      properties:
        created_at:
          type: string
          x-stoplight:
            id: gjj950jpq0ga9
          format: date-time
          description: ISO8601 timestamp with local timezone
        updated_at:
          type: string
          x-stoplight:
            id: bwcuyfwc7aj0e
          format: date-time
          description: ISO8601 timestamp with local timezone
      additionalProperties: false
    Error-Response:
      title: Error-Response
      x-stoplight:
        id: 52cydhphee3qe
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
      additionalProperties: false
    UnauthenticatedError-Response:
      title: UnauthenticatedError-Response
      x-stoplight:
        id: o477eph7ttbzt
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/UnauthenticatedError'
      additionalProperties: false
    ModelError-Response:
      title: ModelError-Response
      x-stoplight:
        id: payf9ndh3l6np
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ModelError'
      additionalProperties: false
    TreadId:
      title: TreadId
      x-stoplight:
        id: 43k4t5tl359m4
      type: object
      required:
        - tread_id
      properties:
        tread_id:
          type: string
          x-stoplight:
            id: zi3ld7djflw6f
          pattern: ^[0-9A-F]{6}$
          minLength: 6
          maxLength: 6
          example: ABC123
          description: Tread ID
      additionalProperties: false
    CompanyType:
      title: CompanyType
      x-stoplight:
        id: dkzo7gjbtb1b3
      enum:
        - broker
        - contractor
        - hauler
        - owner_operator
        - producer
        - super
      example: hauler
      description: Company Type
    Error:
      title: Error
      x-stoplight:
        id: 3g57kkik3l464
      type: object
      description: An Error.
      required:
        - code
      properties:
        code:
          type: string
          x-stoplight:
            id: 7o9x1t8v0bgfo
      additionalProperties: false
    UnauthenticatedError:
      title: UnauthenticatedError
      x-stoplight:
        id: 202o69l0fs40h
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          x-stoplight:
            id: tg10dt7s0l6bw
          properties:
            error_type:
              type: string
              x-stoplight:
                id: wvq8c0qsym4hz
          required:
            - error_type
    ModelError:
      title: ModelError
      x-stoplight:
        id: nhp6714o4j1qt
      description: A Model-specific error
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          required:
            - errors
          properties:
            errors:
              type: array
              x-stoplight:
                id: m4ul9vcq2deh6
              items:
                $ref: '#/components/schemas/ModelError-Item'
    ModelError-Item:
      title: ModelError-Item
      x-stoplight:
        id: b93chwval2t8d
      type: object
      required:
        - model
        - field
        - message
      properties:
        model:
          type: string
          x-stoplight:
            id: 30myfyjkno8ao
          description: The Model associated with this Error
        field:
          type: string
          x-stoplight:
            id: 8gl4ed3uxhdws
          description: The field associated with this Error
        message:
          type: string
          x-stoplight:
            id: bmgbrtmw17qsj
          description: The Error message
      additionalProperties: false
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
            type: object
    UnauthenticatedError:
      description: Example response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthenticatedError-Response'
            type: object
    ModelError:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ModelError-Response'
            type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````