Scan Invoice Payment Proof
POST/api/purchase-invoices/:purchaseInvoice/payment-request/scan-proof
Scan a payment proof — a bank transfer confirmation image or PDF — and return the payment details read from it, used to pre-fill the record-payment form. Nothing is stored: the file is only persisted later (as a payment-proof attachment) when the payment is actually recorded.
Send as multipart/form-data with a single file field. Accepted types: PDF, JPG/JPEG, PNG, GIF, WEBP, TIFF, BMP. Maximum size 10 MB. If the extraction service is unavailable the endpoint returns 422.
Authentication: Requires Bearer token.
Response fields (each nullable when a value cannot be read):
- reference: Payment reference or transaction ID.
- amount: Payment amount.
- currency_code: ISO currency code.
- value_date: Date the payment settled (YYYY-MM-DD).
- payee_name: Beneficiary name shown on the proof.
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.