GetDebts

[POST] .../v1/retailcustomer/getdebts

Returns customer debt information. 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.

Request Parameters

Name Type Required Description
filters Array of Filter Required Filters by fields available for this API method. Required filter fields: customer_id.

Filterable Fields

Field Type Required Description
customer_id int Required Customer ID.
id int Optional Customer debt ID array.
is_debts bool Optional Debt status: true - outstanding, false - paid.
uuid string Optional 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"
    }
  ]
}