pdfDocument resource type

Represents a PDF document in Business Central. It allows you to retrieve PDF documents related to various entities such as sales invoices, sales quotes, sales credit memos, purchase invoices, and purchase credit memos.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET pdfDocumentpdfDocumentGets a PDF document object.
NavigationReturn TypeDescription
salesInvoicesalesInvoiceGets the salesinvoice of the pdfDocument.
salesOrdersalesOrderGets the salesorder of the pdfDocument.
salesQuotesalesQuoteGets the salesquote of the pdfDocument.
salesCreditMemosalesCreditMemoGets the salescreditmemo of the pdfDocument.
purchaseInvoicepurchaseInvoiceGets the purchaseinvoice of the pdfDocument.
purchaseCreditMemopurchaseCreditMemoGets the purchasecreditmemo of the pdfDocument.
customerContactcustomerContactGets the customercontact of the pdfDocument.
projectprojectGets the project of the pdfDocument.
purchaseOrderpurchaseOrderGets the purchaseorder of the pdfDocument.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the PDF document. Non-editable.
parentIdGUIDThe ID of the parent entity.
parentTypeNAV.attachmentEntityBufferDocumentTypeThe type of the parent document of the PDF document. It can be " ", "Journal", "Sales Order", "Sales Quote", "Sales Credit Memo", "Sales Invoice", "Purchase Invoice", "Purchase Order", "Purchase Credit Memo", or "Project".
pdfDocumentContentstreamThe content of the PDF document.

JSON representation

Here's a JSON representation of the pdfDocument resource.

{
    "id": "GUID",
    "parentId": "GUID",
    "parentType": "NAV.attachmentEntityBufferDocumentType",
    "pdfDocumentContent": "stream"
}

GET pdfDocument