Skip to main content
GET
Get inbox item

Authorizations

Authorization
string
header
required

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

Path Parameters

inboxItemId
string<uuid>
required

Required. String in UUID format. The id of the inbox item, as returned in the id property by GET /me/inboxitems.

Example:

"e4677839-5f0a-4c7e-9a1b-2d3c4e5f6a7b"

Query Parameters

include
enum<string>[]

Optional. Array of strings, comma-separated. Additional properties to include in the response. Accepted values: meta.abbreviation adds meta.abbreviation to each inbox item, with pre-formatted, localized strings for displaying it (date, description, attachment, amount and labels). When omitted, meta is not returned.

Available options:
meta.abbreviation

Response

OK

A receipt found in one of the user's connected email accounts. Properties without a value are left out.

id
string<uuid>
required

Id of the inbox item

userId
string
required

Identifier of the connected email account the receipt was received through. Pass it as accountId to GET /me/inboxitems to list only the inbox items from that account.

provider
enum<string>
required

Email provider the receipt was received through

Available options:
GMAIL,
OUTLOOK
receivedAt
string<date-time>
required

When the email was received

used
boolean
required

Whether the inbox item is linked to an expense (true when expenseId is set)

status
enum<string>
required

Status of the inbox item: AVAILABLE (not linked to an expense), PENDING (an expense is being created from it) or EXPENSED (linked to an expense)

Available options:
AVAILABLE,
PENDING,
EXPENSED
hasAttachments
boolean
required

Whether the email has attachments

attachmentTypes
string[]
required

Content types of the attachments

attachments
object[]
required

Attachments of the email

subject
string

Subject of the email

senderEmail
string

Email address of the sender

senderName
string

Name of the sender

bodyPreview
string

The beginning of the email body

detectedAmount
number

Amount detected in the receipt

detectedCurrency
string

ISO 4217 currency code of the detected amount

expenseId
string

Id of the expense the inbox item is linked to

meta
object

Returned only when requested with the include parameter