Case

Få åtkomst till Cases i Amili-systemet. Cases representerar inkassoärenden med associerade fakturor, kundinformation och statusspårning.

Case Management endpoints

GET /cases - Lista alla cases (pagerad)
GET /cases/{caseId} - Hämta ett specifikt case

Se Case Registration och Invoice Registration för case-skapande.

Exempel Request

Nedan är ett exempel på att hämta ett specifikt case. Andra operationer följer liknande request/response-mönster med samma datastruktur.

URL: GET /cases/6867da7788b9226bb78d716c

Headers:

x-api-key: {your_access_token}
Content-Type: application/json

Request Body: Ingen (GET request)

Response Code: 200 OK

Response Body:

json

{
  "_id": "6867da7788b9226bb78d716c",
  "debt": {
    "invoice_number": "103118",
    "debt_reference": "1031186",
    "payout_reference": "1031186",
    "invoice_date": "Tue, 25 Jun 2025 00:00:00 GMT",
    "invoice_due_days_after_invoice_date": 30,
    "interest_days_after_invoice_date": 30,
    "initial_capital": 300.0,
    "capital_to_claim": 300.0,
    "debt_description": "Services"
  },
  "creditor": "671a133fc9e282cfad3ffeb6",
  "_created": "Mon, 30 Aug 2025 07:06:05 GMT",
  "_etag": "e291a3c19b834a11960187af",
  "_updated": "Mon, 30 Aug 2025 07:06:05 GMT",
  "agreement_version": "60e7fdefc90dc3e2ddd6c7ac",
  "case_registration": "60e7fdefc90dc3e2ddd6c7ad",
  "case_settings": {
    "interest_rate": {
      "reference_rate": true
    }
  },
  "creditor_name": "Integration team AB",
  "currency": "SEK",
  "customer": "60e7fdefc90dc3e2ddd6c7ae",
  "customer_id_number": "7766554433",
  "customer_name": "Integration team",
  "customer_number": "12345",
  "customer_status": "initialized",
  "latest_state_date": "Mon, 30 Aug 2025 07:06:05 GMT",
  "local_added_capital_amount": 300.0,
  "local_added_costs_amount": 0,
  "local_added_interest_amount": 0.0,
  "local_added_transaction_amount": 300.0,
  "local_remaining_capital_amount": 300.0,
  "local_remaining_costs_amount": 0,
  "local_remaining_interest_amount": 0.0,
  "local_remaining_transaction_amount": 300.0,
  "state": "initializing",
  "state_history": [
    {
      "state": "initializing",
      "status_date": "Mon, 30 Aug 2025 07:06:05 GMT"
    }
  ],
  "status": "initialized",
  "status_history": [
    {
      "status": "initializing",
      "status_date": "Mon, 30 Aug 2025 07:06:05 GMT"
    },
    {
      "status": "initialized",
      "status_date": "Mon, 30 Aug 2025 07:07:07 GMT"
    }
  ],
  "total_added_capital_amount": 300.0,
  "total_added_costs_amount": 0,
  "total_added_interest_amount": 0.0,
  "total_added_transaction_amount": 300.0,
  "total_remaining_capital_amount": 300.0,
  "total_remaining_costs_amount": 0,
  "total_remaining_interest_amount": 0.0,
  "total_remaining_transaction_amount": 300.0,
  "transactions": [
    {
      "bank_transaction_date": "Tue, 25 Jun 2025 00:00:00 GMT",
      "registration_date": "Mon, 30 Aug 2025 07:06:05 GMT",
      "origin": "creditor_system",
      "type": "capital",
      "description_locale_tag": "api.transaction.case_registration",
      "amount": 300.0
    }
  ],
  "reference_number": "123456",
  "original_invoice": {
    "id": "8be4d5fc86d77d226b0f83f8593de423",
    "filename": "original_invoice.pdf",
    "content_type": "application/pdf",
    "size": 358131
  }
}

Parametrar

Path Parameters

Namn	Typ	Obligatorisk	Beskrivning
`caseId`	string	Ja	Den unika identifieraren för case

Response Properties

