Vendors

Converge an outstanding check (Lane B)

Manual convergence for a human-selected outstanding check (vendors/1099 plan, Phase 3, Section 8.3). Claims the unposted withdrawal feed row against the check's journal entry with the widened matcher, excludes the originally created register row, assigns the surviving feed row the entry's counterpart account, and marks the vendor_check cleared with cleared_via human_selected — atomically, in one transaction. The check must still be recorded, on the withdrawal's bank account, and within $1 of the withdrawal amount. Requires the post:entries role and the bank_transactions:read_write scope.

post/vendors/outstanding-checks/{id}/converge

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/vendors/outstanding-checks/{id}/converge
  • 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

Vendor check UUID

Request body

bankTransactionIdstring uuid required

The unposted withdrawal feed row

Response

Converged: feed row claimed, original row excluded, check cleared

Changes

No recorded changes to this operation across all 5 revisions of this API.