Update Debt

{
  "error": false,
  "message": "Debt updated successfully",
  "data": {
    "id": "abc123def456",
    "civility": "Mr",
    "firstname": "John",
    "lastname": "Doe",
    "phone": "+33987654321",
    "email": "john.doe@newmail.com",
    "birthdate": "1985-06-15",
    "amount": 1250.00,
    "amount_text": "1250.00",
    "currency": "EUR",
    "object": "Invoice #2024-001",
    "internal_id": "INV-2024-001",
    "invoice_date": "2024-01-01",
    "due_date": "2024-02-15",
    "address": null,
    "street_address": "123 Main Street",
    "street_number": null,
    "postal_code": "75001",
    "city": "Paris",
    "country": "FR",
    "status": "status.default.paid",
    "timeline_id": "YOUR_TIMELINE_ID",
    "nb_reminders": 2,
    "nb_answered": 1,
    "summary": null,
    "iban": null,
    "followups_count": 3,
    "company": "GetBill SAS",
    "debtor_company": "ACME Corporation",
    "payment_link": null,
    "import_date": "2024-01-15T10:30:00+00:00",
    "last_timeline_restart": null,
    "payment_plan_active": false,
    "plan_start_date": null
  }
}

Overview

This endpoint allows you to update information for an existing debt. You can modify debtor details, amounts, addresses, and other debt-related information.

The status field can be updated via API to: status.default.paid, status.default.in_progress, status.default.on_hold, status.default.failed, or status.default.archived. Other statuses are managed through internal workflows only.

Authentication

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

When both paid and remaining amounts are sent, their sum must equal the debt amount.

Custom dynamic fields

extra_variables: Optional object of custom dynamic fields, for example {"contract_number": "CTR-123", "agency": "Paris"}. When omitted, existing values are preserved. When provided, replaces all dynamic fields; {} clears them.

Example Request

curl -X PUT "/external-api/v1/debts/abc123def456" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+33987654321",
    "email": "john.doe@newmail.com",
    "debtor_company": "ACME Corporation",
    "street_address": "123 Main Street",
    "city": "Paris",
    "postal_code": "75001",
    "due_date": "2024-02-15",
    "status": "status.default.paid"
  }'

const debtId = 'abc123def456';
const updateData = {
  phone: '+33987654321',
  email: 'john.doe@newmail.com',
  debtor_company: 'ACME Corporation',
  street_address: '123 Main Street',
  city: 'Paris',
  postal_code: '75001',
  due_date: '2024-02-15',
  status: 'status.default.paid'
};

const response = await fetch(`/external-api/v1/debts/${debtId}`, {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(updateData)
});

const result = await response.json();

Returns the updated debt object with the same structure as the Get Debt endpoint. For a costly phone destination without authorization, the update succeeds and includes an expensive_destination_not_accepted warning. It does not return 422 solely because of the destination.

Success Response

{
  "error": false,
  "message": "Debt updated successfully",
  "data": {
    "id": "abc123def456",
    "civility": "Mr",
    "firstname": "John",
    "lastname": "Doe",
    "phone": "+33987654321",
    "email": "john.doe@newmail.com",
    "birthdate": "1985-06-15",
    "amount": 1250.00,
    "amount_text": "1250.00",
    "currency": "EUR",
    "object": "Invoice #2024-001",
    "internal_id": "INV-2024-001",
    "invoice_date": "2024-01-01",
    "due_date": "2024-02-15",
    "address": null,
    "street_address": "123 Main Street",
    "street_number": null,
    "postal_code": "75001",
    "city": "Paris",
    "country": "FR",
    "status": "status.default.paid",
    "timeline_id": "YOUR_TIMELINE_ID",
    "nb_reminders": 2,
    "nb_answered": 1,
    "summary": null,
    "iban": null,
    "followups_count": 3,
    "company": "GetBill SAS",
    "debtor_company": "ACME Corporation",
    "payment_link": null,
    "import_date": "2024-01-15T10:30:00+00:00",
    "last_timeline_restart": null,
    "payment_plan_active": false,
    "plan_start_date": null
  }
}

Error Responses

{
  "error": true,
  "message": "Invalid JSON payload",
  "code": 400
}

{
  "error": true,
  "message": "Access denied to this debt",
  "code": 403
}

{
  "error": true,
  "message": "Debt not found or invalid ID",
  "code": 404
}

Get started

Guides

SFTP integration

Company API

Creditors API

Debtors API

Debts API

Timelines API

Campaigns API

Settings API

Invoice documents API

Followups API

Todos API

Status API

Overview

Authentication

Custom dynamic fields

Example Request

Success Response

Error Responses

​Overview

​Authentication

​Custom dynamic fields

​Example Request

​Success Response

​Error Responses

Overview

Authentication

Custom dynamic fields

Example Request

Success Response

Error Responses