How Updates Work

The `estimated_next_update_at` Field

Every response includes an estimated_next_update_at timestamp indicating when the data will next be refreshed from the source system.

{
  "id": "rec_abc123",
  "vendor": { "id": "...", "name": "Acme Corp" },
  "debtor": { "id": "...", "name": "BigBuyer Inc" },
  "amount_cents": 150000,
  "estimated_next_update_at": "2026-01-07T09:35:00.000Z"
}

Sync Mechanics

Kapwork maintains integrations with debtor systems. Each integration:

Is configured for a specific vendor-debtor pair
Runs on a schedule (daily, weekly, or custom)
Updates all receivables for that pair atomically

Because syncs operate at the vendor-debtor level, all receivables from the same pair share the same estimated_next_update_at value.

Processing Buffer

The estimated_next_update_at value includes a 5-minute buffer for processing time. Data should be considered stale until this timestamp has passed.

Null Values

estimated_next_update_at is null when:

Condition	Explanation
No schedule exists	No scheduled syncs are configured for this pair
Schedule is disabled	The schedule is paused
Integration is inactive	The integration is not currently active

When estimated_next_update_at is null, use the verified_at field to determine when the data was last refreshed.

Granularity by Entity

Receivable

The next scheduled refresh for this specific receivable.

Debtor

The earliest scheduled update across all integrations involving this debtor.

Vendor

The earliest scheduled update across all integrations involving this vendor.

Usage Recommendations

Caching

If estimated_next_update_at is 2026-01-07T09:35:00Z:

Data will not change before that time
Cache until that timestamp
Query again afterward for fresh data

Conditional Polling

if current_time > estimated_next_update_at:
    refresh_data()

Null Handling

When estimated_next_update_at is null, the data is not on a schedule. Use verified_at to determine freshness.

Webhooks

Webhooks are in development. When available, they will eliminate the need for polling by delivering notifications when receivables change.

Webhooks →