Edit

Work with report inbox items through the API

APPLIES TO: Business Central 2026 release wave 2 and later.

The report inbox items API in Business Central gives integrations access to report inbox entries. Use the API to retrieve entry details and update whether an entry is marked as read.

Note

Learn more about enabling APIs for Business Central in Enabling the APIs for Dynamics 365 Business Central.

reportInboxItem

Represents a report inbox entry in Business Central.

Methods

Method Return type Description
GET reportInboxItem Gets a reportInboxItem object.
PATCH reportInboxItem Updates a reportInboxItem object.

Properties

Property Type Description
id GUID The unique ID of the reportInboxItem. Noneditable.
companyName string Specifies the company name for the report inbox entry.
companyNameLower string Specifies the company name in lowercase.
includeAllCompanies boolean Specifies whether the report inbox entry applies to all companies.
entryNo integer Specifies the entry number.
reportId integer Specifies the ID of the report that created the entry.
reportName string Specifies the name of the report that created the entry.
description string Specifies the description of the report inbox entry.
createdDateTime datetime Specifies the date and time when the report inbox entry was created.
outputType NAV.reportInboxOutputType Specifies the report output type. The values are PDF, Word, Excel, and Zip.
read boolean Specifies whether the report inbox entry is marked as read.
fileName string Specifies the name of the report file.

Report Inbox Companies API
Report Inbox Content API
Report Inbox File API
Develop APIs with pages and queries