Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{
"error": false,
"message": "Success",
"data": {
"id": "abc123def456",
"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": "YOUR_TIMELINE_ID",
"nb_reminders": 3,
"nb_answered": 1,
"summary": "Customer acknowledged debt, payment plan in discussion",
"iban": "FR1420041010050500013M02606",
"followups_count": 5,
"company": "Acme Corp",
"debtor_company": "ACME Corporation",
"payment_link": "https://pay.example.com/debt/abc123",
"import_date": "2023-11-15T10:30:00+00:00",
"last_timeline_restart": "2023-12-01T09:00:00+00:00",
"payment_plan_active": false,
"plan_start_date": null
}
}
Retrieve detailed information about a specific debt
debts:read scope.
curl -X GET "/external-api/v1/debts/abc123def456" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"
const debtId = 'abc123def456';
const response = await fetch(`/external-api/v1/debts/${debtId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
});
const debt = await response.json();
debt_id = 'abc123def456'
headers = {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
response = requests.get(
f'/external-api/v1/debts/{debt_id}',
headers=headers
)
debt = response.json()
{
"error": false,
"message": "Success",
"data": {
"id": "abc123def456",
"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": "YOUR_TIMELINE_ID",
"nb_reminders": 3,
"nb_answered": 1,
"summary": "Customer acknowledged debt, payment plan in discussion",
"iban": "FR1420041010050500013M02606",
"followups_count": 5,
"company": "Acme Corp",
"debtor_company": "ACME Corporation",
"payment_link": "https://pay.example.com/debt/abc123",
"import_date": "2023-11-15T10:30:00+00:00",
"last_timeline_restart": "2023-12-01T09:00:00+00:00",
"payment_plan_active": false,
"plan_start_date": null
}
}
{
"error": true,
"message": "Authentication credentials are missing or invalid",
"code": 401
}
{
"error": true,
"message": "Access denied to this debt",
"code": 403
}
{
"error": true,
"message": "Debt not found or invalid ID",
"code": 404
}