GET
/
v1
/
portions
/
{instalmentId}
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/instalment/v1/portions/{instalmentId} \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "portionId": "<string>",
    "portionNumber": "1/10",
    "openDate": "2023-12-25",
    "dueDate": "2023-12-25",
    "currency": "<string>",
    "portionAmount": "<string>",
    "principalAmount": "<string>",
    "feeAmount": "<string>",
    "paidAmount": "<string>",
    "principalPaidAmount": "<string>",
    "writtenOffAmount": "<string>",
    "instalmentId": "<string>",
    "instalmentOriginalId": "<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

Response

200
application/json
List of instalment portions
​
portionId
string

The instalment portion identifier

​
portionNumber
string

The portion number

​
openDate
string

The open date

​
dueDate
string

The due-date

​
currency
string

The currency of the instalment

​
portionAmount
string

The portion amount

​
principalAmount
string

The principal amount

​
feeAmount
string

The fee amount

​
paidAmount
string

The paid amount

​
principalPaidAmount
string

The principal paid amount

​
writtenOffAmount
string

The written-off amount

​
instalmentId
string

Instalment id

​
instalmentOriginalId
string

The instalment id

​
status
enum<string>

The status of the instalment plan

Available options:
WAITING,
INACTIVE,
PREVIEW,
PREVIEW_CLOSED,
OPEN,
PAIDPART,
OVD,
PAID,
CLOSED,
WRITE-OFF,
REVISED,
WAIVED,
NOT_READY,
MOVED,
REJECTED,
SIMULATED,
EXTERNAL,
Z,
OUTSTAND,
OUTSTAND_COMPLETE
Get instalment plans for a given accountChange instalment plan tenor (number of instalments)