WAwafeq
Amortizations

Preview amortization schedule

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

post/amortizations/preview/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/amortizations/preview/
  • Auth
    API key in header Authorization

Query parameters

duration'12_MONTHS' | '24_MONTHS' | '3_MONTHS' | '4_MONTHS' | '6_MONTHS' | 'CUSTOM' | '__null__'
  • 12_MONTHS - 12_MONTHS
  • 24_MONTHS - 24_MONTHS
  • 3_MONTHS - 3_MONTHS
  • 4_MONTHS - 4_MONTHS
  • 6_MONTHS - 6_MONTHS
  • CUSTOM - CUSTOM
  • __null__ - null
  • 3_MONTHS - 3 Months
  • 4_MONTHS - 4 Months
  • 6_MONTHS - 6 Months
  • 12_MONTHS - 12 Months
  • 24_MONTHS - 24 Months
  • CUSTOM - Custom
end_date_afterstring date
end_date_beforestring date
recognition_type'DAILY' | 'MONTHLY' | '__null__'
  • DAILY - DAILY
  • MONTHLY - MONTHLY
  • __null__ - null
  • DAILY - Daily
  • MONTHLY - Monthly
start_date_afterstring date
start_date_beforestring date
status__instring[]
  • AMORTIZING - Amortizing
  • DRAFT - Draft
  • ENDED_EARLY - Ended Early
  • FULLY_AMORTIZED - Fully Amortized
  • INACTIVE - Inactive
  • SCHEDULED - Scheduled

Request body

amountnumber double required

The total amount to amortize.

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW'

An ISO 4217 currency code.

View the enum reference

descriptionstring required

The description of the amortization.

duration'3_MONTHS' | '4_MONTHS' | '6_MONTHS' | '12_MONTHS' | '24_MONTHS' | 'CUSTOM' required

Duration over which an amount is recognized or amortized.

View the enum reference

end_datestring date required

The end date of the amortization schedule.

recognition_type'DAILY' | 'MONTHLY' required

Schedule used to recognize deferred amounts.

View the enum reference

start_datestring date required

The start date of the amortization schedule.

Response

amountnumber double required

The amount recognized for this event.

balancenumber double required

The remaining balance after this event.

datestring date required

The date when this event would post.

descriptionstring required

The description of the event.

Changes

No recorded changes to this operation across all 2 revisions of this API.