Property	Typ	Obligatorisk	Beskrivning
`_id`	string	Ja	Unik identifierare för case
`_created`	string	Ja	Skapandetidsstämpel
`_updated`	string	Ja	Senaste uppdateringstidsstämpel
`_etag`	string	Ja	Entity tag för samtidighetskontroll
`creditor`	string	Ja	Creditor ID
`creditor_name`	string	Ja	Borgenärens namn
`customer`	string	Ja	Customer ID
`customer_name`	string	Ja	Kundens namn
`customer_id_number`	string	Ja	Kundens personnummer eller organisationsnummer
`customer_number`	string	Nej	Kundens referensnummer
`customer_status`	string	Ja	Nuvarande kundstatus (t.ex. "initialized")*
`reference_number`	string	Nej	Referensnummer från borgenär
`currency`	string	Ja	Valutakod (t.ex. "SEK")
`state`	string	Ja	Nuvarande tillstånd (t.ex. "initializing")*
`state_history`	array	Ja	Historik över tillståndsändringar
`status`	string	Ja	Nuvarande status (t.ex. "initialized")*
`status_history`	array	Ja	Historik över statusändringar
`latest_state_date`	string	Ja	Tidsstämpel för senaste tillståndsändring
`agreement_version`	string	Ja	Avtalsversions-ID
`case_registration`	string	Ja	Case Registration ID
`case_settings`	object	Ja	Case-specifika inställningar
`debt`	object	Ja	Skuldinformation
`transactions`	array	Ja	Lista över transaktioner
`total_added_capital_amount`	number	Ja	Totalt tillagt kapitalbelopp
`total_added_costs_amount`	number	Ja	Totalt tillagt kostnadsbelopp
`total_added_interest_amount`	number	Ja	Totalt tillagt räntebelopp
`total_added_transaction_amount`	number	Ja	Totalt tillagt transaktionsbelopp
`total_remaining_capital_amount`	number	Ja	Återstående kapitalbelopp
`total_remaining_costs_amount`	number	Ja	Återstående kostnadsbelopp
`total_remaining_interest_amount`	number	Ja	Återstående räntebelopp
`total_remaining_transaction_amount`	number	Ja	Återstående transaktionsbelopp
`local_added_capital_amount`	number	Ja	Tillagt kapitalbelopp i lokal valuta
`local_added_costs_amount`	number	Ja	Tillagt kostnadsbelopp i lokal valuta
`local_added_interest_amount`	number	Ja	Tillagt räntebelopp i lokal valuta
`local_added_transaction_amount`	number	Ja	Tillagt transaktionsbelopp i lokal valuta
`local_remaining_capital_amount`	number	Ja	Återstående kapitalbelopp i lokal valuta
`local_remaining_costs_amount`	number	Ja	Återstående kostnadsbelopp i lokal valuta
`local_remaining_interest_amount`	number	Ja	Återstående räntebelopp i lokal valuta
`local_remaining_transaction_amount`	number	Ja	Återstående transaktionsbelopp i lokal valuta
`original_invoice`	object	Nej	Originalfakturadokumentinformation

Debt Properties

Property	Typ	Obligatorisk	Beskrivning
`invoice_number`	string	Ja	Fakturanummer från borgenär
`debt_reference`	string	Nej	Referensnummer för skulden
`payout_reference`	string	Nej	Referens för utbetalningsspårning
`invoice_date`	string	Ja	Datum när fakturan utfärdades
`invoice_due_days_after_invoice_date`	number	Ja	Dagar till förfallodatum efter faktureringsdatum
`interest_days_after_invoice_date`	number	Ja	Dagar tills ränta börjar efter faktureringsdatum
`initial_capital`	number	Ja	Initialt kapitalbelopp
`capital_to_claim`	number	Ja	Kapitalbelopp att inkassera
`debt_description`	string	Ja	Beskrivning av skulden

Transaction Properties

Property	Typ	Obligatorisk	Beskrivning
`bank_transaction_date`	string	Ja	Datum för banktransaktion
`registration_date`	string	Ja	Datum när transaktionen registrerades
`origin`	string	Ja	Ursprung för transaktion (t.ex. "creditor_system")*
`type`	string	Ja	Typ av transaktion (t.ex. "capital")*
`description_locale_tag`	string	Ja	Lokaliserings-tagg för beskrivning
`amount`	number	Ja	Transaktionsbelopp

*) För komplett lista över värden och detaljer, se Case

Case ​

Case Management endpoints ​

Exempel Request ​

Parametrar ​

Path Parameters ​

Response Properties ​

Debt Properties ​

Transaction Properties ​