Families

Set a personal row's household category or note

Changed on

Firm-side family relationships only. Select the firm with x-organization-id. Owners, Admins and Staff Admins access all firm families; Staff Members need independent family assignment. Company access does not grant family access. OAuth requires the broad mcp grant, not a narrow banking scope; API keys retain ordinary agent permission scopes. No accounting organizations, portal grants, bank changes, invitations or charges are created. Writes require ordinary firm write entitlement. Cross-firm and inaccessible IDs return 404. Personal accounts never post journals; these operations read delivered bank rows and save household categories, notes and rules. Rows nobody categorized by hand are categorized automatically (rule, then the firm's earlier choice for the merchant, then Plaid, then AI); a person's choice always wins. Rules never hide rows. A category set here is a person's choice, and the firm remembers it for this merchant. Requires banking permission.

patch/families/{id}/personal/transactions/{eventId}

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/families/{id}/personal/transactions/{eventId}
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

idstring uuid required
eventIdstring required

Request body

categoryIdstring uuid nullable
notestring nullable
applyToSimilarboolean

Also set the category on every other row from the same merchant that no person categorized and that was not moved

Response

Success

successboolean
familyIdstring uuid
eventIdstring
merchantKeystring
appliedCountinteger

Other rows from the same merchant that took the category

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status