Preview amortization schedule

post
https://api.wafeq.com/v1/amortizations/preview/

Endpoint for previewing the amortization events that would be generated for the given schedule, without creating an amortization.

Query Params
stringenum
  • 3_MONTHS - 3 Months
  • 4_MONTHS - 4 Months
  • 6_MONTHS - 6 Months
  • 12_MONTHS - 12 Months
  • 24_MONTHS - 24 Months
  • CUSTOM - Custom
Allowed:
date
date
stringenum
  • DAILY - Daily
  • MONTHLY - Monthly
Allowed:
date
date
status__inarray of strings
  • AMORTIZING - Amortizing
  • DRAFT - Draft
  • ENDED_EARLY - Ended Early
  • FULLY_AMORTIZED - Fully Amortized
  • INACTIVE - Inactive
  • SCHEDULED - Scheduled
Body Params

The payload to preview the events of an amortization schedule.

doublerequired

The total amount to amortize.

stringenum

The currency to quantize the previewed schedule in. Defaults to the organization base currency.

View the enum reference

stringrequired

The description of the amortization.

stringenumrequired

The recognition duration.

View the enum reference

Allowed:
daterequired

The end date of the amortization schedule.

stringenumrequired

How the amortization is recognized (DAILY or MONTHLY).

View the enum reference

Allowed:
daterequired

The start date of the amortization schedule.

Headers
stringenumDefaults to application/json

Generated from available request content types

Allowed:
Response