Tool to upload a receipt or invoice image file and extract basic data including merchant name, total amount, tax amount, and date. Use when you need to digitize receipt data from a file (PDF, JPG, PNG, GIF, HEIC up to 20MB). The API uses OCR to detect and extract key fields.
fileRequiredobjectReceipt or invoice image file to upload (less than 20MB). Supported formats: PDF, JPG, PNG, GIF, HEIC.
nearstringA geo location to search for merchant. Typically in the format of city, state, country.
userIdstringTag a request with a user ID so that duplicate receipts by the same user can be detected
refreshbooleanSet true to force re-process image transcription if the receipt is already in storage. Default is false.
languagestringSupported languages for receipt OCR processing.
incognitobooleanSet true to avoid saving the receipt in storage. Default is false.
ipAddressstringIP Address of the end user for fraud detection purposes
containerIdstringTag a request with a container ID for fraud detection purposes
extractTimebooleanSet true to return time if found on the receipt. Otherwise, the time is always set to 12:00:00.000. Default is false.
referenceIdstringTag a request with a unique reference ID for feedback/training and receipt similarity check purposes
subAccountIdstringTag a request with sub-account ID for billing purposes
ignoreMerchantNamestringIgnore this merchant name if detected on the receipt. Use this field to avoid detecting the customer name as the merchant name.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.