Перейти к основному содержанию
GET
/
v1
/
crm
/
metrics
/
penalties
cURL
curl --request GET \
  --url https://api.example.com/v1/crm/metrics/penalties/
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "request": 123,
      "request_status": 123,
      "payment_status": 123,
      "inventory_id": 123,
      "inventory_name": "<string>",
      "inventory_unique_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "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>"
      },
      "paid_amount": "<string>",
      "pending_amount": "<string>",
      "request_inventory": 123,
      "amount": "<string>",
      "reason": "<string>",
      "type": 0,
      "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>
created_by
integer
created_by__in
integer[]

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

end_at
string
обязательно
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.

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

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

request__rental_point
integer
request__rental_point__in
integer[]

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

A search term.

start_at
string
обязательно
type
enum<integer>
  • 0 - AUTO
  • 1 - MANUAL
Доступные опции:
0,
1
type__in
integer[]

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

Ответ

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"