Scan Payment Proof (OCR)
POST/api/vendor-deposits/:vendorDepositId/scan-proof
OCR a payment-proof image/PDF (a wire confirmation or receipt) and return the extracted payment fields for the payer to review before recording the payment.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Runs the shared OCR stack — Azure Document Intelligence layout OCR + a small LLM extraction — and returns the fields WITHOUT persisting anything. The file is only stored (as a payment_proof attachment) when the payment itself is recorded. The Record Payment / Approve & Mark Paid dialogs use this to pre-fill Reference, Amount, and Date.
Gating & metering: requires the tenant's OCR setting to be enabled (Settings → Accounting → Invoice OCR) and Azure DI credentials configured; each scan is metered in the shared OCR usage log. Throttled to 20/min.
Body (multipart/form-data): file — required image/PDF, max 10MB.
Errors (422): OCR not enabled; Azure not configured; no readable text found; file validation.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
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.