Sign in

v1

latestOpenAPI 3.1.0AGPL-3.0 license2026-07-1210336283.6 KB
Inbox

Retrieve a inbox item

Retrieve a inbox item by its unique identifier for the authenticated team.

get/inbox/{id}

Path parameters

idstring required

The unique identifier of the inbox item.

Example:b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4

The unique identifier of the inbox item.

Response

Retrieve an inbox item by its ID.

idstring required

Inbox item ID (UUID)

fileNamestring required

Original file name of the uploaded document

filePathstring[] required

Path segments to the file in storage

displayNamestring required

Display name for the inbox item

amountnumber nullable required

Amount detected or entered for the inbox item

currencystring nullable required

Currency code (ISO 4217) for the amount

contentTypestring nullable required

MIME type of the uploaded file

datestring nullable required

Date associated with the inbox item (ISO 8601)

statusstring required

Status of the inbox item

createdAtstring required

Date and time when the inbox item was created (ISO 8601)

websitestring nullable required

Website associated with the inbox item, if any

descriptionstring nullable required

Description or notes for the inbox item

Example response

{
  "id": "b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
  "fileName": "invoice-123.pdf",
  "filePath": [
    "inbox",
    "2024",
    "05",
    "invoice-123.pdf"
  ],
  "displayName": "Invoice May 2024",
  "amount": 123.45,
  "currency": "USD",
  "contentType": "application/pdf",
  "date": "2024-05-01",
  "status": "pending",
  "createdAt": "2024-05-01T12:34:56.789Z",
  "website": "https://vendor.com",
  "description": "Invoice for May 2024 services",
  "transaction": {
    "id": "a1b2c3d4-5678-4e7a-9c1a-2b7c1e24c2a4",
    "amount": 123.45,
    "currency": "USD",
    "name": "Acme Corp",
    "date": "2024-05-01"
  }
}