GET
/
v1
/
{instalmentId}
/
portions
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/instalment/v1/{instalmentId}/portions \
  --header 'Authorization: Basic <encoded-value>'
{
  "pagination": {
    "page": 123,
    "pages": 123,
    "elements": 123,
    "size": 123
  },
  "data": [
    {
      "id": "<string>",
      "index": 1,
      "total": 38,
      "openDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "currency": "<string>",
      "amount": 123,
      "principalAmount": 123,
      "feeAmount": 123,
      "paidAmount": 123,
      "principalPaidAmount": 123,
      "writtenOffAmount": 123,
      "instalmentId": "<string>",
      "status": "WAITING"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication is used to authenticate towards Enfuce API. It is described in more detail in RFC 7617.

Path Parameters

​
instalmentId
string
required

The instalment id

Query Parameters

​
auditUser
string
required

The audit user to log the request

​
page
integer
default:0

Current page

Required range: x >= 0
​
size
integer
default:30

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

Required range: 1 < x < 100
​
status
string

Filter by status value, list of possible statuses to be provided

Response

200
application/json

List of instalment portions

The response is of type object.