---
title: "Dividend Run Action"
method: POST
path: "/v1/matters/{matter_id}/cash-book/dividends/{run_id}/actions"
tags: ["cash-book"]
---

# Dividend Run Action

`POST /v1/matters/{matter_id}/cash-book/dividends/{run_id}/actions`

## 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}/cash-book/dividends/{run_id}/actions`
- Auth: HTTP bearer

## Path parameters

- `run_id` string, uuid, required
- `matter_id` string, uuid, required

## Headers

- `Idempotency-Key` string, required

## Request body

- DividendCommand
  - `version` integer, required
  - `action` 'save' | 'submit' | 'withdraw' | 'return' | 'finalise', required
  - `settings` DividendSettingsInput
    - `excluded` object
    - `lenders` object
    - `splits` object
    - `overrides` object
    - `payment_matches` object
    - `secured_debt` object
    - `security_reviews` object
    - `excluded_accounts` object
    - `employees` object
    - `feg` object
    - `duplicates` object
    - `caps` object
    - `reserve` string, decimal
    - `reserve_reason` string
    - `confirmations` ConfirmationsInput: Facts about this distribution no other feature records. Unanswered means not confirmed.
      - `court_orders` boolean, nullable
      - `relevant_date` string, date, nullable
      - `note` string
    - `trust_clearance` TrustClearance: The practitioner's clearance that the proceeds are not trust property of the trust the company acted for, or may be distributed regardless.
      - `note` string, required
    - `member_surplus_review` MemberSurplusReview: The practitioner's review before a members' voluntary liquidation pays its surplus to members (s 501): members' rights under the constitution and share classes, and that statutory interest and subordinated claims were considered.
      - `note` string, required
    - `known_unreported_pre_appointment_gst` boolean, nullable
    - `commissioner_notified_on` string, date, nullable
    - `ato_cleared_on` string, date, nullable
    - `recorded` object
  - `source_hash` string, required
  - `reason` string

## Response `200`

Successful Response

