schema/export/380/api.yaml

openapi: 3.0.3
info:
  title: InvenTree API
  version: '380'
  description: API for InvenTree - the intuitive open source inventory management
    system
  license:
    name: MIT
    url: https://github.com/inventree/InvenTree/blob/master/LICENSE
paths:
  /api/:
    get:
      operationId: root_retrieve
      description: Serve current server information.
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoApi'
          description: InvenTree server information
  /api/action/:
    post:
      operationId: action_create
      description: This function checks if all required info was submitted and then
        performs a plugin_action or returns an error.
      tags:
      - action
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionPlugin'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ActionPlugin'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ActionPlugin'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionPlugin'
          description: ''
  /api/admin/config/:
    get:
      operationId: admin_config_list
      description: List view for all accessed configurations.
      tags:
      - admin
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '200':
          description: No response body
  /api/admin/config/{key}/:
    get:
      operationId: admin_config_retrieve
      description: Detail view for an individual configuration.
      parameters:
      - in: path
        name: key
        schema:
          type: string
        required: true
      tags:
      - admin
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '200':
          description: No response body
  /api/admin/email/:
    get:
      operationId: admin_email_list
      description: List view for email objects.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          created, subject, to, sender, status, timestamp, direction.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: global_id, message_id_key, sender,
          subject, thread_id_key, to.'
        schema:
          type: string
      tags:
      - admin
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEmailMessageList'
          description: ''
    delete:
      operationId: admin_email_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - admin
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/admin/email/{global_id}/:
    get:
      operationId: admin_email_retrieve
      description: Detail view for an email object.
      parameters:
      - in: path
        name: global_id
        schema:
          type: string
          format: uuid
          description: Unique identifier for this message
        required: true
      tags:
      - admin
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailMessage'
          description: ''
    delete:
      operationId: admin_email_destroy
      description: Detail view for an email object.
      parameters:
      - in: path
        name: global_id
        schema:
          type: string
          format: uuid
          description: Unique identifier for this message
        required: true
      tags:
      - admin
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '204':
          description: No response body
  /api/admin/email/test/:
    post:
      operationId: admin_email_test_create
      description: Send a test email.
      tags:
      - admin
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestEmail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TestEmail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TestEmail'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:superuser
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEmail'
          description: ''
  /api/attachment/:
    get:
      operationId: attachment_list
      description: List API endpoint for Attachment objects.
      parameters:
      - in: query
        name: is_file
        schema:
          type: boolean
        description: Is File
      - in: query
        name: is_link
        schema:
          type: boolean
        description: Is Link
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: model_id
        schema:
          type: integer
      - in: query
        name: model_type
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          model_id, model_type, upload_date, file_size.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: comment, model_id, model_type.'
        schema:
          type: string
      - in: query
        name: upload_user
        schema:
          type: integer
      tags:
      - attachment
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAttachmentList'
          description: ''
    post:
      operationId: attachment_create
      description: List API endpoint for Attachment objects.
      tags:
      - attachment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Attachment'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Attachment'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Attachment'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
          description: ''
    delete:
      operationId: attachment_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - attachment
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/attachment/{id}/:
    get:
      operationId: attachment_retrieve
      description: Detail API endpoint for Attachment objects.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
          description: ''
    put:
      operationId: attachment_update
      description: Detail API endpoint for Attachment objects.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Attachment'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Attachment'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Attachment'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
          description: ''
    patch:
      operationId: attachment_partial_update
      description: Detail API endpoint for Attachment objects.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAttachment'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAttachment'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAttachment'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Attachment'
          description: ''
    delete:
      operationId: attachment_destroy
      description: Detail API endpoint for Attachment objects.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
  /api/attachment/{id}/metadata/:
    get:
      operationId: attachment_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: attachment_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: attachment_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - attachment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/background-task/:
    get:
      operationId: background_task_retrieve
      description: Return information about the current status of the background task
        queue.
      tags:
      - background-task
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          description: No response body
  /api/background-task/failed/:
    get:
      operationId: background_task_failed_list
      description: Provides a read-only list of currently failed tasks.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          pk, func, started, stopped.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: func.'
        schema:
          type: string
      tags:
      - background-task
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFailedTaskList'
          description: ''
    delete:
      operationId: background_task_failed_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - background-task
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/background-task/pending/:
    get:
      operationId: background_task_pending_list
      description: Provides a read-only list of currently pending tasks.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - background-task
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPendingTaskList'
          description: ''
    delete:
      operationId: background_task_pending_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - background-task
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/background-task/scheduled/:
    get:
      operationId: background_task_scheduled_list
      description: Provides a read-only list of currently scheduled tasks.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          pk, func, last_run, next_run.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: func.'
        schema:
          type: string
      tags:
      - background-task
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedScheduledTaskList'
          description: ''
  /api/barcode/:
    post:
      operationId: barcode_create
      description: |-
        Endpoint for handling generic barcode scan requests.

        Barcode data are decoded by the client application,
        and sent to this endpoint (as a JSON object) for validation.

        A barcode could follow the internal InvenTree barcode format,
        or it could match to a third-party barcode format (e.g. Digikey).
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Barcode'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Barcode'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Barcode'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Barcode'
          description: ''
  /api/barcode/generate/:
    post:
      operationId: barcode_generate_create
      description: |-
        Endpoint for generating a barcode for a database object.

        The barcode is generated by the selected barcode plugin.
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BarcodeGenerate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BarcodeGenerate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BarcodeGenerate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Barcode'
          description: ''
  /api/barcode/history/:
    get:
      operationId: barcode_history_list
      description: List API endpoint for BarcodeScan objects.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          user, plugin, timestamp, endpoint, result.'
        schema:
          type: string
      - in: query
        name: result
        schema:
          type: boolean
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: plugin.'
        schema:
          type: string
      - in: query
        name: user
        schema:
          type: integer
      tags:
      - barcode
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBarcodeScanResultList'
          description: ''
    delete:
      operationId: barcode_history_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - barcode
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/barcode/history/{id}/:
    get:
      operationId: barcode_history_retrieve
      description: Detail endpoint for a BarcodeScan object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - barcode
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodeScanResult'
          description: ''
    delete:
      operationId: barcode_history_destroy
      description: Detail endpoint for a BarcodeScan object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - barcode
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '204':
          description: No response body
  /api/barcode/link/:
    post:
      operationId: barcode_link_create
      description: |-
        Endpoint for assigning a barcode to a stock item.

        - This only works if the barcode is not already associated with an object in the database
        - If the barcode does not match an object, then the barcode hash is assigned to the StockItem
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BarcodeAssign'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BarcodeAssign'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BarcodeAssign'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodeAssign'
          description: ''
  /api/barcode/po-allocate/:
    post:
      operationId: barcode_po_allocate_create
      description: |-
        Endpoint for allocating parts to a purchase order by scanning their barcode.

        Note that the scanned barcode may point to:

        - A Part object
        - A ManufacturerPart object
        - A SupplierPart object
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BarcodePOAllocate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BarcodePOAllocate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BarcodePOAllocate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodePOAllocate'
          description: ''
  /api/barcode/po-receive/:
    post:
      operationId: barcode_po_receive_create
      description: |-
        Endpoint for handling receiving parts by scanning their barcode.

        Barcode data are decoded by the client application,
        and sent to this endpoint (as a JSON object) for validation.

        The barcode should follow a third-party barcode format (e.g. Digikey)
        and ideally contain order_number and quantity information.

        The following parameters are available:

        - barcode: The raw barcode data (required)
        - purchase_order: The purchase order containing the item to receive (optional)
        - location: The destination location for the received item (optional)
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BarcodePOReceive'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BarcodePOReceive'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BarcodePOReceive'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodePOReceive'
          description: ''
  /api/barcode/so-allocate/:
    post:
      operationId: barcode_so_allocate_create
      description: |-
        Endpoint for allocating stock to a sales order, by scanning barcode.

        The scanned barcode should map to a StockItem object.

        Additional fields can be passed to the endpoint:

        - SalesOrder (Required)
        - Line Item
        - Shipment
        - Quantity
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BarcodeSOAllocate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BarcodeSOAllocate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BarcodeSOAllocate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodeSOAllocate'
          description: ''
  /api/barcode/unlink/:
    post:
      operationId: barcode_unlink_create
      description: Endpoint for unlinking / unassigning a custom barcode from a database
        object.
      tags:
      - barcode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BarcodeUnassign'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BarcodeUnassign'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BarcodeUnassign'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BarcodeUnassign'
          description: ''
  /api/bom/:
    get:
      operationId: bom_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: allow_variants
        schema:
          type: boolean
      - in: query
        name: available_stock
        schema:
          type: boolean
        description: Has available stock
      - in: query
        name: category
        schema:
          type: integer
      - in: query
        name: consumable
        schema:
          type: boolean
      - in: query
        name: has_pricing
        schema:
          type: boolean
        description: Has Pricing
      - in: query
        name: inherited
        schema:
          type: boolean
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: on_order
        schema:
          type: boolean
        description: On order
      - in: query
        name: optional
        schema:
          type: boolean
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          can_build, quantity, setup_quantity, attrition, rounding_multiple, sub_part,
          available_stock, allow_variants, inherited, optional, consumable, reference,
          validated, pricing_min, pricing_max, pricing_min_total, pricing_max_total,
          pricing_updated.'
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
      - in: query
        name: part_active
        schema:
          type: boolean
        description: Assembly part is active
      - in: query
        name: part_testable
        schema:
          type: boolean
        description: Assembly part is testable
      - in: query
        name: part_trackable
        schema:
          type: boolean
        description: Assembly part is trackable
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: reference, sub_part__IPN, sub_part__category__name,
          sub_part__description, sub_part__keywords, sub_part__name, sub_part__revision.'
        schema:
          type: string
      - in: query
        name: sub_part_assembly
        schema:
          type: boolean
        description: Component part is an assembly
      - in: query
        name: sub_part_testable
        schema:
          type: boolean
        description: Component part is testable
      - in: query
        name: sub_part_trackable
        schema:
          type: boolean
        description: Component part is trackable
      - in: query
        name: uses
        schema:
          type: integer
      - in: query
        name: validated
        schema:
          type: boolean
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBomItemList'
          description: ''
    post:
      operationId: bom_create
      description: |-
        API endpoint for accessing a list of BomItem objects.

        - GET: Return list of BomItem objects
        - POST: Create a new BomItem object
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BomItem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BomItem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BomItem'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:part
        - r:add:build
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItem'
          description: ''
    delete:
      operationId: bom_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:build
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/bom/{id}/:
    get:
      operationId: bom_retrieve
      description: API endpoint for detail view of a single BomItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItem'
          description: ''
    put:
      operationId: bom_update
      description: API endpoint for detail view of a single BomItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BomItem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BomItem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BomItem'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItem'
          description: ''
    patch:
      operationId: bom_partial_update
      description: API endpoint for detail view of a single BomItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBomItem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBomItem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBomItem'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItem'
          description: ''
    delete:
      operationId: bom_destroy
      description: API endpoint for detail view of a single BomItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:build
      responses:
        '204':
          description: No response body
  /api/bom/{id}/metadata/:
    get:
      operationId: bom_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: bom_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: bom_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/bom/{id}/validate/:
    put:
      operationId: bom_validate_update
      description: API endpoint for validating a BomItem.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BomItemValidation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BomItemValidation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BomItemValidation'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItemValidation'
          description: ''
    patch:
      operationId: bom_validate_partial_update
      description: API endpoint for validating a BomItem.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBomItemValidation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBomItemValidation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBomItemValidation'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItemValidation'
          description: ''
  /api/bom/substitute/:
    get:
      operationId: bom_substitute_list
      description: API endpoint for accessing a list of BomItemSubstitute objects.
      parameters:
      - in: query
        name: bom_item
        schema:
          type: integer
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBomItemSubstituteList'
          description: ''
    post:
      operationId: bom_substitute_create
      description: API endpoint for accessing a list of BomItemSubstitute objects.
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BomItemSubstitute'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BomItemSubstitute'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BomItemSubstitute'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:part
        - r:add:build
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItemSubstitute'
          description: ''
  /api/bom/substitute/{id}/:
    get:
      operationId: bom_substitute_retrieve
      description: API endpoint for detail view of a single BomItemSubstitute object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItemSubstitute'
          description: ''
    put:
      operationId: bom_substitute_update
      description: API endpoint for detail view of a single BomItemSubstitute object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BomItemSubstitute'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BomItemSubstitute'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BomItemSubstitute'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItemSubstitute'
          description: ''
    patch:
      operationId: bom_substitute_partial_update
      description: API endpoint for detail view of a single BomItemSubstitute object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBomItemSubstitute'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBomItemSubstitute'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBomItemSubstitute'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BomItemSubstitute'
          description: ''
    delete:
      operationId: bom_substitute_destroy
      description: API endpoint for detail view of a single BomItemSubstitute object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:build
      responses:
        '204':
          description: No response body
  /api/bom/substitute/{id}/metadata/:
    get:
      operationId: bom_substitute_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: bom_substitute_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: bom_substitute_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - bom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/build/:
    get:
      operationId: build_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: active
        schema:
          type: boolean
        description: Build is active
      - in: query
        name: ancestor
        schema:
          type: integer
        description: Ancestor Build
      - in: query
        name: assigned_to
        schema:
          type: integer
        description: Assigned To
      - in: query
        name: assigned_to_me
        schema:
          type: boolean
        description: Assigned to me
      - in: query
        name: category
        schema:
          type: integer
        description: Category
      - in: query
        name: completed_after
        schema:
          type: string
          format: date
        description: Completed after
      - in: query
        name: completed_before
        schema:
          type: string
          format: date
        description: Completed before
      - in: query
        name: created_after
        schema:
          type: string
          format: date
        description: Created after
      - in: query
        name: created_before
        schema:
          type: string
          format: date
        description: Created before
      - in: query
        name: exclude_tree
        schema:
          type: integer
        description: Exclude Tree
      - in: query
        name: external
        schema:
          type: boolean
      - in: query
        name: has_project_code
        schema:
          type: boolean
        description: has_project_code
      - in: query
        name: has_start_date
        schema:
          type: boolean
        description: Has start date
      - in: query
        name: has_target_date
        schema:
          type: boolean
        description: Has target date
      - in: query
        name: include_variants
        schema:
          type: boolean
        description: Include Variants
      - in: query
        name: issued_by
        schema:
          type: integer
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: max_date
        schema:
          type: string
          format: date
        description: Max Date
      - in: query
        name: min_date
        schema:
          type: string
          format: date
        description: Min Date
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          reference, part__name, status, creation_date, start_date, target_date, completion_date,
          quantity, completed, issued_by, responsible, project_code, priority, level,
          external.'
        schema:
          type: string
      - in: query
        name: outstanding
        schema:
          type: boolean
        description: Build is outstanding
      - in: query
        name: overdue
        schema:
          type: boolean
        description: Build is overdue
      - in: query
        name: parent
        schema:
          type: integer
        description: Parent Build
      - in: query
        name: part
        schema:
          type: integer
        description: Part
      - in: query
        name: project_code
        schema:
          type: integer
      - in: query
        name: reference
        schema:
          type: string
        description: Filter by exact reference
      - in: query
        name: sales_order
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: part__IPN, part__description,
          part__name, priority, project_code__code, reference, title.'
        schema:
          type: string
      - in: query
        name: start_date_after
        schema:
          type: string
          format: date
        description: Start date after
      - in: query
        name: start_date_before
        schema:
          type: string
          format: date
        description: Start date before
      - in: query
        name: status
        schema:
          type: integer
        description: Order Status
      - in: query
        name: target_date_after
        schema:
          type: string
          format: date
        description: Target date after
      - in: query
        name: target_date_before
        schema:
          type: string
          format: date
        description: Target date before
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBuildList'
          description: ''
    post:
      operationId: build_create
      description: |-
        API endpoint for accessing a list of Build objects.

        - GET: Return list of objects (with filters)
        - POST: Create a new Build object
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Build'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Build'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Build'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:build
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
          description: ''
  /api/build/{id}/:
    get:
      operationId: build_retrieve
      description: API endpoint for detail view of a Build object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
          description: ''
    put:
      operationId: build_update
      description: API endpoint for detail view of a Build object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Build'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Build'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Build'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
          description: ''
    patch:
      operationId: build_partial_update
      description: API endpoint for detail view of a Build object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBuild'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBuild'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBuild'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Build'
          description: ''
    delete:
      operationId: build_destroy
      description: API endpoint for detail view of a Build object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:build
      responses:
        '204':
          description: No response body
  /api/build/{id}/allocate/:
    post:
      operationId: build_allocate_create
      description: |-
        API endpoint to allocate stock items to a build order.

        - The BuildOrder object is specified by the URL
        - Items to allocate are specified as a list called "items" with the following options:
            - bom_item: pk value of a given BomItem object (must match the part associated with this build)
            - stock_item: pk value of a given StockItem object
            - quantity: quantity to allocate
            - output: StockItem (build order output) to allocate stock against (optional)
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildAllocation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildAllocation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildAllocation'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildAllocation'
          description: ''
  /api/build/{id}/auto-allocate/:
    post:
      operationId: build_auto_allocate_create
      description: |-
        API endpoint for 'automatically' allocating stock against a build order.

        - Only looks at 'untracked' parts
        - If stock exists in a single location, easy!
        - If user decides that stock items are "fungible", allocate against multiple stock items
        - If the user wants to, allocate substitute parts if the primary parts are not available.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildAutoAllocation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildAutoAllocation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildAutoAllocation'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildAutoAllocation'
          description: ''
  /api/build/{id}/cancel/:
    post:
      operationId: build_cancel_create
      description: API endpoint for cancelling a BuildOrder.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildCancel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildCancel'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildCancel'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildCancel'
          description: ''
  /api/build/{id}/complete/:
    post:
      operationId: build_complete_create
      description: API endpoint for completing build outputs.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildOutputComplete'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildOutputComplete'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildOutputComplete'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildOutputComplete'
          description: ''
  /api/build/{id}/create-output/:
    post:
      operationId: build_create_output_create
      description: API endpoint for creating new build output(s).
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildOutputCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildOutputCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildOutputCreate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildOutputCreate'
          description: ''
  /api/build/{id}/delete-outputs/:
    post:
      operationId: build_delete_outputs_create
      description: API endpoint for deleting multiple build outputs.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildOutputDelete'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildOutputDelete'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildOutputDelete'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildOutputDelete'
          description: ''
  /api/build/{id}/finish/:
    post:
      operationId: build_finish_create
      description: API endpoint for marking a build as finished (completed).
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildComplete'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildComplete'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildComplete'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildComplete'
          description: ''
  /api/build/{id}/hold/:
    post:
      operationId: build_hold_create
      description: API endpoint for placing a BuildOrder on hold.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          description: No response body
  /api/build/{id}/issue/:
    post:
      operationId: build_issue_create
      description: API endpoint for issuing a BuildOrder.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          description: No response body
  /api/build/{id}/metadata/:
    get:
      operationId: build_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: build_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: build_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/build/{id}/scrap-outputs/:
    post:
      operationId: build_scrap_outputs_create
      description: API endpoint for scrapping build output(s).
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildOutputScrap'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildOutputScrap'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildOutputScrap'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildOutputScrap'
          description: ''
  /api/build/{id}/unallocate/:
    post:
      operationId: build_unallocate_create
      description: |-
        API endpoint for unallocating stock items from a build order.

        - The BuildOrder object is specified by the URL
        - "output" (StockItem) can optionally be specified
        - "bom_item" can optionally be specified
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildUnallocation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildUnallocation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildUnallocation'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildUnallocation'
          description: ''
  /api/build/item/:
    get:
      operationId: build_item_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: build
        schema:
          type: integer
        description: Build Order
      - in: query
        name: build_line
        schema:
          type: integer
      - in: query
        name: include_variants
        schema:
          type: boolean
        description: Include Variants
      - in: query
        name: install_into
        schema:
          type: integer
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: location
        schema:
          type: integer
        description: Location
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          part, sku, quantity, location, reference, IPN.'
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
        description: Part
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: build_line__bom_item__reference,
          stock_item__part__IPN, stock_item__part__name, stock_item__supplier_part__SKU.'
        schema:
          type: string
      - in: query
        name: stock_item
        schema:
          type: integer
      - in: query
        name: tracked
        schema:
          type: boolean
        description: Tracked
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBuildItemList'
          description: ''
    post:
      operationId: build_item_create
      description: |-
        API endpoint for accessing a list of BuildItem objects.

        - GET: Return list of objects
        - POST: Create a new BuildItem object
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildItem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildItem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildItem'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:build
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildItem'
          description: ''
    delete:
      operationId: build_item_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:build
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/build/item/{id}/:
    get:
      operationId: build_item_retrieve
      description: API endpoint for detail view of a BuildItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildItem'
          description: ''
    put:
      operationId: build_item_update
      description: API endpoint for detail view of a BuildItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildItem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildItem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildItem'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildItem'
          description: ''
    patch:
      operationId: build_item_partial_update
      description: API endpoint for detail view of a BuildItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBuildItem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBuildItem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBuildItem'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildItem'
          description: ''
    delete:
      operationId: build_item_destroy
      description: API endpoint for detail view of a BuildItem object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:build
      responses:
        '204':
          description: No response body
  /api/build/item/{id}/metadata/:
    get:
      operationId: build_item_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: build_item_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: build_item_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/build/line/:
    get:
      operationId: build_line_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: allocated
        schema:
          type: boolean
        description: Allocated
      - in: query
        name: assembly
        schema:
          type: boolean
        description: Assembly
      - in: query
        name: available
        schema:
          type: boolean
        description: Available
      - in: query
        name: bom_item
        schema:
          type: integer
      - in: query
        name: build
        schema:
          type: integer
      - in: query
        name: consumable
        schema:
          type: boolean
        description: Consumable
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: optional
        schema:
          type: boolean
        description: Optional
      - in: query
        name: order_outstanding
        schema:
          type: boolean
        description: Order Outstanding
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          part, allocated, reference, quantity, consumable, optional, unit_quantity,
          available_stock, trackable, allow_variants, inherited.'
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
        description: Part
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: bom_item__reference, bom_item__sub_part__IPN,
          bom_item__sub_part__description, bom_item__sub_part__name.'
        schema:
          type: string
      - in: query
        name: testable
        schema:
          type: boolean
        description: Testable
      - in: query
        name: tracked
        schema:
          type: boolean
        description: Tracked
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBuildLineList'
          description: ''
    post:
      operationId: build_line_create
      description: API endpoint for accessing a list of BuildLine objects.
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildLine'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildLine'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildLine'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:build
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildLine'
          description: ''
  /api/build/line/{id}/:
    get:
      operationId: build_line_retrieve
      description: API endpoint for detail view of a BuildLine object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildLine'
          description: ''
    put:
      operationId: build_line_update
      description: API endpoint for detail view of a BuildLine object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildLine'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BuildLine'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BuildLine'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildLine'
          description: ''
    patch:
      operationId: build_line_partial_update
      description: API endpoint for detail view of a BuildLine object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedBuildLine'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedBuildLine'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedBuildLine'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:build
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildLine'
          description: ''
    delete:
      operationId: build_line_destroy
      description: API endpoint for detail view of a BuildLine object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:build
      responses:
        '204':
          description: No response body
  /api/build/status/:
    get:
      operationId: build_status_retrieve
      description: Retrieve information about a specific status code
      tags:
      - build
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericStateClass'
          description: ''
        '400':
          description: Invalid request
  /api/company/:
    get:
      operationId: company_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: active
        schema:
          type: boolean
      - in: query
        name: is_customer
        schema:
          type: boolean
      - in: query
        name: is_manufacturer
        schema:
          type: boolean
      - in: query
        name: is_supplier
        schema:
          type: boolean
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          active, name, parts_supplied, parts_manufactured.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: description, name, tax_id, website.'
        schema:
          type: string
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCompanyList'
          description: ''
    post:
      operationId: company_create
      description: |-
        API endpoint for accessing a list of Company objects.

        Provides two methods:

        - GET: Return list of objects
        - POST: Create a new Company object
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Company'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Company'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Company'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:purchase_order
        - r:add:sales_order
        - r:add:return_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
  /api/company/{id}/:
    get:
      operationId: company_retrieve
      description: API endpoint for detail of a single Company object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
    put:
      operationId: company_update
      description: API endpoint for detail of a single Company object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Company'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Company'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Company'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
    patch:
      operationId: company_partial_update
      description: API endpoint for detail of a single Company object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCompany'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCompany'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCompany'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
          description: ''
    delete:
      operationId: company_destroy
      description: API endpoint for detail of a single Company object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:purchase_order
        - r:delete:sales_order
        - r:delete:return_order
      responses:
        '204':
          description: No response body
  /api/company/{id}/metadata/:
    get:
      operationId: company_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: company_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: company_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/company/address/:
    get:
      operationId: company_address_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: company
        schema:
          type: integer
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          title.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAddressList'
          description: ''
    post:
      operationId: company_address_create
      description: API endpoint for list view of Address model.
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Address'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Address'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:purchase_order
        - r:add:sales_order
        - r:add:return_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
          description: ''
    delete:
      operationId: company_address_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:purchase_order
        - r:delete:sales_order
        - r:delete:return_order
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/company/address/{id}/:
    get:
      operationId: company_address_retrieve
      description: API endpoint for a single Address object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
          description: ''
    put:
      operationId: company_address_update
      description: API endpoint for a single Address object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Address'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Address'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Address'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
          description: ''
    patch:
      operationId: company_address_partial_update
      description: API endpoint for a single Address object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAddress'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAddress'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAddress'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Address'
          description: ''
    delete:
      operationId: company_address_destroy
      description: API endpoint for a single Address object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:purchase_order
        - r:delete:sales_order
        - r:delete:return_order
      responses:
        '204':
          description: No response body
  /api/company/contact/:
    get:
      operationId: company_contact_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: company
        schema:
          type: integer
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          name.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: company__name, name.'
        schema:
          type: string
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedContactList'
          description: ''
    post:
      operationId: company_contact_create
      description: API endpoint for list view of Company model.
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contact'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Contact'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Contact'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:purchase_order
        - r:add:sales_order
        - r:add:return_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
    delete:
      operationId: company_contact_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:purchase_order
        - r:delete:sales_order
        - r:delete:return_order
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/company/contact/{id}/:
    get:
      operationId: company_contact_retrieve
      description: Detail endpoint for Company model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
    put:
      operationId: company_contact_update
      description: Detail endpoint for Company model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contact'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Contact'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Contact'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
    patch:
      operationId: company_contact_partial_update
      description: Detail endpoint for Company model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedContact'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedContact'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedContact'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
          description: ''
    delete:
      operationId: company_contact_destroy
      description: Detail endpoint for Company model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:purchase_order
        - r:delete:sales_order
        - r:delete:return_order
      responses:
        '204':
          description: No response body
  /api/company/contact/{id}/metadata/:
    get:
      operationId: company_contact_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
        - r:view:sales_order
        - r:view:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: company_contact_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: company_contact_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/company/part/:
    get:
      operationId: company_part_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: MPN
        schema:
          type: string
        description: Manufacturer Part Number
      - in: query
        name: SKU
        schema:
          type: string
      - in: query
        name: active
        schema:
          type: boolean
        description: Supplier Part is Active
      - in: query
        name: company
        schema:
          type: integer
        description: Company
      - in: query
        name: has_stock
        schema:
          type: boolean
        description: Has Stock
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: manufacturer
        schema:
          type: integer
        description: Manufacturer
      - in: query
        name: manufacturer_part
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          SKU, part, supplier, manufacturer, active, MPN, packaging, pack_quantity,
          in_stock, updated.'
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
      - in: query
        name: part_active
        schema:
          type: boolean
        description: Internal Part is Active
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: SKU, description, manufacturer_part__MPN,
          manufacturer_part__manufacturer__name, part__IPN, part__description, part__keywords,
          part__name, supplier__name, tags__name, tags__slug.'
        schema:
          type: string
      - in: query
        name: supplier
        schema:
          type: integer
      - in: query
        name: supplier_active
        schema:
          type: boolean
        description: Supplier is Active
      - in: query
        name: tags__name
        schema:
          type: string
      - in: query
        name: tags__slug
        schema:
          type: string
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSupplierPartList'
          description: ''
    post:
      operationId: company_part_create
      description: |-
        API endpoint for list view of SupplierPart object.

        - GET: Return list of SupplierPart objects
        - POST: Create a new SupplierPart object
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplierPart'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SupplierPart'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SupplierPart'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:part
        - r:add:purchase_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPart'
          description: ''
    delete:
      operationId: company_part_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/company/part/{id}/:
    get:
      operationId: company_part_retrieve
      description: |-
        API endpoint for detail view of SupplierPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPart'
          description: ''
    put:
      operationId: company_part_update
      description: |-
        API endpoint for detail view of SupplierPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplierPart'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SupplierPart'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SupplierPart'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPart'
          description: ''
    patch:
      operationId: company_part_partial_update
      description: |-
        API endpoint for detail view of SupplierPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSupplierPart'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSupplierPart'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSupplierPart'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPart'
          description: ''
    delete:
      operationId: company_part_destroy
      description: |-
        API endpoint for detail view of SupplierPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
  /api/company/part/{id}/metadata/:
    get:
      operationId: company_part_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: company_part_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: company_part_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/company/part/manufacturer/:
    get:
      operationId: company_part_manufacturer_list
      description: Override the GET method to determine export options.
      parameters:
      - in: query
        name: MPN
        schema:
          type: string
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: manufacturer
        schema:
          type: integer
      - in: query
        name: manufacturer_active
        schema:
          type: boolean
        description: Manufacturer is Active
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
      - in: query
        name: part_active
        schema:
          type: boolean
        description: Part is Active
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: MPN, description, manufacturer__name,
          part__IPN, part__description, part__name, tags__name, tags__slug.'
        schema:
          type: string
      - in: query
        name: tags__name
        schema:
          type: string
      - in: query
        name: tags__slug
        schema:
          type: string
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedManufacturerPartList'
          description: ''
    post:
      operationId: company_part_manufacturer_create
      description: |-
        API endpoint for list view of ManufacturerPart object.

        - GET: Return list of ManufacturerPart objects
        - POST: Create a new ManufacturerPart object
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManufacturerPart'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ManufacturerPart'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ManufacturerPart'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:part
        - r:add:purchase_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPart'
          description: ''
    delete:
      operationId: company_part_manufacturer_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/company/part/manufacturer/{id}/:
    get:
      operationId: company_part_manufacturer_retrieve
      description: |-
        API endpoint for detail view of ManufacturerPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPart'
          description: ''
    put:
      operationId: company_part_manufacturer_update
      description: |-
        API endpoint for detail view of ManufacturerPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManufacturerPart'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ManufacturerPart'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ManufacturerPart'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPart'
          description: ''
    patch:
      operationId: company_part_manufacturer_partial_update
      description: |-
        API endpoint for detail view of ManufacturerPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedManufacturerPart'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedManufacturerPart'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedManufacturerPart'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPart'
          description: ''
    delete:
      operationId: company_part_manufacturer_destroy
      description: |-
        API endpoint for detail view of ManufacturerPart object.

        - GET: Retrieve detail view
        - PATCH: Update object
        - DELETE: Delete object
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
  /api/company/part/manufacturer/{id}/metadata/:
    get:
      operationId: company_part_manufacturer_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: company_part_manufacturer_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: company_part_manufacturer_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/company/part/manufacturer/parameter/:
    get:
      operationId: company_part_manufacturer_parameter_list
      description: API endpoint for list view of ManufacturerPartParamater model.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: manufacturer
        schema:
          type: integer
      - in: query
        name: manufacturer_part
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: name, units, value.'
        schema:
          type: string
      - in: query
        name: units
        schema:
          type: string
      - in: query
        name: value
        schema:
          type: string
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedManufacturerPartParameterList'
          description: ''
    post:
      operationId: company_part_manufacturer_parameter_create
      description: API endpoint for list view of ManufacturerPartParamater model.
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManufacturerPartParameter'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ManufacturerPartParameter'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ManufacturerPartParameter'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:part
        - r:add:purchase_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPartParameter'
          description: ''
    delete:
      operationId: company_part_manufacturer_parameter_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/company/part/manufacturer/parameter/{id}/:
    get:
      operationId: company_part_manufacturer_parameter_retrieve
      description: API endpoint for detail view of ManufacturerPartParameter model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:part
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPartParameter'
          description: ''
    put:
      operationId: company_part_manufacturer_parameter_update
      description: API endpoint for detail view of ManufacturerPartParameter model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManufacturerPartParameter'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ManufacturerPartParameter'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ManufacturerPartParameter'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPartParameter'
          description: ''
    patch:
      operationId: company_part_manufacturer_parameter_partial_update
      description: API endpoint for detail view of ManufacturerPartParameter model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedManufacturerPartParameter'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedManufacturerPartParameter'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedManufacturerPartParameter'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:part
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManufacturerPartParameter'
          description: ''
    delete:
      operationId: company_part_manufacturer_parameter_destroy
      description: API endpoint for detail view of ManufacturerPartParameter model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:part
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
  /api/company/price-break/:
    get:
      operationId: company_price_break_list
      description: |-
        API endpoint for list view of SupplierPriceBreak object.

        - GET: Retrieve list of SupplierPriceBreak objects
        - POST: Create a new SupplierPriceBreak object
      parameters:
      - in: query
        name: base_part
        schema:
          type: integer
        description: Base Part
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          quantity, supplier, SKU, price.'
        schema:
          type: string
      - in: query
        name: part
        schema:
          type: integer
      - in: query
        name: quantity
        schema:
          type: number
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: part__SKU, part__supplier__name.'
        schema:
          type: string
      - in: query
        name: supplier
        schema:
          type: integer
        description: Supplier
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSupplierPriceBreakList'
          description: ''
    post:
      operationId: company_price_break_create
      description: |-
        API endpoint for list view of SupplierPriceBreak object.

        - GET: Retrieve list of SupplierPriceBreak objects
        - POST: Create a new SupplierPriceBreak object
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplierPriceBreak'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SupplierPriceBreak'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SupplierPriceBreak'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:add:purchase_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPriceBreak'
          description: ''
  /api/company/price-break/{id}/:
    get:
      operationId: company_price_break_retrieve
      description: Detail endpoint for SupplierPriceBreak object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPriceBreak'
          description: ''
    put:
      operationId: company_price_break_update
      description: Detail endpoint for SupplierPriceBreak object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupplierPriceBreak'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SupplierPriceBreak'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SupplierPriceBreak'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPriceBreak'
          description: ''
    patch:
      operationId: company_price_break_partial_update
      description: Detail endpoint for SupplierPriceBreak object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSupplierPriceBreak'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSupplierPriceBreak'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSupplierPriceBreak'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:purchase_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierPriceBreak'
          description: ''
    delete:
      operationId: company_price_break_destroy
      description: Detail endpoint for SupplierPriceBreak object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - company
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:delete:purchase_order
      responses:
        '204':
          description: No response body
  /api/contenttype/:
    get:
      operationId: contenttype_list
      description: List view for ContentTypes.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: app_label, model.'
        schema:
          type: string
      tags:
      - contenttype
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedContentTypeList'
          description: ''
  /api/contenttype/{id}/:
    get:
      operationId: contenttype_retrieve
      description: Detail view for a ContentType model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - contenttype
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentType'
          description: ''
  /api/contenttype/model/{model}/:
    get:
      operationId: contenttype_retrieve_model
      description: Detail view for a ContentType model.
      parameters:
      - in: path
        name: model
        schema:
          type: string
        required: true
      tags:
      - contenttype
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentType'
          description: ''
  /api/currency/exchange/:
    get:
      operationId: currency_exchange_retrieve
      description: Return information on available currency conversions.
      tags:
      - currency
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrencyExchange'
          description: ''
  /api/currency/refresh/:
    post:
      operationId: currency_refresh_create
      description: Performing a POST request will update currency exchange rates.
      tags:
      - currency
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          description: No response body
  /api/data-output/:
    get:
      operationId: data_output_list
      description: List view for DataOutput objects.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          pk, user, plugin, output_type, created.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: user
        schema:
          type: integer
      tags:
      - data-output
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataOutputList'
          description: ''
    delete:
      operationId: data_output_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - data-output
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/data-output/{id}/:
    get:
      operationId: data_output_retrieve
      description: Detail view for a DataOutput object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - data-output
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataOutput'
          description: ''
    delete:
      operationId: data_output_destroy
      description: Detail view for a DataOutput object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - data-output
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
  /api/email/generate/:
    post:
      operationId: email_generate_create
      description: Get the token for the current user or fail.
      tags:
      - email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSimpleLogin'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GetSimpleLogin'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GetSimpleLogin'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSimpleLogin'
          description: ''
  /api/error-report/:
    get:
      operationId: error_report_list
      description: List view for server error messages.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          when, info.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: data, info.'
        schema:
          type: string
      tags:
      - error-report
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedErrorMessageList'
          description: ''
    delete:
      operationId: error_report_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - error-report
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/error-report/{id}/:
    get:
      operationId: error_report_retrieve
      description: Detail view for a single error message.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - error-report
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: ''
    put:
      operationId: error_report_update
      description: Detail view for a single error message.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - error-report
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErrorMessage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ErrorMessage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ErrorMessage'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: ''
    patch:
      operationId: error_report_partial_update
      description: Detail view for a single error message.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - error-report
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedErrorMessage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedErrorMessage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedErrorMessage'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: ''
    delete:
      operationId: error_report_destroy
      description: Detail view for a single error message.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - error-report
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
  /api/flags/:
    get:
      operationId: flags_list
      description: List view for feature flags.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - flags
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          description: No response body
  /api/flags/{key}/:
    get:
      operationId: flags_retrieve
      description: Detail view for an individual feature flag.
      parameters:
      - in: path
        name: key
        schema:
          type: string
        required: true
      tags:
      - flags
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          description: No response body
  /api/generate/batch-code/:
    post:
      operationId: generate_batch_code_create
      description: Generate a new batch code.
      tags:
      - generate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateBatchCode'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GenerateBatchCode'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GenerateBatchCode'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateBatchCode'
          description: ''
  /api/generate/serial-number/:
    post:
      operationId: generate_serial_number_create
      description: Generate a new serial number.
      tags:
      - generate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateSerialNumber'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GenerateSerialNumber'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GenerateSerialNumber'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateSerialNumber'
          description: ''
  /api/generic/status/:
    get:
      operationId: generic_status_retrieve_all
      description: Perform a GET request to learn information about status codes.
      tags:
      - generic
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          description: No response body
  /api/generic/status/{statusmodel}/:
    get:
      operationId: generic_status_retrieve
      description: Retrieve information about a specific status code
      parameters:
      - in: path
        name: statusmodel
        schema:
          type: string
        required: true
      tags:
      - generic
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericStateClass'
          description: ''
        '400':
          description: Invalid request
  /api/generic/status/custom/:
    get:
      operationId: generic_status_custom_list
      description: Override the GET method to determine export options.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: model
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          key.'
        schema:
          type: string
      - in: query
        name: reference_status
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: key, label, name, reference_status.'
        schema:
          type: string
      tags:
      - generic
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCustomStateList'
          description: ''
    post:
      operationId: generic_status_custom_create
      description: List view for all custom states.
      tags:
      - generic
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomState'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomState'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomState'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomState'
          description: ''
  /api/generic/status/custom/{id}/:
    get:
      operationId: generic_status_custom_retrieve
      description: Detail view for a particular custom states.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - generic
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomState'
          description: ''
    put:
      operationId: generic_status_custom_update
      description: Detail view for a particular custom states.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - generic
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomState'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CustomState'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CustomState'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomState'
          description: ''
    patch:
      operationId: generic_status_custom_partial_update
      description: Detail view for a particular custom states.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - generic
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCustomState'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCustomState'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCustomState'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomState'
          description: ''
    delete:
      operationId: generic_status_custom_destroy
      description: Detail view for a particular custom states.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - generic
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '204':
          description: No response body
  /api/icons/:
    get:
      operationId: icons_list
      description: List view for available icon packages.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      tags:
      - icons
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIconPackageList'
          description: ''
  /api/importer/column-mapping/:
    get:
      operationId: importer_column_mapping_list
      description: API endpoint for accessing a list of DataImportColumnMap objects.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: session
        schema:
          type: integer
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataImportColumnMapList'
          description: ''
  /api/importer/column-mapping/{id}/:
    get:
      operationId: importer_column_mapping_retrieve
      description: Detail endpoint for a single DataImportColumnMap object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportColumnMap'
          description: ''
    put:
      operationId: importer_column_mapping_update
      description: Detail endpoint for a single DataImportColumnMap object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataImportColumnMap'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataImportColumnMap'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataImportColumnMap'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportColumnMap'
          description: ''
    patch:
      operationId: importer_column_mapping_partial_update
      description: Detail endpoint for a single DataImportColumnMap object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataImportColumnMap'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataImportColumnMap'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataImportColumnMap'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportColumnMap'
          description: ''
  /api/importer/models/:
    get:
      operationId: importer_models_list
      description: Return a list of models available for import.
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataImporterModel'
          description: ''
  /api/importer/row/:
    get:
      operationId: importer_row_list
      description: API endpoint for accessing a list of DataImportRow objects.
      parameters:
      - in: query
        name: complete
        schema:
          type: boolean
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          pk, row_index, valid.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: session
        schema:
          type: integer
      - in: query
        name: valid
        schema:
          type: boolean
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataImportRowList'
          description: ''
    delete:
      operationId: importer_row_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/importer/row/{id}/:
    get:
      operationId: importer_row_retrieve
      description: Detail endpoint for a single DataImportRow object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportRow'
          description: ''
    put:
      operationId: importer_row_update
      description: Detail endpoint for a single DataImportRow object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataImportRow'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataImportRow'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataImportRow'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportRow'
          description: ''
    patch:
      operationId: importer_row_partial_update
      description: Detail endpoint for a single DataImportRow object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataImportRow'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataImportRow'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataImportRow'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportRow'
          description: ''
    delete:
      operationId: importer_row_destroy
      description: Detail endpoint for a single DataImportRow object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '204':
          description: No response body
  /api/importer/session/:
    get:
      operationId: importer_session_list
      description: API endpoint for accessing a list of DataImportSession objects.
      parameters:
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: model_type
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          timestamp, status, model_type.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: status
        schema:
          type: integer
          enum:
          - 0
          - 10
          - 20
          - 30
          - 40
        description: |-
          Import status

          * `0` - Initializing
          * `10` - Mapping Columns
          * `20` - Importing Data
          * `30` - Processing Data
          * `40` - Complete
      - in: query
        name: user
        schema:
          type: integer
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDataImportSessionList'
          description: ''
    post:
      operationId: importer_session_create
      description: API endpoint for accessing a list of DataImportSession objects.
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataImportSession'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataImportSession'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataImportSession'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
        - r:change:part_category
        - r:change:part
        - r:change:stock_location
        - r:change:stock
        - r:change:build
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportSession'
          description: ''
    delete:
      operationId: importer_session_bulk_destroy
      description: |-
        Perform a DELETE operation against this list endpoint.

        Note that the typical DRF list endpoint does not support DELETE,
        so this method is provided as a custom implementation.
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
        - r:change:part_category
        - r:change:part
        - r:change:stock_location
        - r:change:stock
        - r:change:build
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '204':
          description: No response body
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkRequest'
        required: true
  /api/importer/session/{id}/:
    get:
      operationId: importer_session_retrieve
      description: Detail endpoint for a single DataImportSession object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportSession'
          description: ''
    put:
      operationId: importer_session_update
      description: Detail endpoint for a single DataImportSession object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataImportSession'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataImportSession'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataImportSession'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
        - r:change:part_category
        - r:change:part
        - r:change:stock_location
        - r:change:stock
        - r:change:build
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportSession'
          description: ''
    patch:
      operationId: importer_session_partial_update
      description: Detail endpoint for a single DataImportSession object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDataImportSession'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDataImportSession'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDataImportSession'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
        - r:change:part_category
        - r:change:part
        - r:change:stock_location
        - r:change:stock
        - r:change:build
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportSession'
          description: ''
    delete:
      operationId: importer_session_destroy
      description: Detail endpoint for a single DataImportSession object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
        - r:change:part_category
        - r:change:part
        - r:change:stock_location
        - r:change:stock
        - r:change:build
        - r:change:purchase_order
        - r:change:sales_order
        - r:change:return_order
      responses:
        '204':
          description: No response body
  /api/importer/session/{id}/accept_fields/:
    post:
      operationId: importer_session_accept_fields_create
      description: Accept the field mapping for a DataImportSession.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportSession'
          description: ''
  /api/importer/session/{id}/accept_rows/:
    post:
      operationId: importer_session_accept_rows_create
      description: API endpoint to accept the rows for a DataImportSession.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - importer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataImportAcceptRow'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DataImportAcceptRow'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DataImportAcceptRow'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataImportAcceptRow'
          description: ''
  /api/label/print/:
    post:
      operationId: label_print_create
      description: POST action for printing labels.
      tags:
      - label
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelPrint'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LabelPrint'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LabelPrint'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelPrint'
          description: ''
  /api/label/template/:
    get:
      operationId: label_template_list
      description: API endpoint for viewing list of LabelTemplate objects.
      parameters:
      - in: query
        name: enabled
        schema:
          type: boolean
      - in: query
        name: items
        schema:
          type: string
        description: Items
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: model_type
        schema:
          type: string
          enum:
          - build
          - buildline
          - company
          - part
          - purchaseorder
          - returnorder
          - salesorder
          - salesordershipment
          - stockitem
          - stocklocation
        description: |-
          Model Type

          * `build` - Build Order
          * `buildline` - Build Order Line Item
          * `company` - Company
          * `purchaseorder` - Purchase Order
          * `salesorder` - Sales Order
          * `salesordershipment` - Sales Order Shipment
          * `returnorder` - Return Order
          * `part` - Part
          * `stockitem` - Stock Item
          * `stocklocation` - Stock Location
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: description, name.'
        schema:
          type: string
      tags:
      - label
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLabelTemplateList'
          description: ''
    post:
      operationId: label_template_create
      description: API endpoint for viewing list of LabelTemplate objects.
      tags:
      - label
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelTemplate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LabelTemplate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LabelTemplate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelTemplate'
          description: ''
  /api/label/template/{id}/:
    get:
      operationId: label_template_retrieve
      description: Detail API endpoint for label template model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelTemplate'
          description: ''
    put:
      operationId: label_template_update
      description: Detail API endpoint for label template model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelTemplate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LabelTemplate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LabelTemplate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelTemplate'
          description: ''
    patch:
      operationId: label_template_partial_update
      description: Detail API endpoint for label template model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedLabelTemplate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedLabelTemplate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedLabelTemplate'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelTemplate'
          description: ''
    delete:
      operationId: label_template_destroy
      description: Detail API endpoint for label template model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - a:staff
      responses:
        '204':
          description: No response body
  /api/label/template/{id}/metadata/:
    get:
      operationId: label_template_metadata_retrieve
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:admin
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    put:
      operationId: label_template_metadata_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Metadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Metadata'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
    patch:
      operationId: label_template_metadata_partial_update
      description: Generic API endpoint for reading and editing metadata for a model.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - label
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMetadata'
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:change:admin
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
          description: ''
  /api/license/:
    get:
      operationId: license_retrieve
      description: Return information about the InvenTree server.
      tags:
      - license
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicenseView'
          description: ''
  /api/locate/:
    post:
      operationId: locate_create
      description: Identify or 'locate' a stock item or location with a plugin.
      tags:
      - locate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocatePlugin'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LocatePlugin'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LocatePlugin'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - g:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocatePlugin'
          description: ''
  /api/machine/:
    get:
      operationId: machine_list
      description: |-
        API endpoint for list of Machine objects.

        - GET: Return a list of all Machine objects
        - POST: create a MachineConfig
      parameters:
      - in: query
        name: active
        schema:
          type: boolean
      - in: query
        name: driver
        schema:
          type: string
      - name: limit
        required: true
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: machine_type
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: 'Which field to use when ordering the results. Possible fields:
          name, machine_type, driver, active.'
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: 'A search term. Searched fields: name.'
        schema:
          type: string
      tags:
      - machine
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []
      - oauth2:
        - r:view:admin
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMachineConfigList'
          description: ''
    post:
      operationId: machine_create
      description: |-
        API endpoint for list of Machine objects.

        - GET: Return a list of all Machine objects
        - POST: create a MachineConfig
      tags:
      - machine
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MachineConfigCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MachineConfigCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MachineConfigCreate'
        required: true
      security:
      - tokenAuth: []
      - basicAuth: []
      - cookieAuth: []