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

# Preview

`POST /v1/matters/{matter_id}/cash-book/transactions/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}/cash-book/transactions/preview`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Request body

- PreviewCommand
  - `kind` 'bank' | 'notional'
  - `bank_account_id` string, uuid, nullable
  - `transfer_id` string, uuid, nullable
  - `amount` string, decimal, required
  - `allocations` AllocationCommandInput[]
    - `ledger_account_id` string, uuid, required
    - `amount` string, decimal, required
    - `gst_treatment` union
      - 'taxable_sale' | 'gst_free_sale' | 'input_taxed_sale' | 'creditable_purchase' | 'purchase_no_credit' | 'outside_gst'
      - 'gst_included' | 'gst_free' | 'no_gst'
    - `gst_amount` string, decimal
    - `reporting_category` string, nullable
    - `asset_pool` 'circulating' | 'non_circulating' | 'free' | 'mixed' | 'not_applicable' | 'restricted', nullable
    - `disbursement_type` 'recoverable_acquisition' | 'recoverable_recharge' | 'other', nullable
    - `purchase_kind` 'capital' | 'non_capital', nullable
    - `gst_free_kind` 'export' | 'other', nullable
    - `narration` string, nullable
    - `payee` string, nullable
    - `payee_alias` string, nullable
    - `contact_id` string, uuid, nullable
    - `tax_code` string, nullable
    - `tax_code_name` string, nullable
    - `calculation_method` 'standard' | 'no_gst' | 'entered', nullable
    - `gst_reason` string, nullable
    - `invoice_gst` string, decimal, nullable
    - `debtor_invoice_reference` string, nullable
    - `debtor_gst_reported` boolean, nullable
  - `description` string

## Response `200`

Successful Response

- TransactionPreview
  - `lines` JournalPreviewLine[], required
    - `ledger_account_id` string, uuid, required
    - `code` string, required
    - `name` string, required
    - `debit` string, required
    - `credit` string, required
    - `narration` string, required
  - `remaining` string, required
  - `gst` string, required
  - `balanced` boolean, required
  - `total_debit` string, required
  - `total_credit` string, 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)