Get Vendor Credit Extraction
GET/api/vendor-credits/ocr/:extraction
Get a vendor credit OCR extraction record with extracted header fields, matched lines, and related records (supplier, purchase order, duplicate vendor credit, referenced purchase invoice, candidate purchase orders).
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Header fields: credit_number, credit_date, supplier_name, total, subtotal, tax_amount, currency_code, po_number, document_type, plus matched_supplier_id / matched_supplier_name / matched_purchase_order_id / matched_purchase_order_number.
Line match_status values: exact, fuzzy, discount_confirmation, unmatched.
Classification fields: document_type (credit_memo | invoice | unknown), detection_signals (array of raw classifier signals, e.g. keyword:credit memo, doc_number:CM prefix, total:negative; null when not classified) and auto_routed (true when the document arrived via the supplier-invoice intake and was automatically routed to the credit memo queue by the document type classifier).
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.