Get Case API

Haal met een simpele API call de inhoudelijke informatie van je incassozaken op.

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

Met de Get Case API kan je realtime informatie over een specifieke 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 Cases API

Request

Het opvragen van de gegevens gaat met de id van de incassozaak, deze kan worden gevonden met de List Cases API en wordt ook aangeleverd via de webhook. Gebruik voor het opvragen van de informatie de endpoint-url https://api.incasso.io/v2/cases/*id*

Parameters

Vervang id in de URL door de uid van de incassozaak, bijvoorbeeld,cs_7UhSN1zuXS.

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.

InvoiceTotal Het totaalbedrag (som) van de facturen welke zijn aangeboden vanuit jouw administratie.

CostTotal Het totaalbedrag (som) van de kosten in het dossier. Hierin zitten o.a. de incassokosten en eventuele deurwaarderskosten.

Paid Het bedrag dat door ons is geïncasseerd bij de debiteur.

Balance Het hudige saldo van de incassozaak.

Cleared Het bedrag wat reeds aan u is uitgekeerd.

Available Het bedrag wat momenteel beschikbaar is voor uitkering. Afhankelijk van de afspraken zal dit bedrag aan u worden uitgekeerd en vervolgens worden opgeteld bij het bedrag TTA.

Created De ingangsdatum van de incassozaak.

LastAction + LastActionDate De omschrijving en de datum van de laatste actie welke in de incassozaak is uitgevoerd.

NextAction + NextActionDate De omschrijving en de datum van de eerstvolgende actie welke in de incassozaak is zal worden uitgevoerd.

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 voorbeelden

cURL

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

PHP

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

ASP

<%
Set IncassoApi = New IncassoApiClient
IncassoApi.setApiKey("dHar4XY7LxsDOtmnkVtjNVWXLSlXsM")
Createdebtcollection = IncassoApi.getcase("cs_WDqYK6vllg")
%>

Response

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

{
        "resource": "case",
        "id": "c3097f04-6b98-4887-8d1f-6180356974b2",
        "casenumber":"20100315",
        "url":"https://app.incasso.io/cs/c3097f04-6b98-4887-8d1f-6180356974b2",
        "status":"SOM1",
        "InvoiceTotal":"480.00",
        "CostTotal":"50.00",
        "Paid":"200.00",
        "Balance":"330.00",
        "Cleared":"50.00",
        "Available":"100.00",
        "Created":"30-10-2020",
        "LastAction":"1e sommatie verzonden",
        "LastActionDate":"15-11-2020",
        "NextAction":"Beoordeling dossier door incassospecialist",
        "NextActionDate":"02-12-2020"
}