List Entry Link Candidates
GET/api/ledger/reconciliation/link-candidates
The SKU ledger entries a provider-only document could be linked to — the confidence-ranked picker for the reverse direction of the manual link (pick the SKU entry that matches a provider document, identified by remote_type + remote_id).
Ranks the connection's unlinked entries against the target document, spanning BOTH the eligible (sku_only) and the excluded (ineligible) entries — an entry that will never sync can still be the real counterpart of a provider document, and linking it is safe (it reconciles the document out of the provider-only set without pushing anything). Each candidate carries per-signal match flags — amount_match, date_match, reference_match, confident — plus its sync eligibility: eligible (boolean) and eligibility_reasons[] (reason codes such as type_disabled, channel_disabled) so ineligible candidates can be flagged.
Authentication: Requires Bearer token.
Query parameters: connection_id (required), remote_type (required, e.g. xero_bill), remote_id (required — the provider document id), search (optional). Returns 404 when connection_id is not a supported accounting connection, and 422 when a required parameter is missing.
Response: 200 with data as an array of candidate entries ordered most-confident first. Link the chosen entry with POST /api/ledger/reconciliation/link.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.