Get a receipt by ID

GET

/receipts/:receipt_id

GET

/v1/receipts/:receipt_id

$ curl https://api.sandbox.monite.com/v1/receipts/receipt_id \
>      -H "x-monite-version: 2024-01-31" \
>      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "origin": "upload",
6   "created_by_entity_user_id": "created_by_entity_user_id",
7   "currency": "AED",
8   "currency_exchange": {
9     "key": "value"
10   },
11   "description": "Payment for lunch with clients",
12   "document_id": "document_id",
13   "file_id": "123e4567-e89b-12d3-a456-426614174000",
14   "file_url": "file_url",
15   "issued_at": "2024-01-15T09:30:00Z",
16   "merchant_location": "merchant_location",
17   "merchant_name": "merchant_name",
18   "ocr_request_id": "ocr_request_id",
19   "ocr_status": "ocr_status",
20   "partner_metadata": {
21     "key": "value"
22   },
23   "sender": "hello@example.com",
24   "source_of_data": "ocr",
25   "total_amount": 1,
26   "transaction_id": "transaction_id"
27 }

Authentication

AuthorizationBearer

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

Path parameters

receipt_idstringRequired

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.

created_by_entity_user_idstringOptionalformat: "uuid"

Entity user who created.

currencyenumOptional

Currency code.

currency_exchangemap from strings to anyOptional

Currency exchange details.

descriptionstringOptional<=1024 characters

Short transaction description.

document_idstringOptional<=255 characters

Receipt number.

file_idstringOptionalformat: "uuid"

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

file_urlstringOptional

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

issued_atdatetimeOptional

Date when the receipt was issued.

merchant_locationstringOptional<=255 characters

Merchant location.

merchant_namestringOptional<=128 characters

Merchant name.

ocr_request_idstringOptionalformat: "uuid"

OCR request id.

ocr_statusstringOptional

OCR status.

partner_metadatamap from strings to anyOptional

Partner metadata.

senderstringOptionalformat: "email"

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

source_of_dataenumOptional

Source of data.

total_amountintegerOptional

Total amount in minor units.

transaction_idstringOptionalformat: "uuid"

Transaction ID.

Errors

401

Get Receipts ID Request Unauthorized Error

403

Get Receipts ID Request Forbidden Error

404

Get Receipts ID Request Not Found Error

422

Get Receipts ID Request Unprocessable Entity Error

500

Get Receipts ID Request Internal Server Error

Authentication

Path parameters

Headers

Response

Errors