patch_household
Apply a collection-level delta to a stored household without resending the whole document: set scalars (filingStatus, state), upsert entries by id (replace or append), remove entries by id. expectedVersion (from get_household) is REQUIRED — a delta is only meaningful against a version you have read. The merged result is validated in full; a delta can never produce an invalid household.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| set | No | Scalar fields: { filingStatus?, state? } (state: null clears it) | |
| remove | No | Collection → ids to remove | |
| upsert | No | Collection → entries with ids: replace matching ids, append new ones | |
| api_key | No | Worthune API key (wk_…) | |
| expectedVersion | Yes |