Dokumentation - InkassoAPI

Introduktion

InkassoAPI tillhandahåller en modern plattform för att söka, hämta och ladda upp inkassodokument. Används både av privatpersoner och inkassobolag.

1. Autentisering

Alla anrop kräver en personlig API-nyckel som du får genom att kontakta [email protected].

2. API-Endpoints

GET /user/:apiKey

Beskrivning: Validerar API-nyckeln och returnerar kundinformation.

Exempel:

GET https://request.inkassoapi.se/user/abc123xyz

Exempelsvar:

{
  "customerId": "123456-7890",
  "customerType": "inDebt"
}

Fel: 403 Forbidden om API-nyckeln är ogiltig.

GET /search-active/:apiKey

Beskrivning: Returnerar antal aktiva fakturor för användaren (fakturor som inte passerat förfallodatum).

Exempel:

GET https://request.inkassoapi.se/search-active/abc123xyz

Exempelsvar:

{
  "activeInvoicesCount": 3
}

Fel: 403 Forbidden om API-nyckeln är ogiltig.

GET /documents/:apiKey

Beskrivning: Returnerar en lista över alla fakturor kopplade till kunden (både aktiva och passerade).

Exempel:

GET https://request.inkassoapi.se/documents/abc123xyz

Exempelsvar:

[
  {
    "documentId": "doc123",
    "debtCollectionCompanyId": "556677-8899",
    "fromDate": "2024-01-10",
    "toDate": "2024-02-10",
    "debtAmount": "2500"
  },
  {
    "documentId": "doc456",
    "debtCollectionCompanyId": "556677-8899",
    "fromDate": "2024-02-01",
    "toDate": "2024-03-01",
    "debtAmount": "4500"
  }
]

Fel: 403 Forbidden om API-nyckeln är ogiltig.

POST /upload-document/:apiKey

Beskrivning: Laddar upp ett nytt inkassodokument (endast tillgängligt för inkassobolag).

Formdata som krävs:

file: PDF-filen som ska laddas upp
legalPersonId: Personnummer eller organisationsnummer för gäldenären
fromDate: Fakturans utskicksdatum (ÅÅÅÅ-MM-DD)
toDate: Fakturans förfallodatum (ÅÅÅÅ-MM-DD)
debtAmount: Beloppet på fakturan (i svenska kronor)

Exempel:

POST https://request.inkassoapi.se/upload-document/abc123xyz

Exempelsvar:

Upload successful

Fel:

403 Forbidden - Endast inkassobolag kan ladda upp
400 Bad Request - Saknade eller felaktiga fält
500 Server Error - Internt serverfel

3. Definitioner

Dokument = Fakturans ID i systemet
Inkassobolag = Bolag som hanterar fordran
Utskickat = Datum då fakturan skickades till kund
Förfallodatum = Sista betalningsdatum för fakturan
Belopp = Fakturabelopp i kronor

4. Support

Behöver du hjälp? Kontakta oss på [email protected].