---
title: "Illustrate a treatment plan"
method: POST
path: "/hardship/v1/accounts/{accountId}/treatment-plans/illustrate"
tags: ["Customer Distress Management"]
---

# Illustrate a treatment plan

`POST /hardship/v1/accounts/{accountId}/treatment-plans/illustrate`

## Request

- Base URL: `http://<host-url>`
- URL: `http://<host-url>/hardship/v1/accounts/{accountId}/treatment-plans/illustrate`
- Auth: HTTP bearer

Simulate a treatment plan without creating or executing it.

## Path parameters

- `accountId` integer, required

## Request body

- TreatmentPlanCreationDto
  - `actions` PaymentHolidayDto[], required
    - `type` string, required
    - `id` string, uuid
    - `number_of_statements` integer
    - `start_date` string, date
    - `end_date` string, date
    - `interest_treatment` 'ACCRUE' | 'FREEZE', required
    - `fee_treatment` 'ACCRUE' | 'WAIVE', required
    - `spending_status` 'NORMAL' | 'BLOCKED', required
  - `reasons` string[], required
  - `details` string, required

## Response `200`

Treatment plan illustration generated

- TreatmentPlanAggregateDto
  - `id` string, uuid
  - `account_id` integer
  - `reasons` string[]
  - `details` string
  - `start_date` string, date
  - `end_date` string, date
  - `state` 'DRAFT' | 'CANCELLED' | 'EXECUTED'
  - `status` 'ILLUSTRATION' | 'EXPIRED' | 'SCHEDULED' | 'CANCELLED' | 'ACTIVE' | 'COMPLETED'
  - `account_balance_at_save` number
  - `created_at` string, date-time
  - `created_by` string
  - `illustrated_at` string, date-time
  - `illustration_expires_at` string, date-time
  - `actions` TreatmentActionDto[]
    - `type` string, required
  - `directives` TreatmentDirectiveDto[]
    - `id` string, uuid
    - `action_id` string, uuid
    - `name` 'ARREARS' | 'SUSPEND_MIN_DUE' | 'NEXT_PAYMENT_DUE' | 'NEXT_PAYMENT_AMOUNT' | 'HOLIDAY_PERIOD' | 'SUSPEND_INTEREST_ACCRUAL' | 'SUSPEND_FEES' | 'BLOCK_SPEND' | 'INTEREST_ACCRUED'
    - `before` unknown
    - `value` unknown

## Other responses

- `400`: Invalid treatment plan request

---

[API](https://skmtc.dev/paymentology/apis/paycredit-api.md) - [All operations](https://skmtc.dev/paymentology/apis/paycredit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/paycredit-api/revisions/cc56df9c933b?raw)