Create documentAttachments

Article
04/03/2023

Creates a document attachment in Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

POST businesscentralPrefix/companies({id})/documentAttachments({id})

Request headers

Header	Value
Authorization	Bearer {token}. Required.
Content-Type	application/json
If-Match	Required. When this request header is included and the eTag provided does not match the current tag on the documentAttachment, the documentAttachment will not be updated.

Request body

In the request body, supply a JSON representation of a documentAttachment object.

Response

If successful, this method returns 201 Created response code and a documentAttachment object in the response body.

Example

Request

Here is an example of the request.

POST https://{businesscentralPrefix}/api/v2.0/companies({id})/documentAttachments({id})
Content-type: application/json
{
    "id" : "",
    "fileName" : "",
    "byteSize" : "",
    "attachmentContent" : "",
    "parentType" : "",
    "parentId" : "",
    "lineNumber" : "",
    "documentFlowSales" : "",
    "documentFlowPurchase" : "",
    "lastModifiedDateTime" : ""
}

Response

Here is an example of the response.

HTTP/1.1 201 Created
Content-type: application/json
{
    "id" : "",
    "fileName" : "",
    "byteSize" : "",
    "attachmentContent" : "",
    "parentType" : "",
    "parentId" : "",
    "lineNumber" : "",
    "documentFlowSales" : "",
    "documentFlowPurchase" : "",
    "lastModifiedDateTime" : ""
}

Share via