API Reference
Developer ConsoleAPI Status Page

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
string
enum
  • 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
string
enum
  • DAILY - Daily
  • MONTHLY - Monthly
Allowed:
date
date
status__in
array of strings
  • AMORTIZING - Amortizing
  • DRAFT - Draft
  • ENDED_EARLY - Ended Early
  • FULLY_AMORTIZED - Fully Amortized
  • INACTIVE - Inactive
  • SCHEDULED - Scheduled
status__in
Allowed:
Body Params

The payload to preview the events of an amortization schedule.

double
required

The total amount to amortize.

string
enum

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

View the enum reference

string
required

The description of the amortization.

string
enum
required

The recognition duration.

View the enum reference

Allowed:
date
required

The end date of the amortization schedule.

string
enum
required

How the amortization is recognized (DAILY or MONTHLY).

View the enum reference

Allowed:
date
required

The start date of the amortization schedule.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?