---
title: "Preview the schedule runs a set of derived inputs would produce (no persistence)"
method: POST
path: "/accountant/companies/{customerId}/schedule-proposals/preview"
tags: ["Accountant Portal", "Schedule Proposals"]
---

# Preview the schedule runs a set of derived inputs would produce (no persistence)

`POST /accountant/companies/{customerId}/schedule-proposals/preview`

## Request

- Base URL: `https://api.medianfi.com/api/v1`
- URL: `https://api.medianfi.com/api/v1/accountant/companies/{customerId}/schedule-proposals/preview`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Request body

- SchedulePreviewInput
  - `startDate` string, date, required
  - `endDate` string, date
  - `totalPeriods` integer: Optional when endDate is given (derived from the calendar span).
  - `totalAmountCents` integer, required
  - `frequency` 'monthly' | 'quarterly' | 'annual' | 'weekly'
  - `allocationMethod` 'equal' | 'daily_prorated'

## Response `200`

The runs pure generation would produce

- SchedulePreviewResponse
  - `success` boolean
  - `data` object
    - `runs` SchedulePreviewRun[]
      - `sequenceNum` integer
      - `scheduledDate` string, date
      - `amountCents` integer
      - `runParams` object

## Other responses

- `401`: Authentication required
- `403`: Insufficient permissions or not a company member
- `422`: Request failed validation

---

[API](https://skmtc.dev/medianfi/apis/median-api.md) · [All operations](https://skmtc.dev/medianfi/apis/median-api/llms.txt) · [OpenAPI document](https://skmtc.dev/medianfi/apis/median-api/revisions/20090ea32b0d?raw)