latestOpenAPI 3.0.02026-08-102034118.0 KB

8f580eff2157

Loan dunning cases

Index dunning cases

Returns an array containing all the dunning cases for all of your customers.

get/v1/dunning_cases

Query parameters

page[number]integer

Specifies the number of pages of results to return.

page[size]integer

Specifies the size of each page of results.

filter[loan_account_id]string

Filters the returned dunning cases by a specific loan_account_id.

filter[person_id]string

Filters the returned dunning cases by a specific person ID.

filter[status]'new' | 'dunning' | 'pre_termination' | 'terminated' | 'closed'

Filters the returned dunning cases by a specific status.

Response

LoanEngine.V1.ListDunningCasesResponse

status'new' | 'dunning' | 'pre_termination' | 'terminated' | 'closed' | 'pre_collection' | 'closed_matured' required

The status of the dunning case.

person_idstring required

The person ID of the customer associated with the loan and dunning case.

loan_account_idstring required

The account ID to which the loan is attached.

idstring required

The ID of the dunning case.

Example response

[
  {
    "total_overdue_amount": {
      "value": 1000,
      "unit": "cents",
      "currency": "EUR"
    },
    "status": "dunning",
    "person_id": "547a870b2c8461a3104559369d09265dcper",
    "loan_account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc",
    "id": "de8d170b-321c-425b-830d-ed406cba6792"
  }
]