Automatch and Attach File to Transaction

šŸ”’

Required scope: receipts:write

The API credential calling this endpoint must be granted the receipts category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Send us a receipt (PDF, PNG, JPEG) and we try to find the corresponding transaction for this receipt and attach it to the matching transaction. This endpoint works asynchronously and only starts the automatching process. You will get a callback with the result once it is finished. Or you can query the status yourself.

Body Params
file
required

The receipt which should be matched to an existing transaction.

uuid
required

The organization this receipt belongs to. This is the minimum required data we need to automatch a receipt.

metadata
object

Additional metadata about the receipt. This is optional. If provided, it can enhance the matching process. It not provided, we will use OCR data to match the receipt. This needs to be provided as a JSON string.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json