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. |
Response body: #marketorderslist-object
Data model
LoanAmortizationsList object
Property | Type | Description |
---|---|---|
| Array of LoanAmortizations objects | List of loan amortizations. |
LoanAmortization object
Property | Description |
---|---|
| ID of the related account. |
| Date of the payment. |
| Amount of the amortization. |
| Amount of the loan's interest. |
| Amount of the loan's insurance. |
| Amount of the total due payment. |
| Remaining capital to be refunded. |
| Period covered by amortization. Should be monthly (YYYY_MM) or annual (YYYY). |
| List of properties of this response that has been calculated rather than directly obtained from the source. |
| Deletion date for amortizations that no longer exist ( |
| Date of the last synchronization of the investment. |
MonetaryAmount object
Property | Type | Description |
---|---|---|
| String | Currency codes (ISO 4217) of the analyzed accounts. EUR only. |
| Decimal or null | Amount value. Rounded to two decimal places. |
Last updated