Skip to content
BILLZ for developers

Get debt information

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'

Error codes: 400 — input validation error; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
customer_id
string format: uuid

Customer identifier

search
string

Search

status
string

fully_paid, unpaid, overdue, partial_paid

start_date
string

Start of period

end_date
string

End of period

min_amount
number format: double
0

Minimum amount

max_amount
number format: double
0

Maximum amount

shop_ids
Array<string>

Shops

repayment_date_start
string

Start of the repayment date period

repayment_date_end
string

End of the repayment date period

user_id
string
payment_type
string

Filter by payment types

Header Parameters

Section titled “Header Parameters”
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
total

Total count

number format: double
total_debt_amount

Total debt amount

number format: double
total_unpaid_amount

Unpaid amount

number format: double
total_paid_amount

Paid amount

number format: double
total_system_paid_amount

System payment

number format: double
number_of_debtors

Number of debtors

integer format: int32
number_of_paid_debtors

Debtors who repaid the debt

integer format: int32
number_of_overdue_debtors

Overdue debtors

integer format: int32
number_of_debts

Number of debts

integer format: int32
number_of_paid_debts

Repaid debts

integer format: int32
number_of_unpaid_debts

Unpaid debts

integer format: int32
number_of_overdue_debts

Overdue debts

integer format: int32
number_of_partially_paid_debts

Partially paid debts

integer format: int32
payment_type_stats

Breakdown by payment type

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"
    }
  ]
}