How It Works
Overview
What the Partner API provides and how it works
Purpose
The Kapwork Partner API provides read-only access to verified receivables data. When your clients (vendors) issue receivables to their customers (debtors), and those debtors acknowledge the receivables in their procurement systems, we capture and normalize that data.
The API exposes receivables that have been verified through debtor systems such as Coupa, Ariba, Tradeshift, and similar platforms.
Core Entities
Loading diagram...
| Entity | Description | Example |
|---|---|---|
| Vendor | The company that issued the receivable | Acme Corp |
| Debtor | The company that owes payment | BigBuyer Inc |
| Receivable | A verified payment obligation from the debtor's system | INV-2024-001, $1,500 |
Available Operations
| Endpoint | Description |
|---|---|
GET /v1/vendors | List vendors in your organization |
GET /v1/debtors?vendor_id=X | List debtors for a vendor |
GET /v1/receivables?vendor_id=X&debtor_id=Y | List receivables for a vendor-debtor pair |
GET /v1/receivables?vendor_id=X | List all receivables for a vendor |
GET /v1/receivables/:id | Get a single receivable with full history |
Limitations
This is a read-only API. You cannot create, update, or delete receivables. Receivable data originates from debtor systems; we synchronize it and expose it through the API.