v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB

Instalment Operations

Get instalment portions

get/v1/{instalmentId}/portions

Path parameters

instalmentIdstring required

Instalment id

Example:678543

The instalment id

Query parameters

auditUserstring required

The audit user to log the request

pageinteger

Current page

sizeinteger

How many entries should be returned per page, default is 30. Cannot be more than 100.

filterstring

Filter for instalment portion status. Supported operations: eq, or. Example: (status eq WAITING or status eq OVERDUE) Note: You must URL-encode parentheses and spaces.

Response

List of instalment portions

Example response

{
  "pagination": {
    "page": 1,
    "pages": 7,
    "elements": 15,
    "size": 1
  },
  "data": [
    {
      "index": 1,
      "total": 38,
      "currency": "EUR",
      "principalAmount": 1000,
      "feeAmount": 10,
      "interestAmount": 90,
      "paidAmount": 20,
      "interestPaidAmount": 20.57,
      "principalPaidAmount": 500,
      "writtenOffAmount": 1000,
      "reversed": 1000,
      "instalmentId": "678543"
    }
  ]
}