API Reference

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
Body Params
double
required

The total amount to amortize.

string
enum
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

string
required

The description of the amortization.

string
enum
required
  • 3_MONTHS - 3 Months
  • 4_MONTHS - 4 Months
  • 6_MONTHS - 6 Months
  • 12_MONTHS - 12 Months
  • 24_MONTHS - 24 Months
  • CUSTOM - Custom

Full information for DurationEnum

Allowed:
date
required

The end date of the amortization schedule.

string
enum
required
  • DAILY - Daily
  • MONTHLY - Monthly

Full information for RecognitionTypeEnum

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 about 14 hours ago

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

Updated about 14 hours ago