Welcome! This guide will help you quickly get up and running with the Debbie Creditor API.
1. Get access to the creditor portal
Your debt collection partner will invite you to the creditor portal. If you do not have access yet, please reach out to them.
2. Create an API key
In the creditor portal, navigate to the Developer section in the menu. From there, you can create a new API key and select the scopes it should have access to.
The API key is only shown once, when it is created. Store it in a safe place.
On the same page you will find your tenantId and creditorId. You will need both when calling the API — the tenantId is part of every URL, and the creditorId identifies you as the creditor.
3. Understand the core concepts
Before diving into the endpoints, we recommend reading the Core Concepts section to familiarize yourself with how customers, cases and case vouchers fit together.
4. Build your integration
For a typical ERP integration you only need two endpoints:
- Create customer — create the customer with the debtor’s contact details.
- Add case vouchers — send the unpaid invoices and fees for collection.
The platform automatically determines when to create a new case or update an existing one.