GetDebtsPaymentHistory

[POST] .../v1/retailcustomer/getdebtspaymenthistory

Returns customer debt payment history. Retrieve payment history for retail customer debt records when auditing how a debt was repaid. The request requires customer_id and can filter by payment ids; the response result is an array of debt payment records with debt cheque uuid, payment cheque uuid, amount, date 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.

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 RetailCustomerDebtPayment Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "amount": 1.0,
      "date": 1,
      "debt_uuid": "00000000-0000-0000-0000-000000000000",
      "id": 1,
      "last_update": 1,
      "payment_uuid": "00000000-0000-0000-0000-000000000000"
    }
  ]
}