Overview
This endpoint returns a paginated list of all debts owed by a specific debtor. You can filter and search the results using query parameters.Authentication
Requires a valid OAuth 2.0 access token with thedebts:read scope.
Example Request
curl -X GET "/external-api/v1/debts/by-debtor/def456ghi789?page=1&limit=50&status=active" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
const debtorId = 'def456ghi789';
const params = new URLSearchParams({
page: '1',
limit: '50',
status: 'active'
});
const response = await fetch(`/external-api/v1/debts/by-debtor/${debtorId}?${params}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
});
const debts = await response.json();
import requests
debtor_id = 'def456ghi789'
params = {
'page': 1,
'limit': 50,
'status': 'active'
}
headers = {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
response = requests.get(
f'/external-api/v1/debts/by-debtor/{debtor_id}',
headers=headers,
params=params
)
debts = response.json()
Success Response
{
"error": false,
"data": [
{
"id": "YOUR_DEBT_ID",
"civility": "Mr",
"firstname": "John",
"lastname": "Doe",
"phone": "+33123456789",
"email": "john.doe@example.com",
"birthdate": "1985-03-15",
"amount": 1250.00,
"amount_text": "1250.00",
"currency": "EUR",
"object": "Outstanding invoice #INV-2024-001",
"internal_id": "DEBT-2024-001",
"invoice_reference": "INV-2024-001",
"debtor_reference": "DEB-DOE-001",
"invoice_date": "2023-12-01",
"due_date": "2023-12-31",
"address": "123 Main Street, 75001 Paris, France",
"street_address": "Main Street",
"street_number": "123",
"postal_code": "75001",
"city": "Paris",
"country": "FR",
"status": "status.default.in_progress",
"timeline_id": "abc123def456",
"nb_reminders": 3,
"nb_answered": 1,
"summary": "Customer acknowledged debt, payment plan in discussion",
"iban": "FR1420041010050500013M02606",
"followups_count": 5,
"company": "Acme Corp",
"debtor_company": null,
"payment_link": null,
"import_date": "2024-01-15T10:30:00+00:00",
"last_timeline_restart": "2024-01-15T10:30:00+00:00",
"payment_plan_active": false,
"plan_start_date": null
},
{
"id": "def789xyz456",
"civility": "Mr",
"firstname": "John",
"lastname": "Doe",
"phone": "+33123456789",
"email": "john.doe@example.com",
"birthdate": "1985-03-15",
"amount": 750.00,
"amount_text": "750.00",
"currency": "EUR",
"object": "Service contract penalty",
"internal_id": "DEBT-2024-025",
"invoice_reference": "INV-2024-025",
"debtor_reference": null,
"invoice_date": "2024-01-01",
"due_date": "2024-01-31",
"address": null,
"street_address": "Main Street",
"street_number": "123",
"postal_code": "75001",
"city": "Paris",
"country": "FR",
"status": "status.default.pending",
"timeline_id": null,
"nb_reminders": 1,
"nb_answered": 0,
"summary": null,
"iban": "FR1420041010050500013M02606",
"followups_count": 2,
"company": "Service Plus SARL",
"debtor_company": null,
"payment_link": null,
"import_date": "2024-01-20T09:15:00+00:00",
"last_timeline_restart": null,
"payment_plan_active": false,
"plan_start_date": null
}
],
"pagination": {
"total": 3,
"page": 1,
"limit": 50,
"pages": 1
}
}
Error Responses
{
"error": true,
"message": "Authentication credentials are missing or invalid",
"code": 401
}
{
"error": true,
"message": "Required scope \"debts:read\" not found in token",
"code": 403
}
{
"error": true,
"message": "Debtor not found or not authorized",
"code": 404
}
{
"error": true,
"message": "Internal server error",
"code": 500
}
Rate Limiting
This endpoint is subject to rate limiting. See the Rate Limits documentation for details. Rate Limit: 1,000 requests per hourRelated Endpoints
- List All Debts - Get all debts for your company
- Get Debtor - Get debtor information
- List Debts by Creditor - Get all debts for a specific creditor