Edit

Share via

documentAttachment resource type

  • Article

Represents a document attachment in Business Central.

Note

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

Methods

Method Return Type Description
GET documentAttachment documentAttachment Gets a document attachment object.
DELETE documentAttachment none Deletes a document attachment object.
POST documentAttachment documentAttachment Creates a document attachment object.
PATCH documentAttachment documentAttachment Updates a document attachment object.
Navigation Return Type Description
item item Gets the item of the documentAttachment.
customer customer Gets the customer of the documentAttachment.
vendor vendor Gets the vendor of the documentAttachment.
salesInvoice salesInvoice Gets the salesinvoice of the documentAttachment.
employee employee Gets the employee of the documentAttachment.
salesOrder salesOrder Gets the salesorder of the documentAttachment.
salesQuote salesQuote Gets the salesquote of the documentAttachment.
salesCreditMemo salesCreditMemo Gets the salescreditmemo of the documentAttachment.
purchaseInvoice purchaseInvoice Gets the purchaseinvoice of the documentAttachment.
project project Gets the project of the documentAttachment.
purchaseOrder purchaseOrder Gets the purchaseorder of the documentAttachment.
purchaseCreditMemo purchaseCreditMemo Gets the purchasecreditmemo of the documentAttachment.

Properties

Property Type Description
id GUID The unique ID of the document attachment. Non-editable.
fileName string Logical filename.
byteSize integer File size.
attachmentContent stream The attachment's content.
parentType NAV.attachmentEntityBufferDocumentType The type of the parent document of the document attachment. It can be " ", "Journal", "Sales Order", "Sales Quote", "Sales Credit Memo", "Sales Invoice" or "Purchase Invoice".
parentId GUID The ID of the parent entity.
lineNumber integer The document attachment item line number.
documentFlowSales boolean Specifies if the attachment must flow to transactions. Used for integration with Flow; the field is exposed on the Document Attachment Details page.
documentFlowPurchase boolean Specifies if the attachment must flow to transactions. Used for integration with Flow; the field is exposed on the Document Attachment Details page.
lastModifiedDateTime datetime The last datetime the document attachment was modified. Read-Only.

JSON representation

Here is a JSON representation of the documentAttachment resource.

{
    "id": "GUID",
    "fileName": "string",
    "byteSize": "integer",
    "attachmentContent": "stream",
    "parentType": "NAV.attachmentEntityBufferDocumentType",
    "parentId": "GUID",
    "lineNumber": "integer",
    "documentFlowSales": "boolean",
    "documentFlowPurchase": "boolean",
    "lastModifiedDateTime": "datetime"
}

GET documentAttachment DELETE documentAttachment POST documentAttachment PATCH documentAttachment