Receivables API

Receivables API is used for integrating to debt collection and reminder services via Maventa. These services help to automate the debt collection process and are currently available for Finnish customers. Read more about the services:

• Integration guide: Amili Kassavirta
• Integration guide: Amili Perintä

Detailed technical information in Swagger: Receivables API technical documentation

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

To activate the service

• Use PUT /v2/services/amili/receivables to initiate the activation of Receivables Management service.
• Use GET /v2/services/amili/receivables to fetch the status of the activation to see when the service is activated. Or register a webhook to get a event from Maventa when the service gets activated (or rejected).
• Use PATCH /v2/services/amili/receivables to change the setting for using own invoice image and own payments details with the service

Assignments and events

• Use GET /v1/assignments to list and get all the assignments and their events based on given filtering parameters (e.g. debtor name, assignment creation date, closing date..).
• Use GET /v1/assignments/{assignment_id} to fetch one assignment and it’s events.
• Use GET /v1/assignments/{assignment_id}/events to fetch only events related to the one assignment.
• Use GET /v1/assignments/overview to fetch an overview of assignments (how many assignments are all together open, how many are soon to due and how many are already dued. See an example implementation)
• Use POST /v1/assignments/{assignment_id}/events to add a new event to an assignment (e.g. mark direct payment, request due date change, cancel assignment..)
• Use POST /v1/assignments/{assignment_id}/events/{event_id}/seen to mark event as seen
• Use GET /v1/events to list assignment events

Service levels

• Use GET /v1/service_levels to list the service levels for all of your customers. This method will only return customers that have a special service level set (premium, vip or service_bypass), the default service level is named “default” and that applies to every customer that does not have a service level. There is no way to list customers with the default service level.
• Use GET /v1/service_levels/{customer_bid} to get service level for specific customer (with customer bid)
• Use PATCH /v1/service_levels/{customer_bid} to set service level for customer (with customer bid)

Messaging functionality

Messaging functionality is used for the communication between Visma Amili and the customer. It is highly recommended to add this functionality as part of the integration to make sure both parties have a functional discussion connection and important messages do not get lost.

• Use GET /v1/message_threads to lists all the message threads (shown latest message from each of the message thread)
• Use PATCH /v1/message_threads/{thread_id} to flag a message thread
• Use GET /v1/message_threads/{thread_id} to show message thread information (shows only the latest message)
• Use GET /v1/message_threads/{thread_id}/messages to show all the messages inside a message thread
• Use POST /v1/message_threads/{thread_id}/messages to add a message to a message thread
• Use POST /v1/assignments/{assignment_id}/messages to add a message for an assignment (this will create message thread if one does not exist yet, or add a new message to an existing message thread)
• Use GET /v1/assignments/{assignment_id}/messages to show all the messages for an assignment
• Use PUT /v1/messages/{message_id}/seen to mark a message as seen

Try it out with Swagger