Skip to main content

Upload Credit Memo for OCR

POST 
/api/vendor-credits/ocr/upload

Upload a credit memo PDF to begin OCR extraction. multipart/form-data.

Validation:

  • file: required, PDF only (mimes: pdf), max 20 MB (20480 KB)
  • supplier_id: optional integer, must exist in suppliers
  • purchase_order_id: optional integer, must exist in purchase_orders. Pre-links the extraction to that PO; derives the supplier hint from the PO when supplier_id is omitted. A pre-linked PO wins over OCR's own po_number match.

Processing is asynchronous — the response includes a tracked_job_log_id for the global job progress tray. Poll Get Extraction until status moves from processing to pending_review (or failed / duplicate_detected). Returns 422 if Vendor Credit OCR is not enabled in Settings → Invoice OCR.

Request​

Responses​

Created

Response Headers
    Content-Type