Account

Access account information in the Amili system. Accounts represent business entities with their own settings, templates, and configurations for handling cases and agreements. Each Account has at least one Creditor associated with it.

Account endpoints

• GET /accounts - List all accounts (paginated)
• GET /accounts/{accountId} - Get a specific account

See Creditor and Partner for related business entity endpoints.

Example Request

Below is an example of retrieving a specific account. Other operations follow similar request/response patterns with the same data structure.

URL: GET /accounts/674dbeaf08847b9501cc9132

Headers:

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

Request Body: None (GET request)

Response Code: 200 OK

Response Body:

{
  "_id": "674dbeaf08847b9501cc9132",
  "name": "Amili Integration Team",
  "description": "För diverse tester som utförs av integrationsteamet",
  "organization_no": "1122334455",
  "standard_debt_description": "Standard skuldbeskrivning på Konto",
  "agreement_template": "665d9246f611f5df88245746",
  "agreement_address": {
    "address_line_1": "Redaregatan 50",
    "zip_code": "25236",
    "city": "Helsingborg",
    "country": "SE"
  },
  "access_group_template": "65a961d89cbd399b9a0c7693",
  "_updated": "Thu, 22 May 2025 16:04:30 GMT",
  "_created": "Mon, 02 Dec 2024 14:05:35 GMT",
  "_etag": "7b074c6f2e95447ca16ecea01a3cc307",
  "case_settings": {
    "interest_rate": {
      "reference_rate": true
    }
  }
}

Parameters

Path Parameters

Name	Type	Required	Description
accountId	string	Yes	The unique identifier of the account

Response Properties

Property	Type	Required	Description
_id	string	Yes	Unique identifier for the account
_created	string	Yes	Creation timestamp
_updated	string	Yes	Last update timestamp
_etag	string	Yes	Entity tag for concurrency control
name	string	Yes	Account name
description	string	No	Account description
organization_no	string	Yes	Organization/company registration number
standard_debt_description	string	No	Default description for debts
agreement_template	string	Yes	Template ID for agreements
agreement_address	object	Yes	Primary business address
access_group_template	string	Yes	Template ID for access groups
case_settings	object	No	Default settings for cases

Agreement 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")*

Case Settings Properties

Property	Type	Required	Description
interest_rate	object	No	Interest rate configuration

Interest Rate Properties

Property	Type	Required	Description
reference_rate	boolean	Yes	Whether to use reference rate

*) For complete list of values and details, please see Account