Edit

Get report inbox files through the API

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

The report inbox file API in Business Central gives integrations access to report inbox files and their metadata. Use the API to retrieve the company name, file name, file size, and document content for a report inbox file.

Note

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

reportInboxFile

Represents a report inbox file in Business Central.

Methods

Method Return type Description
GET reportInboxFile Gets a reportInboxFile object.

Properties

Property Type Description
id GUID The unique ID of the reportInboxFile. Noneditable.
companyName string Specifies the name of the company that the report inbox file belongs to.
fileName string Specifies the name of the report file.
byteSize integer Specifies the size of the report file in bytes.
documentContent stream Specifies the content of the report file.

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