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

startDatestring date required
endDatestring date
totalPeriodsinteger

Optional when endDate is given (derived from the calendar span).

totalAmountCentsinteger required
frequency'monthly' | 'quarterly' | 'annual' | 'weekly'
allocationMethod'equal' | 'daily_prorated'

Response

The runs pure generation would produce

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.