KapworkKapwork Partner API
How It Works

Data Model

Vendor, debtor, and receivable relationships

Entity Relationships

Loading diagram...
  • Vendor: The company that issued the receivable (your client)
  • Debtor: The company that owes payment (the buyer)
  • Receivable: A verified payment obligation from the debtor's system

Example Structure

Loading diagram...

Sync Granularity

Vendor-Debtor Pairs

Kapwork synchronizes receivables at the vendor-debtor pair level. When a sync runs, it updates all receivables for that relationship simultaneously.

Implications:

  • All receivables from the same vendor-debtor pair share the same estimated_next_update_at value
  • Updates are atomic per vendor-debtor pair
  • You can determine when any receivable will refresh by checking this field

Query Patterns

# Receivables for a vendor
GET /v1/receivables?vendor_id=<Acme Corp ID>

# Debtors that verify a vendor's receivables
GET /v1/debtors?vendor_id=<Acme Corp ID>

# Receivables for a specific vendor-debtor pair
GET /v1/receivables?vendor_id=<Acme Corp ID>&debtor_id=<BigBuyer ID>

Next

On this page