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

# Create

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

## 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`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Headers

- `Idempotency-Key` string, 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

- PlanView
  - `activity` union[], required
    - union
      - ReceiptActivity
        - `id` string, uuid, required
        - `amount` string, decimal, required
        - `received_on` string, date, required
        - `reference` string, required
        - `reversed` boolean, required
        - `unallocated` string, decimal, required
        - `kind` 'receipt', required
        - `created_at` string, date-time, required
      - HistoryActivity
        - `id` string, uuid, required
        - `created_at` string, date-time, required
        - `action` string, required
        - `reason` string, required
        - `actor_name` string, required
        - `kind` 'history', required
  - `activity_page` integer, required
  - `activity_pages` integer, required
  - `activity_total` integer, required
  - `id` string, uuid, required
  - `state` 'draft' | 'active' | 'finalised', required
  - `reference` string, required
  - `created_at` string, date-time, required
  - `version` integer, required
  - `appointment` 'sbr' | 'doca' | 'bankruptcy', required
  - `payer_id` string, uuid, nullable, required
  - `paused` boolean, required
  - `outcome` string, nullable, required
  - `total` string, decimal, required
  - `received` string, decimal, required
  - `remaining` string, decimal, required
  - `overdue` string, decimal, required
  - `cancelled` string, decimal, required
  - `credit` string, decimal, required
  - `rows` Instalment[], required
    - `id` string, uuid, required
    - `due_on` string, date, required
    - `amount` string, decimal, required
    - `received` string, decimal, required
    - `remaining` string, decimal, required
    - `cancelled` string, decimal, required
    - `missed` boolean, required
    - `status` 'upcoming' | 'due' | 'part_paid' | 'paid' | 'overdue' | 'cancelled', required
    - `overdue` boolean, required
  - `subscribers` Subscriber[], required
    - `id` string, uuid, required
    - `name` string, required
  - `subscribed` boolean, required
  - `email_enabled` boolean, required
  - `reminder_days` integer[], required
  - `reminder_failures` integer, required
  - `delivery_reviews` DeliveryReview[], required
    - `id` string, uuid, required
    - `state` 'failed' | 'uncertain' | 'bounced' | 'complained', required
    - `subscriber_name` string, required
    - `recipient_email` string, nullable, required
    - `due_on` string, date, required
    - `attempted_at` string, date-time, nullable, required
    - `attempts` integer, required
  - `timezone` string, required
  - `today` string, date, required
  - `can_edit` boolean, 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/a5849ac366ca?raw)