Qarzlar ro'yxatini olish

GET

/v1/debt

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

• Production

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

• BearerAuth

Parameters

Query Parameters

page

integer format: int32

default: 1

Sahifa raqami; <= 1000

Example

1

limit

integer format: int32

default: 10

Sahifa hajmi; <= 1000

Example

5

search

string

Qidiruv; ko’pi bilan 100 belgi

status

string

fully_paid, unpaid, overdue, partial_paid; boshqa qiymat — 400

start_date

string

Davr boshi

end_date

string

Davr oxiri

customer_id

string format: uuid

Bo’sh bo’lmasa — yaroqli UUID bo’lishi kerak, aks holda 400

min_amount

number format: double

0

Minimal summa; maksimaldan katta bo’lishi mumkin emas

max_amount

number format: double

0

Maksimal summa

shop_ids

Array<string>

Do’konlar; ko’pi bilan 100 element

repayment_date_start

string

So’ndirish sanasi davrining boshi

repayment_date_end

string

So’ndirish sanasi davrining oxiri

user_id

string format: uuid

Yaroqli UUID bo’lishi kerak

last_update

string

UTC bo’yicha vaqt

with_transactions

string

true bo’lsa, har bir qarzga tranzaksiyalar qo’shib yuklanadi

session_id

string

Ishlatilmaydi

language

string

Ishlatilmaydi

company_payment_type_ids

Array<string>

Ishlatilmaydi

Header Parameters

platform-id

string

default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platforma identifikatori. Integratsiyalar uchun statik qiymat ishlatiladi.

Responses

200

Muvaffaqiyatli javob

Media typeapplication/json

object

count

Qarzlar soni

number format: double

data

Qarzlar ro’yxati

Array<object>

object

id

Qarz IDsi

string

order_id

Buyurtma IDsi

string

order_number

Buyurtma raqami

string

external_id

Qarzning tashqi identifikatori

string

amount

Qarz summasi

number format: double

comment

Izoh

string

repayment_date

To’lov sanasi

string

created_by

Yaratuvchi

object

id

string

name

string

first_name

string

last_name

string

created_at

Yaratilgan sana

string

deleted_at

O’chirilgan sana

string

status

Holat: fully_paid, unpaid, overdue, partial_paid

string

customer

Mijoz

object

id

string

name

string

first_name

string

last_name

string

paid_amount

To’langan summa

number format: double

shop

Do’kon

object

id

string

name

string

updated_at

Yangilanish sanasi

string

payments

To’lovlarning matnli tavsiflari

Array<string>

created_at_tz

Yaratilgan sana, TZ bilan

string

repayment_at_tz

So’ndirish sanasi, TZ bilan

string

contact_phones

Aloqa telefonlari

Array<string>

transactions

Faqat with_transactions=true bo’lganda to’ldiriladi. Maydonlar: id, external_id, debt_id, comment, shop, created_by, created_at, payments (id, amount, payment_type), amount, customer, source_type, source_id, cashbox_id

Array<string>

nullable

source_type

string

source_id

integer format: int32

source_item_id

integer

Example^generated

{
  "count": 1,
  "data": [
    {
      "id": "example",
      "order_id": "example",
      "order_number": "example",
      "external_id": "example",
      "amount": 1,
      "comment": "example",
      "repayment_date": "example",
      "created_by": {
        "id": "example",
        "name": "example",
        "first_name": "example",
        "last_name": "example"
      },
      "created_at": "example",
      "deleted_at": "example",
      "status": "example",
      "customer": {
        "id": "example",
        "name": "example",
        "first_name": "example",
        "last_name": "example"
      },
      "paid_amount": 1,
      "shop": {
        "id": "example",
        "name": "example"
      },
      "updated_at": "example",
      "payments": [
        "example"
      ],
      "created_at_tz": "example",
      "repayment_at_tz": "example",
      "contact_phones": [
        "example"
      ],
      "transactions": [
        "example"
      ],
      "source_type": "example",
      "source_id": 1,
      "source_item_id": 1
    }
  ]
}