Get Attachment OCR Extraction
GET/api/purchase-invoices/:purchaseInvoice/attachments/:attachment/ocr
Get the latest OCR extraction result for an invoice attachment. Read-only — never triggers a scan.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns "data": null when the attachment has not been scanned yet (or the first scan is still running). Re-scanning keeps history; only the newest extraction is returned.
The extraction contains:
header— extracted invoice fields, each as{value, confidence}(invoice_number, invoice_date, due_date, vendor_name, total_amount, subtotal, tax_amount, currency_code, po_number, addresses).extracted_lines— document lines matched to purchase order product lines (matched_po_line_id) or cost lines (matched_financial_line_id), withmatch_confidenceofhigh,medium,low, ornone, plus unit price variance versus the PO.unmatched_lines— lines that could not be matched;ignoredreflects choices saved via Apply OCR Extraction to Invoice.
Returns 404 if the attachment does not belong to the given invoice. Requires the purchase-orders:read token scope.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.