Loan installments
A scheduled payment of principal and interest on a term loan.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Treasury account | treasuryaccountId | Reference | Yes | |
| Installment number | sequence | Whole Number | Yes | Sequence of this installment in the loan schedule (1…n). |
| Due date | date | Date | Yes | Date this principal installment is due per the lender schedule. |
| Transfer | treasurytransferId | Reference | Processed transfer that pays this installment's principal. | |
| Principal | amountPrincipal | Currency | Yes | Scheduled principal due on this date. |
| Expected interest | amountInterest | Currency | Expected interest for this installment when the lender provides it. Omit for variable-rate loans. | |
| Installment total | amountDue | Currency | Scheduled principal plus expected interest on this installment. | |
| Remaining principal (schedule) | amountPrincipalClosing | Currency | Yes | Principal the schedule still owes after this installment. This is not the account balance. |
| Exchange rate | fxrate | Decimal | Yes | Units of the company currency for one unit of the installment currency. The interest posting uses this rate. |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Treasury account treasuryaccountId | Treasury accounts | owned by |
Transfer treasurytransferId | Fund transfers | reference |
Actions
What you can do with a record. Every action also sends the webhook event financesloaninstallments.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new installment. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this installment. | App · API · MCP · CLI |
| Process | process | Close this loan installment. | App · WebMCP · API · CLI |
| Delete | delete | Delete this installment and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.