Upload a receipt from a file

Upload an incoming receipt in the PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20 MB.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects a multipart form containing a file.
filefileRequired

Response

Successful Response
idstringformat: "uuid"
Unique receipt ID.
created_atdatetime
Creation timestamp.
updated_atdatetime
Update timestamp.
originenum
Specifies how this receipt was created in Monite.
Allowed values:
created_by_entity_user_idstring or nullformat: "uuid"
Entity user who created.
currencyenum or null
Currency code.
currency_exchangemap from strings to any or null
Currency exchange details.
descriptionstring or null<=1024 characters
Short transaction description.
document_idstring or null<=255 characters
Receipt number.
file_idstring or nullformat: "uuid"
The id of the receipt file stored in the file saver.
file_urlstring or null
The URL of the receipt file stored in the file saver.
issued_atdatetime or null
Date when the receipt was issued.
merchant_locationstring or null<=255 characters
Merchant location.
merchant_namestring or null<=128 characters
Merchant name.
ocr_request_idstring or nullformat: "uuid"
OCR request id.
ocr_statusstring or null
OCR status.
partner_metadatamap from strings to any or null
Partner metadata.
senderstring or nullformat: "email"
The email address from which the invoice was sent to the entity.
source_of_dataenum or null
Source of data.
Allowed values:
total_amountinteger or null
Total amount in minor units.
transaction_idstring or nullformat: "uuid"
Transaction ID.

Errors