# dues

> Scheduled dues.

Scheduled dues.

| Method | Path | Operation | Scope | Test mode |
|---|---|---|---|---|
| GET | `/v1/due-schedules` | `due_schedules_list`: Due schedules | `orders:read` | - |
| POST | `/v1/due-schedules` | `due_schedules_create`: Create a due schedule and its instalments | `orders:write` | - |
| GET | `/v1/due-schedules/{schedule_id}` | `due_schedules_get`: One due schedule | `orders:read` | - |
| PATCH | `/v1/due-schedules/{schedule_id}` | `due_schedules_update`: Change a fee plan | `orders:write` | - |
| POST | `/v1/due-schedules/{schedule_id}/cancel` | `due_schedules_cancel`: Cancel a schedule and its unpaid dues | `orders:write` | - |
| GET | `/v1/dues` | `dues_list`: Dues | `orders:read` | - |
| POST | `/v1/dues` | `dues_create`: Create a one-off due | `orders:write` | - |
| POST | `/v1/dues:bulk-remind` | `dues_bulk_remind`: Send a reminder for many dues at once | `messages:send` | - |
| GET | `/v1/dues/{due_id}` | `dues_get`: One due | `orders:read` | - |
| POST | `/v1/dues/{due_id}/adjust` | `dues_adjust`: Adjust the amount, date or description of a due | `orders:write` | - |
| POST | `/v1/dues/{due_id}/cancel` | `dues_cancel`: Cancel a due | `orders:write` | - |
| POST | `/v1/dues/{due_id}/payment-link` | `dues_payment_link`: Payment link for a due (part payment allowed) | `orders:write` | - |
| GET | `/v1/dues/{due_id}/payments` | `dues_payments_list`: What has been received against a due | `orders:read` | - |
| POST | `/v1/dues/{due_id}/payments` | `dues_payments_record`: Mark a due as received (cash, bank transfer, cheque, UPI to a personal account) | `payments:write` | - |
| POST | `/v1/dues/{due_id}/payments/{payment_id}/reverse` | `dues_payments_reverse`: Reverse a payment marked by staff | `payments:write` | - |
| POST | `/v1/dues/{due_id}/remind` | `dues_remind`: Send a reminder now | `messages:send` | - |
| GET | `/v1/dues/{due_id}/reminders` | `dues_reminders_list`: The reminder ladder of a due | `orders:read` | - |
| POST | `/v1/dues/{due_id}/waive` | `dues_waive`: Waive all or part of a due | `orders:write` | - |
| GET | `/v1/dues/defaulters` | `dues_defaulters`: Defaulter list | `orders:read` | - |
| GET | `/v1/dues/defaulters/export` | `dues_defaulters_export`: Export the defaulter list as CSV | `orders:read` | - |
| GET | `/v1/dues/summary` | `dues_summary`: Money owed, per currency | `orders:read` | - |
| GET | `/v1/payments/received` | `payments_received_list`: Everything received: gateway payments and payments marked by staff | `payments:read` | - |
| GET | `/v1/payments/received/summary` | `payments_received_summary`: Money received by kind and method | `payments:read` | - |

Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`.
