List amortizations

Endpoint for retrieving a list of amortizations.

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
integer

A page number within the paginated result set.

integer

Number of results to return per page.

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
Response

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