GET
/
external-api
/
v1
/
debts
/
{id}
Get Debt
curl --request GET \
  --url https://getbill.io/external-api/v1/debts/{id} \
  --header 'Authorization: <authorization>'
{
  "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_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": "xyz789abc123",
    "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"
  }
}

​
Overview

This endpoint returns comprehensive information about a single debt, including all related data such as followup history, payment status, and debtor details.

​
Authentication

Requires a valid OAuth 2.0 access token with the debts:read scope.

​
Request

​
Authorization
string
required
Bearer token for authentication
​
id
string
required
The encrypted ID of the debt to retrieve

​
Example Request

curl -X GET "/external-api/v1/debts/abc123def456" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

​
Response

​
error
boolean
Always false for successful requests
​
message
string
Success message
​
data
object
Complete debt information

​
Success Response

{
  "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_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": "xyz789abc123",
    "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"
  }
}

​
Error Responses

{
  "error": true,
  "message": "Authentication credentials are missing or invalid",
  "code": 401
}