> ## 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 requests ## OpenAPI ````yaml /openapi/orders.json get /v1/crm/requests/ openapi: 3.0.3 info: title: Yume API — Аренда version: 1.0.0 description: Управление арендой, заявками и заказами. servers: - url: https://api.yume.cloud description: Production - url: https://api.stage.yume.cloud description: Stage security: [] paths: /v1/crm/requests/: get: summary: Get requests operationId: root_list parameters: - in: query name: autorenewal schema: type: boolean - in: query name: client schema: type: integer - in: query name: client__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: client__signed schema: type: boolean - in: query name: client__type schema: type: integer title: Тип enum: - 0 - 1 description: |- * `0` - Физ. лицо * `1` - Юр. лицо - in: query name: date schema: type: string format: date - in: query name: default_tarif_period schema: type: integer - in: query name: default_tarif_period__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: deleted schema: type: boolean - in: query name: end_at schema: type: string format: date description: >- Конец отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата. - in: query name: group schema: type: number - in: query name: has_delivery 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 - in: query name: inventory schema: type: number - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - 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: payment_status schema: type: integer title: Статус оплаты enum: - 0 - 1 - 2 description: |- * `0` - Ожидается оплата * `1` - Оплата произведена * `2` - Частичная оплата - in: query name: payment_status__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - in: query name: plus_id schema: type: integer - in: query name: rent_end_from schema: type: string format: date - in: query name: rent_end_to schema: type: string format: date - in: query name: rent_start_from schema: type: string format: date - in: query name: rent_start_to schema: type: string format: date - in: query name: rental_point schema: type: integer - name: search required: false in: query description: A search term. schema: type: string - in: query name: start_at schema: type: string format: date description: >- Начало отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата. - in: query name: status schema: type: integer title: Статус enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 description: |- * `0` - Запрос * `1` - Забронировано * `2` - В аренде * `3` - Отменено * `4` - Завершено * `5` - Должник * `6` - Просрочка - in: query name: status__in schema: type: array items: type: integer description: Несколько значений могут быть разделены запятыми. explode: false style: form - $ref: '#/components/parameters/TenantId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedOrderRequestList' description: '' security: - jwtAuth: [] components: parameters: TenantId: name: X-Tenant-Id in: header required: false schema: type: integer description: >- Компания, в контексте которой выполняется запрос — её id из `GET /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса. schemas: PaginatedOrderRequestList: 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/OrderRequest' OrderRequest: type: object properties: id: type: integer readOnly: true client: $ref: '#/components/schemas/BaseClient' status: allOf: - $ref: '#/components/schemas/Status3e1Enum' title: Статус minimum: 0 maximum: 32767 type: allOf: - $ref: '#/components/schemas/Type36fEnum' title: Тип аренды minimum: -32768 maximum: 32767 rent_start: type: string format: date-time title: Начало аренды rent_fact_start: type: string format: date-time nullable: true title: Факт выдачи rent_end: type: string format: date-time title: Конец аренды rent_fact_end: type: string format: date-time nullable: true title: Факт возврата price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ discount_amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ price_discount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ price_accrued: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ debt: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true price_inventory: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ price_service: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ discount_inventory_amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ title: Скидка на инвентарь discount_service_amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ payment_status: allOf: - $ref: '#/components/schemas/PaymentStatusEnum' title: Статус оплаты minimum: 0 maximum: 32767 paid_amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ penalty_amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ comments: type: array items: $ref: '#/components/schemas/CommentAttachment' readOnly: true rental_point: type: integer nullable: true title: Точка проката bonus_percent: type: integer readOnly: true bonus_amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true services: type: array items: $ref: '#/components/schemas/OrderRequestServiceShortInfo' readOnly: true inventories: type: array items: $ref: '#/components/schemas/OrderRequestInventoryShortInfo' readOnly: true created_at: type: string format: date-time readOnly: true title: Создан updated_at: type: string format: date-time readOnly: true title: Обновлен actions: type: array items: $ref: '#/components/schemas/OrderRequestAction' readOnly: true deposits: type: array items: $ref: '#/components/schemas/OrderRequestDeposit' readOnly: true deliveries: type: array items: $ref: '#/components/schemas/BaseDelivery' readOnly: true deleted: type: boolean title: Удалено plus_id: type: integer maximum: 9223372036854776000 minimum: -9223372036854776000 format: int64 nullable: true title: Идентификатор Plus extra: {} referrals: type: array items: $ref: '#/components/schemas/OrderRequestReferral' leads: type: array items: type: integer readOnly: true autorenewal: type: boolean title: Автопродление deposit_total: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true deposit_held: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true deposit_due: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ readOnly: true required: - actions - bonus_amount - bonus_percent - client - comments - created_at - debt - deliveries - deposit_due - deposit_held - deposit_total - deposits - id - inventories - leads - referrals - rent_end - rent_start - services - updated_at BaseClient: type: object properties: id: type: integer readOnly: true name: type: string title: Название maxLength: 512 type: allOf: - $ref: '#/components/schemas/BaseClientTypeEnum' 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 Status3e1Enum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 type: integer description: |- * `0` - Запрос * `1` - Забронировано * `2` - В аренде * `3` - Отменено * `4` - Завершено * `5` - Должник * `6` - Просрочка Type36fEnum: enum: - 0 - 1 type: integer description: |- * `0` - За период * `1` - Посуточно PaymentStatusEnum: enum: - 0 - 1 - 2 type: integer description: |- * `0` - Ожидается оплата * `1` - Оплата произведена * `2` - Частичная оплата CommentAttachment: type: object properties: id: type: integer readOnly: true body: type: string user: type: integer readOnly: true nullable: true context: nullable: true content_type: type: string title: Имя класса модели object_id: type: integer maximum: 9223372036854776000 minimum: 0 format: int64 links: type: array items: $ref: '#/components/schemas/CommentLink' readOnly: true created_at: type: string format: date-time readOnly: true title: Создан updated_at: type: string format: date-time readOnly: true title: Обновлен required: - body - content_type - created_at - id - links - object_id - updated_at - user OrderRequestServiceShortInfo: type: object properties: id: type: integer readOnly: true service: type: string readOnly: true worker: type: integer nullable: true title: Исполнитель required: - id - service OrderRequestInventoryShortInfo: type: object properties: id: type: integer readOnly: true inventory: type: integer nullable: true title: Инвентарь inventory_group: type: integer nullable: true title: Группа инвентаря tarif: type: integer nullable: true title: Тариф tarif_price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ title: Цена тарифа tarif_duration: type: string title: Длительность тарифа inventory_name: type: string readOnly: true inventory_unique_id: type: string readOnly: true inventory_car_number: type: string readOnly: true inventory_car_tech_passport: type: string readOnly: true image: type: string format: uri readOnly: true started: type: boolean readOnly: true returned: type: boolean readOnly: true required: - id - image - inventory_car_number - inventory_car_tech_passport - inventory_name - inventory_unique_id - returned - started OrderRequestAction: type: object properties: id: type: integer readOnly: true user: type: integer created_at: type: string format: date-time readOnly: true title: Создан type: allOf: - $ref: '#/components/schemas/TypeFb2Enum' minimum: -32768 maximum: 32767 inventories: type: array items: type: integer readOnly: true required: - created_at - id - inventories - type - user 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 BaseDelivery: type: object properties: id: type: integer readOnly: true request: type: integer title: Аренда delivery_place: $ref: '#/components/schemas/Geolocation' issue_place: $ref: '#/components/schemas/Geolocation' worker: type: integer title: Исполнитель cancel_comment: type: string nullable: true title: Причина отмены delivered_at: type: string format: date-time nullable: true title: Доставлено issued_at: type: string format: date-time nullable: true title: Выдано pickup_date: type: string format: date-time nullable: true title: Дата забора type: allOf: - $ref: '#/components/schemas/TypeCc7Enum' title: Тип minimum: -32768 maximum: 32767 status: allOf: - $ref: '#/components/schemas/StatusF7aEnum' title: Статус minimum: -32768 maximum: 32767 comment: type: string nullable: true title: Комментарий price: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ price_discount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ extra: title: Доп. данные issue: type: integer nullable: true title: Связанная доставка phone: type: string nullable: true title: Телефон maxLength: 32 phone_alternative: type: string nullable: true title: Доп. телефон maxLength: 32 required: - delivery_place - id - issue_place - request - worker OrderRequestReferral: type: object properties: id: type: integer readOnly: true created_at: type: string format: date-time readOnly: true title: Создан request: type: integer readOnly: true title: Аренда agent: type: integer nullable: true title: Агент amount: type: string format: decimal pattern: ^-?\d{0,14}(?:\.\d{0,2})?$ title: Сумма status: allOf: - $ref: '#/components/schemas/OrderRequestReferralStatusEnum' readOnly: true title: Статус status_changed_at: type: string format: date-time readOnly: true nullable: true title: Статус изменён request_status: type: integer readOnly: true required: - created_at - id - request - request_status - status - status_changed_at BaseClientTypeEnum: enum: - 0 - 1 type: integer description: |- * `0` - Физ. лицо * `1` - Юр. лицо LegalTypeEnum: enum: - 0 - 1 - 2 - 3 type: integer description: |- * `0` - ИП * `1` - ТОО * `2` - АО * `3` - ПК NullEnum: enum: - null CommentLink: type: object properties: content_type: type: string title: Имя класса модели readOnly: true content_type_label: type: string readOnly: true object_id: type: integer maximum: 9223372036854776000 minimum: 0 format: int64 title: ID объекта label: type: string readOnly: true url: type: string readOnly: true required: - content_type - content_type_label - label - object_id - url TypeFb2Enum: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 type: integer description: |- * `0` - Бронь * `1` - Выдача * `2` - Приём * `3` - Отмена * `4` - Архив * `5` - Сборка * `6` - Создание * `7` - Забор доставки * `8` - Выдача доставки OrderRequestDepositTypeEnum: enum: - 0 - 1 type: integer description: |- * `0` - Предмет * `1` - Сумма OrderRequestDepositStatusEnum: enum: - 0 - 1 - 2 type: integer description: |- * `0` - Ожидает внесения * `1` - Принято * `2` - Возвращён Geolocation: type: object properties: latitude: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,9})?$ longitude: type: string format: decimal pattern: ^-?\d{0,3}(?:\.\d{0,9})?$ name: type: string nullable: true maxLength: 255 TypeCc7Enum: enum: - 0 - 1 type: integer description: |- * `0` - Доставка * `1` - Самовывоз StatusF7aEnum: enum: - 0 - 1 - 2 - 3 type: integer description: |- * `0` - Ожидает * `1` - В работе * `2` - Доставлено * `3` - Отменено OrderRequestReferralStatusEnum: enum: - 0 - 1 type: integer description: |- * `0` - Выплачено * `1` - Ожидает securitySchemes: jwtAuth: type: http scheme: bearer bearerFormat: JWT ````