[POST] .../v1/retailcustomer/getdebts
Returns customer debt information. Use this method to retrieve debt ledger records for a retail customer, for example when showing unpaid cheques or reconciling customer credit. The request requires customer_id and can filter by debt record ids, sale cheque uuids and is_debts to return outstanding or fully paid debts; the response result is an array of debt records with cheque uuid, code, date, amount, paid amount and last_update. The method checks the current request user and requires retail customer select permission; missing body, missing customer_id, denied permission, invalid filter values and storage errors are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| customer_id | int | Customer ID. |
| ids | int | Customer debt ID array. |
| is_debts | bool | Debt status: true - outstanding, false - paid. |
| uuids | string | UUID array of sale cheques with debts. |
Request Example
{
"filters": [
{
"Field": "customer_id",
"Operator": "Equal",
"Value": "string"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of RetailCustomerDebtRecord | Result array. |
Response Example
{
"ok": true,
"result": [
{
"amount": 1.0,
"code": "string",
"date": 1,
"id": 1,
"last_update": 1,
"payments_amount": 1.0,
"uuid": "00000000-0000-0000-0000-000000000000"
}
]
}