Bulk Dismiss Provider Documents
POST/api/ledger/reconciliation/dismiss/bulk
Dismiss many provider-only documents from reconciliation in one action (idempotent). Provide either ids (an array of composite "{remote_type}:{remote_id}" identifiers — the selected rows) or apply_to_all: true with filters to dismiss every provider-only document matching those filters. An optional reason is stored on each.
Authentication: Requires Bearer token.
Body: connection_id (required, integer); ids (array of strings, required unless apply_to_all); apply_to_all (boolean); filters (object, optional) — the list filters to scope apply_to_all, e.g. {"search": "Contractor Payment"}. Accepts flat filter values (search, remote_type, status, date_from, date_to) plus an optional filter_groups tree (same structure as the list endpoint's filter_groups parameter). When omitted, apply_to_all targets every document in the reconcile window.; reason (string, optional).
Response: 200 with the number dismissed.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.