Get Creditor

{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "abc123def456",
      "name": "Acme Corporation",
      "email": "billing@acmecorp.com",
      "phone": "+33142123456",
      "address": "123 Business Street",
      "city": "Paris",
      "postalCode": "75001",
      "country": "France",
      "registrationNumber": "B123456789",
      "taxNumber": "FR12345678901",
      "contactPerson": "John Billing",
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-01-20 14:22:00",
      "totalDebts": 45,
      "totalAmount": 125750.00
    }
  }
}

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

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

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

Overview

This endpoint returns detailed information about a specific creditor identified by its encrypted ID.

Authentication

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

Example Request

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

const creditorId = 'abc123def456';

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

const creditor = await response.json();

import requests

creditor_id = 'abc123def456'

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

response = requests.get(
    f'/external-api/v1/creditors/{creditor_id}',
    headers=headers
)

creditor = response.json()

Example Response

{
  "error": false,
  "message": "Success",
  "data": {
    "data": {
      "id": "abc123def456",
      "name": "Acme Corporation",
      "email": "billing@acmecorp.com",
      "phone": "+33142123456",
      "address": "123 Business Street",
      "city": "Paris",
      "postalCode": "75001",
      "country": "France",
      "registrationNumber": "B123456789",
      "taxNumber": "FR12345678901",
      "contactPerson": "John Billing",
      "createdAt": "2024-01-15 10:30:00",
      "updatedAt": "2024-01-20 14:22:00",
      "totalDebts": 45,
      "totalAmount": 125750.00
    }
  }
}

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

{
  "error": true,
  "message": "Required scope \"creditors:read\" 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

List Creditors - Get a list of all creditors
Update Creditor - Update creditor information
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