--- title: "Create Workspace" method: POST path: "/v1/matters/{matter_id}/sbr/scenario/scenarios" tags: ["sbr-scenario"] --- # Create Workspace `POST /v1/matters/{matter_id}/sbr/scenario/scenarios` ## 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}/sbr/scenario/scenarios` - Auth: HTTP bearer ## Path parameters - `matter_id` string, uuid, required ## Request body - CreateScenarioWorkspace - `name` string, required - `description` string, nullable - `proposal` ScenarioProposalInputV1Input - `schema_version` 'sbr-scenario-proposal-v1' - `offer` union, required - NetPoolOfferInput - `kind` 'net_pool' - `amount` string, decimal, required - DividendRateOfferInput - `kind` 'dividend_rate' - `rate` string, decimal, required - `funding_sources` FundingSourceInput[], required - `id` string, required - `type` 'director_contribution' | 'related_party_contribution' | 'trading_cash' | 'asset_sale' | 'other', required - `amount` string, decimal, required - `month` integer, required - `costs` PlanCostInput[], required - `id` string, required - `description` string, required - `amount` string, decimal, required - `kind` 'practitioner_fee' | 'other' - `treatment` 'inside_pool' | 'outside_pool', required - `month` integer, required - `duration_months` integer, required - `label` string, nullable - `notes` string, nullable - `overrides` ScenarioAssumptionOverridesV1Input - `schema_version` 'sbr-scenario-overrides-v1' - `current_cash` string, decimal, nullable - `annual_profit_proxy` string, decimal, nullable - `assets` AssetOverrideInput[] - `asset_id` string, required - `category` string, nullable - `book_value` string, decimal, nullable - `realization_basis` 'amount' | 'rate' - `low_realization` string, decimal, nullable - `high_realization` string, decimal, nullable - `low_realization_rate` string, decimal, nullable - `high_realization_rate` string, decimal, nullable - `low_realization_cost` string, decimal, nullable - `high_realization_cost` string, decimal, nullable - `excluded` boolean - `reason` string, nullable - `manual_assets` ManualAssetInput[] - `id` string, required - `category` string, required - `book_value` string, decimal, nullable - `realization_basis` 'amount' | 'rate' - `low_realization` string, decimal, nullable - `high_realization` string, decimal, nullable - `low_realization_rate` string, decimal, nullable - `high_realization_rate` string, decimal, nullable - `low_realization_cost` string, decimal, nullable - `high_realization_cost` string, decimal, nullable - `reason` string, nullable - `claims` ClaimOverrideInput[] - `claim_id` string, required - `creditor` string, nullable - `category` 'ato' | 'trade' | 'other_unsecured' | 'employee' | 'unresolved' - `gross_amount` string, decimal, nullable - `admitted_amount` string, decimal, nullable - `secured_amount` string, decimal, nullable - `is_related_party` boolean, nullable - `is_disputed` boolean, nullable - `excluded` boolean - `reason` string, nullable - `manual_claims` ManualClaimInput[] - `id` string, required - `creditor` string, required - `category` 'ato' | 'trade' | 'other_unsecured' | 'employee' | 'unresolved' - `gross_amount` string, decimal, nullable - `admitted_amount` string, decimal, nullable - `secured_amount` string, decimal - `is_related_party` boolean - `is_disputed` boolean - `reason` string, nullable - `liquidation` LiquidationOverrideInput[] - `case` 'low' | 'high', required - `secured_recoveries` string, decimal, nullable - `remuneration_and_expenses` string, decimal, nullable - `recoveries` string, decimal, nullable - `recovery_costs` string, decimal, nullable - `reason` string, nullable - `forecast` ForecastPeriodOverrideInput[], nullable - `month` integer, required - `net_profit` string, decimal, nullable - `sbr_contribution` string, decimal, nullable - `practitioner_fee` string, decimal, nullable - `other_plan_costs` string, decimal, nullable - `opening_cash` string, decimal, nullable - `operating_inflows` string, decimal, nullable - `operating_outflows` string, decimal, nullable - `financing_outflows` string, decimal, nullable - `profit_and_loss` ProfitAndLossRowOverrideInput[] - `row_key` string, required - `description` string, nullable - `line_type` 'revenue' | 'cost_of_sales' | 'operating_expense' | 'other_income' | 'other_expense' | 'subtotal' | 'net_profit' | 'unknown', nullable - `excluded` boolean - `cells` ProfitAndLossCellOverrideInput[] - `month` integer, required - `amount` string, decimal, nullable - `manual_profit_and_loss` ManualProfitAndLossRowInput[] - `id` string, required - `description` string, required - `line_type` 'revenue' | 'cost_of_sales' | 'operating_expense' | 'other_income' | 'other_expense' | 'subtotal' | 'unknown' - `cells` ProfitAndLossCellOverrideInput[] - `month` integer, required - `amount` string, decimal, nullable - `minimum_cash_buffer` string, decimal, nullable - `profit_basis` 'supplied_forecast' | 'latest_actual' | 'average_actual' | 'manual' - `ato_records` AppModulesSbrScenarioContractsAtoRecordOverrideInput[] - `record_id` string, required - `account_or_lodgement` string, required - `record_kind` 'lodgement' | 'account_balance', nullable - `period` string, nullable - `due_date` string, date, nullable - `lodged_date` string, date, nullable - `status` string, nullable - `amount` string, decimal, nullable - `excluded` boolean - `manual_ato_records` AppModulesSbrScenarioContractsManualAtoRecordInput[] - `id` string, required - `account_or_lodgement` string, required - `record_kind` 'lodgement' | 'account_balance', nullable - `period` string, nullable - `due_date` string, date, nullable - `lodged_date` string, date, nullable - `status` string, nullable - `amount` string, decimal, nullable ## Response `201` Successful Response - ScenarioWorkspace - `id` string, uuid, required - `matter_id` string, uuid, required - `name` string, required - `description` string, nullable, required - `current_run_id` string, uuid, nullable, required - `pending_run_id` string, uuid, nullable, required - `proposal` ScenarioProposalInputV1Output, required - `schema_version` 'sbr-scenario-proposal-v1', required - `offer` union, required - NetPoolOfferOutput - `kind` 'net_pool', required - `amount` string, decimal, required - DividendRateOfferOutput - `kind` 'dividend_rate', required - `rate` string, decimal, required - `funding_sources` AppModulesSbrScenarioContractsFundingSource[], required - `id` string, required - `type` 'director_contribution' | 'related_party_contribution' | 'trading_cash' | 'asset_sale' | 'other', required - `amount` string, decimal, required - `month` integer, required - `costs` PlanCostOutput[], required - `id` string, required - `description` string, required - `amount` string, decimal, required - `kind` 'practitioner_fee' | 'other', required - `treatment` 'inside_pool' | 'outside_pool', required - `month` integer, required - `duration_months` integer, required - `label` string, nullable, required - `notes` string, nullable, required - `overrides` ScenarioAssumptionOverridesV1Output, required - `schema_version` 'sbr-scenario-overrides-v1', required - `current_cash` string, decimal, nullable, required - `annual_profit_proxy` string, decimal, nullable, required - `assets` AssetOverrideOutput[], required - `asset_id` string, required - `category` string, nullable, required - `book_value` string, decimal, nullable, required - `realization_basis` 'amount' | 'rate', required - `low_realization` string, decimal, nullable, required - `high_realization` string, decimal, nullable, required - `low_realization_rate` string, decimal, nullable, required - `high_realization_rate` string, decimal, nullable, required - `low_realization_cost` string, decimal, nullable, required - `high_realization_cost` string, decimal, nullable, required - `excluded` boolean, required - `reason` string, nullable, required - `manual_assets` ManualAssetOutput[], required - `id` string, required - `category` string, required - `book_value` string, decimal, nullable, required - `realization_basis` 'amount' | 'rate', required - `low_realization` string, decimal, nullable, required - `high_realization` string, decimal, nullable, required - `low_realization_rate` string, decimal, nullable, required - `high_realization_rate` string, decimal, nullable, required - `low_realization_cost` string, decimal, nullable, required - `high_realization_cost` string, decimal, nullable, required - `reason` string, nullable, required - `claims` ClaimOverrideOutput[], required - `claim_id` string, required - `creditor` string, nullable, required - `category` 'ato' | 'trade' | 'other_unsecured' | 'employee' | 'unresolved', required - `gross_amount` string, decimal, nullable, required - `admitted_amount` string, decimal, nullable, required - `secured_amount` string, decimal, nullable, required - `is_related_party` boolean, nullable, required - `is_disputed` boolean, nullable, required - `excluded` boolean, required - `reason` string, nullable, required - `manual_claims` ManualClaimOutput[], required - `id` string, required - `creditor` string, required - `category` 'ato' | 'trade' | 'other_unsecured' | 'employee' | 'unresolved', required - `gross_amount` string, decimal, nullable, required - `admitted_amount` string, decimal, nullable, required - `secured_amount` string, decimal, required - `is_related_party` boolean, required - `is_disputed` boolean, required - `reason` string, nullable, required - `liquidation` LiquidationOverrideOutput[], required - `case` 'low' | 'high', required - `secured_recoveries` string, decimal, nullable, required - `remuneration_and_expenses` string, decimal, nullable, required - `recoveries` string, decimal, nullable, required - `recovery_costs` string, decimal, nullable, required - `reason` string, nullable, required - `forecast` ForecastPeriodOverrideOutput[], nullable, required - `month` integer, required - `net_profit` string, decimal, nullable, required - `sbr_contribution` string, decimal, nullable, required - `practitioner_fee` string, decimal, nullable, required - `other_plan_costs` string, decimal, nullable, required - `opening_cash` string, decimal, nullable, required - `operating_inflows` string, decimal, nullable, required - `operating_outflows` string, decimal, nullable, required - `financing_outflows` string, decimal, nullable, required - `profit_and_loss` ProfitAndLossRowOverrideOutput[], required - `row_key` string, required - `description` string, nullable, required - `line_type` 'revenue' | 'cost_of_sales' | 'operating_expense' | 'other_income' | 'other_expense' | 'subtotal' | 'net_profit' | 'unknown', nullable, required - `excluded` boolean, required - `cells` ProfitAndLossCellOverrideOutput[], required - `month` integer, required - `amount` string, decimal, nullable, required - `manual_profit_and_loss` ManualProfitAndLossRowOutput[], required - `id` string, required - `description` string, required - `line_type` 'revenue' | 'cost_of_sales' | 'operating_expense' | 'other_income' | 'other_expense' | 'subtotal' | 'unknown', required - `cells` ProfitAndLossCellOverrideOutput[], required - `month` integer, required - `amount` string, decimal, nullable, required - `minimum_cash_buffer` string, decimal, nullable, required - `profit_basis` 'supplied_forecast' | 'latest_actual' | 'average_actual' | 'manual', required - `ato_records` AppModulesSbrScenarioContractsAtoRecordOverrideOutput[], required - `record_id` string, required - `account_or_lodgement` string, required - `record_kind` 'lodgement' | 'account_balance', nullable, required - `period` string, nullable, required - `due_date` string, date, nullable, required - `lodged_date` string, date, nullable, required - `status` string, nullable, required - `amount` string, decimal, nullable, required - `excluded` boolean, required - `manual_ato_records` AppModulesSbrScenarioContractsManualAtoRecordOutput[], required - `id` string, required - `account_or_lodgement` string, required - `record_kind` 'lodgement' | 'account_balance', nullable, required - `period` string, nullable, required - `due_date` string, date, nullable, required - `lodged_date` string, date, nullable, required - `status` string, nullable, required - `amount` string, decimal, nullable, required - `basis_issue` AppModulesSbrScenarioApiContractsRunIssue, required - `code` string, required - `message` string, required - `retryable` boolean, required - `required_action` 'rerun' | 'contact_support', nullable, required - `outcome_summary` ScenarioOutcomeSummary, required - `status` 'complete' | 'limited' | 'insufficient_data', required - `outcome` 'sbr_better_than_both' | 'sbr_better_than_low_only' | 'liquidation_comparable_or_better' | 'no_proposed_plan' | 'insufficient_data', required - `low_liquidation_dividend_rate` string, decimal, nullable, required - `high_liquidation_dividend_rate` string, decimal, nullable, required - `proposed_dividend_rate` string, decimal, nullable, required - `gross_funding_sources` string, decimal, nullable, required - `version` integer, required - `archived_at` string, date-time, nullable, required - `created_by` string, uuid, required - `updated_by` string, uuid, required - `created_at` string, date-time, required - `updated_at` string, date-time, 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)