Collection Actions

The API returns company's collection actions in JSON format, as specified by business id or duns number.

In order to use the API you must have the valid environment-specific username and password. Before any API requests, you need to obtain an API KEY. You will get a valid API KEY (it's called a ticket) by using the ticket API (Please, read how to use ticket API instructions).

The API KEY must be sent in the request custom header element (named ticket or x-api-key). If the API KEY value is valid then API request will be successful (http status code 200), otherwise it will fail (http status code 401). All API requests must be made over HTTPS. Request the username and password

API endpoints

  • production environment
  • test environment

API request parameters

id Business id or duns number X


API response

businessId Company's business id
collectionActionDate Company's collection action date
amount Collected amount
numberOfInvoices Number of invoices
incidentId Incident id
remarkCode Remark code
collectionActionDueDate Collection action due date
collectionActionPaidDate Collection action paid date
collectingCompany Collecting Company

curl '' -H 'x-api-key: 1234567890ABC'

Successful request and the API return results in JSON format. 

  "businessId": "2014838-7",
  "dunsNumber": "539506084",
  "bondNotices": [
      "collectionActionDate": "2017-09-12T00:00:00Z",
      "amount": 994.82,
      "numberOfInvoices": 2,
      "incidentId": "T64178301",
      "remarkCode": null,
      "collectionActionDueDate": "2017-07-12T00:00:00Z",
      "collectionActionPaidDate": null,
      "collectingCompany": "Lindorff Oy"


SWAGGER - Developer REST API documentation - read more »

Please note that data coverage varies between companies. Data coverage depends e.g. on company form. Remember the codes and descriptions API returns all companies REST APIs code values and descriptions - read more.