Case Registration

Registrera nya Cases i Amili-systemet. Case Registration används för att initiera inkassoärenden, inklusive kundinformation och associerade fakturor som kräver bearbetning från påminnelsestadiet och framåt.

Case Registration endpoints

GET /case--registrations - Lista case registrations (pagerad)
GET /case--registrations/{id} - Hämta en specifik case registration
POST /case--registrations - Skapa en ny case registration

Se Case för att få åtkomst till registrerade cases.

OBS Det rekommenderas starkt att ladda upp originalfakturan för ett case. Se Media Upload för detta.

Exempel Request

Nedan är ett exempel på att skapa en ny case registration. Andra operationer följer liknande request/response-mönster med samma datastruktur.

URL: POST /case--registrations

Headers:

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

Request Body:

json

{
  "account": "674dbeaf08847b9501cc9132",
  "creditor": "674dbeb208847b9501cc9138",
  "first_action": "debt_collection",
  "currency": "SEK",
  "customer": {
    "name": "Jane Doe",
    "id_number": "202501012385",
    "address": {
      "address_line_1": "Business Street 456",
      "zip_code": "54321",
      "city": "Gothenburg",
      "country": "SE"
    },
    "mobile_number": "+46709876543",
    "email": "jane.doe@domain.se"
  },
  "debts": [
    {
      "invoice_number": "778899",
      "debt_description": "Consulting fee",
      "invoice_date": "Mon, 16 Jun 2025 00:00:00 GMT",
      "capital_to_claim": 250.0,
      "invoice_due_days_after_invoice_date": 10
    }
  ]
}

Response Code: 201 Created

Response Body:

json

{
  "_updated": "Fri, 04 Jul 2025 13:43:19 GMT",
  "_created": "Fri, 04 Jul 2025 13:43:19 GMT",
  "_etag": "fb0b598d816eaa0085492ba22c7876ecd06f3764",
  "_id": "6867da77eaa52b3ff595b5a5",
  "_status": "OK",
  "_cases": ["6867da7788b9226bb78d716c"],
  "_ocr_numbers": ["6867da77eaa52b3ff595b5aa"],
  "_ocr_numbers_ocr": ["20251852687013699044"]
}

Parametrar

Request Body Properties

Property	Typ	Obligatorisk	Beskrivning
`account`	string	Ja	Account ID
`creditor`	string	Ja	Creditor ID
`first_action`	string	Ja	Initial åtgärd (t.ex. "debt_collection")*
`currency`	string	Ja	Valutakod (för närvarande endast "SEK" stöds)
`customer`	object	Ja	Kundinformation
`debts`	array	Ja	Array av skuldobjekt

Customer Properties

Property	Typ	Obligatorisk	Beskrivning
`name`	string	Ja	Kundens fullständiga namn
`id_number`	string	Ja**	Personnummer eller organisationsnummer
`address`	object	Ja	Kundens adressinformation
`mobile_number`	string	Nej	Kontakttelefonnummer
`email`	string	Nej	Kontakt-e-postadress

Address Properties

Property	Typ	Obligatorisk	Beskrivning
`address_line_1`	string	Ja	Primär adressrad
`zip_code`	string	Ja	Postnummer
`city`	string	Ja	Stad
`country`	string	Ja*	Landskod i ISO 3166-1 alpha-2 format (t.ex. "SE")**

*) Inte schema-obligatorisk men funktionellt obligatorisk för att case-initialisering ska lyckas **) För komplett lista över värden och detaljer, se Case Registration

Debt Properties

Property	Typ	Obligatorisk	Beskrivning
`invoice_number`	string	Ja	Fakturanummer från borgenär
`debt_description`	string	Ja***	Beskrivning av skulden
`invoice_date`	string	Ja	Datum när fakturan utfärdades
`capital_to_claim`	number	Ja	Kapitalbelopp att inkassera
`invoice_due_days_after_invoice_date`	number	Ja	Dagar till förfallodatum efter fakturadatum
`fees_already_claimed`	object	Nej	Avgifter som redan har debiterats kunden
`fees_already_claimed.reminder`	object	Nej	Påminnelseavgift som redan har debiterats
`fees_already_claimed.reminder.amount`	number	Ja*	Påminnelseavgiftens belopp
`fees_already_claimed.reminder.fee_registration_date`	string	Ja*	Datum när påminnelseavgiften debiterades (RFC 1123 format)
`fees_already_claimed.debt_collection`	object	Nej	Inkassoavgift som redan har debiterats
`fees_already_claimed.debt_collection.amount`	number	Ja*	Inkassoavgiftens belopp
`fees_already_claimed.debt_collection.fee_registration_date`	string	Ja*	Datum när inkassoavgiften debiterades (RFC 1123 format)
`fees_included_in_capital_to_claim`	object	Nej	Avgifter inkluderade i capital_to_claim beloppet
`fees_included_in_capital_to_claim.invoice_fee`	number	Nej	Fakturaavgift inkluderad i capital_to_claim
`fees_included_in_capital_to_claim.shipment_fee`	number	Nej	Fraktavgift inkluderad i capital_to_claim

* Obligatorisk om föräldraobjektet finns

Avgifter som redan debiterats

När du registrerar ett ärende där avgifter redan har debiterats kunden (t.ex. påminnelseavgift eller inkassoavgift), ska dessa anges i fees_already_claimed-objektet. Varje avgiftstyp kräver både ett amount och ett fee_registration_date:

fees_already_claimed.reminder: Påminnelseavgift som redan har debiterats
- amount: Avgiftsbeloppet (obligatorisk)
- fee_registration_date: Datum när påminnelsen skickades (obligatorisk, RFC 1123 format)
fees_already_claimed.debt_collection: Inkassoavgift som redan har debiterats
- amount: Avgiftsbeloppet (obligatorisk)
- fee_registration_date: Datum när inkassoprocessen startade (obligatorisk, RFC 1123 format)

Avgifter inkluderade i kapital

Om avgifter från originalfakturan är inkluderade i capital_to_claim-beloppet, ska de också anges i fees_included_in_capital_to_claim. Detta säkerställer korrekt redovisning och uppdelning av totalbeloppet:

fees_included_in_capital_to_claim.invoice_fee: Fakturaavgift inkluderad i capital_to_claim
fees_included_in_capital_to_claim.shipment_fee: Fraktavgift inkluderad i capital_to_claim

Exempel: Om originalfakturan var 2000 SEK + 50 SEK fakturaavgift, sätt capital_to_claim: 2050 och fees_included_in_capital_to_claim.invoice_fee: 50.

Response Properties

Property	Typ	Obligatorisk	Beskrivning
`_id`	string	Ja	Registration ID
`_created`	string	Ja	Skapandetidsstämpel
`_updated`	string	Ja	Senaste uppdateringstidsstämpel
`_etag`	string	Ja	Entity tag för concurrency control
`_status`	string	Ja	Registreringsstatus (t.ex. "OK")*
`_cases`	array	Ja	Array av skapade case ID:n
`_ocr_numbers`	array	Ja	Array av OCR-nummer ID:n
`_ocr_numbers_ocr`	array	Ja	Array av faktiska OCR-nummer

*) För komplett lista över värden och detaljer, se Case Registration) Obligatorisk för enforcement services *) Obligatorisk för debt collection och enforcement services

Case Registration ​