Retrieve payment allocations

Fetch the allocated received payments from the collection agency. Data is available after the settlement has been created for the payment transactions.
Use this data to allocate payments in your accounting system.

Payload content

This endpoint returns an JSON object and array containing allocated payments by the agency. Data is collected per settlement.

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
  "creditor": {
    "creditorNo": 12345,
    "name": "Acme Oy",
    "businessId": "12345678"
  },
  "query": {
    "settlementNo": 456789,
    "allocationDate": null
  },
  "batches": [
    {
      "settlementNo": 456789,
      "accountNo": "FI2112345600000785",
      "currency": "EUR",
      "recordCount": 2,
      "totalAmount": 1295.00,
      "payments": [
        {
          "debtNo": 998877,
          "invoiceNo": "INV-2026-001",
          "paymentNo": 4,
          "allocationType": "POK",
          "allocationDate": "2026-08-04",
          "paymentDate": "2026-08-01",
          "reference": "10025883",
          "originalReference": "55501234",
          "reportingReference": "55501234",
          "debtorPartyNo": "445566",
          "debtorName": "Meikalainen",
          "amount": 1250.00,
          "creditFlag": false
        },
        {
          "debtNo": 998877,
          "invoiceNo": "INV-2026-001",
          "allocationType": "VKO",
          "allocationDate": "2026-08-04",
          "paymentDate": "2026-08-01",
          "reference": "10025883",
          "originalReference": null,
          "reportingReference": "10025883",
          "debtorPartyNo": "445566",
          "debtorName": "Meikalainen",
          "amount": 45.00,
          "creditFlag": false
        }
      ]
    }
  ],
  "batchCount": 1,
  "paymentCount": 2
}

🟠400Generic 400

🟠401Unauthorized

Request

Responses