Upload Credit Memo for OCR
POST/api/vendor-credits/ocr/upload
Upload a credit memo PDF to begin OCR extraction. multipart/form-data.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
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 tracked job log endpoints. 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
- 201
- 401
- 403
- 422
- 429
Created
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.
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.