v1
latestOpenAPI 3.1.12026-07-24260246894.7 KBAmortizations
List amortizations
Endpoint for retrieving a list of amortizations.
get/amortizations/
Query parameters
duration'12_MONTHS' | '24_MONTHS' | '3_MONTHS' | '4_MONTHS' | '6_MONTHS' | 'CUSTOM' | '__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
pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
recognition_type'DAILY' | 'MONTHLY' | '__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
Response
Example response
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}