Amili API

Here you will find resources needed to implement an integration with the Amili API.

Jump straight to API Documentation for detailed references if you know what you're looking for.

If you are new to the API, we suggest you:

1. Read the Getting Started section, which provides simple use case descriptions and code examples
2. Continue with Common Concepts to understand authentication, pagination, and error handling
3. Review the Entity Relations to understand the data model
4. Take a closer look at the most central endpoints in the API

Getting Started

This section provides an overview of common use cases that an integration will likely implement. The central concepts and core endpoints described in the API reference are tied together in a logical sequence to give a more coherent view of the API.

Please refer to the endpoint references for detailed descriptions on core endpoints and related parameters.

Common Use Cases

The following use cases describe typical integration scenarios and their implementation sequences:

• Invoice Use Case - Describes the sequence and implementation for invoice creation, crediting, and cancellation
• Case Use Case - Describes the sequence and implementation for case registration where the debtor pays the full amount before the case is sent for debt collection

API Documentation

For the complete API specifications, refer to the swagger specifications below. You can also download our Postman collections to test the API endpoints directly.

Swagger specification

• Partner API: https://api-sandbox.amili.se/docs/partner
• Creditor API: https://api-sandbox.amili.se/docs/creditor

Postman Collections

• Download Partner API Collection
• Download Creditor API Collection

Common Concepts

Before diving into specific endpoints, it's important to understand the common concepts that apply across the entire API. This includes fundamental aspects like security, data retrieval patterns, error handling, and integration capabilities. Understanding these concepts will help you implement any endpoint effectively and follow best practices.

• Authentication
• Pagination and Queries
• Error Handling and Rate Limiting
• User Interface Integration

Endpoints

The following endpoints constitute the core the API and enable the implementation of central use cases.

Core Entities

Entity	Endpoint	Description
Partner	/partners	Manage the business entities that can handle multiple creditors. Partners represent system integrators or large organizations managing multiple creditors.
Account	/accounts	Manage business entities with their own settings, templates, and configurations for handling cases and agreements.
Creditor	/creditors	Manage businesses that use Amili for invoice and case management. A creditor belongs to either a partner or an account.
Case	/cases	Access collection matters with associated invoices, customer information, and status tracking.
Customer	/customers	Manage individuals or organizations associated with cases and invoices, including their contact details and address information.

Data Registration

Entity	Endpoint	Description
Invoice Registration	/invoice--registrations	Register new invoices for distribution by Amili. Creates invoice records and optionally associates them with cases.
Case Registration	/case--registrations	Register new cases for collection processing. Creates cases and associates them with customers and invoices.

File Management

Entity	Endpoint	Description
Media Upload	/media--upload	Upload and attach files to cases, primarily used for attaching original invoice documents to cases.

Payment and Transaction Management

Entity	Endpoint	Description
Creditor Payment	/creditor--payments	Record payments made directly to creditors against specific cases or invoices.
Creditor Cancellation	/creditor--cancellations	Cancel active cases or invoices when they no longer require processing.
Creditor Crediting	/creditor--creditings	Issue credits for cases, entire invoices, or partial invoice amounts.
Finance Payout Specification	/finance--payout-specifications	Configure and manage how collected funds are disbursed to creditors, including bank details and payout schedules.

User Management

Entity	Endpoint	Description
Users	/users	Manage user access to the system. Users can be associated with either partners or accounts to access their respective creditors.