Uppföljning av ärendestatus

Den här guiden täcker de tre huvudsakliga användningsfallen och tillvägagångssätten för att följa ärendestatus genom Amilis API. Beroende på ditt användningsfall kan du hämta enskilda ärenden, paginerade listor med öppna ärenden, eller periodiskt hämta stängda ärenden för avstämning.

Alla API-anrop kräver en giltig autentiseringstoken i X-API-Key-headern. För detaljer om autentiseringsprocessen och tokenhantering, se Autentiseringsdokumentationen.

I den här guiden använder vi klassen AuthTokenProvider (dokumenterad i autentiseringsguiden) för att hantera tokens.

Innehållsförteckning

Hämta aktuell ärendestatus — Hämta enskilda ärenden eller paginerade listor vid behov
Följ öppna ärenden — Periodisk batchexport av alla öppna ärenden
Följ stängda ärenden — Periodisk batchexport av stängda ärenden för avstämning

Hämta aktuell ärendestatus

När du behöver aktuell status för ett specifikt ärende — till exempel under en konversation med gäldenären, eller när du granskar ett ärende i ditt ärendehanteringssystem — fråga API:et direkt istället för att förlita dig på cachad eller periodiskt hämtad data.

Undvik att förlita dig på periodisk polling för aktuell status

Att hämta ärendedata på ett schema och lagra det lokalt introducerar inaktuell data. Ärendestatus kan ändras när som helst (betalningar, statusövergångar, stängningar), och att agera på inaktuell information riskerar felaktiga beslut, åtgärder eller kommunikation — särskilt gentemot gäldenärer.

API:et stöder också paginerade frågor med filtrering och sortering, vilket gör det väl lämpat för att integrera direkt i ditt ärendehanteringsgränssnitt. Du kan till exempel fråga efter alla öppna ärenden som tillhör en specifik borgenär och visa dem i en paginerad tabell — alltid med aktuell status utan behov av en lokal kopia.

Enskild ärendeuppslagning

Hämta statusinformation för ett specifikt ärende via Ärendeendpointen:

TypeScriptPython

typescript

const token = await auth.getValidToken()
const caseId = '6867da7788b9226bb78d716c'

const projection = encodeURIComponent(
  JSON.stringify({
    _id: 1,
    state: 1,
    status: 1,
    closed: 1,
    'debt.invoice_number': 1,
    total_remaining_capital_amount: 1,
  })
)

const response = await axios.get(
  `https://api-sandbox.amili.se/cases/${caseId}?projection=${projection}`,
  {
    headers: {
      'X-API-Key': token,
    },
  }
)

python

import json

token = auth.get_valid_token()
case_id = '6867da7788b9226bb78d716c'

projection = json.dumps({
    '_id': 1,
    'state': 1,
    'status': 1,
    'closed': 1,
    'debt.invoice_number': 1,
    'total_remaining_capital_amount': 1,
})

response = requests.get(
    f'https://api-sandbox.amili.se/cases/{case_id}',
    params={'projection': projection},
    headers={'X-API-Key': token}
)
response.raise_for_status()
result = response.json()

Exempelsvar:

json

{
  "_id": "6867da7788b9226bb78d716c",
  "debt": {
    "invoice_number": "INV-2025-003"
  },
  "state": "debt_collection",
  "status": "debt_collection_active",
  "total_remaining_capital_amount": 2050.0
}

Följ öppna ärenden

För periodisk rapportering och portföljöversikt rekommenderar vi en schemalagd batchfråga av alla öppna ärenden. Detta ger dig en fullständig bild av utestående skulder, aktuella tillstånd och återstående kapital i din portfölj vid en specifik tidpunkt.

TypeScriptPython

typescript

const token = await auth.getValidToken()

const where = encodeURIComponent(JSON.stringify({ closed: { $exists: false } }))
const projection = encodeURIComponent(
  JSON.stringify({
    _id: 1,
    state: 1,
    status: 1,
    'debt.invoice_number': 1,
    total_remaining_capital_amount: 1,
  })
)

const response = await axios.get(
  `https://api-sandbox.amili.se/cases?where=${where}&projection=${projection}&sort=-_created&max_results=50`,
  {
    headers: {
      'X-API-Key': token,
    },
  }
)

python

import json

token = auth.get_valid_token()

where = json.dumps({'closed': {'$exists': False}})
projection = json.dumps({
    '_id': 1,
    'state': 1,
    'status': 1,
    'debt.invoice_number': 1,
    'total_remaining_capital_amount': 1,
})

response = requests.get(
    'https://api-sandbox.amili.se/cases',
    params={
        'where': where,
        'projection': projection,
        'sort': '-_created',
        'max_results': 50,
    },
    headers={'X-API-Key': token}
)
response.raise_for_status()
result = response.json()

Exempelsvar:

json

{
  "_items": [
    {
      "_id": "6867da7788b9226bb78d716c",
      "debt": { "invoice_number": "INV-2025-003" },
      "state": "debt_collection",
      "status": "debt_collection_active",
      "total_remaining_capital_amount": 2050.0
    },
    {
      "_id": "68a1bc3388b9226bb78d8a2f",
      "debt": { "invoice_number": "INV-2025-010" },
      "state": "reminder",
      "status": "reminder_sent",
      "total_remaining_capital_amount": 1200.0
    }
  ],
  "_meta": {
    "page": 1,
    "max_results": 50,
    "total": 87
  }
}

Ärendetillstånd

Fältet state anger den aktuella statusen för ett öppet ärende:

