Case Registration

Register new cases in the Amili system. Case registration is used for initiating collection matters, including customer information and associated invoices that require processing from the reminder stage onwards.

Case Registration endpoints

GET /case--registrations - List case registrations (paginated)
GET /case--registrations/{id} - Get a specific case registration
POST /case--registrations - Create a new case registration

See Case for accessing registered cases.

NOTE It is highly recommended to upload the original invoice of a case. Please refer to Media Upload for this.

Example Request

Below is an example of creating a new case registration. Other operations follow similar request/response patterns with the same data structure.

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"]
}

Parameters

Request Body Properties

Property	Type	Required	Description
`account`	string	Yes	Account ID
`creditor`	string	Yes	Creditor ID
`first_action`	string	Yes	Initial action (e.g. "debt_collection")*
`currency`	string	Yes	Currency code (currently only "SEK" supported)
`customer`	object	Yes	Customer information
`debts`	array	Yes	Array of debt objects

Customer Properties

Property	Type	Required	Description
`name`	string	Yes	Customer's full name
`id_number`	string	Yes**	Personal ID or organization number
`address`	object	Yes	Customer's address information
`mobile_number`	string	No	Contact phone number
`email`	string	No	Contact email address

Address Properties

Property	Type	Required	Description
`address_line_1`	string	Yes	Primary address line
`zip_code`	string	Yes	Postal code
`city`	string	Yes	City name
`country`	string	Yes*	Country code in ISO 3166-1 alpha-2 format (e.g. "SE")**

*) Not schema-required but functionally required for case initialization to succeed **) For complete list of values and details, please see Case Registration

Debt Properties

Property	Type	Required	Description
`invoice_number`	string	Yes	Invoice number from creditor
`debt_description`	string	Yes***	Description of the debt
`invoice_date`	string	Yes	Date invoice was issued
`capital_to_claim`	number	Yes	Capital amount to collect
`invoice_due_days_after_invoice_date`	number	Yes	Days until due date after invoice date
`fees_already_claimed`	object	No	Fees that have already been charged to the customer
`fees_already_claimed.reminder`	object	No	Reminder fee that has already been charged
`fees_already_claimed.reminder.amount`	number	Yes*	Reminder fee amount
`fees_already_claimed.reminder.fee_registration_date`	string	Yes*	Date when reminder fee was charged (RFC 1123 format)
`fees_already_claimed.debt_collection`	object	No	Debt collection fee that has already been charged
`fees_already_claimed.debt_collection.amount`	number	Yes*	Debt collection fee amount
`fees_already_claimed.debt_collection.fee_registration_date`	string	Yes*	Date when debt collection fee was charged (RFC 1123 format)
`fees_included_in_capital_to_claim`	object	No	Fees included in the capital_to_claim amount
`fees_included_in_capital_to_claim.invoice_fee`	number	No	Invoice fee included in capital_to_claim
`fees_included_in_capital_to_claim.shipment_fee`	number	No	Shipment fee included in capital_to_claim

* Required if the parent object is present

Fees Already Claimed

When registering a case where fees have already been charged to the customer (e.g., reminder fee or debt collection fee), these should be specified in the fees_already_claimed object. Each fee type requires both an amount and a fee_registration_date:

fees_already_claimed.reminder: Reminder fee that was already charged
- amount: The fee amount (required)
- fee_registration_date: Date when the reminder was sent (required, RFC 1123 format)
fees_already_claimed.debt_collection: Debt collection fee that was already charged
- amount: The fee amount (required)
- fee_registration_date: Date when the debt collection started (required, RFC 1123 format)

Fees Included in Capital

If fees from the original invoice are included in the capital_to_claim amount, they should also be specified in fees_included_in_capital_to_claim. This ensures proper accounting and breakdown of the total amount:

fees_included_in_capital_to_claim.invoice_fee: Invoice fee included in capital_to_claim
fees_included_in_capital_to_claim.shipment_fee: Shipment fee included in capital_to_claim

Example: If the original invoice was 2000 SEK + 50 SEK invoice fee, set capital_to_claim: 2050 and fees_included_in_capital_to_claim.invoice_fee: 50.

Response Properties

Property	Type	Required	Description
`_id`	string	Yes	Registration ID
`_created`	string	Yes	Creation timestamp
`_updated`	string	Yes	Last update timestamp
`_etag`	string	Yes	Entity tag for concurrency control
`_status`	string	Yes	Registration status (e.g. "OK")*
`_cases`	array	Yes	Array of created case IDs
`_ocr_numbers`	array	Yes	Array of OCR number IDs
`_ocr_numbers_ocr`	array	Yes	Array of actual OCR numbers

*) For complete list of values and details, please see Case Registration) Required for enforcement services *) Required for debt collection and enforcement services

Case Registration ​