---
title: "Preview"
method: POST
path: "/v1/matters/{matter_id}/contributions/preview"
tags: ["contributions"]
---

# Preview

`POST /v1/matters/{matter_id}/contributions/preview`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/contributions/preview`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Request body

- CreatePlan
  - `total` string, decimal, nullable
  - `frequency` 'weekly' | 'fortnightly' | 'monthly' | 'quarterly', nullable
  - `instalments` integer, nullable
  - `months` integer, nullable
  - `first_due` string, date, nullable
  - `rows` DatedAmount[], nullable
    - `due_on` string, date, required
    - `amount` string, decimal, required
  - `appointment` 'sbr' | 'doca' | 'bankruptcy', nullable
  - `payer_id` string, uuid, nullable
  - `reference` string
  - `recipient_ids` string[]
  - `start` boolean

## Response `200`

Successful Response

- SchedulePreview
  - `rows` PreviewRow[], required
    - `due_on` string, date, required
    - `amount` string, decimal, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)