Update Creditor

{
  "error": false,
  "message": "Creditor updated successfully",
  "data": {
    "id": "abc123def456",
    "name": "Acme Corporation Updated",
    "email": "newbilling@acmecorp.com",
    "phone": "+33142123456",
    "address": "123 Business Street",
    "siret": "12345678900012",
    "vatNumber": "FR12345678901",
    "contactPerson": "Jane Doe",
    "firstSeenAt": "2024-01-15 10:30:00",
    "lastUpdatedAt": "2024-02-01 15:45:00"
  }
}

{
  "error": true,
  "message": "Validation failed",
  "code": 400,
  "errors": [
    {
      "property": "email",
      "message": "This value is not a valid email address."
    }
  ]
}

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

{
  "error": true,
  "message": "Required scope \"creditors:write\" not found in token",
  "code": 403
}

{
  "error": true,
  "message": "Creditor not found",
  "code": 404
}

Overview

This endpoint allows you to update creditor information. You can use either PUT (full update) or PATCH (partial update) methods.

Authentication

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

Example Request

curl -X PUT "/external-api/v1/creditors/abc123def456" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation Updated",
    "email": "newbilling@acmecorp.com",
    "contactPerson": "Jane Doe"
  }'

const creditorId = 'abc123def456';
const updateData = {
  name: 'Acme Corporation Updated',
  email: 'newbilling@acmecorp.com',
  contactPerson: 'Jane Doe'
};

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

const updatedCreditor = await response.json();

import requests
import json

creditor_id = 'abc123def456'
update_data = {
    'name': 'Acme Corporation Updated',
    'email': 'newbilling@acmecorp.com',
    'contactPerson': 'Jane Doe'
}

headers = {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
}

response = requests.put(
    f'/external-api/v1/creditors/{creditor_id}',
    headers=headers,
    data=json.dumps(update_data)
)

updated_creditor = response.json()

Example Response

{
  "error": false,
  "message": "Creditor updated successfully",
  "data": {
    "id": "abc123def456",
    "name": "Acme Corporation Updated",
    "email": "newbilling@acmecorp.com",
    "phone": "+33142123456",
    "address": "123 Business Street",
    "siret": "12345678900012",
    "vatNumber": "FR12345678901",
    "contactPerson": "Jane Doe",
    "firstSeenAt": "2024-01-15 10:30:00",
    "lastUpdatedAt": "2024-02-01 15:45:00"
  }
}

{
  "error": true,
  "message": "Validation failed",
  "code": 400,
  "errors": [
    {
      "property": "email",
      "message": "This value is not a valid email address."
    }
  ]
}

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

{
  "error": true,
  "message": "Required scope \"creditors:write\" not found in token",
  "code": 403
}

{
  "error": true,
  "message": "Creditor not found",
  "code": 404
}

Rate Limiting

This endpoint is subject to rate limiting. See the Rate Limits documentation for details. Rate Limit: 1,000 requests per hour

Get Creditor - Get creditor information
List Creditors - Get a list of all creditors
List Debts by Creditor - Get all debts for this creditor

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

Example Request

Example Response

Rate Limiting

​Overview

​Authentication

​Example Request

​Example Response

​Rate Limiting

​Related Endpoints

Overview

Authentication

Example Request

Example Response

Rate Limiting

Related Endpoints