Retrieve settlements - Confirma Finance Integrations API

Returns settlement batches for the selected period, including per-invoice allocations and amount breakdown (capital, interest, fees).
If you do not pass a date range, the last 30 days are used.

Only unfetched settlements

Set unfetchedOnly = true to return only settlements your integration has not yet retrieved (for incremental sync).

Responses

🟢200OK (Results found)

application/json

Bodyapplication/json

Example

{
    "createdAt": "2026-04-01T09:34:12.123Z",
    "settlements": [
        {
            "settlementId": 202603280001,
            "settlementDate": "2026-03-28",
            "agency": "CASH-IN",
            "remittanceReference": "8090801781763",
            "beneficiary": {
                "name": "Partner Test Customer",
                "iban": "",
                "bic": ""
            },
            "settlementAmount": 1240.50,
            "currency": "EUR",
            "apiFetchDate": null,
            "allocations": [
                {
                    "allocationId": 9001001,
                    "allocatedTotalAmount": 1000.00,
                    "allocationDate": "2026-03-28",
                    "currency": "EUR",
                    "caseId": null,
                    "originalInvoiceNumber": "202600145",
                    "originalPaymentReference": "",
                    "breakdown": [
                        {
                            "type": "CAPITAL",
                            "amount": 900.00
                        },
                        {
                            "type": "INTEREST",
                            "amount": 75.00
                        },
                        {
                            "type": "FEES",
                            "amount": 25.00
                        }
                    ]
                },
                {
                    "allocationId": 9001002,
                    "allocatedTotalAmount": 240.50,
                    "allocationDate": "2026-03-28",
                    "currency": "EUR",
                    "caseId": null,
                    "originalInvoiceNumber": "202600146",
                    "originalPaymentReference": "",
                    "breakdown": [
                        {
                            "type": "CAPITAL",
                            "amount": 200.00
                        },
                        {
                            "type": "INTEREST",
                            "amount": 30.00
                        },
                        {
                            "type": "FEES",
                            "amount": 10.50
                        }
                    ]
                }
            ]
        }
    ]
}

🟢204No Content (No settlements found)

🟠400Bad Request

🟠401Unauthorized

🟠404Not Found