List Cases API

https://api.incasso.io/v2/cases

Met de List Cases API kan je realtime informatie over een incassozaak ophalen.

Om een incassozaak op te halen heb je de unique identifier (uid) van de incassozaak nodig. Deze kan je vinden met de List Debtcollections API

Request

Bekijk alle incassozaken welke zijn aangemaakt binnen je administratie, gerangschikt van nieuw naar oud.

Parameters

limit het aantal incassozaken dat zullen worden weergegeven (met een maximum van 250).

Response

Resource Geeft aan dat het antwoord een case (incassozaak) object bevat. De waarde zal bij deze api-call dan ook altijd case zijn

Id De unieke id gekoppeld aan deze incassozaak. Deze unieke id wordt altijd automatisch gegenereerd bij het aanmaken van de incassozaak. Deze id wordt altijd gebruikt om te refereren naar een incassozaak.

Casenumber Het dossiernummer wat is gekoppeld aan de incassozaak en wat wordt gebruik voor alle externe communicatie. Dit dossiernummer staat dus los van de interne unieke id.

Url De URL waarmee de incassozaak kan worden benaderd. Wil je het dossier rechtstreeks vanuit je administratie benaderen, zonder tussenkomst van een inlogscherm? Voeg dan de variabele webkey toe aan de url. Informatie over de webkey kan je vinden bij Authenticatie. Bijvoorbeeld:

https://portaal.incasso.io/cs/{webkey}/c3097f04-6b98-4887-8d1f-6180356974b2

Status Statuscode van de incassozaak, bijvoorbeeld SOM1 REG of AFW. Bekijk hier de verschillende statuscodes en de bijbehorende omschrijvingen.

Saldo Het huidige saldo van de incassozaak.

Ingangsdatum De ingangsdatum van de incassozaak

Customer object Customer is een object met daarin een aantal essentiële debiteurgegevens.

Customer object

Customer Id De unieke id van de debiteur in jouw incasso.io administratie.

Customer Code Klantnummer van de debiteur uit jouw oorspronkelijke administratie.

Customer Name Volledige naam of bedrijfsnaam van debiteur

Statuscode AFW

Indien de incassozaak de statuscode AFW heeft, dan betekent dit dat de incassozaak is afgewikkeld. Er zullen dan twee extra velden beschikbaar zijn:

AfwikkelingCode De code (reden) van de afwikkeling. bijvoorbeeld paid cancelled of bankrupt. Bekijk hier de verschillende statuscodes en de bijbehorende omschrijvingen.

AfwikkelingDatum De datum waarop de incassozaak is afgewikkeld

Request voorbeeld

cURL

curl -X GET https://api.incasso.io/v2/cases \
   -H "Authorization: dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \

PHP

<?php
$incasso = new IncassoApi();
$incasso->setApiKey("dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");
$listdebtcollections = $incasso->listCases();

ASP

<%
Set IncassoApi = New IncassoApiClient
IncassoApi.setApiKey("dHar4XY7LxsDOtmnkVtjNVWXLSlXsM")
Listdebtcollections = IncassoApi.listCases()
%>

Response voorbeeld

HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 4,
    "cases": [{
        "resource": "case",
        "id": "c3097f04-6b98-4887-8d1f-6180356974b2",
        "casenumber":"20100315",
        "url":"https://app.incasso.io/cs/cs_WDqYK6vllg",
        "status":"SOM1",
        "saldo":"551.40",
        "ingangsdatum":"30-10-2020",
        "customer": {
            "Id": "ec9fed02-3c52-41ec-93dd-bad2f4d5b965",
            "Code": "1001",
            "name": "Test B.V."
            }
        },
        { },
        { },
        { }
        ]
}