- DividendDetail
  - `id` string, uuid, required
  - `distribution_date` string, date, required
  - `status` 'draft' | 'review' | 'finalised', required
  - `version` integer, required
  - `settings` DividendSettingsOutput, required
    - `excluded` object, required
    - `lenders` object, required
    - `splits` object, required
    - `overrides` object, required
    - `payment_matches` object, required
    - `secured_debt` object, required
    - `security_reviews` object, required
    - `excluded_accounts` object, required
    - `employees` object, required
    - `feg` object, required
    - `duplicates` object, required
    - `caps` object, required
    - `reserve` string, decimal, required
    - `reserve_reason` string, required
    - `confirmations` ConfirmationsOutput, required: Facts about this distribution no other feature records. Unanswered means not confirmed.
      - `court_orders` boolean, nullable, required
      - `relevant_date` string, date, nullable, required
      - `note` string, required
    - `trust_clearance` TrustClearance, required: The practitioner's clearance that the proceeds are not trust property of the trust the company acted for, or may be distributed regardless.
      - `note` string, required
    - `member_surplus_review` MemberSurplusReview, required: The practitioner's review before a members' voluntary liquidation pays its surplus to members (s 501): members' rights under the constitution and share classes, and that statutory interest and subordinated claims were considered.
      - `note` string, required
    - `known_unreported_pre_appointment_gst` boolean, nullable, required
    - `commissioner_notified_on` string, date, nullable, required
    - `ato_cleared_on` string, date, nullable, required
    - `recorded` object, required
  - `actors` object, required
  - `source_hash` string, required
  - `review_stale` boolean, required
  - `can_prepare` boolean, required
  - `can_review` boolean, required
  - `can_withdraw` boolean, required
  - `snapshot` DividendSnapshot, required: Funds, claims, waterfall and checks at the distribution date.
    - `dates` DividendSnapshotDates, required
      - `relevant` string, date, nullable, required
      - `relevant_basis` 'appointment' | 'administration' | 'application', nullable, required
      - `declaration` string, date, required
      - `distribution` string, date, required
      - `cash_snapshot` string, date, required
    - `receipts` DividendReceipt[], required
      - `id` string, uuid, required
      - `transaction_id` string, uuid, required
      - `bank_id` string, uuid, required
      - `date` string, date, required
      - `description` string, required
      - `category` string, required
      - `pool` string, required
      - `review` boolean, required
      - `lender_id` string, uuid, nullable, required
      - `no_lender` boolean, required
      - `gross` string, decimal, required
      - `gst` string, decimal, required
      - `gst_class` 'gst' | 'gst_free' | 'not_applicable', required
      - `gst_treatment` string, required
      - `tax_code` string, nullable, required
      - `net` string, decimal, required
      - `amount` string, decimal, required
      - `override` Override, required: An included amount that differs from the cash book, with the reason kept.
        - `amount` string, decimal, required
        - `reason` string, required
      - `exclusion` ExclusionOutput, required: Why a receipt stays out of the pool. Free-form deselection is not allowed.
        - `reason` 'not_company_property' | 'restricted_or_trust' | 'reserve' | 'disputed_ownership' | 'other', required
        - `note` string, required
      - `split` PoolSplitOutput, required: How a mixed receipt divides between the pools, with the reason kept.
        - `free` string, decimal, required
        - `circulating` string, decimal, required
        - `non_circulating` string, decimal, required
        - `reason` string, required
      - `included` boolean, required
      - `pools` object, required
      - `recovery` boolean, required
    - `payments` DividendFundsPayment[], required
      - `id` string, uuid, required
      - `transaction_id` string, uuid, required
      - `bank_id` string, uuid, required
      - `date` string, date, required
      - `description` string, required
      - `category` string, required
      - `gross` string, decimal, required
      - `gst_class` 'gst' | 'gst_free' | 'not_applicable', required
      - `pool` string, required
      - `distribution` boolean, required
      - `matched_run` string, uuid, nullable, required
      - `run_number` integer, nullable, required
      - `linked` boolean, required
      - `gst` string, decimal, required
      - `amount` string, decimal, required
      - `reserved` string, decimal, required
    - `claims` DividendClaim[], required
      - `id` string, uuid, required
      - `name` string, required
      - `kind` string, required
      - `type` string, required
      - `status` string, required
      - `participating` boolean, required
      - `claimed` string, decimal, required
      - `admitted` string, decimal, required
      - `previous` string, decimal, required
      - `previous_runs` DividendEarlierRun[], required
        - `id` string, uuid, required
        - `date` string, date, required
        - `amount` string, decimal, required
      - `admissions` DividendAdmission[], required
        - `claim_id` string, uuid, required
        - `revision_id` string, uuid, required
        - `date` string, date, required
        - `status` string, required
        - `claimed` string, decimal, required
        - `admitted` string, decimal, required
      - `previous_unsecured` string, decimal, required
      - `overpayment` string, decimal, required
      - `overpayment_priority` string, decimal, required
      - `recoverable` string, decimal, required
      - `recovery_class` 'priority' | 'unsecured', required
      - `recovered` string, decimal, required
      - `priority` string, decimal, required
      - `priority_split` DividendPrioritySplit, required
        - `wages` string, decimal, required
        - `leave` string, decimal, required
        - `retrenchment` string, decimal, required
      - `split_source` 'employees' | 'entered', nullable, required
      - `excluded_status` 'excluded' | 'not_excluded' | 'unknown', nullable, required
      - `substituted` string, decimal, required
      - `unsecured` string, decimal, required
      - `wages` string, decimal, required
      - `leave` string, decimal, required
      - `retrenchment` string, decimal, required
      - `secured_debt` string, decimal, required
      - `secured_debt_entered` boolean, required
      - `suggested` DividendPrioritySplit, required
        - `wages` string, decimal, required
        - `leave` string, decimal, required
        - `retrenchment` string, decimal, required
      - `feg_candidate` boolean, required
      - `duplicate` string, nullable, required
      - `duplicate_of` string[], required
      - `resolution` DuplicateResolutionOutput, required: How a flagged claim was resolved for this distribution.
        - `decision` 'exclude' | 'separate', required
        - `reason` string, required
        - `partners` string[], required
      - `current` string, decimal, required
      - `catch_up` string, decimal, required
      - `dividend` string, decimal, required
      - `secured_paid` string, decimal, required
      - `priority_paid` string, decimal, required
      - `total_paid` string, decimal, required
    - `pools` object, required
    - `employee_free` DividendEmployeeFree, required: Free property genuinely available to employees before circulating.
      - `free` string, decimal, required
      - `reserve` string, decimal, required
      - `costs` string, decimal, required
      - `available` string, decimal, required
      - `circulating` string, decimal, required
    - `restricted` string, decimal, required
    - `funds` DividendFunds, required
      - `rows` DividendFundsRow[], required
        - `key` string, required
        - `lender_id` string, uuid, nullable, required
        - `gross` string, decimal, required
        - `reserve` string, decimal, required
        - `available` string, decimal, required
        - `payments` string, decimal, required
        - `reserved` string, decimal, required
        - `count` integer, required
      - `subtotal` string, decimal, required
      - `payments` string, decimal, required
      - `reserved` string, decimal, required
      - `distributable` string, decimal, required
    - `costs` DividendCosts, required
      - `approved` string, decimal, required
      - `drawn` string, decimal, required
      - `outstanding` string, decimal, required
      - `reserved` string, decimal, required
      - `due` string, decimal, required
    - `sources` DividendSources, required: The records behind figures the snapshot does not otherwise list.
      - `approvals` DividendApprovalSource[], required
        - `id` string, uuid, required
        - `date` string, date, required
        - `label` string, required
        - `approved` string, decimal, required
        - `drawn` string, decimal, required
        - `undrawn` string, decimal, required
      - `drawings` DividendDrawingSource[], required
        - `id` string, uuid, required
        - `approval_id` string, uuid, required
        - `date` string, date, required
        - `label` string, required
        - `amount` string, decimal, required
        - `transaction_id` string, uuid, nullable, required
        - `bank_id` string, uuid, nullable, required
      - `deductions` DividendDeduction[], required
        - `id` string, uuid, required
        - `pool` string, required
        - `amount` string, decimal, required
      - `earlier` DividendEarlierRun[], required
        - `id` string, uuid, required
        - `date` string, date, required
        - `amount` string, decimal, required
    - `available` string, decimal, required
    - `bank_balance` string, decimal, required
    - `banks` DividendBank[], required
      - `id` string, uuid, required
      - `name` string, required
      - `reconciled_to` string, date, nullable, required
      - `balance` string, decimal, nullable, required
      - `excluded` string, nullable, required
    - `prior_runs` DividendPriorRun[], required
      - `id` string, uuid, required
      - `date` string, date, required
    - `prior_rate` string, decimal, required
    - `latest_finalised` string, date, nullable, required
    - `gates` DividendGates, required: Matter facts and the statutory process this distribution relies on.
      - `acted_as_trustee` boolean, nullable, required
      - `pooling_applies` boolean, nullable, required
      - `notice` DividendNotice, required
        - `id` string, uuid, required
        - `kind` 'interim' | 'final', required
        - `issued_on` string, date, required
        - `proofs_close_on` string, date, required
        - `created_by` string, uuid, required
        - `created_at` string, date-time, required
      - `awaiting` string[], required
    - `documents` object, required
    - `adjustments` DividendAdjustment[], required
      - `key` string, required
      - `kind` string, required
      - `subject` string, required
      - `source` string, required
      - `adjusted` string, required
      - `reason` string, required
      - `by` string, uuid, nullable, required
      - `at` string, nullable, required
    - `issues` DividendIssue[], required
      - `code` 'appointment' | 'ato_clearance' | 'bank_account' | 'bank_reconciliation' | 'chronology' | 'claim_status' | 'classification' | 'commissioner_notice' | 'competing_security' | 'competing_surplus' | 'confirm_court_orders' | 'court_orders' | 'currency' | 'dividend_notice' | 'duplicate' | 'employee_excluded_status' | 'employee_free_property' | 'employee_review' | 'employee_split' | 'excluded_account_receipts' | 'feg_substitution' | 'funding_pool' | 'insufficient_cash' | 'lender' | 'matter_pooling' | 'matter_trustee' | 'mixed_claim' | 'mixed_split' | 'mvl_members' | 'no_distribution' | 'overpayment' | 'payment_match' | 'pool_shortfall' | 'pooling' | 'pre_appointment_gst' | 'prior_lender_changed' | 'prior_payment' | 'priority' | 'proofs_awaiting' | 'proofs_open' | 'relevant_date' | 'reserve_review' | 'secured_debt' | 'secured_shortfall' | 'security_review' | 'subordinated' | 'surplus_review' | 'trust_review', required
      - `message` string, required
      - `section` string, required
      - `severity` 'blocking' | 'advisory', required
      - `id` string, nullable, required
    - `calculation` DividendCalculation, required
      - `stages` DividendStage[], required
        - `key` string, required
        - `step` string, required
        - `label` string, required
        - `section` string, required
        - `pools` string[], required
        - `opening` string, decimal, required
        - `available` string, decimal, required
        - `claims` string, decimal, required
        - `cap` string, decimal, nullable, required
        - `paid` string, decimal, required
        - `movement` string, decimal, required
        - `shortfall` string, decimal, required
        - `rate` string, decimal, nullable, required
        - `drawn` object, required
        - `released` string, decimal, required
        - `retained` string, decimal, required
        - `closing` string, decimal, required
        - `creditors` object, required
      - `payments` object, required
      - `breakdown` object, required
      - `catch_up` object, required
      - `pool_usage` object, required
      - `free_before_costs` string, decimal, required
      - `employee_free` string, decimal, required
      - `employee_circulating` string, decimal, required
      - `unsecured_claims` string, decimal, required
      - `unsecured_dividend` string, decimal, required
      - `unsecured_paid` string, decimal, required
      - `rate` string, decimal, required
      - `cumulative_rate` string, decimal, required
      - `residual` string, decimal, required
      - `retained` string, decimal, required
      - `surplus` string, decimal, required
      - `costs_paid` string, decimal, required
      - `members_paid` string, decimal, required
      - `total_paid` string, decimal, required
    - `reconciliations` DividendReconciliationVersion[], required
      - `id` string, uuid, required
      - `version` integer, required
    - `settings` DividendSettingsOutput, required
      - `excluded` object, required
      - `lenders` object, required
      - `splits` object, required
      - `overrides` object, required
      - `payment_matches` object, required
      - `secured_debt` object, required
      - `security_reviews` object, required
      - `excluded_accounts` object, required
      - `employees` object, required
      - `feg` object, required
      - `duplicates` object, required
      - `caps` object, required
      - `reserve` string, decimal, required
      - `reserve_reason` string, required
      - `confirmations` ConfirmationsOutput, required: Facts about this distribution no other feature records. Unanswered means not confirmed.
        - `court_orders` boolean, nullable, required
        - `relevant_date` string, date, nullable, required
        - `note` string, required
      - `trust_clearance` TrustClearance, required: The practitioner's clearance that the proceeds are not trust property of the trust the company acted for, or may be distributed regardless.
        - `note` string, required
      - `member_surplus_review` MemberSurplusReview, required: The practitioner's review before a members' voluntary liquidation pays its surplus to members (s 501): members' rights under the constitution and share classes, and that statutory interest and subordinated claims were considered.
        - `note` string, required
      - `known_unreported_pre_appointment_gst` boolean, nullable, required
      - `commissioner_notified_on` string, date, nullable, required
      - `ato_cleared_on` string, date, nullable, required
      - `recorded` object, required
    - `source_hash` string, required
  - `history` DividendHistoryEntry[], required
    - `action` string, required
    - `actor` string, uuid, required
    - `at` string, date-time, required
    - `reason` string, required
    - `changes` string[], required
    - `self_approval` boolean, required
  - `payments` DividendPayments, required
    - `status` 'not_paid' | 'partly_paid' | 'paid', required
    - `total` string, required
    - `paid` string, required
    - `lines` PaymentLine[], required
      - `creditor_id` string, uuid, required
      - `creditor` string, required
      - `pay_to` string, required
      - `source` 'direction' | 'bank', nullable, required
      - `masked` string, nullable, required
      - `amount` string, required
      - `status` 'unprepared' | 'prepared' | 'exported' | 'paid', required
      - `transaction_id` string, uuid, nullable, required
      - `transaction_status` string, nullable, required
      - `bank_account_id` string, uuid, nullable, required
      - `version` integer, nullable, required
    - `can_post` 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/bf4373130521?raw)