Breeze Interface API

Here you will find the documentation for the following products:

• Invoice
• Procurement
• Order Confirmation
• Delivery Note

BC-side API

In addition to the interfaces documented above, the Breeze Interface publishes the following web services on the Business Central side. They are used by the external system to exchange documents, attachments and status information.

Breeze Documents API

OData API (entity set breezedocumentsapi) over the Breeze Document table. It is used to create and read Breeze documents in Business Central.

Breeze Attachments API

OData API (entity set breezeattachmentsapi) for the attachments of a Breeze document. The file content is transferred through the dataAsBase64 field, which is used for both uploading and downloading the attachment as a Base64-encoded string.

GetDocumentStatus

Status callback exposed as a web service. The external system polls this endpoint to retrieve the current status of a document (for example whether the resulting purchase document has been created, posted, closed, deleted or cancelled).

Read-only lookup web services

The following read-only pages are published as web services so that the external system can look up master and reference data:

• Bin List
• GL Setup Dimensions
• Orderdata Purchase Lines
• Posted Purchase Rcpt. Lines