Receivables API

The Receivables API provides a shared set of endpoints for tracking assignments and events across all of Maventa’s debt collection and reminder services. Regardless of which service is used — Ropo, Amili Kassavirta, or Amili Perintä — the same API is used to list assignments, follow collection status, and report payments or credit notes.

Service-specific operations such as activation, configuration, and invoice transfers use dedicated endpoints in the AutoXChange API. See each integration guide for details:

• Ropo’s reminder and collection service — available in Finland, Sweden, and Norway
• Amili Kassavirta — available in Finland
• Amili Perintä — available in Finland

Detailed technical information in Swagger: Receivables API technical documentation

For using the Receivables API, the authentication scope receivables:assignments is required.

Assignments and events All services

These endpoints are shared across all services. Each invoice that enters the collection process creates an assignment. Events on assignments track status changes, payments, reminders, and other collection activities.

• GET /v1/assignments — list assignments with filtering (debtor name, creation date, closing date, etc.)
• GET /v1/assignments/{assignment_id} — fetch a specific assignment and its events
• GET /v1/assignments/{assignment_id}/events — fetch only the events for an assignment
• GET /v1/assignments/overview — fetch an overview of assignments (open, soon to due, overdue)
• POST /v1/assignments/{assignment_id}/events — add an event to an assignment (direct payment, credit note, due date change, cancellation, etc.)
• POST /v1/assignments/{assignment_id}/events/{event_id}/seen — mark an event as seen
• GET /v1/events — list assignment events across all assignments

Service levels Amili Kassavirta only

Service levels allow you to set different collection behaviours per customer. Only applicable to Amili Kassavirta.

• GET /v1/service_levels — list customers with a non-default service level (premium, vip, or service_bypass). Customers with the default service level are not returned.
• GET /v1/service_levels/{customer_bid} — get the service level for a specific customer
• PATCH /v1/service_levels/{customer_bid} — set the service level for a specific customer

Messaging Amili Kassavirta and Amili Perintä only

Messaging enables communication between the sender and Visma Amili. Adding messaging support to the integration is highly recommended to ensure important messages are not missed.

• GET /v1/message_threads — list all message threads (shows the latest message from each thread)
• PATCH /v1/message_threads/{thread_id} — flag a message thread
• GET /v1/message_threads/{thread_id} — show message thread information (latest message only)
• GET /v1/message_threads/{thread_id}/messages — show all messages in a thread
• POST /v1/message_threads/{thread_id}/messages — add a message to a thread
• POST /v1/assignments/{assignment_id}/messages — add a message for an assignment (creates a thread if none exists)
• GET /v1/assignments/{assignment_id}/messages — show all messages for an assignment
• PUT /v1/messages/{message_id}/seen — mark a message as seen

Try it out with Swagger