API Documentation

Getting started

e-inkasso's API v2 is a JSON-based REST API, which is easy to work with.

Please note, that the API is an early stage and therefore might change over the course of the next months. We furthermore look forward to extend the documentation with more information about resources and error messages.

Base endpoint

The API is located at https://secure.e-inkasso.dk/api/v2.
SSL is required for all requests.

HTTP Headers

The API requires the following Content-Type header to be present on all POST requests:

Content-Type: application/x-www-form-urlencoded

Please note, that the content has be encoded accordingly as well.

Glossary

Profile
Profiles are what we refer to as "Konto".
They can either be of type business, private or pro.

Client
A client is a profile that is directly related to another profile. Only PRO profiles can have clients.

Authentication

How to create an App- and AuthKey

Follow these steps on how to create an App- and AuthKey.

  1. Login to our website.
  2. Open the menu "Indstillinger" and click on the now visible menuitem "API-nøgler".
  3. Click on "Ny API-nøgle".
  4. Enter a meaningful name for your AuthKey.
  5. Click on "Gem API-nøgle".
  6. The page will now reload and show your key with an auto-generated AuthKey in the list.
Basic access authentication

The API currently only supports Basic access authentication.
Simply base64-encode your App- and AuthKey and include the resulting string in an authorization header like this: 

Authorization: Basic [encoded_keys]

Status Codes

The API uses standard HTTP status codes for its responses. You can find a list of them here.

Successful request

Every successful request contains the following parameters.

Parameter Description
status The Status Code of the response.
resource The requested resource. Either an array of Resources or a single Resource.
total_execution_time The time it took the server to process your request.
Failed request

Every failed request contains the following parameters.

Parameter Description
status The Status Code of the response.
description A generic description of the error.
errors An array of more detailed error messages (e.g. validation errors).
total_execution_time The time it took the server to process your request.

Resources

Here you can find definitions of the currently available resources and their respective properties and data types.

Customer
Case
Invoice
Payment
Reminder
Profile

Endpoints

Customers

Cases

Invoices

Payments

Reminders

Clients

This endpoint is only available for PRO profiles. If you don't have a PRO profile, you will receive a 403 Forbidden response.