Skip to main content
GET
/
receipts
/
{receipt_id}
Get a receipt by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/receipts/{receipt_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "origin": "upload",
  "created_by_entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "AED",
  "currency_exchange": {},
  "description": "Payment for lunch with clients",
  "document_id": "<string>",
  "file_id": "123e4567-e89b-12d3-a456-426614174000",
  "file_url": "<string>",
  "issued_at": "2023-11-07T05:31:56Z",
  "merchant_location": "<string>",
  "merchant_name": "<string>",
  "ocr_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ocr_status": "<string>",
  "partner_metadata": {},
  "sender": "hello@example.com",
  "source_of_data": "ocr",
  "total_amount": 123,
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
receipt_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required

Unique receipt ID.

​
created_at
string<date-time>
required

Creation timestamp.

​
updated_at
string<date-time>
required

Update timestamp.

​
origin
enum<string>
required

Specifies how this receipt was created in Monite.

Available options:
upload,
email
​
created_by_entity_user_id
string<uuid>

Entity user who created.

​
currency
enum<string>

Currency code.

Available options:
AED,
AFN,
ALL,
AMD,
ANG,
AOA,
ARS,
AUD,
AWG,
AZN,
BAM,
BBD,
BDT,
BGN,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BTN,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
FKP,
GBP,
GEL,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HTG,
HUF,
IDR,
ILS,
INR,
IQD,
ISK,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SBD,
SCR,
SEK,
SGD,
SHP,
SLE,
SOS,
SRD,
SSP,
SVC,
SZL,
THB,
TJS,
TMT,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
WST,
XAF,
XCD,
XOF,
XPF,
YER,
ZAR,
ZMW
​
currency_exchange
object

Currency exchange details.

​
description
string

Short transaction description.

Maximum string length: 1024
Example:

"Payment for lunch with clients"

​
document_id
string

Receipt number.

Maximum string length: 255
​
file_id
string<uuid>

The id of the receipt file stored in the file saver.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
file_url
string

The URL of the receipt file stored in the file saver.

​
issued_at
string<date-time>

Date when the receipt was issued.

​
merchant_location
string

Merchant location.

Maximum string length: 255
​
merchant_name
string

Merchant name.

Maximum string length: 128
​
ocr_request_id
string<uuid>

OCR request id.

​
ocr_status
string

OCR status.

​
partner_metadata
object

Partner metadata.

​
sender
string<email>

The email address from which the invoice was sent to the entity.

Example:

"hello@example.com"

​
source_of_data
enum<string>

Source of data.

Available options:
ocr,
user_specified
​
total_amount
integer

Total amount in minor units.

​
transaction_id
string<uuid>

Transaction ID.