> ## 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 amount



## OpenAPI

````yaml /openapi/orders.json get /v1/crm/requests/amount/
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/amount/:
    get:
      tags:
        - amount
      summary: Get amount
      operationId: amount_retrieve
      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
        - 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/OrderRequestAmount'
          description: ''
      security:
        - jwtAuth: []
components:
  parameters:
    TenantId:
      name: X-Tenant-Id
      in: header
      required: false
      schema:
        type: integer
      description: >-
        Компания, в контексте которой выполняется запрос — её id из `GET
        /v1/tenant/`. Пользователь должен состоять в этой компании: чужой id
        доступа к данным не даёт. Без заголовка компания определяется по домену
        запроса.
  schemas:
    OrderRequestAmount:
      type: object
      properties:
        price_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        price_discount_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        tax_amount_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        paid_amount_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        debt_amount_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        deposit_total_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        deposit_held_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
        deposit_due_sum:
          type: string
          format: decimal
          pattern: ^-?\d{0,14}(?:\.\d{0,2})?$
      required:
        - debt_amount_sum
        - deposit_due_sum
        - deposit_held_sum
        - deposit_total_sum
        - paid_amount_sum
        - price_discount_sum
        - price_sum
        - tax_amount_sum
  securitySchemes:
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````