Kontentga o'tish
Dasturchilar uchun BILLZ

Qarzlar bo'yicha ma'lumot olish

GET
/v1/debt-stats
curl --request GET \
  --url 'https://api-admin.billz.ai/v1/debt-stats?min_amount=0&max_amount=0' \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

Xato kodlari: 400 — kiruvchi ma’lumotlar validatsiya xatosi; 401, 403, 429, 500 — barcha metodlar uchun umumiy. Tana formatlari va semantikasi: Javob kodlari va xatolar.

Authorizations

“Authorizations” bo'limi

Parameters

“Parameters” bo'limi

Query Parameters

“Query Parameters” bo'limi
customer_id
string format: uuid

Mijoz identifikatori

search
string

Qidiruv

status
string

fully_paid, unpaid, overdue, partial_paid

start_date
string

Davr boshi

end_date
string

Davr oxiri

min_amount
number format: double
0

Minimal summa

max_amount
number format: double
0

Maksimal summa

shop_ids
Array<string>

Do’konlar

repayment_date_start
string

So’ndirish sanasi davrining boshi

repayment_date_end
string

So’ndirish sanasi davrining oxiri

user_id
string
payment_type
string

To’lov turlari bo’yicha filtr

Header Parameters

“Header Parameters” bo'limi
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platforma identifikatori. Integratsiyalar uchun statik qiymat ishlatiladi.

Responses

“Responses” bo'limi

200

“200” bo'limi

Muvaffaqiyatli javob

Media typeapplication/json
object
total

Umumiy soni

number format: double
total_debt_amount

Umumiy qarz summasi

number format: double
total_unpaid_amount

To’lanmagan summa

number format: double
total_paid_amount

To’langan summa

number format: double
total_system_paid_amount

Tizimli to’lov

number format: double
number_of_debtors

Qarzdorlar soni

integer format: int32
number_of_paid_debtors

Qarzini so’ndirgan qarzdorlar

integer format: int32
number_of_overdue_debtors

Muddati o’tgan qarzdorlar

integer format: int32
number_of_debts

Qarzlar soni

integer format: int32
number_of_paid_debts

To’langan qarzlar

integer format: int32
number_of_unpaid_debts

To’lanmagan qarzlar

integer format: int32
number_of_overdue_debts

Muddati o’tgan qarzlar

integer format: int32
number_of_partially_paid_debts

Qisman to’langan qarzlar

integer format: int32
payment_type_stats

To’lov turlari bo’yicha taqsimot

Array<object>
nullable
object
payment_type_id
string
amount
string
name
string
Examplegenerated
{
  "total": 1,
  "total_debt_amount": 1,
  "total_unpaid_amount": 1,
  "total_paid_amount": 1,
  "total_system_paid_amount": 1,
  "number_of_debtors": 1,
  "number_of_paid_debtors": 1,
  "number_of_overdue_debtors": 1,
  "number_of_debts": 1,
  "number_of_paid_debts": 1,
  "number_of_unpaid_debts": 1,
  "number_of_overdue_debts": 1,
  "number_of_partially_paid_debts": 1,
  "payment_type_stats": [
    {
      "payment_type_id": "example",
      "amount": "example",
      "name": "example"
    }
  ]
}