Перейти к основному содержанию
GET
/
v1
/
crm
/
metrics
/
discounts
/
history
cURL
curl --request GET \
  --url https://api.example.com/v1/crm/metrics/discounts/history/
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "request": {
        "id": 123,
        "rent_start": "2023-11-07T05:31:56Z",
        "rent_end": "2023-11-07T05:31:56Z",
        "status_color": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "status": 0,
        "rent_fact_start": "2023-11-07T05:31:56Z",
        "rent_fact_end": "2023-11-07T05:31:56Z",
        "price": "<string>",
        "discount_amount": "<string>",
        "price_discount": "<string>",
        "price_inventory": "<string>",
        "price_service": "<string>",
        "discount_inventory_amount": "<string>",
        "discount_service_amount": "<string>",
        "payment_status": 0,
        "paid_amount": "<string>",
        "time_exceed": true,
        "penalty_amount": "<string>",
        "rental_point": 123,
        "deleted": true,
        "plus_id": 0,
        "extra": "<unknown>"
      },
      "client": {
        "id": 123,
        "name": "<string>",
        "agreement_id": "<string>",
        "phone": "<string>",
        "type": 0,
        "avatar": "<string>",
        "signed": true,
        "sign_date": "2023-12-25",
        "sign_expires": "2023-12-25",
        "email": "jsmith@example.com",
        "legal_type": 0,
        "extra": "<unknown>"
      },
      "inventory": {
        "id": 123,
        "name": "<string>",
        "group": 123,
        "unique_id": "<string>",
        "category": 123,
        "image": "<string>",
        "extra": "<unknown>",
        "sublease_user": 123,
        "state": 123,
        "disabled": 0,
        "rental_point": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": 0,
      "discount_amount": "<string>",
      "start_at": "2023-12-25",
      "end_at": "2023-12-25",
      "scheduled": true,
      "scheduled_amount": "<string>",
      "destination": 0,
      "reason": "<string>",
      "tenant": 123,
      "request_inventory": 123,
      "request_service": 123,
      "discount": 123,
      "created_by": 123
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Параметры запроса

​
created_at__date__gte
string<date>
​
created_at__date__lte
string<date>
​
discount
integer
​
discount__discount_type
enum<integer>
  • 0 - Процент
  • 1 - Сумма
Доступные опции:
0,
1
​
discount__in
integer[]

Несколько значений могут быть разделены запятыми.

​
discount__type
enum<integer>
  • 0 - Скидка
  • 1 - Промокод
  • 2 - Сумма
Доступные опции:
0,
1,
2
​
ordering
string

Which field to use when ordering the results.

​
page
integer

A page number within the paginated result set.

​
pageSize
integer

Number of results to return per page.

​
request__client
integer
​
request__client__in
integer[]

Несколько значений могут быть разделены запятыми.

​
request__payment_status
enum<integer>
  • 0 - Ожидается оплата
  • 1 - Оплата произведена
  • 2 - Частичная оплата
Доступные опции:
0,
1,
2
​
request__payment_status__in
integer[]

Несколько значений могут быть разделены запятыми.

​
request__rent_end__date__gte
string<date>
​
request__rent_end__date__lte
string<date>
​
request__rent_start__date__gte
string<date>
​
request__rent_start__date__lte
string<date>
​
request__status
enum<integer>
  • 0 - Запрос
  • 1 - Забронировано
  • 2 - В аренде
  • 3 - Отменено
  • 4 - Завершено
  • 5 - Должник
Доступные опции:
0,
1,
2,
3,
4,
5
​
request__status__in
integer[]

Несколько значений могут быть разделены запятыми.

​
search
string

A search term.

​
type
enum<integer>
  • 0 - DISCOUNT
  • 1 - MANUAL
Доступные опции:
0,
1

Ответ

200 - application/json
​
count
integer
обязательно
Пример:

123

​
results
object[]
обязательно
​
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=2"