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

Name	Type	Description
userId*	Integer or "me"	ID of the related user.

200: OK List of loan amortizations

Response body: #marketorderslist-object

401: Unauthorized You are not authorized to use this feature. Please contact us.

{
    // Response
}

Filtering route aliases:

/users/{userId}/amortizations
/users/{userId}/accounts/{accountId}/amortizations
/users/{userId}/connections/{connectionId}/amortizations

Data model

LoanAmortizationsList object

Property	Type	Description
loanamortizations	Array of LoanAmortizations objects	List of loan amortizations.

LoanAmortization object

Property	Description
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

Property	Type	Description
currency	String	Currency codes (ISO 4217) of the analyzed accounts. EUR only.
value	Decimal or null	Amount value. Rounded to two decimal places.