API Reference
These docs are for v2.3. Click to read the latest docs for v3.0.

Retrieves active Arrangements via pagination

Sample Request:
GET /api/v2.0/arrangements/

MAX PER PAGE LIMIT: 500

Returns
{
    "page": 1,
    "total": 2,
    "limit": 10,
    "totalEntries": 14,
    "data": [
        {
			"id": "30a0004-5707-4502-0000-2c963f66afa6", 
            "arragementState": "Failed",
            "accountReference": "ALB10-001-GA",
            "occupancyReference": "ALB10-001",
            "arrangementType": "IncomeOverShortfallArrangement",
            "arrangementCycle": "Manual",
            "arrangementStart": "03/12/2021 00:00",
            "arrangementEnd": "11/05/2022 00:00",
            "numberOfInstallments": 20
            "currentInstallmentFromDate": "04/12/2021 00:00",
			"currentInstallmentToDate": "11/12/2021 00:00",
			"currentInstallmentAmount": "100.00",
			"currentInstallmentPaidAmount": "0.00"
        },
        ...
        ...
    ]
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!