Create a receipt

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 an object.
base64_encoded_filestringOptional

Base64-encoded contents of the original receipt file.

currencyenumOptional
Currency code used in the receipt.
document_idstringOptional<=255 characters
Unique receipt number assigned by the issuer.
issued_atdatetimeOptional
Receipt issued date and time.
merchant_locationstringOptional<=255 characters
Location of the merchant.
merchant_namestringOptional<=128 characters
Name of the merchant.
total_amountintegerOptional>=0

Total amount for the receipt in minor units (e.g. cents).

transaction_idstringOptionalformat: "uuid"
Transaction ID.

Response

Successful Response
idstringformat: "uuid"
Unique receipt ID.
created_atdatetime
Creation timestamp.
updated_atdatetime
Update timestamp.
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.
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.
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