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

# Get schedules



## OpenAPI

````yaml /openapi/main.json get /v1/crm/inventories/schedules/
openapi: 3.0.3
info:
  title: Yume API — Основное
  version: 1.0.0
  description: Базовые сущности и бизнес-логика CRM.
servers:
  - url: https://api.yume.cloud
    description: Production
  - url: https://api.stage.yume.cloud
    description: Stage
security: []
paths:
  /v1/crm/inventories/schedules/:
    get:
      tags:
        - inventories
      summary: Get schedules
      operationId: inventories_schedules_list
      parameters:
        - in: query
          name: car__isnull
          schema:
            type: boolean
        - in: query
          name: category
          schema:
            type: integer
        - in: query
          name: category__in
          schema:
            type: array
            items:
              type: integer
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: disable__isnull
          schema:
            type: boolean
        - in: query
          name: disable__method
          schema:
            type: integer
            title: Способ
            enum:
              - 0
              - 1
              - 2
          description: |-
            * `0` - удалить
            * `1` - Архив
            * `2` - Списано
        - in: query
          name: disabled
          schema:
            type: boolean
        - in: query
          name: end_at
          schema:
            type: string
            format: date-time
          description: Конец окна. Момент времени или дата, от которой берётся полночь.
          required: true
        - in: query
          name: exclude_ids
          schema:
            type: array
            items:
              type: integer
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: filter_key
          schema:
            type: string
        - in: query
          name: fleet_status
          schema:
            type: string
        - in: query
          name: free
          schema:
            type: boolean
        - in: query
          name: group
          schema:
            type: integer
        - in: query
          name: group__in
          schema:
            type: array
            items:
              type: integer
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: has_sublease
          schema:
            type: boolean
        - in: query
          name: id
          schema:
            type: integer
        - in: query
          name: id__in
          schema:
            type: array
            items:
              type: integer
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - name: page
          required: false
          in: query
          description: A page number within the paginated result set.
          schema:
            type: integer
        - name: pageSize
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
        - in: query
          name: rental_point
          schema:
            type: integer
        - in: query
          name: rental_point__in
          schema:
            type: array
            items:
              type: integer
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: request
          schema:
            type: number
        - in: query
          name: saleable
          schema:
            type: boolean
        - name: search
          required: false
          in: query
          description: A search term.
          schema:
            type: string
        - in: query
          name: start_at
          schema:
            type: string
            format: date-time
          description: Начало окна. Момент времени или дата, от которой берётся полночь.
          required: true
        - in: query
          name: state
          schema:
            type: integer
        - in: query
          name: state__in
          schema:
            type: array
            items:
              type: integer
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: status
          schema:
            type: number
        - in: query
          name: sublease_user
          schema:
            type: number
        - in: query
          name: sublease_user__in
          schema:
            type: array
            items:
              type: number
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - in: query
          name: sublease_user__isnull
          schema:
            type: boolean
        - in: query
          name: type
          schema:
            type: number
        - in: query
          name: unique_id
          schema:
            type: string
        - in: query
          name: unique_id__in
          schema:
            type: array
            items:
              type: string
          description: Несколько значений могут быть разделены запятыми.
          explode: false
          style: form
        - $ref: '#/components/parameters/TenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInventoryScheduleList'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    PaginatedInventoryScheduleList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/InventorySchedule'
    InventorySchedule:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        car:
          allOf:
            - $ref: '#/components/schemas/InventoryCar'
          readOnly: true
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/Schedule'
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Обновлен
        name:
          type: string
          title: Название
          maxLength: 255
        unique_id:
          type: string
          nullable: true
          title: Артикул
          maxLength: 255
        device_unique_id:
          type: string
          nullable: true
          title: Идентификатор устройства
          maxLength: 255
        type:
          allOf:
            - $ref: '#/components/schemas/Type9ddEnum'
          title: Тип
          minimum: 0
          maximum: 32767
        buy_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          nullable: true
          title: Цена покупки
        buy_date:
          type: string
          format: date
          nullable: true
          title: Дата покупки
        sell_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          nullable: true
          title: Цена продажи
        sell_date:
          type: string
          format: date-time
          nullable: true
          title: Дата продажи
        lifetime:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
          title: Срок службы, дней
        stock_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          nullable: true
          title: Складская цена
        comment:
          type: string
          nullable: true
          title: Комментарий
          maxLength: 1024
        image:
          type: string
          format: uri
          nullable: true
          title: Изображение
        prev_earning:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          title: Заработано ранее
        extra:
          title: Доп. данные
        tenant:
          type: integer
        category:
          type: integer
          nullable: true
          title: Категория
        group:
          type: integer
          nullable: true
          title: Группа инвентаря
        rental_point:
          type: integer
          nullable: true
          title: Точка проката
        state:
          type: integer
          nullable: true
          title: Состояние
      required:
        - car
        - created_at
        - id
        - name
        - schedules
        - updated_at
    InventoryCar:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          $ref: '#/components/schemas/Type839Enum'
        brand:
          type: string
          nullable: true
          maxLength: 255
        model:
          type: string
          nullable: true
          maxLength: 255
        number:
          type: string
          nullable: true
          maxLength: 255
        tech_passport:
          type: string
          nullable: true
          maxLength: 255
        serial:
          type: string
          nullable: true
          maxLength: 255
        vin:
          type: string
          nullable: true
          maxLength: 18
        extra: {}
      required:
        - id
    Schedule:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        inventory:
          type: integer
          nullable: true
          title: Инвентарь
        request_id:
          type: integer
        request_status:
          allOf:
            - $ref: '#/components/schemas/RequestStatusEnum'
          readOnly: true
        request_autorenewal:
          type: boolean
          readOnly: true
        client:
          allOf:
            - $ref: '#/components/schemas/BaseClient'
          readOnly: true
        start_at:
          type: string
          format: date-time
          nullable: true
          title: Начало периода
        end_at:
          type: string
          format: date-time
          nullable: true
          title: Конец периода
        fact_start_at:
          type: string
          format: date-time
          nullable: true
          title: Факт выдачи
        fact_end_at:
          type: string
          format: date-time
          nullable: true
          title: Факт возврата
        rent_start:
          type: string
          format: date-time
        rent_fact_start:
          type: string
          format: date-time
        rent_end:
          type: string
          format: date-time
        rent_fact_end:
          type: string
          format: date-time
        rent_price:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        rent_price_discount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        rent_price_inventory:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        rent_price_service:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        rent_price_paid_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        deposits:
          type: array
          items:
            $ref: '#/components/schemas/OrderRequestDeposit'
          readOnly: true
      required:
        - client
        - deposits
        - id
        - rent_end
        - rent_fact_end
        - rent_fact_start
        - rent_start
        - request_autorenewal
        - request_id
        - request_status
    Type9ddEnum:
      enum:
        - 0
        - 1
      type: integer
      description: |-
        * `0` - Аренда
        * `1` - Продажа
    Type839Enum:
      enum:
        - CAR
        - SCOOTER
        - MOTORCYCLE
      type: string
      description: |-
        * `CAR` - Автомобиль
        * `SCOOTER` - Электросамокат
        * `MOTORCYCLE` - Мотоцикл/Мопед
    RequestStatusEnum:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
      type: integer
      description: |-
        * `0` - Запрос
        * `1` - Забронировано
        * `2` - В аренде
        * `3` - Отменено
        * `4` - Завершено
        * `5` - Должник
        * `6` - Просрочка
    BaseClient:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          title: Название
          maxLength: 512
        type:
          allOf:
            - $ref: '#/components/schemas/Type433Enum'
          title: Тип
          minimum: 0
          maximum: 2147483647
        avatar:
          type: string
          format: uri
          nullable: true
          title: Фото
        agreement_id:
          type: string
          readOnly: true
          nullable: true
        signed:
          type: boolean
        sign_date:
          type: string
          format: date
          nullable: true
        sign_expires:
          type: string
          format: date
          nullable: true
        phone:
          type: string
          title: Телефон
          maxLength: 32
        email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        legal_type:
          nullable: true
          title: Форма организации
          minimum: 0
          maximum: 2147483647
          oneOf:
            - $ref: '#/components/schemas/LegalTypeEnum'
            - $ref: '#/components/schemas/NullEnum'
        extra:
          title: Доп. данные
      required:
        - agreement_id
        - id
        - name
        - phone
    OrderRequestDeposit:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_by:
          type: integer
          readOnly: true
          title: Создал
        payment_type:
          type: integer
          nullable: true
          title: Способ оплаты
        type:
          allOf:
            - $ref: '#/components/schemas/OrderRequestDepositTypeEnum'
          title: Тип
          minimum: -32768
          maximum: 32767
        status:
          allOf:
            - $ref: '#/components/schemas/OrderRequestDepositStatusEnum'
          title: Статус
          minimum: -32768
          maximum: 32767
        request:
          type: integer
          readOnly: true
          title: Аренда
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Создан
        deposit:
          type: string
          title: Залоговый предмет
          maxLength: 255
        amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          title: Сумма
        returned_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          title: Возвращён
        transaction_amount:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
          readOnly: true
        deposit_finance:
          type: boolean
          title: Залог как деньги на хранении
        amount_in:
          type: number
          format: double
          readOnly: true
        amount_out:
          type: number
          format: double
          readOnly: true
        amount_charged:
          type: number
          format: double
          readOnly: true
        amount_returned:
          type: number
          format: double
          readOnly: true
        amount_held:
          type: number
          format: double
          readOnly: true
        remaining:
          type: number
          format: double
          readOnly: true
        with_transaction:
          type: boolean
          writeOnly: true
          default: false
      required:
        - amount_charged
        - amount_held
        - amount_in
        - amount_out
        - amount_returned
        - created_at
        - created_by
        - deposit
        - id
        - remaining
        - request
        - returned_at
        - transaction_amount
        - type
    Type433Enum:
      enum:
        - 0
        - 1
      type: integer
      description: |-
        * `0` - Физ. лицо
        * `1` - Юр. лицо
    LegalTypeEnum:
      enum:
        - 0
        - 1
        - 2
        - 3
      type: integer
      description: |-
        * `0` - ИП
        * `1` - ТОО
        * `2` - АО
        * `3` - ПК
    NullEnum:
      enum:
        - null
    OrderRequestDepositTypeEnum:
      enum:
        - 0
        - 1
      type: integer
      description: |-
        * `0` - Предмет
        * `1` - Сумма
    OrderRequestDepositStatusEnum:
      enum:
        - 0
        - 1
        - 2
      type: integer
      description: |-
        * `0` - Ожидает внесения
        * `1` - Принято
        * `2` - Возвращён
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````