API Reference
Debtors
Debtors endpoint reference
List Debtors
GET /v1/debtorsReturns debtors that have receivables in your organization.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
vendor_id | UUID | No | Filter to debtors with receivables from this vendor |
Response
{
"object": "list",
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440002",
"object": "debtor",
"name": "BigBuyer Inc",
"created_at": "2026-01-15T10:00:00.000Z",
"estimated_next_update_at": "2026-01-07T09:30:00.000Z"
}
],
"total_count": 10
}Examples
# All debtors
curl "https://api.kapwork.com/v1/debtors" \
-H "Authorization: Bearer $KAPWORK_API_KEY"
# Debtors for a specific vendor
curl "https://api.kapwork.com/v1/debtors?vendor_id=550e8400-e29b-41d4-a716-446655440001" \
-H "Authorization: Bearer $KAPWORK_API_KEY"Debtor Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier |
object | string | "debtor" |
name | string | Company name |
created_at | string | Creation timestamp (ISO8601) |
estimated_next_update_at | string | Earliest next update across all integrations (nullable) |
estimated_next_update_at Behavior
For a debtor, this value represents the earliest scheduled update across all integrations involving this debtor.
Example: If BigBuyer has integrations with Acme Corp (updates at 9:00) and Widget Co (updates at 10:00), the debtor's estimated_next_update_at will be 9:00.
Common Queries
List all debtors
GET /v1/debtorsDebtors that verify a vendor's receivables
GET /v1/debtors?vendor_id=<vendor_id>Receivables for a debtor
GET /v1/receivables?debtor_id=<debtor_id>Receivables for a specific vendor-debtor pair
GET /v1/receivables?vendor_id=<vendor_id>&debtor_id=<debtor_id>