Перейти к содержимому

Получение списка долгов

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'

Коды ошибок: 400 — ошибка валидации входных данных; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.

page
integer format: int32
default: 1

Номер страницы; <= 1000

Example
1
limit
integer format: int32
default: 10

Размер страницы; <= 1000

Example
5
search
string

Поиск; не более 100 символов

status
string

fully_paid, unpaid, overdue, partial_paid; иное значение — 400

start_date
string

Начало периода

end_date
string

Конец периода

customer_id
string format: uuid

Если непустой — должен быть валидным UUID, иначе 400

min_amount
number format: double
0

Минимальная сумма; не может быть больше максимальной

max_amount
number format: double
0

Максимальная сумма

shop_ids
Array<string>

Магазины; не более 100 элементов

repayment_date_start
string

Начало периода даты погашения

repayment_date_end
string

Конец периода даты погашения

user_id
string format: uuid

Должен быть валидным UUID

last_update
string

Время в UTC

with_transactions
string

При true в каждый долг догружаются транзакции

session_id
string

Не используется

language
string

Не используется

company_payment_type_ids
Array<string>

Не используется

platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Успешный ответ

Media typeapplication/json
object
count

Количество долгов

number format: double
data

Список долгов

Array<object>
object
id

ID долга

string
order_id

ID заказа

string
order_number

Номер заказа

string
external_id

Внешний идентификатор долга

string
amount

Сумма долга

number format: double
comment

Комментарий

string
repayment_date

Дата погашения

string
created_by

Создатель

object
id
string
name
string
first_name
string
last_name
string
created_at

Дата создания

string
deleted_at

Дата удаления

string
status

Статус: fully_paid, unpaid, overdue, partial_paid

string
customer

Клиент

object
id
string
name
string
first_name
string
last_name
string
paid_amount

Оплаченная сумма

number format: double
shop

Магазин

object
id
string
name
string
updated_at

Дата обновления

string
payments

Текстовые описания платежей

Array<string>
created_at_tz

Дата создания с TZ

string
repayment_at_tz

Дата погашения с TZ

string
contact_phones

Контактные телефоны

Array<string>
transactions

Заполняется только при with_transactions=true. Поля: 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
Examplegenerated
{
"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
}
]
}