Loan amortizations
API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
List loan amortizations
GET
https://{domain}.biapi.pro/2.0/users/{userId}/amortizations
List loan amortizations related to a user.
Path Parameters
userId*
Integer or "me"
ID of the related user.
Response body: #marketorderslist-object
Data model
LoanAmortizationsList object
LoanAmortization object
id_account
ID of the related account.
payment_date
Date of the payment.
amortization_amount
Amount of the amortization.
interest_amount
Amount of the loan's interest.
insurance_amount
Amount of the loan's insurance.
total_payment_amount
Amount of the total due payment.
remaining_capital
Remaining capital to be refunded.
period
Period covered by amortization. Should be monthly (YYYY_MM) or annual (YYYY).
calculated
List of properties of this response that has been calculated rather than directly obtained from the source.
deleted
Deletion date for amortizations that no longer exist (null
if still present).
last_update
Date of the last synchronization of the investment.
MonetaryAmount object
value
Decimal or null
Amount value. Rounded to two decimal places.
Last updated