Receivables

List Receivables

GET /v1/receivables

Returns a paginated list of receivables for your organization.

Query Parameters

Parameter	Type	Required	Description
`vendor_id`	UUID	No	Filter by vendor
`debtor_id`	UUID	No	Filter by debtor
`status`	string	No	Filter by status. Without this parameter, returns all statuses
`verified_since`	string	No	`all` or ISO8601 timestamp (default: 24 hours ago)
`expand[]`	string	No	Include `history` and/or `metadata`
`history_limit`	integer	No	Maximum history entries (default: 10)
`page`	integer	No	Page number (default: 1)
`limit`	integer	No	Items per page (default: 100, max: 500)

Response

{
  "object": "list",
  "data": [
    {
      "id": "rcv_550e8400e29b41d4a716446655440000",
      "object": "receivable",
      "vendor_receivable_id": "INV-2024-001",
      "vendor": {
        "id": "550e8400-e29b-41d4-a716-446655440001",
        "name": "Acme Corp"
      },
      "debtor": {
        "id": "550e8400-e29b-41d4-a716-446655440002",
        "name": "BigBuyer Inc"
      },
      "amount_cents": 150000,
      "currency": "USD",
      "receivable_date": "2026-01-01",
      "due_date": "2026-02-15",
      "status": "APPROVED",
      "portal_status": "APPROVED FOR PAYMENT",
      "po_number": "PO-2024-001",
      "detected_at": "2026-01-05T10:00:00.000Z",
      "updated_at": "2026-01-07T14:30:00.000Z",
      "estimated_next_update_at": "2026-01-08T09:35:00.000Z"
    }
  ],
  "has_more": true,
  "total_count": 1234
}

Examples

# Receivables updated in last 24 hours
curl "https://api.kapwork.com/v1/receivables" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

# Filter by vendor
curl "https://api.kapwork.com/v1/receivables?vendor_id=XXX" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

# Filter by vendor and debtor
curl "https://api.kapwork.com/v1/receivables?vendor_id=XXX&debtor_id=YYY" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

# All receivables (no time filter)
curl "https://api.kapwork.com/v1/receivables?verified_since=all" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

# Include history
curl "https://api.kapwork.com/v1/receivables?expand[]=history" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

Get Receivable

GET /v1/receivables/:id

Returns a single receivable with history and metadata included by default.

Path Parameters

Parameter	Type	Description
`id`	string	Receivable ID with `rcv_` prefix (e.g., `rcv_550e8400e29b41d4a716446655440000`)

Query Parameters

Parameter	Type	Description
`history_limit`	integer	Maximum history entries (default: 10)

Response

{
  "id": "rcv_550e8400e29b41d4a716446655440000",
  "object": "receivable",
  "vendor_receivable_id": "INV-2024-001",
  "vendor": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Acme Corp"
  },
  "debtor": {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "BigBuyer Inc"
  },
  "amount_cents": 150000,
  "currency": "USD",
  "status": "APPROVED",
  "portal_status": "APPROVED FOR PAYMENT",
  "receivable_date": "2026-01-01",
  "due_date": "2026-02-15",
  "detected_at": "2026-01-05T10:00:00.000Z",
  "updated_at": "2026-01-07T14:30:00.000Z",
  "estimated_next_update_at": "2026-01-08T09:35:00.000Z",
  
  "history": [
    {
      "changed_at": "2026-01-07T14:30:00.000Z",
      "changes": {
        "status": { "from": "PENDING", "to": "APPROVED" },
        "portal_status": { "from": "SUBMITTED", "to": "APPROVED FOR PAYMENT" }
      }
    }
  ],
  
  "metadata": {
    "payment_terms": "NET30",
    "supplier_code": "SUP-001234"
  }
}

Example

curl "https://api.kapwork.com/v1/receivables/rcv_550e8400e29b41d4a716446655440000" \
  -H "Authorization: Bearer $KAPWORK_API_KEY"

Receivable Object

Field	Type	Description
`id`	string	Unique identifier with `rcv_` prefix
`object`	string	`"receivable"`
`vendor_receivable_id`	string	Vendor's receivable number (nullable)
`vendor`	object	Vendor info (`id`, `name`)
`debtor`	object	Debtor info (`id`, `name`)
`amount_cents`	integer	Amount in cents
`currency`	string	Currency code (e.g., `USD`)
`receivable_date`	string	Receivable date (YYYY-MM-DD)
`due_date`	string	Due date (nullable)
`status`	string	Normalized status
`portal_status`	string	Original status from portal
`po_number`	string	Purchase order number (nullable)
`detected_at`	string	When Kapwork first detected this receivable (ISO8601)
`updated_at`	string	Last update timestamp (ISO8601)
`estimated_next_update_at`	string	Next scheduled update (nullable)
`history`	array	Change history (included by default on single, requires `expand[]` on list)
`metadata`	object	Portal metadata (included by default on single, requires `expand[]` on list)

History Object

Field	Type	Description
`changed_at`	string	Change timestamp (ISO8601)
`changes`	object	Field changes: `{ "field": { "from": old, "to": new } }`

Status Values

Status	Description
`PENDING`	Not yet ready for processing
`APPROVED`	Ready for payment or factoring
`PAID`	Payment completed
`SOLD`	Factored to third party
`DISPUTED`	Rejected, canceled, or on hold
`ACKNOWLEDGED`	Received but status not mapped

Status Reference →

On this page