State	Beskrivning
`reminder`	Påminnelse skickad, inväntar betalning
`debt_collection`	Under aktiv inkasso
`enforcement`	Hos Kronofogden
`debt_surveillance`	Långsiktig skuldbevakning
`amortization`	Betalningsplan aktiv
`dispute`	Under tvist
`estate`	Dödsboförvaltning
`bankruptcy_estate`	Gäldenären försatt i konkurs, konkursbo under förvaltning

Följ stängda ärenden

För avstämning och intern rapportering rekommenderar vi en periodisk batchfråga av nyligen stängda ärenden. Ärenden kan stängas av många olika anledningar — vissa resulterar i utbetalningar, medan andra representerar förluster som bör skrivas av internt.

Spåra utbetalningar för betalda ärenden

Ärenden stängda med en fully_paid*-anledning resulterar i en ekonomisk avräkning. Se guiden Ekonomi & utbetalningshantering för våra rekommendationer om hur du spårar och avräknar dessa utbetalningar.

Använd fältet closed.close_date med operatorn $gt för att inkrementellt hämta ärenden stängda sedan din senaste fråga. Lagra senast hämtade datumet för framtida frågor, för att undvika duplicerad eller missad data.

TypeScriptPython

typescript

const token = await auth.getValidToken()

const where = encodeURIComponent(
  JSON.stringify({
    'closed.close_date': { $gt: 'Mon, 13 Jan 2026 00:00:00 GMT' },
  })
)
const projection = encodeURIComponent(
  JSON.stringify({
    _id: 1,
    closed: 1,
    'debt.invoice_number': 1,
    total_remaining_capital_amount: 1,
  })
)

const response = await axios.get(
  `https://api-sandbox.amili.se/cases?where=${where}&projection=${projection}&sort=-closed.close_date&max_results=50`,
  {
    headers: {
      'X-API-Key': token,
    },
  }
)

python

import json

token = auth.get_valid_token()

where = json.dumps({
    'closed.close_date': {'$gt': 'Mon, 13 Jan 2026 00:00:00 GMT'},
})
projection = json.dumps({
    '_id': 1,
    'closed': 1,
    'debt.invoice_number': 1,
    'total_remaining_capital_amount': 1,
})

response = requests.get(
    'https://api-sandbox.amili.se/cases',
    params={
        'where': where,
        'projection': projection,
        'sort': '-closed.close_date',
        'max_results': 50,
    },
    headers={'X-API-Key': token}
)
response.raise_for_status()
result = response.json()

Exempelsvar:

json

{
  "_items": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "debt": { "invoice_number": "INV-2025-020" },
      "closed": {
        "close_date": "Wed, 03 Sep 2025 11:18:59 GMT",
        "reason": "fully_paid"
      },
      "total_remaining_capital_amount": 0
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "debt": { "invoice_number": "INV-2025-019" },
      "closed": {
        "close_date": "Tue, 02 Sep 2025 14:22:15 GMT",
        "reason": "recalled"
      },
      "total_remaining_capital_amount": 1500.5
    },
    {
      "_id": "507f1f77bcf86cd799439013",
      "debt": { "invoice_number": "INV-2025-018" },
      "closed": {
        "close_date": "Mon, 01 Sep 2025 09:45:30 GMT",
        "reason": "bankruptcy"
      },
      "total_remaining_capital_amount": 2500.0
    }
  ],
  "_meta": {
    "page": 1,
    "max_results": 50,
    "total": 142
  }
}

Stängningsorsaker

Fältet closed.reason anger varför ett ärende stängdes. Orsakerna delas in i två kategorier:

Betald — skulden har reglerats och kommer att resultera i en utbetalning:

Orsak	Beskrivning
`fully_paid`	Fullt betald av gäldenären
`fully_paid_depreciation`	Fullt betald med avskrivning tillämpad
`fully_paid_before_reminder`	Betald före påminnelsestadiet
`fully_paid_before_debt_collection`	Betald före inkassostadiet
`capital_paid_to_creditor`	Kapital betalt direkt till borgenären

Obetald — skulden återkrävdes inte; dessa ärenden bör normalt rapporteras som förluster:

Orsak	Beskrivning
`bankruptcy`	Gäldenären försatt i konkurs
`deceased`	Gäldenären avliden
`recalled`	Återkallad av borgenären
`credit`	Krediterad av borgenären
`cancellation`	Annullerad
`dispute`	Stängd efter tvistlösning
`written_off`	Avskriven
`debt_restructuring`	Stängd på grund av skuldsanering
`resubmit_invoice`	Stängd för att skickas in på nytt som ett nytt ärende
`migrated`	Migrerad till ett annat system

Relaterad dokumentation

Ärendeendpointreferens — Fullständiga fältbeskrivningar och ärendeegenskaper
Paginering och frågor — Avancerad filtrering, sortering och paginering
Borgenärsåtgärder — Registrera betalningar, krediteringar, annulleringar och anstånd
Ekonomi & utbetalningshantering — Följ utbetalningsspecifikationer och ekonomiska avräkningar

Uppföljning av ärendestatus ​

Hämta aktuell ärendestatus ​

Enskild ärendeuppslagning ​

Följ öppna ärenden ​

Ärendetillstånd ​

Följ stängda ärenden ​

Stängningsorsaker ​

Relaterad dokumentation ​

Uppföljning av ärendestatus

Hämta aktuell ärendestatus

Enskild ärendeuppslagning

Följ öppna ärenden

Ärendetillstånd

Följ stängda ärenden

Stängningsorsaker

Relaterad dokumentation